Some logging improvements

Author: msmolka

README.md

@@ -40,7 +40,7 @@ When you install the package, it should be added to your `.csproj`. Alternativel
 
 ```xml
 <ItemGroup>
-    <PackageReference Include="ZNetCS.AspNetCore.Authentication.Basic" Version="6.0.0" />
+    <PackageReference Include="ZNetCS.AspNetCore.Authentication.Basic" Version="6.0.1" />
 </ItemGroup>
 ```
 

src/Directory.Build.props

@@ -1,6 +1,6 @@
 <Project>
   <PropertyGroup>
-    <Version>6.0.0</Version>
+    <Version>6.0.1</Version>
     <PackageReleaseNotes>Breaking Change: Drop support for netstandard and .net framework. Code refactoring. Dependency update. Nullable enable. Events are initialized once in handler only or configuration.</PackageReleaseNotes>
   </PropertyGroup>
 

src/ZNetCS.AspNetCore.Authentication.Basic/BasicAuthenticationHandler.cs

@@ -9,7 +9,7 @@
 
 namespace ZNetCS.AspNetCore.Authentication.Basic;
 
-#region Usings
+    #region Usings
 
 using System;
 using System.Diagnostics.CodeAnalysis;
@@ -53,6 +53,15 @@ public class BasicAuthenticationHandler : AuthenticationHandler<BasicAuthenticat
 
     #endregion
 
+    #region Fields
+
+    /// <summary>
+    /// The logger.
+    /// </summary>
+    private readonly ILogger logger;
+
+    #endregion
+
     #region Constructors and Destructors
 
     /// <summary>
@@ -61,19 +70,18 @@ public class BasicAuthenticationHandler : AuthenticationHandler<BasicAuthenticat
     /// <param name="options">
     /// The options.
     /// </param>
-    /// <param name="logger">
-    /// The logger.
+    /// <param name="loggerFactory">
+    /// The logger factory.
     /// </param>
     /// <param name="encoder">
     /// The encoder.
     /// </param>
     /// <param name="clock">
     /// The clock.
     /// </param>
-    public BasicAuthenticationHandler(IOptionsMonitor<BasicAuthenticationOptions> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock)
-        : base(options, logger, encoder, clock)
-    {
-    }
+    public BasicAuthenticationHandler(IOptionsMonitor<BasicAuthenticationOptions> options, ILoggerFactory loggerFactory, UrlEncoder encoder, ISystemClock clock)
+        : base(options, loggerFactory, encoder, clock)
+        => this.logger = loggerFactory.CreateLogger<BasicAuthenticationHandler>();
 
     #endregion
 
@@ -108,7 +116,7 @@ protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
         // there is no authorization header so there is nothing to do by this middleware
         if (authorizationHeaderValues.Length == 0)
         {
-            this.Logger.LogDebug("'Authorization' header is not present in the request.");
+            this.logger.AuthorizationHeaderNotPresent();
             return AuthenticateResult.NoResult();
         }
 
@@ -117,7 +125,7 @@ protected override async Task<AuthenticateResult> HandleAuthenticateAsync()
         // Authorization header is not 'Basic' so there is nothing to do by this middleware
         if (string.IsNullOrEmpty(basicAuthorizationHeader))
         {
-            this.Logger.LogDebug("'Authorization' header is not in 'Basic' scheme in the request.");
+            this.logger.AuthorizationHeaderNotBasic();
             return AuthenticateResult.NoResult();
         }
 
@@ -170,7 +178,8 @@ protected override Task HandleChallengeAsync(AuthenticationProperties context)
             return Task.CompletedTask;
         }
 
-        if (this.Options.AjaxRequestOptions.SuppressWwwAuthenticateHeader && this.Request.Headers.TryGetValue(this.Options.AjaxRequestOptions.HeaderName, out StringValues value))
+        if (this.Options.AjaxRequestOptions.SuppressWwwAuthenticateHeader &&
+            this.Request.Headers.TryGetValue(this.Options.AjaxRequestOptions.HeaderName, out StringValues value))
         {
             if (value == this.Options.AjaxRequestOptions.HeaderValue)
             {

src/ZNetCS.AspNetCore.Authentication.Basic/LoggerExtensions.cs

@@ -0,0 +1,44 @@
+// -----------------------------------------------------------------------
+// <copyright file="LoggerExtensions.cs" company="Marcin Smółka">
+//   Copyright (c) Marcin Smółka. All rights reserved.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace ZNetCS.AspNetCore.Authentication.Basic;
+
+#region Usings
+
+using System;
+using System.Diagnostics.CodeAnalysis;
+
+using Microsoft.Extensions.Logging;
+
+#endregion
+
+[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "Internal")]
+internal static class LoggerExtensions
+{
+    #region Static Fields
+
+    private static readonly Action<ILogger, Exception?> AuthorizationHeaderNotBasicDefinition =
+        LoggerMessage.Define(LogLevel.Debug, new EventId(100, "AuthorizationHeaderNotPresent"), "'Authorization' header is not in 'Basic' scheme in the request");
+
+    private static readonly Action<ILogger, Exception?> AuthorizationHeaderNotPresentDefinition =
+        LoggerMessage.Define(LogLevel.Debug, new EventId(100, "AuthorizationHeaderNotPresent"), "'Authorization' header is not present in the request");
+
+    #endregion
+
+    #region Public Methods
+
+    public static void AuthorizationHeaderNotBasic(this ILogger logger)
+    {
+        AuthorizationHeaderNotBasicDefinition(logger, null);
+    }
+
+    public static void AuthorizationHeaderNotPresent(this ILogger logger)
+    {
+        AuthorizationHeaderNotPresentDefinition(logger, null);
+    }
+
+    #endregion
+}