Use LoggerMessage in HttpAbstractions

Author: pranavkm

src/Hosting/Hosting/src/Internal/HostingLoggerExtensions.cs

@@ -11,28 +11,23 @@
 
 namespace Microsoft.AspNetCore.Hosting
 {
-    internal static class HostingLoggerExtensions
+    internal static partial class HostingLoggerExtensions
     {
-        private static readonly Action<ILogger, string, Exception?> _startupAssemblyLoaded =
-                LoggerMessage.Define<string>(LogLevel.Debug, LoggerEventIds.HostingStartupAssemblyLoaded, "Loaded hosting startup assembly {assemblyName}", skipEnabledCheck: true);
-
-        private static readonly Action<ILogger, string, Exception?> _listeningOnAddress =
-                LoggerMessage.Define<string>(LogLevel.Information, LoggerEventIds.ServerListeningOnAddresses, "Now listening on: {address}");
-
         public static IDisposable RequestScope(this ILogger logger, HttpContext httpContext)
         {
             return logger.BeginScope(new HostingLogScope(httpContext));
         }
 
-        public static void ListeningOnAddress(this ILogger logger, string address)
-        {
-            _listeningOnAddress(logger, address, null);
-        }
+        [LoggerMessage(LoggerEventIds.ServerListeningOnAddresses, LogLevel.Information,
+            "Now listening on: {address}",
+            EventName = "ListeningOnAddress")]
+        public static partial void ListeningOnAddress(this ILogger logger, string address);
 
-        public static void StartupAssemblyLoaded(this ILogger logger, string assemblyName)
-        {
-            _startupAssemblyLoaded(logger, assemblyName, null);
-        }
+        [LoggerMessage(LoggerEventIds.HostingStartupAssemblyLoaded, LogLevel.Debug,
+            "Loaded hosting startup assembly {assemblyName}",
+            EventName = "HostingStartupAssemblyLoaded",
+            SkipEnabledCheck = true)]
+        public static partial void StartupAssemblyLoaded(this ILogger logger, string assemblyName);
 
         public static void ApplicationError(this ILogger logger, Exception exception)
         {
@@ -52,8 +47,7 @@ public static void HostingStartupAssemblyError(this ILogger logger, Exception ex
 
         public static void ApplicationError(this ILogger logger, EventId eventId, string message, Exception exception)
         {
-            var reflectionTypeLoadException = exception as ReflectionTypeLoadException;
-            if (reflectionTypeLoadException != null)
+            if (exception is ReflectionTypeLoadException reflectionTypeLoadException)
             {
                 foreach (var ex in reflectionTypeLoadException.LoaderExceptions)
                 {
@@ -167,7 +161,7 @@ public override string ToString()
 
             public IEnumerator<KeyValuePair<string, object>> GetEnumerator()
             {
-                for (int i = 0; i < Count; ++i)
+                for (var i = 0; i < Count; ++i)
                 {
                     yield return this[i];
                 }

src/Hosting/Hosting/src/Internal/LoggerEventIds.cs

@@ -1,24 +1,23 @@
 // Copyright (c) .NET Foundation. All rights reserved.
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
-using Microsoft.Extensions.Logging;
 
 namespace Microsoft.AspNetCore.Hosting
 {
     internal static class LoggerEventIds
     {
-        public static readonly EventId RequestStarting = new EventId(1, "RequestStarting");
-        public static readonly EventId RequestFinished = new EventId(2, "RequestFinished");
-        public static readonly EventId Starting = new EventId(3, "Starting");
-        public static readonly EventId Started = new EventId(4, "Started");
-        public static readonly EventId Shutdown = new EventId(5, "Shutdown");
-        public static readonly EventId ApplicationStartupException = new EventId(6, "ApplicationStartupException");
-        public static readonly EventId ApplicationStoppingException = new EventId(7, "ApplicationStoppingException");
-        public static readonly EventId ApplicationStoppedException = new EventId(8, "ApplicationStoppedException");
-        public static readonly EventId HostedServiceStartException = new EventId(9, "HostedServiceStartException");
-        public static readonly EventId HostedServiceStopException = new EventId(10, "HostedServiceStopException");
-        public static readonly EventId HostingStartupAssemblyException = new EventId(11, "HostingStartupAssemblyException");
-        public static readonly EventId ServerShutdownException = new EventId(12, "ServerShutdownException");
-        public static readonly EventId HostingStartupAssemblyLoaded = new EventId(13, "HostingStartupAssemblyLoaded");
-        public static readonly EventId ServerListeningOnAddresses = new EventId(14, "ServerListeningOnAddresses");
+        public const int RequestStarting = 1;
+        public const int RequestFinished = 2;
+        public const int Starting = 3;
+        public const int Started = 4;
+        public const int Shutdown = 5;
+        public const int ApplicationStartupException = 6;
+        public const int ApplicationStoppingException = 7;
+        public const int ApplicationStoppedException = 8;
+        public const int HostedServiceStartException = 9;
+        public const int HostedServiceStopException = 10;
+        public const int HostingStartupAssemblyException = 11;
+        public const int ServerShutdownException = 12;
+        public const int HostingStartupAssemblyLoaded = 13;
+        public const int ServerListeningOnAddresses = 14;
     }
 }

src/Http/Http.Abstractions/src/Microsoft.AspNetCore.Http.Abstractions.csproj

@@ -19,6 +19,7 @@ Microsoft.AspNetCore.Http.HttpResponse</Description>
   <ItemGroup>
     <Reference Include="Microsoft.AspNetCore.Http.Features" />
     <Reference Include="Microsoft.Net.Http.Headers" />
+    <Reference Include="Microsoft.Extensions.Logging.Abstractions" />
 
     <Compile Include="$(SharedSourceRoot)ActivatorUtilities\*.cs" />
     <Compile Include="$(SharedSourceRoot)ParameterDefaultValue\*.cs" />

src/Http/Http.Extensions/src/RequestDelegateFactory.cs

@@ -20,7 +20,7 @@ namespace Microsoft.AspNetCore.Http
     /// <summary>
     /// Creates <see cref="RequestDelegate"/> implementations from <see cref="Delegate"/> request handlers.
     /// </summary>
-    public static class RequestDelegateFactory
+    public static partial class RequestDelegateFactory
     {
         private static readonly MethodInfo ExecuteTaskOfTMethod = typeof(RequestDelegateFactory).GetMethod(nameof(ExecuteTask), BindingFlags.NonPublic | BindingFlags.Static)!;
         private static readonly MethodInfo ExecuteTaskOfStringMethod = typeof(RequestDelegateFactory).GetMethod(nameof(ExecuteTaskOfString), BindingFlags.NonPublic | BindingFlags.Static)!;
@@ -748,37 +748,27 @@ private class FactoryContext
             public List<(ParameterExpression, Expression)> TryParseParams { get; } = new();
         }
 
-        private static class Log
+        private static partial class Log
         {
-            private static readonly Action<ILogger, Exception> _requestBodyIOException = LoggerMessage.Define(
-                LogLevel.Debug,
-                new EventId(1, "RequestBodyIOException"),
-                "Reading the request body failed with an IOException.");
-
-            private static readonly Action<ILogger, Exception> _requestBodyInvalidDataException = LoggerMessage.Define(
-                LogLevel.Debug,
-                new EventId(2, "RequestBodyInvalidDataException"),
-                "Reading the request body failed with an InvalidDataException.");
-
-            private static readonly Action<ILogger, string, string, string, Exception?> _parameterBindingFailed = LoggerMessage.Define<string, string, string>(
-                LogLevel.Debug,
-                new EventId(3, "ParamaterBindingFailed"),
-                @"Failed to bind parameter ""{ParameterType} {ParameterName}"" from ""{SourceValue}"".");
-
             public static void RequestBodyIOException(HttpContext httpContext, IOException exception)
-            {
-                _requestBodyIOException(GetLogger(httpContext), exception);
-            }
+                => RequestBodyIOException(GetLogger(httpContext), exception);
+
+            [LoggerMessage(1, LogLevel.Debug, "Reading the request body failed with an IOException.", EventName = "RequestBodyIOException")]
+            private static partial void RequestBodyIOException(ILogger logger, IOException exception);
 
             public static void RequestBodyInvalidDataException(HttpContext httpContext, InvalidDataException exception)
-            {
-                _requestBodyInvalidDataException(GetLogger(httpContext), exception);
-            }
+                => RequestBodyInvalidDataException(GetLogger(httpContext), exception);
+
+            [LoggerMessage(2, LogLevel.Debug, "Reading the request body failed with an InvalidDataException.", EventName = "RequestBodyInvalidDataException")]
+            private static partial void RequestBodyInvalidDataException(ILogger logger, InvalidDataException exception);
 
             public static void ParameterBindingFailed(HttpContext httpContext, string parameterTypeName, string parameterName, string sourceValue)
-            {
-                _parameterBindingFailed(GetLogger(httpContext), parameterTypeName, parameterName, sourceValue, null);
-            }
+                => ParameterBindingFailed(GetLogger(httpContext), parameterTypeName, parameterName, sourceValue);
+
+            [LoggerMessage(3, LogLevel.Debug,
+                @"Failed to bind parameter ""{ParameterType} {ParameterName}"" from ""{SourceValue}"".",
+                EventName = "ParamaterBindingFailed")]
+            private static partial void ParameterBindingFailed(ILogger logger, string parameterType, string parameterName, string sourceValue);
 
             private static ILogger GetLogger(HttpContext httpContext)
             {

src/Http/Http/src/BindingAddress.cs

@@ -129,12 +129,12 @@ public static BindingAddress Parse(string address)
             // A null/empty address will throw FormatException
             address = address ?? string.Empty;
 
-            int schemeDelimiterStart = address.IndexOf(Uri.SchemeDelimiter, StringComparison.Ordinal);
+            var schemeDelimiterStart = address.IndexOf(Uri.SchemeDelimiter, StringComparison.Ordinal);
             if (schemeDelimiterStart < 0)
             {
                 throw new FormatException($"Invalid url: '{address}'");
             }
-            int schemeDelimiterEnd = schemeDelimiterStart + Uri.SchemeDelimiter.Length;
+            var schemeDelimiterEnd = schemeDelimiterStart + Uri.SchemeDelimiter.Length;
 
             var isUnixPipe = address.IndexOf(UnixPipeHostPrefix, schemeDelimiterEnd, StringComparison.Ordinal) == schemeDelimiterEnd;
 
@@ -169,17 +169,17 @@ public static BindingAddress Parse(string address)
 
             var scheme = address.Substring(0, schemeDelimiterStart);
             string? host = null;
-            int port = 0;
+            var port = 0;
 
             var hasSpecifiedPort = false;
             if (!isUnixPipe)
             {
-                int portDelimiterStart = address.LastIndexOf(":", pathDelimiterStart - 1, pathDelimiterStart - schemeDelimiterEnd, StringComparison.Ordinal);
+                var portDelimiterStart = address.LastIndexOf(":", pathDelimiterStart - 1, pathDelimiterStart - schemeDelimiterEnd, StringComparison.Ordinal);
                 if (portDelimiterStart >= 0)
                 {
-                    int portDelimiterEnd = portDelimiterStart + ":".Length;
+                    var portDelimiterEnd = portDelimiterStart + ":".Length;
 
-                    string portString = address.Substring(portDelimiterEnd, pathDelimiterStart - portDelimiterEnd);
+                    var portString = address.Substring(portDelimiterEnd, pathDelimiterStart - portDelimiterEnd);
                     int portNumber;
                     if (int.TryParse(portString, NumberStyles.Integer, CultureInfo.InvariantCulture, out portNumber))
                     {

src/Http/Http/src/Features/HttpRequestIdentifierFeature.cs

@@ -42,7 +42,7 @@ private static string GenerateRequestId(long id)
         {
             return string.Create(13, id, (buffer, value) =>
             {
-                char[] encode32Chars = s_encode32Chars;
+                var encode32Chars = s_encode32Chars;
 
                 buffer[12] = encode32Chars[value & 31];
                 buffer[11] = encode32Chars[(value >> 5) & 31];

src/Http/Http/src/FormCollection.cs

@@ -70,7 +70,7 @@ public StringValues this[string key]
                     return StringValues.Empty;
                 }
 
-                if (TryGetValue(key, out StringValues value))
+                if (TryGetValue(key, out var value))
                 {
                     return value;
                 }

src/Http/Http/src/HeaderDictionary.cs

@@ -71,7 +71,7 @@ public StringValues this[string key]
                     return StringValues.Empty;
                 }
 
-                if (TryGetValue(key, out StringValues value))
+                if (TryGetValue(key, out var value))
                 {
                     return value;
                 }
@@ -227,7 +227,7 @@ public void Clear()
         public bool Contains(KeyValuePair<string, StringValues> item)
         {
             if (Store == null ||
-                !Store.TryGetValue(item.Key, out StringValues value) ||
+                !Store.TryGetValue(item.Key, out var value) ||
                 !StringValues.Equals(value, item.Value))
             {
                 return false;

src/Http/Http/src/Internal/DefaultHttpResponse.cs

@@ -14,9 +14,9 @@ namespace Microsoft.AspNetCore.Http
     internal sealed class DefaultHttpResponse : HttpResponse
     {
         // Lambdas hoisted to static readonly fields to improve inlining https://github.com/dotnet/roslyn/issues/13624
-        private readonly static Func<IFeatureCollection, IHttpResponseFeature?> _nullResponseFeature = f => null;
-        private readonly static Func<IFeatureCollection, IHttpResponseBodyFeature?> _nullResponseBodyFeature = f => null;
-        private readonly static Func<IFeatureCollection, IResponseCookiesFeature?> _newResponseCookiesFeature = f => new ResponseCookiesFeature(f);
+        private static readonly Func<IFeatureCollection, IHttpResponseFeature?> _nullResponseFeature = f => null;
+        private static readonly Func<IFeatureCollection, IHttpResponseBodyFeature?> _nullResponseBodyFeature = f => null;
+        private static readonly Func<IFeatureCollection, IResponseCookiesFeature?> _newResponseCookiesFeature = f => new ResponseCookiesFeature(f);
 
         private readonly DefaultHttpContext _context;
         private FeatureReferences<FeatureInterfaces> _features;

src/Http/Http/src/Internal/EventIds.cs

@@ -14,7 +14,7 @@ namespace Microsoft.AspNetCore.Http
     /// <summary>
     /// A wrapper for the response Set-Cookie header.
     /// </summary>
-    internal class ResponseCookies : IResponseCookies
+    internal partial class ResponseCookies : IResponseCookies
     {
         internal const string EnableCookieNameEncoding = "Microsoft.AspNetCore.Http.EnableCookieNameEncoding";
         internal bool _enableCookieNameEncoding = AppContext.TryGetSwitch(EnableCookieNameEncoding, out var enabled) && enabled;
@@ -156,8 +156,8 @@ public void Delete(string key, CookieOptions options)
             }
 
             var encodedKeyPlusEquals = (_enableCookieNameEncoding ? Uri.EscapeDataString(key) : key) + "=";
-            bool domainHasValue = !string.IsNullOrEmpty(options.Domain);
-            bool pathHasValue = !string.IsNullOrEmpty(options.Path);
+            var domainHasValue = !string.IsNullOrEmpty(options.Domain);
+            var pathHasValue = !string.IsNullOrEmpty(options.Path);
 
             Func<string, string, CookieOptions, bool> rejectPredicate;
             if (domainHasValue && pathHasValue)
@@ -212,17 +212,10 @@ public void Delete(string key, CookieOptions options)
             });
         }
 
-        private static class Log
+        private static partial class Log
         {
-            private static readonly Action<ILogger, string, Exception?> _samesiteNotSecure = LoggerMessage.Define<string>(
-                LogLevel.Warning,
-                EventIds.SameSiteNotSecure,
-                "The cookie '{name}' has set 'SameSite=None' and must also set 'Secure'.");
-
-            public static void SameSiteCookieNotSecure(ILogger logger, string name)
-            {
-                _samesiteNotSecure(logger, name, null);
-            }
+            [LoggerMessage(1, LogLevel.Warning, "The cookie '{name}' has set 'SameSite=None' and must also set 'Secure'.", EventName = "SameSiteNotSecure")]
+            public static partial void SameSiteCookieNotSecure(ILogger logger, string name);
         }
     }
 }