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

Commit 12b78a3

Browse files
committed
Added more tests and error handling for construction of middleware classes #236
1 parent c83ff60 commit 12b78a3

File tree

5 files changed

+387
-6
lines changed

5 files changed

+387
-6
lines changed

src/Microsoft.AspNet.Http.Abstractions/Extensions/UseMiddlewareExtensions.cs

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@
66
using System.Reflection;
77
using System.Threading.Tasks;
88
using Microsoft.AspNet.Http;
9+
using Microsoft.AspNet.Http.Abstractions;
910
using Microsoft.Framework.Internal;
1011

1112
namespace Microsoft.AspNet.Builder
1213
{
1314
public static class UseMiddlewareExtensions
1415
{
16+
const string InvokeMethodName = "Invoke";
1517
public static IApplicationBuilder UseMiddleware<T>(this IApplicationBuilder builder, params object[] args)
1618
{
1719
return builder.UseMiddleware(typeof(T), args);
@@ -22,24 +24,44 @@ public static IApplicationBuilder UseMiddleware(this IApplicationBuilder builder
2224
var applicationServices = builder.ApplicationServices;
2325
return builder.Use(next =>
2426
{
25-
var instance = ActivatorUtilities.CreateInstance(builder.ApplicationServices, middleware, new[] { next }.Concat(args).ToArray());
26-
var methodinfo = middleware.GetMethod("Invoke", BindingFlags.Instance | BindingFlags.Public);
27+
var methods = middleware.GetMethods(BindingFlags.Instance | BindingFlags.Public);
28+
var invokeMethods = methods.Where(m => string.Equals(m.Name, InvokeMethodName, StringComparison.Ordinal)).ToArray();
29+
if (invokeMethods.Length > 1)
30+
{
31+
throw new InvalidOperationException(Resources.FormatException_UseMiddleMutlipleInvokes(InvokeMethodName));
32+
}
33+
34+
if (invokeMethods.Length == 0)
35+
{
36+
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareNoInvokeMethod(InvokeMethodName));
37+
}
38+
39+
var methodinfo = invokeMethods[0];
40+
if (!typeof(Task).IsAssignableFrom(methodinfo.ReturnType))
41+
{
42+
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareNonTaskReturnType(InvokeMethodName, nameof(Task)));
43+
}
44+
2745
var parameters = methodinfo.GetParameters();
28-
if (parameters[0].ParameterType != typeof(HttpContext))
46+
if (parameters.Length == 0 || parameters[0].ParameterType != typeof(HttpContext))
2947
{
30-
throw new Exception("Middleware Invoke method must take first argument of HttpContext");
48+
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareNoParameters(InvokeMethodName,nameof(HttpContext)));
3149
}
50+
51+
var instance = ActivatorUtilities.CreateInstance(builder.ApplicationServices, middleware, new[] { next }.Concat(args).ToArray());
3252
if (parameters.Length == 1)
3353
{
3454
return (RequestDelegate)methodinfo.CreateDelegate(typeof(RequestDelegate), instance);
3555
}
56+
3657
return context =>
3758
{
3859
var serviceProvider = context.RequestServices ?? context.ApplicationServices ?? applicationServices;
3960
if (serviceProvider == null)
4061
{
41-
throw new Exception("IServiceProvider is not available");
62+
throw new InvalidOperationException(Resources.FormatException_UseMiddlewareIServiceProviderNotAvailable(nameof(IServiceProvider)));
4263
}
64+
4365
var arguments = new object[parameters.Length];
4466
arguments[0] = context;
4567
for(var index = 1; index != parameters.Length; ++index)

src/Microsoft.AspNet.Http.Abstractions/Properties/AssemblyInfo.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +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.Reflection;
5+
using System.Runtime.CompilerServices;
56

6-
[assembly: AssemblyMetadata("Serviceable", "True")]
7+
[assembly: AssemblyMetadata("Serviceable", "True")]
8+
[assembly: InternalsVisibleTo("Microsoft.AspNet.Http.Abstractions.Tests")]

src/Microsoft.AspNet.Http.Abstractions/Properties/Resources.Designer.cs

Lines changed: 110 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="Exception_UseMiddlewareIServiceProviderNotAvailable" xml:space="preserve">
121+
<value>'{0}' is not available.</value>
122+
</data>
123+
<data name="Exception_UseMiddlewareNoInvokeMethod" xml:space="preserve">
124+
<value>No public '{0}' method found.</value>
125+
</data>
126+
<data name="Exception_UseMiddlewareNonTaskReturnType" xml:space="preserve">
127+
<value>'{0}' does not return an object of type '{1}'.</value>
128+
</data>
129+
<data name="Exception_UseMiddlewareNoParameters" xml:space="preserve">
130+
<value>The '{0}' method's first argument must be of type '{1}'.</value>
131+
</data>
132+
<data name="Exception_UseMiddleMutlipleInvokes" xml:space="preserve">
133+
<value>Multiple public '{0}' methods are available.</value>
134+
</data>
135+
</root>

0 commit comments

Comments
 (0)