Merge branch 'master' of https://github.com/csmir/Commands.NET

csmir · csmir · commit 838cd94d84d4 · 2025-12-01T16:10:50.000+01:00
diff --git a/src/Commands.Hosting/Commands.Hosting.csproj b/src/Commands.Hosting/Commands.Hosting.csproj
@@ -10,7 +10,7 @@
 		<NoWarn>CA1822;IDE0130;IDE0290</NoWarn>
 
 		<AssemblyVersion>2.0</AssemblyVersion>
-		<PackageVersion>2.0.0-alpha.26</PackageVersion> <!--\-alpha.1-->
+		<PackageVersion>2.0.0-alpha.29</PackageVersion> <!--\-alpha.1-->
 		<FileVersion>2.0.0.0</FileVersion>
 
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>
diff --git a/src/Commands.Hosting/Commands.Hosting/Execution/CommandExecutionFactory.cs b/src/Commands.Hosting/Commands.Hosting/Execution/CommandExecutionFactory.cs
@@ -67,7 +67,7 @@ public CommandExecutionFactory(IComponentProvider execProvider, IServiceProvider
             services.GetService<IExecutionScope>()?.Dispose();
         };
 
-        Logger?.LogInformation("Consuming {ExecutionProvider}, with {HandlerCount} result handler{MoreOrOne}.", Provider.GetType().FullName, handlers.Length, handlers.Length > 1 ? "(s)" : "");
+        Logger?.LogInformation("Consuming {ExecutionProvider}, with {HandlerCount} result handler{MoreOrOne}.", Provider.GetType().FullName, handlers.Length, handlers.Length != 1 ? "(s)" : "");
 
         var commands = execProvider.Components.GetCommands().ToArray();
 
diff --git a/src/Commands.Http/Commands.Http.csproj b/src/Commands.Http/Commands.Http.csproj
@@ -10,7 +10,7 @@
 		<NoWarn>CA1822;IDE0130;IDE0290</NoWarn>
 
 		<AssemblyVersion>2.0</AssemblyVersion>
-		<PackageVersion>2.0.0-alpha.26</PackageVersion> <!--\-alpha.1-->
+		<PackageVersion>2.0.0-alpha.29</PackageVersion> <!--\-alpha.1-->
 		<FileVersion>2.0.0.0</FileVersion>
 
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>
diff --git a/src/Commands.Http/Commands.Http/Execution/HttpCommandContext.cs b/src/Commands.Http/Commands.Http/Execution/HttpCommandContext.cs
@@ -127,7 +127,14 @@ public virtual void Respond(IHttpResult result)
             }
             else
             {
-                var jsonBytes = Response.ContentEncoding.GetBytes(JsonSerializer.Serialize(result.Content, result.Content.GetType(), _services.GetService<JsonSerializerOptions>()));
+                string serializationResult;
+
+                if (result.Content is Tuple<Type, object> objectReferredByT)
+                    serializationResult = JsonSerializer.Serialize(objectReferredByT.Item2, objectReferredByT.Item1, _services.GetService<JsonSerializerOptions>());
+                else
+                    serializationResult = JsonSerializer.Serialize(result.Content, result.Content.GetType(), _services.GetService<JsonSerializerOptions>());
+
+                var jsonBytes = Response.ContentEncoding.GetBytes(serializationResult);
 
                 Response.ContentLength64 = jsonBytes.Length;
 
diff --git a/src/Commands.Http/Commands.Http/Execution/HttpCommandExecutionFactory.cs b/src/Commands.Http/Commands.Http/Execution/HttpCommandExecutionFactory.cs
@@ -21,7 +21,7 @@ public class HttpCommandExecutionFactory(IComponentProvider executionProvider, I
     /// </remarks>
     /// <param name="cancellationToken">The token that when cancelled, will notify a linked token to stop the HTTP pipeline and cleanly escape the listening process.</param>
     /// <returns>An awaitable <see cref="Task"/> representing the result of the start operation.</returns>
-    public Task StartAsync(CancellationToken cancellationToken)
+    public Task StartAsync(CancellationToken cancellationToken = default)
     {
         try
         {
@@ -34,11 +34,8 @@ public Task StartAsync(CancellationToken cancellationToken)
                 {
                     Logger?.LogDebug("Configuring HTTP prefix: {Prefix}", prefix.Value);
 
-                    if (string.IsNullOrWhiteSpace(prefix.Value))
-                        continue;
-
-                    if (!httpListener.Prefixes.Contains(prefix.Value!))
-                        httpListener.Prefixes.Add(prefix.Value!);
+                    if (!string.IsNullOrWhiteSpace(prefix.Value) && !httpListener.Prefixes.Contains(prefix.Value))
+                        httpListener.Prefixes.Add(prefix.Value);
                 }
             }
 
@@ -65,7 +62,7 @@ public Task StartAsync(CancellationToken cancellationToken)
     /// </summary>
     /// <param name="cancellationToken">The token that when cancelled, will force the listening process to break regardless of its execution state.</param>
     /// <returns>An awaitable <see cref="Task"/> representing the result of the stop operation.</returns>
-    public async Task StopAsync(CancellationToken cancellationToken)
+    public async Task StopAsync(CancellationToken cancellationToken = default)
     {
         if (_runningTask is null)
             return;
diff --git a/src/Commands.Http/Commands.Http/Results/HttpResult.cs b/src/Commands.Http/Commands.Http/Results/HttpResult.cs
@@ -87,11 +87,11 @@ public override string ToString()
     /// <param name="content">The response to send.</param>
     /// <param name="statusCode">The status code of the response.</param>
     /// <returns>A new instance of <see cref="HttpResult"/> containing the values to be served to the caller invoking this operation.</returns>
-    public static HttpResult Json(object content, HttpStatusCode statusCode = HttpStatusCode.OK)
+    public static HttpResult Json<T>([DisallowNull] T content, HttpStatusCode statusCode = HttpStatusCode.OK)
     {
         Assert.NotNull(content, nameof(content));
 
-        return new(statusCode, content, "application/json");
+        return new(statusCode, new Tuple<Type, object>(typeof(T), content), "application/json");
     }
 
     /// <summary>
diff --git a/src/Commands.Samples/Commands.Samples.Http/Program.cs b/src/Commands.Samples/Commands.Samples.Http/Program.cs
@@ -38,7 +38,7 @@
     // This (currently) includes defining parsers and validation of component names.
     context.ConfigureOptions(options =>
     {
-        
+
     });
 });
 
@@ -88,23 +88,14 @@
 // This approach is more flexible and allows for more granular control over the services and components used in the application.
 // ... Or when you do not intend to implement the whole host, but just want to run the HTTP server on an isolated service collection.
 var services = new ServiceCollection()
-    .AddHttpComponents(options =>
-    {
-        options.WithListener(listener =>
-        {
-           listener.Prefixes.Add("http://localhost:7000/");
-        });
-    })
+    .AddSingleton<ComponentTree>([new CommandGroup<HttpModule>()])
+    .AddHttpComponents(cfg => cfg.WithListener(listener => listener.Prefixes.Add("http://localhost:7000/")))
     .BuildServiceProvider();
 
-// Retrieve the component provider from the service collection and add the HttpModule to it, rather than calling UseComponents on the host.
-services.GetRequiredService<IComponentProvider>()
-    .Components.Add<HttpModule>();
-
 // The factory under hosted context implements IHostedService, which means it will start and stop with the host.
 // This is not supported in this isolated context, so it is registered as a singleton service and can be started and stopped manually.
 await services.GetRequiredService<HttpCommandExecutionFactory>()
-    .StartAsync(default);
+    .StartAsync();
 
 // Prevent the application from exiting immediately... or when in a larger application, continue running other tasks.
 await Task.Delay(Timeout.Infinite);
diff --git a/src/Commands.Tests/Commands.Tests.Benchmarks/Commands.Tests.Benchmarks.csproj b/src/Commands.Tests/Commands.Tests.Benchmarks/Commands.Tests.Benchmarks.csproj
@@ -5,12 +5,15 @@
     <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
-		<NoWarn>CA1822;IDE0130</NoWarn>
+	<NoWarn>CA1822;IDE0130</NoWarn>  
+    <DefineConstants>$(DefineConstants);DISABLE_PROFILER_AGENT_CONFIG</DefineConstants>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="BenchmarkDotNet" Version="0.14.0" />
+    <PackageReference Include="BenchmarkDotNet" Version="0.15.6" />
+    <PackageReference Include="Microsoft.VisualStudio.DiagnosticsHub.BenchmarkDotNetDiagnosers" Version="18.3.36726.2" />
   </ItemGroup>
+	
 
   <ItemGroup>
     <ProjectReference Include="..\..\Commands\Commands.csproj" />
diff --git a/src/Commands.Tests/Commands.Tests.Benchmarks/Program.cs b/src/Commands.Tests/Commands.Tests.Benchmarks/Program.cs
@@ -50,22 +50,15 @@ public void FindCommands()
     public Task RunCommand()
         => _provider.Execute(new BenchmarkContext("command"));
 
-    //[Benchmark]
-    //public Task RunCommandNonBlocking()
-    //    => _provider.Execute(new BenchmarkContext("command"), new ExecutionOptions()
-    //    {
-    //        ExecuteAsynchronously = true,
-    //    });
-
-    //[Benchmark]
-    //public ComponentTree CollectionCreate()
-    //    => [];
+    [Benchmark]
+    public ComponentTree CollectionCreate()
+        => [];
 
-    //[Benchmark]
-    //public CommandGroup GroupCreate()
-    //    => new(["name"]);
+    [Benchmark]
+    public CommandGroup GroupCreate()
+        => new(["name"]);
 
-    //[Benchmark]
-    //public Command CommandCreate()
-    //    => new(() => { }, ["name"]);
+    [Benchmark]
+    public Command CommandCreate()
+        => new(() => { }, ["name"]);
 }
diff --git a/src/Commands.Tests/Commands.Tests.Benchmarks/README.md b/src/Commands.Tests/Commands.Tests.Benchmarks/README.md
@@ -4,34 +4,45 @@ Benchmarks are ran for every release to ensure the library is performing as expe
 
 The following benchmarks are ran on the latest version of the library, using the latest version of the .NET SDK and BenchmarkDotNet.
 
-### Last Benchmark: 1/22/2025
-
 - **CreateArguments**: Parsing provided string input into processable arguments.
 - **FindCommands**: Finding the command to execute based on the provided arguments.
 - **RunCommand**: Parsing, Finding and running the command, start to finish.
-- **RunCommandNonBlocking**: Parsing, Finding and running the command asynchronously, start to finish.
 - **CollectionCreate**: Creating a collection for commands.
 - **GroupCreate**: Creating a group for commands.
 - **CommandCreate**: Creating a command.
 
-# Intel� Core� i7-1255U
+# Intel® Core™ i7-1255U
+
+### Last Benchmark: 1/22/2025
 
 | Method                | Mean       | Error     | StdDev    | Gen0   | Allocated |
 |---------------------- |-----------:|----------:|----------:|-------:|----------:|
 | CreateArguments       |  50.497 ns | 0.9744 ns | 0.9570 ns | 0.0446 |     280 B |
 | FindCommands          |  45.632 ns | 0.4376 ns | 0.3879 ns | 0.0140 |      88 B |
 | RunCommand            | 199.856 ns | 2.5021 ns | 2.2180 ns | 0.0815 |     512 B |
-| RunCommandNonBlocking | 207.349 ns | 2.2603 ns | 1.8874 ns | 0.0892 |     560 B |
 | CollectionCreate      |   4.372 ns | 0.0760 ns | 0.0635 ns | 0.0051 |      32 B |
 | GroupCreate           |  11.112 ns | 0.0974 ns | 0.0864 ns | 0.0166 |     104 B |
 | CommandCreate         | 137.402 ns | 1.4430 ns | 1.2050 ns | 0.0508 |     320 B |
 
 > [!NOTE]
 > Allocation for running commands is a combination of the argument creation, and search process. 
-> On itself, it allocates 144 / 192 bytes for actual execution.
+> On itself, it allocates 144 bytes for actual execution.
 
-# Intel� Core� Ultra 7 155H 
+# Intel® Core™ Ultra 7 155H 
 
-> Not yet tested.
+### Last Benchmark: 11/27/2025
+
+| Method           | Mean       | Error     | StdDev    | Gen0   | Allocated |
+|----------------- |-----------:|----------:|----------:|-------:|----------:|
+| CreateArguments  |  42.739 ns | 0.7411 ns | 0.6933 ns | 0.0159 |     200 B |
+| FindCommands     |  36.797 ns | 0.7566 ns | 1.0100 ns | 0.0025 |      32 B |
+| RunCommand       | 172.082 ns | 3.0553 ns | 2.8579 ns | 0.0248 |     312 B |
+| CollectionCreate |   4.652 ns | 0.1170 ns | 0.1094 ns | 0.0025 |      32 B |
+| GroupCreate      |  11.211 ns | 0.0869 ns | 0.0813 ns | 0.0083 |     104 B |
+| CommandCreate    | 165.108 ns | 1.7455 ns | 1.6327 ns | 0.0370 |     464 B |
+
+> [!NOTE]
+> Allocation for running commands is a combination of the argument creation, and search process. 
+> On itself, it allocates 112 bytes for actual execution.
 
-*This chart can be reproduced at any time by running this benchmark project.*
+*This chart can be reproduced at any time by running this benchmark project.*
diff --git a/src/Commands/Commands.Parsing/Parsers/ColorParser.cs b/src/Commands/Commands.Parsing/Parsers/ColorParser.cs
@@ -17,15 +17,9 @@ public ColorParser()
     {
         _colors = new(StringComparer.OrdinalIgnoreCase);
 
-        var properties = typeof(Color).GetProperties(BindingFlags.Public | BindingFlags.Static);
-
-        foreach (var property in properties)
+        foreach (var property in typeof(Color).GetProperties(BindingFlags.Public | BindingFlags.Static).Where(static p => p.PropertyType == typeof(Color)))
         {
-            if (property.PropertyType == typeof(Color))
-            {
-                var color = (Color)property.GetValue(null)!;
-                _colors[property.Name] = color;
-            }
+            _colors[property.Name] = (Color)property.GetValue(null)!;
         }
     }
 
@@ -61,8 +55,6 @@ public override ValueTask<ParseResult> Parse(IContext context, ICommandParameter
 
     private bool TryParseRgb(string value, out Color result)
     {
-        result = new();
-
         var separation = value.Split(',');
 
         if (separation.Length == 3)
@@ -76,6 +68,7 @@ private bool TryParseRgb(string value, out Color result)
             }
         }
 
+        result = new();
         return false;
     }
 
@@ -108,8 +101,6 @@ private bool TryParseHex(string value, out Color result)
 
     private bool TryParseUint(string value, out Color result)
     {
-        result = new();
-
         if (uint.TryParse(value, out var rgb))
         {
             var r = (byte)((rgb & 0xFF0000) >> 16);
@@ -121,20 +112,20 @@ private bool TryParseUint(string value, out Color result)
             return true;
         }
 
+        result = new();
         return false;
     }
 
     private bool TryParseNamed(string value, out Color result)
     {
-        result = new();
-
         if (_colors.TryGetValue(value, out var color))
         {
             result = color;
 
             return true;
         }
 
+        result = new();
         return false;
     }
 }
diff --git a/src/Commands/Commands.csproj b/src/Commands/Commands.csproj
@@ -10,7 +10,7 @@
 		<NoWarn>CA1822;IDE0130;IDE0290;IDE0056;SYSLIB1045</NoWarn>
 
 		<AssemblyVersion>2.0</AssemblyVersion>
-		<PackageVersion>2.0.0-alpha.26</PackageVersion> <!--\-alpha.1-->
+		<PackageVersion>2.0.0-alpha.29</PackageVersion> <!--\-alpha.1-->
 		<FileVersion>2.0.0.0</FileVersion>
 
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>
diff --git a/src/Commands/Commands/Assert.cs b/src/Commands/Commands/Assert.cs
@@ -32,21 +32,17 @@ public static void NotNullOrInvalid(IEnumerable<string> values, Regex? regex, st
     {
         NotNull(values, nameof(values));
 
-        if (regex != null)
-        {
-            var valueCount = 0;
-            foreach (var value in values)
-            {
-                valueCount++;
+        if (regex == null) return;
 
-                NotNullOrEmpty(value, argumentExpression);
+        if (!values.Any())
+            throw new ArgumentException($"The argument '{argumentExpression}' must not be empty.", argumentExpression);
 
-                if (!regex.IsMatch(value))
-                    throw new ArgumentException($"The argument '{argumentExpression}' must match the validation expression '{regex}'", argumentExpression);
-            }
+        foreach (var value in values)
+        {
+            NotNullOrEmpty(value, argumentExpression);
 
-            if (valueCount == 0)
-                throw new ArgumentException($"The argument '{argumentExpression}' must not be empty.", argumentExpression);
+            if (!regex.IsMatch(value))
+                throw new ArgumentException($"The argument '{argumentExpression}' must match the validation expression '{regex}'", argumentExpression);
         }
     }
 }
diff --git a/src/Commands/Commands/Components/Command.cs b/src/Commands/Commands/Components/Command.cs
@@ -155,12 +155,9 @@ private Command(IActivator activator, ComponentOptions options)
 
         (MinLength, MaxLength) = Utilities.GetLength(parameters);
 
-        for (var i = 0; i < parameters.Length; i++)
+        for (int i = parameters.Length - 1; i < -1; i--)
         {
-            var parameter = parameters[i];
-
-            if (parameter.IsRemainder && i != parameters.Length - 1)
-                throw new ComponentFormatException("Remainder-marked parameters must be the last parameter in the parameter list of a command.");
+            if (parameters[i].IsRemainder) throw new ComponentFormatException("Remainder-marked parameters must be the last parameter in the parameter list of a command."); 
         }
 
         Parameters = parameters;
@@ -283,7 +280,7 @@ static TestResult Compare(ITest test, TestResultType targetType, Exception excep
     /// <param name="includeArguments">Defines if the arguments of the command should be included in the output.</param>
     public string GetFullName(bool includeArguments)
     {
-        var sb = new StringBuilder();
+        var sb = new ValueStringBuilder(stackalloc char[64]);
 
         if (Parent?.Name != null)
         {
@@ -314,18 +311,9 @@ public string GetFullName(bool includeArguments)
     public string GetFullName()
         => GetFullName(true);
 
-    /// <inheritdoc />
-    public float GetScore()
-    {
-        var score = 1.0f;
-
-        foreach (var parameter in Parameters)
-            score += parameter.GetScore();
-
-        score += Attributes.FirstOrDefault<PriorityAttribute>()?.Priority ?? 0;
 
-        return score;
-    }
+    /// <inheritdoc />
+    public float GetScore() => 1 + Parameters.Sum(p => p.GetScore()) + Attributes.FirstOrDefault<PriorityAttribute>()?.Priority ?? 0;
 
     /// <inheritdoc />
     public int CompareTo(IComponent? component)
diff --git a/src/Commands/Commands/Components/CommandGroup.cs b/src/Commands/Commands/Components/CommandGroup.cs
diff --git a/src/Commands/Commands/Components/ComponentSet.cs b/src/Commands/Commands/Components/ComponentSet.cs
diff --git a/src/Commands/Commands/Execution/Arguments.cs b/src/Commands/Commands/Execution/Arguments.cs
diff --git a/src/Commands/Commands/Execution/AsyncContext.cs b/src/Commands/Commands/Execution/AsyncContext.cs
diff --git a/src/Commands/Commands/Execution/ComponentProvider.cs b/src/Commands/Commands/Execution/ComponentProvider.cs
diff --git a/src/Commands/Commands/Utilities.cs b/src/Commands/Commands/Utilities.cs
diff --git a/src/Commands/ValueStringBuilder.cs b/src/Commands/ValueStringBuilder.cs

Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,14 @@ public virtual void Respond(IHttpResult result)`
`127`	`127`	`}`
`128`	`128`	`else`
`129`	`129`	`{`
`130`		`- var jsonBytes = Response.ContentEncoding.GetBytes(JsonSerializer.Serialize(result.Content, result.Content.GetType(), _services.GetService<JsonSerializerOptions>()));`
	`130`	`+ string serializationResult;`
	`131`	`+`
	`132`	`+ if (result.Content is Tuple<Type, object> objectReferredByT)`
	`133`	`+ serializationResult = JsonSerializer.Serialize(objectReferredByT.Item2, objectReferredByT.Item1, _services.GetService<JsonSerializerOptions>());`
	`134`	`+ else`
	`135`	`+ serializationResult = JsonSerializer.Serialize(result.Content, result.Content.GetType(), _services.GetService<JsonSerializerOptions>());`
	`136`	`+`
	`137`	`+ var jsonBytes = Response.ContentEncoding.GetBytes(serializationResult);`
`131`	`138`
`132`	`139`	`Response.ContentLength64 = jsonBytes.Length;`
`133`	`140`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public class HttpCommandExecutionFactory(IComponentProvider executionProvider, I`
`21`	`21`	`/// </remarks>`
`22`	`22`	`/// <param name="cancellationToken">The token that when cancelled, will notify a linked token to stop the HTTP pipeline and cleanly escape the listening process.</param>`
`23`	`23`	`/// <returns>An awaitable <see cref="Task"/> representing the result of the start operation.</returns>`
`24`		`- public Task StartAsync(CancellationToken cancellationToken)`
	`24`	`+ public Task StartAsync(CancellationToken cancellationToken = default)`
`25`	`25`	`{`
`26`	`26`	`try`
`27`	`27`	`{`
`@@ -34,11 +34,8 @@ public Task StartAsync(CancellationToken cancellationToken)`
`34`	`34`	`{`
`35`	`35`	`Logger?.LogDebug("Configuring HTTP prefix: {Prefix}", prefix.Value);`
`36`	`36`
`37`		`- if (string.IsNullOrWhiteSpace(prefix.Value))`
`38`		`- continue;`
`39`		`-`
`40`		`- if (!httpListener.Prefixes.Contains(prefix.Value!))`
`41`		`- httpListener.Prefixes.Add(prefix.Value!);`
	`37`	`+ if (!string.IsNullOrWhiteSpace(prefix.Value) && !httpListener.Prefixes.Contains(prefix.Value))`
	`38`	`+ httpListener.Prefixes.Add(prefix.Value);`
`42`	`39`	`}`
`43`	`40`	`}`
`44`	`41`
`@@ -65,7 +62,7 @@ public Task StartAsync(CancellationToken cancellationToken)`
`65`	`62`	`/// </summary>`
`66`	`63`	`/// <param name="cancellationToken">The token that when cancelled, will force the listening process to break regardless of its execution state.</param>`
`67`	`64`	`/// <returns>An awaitable <see cref="Task"/> representing the result of the stop operation.</returns>`
`68`		`- public async Task StopAsync(CancellationToken cancellationToken)`
	`65`	`+ public async Task StopAsync(CancellationToken cancellationToken = default)`
`69`	`66`	`{`
`70`	`67`	`if (_runningTask is null)`
`71`	`68`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -87,11 +87,11 @@ public override string ToString()`
`87`	`87`	`/// <param name="content">The response to send.</param>`
`88`	`88`	`/// <param name="statusCode">The status code of the response.</param>`
`89`	`89`	`/// <returns>A new instance of <see cref="HttpResult"/> containing the values to be served to the caller invoking this operation.</returns>`
`90`		`- public static HttpResult Json(object content, HttpStatusCode statusCode = HttpStatusCode.OK)`
	`90`	`+ public static HttpResult Json<T>([DisallowNull] T content, HttpStatusCode statusCode = HttpStatusCode.OK)`
`91`	`91`	`{`
`92`	`92`	`Assert.NotNull(content, nameof(content));`
`93`	`93`
`94`		`- return new(statusCode, content, "application/json");`
	`94`	`+ return new(statusCode, new Tuple<Type, object>(typeof(T), content), "application/json");`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/// <summary>`