Prefer IHttpContextAccessor over HttpContextAccessor (#471)

This change will check if we're currently in a runtime environment that contains a IHttpContextAccessor; if we are, then we'll prefer that over HttpContextAccessor. This allows people to potentially customize what it means to get and set a HttpContext.

Author: twsouthwick

src/Microsoft.AspNetCore.SystemWebAdapters/Hosting/HostingEnvironmentAccessor.cs

@@ -2,20 +2,26 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Diagnostics.CodeAnalysis;
+using System.Threading;
+using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.SystemWebAdapters;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
 
 namespace System.Web.Hosting;
 
 internal sealed class HostingEnvironmentAccessor
 {
+    private static HttpContextAccessor? _defaultHttpContextAccessor;
     private static HostingEnvironmentAccessor? _current;
 
     private readonly IOptions<SystemWebAdaptersOptions> _options;
+    private readonly IHttpContextAccessor? _accessor;
 
     public HostingEnvironmentAccessor(IServiceProvider services, IOptions<SystemWebAdaptersOptions> options)
     {
         Services = services;
+        _accessor = services.GetService<IHttpContextAccessor>();
         _options = options;
     }
 
@@ -42,5 +48,26 @@ public static bool TryGet([MaybeNullWhen(false)] out HostingEnvironmentAccessor
         return current is not null;
     }
 
+    /// <summary>
+    /// Gets an <see cref="IHttpContextAccessor"/> that is either registered to the current hosting runtime or the default one via <see cref="HttpContextAccessor"/>.  
+    /// </summary>
+    public static IHttpContextAccessor HttpContextAccessor
+    {
+        get
+        {
+            if (_current?._accessor is { } current)
+            {
+                return current;
+            }
+
+            if (_defaultHttpContextAccessor is null)
+            {
+                Interlocked.CompareExchange(ref _defaultHttpContextAccessor, new(), null);
+            }
+
+            return _defaultHttpContextAccessor;
+        }
+    }
+
     internal SystemWebAdaptersOptions Options => _options.Value;
 }

src/Microsoft.AspNetCore.SystemWebAdapters/HttpContext.cs

@@ -6,9 +6,9 @@
 using System.Linq;
 using System.Security.Principal;
 using System.Web.Caching;
+using System.Web.Hosting;
 using System.Web.SessionState;
 using Microsoft.AspNetCore.Hosting;
-using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Features.Authentication;
 using Microsoft.AspNetCore.SystemWebAdapters;
 using Microsoft.AspNetCore.SystemWebAdapters.Features;
@@ -20,8 +20,6 @@ namespace System.Web;
 
 public class HttpContext : IServiceProvider
 {
-    private static readonly HttpContextAccessor _accessor = new();
-
     private HttpRequest? _request;
     private HttpResponse? _response;
     private HttpServerUtility? _server;
@@ -30,8 +28,8 @@ public class HttpContext : IServiceProvider
 
     public static HttpContext? Current
     {
-        get => _accessor.HttpContext?.AsSystemWeb();
-        set => _accessor.HttpContext = value?.AsAspNetCore();
+        get => HostingEnvironmentAccessor.HttpContextAccessor.HttpContext?.AsSystemWeb();
+        set => HostingEnvironmentAccessor.HttpContextAccessor.HttpContext = value?.AsAspNetCore();
     }
 
     internal HttpContext(HttpContextCore context)

test/Microsoft.AspNetCore.SystemWebAdapters.CoreServices.Tests/HttpContextCurrentTests.cs

@@ -0,0 +1,69 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.TestHost;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using Moq;
+using Xunit;
+
+namespace Microsoft.AspNetCore.SystemWebAdapters.CoreServices.Tests;
+
+[Collection(nameof(SelfHostedTests))]
+public class HttpContextCurrentTests
+{
+    [Fact]
+    public void CurrentReturnsNullByDefault()
+    {
+        Assert.Null(HttpContext.Current);
+    }
+
+    [Fact]
+    public void SavesByDefaultToHttpContextAccessor()
+    {
+        // Arrange
+        var accessor = new HttpContextAccessor();
+        var context = new DefaultHttpContext();
+
+        // Act
+        HttpContext.Current = context;
+
+        // Assert
+        Assert.Same(accessor.HttpContext, context);
+    }
+
+    [Fact]
+    public async Task UsesIHttpContextAccessor()
+    {
+        // Arrange
+        var accessor = new Mock<IHttpContextAccessor>();
+        accessor.SetupAllProperties();
+
+        using var host = await new HostBuilder()
+           .ConfigureWebHost(webBuilder =>
+           {
+               webBuilder
+                   .UseTestServer()
+                   .ConfigureServices(services =>
+                   {
+                       services.AddSingleton(accessor.Object);
+                       services.AddSystemWebAdapters();
+                   })
+                   .Configure(app =>
+                   {
+                   });
+           })
+           .StartAsync();
+        var context = new DefaultHttpContext();
+
+        // Act
+        HttpContext.Current = context;
+
+        // Assert
+        Assert.Same(context, accessor.Object.HttpContext);
+        Assert.Null(new HttpContextAccessor().HttpContext);
+    }
+}

test/Microsoft.AspNetCore.SystemWebAdapters.CoreServices.Tests/ResponseHeaderTests.cs

@@ -13,6 +13,7 @@
 using Microsoft.Extensions.Hosting;
 using Microsoft.Net.Http.Headers;
 using Xunit;
+
 using SameSiteMode = System.Web.SameSiteMode;
 
 namespace Microsoft.AspNetCore.SystemWebAdapters.CoreServices.Tests;