Skip to content
This repository was archived by the owner on Nov 20, 2018. It is now read-only.

Added support for middleware activation via IMiddlewareFactory #773

Merged
merged 3 commits into from
Feb 14, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,18 @@ public static IApplicationBuilder UseMiddleware<TMiddleware>(this IApplicationBu
/// <returns>The <see cref="IApplicationBuilder"/> instance.</returns>
public static IApplicationBuilder UseMiddleware(this IApplicationBuilder app, Type middleware, params object[] args)
{
if (typeof(IMiddleware).GetTypeInfo().IsAssignableFrom(middleware.GetTypeInfo()))
{
// IMiddleware doesn't support passing args directly since it's
// activated from the container
if (args.Length > 0)
{
throw new NotSupportedException(Resources.FormatException_UseMiddlewareExplicitArgumentsNotSupported(typeof(IMiddleware)));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you've decide you're OK with throwing? #754 (comment)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put it in the PR for feedback. I considered adding another overload but it would be confusing naming.

}

return UseMiddlewareInterface(app, middleware);
}

var applicationServices = app.ApplicationServices;
return app.Use(next =>
{
Expand Down Expand Up @@ -93,6 +105,38 @@ public static IApplicationBuilder UseMiddleware(this IApplicationBuilder app, Ty
});
}

private static IApplicationBuilder UseMiddlewareInterface(IApplicationBuilder app, Type middlewareType)
{
return app.Use(next =>
{
return async context =>
{
var middlewareFactory = (IMiddlewareFactory)context.RequestServices.GetService(typeof(IMiddlewareFactory));
if (middlewareFactory == null)
{
// No middleware factory
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareNoMiddlewareFactory(typeof(IMiddlewareFactory)));
}

var middleware = middlewareFactory.Create(middlewareType);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's kind of interesting how the type winds up just being used as a key and nothing else.

if (middleware == null)
{
// The factory returned null, it's a broken implementation
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareUnableToCreateMiddleware(middlewareFactory.GetType(), middlewareType));
}

try
{
await middleware.Invoke(context, next);
}
finally
{
middlewareFactory.Release(middleware);
}
};
});
}

private static Func<T, HttpContext, IServiceProvider, Task> Compile<T>(MethodInfo methodinfo, ParameterInfo[] parameters)
{
// If we call something like
Expand Down
25 changes: 25 additions & 0 deletions src/Microsoft.AspNetCore.Http.Abstractions/IMiddleware.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Microsoft.AspNetCore.Http
{
/// <summary>
/// Defines middleware that can be added to the application's request pipeline.
/// </summary>
public interface IMiddleware
{
/// <summary>
/// Request handling method.
/// </summary>
/// <param name="context">The <see cref="HttpContext"/> for the current request.</param>
/// <param name="next">The delegate representing the remaining middleware in the request pipeline.</param>
/// <returns>A <see cref="Task"/> that represents the execution of this middleware.</returns>
Task Invoke(HttpContext context, RequestDelegate next);
}
}
30 changes: 30 additions & 0 deletions src/Microsoft.AspNetCore.Http.Abstractions/IMiddlewareFactory.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Microsoft.AspNetCore.Http
{
/// <summary>
/// Provides methods to create middlware.
/// </summary>
public interface IMiddlewareFactory
{
/// <summary>
/// Creates a middleware instance for each request.
/// </summary>
/// <param name="middlewareType">The concrete <see cref="Type"/> of the <see cref="IMiddleware"/>.</param>
/// <returns>The <see cref="IMiddleware"/> instance.</returns>
IMiddleware Create(Type middlewareType);

/// <summary>
/// Releases a <see cref="IMiddleware"/> instance at the end of each request.
/// </summary>
/// <param name="middleware">The <see cref="IMiddleware"/> instance to release.</param>
void Release(IMiddleware middleware);
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions src/Microsoft.AspNetCore.Http.Abstractions/Resources.resx
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,13 @@
<data name="Exception_PortMustBeGreaterThanZero" xml:space="preserve">
<value>The value must be greater than zero.</value>
</data>
<data name="Exception_UseMiddlewareNoMiddlewareFactory" xml:space="preserve">
<value>No service for type '{0}' has been registered.</value>
</data>
<data name="Exception_UseMiddlewareUnableToCreateMiddleware" xml:space="preserve">
<value>'{0}' failed to create middleware of type '{1}'.</value>
</data>
<data name="Exception_UseMiddlewareExplicitArgumentsNotSupported" xml:space="preserve">
<value>Types that implement '{0}' do not support explicit arguments.</value>
</data>
</root>
35 changes: 35 additions & 0 deletions src/Microsoft.AspNetCore.Http/MiddlewareFactory.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// Copyright (c) .NET Foundation. All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;

namespace Microsoft.AspNetCore.Http
{
public class MiddlewareFactory : IMiddlewareFactory
{
// The default middleware factory is just an IServiceProvider proxy.
// This should be registered as a scoped service so that the middleware instances
// don't end up being singletons.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a companion PR in hosting where this is registered?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not yet, I'll do that after we agree we like this.

private readonly IServiceProvider _serviceProvider;

public MiddlewareFactory(IServiceProvider serviceProvider)
{
_serviceProvider = serviceProvider;
}

public IMiddleware Create(Type middlewareType)
{
return _serviceProvider.GetRequiredService(middlewareType) as IMiddleware;
}

public void Release(IMiddleware middleware)
{
// The container owns the lifetime of the service
}
}
}
117 changes: 117 additions & 0 deletions test/Microsoft.AspNetCore.Http.Abstractions.Tests/UseMiddlewareTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Builder.Internal;
Expand Down Expand Up @@ -83,14 +84,130 @@ public void UseMiddlewareWithIvokeWithOutAndRefThrows()
var exception = Assert.Throws<NotSupportedException>(() => builder.Build());
}

[Fact]
public void UseMiddlewareWithIMiddlewareThrowsIfParametersSpecified()
{
var mockServiceProvider = new DummyServiceProvider();
var builder = new ApplicationBuilder(mockServiceProvider);
var exception = Assert.Throws<NotSupportedException>(() => builder.UseMiddleware(typeof(Middleware), "arg"));
Assert.Equal(Resources.FormatException_UseMiddlewareExplicitArgumentsNotSupported(typeof(IMiddleware)), exception.Message);
}

[Fact]
public async Task UseMiddlewareWithIMiddlewareThrowsIfNoIMiddlewareFactoryRegistered()
{
var mockServiceProvider = new DummyServiceProvider();
var builder = new ApplicationBuilder(mockServiceProvider);
builder.UseMiddleware(typeof(Middleware));
var app = builder.Build();
var exception = await Assert.ThrowsAsync<InvalidOperationException>(async () =>
{
var context = new DefaultHttpContext();
var sp = new DummyServiceProvider();
context.RequestServices = sp;
await app(context);
});
Assert.Equal(Resources.FormatException_UseMiddlewareNoMiddlewareFactory(typeof(IMiddlewareFactory)), exception.Message);
}

[Fact]
public async Task UseMiddlewareWithIMiddlewareThrowsIfMiddlewareFactoryCreateReturnsNull()
{
var mockServiceProvider = new DummyServiceProvider();
var builder = new ApplicationBuilder(mockServiceProvider);
builder.UseMiddleware(typeof(Middleware));
var app = builder.Build();
var exception = await Assert.ThrowsAsync<InvalidOperationException>(async () =>
{
var context = new DefaultHttpContext();
var sp = new DummyServiceProvider();
sp.AddService(typeof(IMiddlewareFactory), new BadMiddlewareFactory());
context.RequestServices = sp;
await app(context);
});

Assert.Equal(Resources.FormatException_UseMiddlewareUnableToCreateMiddleware(typeof(BadMiddlewareFactory), typeof(Middleware)), exception.Message);
}

[Fact]
public async Task UseMiddlewareWithIMiddlewareWorks()
{
var mockServiceProvider = new DummyServiceProvider();
var builder = new ApplicationBuilder(mockServiceProvider);
builder.UseMiddleware(typeof(Middleware));
var app = builder.Build();
var context = new DefaultHttpContext();
var sp = new DummyServiceProvider();
var middlewareFactory = new BasicMiddlewareFactory();
sp.AddService(typeof(IMiddlewareFactory), middlewareFactory);
context.RequestServices = sp;
await app(context);
Assert.Equal(true, context.Items["before"]);
Assert.Equal(true, context.Items["after"]);
Assert.NotNull(middlewareFactory.Created);
Assert.NotNull(middlewareFactory.Released);
Assert.IsType(typeof(Middleware), middlewareFactory.Created);
Assert.IsType(typeof(Middleware), middlewareFactory.Released);
Assert.Same(middlewareFactory.Created, middlewareFactory.Released);
}

public class Middleware : IMiddleware
{
public async Task Invoke(HttpContext context, RequestDelegate next)
{
context.Items["before"] = true;
await next(context);
context.Items["after"] = true;
}
}

public class BasicMiddlewareFactory : IMiddlewareFactory
{
public IMiddleware Created { get; private set; }
public IMiddleware Released { get; private set; }

public IMiddleware Create(Type middlewareType)
{
Created = Activator.CreateInstance(middlewareType) as IMiddleware;
return Created;
}

public void Release(IMiddleware middleware)
{
Released = middleware;
}
}

public class BadMiddlewareFactory : IMiddlewareFactory
{
public IMiddleware Create(Type middlewareType)
{
return null;
}

public void Release(IMiddleware middleware)
{

}
}

private class DummyServiceProvider : IServiceProvider
{
private Dictionary<Type, object> _services = new Dictionary<Type, object>();

public void AddService(Type type, object value) => _services[type] = value;

public object GetService(Type serviceType)
{
if (serviceType == typeof(IServiceProvider))
{
return this;
}

if (_services.TryGetValue(serviceType, out object value))
{
return value;
}
return null;
}
}
Expand Down