Keyed services fail to dependency inject into middleware #54500

hacst · 2024-03-12T16:26:57Z

Is there an existing issue for this?

I have searched the existing issues

Describe the bug

It does not seem possible to get keyed services injected into middleware classes . Neither using constructor or Invoke/InvokeAsync argument injection. Attempting to do so results in a startup or invoke time exception respectively.

Expected Behavior

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/dependency-injection?view=aspnetcore-8.0#service-lifetimes documents constructor as well as InvokeAsync using DI as well as constructor injection using keyed services for classes in DI.

As such the expectation is for DI on middleware to also work with keyed services.

Steps To Reproduce

Execute the following code using dotnet run

class Program
{
    static void Main(string[] args)
    {
        var builder = WebApplication.CreateBuilder(args);
        builder.Services.AddKeyedSingleton<SomeClass>("test");
        builder.Services.AddSingleton<ObjectUsingKeyedSomeClass>();

        var app = builder.Build();
        app.UseMiddleware<MiddlewareUsingKeyedSomeClassConstructor>(); // Throws on startup
        app.UseMiddleware<MiddlewareUsingKeyedSomeClassInvoke>(); // Throws on invoke
        app.MapGet("/", ([FromKeyedServices("test")] SomeClass foo) => Results.Ok()); // Works
        app.MapGet("/2", (ObjectUsingKeyedSomeClass foo) => Results.Ok()); // Works
        app.Run();
    }
}

public class SomeClass { }
public class MiddlewareUsingKeyedSomeClassConstructor(RequestDelegate next, [FromKeyedServices("test")] SomeClass someClass)
{
    public async Task InvokeAsync(HttpContext context)
    {
        await next(context);
    }
}

public class MiddlewareUsingKeyedSomeClassInvoke(RequestDelegate next)
{
    public async Task InvokeAsync(HttpContext context, [FromKeyedServices("test")] SomeClass someClass)
    {
        await next(context);
    }
}

class ObjectUsingKeyedSomeClass([FromKeyedServices("test")] SomeClass someClass) {}

Exceptions (if any)

app.UseMiddleware<MiddlewareUsingKeyedSomeClassConstructor>(); // Throws on startup

crit: Microsoft.AspNetCore.Hosting.Diagnostics[6]
      Application startup exception
      System.InvalidOperationException: Unable to resolve service for type 'SomeClass' while attempting to activate 'MiddlewareUsingKeyedSomeClassConstructor'.
         at Microsoft.Extensions.Internal.ActivatorUtilities.ConstructorMatcher.CreateInstance(IServiceProvider provider)
         at Microsoft.Extensions.Internal.ActivatorUtilities.CreateInstance(IServiceProvider provider, Type instanceType, Object[] parameters)
         at Microsoft.AspNetCore.Builder.UseMiddlewareExtensions.ReflectionMiddlewareBinder.CreateMiddleware(RequestDelegate next)
         at Microsoft.AspNetCore.Builder.ApplicationBuilder.Build()
         at Microsoft.AspNetCore.Builder.ApplicationBuilder.Build()
         at Microsoft.AspNetCore.Hosting.GenericWebHostService.StartAsync(CancellationToken cancellationToken)

app.UseMiddleware<MiddlewareUsingKeyedSomeClassInvoke>(); // Throws on invoke

fail: Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware[1]
      An unhandled exception has occurred while executing the request.
      System.InvalidOperationException: Unable to resolve service for type 'SomeClass' while attempting to Invoke middleware 'MiddlewareUsingKeyedSomeClassInvoke'.
         at lambda_method1(Closure, Object, HttpContext, IServiceProvider)
         at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddlewareImpl.Invoke(HttpContext context)

.NET Version

8.0.200

Anything else?

No response

The text was updated successfully, but these errors were encountered:

laliconfigcat · 2024-04-10T11:54:02Z

I am also experiencing the issue with .NET 8.0.2. I did a workaround with injecting the IServiceProvider to the middleware and acquiring the keyed service implementation with serviceProvider.GetKeyedService<>. It works but it doesn't look so nice.

Do you have any updates regarding this issue?

KalleOlaviNiemitalo · 2024-04-10T13:28:34Z

Microsoft.Extensions.DependencyInjection.ActivatorUtilities supports FromKeyedServicesAttribute but Microsoft.Extensions.Internal.ActivatorUtilities doesn't. Why does ASP.NET Core even have its own fork of this class…?

Bituum · 2024-04-11T11:31:11Z

I have the same problem.

NicoBrabers · 2024-05-08T11:07:32Z

I'm experiencing the same issue. Specifically, it resolves to an unexpected instance when another instance is already registered using the AddSingleton method.

Consider the following example:

public class HelloWorldMiddleware(RequestDelegate next)
{
    public async Task InvokeAsync(HttpContext context, [FromKeyedServices("HelloWorld:1")] IHelloWorld helloWorld) 
    {         
        await next(context);
    }
}

Scenario 1 returns an incorrect instance:
In Program.cs:

builder.Services.AddSingleton<IHelloWorld>(new HelloWorld()); // This instance is incorrectly resolved in the middleware, which shouldn't happen.
builder.Services.AddKeyedSingleton<IHelloWorld>("HelloWorld:1", new HelloWorld());

Scenario 2, which results in the error mentioned in the original post:
In Program.cs:

builder.Services.AddKeyedSingleton<IHelloWorld>("HelloWorld:1", new HelloWorld());

…ction to Microsoft.AspNetCore.Http.Abstractions and utilized the ActivatorUtilities it provides to obtain a middleware instance. Also changed the ReflectionMiddlewareBinder to be able to handle keyed injection.

…new lines) based on pull-request feedback.

… parameter within the ReflectionFallback.

…ach parameter within the ReflectionFallback, removed the parameterType and declaringType from the precomputed cache.

…d added the NotNullWhen(true) attribute. Also changed the Inherit param from true to false when obtaining the custom attribute FromKeyedServicesAttribute.

…test. Added Benchmark(s) for the ReflectionFallback method.

codymullins · 2024-05-24T20:09:07Z

The workaround mentioned by @laliconfigcat (injecting via IServiceProvider) resolves this for now.

dotnet-issue-labeler bot added the needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically label Mar 12, 2024

mkArtakMSFT added area-middleware Includes: URL rewrite, redirect, response cache/compression, session, and other general middlesware and removed needs-area-label Used by the dotnet-issue-labeler to label those issues which couldn't be triaged automatically labels Mar 12, 2024

NicoBrabers linked a pull request May 14, 2024 that will close this issue

Fix for issue #54500: Middleware keyed dependency injection #55722

Open

4 tasks

NicoBrabers pushed a commit to NicoBrabers/aspnetcore that referenced this issue May 15, 2024

Fix for issue dotnet#54500: Added different method formatting (added …

c4a279f

…new lines) based on pull-request feedback.

NicoBrabers pushed a commit to NicoBrabers/aspnetcore that referenced this issue May 16, 2024

Fix for issue dotnet#54500: Precompute and cache the results for each…

d28858e

… parameter within the ReflectionFallback.

NicoBrabers pushed a commit to NicoBrabers/aspnetcore that referenced this issue May 21, 2024

Fix for issue dotnet#54500: Removed unnecessary mock class from unit-…

e9b37eb

…test. Added Benchmark(s) for the ReflectionFallback method.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Keyed services fail to dependency inject into middleware #54500

Keyed services fail to dependency inject into middleware #54500

hacst commented Mar 12, 2024

laliconfigcat commented Apr 10, 2024 •

edited

KalleOlaviNiemitalo commented Apr 10, 2024

Bituum commented Apr 11, 2024

NicoBrabers commented May 8, 2024 •

edited

codymullins commented May 24, 2024

Keyed services fail to dependency inject into middleware #54500

Keyed services fail to dependency inject into middleware #54500

Comments

hacst commented Mar 12, 2024

Is there an existing issue for this?

Describe the bug

Expected Behavior

Steps To Reproduce

Exceptions (if any)

.NET Version

Anything else?

laliconfigcat commented Apr 10, 2024 • edited

KalleOlaviNiemitalo commented Apr 10, 2024

Bituum commented Apr 11, 2024

NicoBrabers commented May 8, 2024 • edited

codymullins commented May 24, 2024

laliconfigcat commented Apr 10, 2024 •

edited

NicoBrabers commented May 8, 2024 •

edited