[PM-13098] Use ILogger.BeginScope For Better Scopes (#4740)

* Use `ILogger.BeginScope` For Better Scopes * Format * Remove Behind Feature Flag
2026-02-04 08:03:29 +08:00 · 2024-10-03 08:30:02 -04:00
parent f3f81deb98
commit b196c8bfb9
3 changed files with 119 additions and 27 deletions
--- a/src/SharedWeb/Utilities/RequestLoggingMiddleware.cs
+++ b/src/SharedWeb/Utilities/RequestLoggingMiddleware.cs
@@ -0,0 +1,117 @@
+using System.Collections;
+using Bit.Core;
+using Bit.Core.Services;
+using Bit.Core.Settings;
+using Bit.Core.Utilities;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.Logging;
+
+#nullable enable
+
+namespace Bit.SharedWeb.Utilities;
+
+public sealed class RequestLoggingMiddleware
+{
+    private readonly RequestDelegate _next;
+    private readonly ILogger<RequestLoggingMiddleware> _logger;
+    private readonly GlobalSettings _globalSettings;
+
+    public RequestLoggingMiddleware(RequestDelegate next, ILogger<RequestLoggingMiddleware> logger, GlobalSettings globalSettings)
+    {
+        _next = next;
+        _logger = logger;
+        _globalSettings = globalSettings;
+    }
+
+    public Task Invoke(HttpContext context, IFeatureService featureService)
+    {
+        if (!featureService.IsEnabled(FeatureFlagKeys.RemoveServerVersionHeader))
+        {
+            context.Response.OnStarting(() =>
+            {
+                context.Response.Headers.Append("Server-Version", AssemblyHelpers.GetVersion());
+                return Task.CompletedTask;
+            });
+        }
+
+        using (_logger.BeginScope(
+          new RequestLogScope(context.GetIpAddress(_globalSettings),
+            GetHeaderValue(context, "user-agent"),
+            GetHeaderValue(context, "device-type"),
+            GetHeaderValue(context, "device-type"))))
+        {
+            return _next(context);
+        }
+
+        static string? GetHeaderValue(HttpContext httpContext, string header)
+        {
+            if (httpContext.Request.Headers.TryGetValue(header, out var value))
+            {
+                return value;
+            }
+
+            return null;
+        }
+    }
+
+
+    private sealed class RequestLogScope : IReadOnlyList<KeyValuePair<string, object?>>
+    {
+        private string? _cachedToString;
+
+        public RequestLogScope(string? ipAddress, string? userAgent, string? deviceType, string? origin)
+        {
+            IpAddress = ipAddress;
+            UserAgent = userAgent;
+            DeviceType = deviceType;
+            Origin = origin;
+        }
+
+        public KeyValuePair<string, object?> this[int index]
+        {
+            get
+            {
+                if (index == 0)
+                {
+                    return new KeyValuePair<string, object?>(nameof(IpAddress), IpAddress);
+                }
+                else if (index == 1)
+                {
+                    return new KeyValuePair<string, object?>(nameof(UserAgent), UserAgent);
+                }
+                else if (index == 2)
+                {
+                    return new KeyValuePair<string, object?>(nameof(DeviceType), DeviceType);
+                }
+                else if (index == 3)
+                {
+                    return new KeyValuePair<string, object?>(nameof(Origin), Origin);
+                }
+
+                throw new ArgumentOutOfRangeException(nameof(index));
+            }
+        }
+
+        public int Count => 4;
+
+        public string? IpAddress { get; }
+        public string? UserAgent { get; }
+        public string? DeviceType { get; }
+        public string? Origin { get; }
+
+        public IEnumerator<KeyValuePair<string, object?>> GetEnumerator()
+        {
+            for (var i = 0; i < Count; i++)
+            {
+                yield return this[i];
+            }
+        }
+        IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
+
+        public override string ToString()
+        {
+            _cachedToString ??= $"IpAddress:{IpAddress} UserAgent:{UserAgent} DeviceType:{DeviceType} Origin:{Origin}";
+            return _cachedToString;
+        }
+    }
+}