Switch to `System.CommandLine` #7653

rubo · 2024-10-24T19:18:32Z

Replaces #4310

Changes

Replaced the McMaster.Extensions.CommandLineUtils with System.CommandLine as the CLI options parser
Changed configuration file extensions from .cfg to .json. The change is backward-compatible, i.e., the .cfg files are still handled if no .json equivalent is found. See Remarks below.
Program.cs has been heavily refactored and changed to a top-level file

Added new CLI option aliases to be closer to the conventional POSIX style and have less C# notation:

nethermind --configsDirectory path/to/dir --JsonRpc.JwtSecretFile path/to/jwt.hex
# or
nethermind --configs-dir path/to/dir --jsonrpc-jwtsecretfile path/to/jwt.hex

Revised logs wording
Unified logging styles on startup to have coloring from the beginning and avoid sudden formatting switch on configuration load

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

Needs manual testing

Documentation

Requires documentation update

Yes
No

PR pending.

Requires explanation in Release Notes

Yes
No

Optionally. Pending.

Remarks

The large number of changed files is due to .cfg to .json rename. I commented on the changes that need attention except for Program.cs, which has too many changes. The rest are file scope namespace changes or extension changes.

LukaszRozmej · 2024-10-25T08:33:36Z

Can you explain why? I thought McMaster.Extensions.CommandLineUtils is quite good and solved all our issues, why System.CommandLine would be better if not only by being 1st party?

Also why change cfg to json? It was a nice distinction which is chainspec and which config.

rubo · 2024-10-25T09:15:18Z

@LukaszRozmej We had no particular issues with Microsoft.Extensions.CommandLineUtils but NuGet warnings of deprecation. The replacement McMaster.Extensions.CommandLineUtils was also abandoned by the time we picked it; its package is just not yet marked as deprecated. So, the goal here is to have something in active development and future-oriented.

.json is a well-known standard extension and is more editor-friendly and self-explanatory. Generally, I'd like to use something standard and familiar to everyone. Given we have chain specs and configs in different directories, there's no confusion, and the distinction is still clear. Moreover, chain specs are embedded in binary and are not visible to end-users.

rubo · 2024-10-25T17:22:03Z

src/Nethermind/Nethermind.Config/INoCategoryConfig.cs

-    [ConfigItem(Description = "Enables Hive plugin used for executing Hive Ethereum Tests.", EnvironmentVariable = "NETHERMIND_HIVE_ENABLED", DefaultValue = "false")]
-    public bool HiveEnabled { get; set; }
+    //[ConfigItem(Description = "Enables Hive plugin used for executing Hive Ethereum Tests.", EnvironmentVariable = "NETHERMIND_HIVE_ENABLED", DefaultValue = "false")]
+    //public bool HiveEnabled { get; set; }


@LukaszRozmej The NETHERMIND_HIVE_ENABLED seems redundant as we already have NETHERMIND_HIVECONFIG_ENABLED with IHiveConfig.Enabled. Related tests are failing, but I don't wanna touch them until I get feedback.

rubo · 2024-10-25T17:23:11Z

src/Nethermind/Nethermind.Config/INoCategoryConfig.cs


    [ConfigItem(Description = "Sets the job name for metrics monitoring.", EnvironmentVariable = "NETHERMIND_MONITORING_JOB")]
    public string MonitoringJob { get; set; }

-    [ConfigItem(Description = "Sets the default group name for metrics monitoring.", EnvironmentVariable = "NETHERMIND_MONITORING_GROUP")]
-    public string MonitoringGroup { get; set; }
+    //[ConfigItem(Description = "Sets the default group name for metrics monitoring.", EnvironmentVariable = "NETHERMIND_MONITORING_GROUP")]


@LukaszRozmej NETHERMIND_MONITORING_GROUP seems no longer relevant.

rubo · 2024-10-25T17:23:48Z

src/Nethermind/Nethermind.Config/INoCategoryConfig.cs

-    [ConfigItem(Description = "Plugins directory")]
-    public string PluginsDirectory { get; set; }
+    //[ConfigItem(Description = "Plugins directory")]
+    //public string PluginsDirectory { get; set; }

    [ConfigItem(Description = "Sets the job name for metrics monitoring.", EnvironmentVariable = "NETHERMIND_MONITORING_JOB")]
    public string MonitoringJob { get; set; }


@LukaszRozmej NETHERMIND_MONITORING_JOB seems no longer relevant.

rubo · 2024-10-25T17:31:59Z

src/Nethermind/Nethermind.Api/Extensions/IPluginLoader.cs


-        void Load(ILogManager logManager);
+    void Load();


The ILogManager parameter has been removed from the Load() method. Implementations can require it in their constructors if needed. This was helpful in the context of Program.cs refactoring.

rubo · 2024-10-25T17:33:51Z

src/Nethermind/Nethermind.Api/Extensions/PluginLoader.cs

-namespace Nethermind.Api.Extensions
+namespace Nethermind.Api.Extensions;
+
+public class PluginLoader(string pluginPath, IFileSystem fileSystem, ILogger logger, params Type[] embedded) : IPluginLoader


Added ILogger to the constructor instead of taking ILogManager in the Load() method. That's it for this file.

rubo · 2024-10-25T17:34:33Z

src/Nethermind/Nethermind.Api/Extensions/SinglePluginLoader.cs


-        public void Load(ILogManager logManager) { }


Removed ILogManager from the Load() method. This implementation doesn't need it at all.

rubo · 2024-10-25T17:44:35Z

src/Nethermind/Nethermind.Config/IProcessExitSource.cs

-    public CancellationToken Token => _cancellationTokenSource!.Token;
+    public ProcessExitSource(CancellationToken cancellationToken)
+    {
+        _cancellationTokenSource = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);


System.CommandLine provides a cancellation token for ctrl+c, so we don't need to handle it ourselves. Thus, ProcessExitSource now uses a linked cancellation token source to combine its own with the one of the CLI parser.

rubo · 2024-10-25T17:46:33Z

src/Nethermind/Nethermind.Config/ConfigProvider.cs


-        foreach (var source in _configSource)
+        // Skip the validation for ArgsConfigSource items as they are already validated by the CLI parser
+        foreach (IConfigSource source in _configSource.Where(s => s is not ArgsConfigSource))


Disabled validation for ArgsConfigSource (CLI arguments) since the CLI parser does the job now.

rubo added 6 commits October 23, 2024 22:34

Replace McMaster.Extensions.CommandLineUtils with System.CommandLine

066bc8e

Refactor startup and clean up

4cdd44c

Remove unused parameter

0449603

Switch to top-level file

8e098e1

Revise and add more conventional CLI options

7660ed2

Change config file extensions to .json

9c98998

rubo force-pushed the feature/system-commandline-2 branch from 2f13e8e to 9c98998 Compare October 24, 2024 23:12

rubo added 6 commits October 25, 2024 01:14

Merge branch 'master' into feature/system-commandline-2

572e7f7

Rename Taiko configs

63e068d

Revise nuget.config files

a328140

Fix tests

91fd242

Remove kovan.json

08e00e9

Revise log config

c1b28a5

rubo added 7 commits October 25, 2024 11:57

Refactor and optimize parse result handling

0fb3ddb

Refactor and unify logging on startup

40ec8f6

Revise CLI option handling

6ddb2d5

Revise logs

4067141

Fix formatting

90ece4c

Disable redundant CLI options validation

3976ab0

Merge branch 'master' into feature/system-commandline-2

6f1c095

rubo commented Oct 25, 2024

View reviewed changes

rubo requested a review from LukaszRozmej October 25, 2024 17:56

Drop System.CommandLine.NamingConventionBinder package

98889a3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch to `System.CommandLine` #7653

Switch to `System.CommandLine` #7653

rubo commented Oct 24, 2024 •

edited

Loading

LukaszRozmej commented Oct 25, 2024 •

edited

Loading

rubo commented Oct 25, 2024 •

edited

Loading

rubo Oct 25, 2024 •

edited

Loading

rubo Oct 25, 2024

rubo Oct 25, 2024

rubo Oct 25, 2024

rubo Oct 25, 2024

rubo Oct 25, 2024

rubo Oct 25, 2024 •

edited

Loading

rubo Oct 25, 2024

Switch to System.CommandLine #7653

Are you sure you want to change the base?

Switch to System.CommandLine #7653

Conversation

rubo commented Oct 24, 2024 • edited Loading

Changes

Types of changes

What types of changes does your code introduce?

Testing

Requires testing

If yes, did you write tests?

Notes on testing

Documentation

Requires documentation update

Requires explanation in Release Notes

Remarks

LukaszRozmej commented Oct 25, 2024 • edited Loading

rubo commented Oct 25, 2024 • edited Loading

rubo Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

rubo Oct 25, 2024

Choose a reason for hiding this comment

rubo Oct 25, 2024

Choose a reason for hiding this comment

rubo Oct 25, 2024

Choose a reason for hiding this comment

rubo Oct 25, 2024

Choose a reason for hiding this comment

rubo Oct 25, 2024

Choose a reason for hiding this comment

rubo Oct 25, 2024 • edited Loading

Choose a reason for hiding this comment

rubo Oct 25, 2024

Choose a reason for hiding this comment

Switch to `System.CommandLine` #7653

Switch to `System.CommandLine` #7653

rubo commented Oct 24, 2024 •

edited

Loading

LukaszRozmej commented Oct 25, 2024 •

edited

Loading

rubo commented Oct 25, 2024 •

edited

Loading

rubo Oct 25, 2024 •

edited

Loading

rubo Oct 25, 2024 •

edited

Loading