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

Commit 945b4e6

Browse files
davidfowldavidfowl
authored
Added support for middleware activation via IMiddlewareFactory (#773)
* Added support for middleware activation via IMiddlewareFactory - IMiddlewareFactory and IMiddleware are new extensiblity points for activating and authoring middleware. Under the covers, middleware is still very much just a function. This just provides a nice way to get a per request activated middleware instance that is created and released via the IMiddlewareFactory. The caveats are that middleware needs to be registered in the container (by default) and that not possible to explicitly pass arguments directly via UseMiddleware. - Added tests
1 parent 6e01e64 commit 945b4e6

File tree

7 files changed

+308
-0
lines changed

7 files changed

+308
-0
lines changed

‎src/Microsoft.AspNetCore.Http.Abstractions/Extensions/UseMiddlewareExtensions.cs

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,18 @@ public static IApplicationBuilder UseMiddleware<TMiddleware>(this IApplicationBu
4242
/// <returns>The <see cref="IApplicationBuilder"/> instance.</returns>
4343
public static IApplicationBuilder UseMiddleware(this IApplicationBuilder app, Type middleware, params object[] args)
4444
{
45+
if (typeof(IMiddleware).GetTypeInfo().IsAssignableFrom(middleware.GetTypeInfo()))
46+
{
47+
// IMiddleware doesn't support passing args directly since it's
48+
// activated from the container
49+
if (args.Length > 0)
50+
{
51+
throw new NotSupportedException(Resources.FormatException_UseMiddlewareExplicitArgumentsNotSupported(typeof(IMiddleware)));
52+
}
53+
54+
return UseMiddlewareInterface(app, middleware);
55+
}
56+
4557
var applicationServices = app.ApplicationServices;
4658
return app.Use(next =>
4759
{
@@ -93,6 +105,38 @@ public static IApplicationBuilder UseMiddleware(this IApplicationBuilder app, Ty
93105
});
94106
}
95107

108+
private static IApplicationBuilder UseMiddlewareInterface(IApplicationBuilder app, Type middlewareType)
109+
{
110+
return app.Use(next =>
111+
{
112+
return async context =>
113+
{
114+
var middlewareFactory = (IMiddlewareFactory)context.RequestServices.GetService(typeof(IMiddlewareFactory));
115+
if (middlewareFactory == null)
116+
{
117+
// No middleware factory
118+
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareNoMiddlewareFactory(typeof(IMiddlewareFactory)));
119+
}
120+
121+
var middleware = middlewareFactory.Create(middlewareType);
122+
if (middleware == null)
123+
{
124+
// The factory returned null, it's a broken implementation
125+
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareUnableToCreateMiddleware(middlewareFactory.GetType(), middlewareType));
126+
}
127+
128+
try
129+
{
130+
await middleware.Invoke(context, next);
131+
}
132+
finally
133+
{
134+
middlewareFactory.Release(middleware);
135+
}
136+
};
137+
});
138+
}
139+
96140
private static Func<T, HttpContext, IServiceProvider, Task> Compile<T>(MethodInfo methodinfo, ParameterInfo[] parameters)
97141
{
98142
// If we call something like

‎src/Microsoft.AspNetCore.Http.Abstractions/IMiddleware.cs

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
// Copyright (c) .NET Foundation. All rights reserved.
2+
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
3+
4+
using System;
5+
using System.Collections.Generic;
6+
using System.Linq;
7+
using System.Text;
8+
using System.Threading.Tasks;
9+
10+
namespace Microsoft.AspNetCore.Http
11+
{
12+
/// <summary>
13+
/// Defines middleware that can be added to the application's request pipeline.
14+
/// </summary>
15+
public interface IMiddleware
16+
{
17+
/// <summary>
18+
/// Request handling method.
19+
/// </summary>
20+
/// <param name="context">The <see cref="HttpContext"/> for the current request.</param>
21+
/// <param name="next">The delegate representing the remaining middleware in the request pipeline.</param>
22+
/// <returns>A <see cref="Task"/> that represents the execution of this middleware.</returns>
23+
Task Invoke(HttpContext context, RequestDelegate next);
24+
}
25+
}

‎src/Microsoft.AspNetCore.Http.Abstractions/IMiddlewareFactory.cs

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Copyright (c) .NET Foundation. All rights reserved.
2+
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
3+
4+
using System;
5+
using System.Collections.Generic;
6+
using System.Linq;
7+
using System.Text;
8+
using System.Threading.Tasks;
9+
10+
namespace Microsoft.AspNetCore.Http
11+
{
12+
/// <summary>
13+
/// Provides methods to create middlware.
14+
/// </summary>
15+
public interface IMiddlewareFactory
16+
{
17+
/// <summary>
18+
/// Creates a middleware instance for each request.
19+
/// </summary>
20+
/// <param name="middlewareType">The concrete <see cref="Type"/> of the <see cref="IMiddleware"/>.</param>
21+
/// <returns>The <see cref="IMiddleware"/> instance.</returns>
22+
IMiddleware Create(Type middlewareType);
23+
24+
/// <summary>
25+
/// Releases a <see cref="IMiddleware"/> instance at the end of each request.
26+
/// </summary>
27+
/// <param name="middleware">The <see cref="IMiddleware"/> instance to release.</param>
28+
void Release(IMiddleware middleware);
29+
}
30+
}

‎src/Microsoft.AspNetCore.Http.Abstractions/Properties/Resources.Designer.cs

Lines changed: 48 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Microsoft.AspNetCore.Http.Abstractions/Resources.resx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,4 +144,13 @@
144144
<data name="Exception_PortMustBeGreaterThanZero" xml:space="preserve">
145145
<value>The value must be greater than zero.</value>
146146
</data>
147+
<data name="Exception_UseMiddlewareNoMiddlewareFactory" xml:space="preserve">
148+
<value>No service for type '{0}' has been registered.</value>
149+
</data>
150+
<data name="Exception_UseMiddlewareUnableToCreateMiddleware" xml:space="preserve">
151+
<value>'{0}' failed to create middleware of type '{1}'.</value>
152+
</data>
153+
<data name="Exception_UseMiddlewareExplicitArgumentsNotSupported" xml:space="preserve">
154+
<value>Types that implement '{0}' do not support explicit arguments.</value>
155+
</data>
147156
</root>

‎src/Microsoft.AspNetCore.Http/MiddlewareFactory.cs

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// Copyright (c) .NET Foundation. All rights reserved.
2+
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
3+
4+
using System;
5+
using System.Collections.Generic;
6+
using System.Linq;
7+
using System.Text;
8+
using System.Threading.Tasks;
9+
using Microsoft.Extensions.DependencyInjection;
10+
11+
namespace Microsoft.AspNetCore.Http
12+
{
13+
public class MiddlewareFactory : IMiddlewareFactory
14+
{
15+
// The default middleware factory is just an IServiceProvider proxy.
16+
// This should be registered as a scoped service so that the middleware instances
17+
// don't end up being singletons.
18+
private readonly IServiceProvider _serviceProvider;
19+
20+
public MiddlewareFactory(IServiceProvider serviceProvider)
21+
{
22+
_serviceProvider = serviceProvider;
23+
}
24+
25+
public IMiddleware Create(Type middlewareType)
26+
{
27+
return _serviceProvider.GetRequiredService(middlewareType) as IMiddleware;
28+
}
29+
30+
public void Release(IMiddleware middleware)
31+
{
32+
// The container owns the lifetime of the service
33+
}
34+
}
35+
}

‎test/Microsoft.AspNetCore.Http.Abstractions.Tests/UseMiddlewareTest.cs

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33

44
using System;
5+
using System.Collections.Generic;
56
using System.Threading.Tasks;
67
using Microsoft.AspNetCore.Builder;
78
using Microsoft.AspNetCore.Builder.Internal;
@@ -83,14 +84,130 @@ public void UseMiddlewareWithIvokeWithOutAndRefThrows()
8384
var exception = Assert.Throws<NotSupportedException>(() => builder.Build());
8485
}
8586

87+
[Fact]
88+
public void UseMiddlewareWithIMiddlewareThrowsIfParametersSpecified()
89+
{
90+
var mockServiceProvider = new DummyServiceProvider();
91+
var builder = new ApplicationBuilder(mockServiceProvider);
92+
var exception = Assert.Throws<NotSupportedException>(() => builder.UseMiddleware(typeof(Middleware), "arg"));
93+
Assert.Equal(Resources.FormatException_UseMiddlewareExplicitArgumentsNotSupported(typeof(IMiddleware)), exception.Message);
94+
}
95+
96+
[Fact]
97+
public async Task UseMiddlewareWithIMiddlewareThrowsIfNoIMiddlewareFactoryRegistered()
98+
{
99+
var mockServiceProvider = new DummyServiceProvider();
100+
var builder = new ApplicationBuilder(mockServiceProvider);
101+
builder.UseMiddleware(typeof(Middleware));
102+
var app = builder.Build();
103+
var exception = await Assert.ThrowsAsync<InvalidOperationException>(async () =>
104+
{
105+
var context = new DefaultHttpContext();
106+
var sp = new DummyServiceProvider();
107+
context.RequestServices = sp;
108+
await app(context);
109+
});
110+
Assert.Equal(Resources.FormatException_UseMiddlewareNoMiddlewareFactory(typeof(IMiddlewareFactory)), exception.Message);
111+
}
112+
113+
[Fact]
114+
public async Task UseMiddlewareWithIMiddlewareThrowsIfMiddlewareFactoryCreateReturnsNull()
115+
{
116+
var mockServiceProvider = new DummyServiceProvider();
117+
var builder = new ApplicationBuilder(mockServiceProvider);
118+
builder.UseMiddleware(typeof(Middleware));
119+
var app = builder.Build();
120+
var exception = await Assert.ThrowsAsync<InvalidOperationException>(async () =>
121+
{
122+
var context = new DefaultHttpContext();
123+
var sp = new DummyServiceProvider();
124+
sp.AddService(typeof(IMiddlewareFactory), new BadMiddlewareFactory());
125+
context.RequestServices = sp;
126+
await app(context);
127+
});
128+
129+
Assert.Equal(Resources.FormatException_UseMiddlewareUnableToCreateMiddleware(typeof(BadMiddlewareFactory), typeof(Middleware)), exception.Message);
130+
}
131+
132+
[Fact]
133+
public async Task UseMiddlewareWithIMiddlewareWorks()
134+
{
135+
var mockServiceProvider = new DummyServiceProvider();
136+
var builder = new ApplicationBuilder(mockServiceProvider);
137+
builder.UseMiddleware(typeof(Middleware));
138+
var app = builder.Build();
139+
var context = new DefaultHttpContext();
140+
var sp = new DummyServiceProvider();
141+
var middlewareFactory = new BasicMiddlewareFactory();
142+
sp.AddService(typeof(IMiddlewareFactory), middlewareFactory);
143+
context.RequestServices = sp;
144+
await app(context);
145+
Assert.Equal(true, context.Items["before"]);
146+
Assert.Equal(true, context.Items["after"]);
147+
Assert.NotNull(middlewareFactory.Created);
148+
Assert.NotNull(middlewareFactory.Released);
149+
Assert.IsType(typeof(Middleware), middlewareFactory.Created);
150+
Assert.IsType(typeof(Middleware), middlewareFactory.Released);
151+
Assert.Same(middlewareFactory.Created, middlewareFactory.Released);
152+
}
153+
154+
public class Middleware : IMiddleware
155+
{
156+
public async Task Invoke(HttpContext context, RequestDelegate next)
157+
{
158+
context.Items["before"] = true;
159+
await next(context);
160+
context.Items["after"] = true;
161+
}
162+
}
163+
164+
public class BasicMiddlewareFactory : IMiddlewareFactory
165+
{
166+
public IMiddleware Created { get; private set; }
167+
public IMiddleware Released { get; private set; }
168+
169+
public IMiddleware Create(Type middlewareType)
170+
{
171+
Created = Activator.CreateInstance(middlewareType) as IMiddleware;
172+
return Created;
173+
}
174+
175+
public void Release(IMiddleware middleware)
176+
{
177+
Released = middleware;
178+
}
179+
}
180+
181+
public class BadMiddlewareFactory : IMiddlewareFactory
182+
{
183+
public IMiddleware Create(Type middlewareType)
184+
{
185+
return null;
186+
}
187+
188+
public void Release(IMiddleware middleware)
189+
{
190+
191+
}
192+
}
193+
86194
private class DummyServiceProvider : IServiceProvider
87195
{
196+
private Dictionary<Type, object> _services = new Dictionary<Type, object>();
197+
198+
public void AddService(Type type, object value) => _services[type] = value;
199+
88200
public object GetService(Type serviceType)
89201
{
90202
if (serviceType == typeof(IServiceProvider))
91203
{
92204
return this;
93205
}
206+
207+
if (_services.TryGetValue(serviceType, out object value))
208+
{
209+
return value;
210+
}
94211
return null;
95212
}
96213
}

0 commit comments

Comments
 (0)