Fix warning CA1873: Evaluation of this argument may be expensive and unnecessary if logging is disabled

Author: bkoelman

src/JsonApiDotNetCore.OpenApi.Swashbuckle/JsonApiActionDescriptorCollectionProvider.cs

@@ -17,7 +17,6 @@
 using Microsoft.AspNetCore.Mvc.Infrastructure;
 using Microsoft.AspNetCore.Mvc.Routing;
 using Microsoft.AspNetCore.Routing;
-using Microsoft.Extensions.Logging;
 
 namespace JsonApiDotNetCore.OpenApi.Swashbuckle;
 
@@ -27,32 +26,29 @@ namespace JsonApiDotNetCore.OpenApi.Swashbuckle;
 /// /article/{id}/{relationshipName} -> /article/{id}/author, /article/{id}/revisions, etc.
 /// ]]></code>
 /// </summary>
-internal sealed partial class JsonApiActionDescriptorCollectionProvider : IActionDescriptorCollectionProvider
+internal sealed class JsonApiActionDescriptorCollectionProvider : IActionDescriptorCollectionProvider
 {
     private const int FilterScope = 10;
     private static readonly Type ErrorDocumentType = typeof(ErrorResponseDocument);
 
     private readonly IActionDescriptorCollectionProvider _defaultProvider;
     private readonly IControllerResourceMapping _controllerResourceMapping;
     private readonly JsonApiEndpointMetadataProvider _jsonApiEndpointMetadataProvider;
-    private readonly ILogger<JsonApiActionDescriptorCollectionProvider> _logger;
     private readonly ConcurrentDictionary<int, Lazy<ActionDescriptorCollection>> _versionedActionDescriptorCache = new();
 
     public ActionDescriptorCollection ActionDescriptors =>
         _versionedActionDescriptorCache.GetOrAdd(_defaultProvider.ActionDescriptors.Version, LazyGetActionDescriptors).Value;
 
     public JsonApiActionDescriptorCollectionProvider(IActionDescriptorCollectionProvider defaultProvider, IControllerResourceMapping controllerResourceMapping,
-        JsonApiEndpointMetadataProvider jsonApiEndpointMetadataProvider, ILogger<JsonApiActionDescriptorCollectionProvider> logger)
+        JsonApiEndpointMetadataProvider jsonApiEndpointMetadataProvider)
     {
         ArgumentNullException.ThrowIfNull(defaultProvider);
         ArgumentNullException.ThrowIfNull(controllerResourceMapping);
         ArgumentNullException.ThrowIfNull(jsonApiEndpointMetadataProvider);
-        ArgumentNullException.ThrowIfNull(logger);
 
         _defaultProvider = defaultProvider;
         _controllerResourceMapping = controllerResourceMapping;
         _jsonApiEndpointMetadataProvider = jsonApiEndpointMetadataProvider;
-        _logger = logger;
     }
 
     private Lazy<ActionDescriptorCollection> LazyGetActionDescriptors(int version)
@@ -478,7 +474,4 @@ private static void SetNonPrimaryResponseMetadata(ActionDescriptor descriptor,
 
         descriptorsByRelationship[relationship] = relationshipDescriptor;
     }
-
-    [LoggerMessage(Level = LogLevel.Warning, Message = "Hiding unsupported custom JSON:API action method [{HttpMethods}] {ActionMethod} in OpenAPI.")]
-    private partial void LogSuppressedActionMethod(string httpMethods, string? actionMethod);
 }

src/JsonApiDotNetCore/QueryStrings/QueryStringReader.cs

@@ -47,7 +47,11 @@ public void ReadAll(DisableQueryStringAttribute? disableQueryStringAttribute)
 
             if (reader != null)
             {
-                LogParameterAccepted(parameterName, parameterValue, reader.GetType().Name);
+                if (_logger.IsEnabled(LogLevel.Debug))
+                {
+                    string readerType = reader.GetType().Name;
+                    LogParameterAccepted(parameterName, parameterValue, readerType);
+                }
 
                 if (!reader.AllowEmptyValue && string.IsNullOrEmpty(parameterValue))
                 {
@@ -74,7 +78,8 @@ public void ReadAll(DisableQueryStringAttribute? disableQueryStringAttribute)
         }
     }
 
-    [LoggerMessage(Level = LogLevel.Debug, Message = "Query string parameter '{ParameterName}' with value '{ParameterValue}' was accepted by {ReaderType}.")]
+    [LoggerMessage(Level = LogLevel.Debug, SkipEnabledCheck = true,
+        Message = "Query string parameter '{ParameterName}' with value '{ParameterValue}' was accepted by {ReaderType}.")]
     private partial void LogParameterAccepted(string parameterName, StringValues parameterValue, string readerType);
 
     [LoggerMessage(Level = LogLevel.Debug, Message = "Query string parameter '{ParameterName}' was successfully read.")]

test/TestBuildingBlocks/XUnitLogHttpMessageHandler.cs

@@ -1,6 +1,8 @@
 using Microsoft.Extensions.Logging;
 using Xunit.Abstractions;
 
+#pragma warning disable CA1873 // Avoid potentially expensive logging
+
 namespace TestBuildingBlocks;
 
 /// <summary>