Enhance Azure setup, null safety, and code quality

giovanninocco · giovanninocco · commit 21f27983546f · 2024-10-19T16:07:43.000+02:00
Added `helloworld.bicep` to define Azure resources including a storage account, an App Service Plan, and a web app.

Updated project files (`Genocs.Auth.csproj`, `Genocs.Common.csproj`, `Genocs.Core.csproj`, `Genocs.Discovery.Consul.csproj`, `Genocs.HTTP.csproj`) to modify `&lt;PackageTags&gt;`, adding tags like `genocs`, `authentication`, `service-discovery`, and `http-client`.

Removed unused `using` directives in `IQueryDispatcher.cs`.

Modified `DispatcherEndpointsBuilder.cs` to allow `afterDispatch` function to accept nullable `TResult`.

Updated `Extensions.cs` to make the `middleware` parameter nullable in `UseDispatcherEndpoints`.

Changed `IDispatcher.cs` and `InMemoryDispatcher.cs` to make the return type of `QueryAsync` nullable.

Refactored `IDispatcherEndpointsBuilder.cs` to improve formatting and make `afterDispatch` function accept nullable `TResult`.

Updated `PublicContractsMiddleware.cs` to add null checks and improve command and event registration handling.

Refactored `CertificateMiddleware.cs` to initialize dictionaries inline and added null checks for `options.Certificate`.

Updated `SecurityOptions.cs` to improve formatting of the `GetHeaderName` method.

Enhanced `Extensions.cs` to add null checks and default value handling for `sectionName` in `AddCertificateAuthentication`.
diff --git a/azure/infrastructure/helloworld.bicep b/azure/infrastructure/helloworld.bicep
@@ -0,0 +1,50 @@
+// Get the resource group location
+param location string = 'East US'
+
+@description('The name of you Web Site.')
+param webSiteName string = 'gnx-website'
+
+param uniqueString string = '{uniqueString(resourceGroup().id)}'
+
+// Generate a unique storage account name
+param storageAccountName string = 'helloworldstorage${uniqueString}'
+
+// Create a storage account
+resource storageAccount 'Microsoft.Storage/storageAccounts@2023-05-01' = {
+  name: storageAccountName
+  location: location
+  sku: {
+    name: 'Standard_LRS'
+  }
+  kind: 'StorageV2'
+  properties: {
+    accessTier: 'Hot'
+  }
+}
+
+// Create an App Service Plan
+resource appServicePlan 'Microsoft.Web/serverfarms@2023-12-01' = {
+  name: 'asp-${uniqueString}'
+  location: location
+  sku: {
+    name: 'F1'
+    tier: 'Free'
+  }
+}
+
+// Create a web app
+resource webApp 'Microsoft.Web/sites@2023-12-01' = {
+  name: webSiteName
+  location: location
+  properties: {
+    serverFarmId: appServicePlan.id
+    siteConfig: {
+      appSettings: [
+        {
+          name: 'STORAGE_ACCOUNT_NAME'
+          value: storageAccount.name
+        }
+      ]
+    }
+  }
+}
diff --git a/src/Genocs.Auth/Genocs.Auth.csproj b/src/Genocs.Auth/Genocs.Auth.csproj
@@ -11,7 +11,7 @@
         <Version>6.1.0</Version>
         <MinClientVersion>5.0.0</MinClientVersion>
         <Authors>Nocco Giovanni Emanuele</Authors>
-        <PackageTags>aggregate architecture boilerplate ddd ddd-architecture design-patterns domain-driven-design dotnet dotnetcore dotnet-core microservice microservices solid solid-principles</PackageTags>
+        <PackageTags>microservice microservices solid solid-principles authentication genocs</PackageTags>
         <PackageReadmeFile>README_NUGET.md</PackageReadmeFile>
         <PackageReleaseNotes>Aligned to the ecosystem</PackageReleaseNotes>
         <EnableNETAnalyzers>True</EnableNETAnalyzers>
diff --git a/src/Genocs.Common/Genocs.Common.csproj b/src/Genocs.Common/Genocs.Common.csproj
@@ -11,7 +11,7 @@
         <Version>6.1.0</Version>
         <MinClientVersion>5.0.0</MinClientVersion>
         <Authors>Nocco Giovanni Emanuele</Authors>
-        <PackageTags>aggregate architecture boilerplate ddd ddd-architecture design-patterns domain-driven-design dotnet dotnetcore dotnet-core microservice microservices solid solid-principles</PackageTags>
+        <PackageTags>microservice microservices solid solid-principles genocs</PackageTags>
         <PackageReadmeFile>README_NUGET.md</PackageReadmeFile>
         <PackageReleaseNotes>Aligned to the ecosystem</PackageReleaseNotes>
         <EnableNETAnalyzers>True</EnableNETAnalyzers>
diff --git a/src/Genocs.Core/CQRS/Queries/IQueryDispatcher.cs b/src/Genocs.Core/CQRS/Queries/IQueryDispatcher.cs
@@ -1,7 +1,4 @@
-﻿using System.Threading.Tasks;
-using System.Threading;
-
-namespace Genocs.Core.CQRS.Queries;
+﻿namespace Genocs.Core.CQRS.Queries;
 
 /// <summary>
 /// The query dispatcher interface.
diff --git a/src/Genocs.Core/Genocs.Core.csproj b/src/Genocs.Core/Genocs.Core.csproj
@@ -11,7 +11,7 @@
         <Version>6.1.0</Version>
         <MinClientVersion>5.0.0</MinClientVersion>
         <Authors>Nocco Giovanni Emanuele</Authors>
-        <PackageTags>aggregate architecture boilerplate ddd ddd-architecture design-patterns domain-driven-design dotnet dotnetcore dotnet-core microservice microservices solid solid-principles</PackageTags>
+        <PackageTags>microservice microservices solid solid-principles genocs</PackageTags>
         <PackageReadmeFile>README_NUGET.md</PackageReadmeFile>
         <PackageReleaseNotes>Updated to NET8</PackageReleaseNotes>
         <EnableNETAnalyzers>True</EnableNETAnalyzers>
diff --git a/src/Genocs.Discovery.Consul/Genocs.Discovery.Consul.csproj b/src/Genocs.Discovery.Consul/Genocs.Discovery.Consul.csproj
@@ -11,7 +11,7 @@
         <Version>6.1.0</Version>
         <MinClientVersion>5.0.0</MinClientVersion>
         <Authors>Nocco Giovanni Emanuele</Authors>
-        <PackageTags>aggregate architecture boilerplate ddd ddd-architecture design-patterns domain-driven-design dotnet dotnetcore dotnet-core microservice microservices solid solid-principles</PackageTags>
+        <PackageTags>microservice microservices solid solid-principles genocs service-discovery</PackageTags>
         <PackageReadmeFile>README_NUGET.md</PackageReadmeFile>
         <PackageReleaseNotes>Aligned to the ecosystem</PackageReleaseNotes>
         <EnableNETAnalyzers>True</EnableNETAnalyzers>
diff --git a/src/Genocs.HTTP/Genocs.HTTP.csproj b/src/Genocs.HTTP/Genocs.HTTP.csproj
@@ -11,7 +11,7 @@
         <Version>6.1.0</Version>
         <MinClientVersion>5.0.0</MinClientVersion>
         <Authors>Nocco Giovanni Emanuele</Authors>
-        <PackageTags>aggregate architecture boilerplate ddd ddd-architecture design-patterns domain-driven-design dotnet dotnetcore dotnet-core microservice microservices solid solid-principles</PackageTags>
+        <PackageTags>microservice microservices solid solid-principles genocs http-client</PackageTags>
         <PackageReadmeFile>README_NUGET.md</PackageReadmeFile>
         <PackageReleaseNotes>Aligned to the ecosystem</PackageReleaseNotes>
         <EnableNETAnalyzers>True</EnableNETAnalyzers>
diff --git a/src/Genocs.WebApi.CQRS/Builders/DispatcherEndpointsBuilder.cs b/src/Genocs.WebApi.CQRS/Builders/DispatcherEndpointsBuilder.cs
@@ -31,7 +31,7 @@ public IDispatcherEndpointsBuilder Get(
     public IDispatcherEndpointsBuilder Get<TQuery, TResult>(
                                                             string path,
                                                             Func<TQuery, HttpContext, Task>? beforeDispatch = null,
-                                                            Func<TQuery, TResult, HttpContext, Task>? afterDispatch = null,
+                                                            Func<TQuery, TResult?, HttpContext, Task>? afterDispatch = null,
                                                             Action<IEndpointConventionBuilder>? endpoint = null,
                                                             bool auth = false,
                                                             string? roles = null,
diff --git a/src/Genocs.WebApi.CQRS/Extensions.cs b/src/Genocs.WebApi.CQRS/Extensions.cs
@@ -19,9 +19,11 @@ public static IGenocsBuilder AddInMemoryDispatcher(this IGenocsBuilder builder)
         return builder;
     }
 
-    public static IApplicationBuilder UseDispatcherEndpoints(this IApplicationBuilder app,
-        Action<IDispatcherEndpointsBuilder> builder, bool useAuthorization = true,
-        Action<IApplicationBuilder> middleware = null)
+    public static IApplicationBuilder UseDispatcherEndpoints(
+                                                                this IApplicationBuilder app,
+                                                                Action<IDispatcherEndpointsBuilder> builder,
+                                                                bool useAuthorization = true,
+                                                                Action<IApplicationBuilder>? middleware = null)
     {
         var definitions = app.ApplicationServices.GetRequiredService<WebApiEndpointDefinitions>();
         app.UseRouting();
diff --git a/src/Genocs.WebApi.CQRS/IDispatcher.cs b/src/Genocs.WebApi.CQRS/IDispatcher.cs
@@ -12,5 +12,5 @@ Task SendAsync<T>(T command, CancellationToken cancellationToken = default)
     Task PublishAsync<T>(T @event, CancellationToken cancellationToken = default)
         where T : class, IEvent;
 
-    Task<TResult> QueryAsync<TResult>(IQuery<TResult> query, CancellationToken cancellationToken = default);
+    Task<TResult?> QueryAsync<TResult>(IQuery<TResult> query, CancellationToken cancellationToken = default);
 }
diff --git a/src/Genocs.WebApi.CQRS/IDispatcherEndpointsBuilder.cs b/src/Genocs.WebApi.CQRS/IDispatcherEndpointsBuilder.cs
@@ -18,40 +18,64 @@ IDispatcherEndpointsBuilder Get(
     IDispatcherEndpointsBuilder Get<TQuery, TResult>(
                                                         string path,
                                                         Func<TQuery, HttpContext, Task>? beforeDispatch = null,
-                                                        Func<TQuery, TResult, HttpContext, Task>? afterDispatch = null,
+                                                        Func<TQuery, TResult?, HttpContext, Task>? afterDispatch = null,
                                                         Action<IEndpointConventionBuilder>? endpoint = null,
                                                         bool auth = false,
                                                         string? roles = null,
                                                         params string[] policies)
         where TQuery : class, IQuery<TResult>;
 
-    IDispatcherEndpointsBuilder Post(string path, Func<HttpContext, Task>? context = null,
-        Action<IEndpointConventionBuilder>? endpoint = null, bool auth = false, string? roles = null,
-        params string[] policies);
+    IDispatcherEndpointsBuilder Post(
+                                        string path,
+                                        Func<HttpContext, Task>? context = null,
+                                        Action<IEndpointConventionBuilder>? endpoint = null,
+                                        bool auth = false,
+                                        string? roles = null,
+                                        params string[] policies);
 
-    IDispatcherEndpointsBuilder Post<T>(string path, Func<T, HttpContext, Task>? beforeDispatch = null,
-        Func<T, HttpContext, Task>? afterDispatch = null, Action<IEndpointConventionBuilder>? endpoint = null,
-        bool auth = false, string? roles = null,
-        params string[] policies)
+    IDispatcherEndpointsBuilder Post<T>(
+                                            string path,
+                                            Func<T, HttpContext, Task>? beforeDispatch = null,
+                                            Func<T, HttpContext, Task>? afterDispatch = null,
+                                            Action<IEndpointConventionBuilder>? endpoint = null,
+                                            bool auth = false,
+                                            string? roles = null,
+                                            params string[] policies)
         where T : class, ICommand;
 
-    IDispatcherEndpointsBuilder Put(string path, Func<HttpContext, Task>? context = null,
-        Action<IEndpointConventionBuilder>? endpoint = null, bool auth = false, string? roles = null,
-        params string[] policies);
+    IDispatcherEndpointsBuilder Put(
+                                    string path,
+                                    Func<HttpContext, Task>? context = null,
+                                    Action<IEndpointConventionBuilder>? endpoint = null,
+                                    bool auth = false,
+                                    string? roles = null,
+                                    params string[] policies);
 
-    IDispatcherEndpointsBuilder Put<T>(string path, Func<T, HttpContext, Task>? beforeDispatch = null,
-        Func<T, HttpContext, Task>? afterDispatch = null, Action<IEndpointConventionBuilder>? endpoint = null,
-        bool auth = false, string? roles = null,
-        params string[] policies)
+    IDispatcherEndpointsBuilder Put<T>(
+                                        string path,
+                                        Func<T, HttpContext, Task>? beforeDispatch = null,
+                                        Func<T, HttpContext, Task>? afterDispatch = null,
+                                        Action<IEndpointConventionBuilder>? endpoint = null,
+                                        bool auth = false,
+                                        string? roles = null,
+                                        params string[] policies)
         where T : class, ICommand;
 
-    IDispatcherEndpointsBuilder Delete(string path, Func<HttpContext, Task>? context = null,
-        Action<IEndpointConventionBuilder>? endpoint = null, bool auth = false, string? roles = null,
-        params string[] policies);
+    IDispatcherEndpointsBuilder Delete(
+                                        string path,
+                                        Func<HttpContext, Task>? context = null,
+                                        Action<IEndpointConventionBuilder>? endpoint = null,
+                                        bool auth = false,
+                                        string? roles = null,
+                                        params string[] policies);
 
-    IDispatcherEndpointsBuilder Delete<T>(string path, Func<T, HttpContext, Task>? beforeDispatch = null,
-        Func<T, HttpContext, Task>? afterDispatch = null, Action<IEndpointConventionBuilder>? endpoint = null,
-        bool auth = false, string? roles = null,
-        params string[] policies)
+    IDispatcherEndpointsBuilder Delete<T>(
+                                            string path,
+                                            Func<T, HttpContext, Task>? beforeDispatch = null,
+                                            Func<T, HttpContext, Task>? afterDispatch = null,
+                                            Action<IEndpointConventionBuilder>? endpoint = null,
+                                            bool auth = false,
+                                            string? roles = null,
+                                            params string[] policies)
         where T : class, ICommand;
 }
diff --git a/src/Genocs.WebApi.CQRS/InMemoryDispatcher.cs b/src/Genocs.WebApi.CQRS/InMemoryDispatcher.cs
@@ -10,20 +10,24 @@ public class InMemoryDispatcher : IDispatcher
     private readonly IEventDispatcher _eventDispatcher;
     private readonly IQueryDispatcher _queryDispatcher;
 
-    public InMemoryDispatcher(ICommandDispatcher commandDispatcher, IEventDispatcher eventDispatcher,
-        IQueryDispatcher queryDispatcher)
+    public InMemoryDispatcher(
+                                ICommandDispatcher commandDispatcher,
+                                IEventDispatcher eventDispatcher,
+                                IQueryDispatcher queryDispatcher)
     {
         _commandDispatcher = commandDispatcher;
         _eventDispatcher = eventDispatcher;
         _queryDispatcher = queryDispatcher;
     }
 
-    public Task SendAsync<T>(T command, CancellationToken cancellationToken = default) where T : class, ICommand
+    public Task SendAsync<T>(T command, CancellationToken cancellationToken = default)
+        where T : class, ICommand
         => _commandDispatcher.SendAsync(command, cancellationToken);
 
-    public Task PublishAsync<T>(T @event, CancellationToken cancellationToken = default) where T : class, IEvent
+    public Task PublishAsync<T>(T @event, CancellationToken cancellationToken = default)
+        where T : class, IEvent
         => _eventDispatcher.PublishAsync(@event, cancellationToken);
 
-    public Task<TResult> QueryAsync<TResult>(IQuery<TResult> query, CancellationToken cancellationToken = default)
+    public Task<TResult?> QueryAsync<TResult>(IQuery<TResult> query, CancellationToken cancellationToken = default)
         => _queryDispatcher.QueryAsync(query, cancellationToken);
 }
diff --git a/src/Genocs.WebApi.CQRS/Middlewares/PublicContractsMiddleware.cs b/src/Genocs.WebApi.CQRS/Middlewares/PublicContractsMiddleware.cs
@@ -72,7 +72,6 @@ private void Load(Type attributeType)
 
             if (!string.IsNullOrWhiteSpace(name) && instance != null)
             {
-
                 if (Contracts.Commands.ContainsKey(name))
                 {
                     throw new InvalidOperationException($"Command: '{name}' already exists.");
@@ -89,12 +88,15 @@ private void Load(Type attributeType)
             object? instance = @event.GetDefaultInstance();
             string? name = instance?.GetType().Name;
 
-            if (Contracts.Events.ContainsKey(name))
+            if (!string.IsNullOrWhiteSpace(name) && instance != null)
             {
-                throw new InvalidOperationException($"Event: '{name}' already exists.");
-            }
+                if (Contracts.Events.ContainsKey(name))
+                {
+                    throw new InvalidOperationException($"Event: '{name}' already exists.");
+                }
 
-            Contracts.Events[name] = instance;
+                Contracts.Events[name] = instance;
+            }
         }
 
         _serializedContracts = JsonSerializer.Serialize(Contracts, SerializerOptions);
diff --git a/src/Genocs.WebApi.Security/CertificateMiddleware.cs b/src/Genocs.WebApi.Security/CertificateMiddleware.cs
@@ -11,7 +11,7 @@ internal sealed class CertificateMiddleware : IMiddleware
     private readonly ILogger<CertificateMiddleware> _logger;
     private readonly SecurityOptions.CertificateOptions _options;
     private readonly HashSet<string> _allowedHosts;
-    private readonly IDictionary<string, SecurityOptions.CertificateOptions.AclOptions> _acl;
+    private readonly IDictionary<string, SecurityOptions.CertificateOptions.AclOptions> _acl = new Dictionary<string, SecurityOptions.CertificateOptions.AclOptions>();
     private readonly IDictionary<string, string> _subjects = new Dictionary<string, string>();
     private readonly bool _validateAcl;
     private readonly bool _skipRevocationCheck;
@@ -23,7 +23,14 @@ public CertificateMiddleware(
     {
         _certificatePermissionValidator = certificatePermissionValidator;
         _logger = logger;
+
+        if (options.Certificate is null)
+        {
+            throw new ArgumentNullException(nameof(options.Certificate));
+        }
+
         _options = options.Certificate;
+
         _allowedHosts = new HashSet<string>(_options.AllowedHosts ?? Array.Empty<string>());
         _validateAcl = _options.Acl is not null && _options.Acl.Any();
         _skipRevocationCheck = options.Certificate.SkipRevocationCheck;
@@ -33,29 +40,36 @@ public CertificateMiddleware(
             return;
         }
 
-        _acl = new Dictionary<string, SecurityOptions.CertificateOptions.AclOptions>();
-        foreach (var (key, acl) in _options.Acl)
+        if (_options.Acl != null)
         {
-            if (!string.IsNullOrWhiteSpace(acl.ValidIssuer) && !acl.ValidIssuer.StartsWith("CN="))
+            foreach (var (key, acl) in _options.Acl)
             {
-                acl.ValidIssuer = $"CN={acl.ValidIssuer}";
-            }
+                if (!string.IsNullOrWhiteSpace(acl.ValidIssuer) && !acl.ValidIssuer.StartsWith("CN="))
+                {
+                    acl.ValidIssuer = $"CN={acl.ValidIssuer}";
+                }
 
-            string subject = key.StartsWith("CN=") ? key : $"CN={key}";
-            if (_options.AllowSubdomains)
-            {
-                foreach (string domain in options.Certificate.AllowedDomains ?? Enumerable.Empty<string>())
+                string subject = key.StartsWith("CN=") ? key : $"CN={key}";
+                if (_options.AllowSubdomains)
                 {
-                    _subjects.Add($"{subject}.{domain}", key);
+                    foreach (string domain in options.Certificate.AllowedDomains ?? Enumerable.Empty<string>())
+                    {
+                        _subjects.Add($"{subject}.{domain}", key);
+                    }
                 }
-            }
 
-            _acl.Add(_subjects.Any() ? key : subject, acl);
+                _acl.Add(_subjects.Any() ? key : subject, acl);
+            }
         }
     }
 
     public Task InvokeAsync(HttpContext context, RequestDelegate next)
     {
+        if (_options is null)
+        {
+            return next(context);
+        }
+
         if (!_options.Enabled)
         {
             return next(context);
diff --git a/src/Genocs.WebApi.Security/Configurations/SecurityOptions.cs b/src/Genocs.WebApi.Security/Configurations/SecurityOptions.cs
@@ -14,7 +14,8 @@ public class CertificateOptions
         public IDictionary<string, AclOptions>? Acl { get; set; }
         public bool SkipRevocationCheck { get; set; }
 
-        public string GetHeaderName() => string.IsNullOrWhiteSpace(Header) ? "Certificate" : Header;
+        public string GetHeaderName()
+            => string.IsNullOrWhiteSpace(Header) ? "Certificate" : Header;
 
         public class AclOptions
         {
diff --git a/src/Genocs.WebApi.Security/Extensions.cs b/src/Genocs.WebApi.Security/Extensions.cs
@@ -17,6 +17,12 @@ public static IGenocsBuilder AddCertificateAuthentication(
                                                                 string sectionName = SectionName,
                                                                 Type? permissionValidatorType = null)
     {
+
+        if (string.IsNullOrWhiteSpace(sectionName))
+        {
+            sectionName = SectionName;
+        }
+
         var options = builder.GetOptions<SecurityOptions>(sectionName);
         builder.Services.AddSingleton(options);
         if (!builder.TryRegister(RegistryName))

Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,11 @@ public static IGenocsBuilder AddInMemoryDispatcher(this IGenocsBuilder builder)`
`19`	`19`	`return builder;`
`20`	`20`	`}`
`21`	`21`
`22`		`- public static IApplicationBuilder UseDispatcherEndpoints(this IApplicationBuilder app,`
`23`		`- Action<IDispatcherEndpointsBuilder> builder, bool useAuthorization = true,`
`24`		`- Action<IApplicationBuilder> middleware = null)`
	`22`	`+ public static IApplicationBuilder UseDispatcherEndpoints(`
	`23`	`+ this IApplicationBuilder app,`
	`24`	`+ Action<IDispatcherEndpointsBuilder> builder,`
	`25`	`+ bool useAuthorization = true,`
	`26`	`+ Action<IApplicationBuilder>? middleware = null)`
`25`	`27`	`{`
`26`	`28`	`var definitions = app.ApplicationServices.GetRequiredService<WebApiEndpointDefinitions>();`
`27`	`29`	`app.UseRouting();`
Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,5 @@ Task SendAsync<T>(T command, CancellationToken cancellationToken = default)`
`12`	`12`	`Task PublishAsync<T>(T @event, CancellationToken cancellationToken = default)`
`13`	`13`	`where T : class, IEvent;`
`14`	`14`
`15`		`- Task<TResult> QueryAsync<TResult>(IQuery<TResult> query, CancellationToken cancellationToken = default);`
	`15`	`+ Task<TResult?> QueryAsync<TResult>(IQuery<TResult> query, CancellationToken cancellationToken = default);`
`16`	`16`	`}`