Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CORS support to MiniProfiler #509

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
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
37 changes: 37 additions & 0 deletions src/MiniProfiler.AspNetCore/MiniProfilerMiddleware.cs
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,12 @@ private async Task SetHeadersAndState(HttpContext context, MiniProfiler current)
}
}

// Expose X-MiniProfiler-Ids header if this is a CORS request
if (context.Request.Headers.ContainsKey("Origin"))
{
context.Response.Headers.Add("Access-Control-Expose-Headers", "X-MiniProfiler-Ids");
}

// Set the state to use in RenderIncludes() down the pipe later
new RequestState { IsAuthorized = isAuthorized, RequestIDs = profilerIds }.Store(context);
}
Expand All @@ -205,6 +211,18 @@ private async Task SetHeadersAndState(HttpContext context, MiniProfiler current)

private async Task HandleRequest(HttpContext context, PathString subPath)
{
// Is this a CORS request
if (context.Request.Headers.TryGetValue("Origin", out var originValues)
&& originValues.Any())
{
SetCorsHeaders(context.Response, originValues);
if (context.Request.Method == "OPTIONS")
{
await HandleCorsOptionsRequest(context.Response);
return;
}
}

context.Response.StatusCode = StatusCodes.Status200OK;
string result = null;

Expand Down Expand Up @@ -406,5 +424,24 @@ private async Task<string> GetSingleProfilerResultAsync(HttpContext context)
return Render.SingleResultHtml(profiler, context.Request.PathBase + Options.RouteBasePath.Value.EnsureTrailingSlash());
}
}

private void SetCorsHeaders(HttpResponse response, string origin)
{
response.Headers.Add("Vary", "Origin");

if (_options.Value.CorsOrigins != null
&& _options.Value.CorsOrigins.Contains(origin, StringComparer.OrdinalIgnoreCase))
{
response.Headers.Add("Access-Control-Allow-Origin", origin);
}
}

private async Task HandleCorsOptionsRequest(HttpResponse response)
{
response.StatusCode = 200;
response.Headers.Add("Access-Control-Allow-Headers", "Content-Type");
response.Headers.Add("Access-Control-Allow-Methods", "OPTIONS, GET");
await response.WriteAsync("").ConfigureAwait(false);
}
}
}
6 changes: 6 additions & 0 deletions src/MiniProfiler.AspNetCore/MiniProfilerOptions.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using StackExchange.Profiling.Internal;
Expand Down Expand Up @@ -55,6 +56,11 @@ public class MiniProfilerOptions : MiniProfilerBaseOptions
/// </summary>
public Func<HttpRequest, string> UserIdProvider { get; set; } = request => request.HttpContext.Connection.RemoteIpAddress?.ToString();

/// <summary>
/// Optional list of origins allowed for CORS requests to MiniProfiler
/// </summary>
public IEnumerable<string> CorsOrigins { get; set; }

#if NETCOREAPP3_0
/// <summary>
/// Whether to add a Server-Timing header after profiling a request. Only supported in .NET Core 3.0 and higher.
Expand Down