Validate and log when an unrecognized parameter/flag is used

[wugalde19]

Resolves #6942

Changes

Changes made into src/Nethermind/Nethermind.Runner/Program.cs

• Add a function to load all possible flags/params/arguments to be used and put them on a hash
  • The hash is initialized with the default flags allowed in the app and not related to flags in config files
• Add a function to validate current args against the hash generated
• Call the validation function into Run so that we initialize the app and validate before start running most of the logic.

Types of changes

What types of changes does your code introduce?

• Bugfix (a non-breaking change that fixes an issue)
• New feature (a non-breaking change that adds functionality)
• Breaking change (a change that causes existing functionality not to work as expected)
• Optimization
• Refactoring
• Documentation update
• Build-related changes
• Other: Description

Testing

Requires testing

• Yes
• No

If yes, did you write tests?

• Yes
• No

Notes on testing

I did not see any test file for Program.cs files

Documentation

Requires documentation update

• Yes
• No

Requires explanation in Release Notes

• Yes
• No

Remarks

I recorded a video showing how it works and the error log is displayed when the argument/option/flag used is not valid and when it is valid.
Also, the cases where no flag is provided and when a default app flag (like --help) is provided, and when we try using duplicate arguments

https://www.loom.com/share/0ac1011bac1247b992a9fbadba9e5b26?sid=eb48d13b-961e-490e-a1ff-5fe51a2580b0

List of commands used:

# Should work
./publish/nethermind --help

# Should work
./publish/nethermind -v

# Should work
./publish/nethermind

# Should work
./publish/nethermind --JsonRpc.WebSocketsPort 8546

# Duplicate argument error
./publish/nethermind --JsonRpc.WebSocketsPort 8546 --JsonRpc.WebSocketsPort 8546

# Unrecognized argument error
./publish/nethermind --JsonRpc.WebsocketsPort 8546

[LukaszRozmej]

If we are validating here I would also move GetDuplicateArguments and duplication validation under this one method.

[wugalde19]

@LukaszRozmej I've already addressed all your comments and updated the video to validate new changes
Feel free to review it again and let me know if you have more feedback
Thanks

[LukaszRozmej]

Better design, but way to much allocations.

[wugalde19]

@LukaszRozmej Thanks for all the feedback provided
Definitely learning a lot and it is forcing me to be more thoughtful with the code
Ready for another round of reviews

[LukaszRozmej]

Cool, IMO code now is quite good, would apply few final touches to make it perfect ;)

[wugalde19]

@LukaszRozmej one step closer to a better implementation
You are great
Thanks for your patience

[LukaszRozmej]

Congrats for persistence ;)

[wugalde19]

@LukaszRozmej Just applied changes suggested on last two comments

[LukaszRozmej]

@wugalde19 thank you for your contribution 🫡

[benaadams]

Fails for?

 --JsonRpc.JwtSecretFile=C:/ethereum/jwt.hex

🤔

[wugalde19]

My pleasure @LukaszRozmej

[benaadams]

Failed due to unrecognized argument - [JsonRpc.JwtSecretFile=C:/ethereum/jwt.hex].
Run --help for a list of available options and commands.

[wugalde19]

JsonRpc.JwtSecretFile=C:/ethereum/jwt.hex

@benaadams Please try again
@LukaszRozmej came out with a much better solution (here)
Those changes seemed to have fixed the issue you were having