Access TempData within custom middleware

Question

I have custom middleware that provides global error handling. If an exception is caught it should log the details with a reference number. I then want to redirect the user to an error page and only show the reference number. My research shows that TempData should be ideal for this but it only seems to be accessible from within a controller context. I tried adding the reference number to HttpContext.Items["ReferenceNumber"] = Guid.NewGuid(); But this value is lost through the redirect.

How can middleware pass information through a redirect? Do I just have to put the number in a querystring?

Answer 1

Inside the middleware class you need to add a reference to get access to the required interfaces. I have this middleware in a separate project and needed to add this NuGet package.

using Microsoft.AspNetCore.Mvc.ViewFeatures;

This then allows you to request the correct services within the middleware.

//get TempData handle
ITempDataDictionaryFactory factory = httpContext.RequestServices.GetService(typeof(ITempDataDictionaryFactory)) as ITempDataDictionaryFactory;
ITempDataDictionary tempData = factory.GetTempData(httpContext);

After you have ITempDataDictionary you can use it like you would use TempData within a controller.

//pass reference number to error controller
Guid ReferenceNum = Guid.NewGuid();
tempData["ReferenceNumber"] = ReferenceNum.ToString();

//log error details
logger.LogError(eventID, exception, ReferenceNum.ToString() + " - " + exception.Message);

Now when I get the the controller after a redirect I have no issues pulling out the reference number and using it in my view.

//read value in controller
string refNum = TempData["ReferenceNumber"] as string;
if (!string.IsNullOrEmpty(refNum))
    ViewBag.ReferenceNumber = refNum;

@*display reference number if one was provided*@
@if (ViewBag.ReferenceNumber != null){<p>Reference Number: @ViewBag.ReferenceNumber</p>}

Once you put this all together, you give users a reference number that they can give you to help troubleshoot the problem. But, you are not passing back potentially sensitive error information which could be misused.

Answer 2

You can register an ITempDataProvider yourself and use it in your middleware. Here is a small sample I got working between two simple paths. If you are already using MVC the ITempDataProvider is probably already registered. The issue I faced was the path of the cookie that was written. It was /page1 so /page2 did not have access to the cookie. So I had to override the options as you can see in code below.

I hope this will help you :)

public void ConfigureServices(IServiceCollection services)
{

    services.AddSingleton<IDataProtectionProvider>(s => DataProtectionProvider.Create("WebApplication2"));

    services.Configure<CookieTempDataProviderOptions>(options =>
    {
        options.Path = "/";
    });
    services.AddSingleton<ITempDataProvider, CookieTempDataProvider>();
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ITempDataProvider tempDataProvider)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.Map("/page1", (app1) =>
    {
        app1.Run(async context =>
        {
            tempDataProvider.SaveTempData(context, new Dictionary<string, object> { ["Message"] = "Hello from page1 middleware" });
            await context.Response.WriteAsync("Hello World! I'm page1");
        });
    });

    app.Map("/page2", (app1) =>
    {
        app1.Run(async context =>
        {
            var loadTempData = tempDataProvider.LoadTempData(context);
            await context.Response.WriteAsync("Hello World! I'm page2: Message from page1: " + loadTempData["Message"]);
        });
    });
}

This led me in the right direction: https://learn.microsoft.com/en-us/aspnet/core/fundamentals/app-state#cookie-based-tempdata-provider

Happy coding! :)

Answer 3

This is the cleanest way of doing it:

// Create a new ITempDataDictionary object
var tempData = context.RequestServices.GetRequiredService<ITempDataProvider>().LoadTempData(context);

// Add key-value pairs to the temp data dictionary
tempData["Key1"] = "Value1";
tempData["Key2"] = "Value2";

// Save the temp data dictionary to the HttpContext
context.RequestServices.GetRequiredService<ITempDataProvider>().SaveTempData(context, tempData);

await next.Invoke();