Plumber is a request pipeline that supports middleware delegates and classes. It provides configuration, dependency injection, and middleware pipeline services for AWS Lambda functions and Azure functions.
Plumber is based this article: How is the ASP.NET Core Middleware Pipeline Built - Steve Gorden, July 2020
If you're not familiar with middleware pipelines, Microsoft has a good primer on how middleware works in ASP.NET Core.
To install, use the following command: dotnet add package MSL.Plumber.Pipeline
- Create an
IRequestHandlerBuilder<TRequest, TResponse>
by calling one of the staticRequestHandlerBuilder.New
methods. - The request handler builder adds default configuration providers for appsettings files, environment variables, command line args, and user secrets.
- Handle additional configuration scenarios through the
IConfigurationManager Configuration
property on the builder. - Register services with the
IServiceCollection Servics
property. - Use the
Build
method to create anIRequestRequestDelegate<TRequest, TResponse>
instance. - Configure the request delegate pipeline by calling the
Use
methods on the request handler. - Call the
Prepare
method on the request handler to compile the pipeline. If you don't callPrepare
, the pipeline will be compiled when the first request is processed. - Call the
InvokeAsync
method on the request handler to forward the request to the pipeline. - Within your middleware delegates, or
IMiddleware
implementations, always invokeNext
to pass the request context to the next delegate in the pipeline. - Always call
context.CancelationToken.ThrowIfCancellationRequested()
to check for cancellation requests before processing the request or invokingNext
. - To terminate, or "short circuit", the pipeline don't invoke
Next
. - In your terminal delegate, set the response value in the request context.
- Samples.Lambda.SQS
- Samples.Lambda.SQS.Tests
- Samples.Lambda.APIGateway
- Samples.Lambda.APIGateway.Tests
The following examples demonstrate common usage scenarios.
In this sample, we create a request handler that does nothing with no configuration, no service registration, and no user-defined middleware. This is the simplest possible example.
var request = "Hello, World!";
var handler = RequestHandlerBuilder
.New<string, string>()
.Build();
var response = await handler.InvokeAsync(request);
Assert.True(String.IsNullOrEmpty(response));
In this sample, we create a request handler with user-defined middleware that converts the request to uppercase.
var request = "Hello, World!";
var handler = RequestHandlerBuilder.New<string, string>()
.Build()
.Use(async (context, next) =>
{
context.CancelationToken.ThrowIfCancellationRequested();
context.Response = context.Request.ToUpperInvariant();
await next(context); // call next to pass the request context to the next delegate in the pipeline
})
.Prepare();
var response = await handler.InvokeAsync(request);
Assert.Equal(request.ToUpperInvariant(), response);
In this sample, we create a request handler with a user-defined IMiddleware
implementation that converts the request to lowercase.
First, we define the middleware class, which receives the next middleware delegate in the pipeline in its constructor. The middleware is responsible for calling the next delegate unless the middleware needs to short-circuiting the pipeline. An example short-circuit scenario might be a request validation middleware that returns an error response if the request is invalid.
Constructor-based dependency injection is supported for IMiddleware
implementations,
with the condition that the next
delegate must be the first argument in the constructor.
internal sealed class ToLowerMiddleware(RequestMiddleware<string, string> next)
: IMiddleware<string, string>
{
private readonly RequestMiddleware<string, string> next = next
?? throw new ArgumentNullException(nameof(next));
public Task InvokeAsync(Context<string, string> context)
{
context.CancelationToken.ThrowIfCancellationRequested();
context.Response = context.Request.ToLowerInvariant();
return next(context); // call next to pass the request context to the next delegate in the pipeline
}
}
Next, we register the middleware with the request handler with the Use<T>
method.
var request = "Hello, World!";
var handler = RequestHandlerBuilder.New<string, string>()
.Build()
.Use<ToLowerMiddleware>()
.Prepare();
var response = await handler.InvokeAsync(request);
Assert.Equal(request.ToLowerInvariant(), response);
Use the IRequestHandlerBuilder.Configuration
property to add configuration providers, like AddInMemory
or AddJsonFile
.
var builder = RequestHandlerBuilder.New<string, string>(args);
builder.Configuration
.AddInMemoryCollection(new Dictionary<string, string> { { "MyKey", "MyValue" } });
var handler = builder.Build();
Use the IRequestHandlerBuilder.Services
property to register services.
var builder = RequestHandlerBuilder.New<string, string>(args);
builder.Services
.AddSingleton<IMyService, MyService>()
.AddSerilog();
var handler = builder.Build();
Use Void as a response type for request handlers that don't return a value.
public readonly struct Void { }
For request handlers that don't return a response, use Void
as the response type.
var handler = RequestHandlerBuilder.New<string, Void>() // Void TResponse type
.Build()
.Prepare();