Add IUserContextBuilder<TSchema> (#60)

* Add IUserContextBuilder<TSchema>

* Update

Author: Shane32

Directory.Build.props

@@ -21,7 +21,7 @@
     <Nullable>enable</Nullable>
     <IsPackable>false</IsPackable>
     <GraphQLVersion>7.0.0</GraphQLVersion>
-    <NoWarn>$(NoWarn);IDE0056;IDE0057</NoWarn>
+    <NoWarn>$(NoWarn);IDE0056;IDE0057;NU1902;NU1903</NoWarn>
   </PropertyGroup>
 
   <ItemGroup Condition="'$(IsPackable)' == 'true'">

README.md

@@ -741,6 +741,10 @@ are long-lived, using scoped services within a user context builder will result
 scoped services having a matching long lifetime.  You may wish to alleviate this by
 creating a service scope temporarily within your user context builder.
 
+For applications that service multiple schemas, you may register `IUserContextBuilder<TSchema>`
+to create a user context for a specific schema.  This is useful when you need to create
+a user context that is specific to a particular schema.
+
 ### Mutations within GET request
 
 For security reasons and pursuant to current recommendations, mutation GraphQL requests

src/GraphQL.AspNetCore3/GraphQLHttpMiddleware.cs

@@ -32,6 +32,15 @@ public GraphQLHttpMiddleware(
         : base(next, serializer, documentExecuter, serviceScopeFactory, options, hostApplicationLifetime)
     {
     }
+
+    /// <inheritdoc/>
+    protected override ValueTask<IDictionary<string, object?>> BuildUserContextAsync(HttpContext context, object? payload)
+    {
+        var userContextBuilder = context.RequestServices.GetService<IUserContextBuilder<TSchema>>();
+        return userContextBuilder == null
+            ? base.BuildUserContextAsync(context, payload)
+            : userContextBuilder.BuildUserContextAsync(context, payload);
+    }
 }
 
 /// <summary>
@@ -405,17 +414,18 @@ protected virtual async Task<ExecutionResult> ExecuteRequestAsync(HttpContext co
     /// <see cref="IHttpContextAccessor"/> via <see cref="ExecutionOptions.RequestServices"/>
     /// if needed.
     /// <br/><br/>
-    /// By default this method pulls the registered <see cref="IUserContextBuilder"/>,
-    /// if any, within the service scope and executes it to build the user context.
+    /// By default this method pulls the registered <see cref="IUserContextBuilder{TSchema}"/>
+    /// or <see cref="IUserContextBuilder"/> instance, if any, within the service scope
+    /// and executes it to build the user context.
     /// In this manner, both scoped and singleton <see cref="IUserContextBuilder"/>
     /// instances are supported, although singleton instances are recommended.
     /// </summary>
-    protected virtual async ValueTask<IDictionary<string, object?>> BuildUserContextAsync(HttpContext context, object? payload)
+    protected virtual ValueTask<IDictionary<string, object?>> BuildUserContextAsync(HttpContext context, object? payload)
     {
         var userContextBuilder = context.RequestServices.GetService<IUserContextBuilder>();
         var userContext = userContextBuilder == null
-            ? new Dictionary<string, object?>()
-            : await userContextBuilder.BuildUserContextAsync(context, payload);
+            ? new(new Dictionary<string, object?>())
+            : userContextBuilder.BuildUserContextAsync(context, payload);
         return userContext;
     }
 

src/GraphQL.AspNetCore3/IUserContextBuilder.cs

@@ -23,3 +23,9 @@ public interface IUserContextBuilder
     /// </param>
     ValueTask<IDictionary<string, object?>> BuildUserContextAsync(HttpContext context, object? payload);
 }
+
+/// <inheritdoc cref="IUserContextBuilder"/>
+public interface IUserContextBuilder<TSchema> : IUserContextBuilder
+    where TSchema : ISchema
+{
+}

src/Tests.ApiApprovals/GraphQL.AspNetCore3.approved.txt

@@ -160,6 +160,7 @@ namespace GraphQL.AspNetCore3
         where TSchema : GraphQL.Types.ISchema
     {
         public GraphQLHttpMiddleware(Microsoft.AspNetCore.Http.RequestDelegate next, GraphQL.IGraphQLTextSerializer serializer, GraphQL.IDocumentExecuter<TSchema> documentExecuter, Microsoft.Extensions.DependencyInjection.IServiceScopeFactory serviceScopeFactory, GraphQL.AspNetCore3.GraphQLHttpMiddlewareOptions options, Microsoft.Extensions.Hosting.IHostApplicationLifetime hostApplicationLifetime) { }
+        protected override System.Threading.Tasks.ValueTask<System.Collections.Generic.IDictionary<string, object?>> BuildUserContextAsync(Microsoft.AspNetCore.Http.HttpContext context, object? payload) { }
     }
     public sealed class HttpGetValidationRule : GraphQL.Validation.IValidationRule
     {
@@ -181,6 +182,8 @@ namespace GraphQL.AspNetCore3
     {
         System.Threading.Tasks.ValueTask<System.Collections.Generic.IDictionary<string, object?>> BuildUserContextAsync(Microsoft.AspNetCore.Http.HttpContext context, object? payload);
     }
+    public interface IUserContextBuilder<TSchema> : GraphQL.AspNetCore3.IUserContextBuilder
+        where TSchema : GraphQL.Types.ISchema { }
     public class UserContextBuilder<TUserContext> : GraphQL.AspNetCore3.IUserContextBuilder
         where TUserContext : System.Collections.Generic.IDictionary<string, object?>
     {

src/Tests/Middleware/MiscTests.cs

@@ -34,6 +34,37 @@ public void Constructors()
 
     }
 
+    [Fact]
+    public async Task SchemaSpecificBuilders()
+    {
+        var middleware = new MyMiddleware<Schema>(
+            Mock.Of<RequestDelegate>(MockBehavior.Strict),
+            Mock.Of<IGraphQLTextSerializer>(MockBehavior.Strict),
+            Mock.Of<IDocumentExecuter<Schema>>(MockBehavior.Strict),
+            Mock.Of<IServiceScopeFactory>(MockBehavior.Strict),
+            new GraphQLHttpMiddlewareOptions(),
+            Mock.Of<IHostApplicationLifetime>(MockBehavior.Strict));
+        var builder = new Mock<IUserContextBuilder<Schema>>(MockBehavior.Strict);
+        var d = new Dictionary<string, object?> { { "test", "test" } };
+        builder.Setup(x => x.BuildUserContextAsync(It.IsAny<HttpContext>(), It.IsAny<object?>())).ReturnsAsync(d);
+        var serviceProviderMock = new Mock<IServiceProvider>(MockBehavior.Strict);
+        serviceProviderMock.Setup(x => x.GetService(typeof(IUserContextBuilder<Schema>))).Returns(builder.Object);
+        var contextMock = new Mock<HttpContext>(MockBehavior.Strict);
+        contextMock.Setup(x => x.RequestServices).Returns(serviceProviderMock.Object);
+        (await middleware.MyBuildUserContextAsync(contextMock.Object, null)).ShouldBe(d);
+    }
+
+    private class MyMiddleware<TSchema> : GraphQLHttpMiddleware<TSchema>
+        where TSchema : ISchema
+    {
+        public MyMiddleware(RequestDelegate next, IGraphQLTextSerializer serializer, IDocumentExecuter<TSchema> executer, IServiceScopeFactory scopeFactory, GraphQLHttpMiddlewareOptions options, IHostApplicationLifetime hostApplicationLifetime)
+            : base(next, serializer, executer, scopeFactory, options, hostApplicationLifetime)
+        {
+        }
+
+        public ValueTask<IDictionary<string, object?>> MyBuildUserContextAsync(HttpContext context, object? payload) => base.BuildUserContextAsync(context, payload);
+    }
+
     [Fact]
     public async Task WriteErrorResponseString()
     {

src/Tests/Tests.csproj

@@ -46,6 +46,7 @@
     <Using Include="GraphQL.AspNetCore3" />
     <Using Include="GraphQL.AspNetCore3.WebSockets" />
     <Using Include="Shouldly" />
+    <Using Include="System.Net.Http"/>
     <Using Include="System.Text" />
     <Using Include="System.Threading" />
     <Using Include="System.Threading.Tasks" />