Updated conventions (#1995)

RocketSurgeonsGuild · May 3, 2024 · c55e387 · c55e387
1 parent 4fecf0c
commit c55e387
Show file tree

Hide file tree

Showing 25 changed files with 112 additions and 69 deletions.
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -94,15 +94,15 @@
     <PackageVersion Include="Polly" Version="8.3.1" />
     <PackageVersion Include="StronglyTypedId" Version="1.0.0-beta08" />
     <PackageVersion Include="Rocket.Surgery.Build.Information" Version="3.3.11" />
-    <PackageVersion Include="Rocket.Surgery.Conventions" Version="14.0.1-beta.1" />
-    <PackageVersion Include="Rocket.Surgery.Conventions.Abstractions" Version="14.0.1-beta.1" />
-    <PackageVersion Include="Rocket.Surgery.CommandLine" Version="14.0.1-beta.1" />
-    <PackageVersion Include="Rocket.Surgery.Conventions.DependencyModel" Version="14.0.1-beta.1" />
-    <PackageVersion Include="Rocket.Surgery.Conventions.DryIoc" Version="14.0.1-beta.1" />
+    <PackageVersion Include="Rocket.Surgery.Conventions" Version="14.0.1-beta.2" />
+    <PackageVersion Include="Rocket.Surgery.Conventions.Abstractions" Version="14.0.1-beta.2" />
+    <PackageVersion Include="Rocket.Surgery.CommandLine" Version="14.0.1-beta.2" />
+    <PackageVersion Include="Rocket.Surgery.Conventions.DependencyModel" Version="14.0.1-beta.2" />
+    <PackageVersion Include="Rocket.Surgery.Conventions.DryIoc" Version="14.0.1-beta.2" />
     <PackageVersion Include="Rocket.Surgery.DependencyInjection.Extensions" Version="12.1.0" />
     <PackageVersion Include="Rocket.Surgery.Extensions" Version="12.1.0" />
-    <PackageVersion Include="Rocket.Surgery.Hosting" Version="14.0.1-beta.1" />
-    <PackageVersion Include="Rocket.Surgery.WebAssembly.Hosting" Version="14.0.1-beta.1" />
+    <PackageVersion Include="Rocket.Surgery.Hosting" Version="14.0.1-beta.2" />
+    <PackageVersion Include="Rocket.Surgery.WebAssembly.Hosting" Version="14.0.1-beta.2" />
     <PackageVersion Include="Scrutor" Version="4.2.2" />
     <PackageVersion Include="Serilog" Version="3.1.1" />
     <PackageVersion Include="Serilog.AspNetCore" Version="8.0.1" />

diff --git a/Readme.md b/Readme.md
@@ -42,7 +42,6 @@ A common set of libraries used to build console and web applications.
 | Rocket.Surgery.LaunchPad.StrawberryShake.Spatial | [![nuget-version-zeenxt+snrtq-badge]![nuget-downloads-zeenxt+snrtq-badge]][nuget-zeenxt+snrtq] |
 | Rocket.Surgery.LaunchPad.Telemetry | [![nuget-version-ge/ixoxynyea-badge]![nuget-downloads-ge/ixoxynyea-badge]][nuget-ge/ixoxynyea] |
 | Rocket.Surgery.LaunchPad.Testing | [![nuget-version-bhdja8ikzcgq-badge]![nuget-downloads-bhdja8ikzcgq-badge]][nuget-bhdja8ikzcgq] |
-| Rocket.Surgery.LaunchPad.Web.Hosting | [![nuget-version-r6lkw/f1bsvg-badge]![nuget-downloads-r6lkw/f1bsvg-badge]][nuget-r6lkw/f1bsvg] |
 <!-- nuget packages -->
 
 # Whats next?
@@ -125,9 +124,6 @@ TBD
 [nuget-bhdja8ikzcgq]: https://www.nuget.org/packages/Rocket.Surgery.LaunchPad.Testing/
 [nuget-version-bhdja8ikzcgq-badge]: https://img.shields.io/nuget/v/Rocket.Surgery.LaunchPad.Testing.svg?color=004880&logo=nuget&style=flat-square "NuGet Version"
 [nuget-downloads-bhdja8ikzcgq-badge]: https://img.shields.io/nuget/dt/Rocket.Surgery.LaunchPad.Testing.svg?color=004880&logo=nuget&style=flat-square "NuGet Downloads"
-[nuget-r6lkw/f1bsvg]: https://www.nuget.org/packages/Rocket.Surgery.LaunchPad.Web.Hosting/
-[nuget-version-r6lkw/f1bsvg-badge]: https://img.shields.io/nuget/v/Rocket.Surgery.LaunchPad.Web.Hosting.svg?color=004880&logo=nuget&style=flat-square "NuGet Version"
-[nuget-downloads-r6lkw/f1bsvg-badge]: https://img.shields.io/nuget/dt/Rocket.Surgery.LaunchPad.Web.Hosting.svg?color=004880&logo=nuget&style=flat-square "NuGet Downloads"
 <!-- generated references -->
 
 <!-- nuke-data

diff --git a/src/Foundation.NewtonsoftJson/Conventions/NewtonsoftJsonConvention.cs b/src/Foundation.NewtonsoftJson/Conventions/NewtonsoftJsonConvention.cs
@@ -20,7 +20,7 @@ namespace Rocket.Surgery.LaunchPad.Foundation.Conventions;
 public class NewtonsoftJsonConvention : IServiceConvention, ISerilogConvention
 {
     /// <inheritdoc />
-    public void Register(IConventionContext context, IServiceProvider services, IConfiguration configuration, LoggerConfiguration loggerConfiguration)
+    public void Register(IConventionContext context, IConfiguration configuration, IServiceProvider services, LoggerConfiguration loggerConfiguration)
     {
         loggerConfiguration.Destructure.NewtonsoftJsonTypes();
     }
@@ -44,4 +44,4 @@ public void Register(IConventionContext context, IConfiguration configuration, I
                 )
         );
     }
-}
+}
diff --git a/src/Foundation/Conventions/NodaTimeConvention.cs b/src/Foundation/Conventions/NodaTimeConvention.cs
@@ -30,7 +30,7 @@ public NodaTimeConvention(FoundationOptions? options = null)
     }
 
     /// <inheritdoc />
-    public void Register(IConventionContext context, IServiceProvider services, IConfiguration configuration, LoggerConfiguration loggerConfiguration)
+    public void Register(IConventionContext context, IConfiguration configuration, IServiceProvider services, LoggerConfiguration loggerConfiguration)
     {
         loggerConfiguration.Destructure.NodaTimeTypes(services.GetRequiredService<IDateTimeZoneProvider>());
     }

diff --git a/src/Foundation/Conventions/SystemTextJsonConvention.cs b/src/Foundation/Conventions/SystemTextJsonConvention.cs
@@ -21,7 +21,7 @@ namespace Rocket.Surgery.LaunchPad.Foundation.Conventions;
 public class SystemTextJsonConvention : IServiceConvention, ISerilogConvention
 {
     /// <inheritdoc />
-    public void Register(IConventionContext context, IServiceProvider services, IConfiguration configuration, LoggerConfiguration loggerConfiguration)
+    public void Register(IConventionContext context, IConfiguration configuration, IServiceProvider services, LoggerConfiguration loggerConfiguration)
     {
         loggerConfiguration.Destructure.SystemTextJsonTypes();
     }
@@ -49,4 +49,4 @@ public void Register(IConventionContext context, IConfiguration configuration, I
                 )
         );
     }
-}
+}
diff --git a/src/Hosting/Conventions/EnvironmentLoggingConvention.cs b/src/Hosting/Conventions/EnvironmentLoggingConvention.cs
@@ -24,8 +24,8 @@ public class EnvironmentLoggingConvention : ISerilogConvention
     /// <param name="loggerConfiguration"></param>
     public void Register(
         IConventionContext context,
-        IServiceProvider services,
         IConfiguration configuration,
+        IServiceProvider services,
         LoggerConfiguration loggerConfiguration
     )
     {

diff --git a/src/Hosting/Conventions/SerilogConsoleLoggingConvention.cs b/src/Hosting/Conventions/SerilogConsoleLoggingConvention.cs
@@ -32,8 +32,8 @@ public SerilogConsoleLoggingConvention(LaunchPadLoggingOptions? options = null)
     /// <inheritdoc />
     public void Register(
         IConventionContext context,
-        IServiceProvider services,
         IConfiguration configuration,
+        IServiceProvider services,
         LoggerConfiguration loggerConfiguration
     )
     {

diff --git a/src/Hosting/Conventions/SerilogDebugLoggingConvention.cs b/src/Hosting/Conventions/SerilogDebugLoggingConvention.cs
@@ -31,8 +31,8 @@ public SerilogDebugLoggingConvention(LaunchPadLoggingOptions? options = null)
     /// <inheritdoc />
     public void Register(
         IConventionContext context,
-        IServiceProvider services,
         IConfiguration configuration,
+        IServiceProvider services,
         LoggerConfiguration loggerConfiguration
     )
     {

diff --git a/src/Hosting/Conventions/SerilogHostingConvention.cs b/src/Hosting/Conventions/SerilogHostingConvention.cs
@@ -39,8 +39,12 @@ public void Register(IConventionContext context, IHostApplicationBuilder builder
         foreach (var item in builder
                             .Services
                             .Where(
-                                 x => x.ImplementationType?.FullName?.StartsWith("Microsoft.Extensions.Logging", StringComparison.Ordinal) == true
-                                  && x.ImplementationType?.FullName.EndsWith("Provider", StringComparison.Ordinal) == true
+                                 x =>
+                                 {
+                                     var type = x.IsKeyedService ? x.KeyedImplementationType : x.ImplementationType;
+                                     return type?.FullName?.StartsWith("Microsoft.Extensions.Logging", StringComparison.Ordinal) == true
+                                      && type.FullName.EndsWith("Provider", StringComparison.Ordinal);
+                                 }
                              )
                             .ToArray()
                 )
@@ -55,7 +59,7 @@ public void Register(IConventionContext context, IHostApplicationBuilder builder
         else
         {
             builder.Services.AddSerilog(
-                (services, loggerConfiguration) => loggerConfiguration.ApplyConventions(context, services),
+                (services, loggerConfiguration) => loggerConfiguration.ApplyConventions(context, builder.Configuration, services),
                 _options.PreserveStaticLogger,
                 _options.WriteToProviders
             );

diff --git a/src/Serilog/Conventions/ConfigureOptionsLoggingConvention.cs b/src/Serilog/Conventions/ConfigureOptionsLoggingConvention.cs
@@ -19,13 +19,13 @@ public class ConfigureOptionsLoggingConvention : ISerilogConvention
     ///     Registers the specified context.
     /// </summary>
     /// <param name="context">The context.</param>
-    /// <param name="services"></param>
     /// <param name="configuration"></param>
+    /// <param name="services"></param>
     /// <param name="loggerConfiguration"></param>
     public void Register(
         IConventionContext context,
-        IServiceProvider services,
         IConfiguration configuration,
+        IServiceProvider services,
         LoggerConfiguration loggerConfiguration
     )
     {

diff --git a/src/Serilog/Conventions/SerilogEnrichEnvironmentLoggingConvention.cs b/src/Serilog/Conventions/SerilogEnrichEnvironmentLoggingConvention.cs
@@ -17,13 +17,13 @@ public class SerilogEnrichEnvironmentLoggingConvention : ISerilogConvention
     ///     Registers the specified context.
     /// </summary>
     /// <param name="context">The context.</param>
-    /// <param name="services"></param>
     /// <param name="configuration"></param>
+    /// <param name="services"></param>
     /// <param name="loggerConfiguration"></param>
     public void Register(
         IConventionContext context,
-        IServiceProvider services,
         IConfiguration configuration,
+        IServiceProvider services,
         LoggerConfiguration loggerConfiguration
     )
     {

diff --git a/src/Serilog/Conventions/SerilogEnrichLoggingConvention.cs b/src/Serilog/Conventions/SerilogEnrichLoggingConvention.cs
@@ -18,13 +18,13 @@ public class SerilogEnrichLoggingConvention : ISerilogConvention
     ///     Registers the specified context.
     /// </summary>
     /// <param name="context">The context.</param>
-    /// <param name="services"></param>
     /// <param name="configuration"></param>
+    /// <param name="services"></param>
     /// <param name="loggerConfiguration"></param>
     public void Register(
         IConventionContext context,
-        IServiceProvider services,
         IConfiguration configuration,
+        IServiceProvider services,
         LoggerConfiguration loggerConfiguration
     )
     {

diff --git a/src/Serilog/Conventions/SerilogEnrichSpansConvention.cs b/src/Serilog/Conventions/SerilogEnrichSpansConvention.cs
@@ -18,13 +18,13 @@ public class SerilogEnrichSpansConvention : ISerilogConvention
     ///     Registers the specified context.
     /// </summary>
     /// <param name="context">The context.</param>
-    /// <param name="services"></param>
     /// <param name="configuration"></param>
+    /// <param name="services"></param>
     /// <param name="loggerConfiguration"></param>
     public void Register(
         IConventionContext context,
-        IServiceProvider services,
         IConfiguration configuration,
+        IServiceProvider services,
         LoggerConfiguration loggerConfiguration
     )
     {

diff --git a/src/Serilog/Conventions/SerilogReadFromConfigurationConvention.cs b/src/Serilog/Conventions/SerilogReadFromConfigurationConvention.cs
@@ -48,8 +48,8 @@ public void Register(IConventionContext context, IConfiguration configuration, I
     /// <inheritdoc />
     public void Register(
         IConventionContext context,
-        IServiceProvider services,
         IConfiguration configuration,
+        IServiceProvider services,
         LoggerConfiguration loggerConfiguration
     )
     {

diff --git a/src/Serilog/ISerilogConvention.cs b/src/Serilog/ISerilogConvention.cs
@@ -15,8 +15,8 @@ public interface ISerilogConvention : IConvention
     ///     A serilog convention
     /// </summary>
     /// <param name="context"></param>
-    /// <param name="services"></param>
     /// <param name="configuration"></param>
+    /// <param name="services"></param>
     /// <param name="loggerConfiguration"></param>
-    void Register(IConventionContext context, IServiceProvider services, IConfiguration configuration, LoggerConfiguration loggerConfiguration);
-}
+    void Register(IConventionContext context, IConfiguration configuration, IServiceProvider services, LoggerConfiguration loggerConfiguration);
+}
diff --git a/src/Serilog/RocketSurgerySerilogExtensions.cs b/src/Serilog/RocketSurgerySerilogExtensions.cs
@@ -15,22 +15,22 @@ public static class RocketSurgerySerilogExtensions
     ///     Apply configuration conventions
     /// </summary>
     /// <param name="configurationBuilder"></param>
-    /// <param name="conventionContext"></param>
+    /// <param name="context"></param>
+    /// <param name="configuration"></param>
     /// <param name="services"></param>
     /// <returns></returns>
     public static LoggerConfiguration ApplyConventions(
         this LoggerConfiguration configurationBuilder,
-        IConventionContext conventionContext,
+        IConventionContext context,
+        IConfiguration configuration,
         IServiceProvider services
     )
     {
-        var configuration = conventionContext.Get<IConfiguration>()
-         ?? throw new ArgumentException("Configuration was not found in context", nameof(conventionContext));
-        foreach (var item in conventionContext.Conventions.Get<ISerilogConvention, SerilogConvention>())
+        foreach (var item in context.Conventions.Get<ISerilogConvention, SerilogConvention>())
         {
             if (item is ISerilogConvention convention)
-                convention.Register(conventionContext, services, configuration, configurationBuilder);
-            else if (item is SerilogConvention @delegate) @delegate(conventionContext, services, configuration, configurationBuilder);
+                convention.Register(context, configuration, services, configurationBuilder);
+            else if (item is SerilogConvention @delegate) @delegate(context, configuration, services, configurationBuilder);
         }
 
         return configurationBuilder;

diff --git a/src/Serilog/SerilogAbstractionsHostBuilderExtensions.cs b/src/Serilog/SerilogAbstractionsHostBuilderExtensions.cs
@@ -1,6 +1,8 @@
-// ReSharper disable once CheckNamespace
-
+using Microsoft.Extensions.Configuration;
 using Rocket.Surgery.LaunchPad.Serilog;
+using Serilog;
+
+// ReSharper disable once CheckNamespace
 
 // ReSharper disable once CheckNamespace
 namespace Rocket.Surgery.Conventions;
@@ -11,6 +13,45 @@ namespace Rocket.Surgery.Conventions;
 [PublicAPI]
 public static class SerilogAbstractionsHostBuilderExtensions
 {
+    /// <summary>
+    ///     Configure the serilog delegate to the convention scanner
+    /// </summary>
+    /// <param name="container">The container.</param>
+    /// <param name="delegate">The delegate.</param>
+    /// <returns>IConventionHostBuilder.</returns>
+    public static ConventionContextBuilder ConfigureSerilog(this ConventionContextBuilder container, Action<LoggerConfiguration> @delegate)
+    {
+        return ConfigureSerilog(container, (_, _, _, logger) => @delegate(logger));
+    }
+
+    /// <summary>
+    ///     Configure the serilog delegate to the convention scanner
+    /// </summary>
+    /// <param name="container">The container.</param>
+    /// <param name="delegate">The delegate.</param>
+    /// <returns>IConventionHostBuilder.</returns>
+    public static ConventionContextBuilder ConfigureSerilog(
+        this ConventionContextBuilder container,
+        Action<IConfiguration, IServiceProvider, LoggerConfiguration> @delegate
+    )
+    {
+        return ConfigureSerilog(container, (_, configuration, services, logger) => @delegate(configuration, services, logger));
+    }
+
+    /// <summary>
+    ///     Configure the serilog delegate to the convention scanner
+    /// </summary>
+    /// <param name="container">The container.</param>
+    /// <param name="delegate">The delegate.</param>
+    /// <returns>IConventionHostBuilder.</returns>
+    public static ConventionContextBuilder ConfigureSerilog(
+        this ConventionContextBuilder container,
+        Action<IServiceProvider, LoggerConfiguration> @delegate
+    )
+    {
+        return ConfigureSerilog(container, (_, _, services, logger) => @delegate(services, logger));
+    }
+
     /// <summary>
     ///     Configure the serilog delegate to the convention scanner
     /// </summary>
@@ -20,7 +61,6 @@ public static class SerilogAbstractionsHostBuilderExtensions
     public static ConventionContextBuilder ConfigureSerilog(this ConventionContextBuilder container, SerilogConvention @delegate)
     {
         ArgumentNullException.ThrowIfNull(container);
-
         ArgumentNullException.ThrowIfNull(@delegate);
 
         container.AppendDelegate(@delegate);

diff --git a/src/Serilog/SerilogConventionDelegate.cs b/src/Serilog/SerilogConventionDelegate.cs
@@ -8,10 +8,13 @@ namespace Rocket.Surgery.LaunchPad.Serilog;
 ///     Delegate SerilogConventionDelegate
 /// </summary>
 /// <param name="context">The context.</param>
-/// <param name="services">The services.</param>
 /// <param name="configuration">The configuration.</param>
+/// <param name="services">The services.</param>
 /// <param name="loggerConfiguration">The logger configuration.</param>
 [PublicAPI]
 public delegate void SerilogConvention(
-    IConventionContext context, IServiceProvider services, IConfiguration configuration, LoggerConfiguration loggerConfiguration
-);
+    IConventionContext context,
+    IConfiguration configuration,
+    IServiceProvider services,
+    LoggerConfiguration loggerConfiguration
+);
diff --git a/src/Spatial/Conventions/SpatialConvention.cs b/src/Spatial/Conventions/SpatialConvention.cs
@@ -19,7 +19,7 @@ namespace Rocket.Surgery.LaunchPad.Spatial.Conventions;
 public class SpatialConvention : IServiceConvention, ISerilogConvention
 {
     /// <inheritdoc />
-    public void Register(IConventionContext context, IServiceProvider services, IConfiguration configuration, LoggerConfiguration loggerConfiguration)
+    public void Register(IConventionContext context, IConfiguration configuration, IServiceProvider services, LoggerConfiguration loggerConfiguration)
     {
         loggerConfiguration.Destructure.NetTopologySuiteTypes();
     }
@@ -35,4 +35,4 @@ public void Register(IConventionContext context, IConfiguration configuration, I
                 (options, factory) => options.ConfigureGeoJsonForLaunchPad(factory)
             );
     }
-}
+}
diff --git a/src/Telemetry/IOpenTelemetryAsyncConvention.cs b/src/Telemetry/IOpenTelemetryAsyncConvention.cs
@@ -14,9 +14,9 @@ public interface IOpenTelemetryAsyncConvention : IConvention
     /// <summary>
     ///     Register metrics
     /// </summary>
-    /// <param name="conventionContext"></param>
+    /// <param name="context"></param>
     /// <param name="configuration"></param>
     /// <param name="builder"></param>
     /// <param name="cancellationToken"></param>
-    ValueTask Register(IConventionContext conventionContext, IConfiguration configuration, IOpenTelemetryBuilder builder, CancellationToken cancellationToken);
+    ValueTask Register(IConventionContext context, IConfiguration configuration, IOpenTelemetryBuilder builder, CancellationToken cancellationToken);
 }
diff --git a/src/Telemetry/OpenTelemetryAsyncConvention.cs b/src/Telemetry/OpenTelemetryAsyncConvention.cs
@@ -7,12 +7,12 @@ namespace Rocket.Surgery.LaunchPad.Telemetry;
 /// <summary>
 ///     Delegate OpenTelemetryAsyncConvention
 /// </summary>
-/// <param name="conventionContext"></param>
+/// <param name="context"></param>
 /// <param name="configuration"></param>
 /// <param name="builder"></param>
 /// <param name="cancellationToken"></param>
 public delegate ValueTask OpenTelemetryAsyncConvention(
-    IConventionContext conventionContext,
+    IConventionContext context,
     IConfiguration configuration,
     IOpenTelemetryBuilder builder,
     CancellationToken cancellationToken

diff --git a/src/Telemetry/OpenTelemetryConvention.cs b/src/Telemetry/OpenTelemetryConvention.cs
@@ -7,7 +7,7 @@ namespace Rocket.Surgery.LaunchPad.Telemetry;
 /// <summary>
 ///     Delegate OpenTelemetryConvention
 /// </summary>
-/// <param name="conventionContext"></param>
+/// <param name="context"></param>
 /// <param name="configuration"></param>
 /// <param name="builder"></param>
-public delegate void OpenTelemetryConvention(IConventionContext conventionContext, IConfiguration configuration, IOpenTelemetryBuilder builder);
+public delegate void OpenTelemetryConvention(IConventionContext context, IConfiguration configuration, IOpenTelemetryBuilder builder);