Adding basepath to the config #6963

ewassef · 2024-12-18T03:40:10Z

This will allow the aspire app to handle running behind a reverse proxy such as a k8s ingress on a subpath #4159
#4528
#5134

Description

Added a new dashboard base path option, integrated it into the Dashboard Option, validated and replaced all areas that are creating the links

Fixes # (issue)

Checklist

Is this feature complete?
- Yes. Ready to ship.
- No. Follow-up changes expected.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
- [x ] No
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - Yes
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
    - [] No
- No
Does the change make any security assumptions or guarantees?
- Yes
  - If yes, have you done a threat model and had a security review?
    - Yes
    - No
- No
Does the change require an update in our Aspire docs?
- Yes
  - Is this introducing a breaking change?
    - Yes
      - Link to aspire-docs issue (please use this breaking-change template):
    - No
      - Link to aspire-docs issue (please use this doc-idea template):
- No

Microsoft Reviewers: Open in CodeFlow

This will allow the aspire app to handle running behind a reverse proxy such as a k8s ingress on a subpath dotnet#4159 dotnet#4528 dotnet#5134

adamint

Please add test coverage in ValidateDashboardOptions.

src/Aspire.Dashboard/Utils/DashboardUrls.cs

adamint · 2024-12-19T18:46:17Z

@JamesNK for review

ewassef · 2024-12-23T04:00:59Z

Please add test coverage in ValidateDashboardOptions.

Tests added

rerunning the PR checks

davidfowl · 2024-12-24T23:14:27Z

The options changes look fine, but this is a one liner in middleware https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.usepathbaseextensions.usepathbase?view=aspnetcore-9.0.

You can undo all of the other changes you made.

ewassef · 2024-12-26T19:57:44Z

The options changes look fine, but this is a one liner in middleware https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.usepathbaseextensions.usepathbase?view=aspnetcore-9.0.

You can undo all of the other changes you made.

@davidfowl , I'm afraid I do not follow. I am using that method in the middleware, but everything else is to handle the options and also the way we are generating the link in the blazor app. The links seem to be string interpolation from the base before

adamint · 2024-12-26T20:44:36Z

The options changes look fine, but this is a one liner in middleware https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.usepathbaseextensions.usepathbase?view=aspnetcore-9.0.
You can undo all of the other changes you made.

@davidfowl , I'm afraid I do not follow. I am using that method in the middleware, but everything else is to handle the options and also the way we are generating the link in the blazor app. The links seem to be string interpolation from the base before

I see what fowler means now. We don't need to store path base inside DashboardUrls. You do however need to provide a <base> tag in blazor since the base path is changed.

the way we are generating the link

The path base is provided in the dashboard options already. You can use that when writing out the dashboard url.

davidfowl · 2024-12-26T20:55:45Z

There should be a single call to the UsePathBase middleware in the code base. You can undo all of the other changes that were made to prepend the path base into various places in the application.

adamint · 2024-12-27T14:39:12Z

There should be a single call to the UsePathBase middleware in the code base. You can undo all of the other changes that were made to prepend the path base into various places in the application.

We need to change the blazor client-side path base as well.

davidfowl · 2024-12-28T00:55:14Z

Why? Also UsePathBase should be the first middleware (order matters). We should be able to remove the prefix in UseErrorHandler as well.

JamesNK · 2024-12-28T02:17:51Z

Is blazor loading something from a rooted path? Eg /blazor.

Can it be changed to a relative path? ./blazor

JamesNK · 2024-12-28T02:37:34Z

https://learn.microsoft.com/en-nz/aspnet/core/blazor/host-and-deploy/?view=aspnetcore-8.0&tabs=visual-studio#app-base-path

I don’t know the right thing to do (haven’t read docs) but there are a lot of docs on this issue. Find out what is best with blazor server in this situation.

davidfowl · 2025-01-14T07:34:11Z

/azp run

davidfowl · 2025-01-14T07:34:22Z

@JamesNK @adamint have you tried this out?

azure-pipelines · 2025-01-14T07:34:24Z

Azure Pipelines successfully started running 1 pipeline(s).

ewassef · 2025-02-02T17:30:26Z

Im still unclear on the ask. I started with just the one liner, but it doesnt work as expected. we need to handle the url creation helpers in all the places that ive modified. The pipelines keep cycling and im not sure whats not actually working from this code?

davidfowl · 2025-02-02T18:29:03Z

UsePathBase should do most of the heavy lifting. I will take a stab at this and see why that simple one line change doesn’t work.

ewassef · 2025-02-04T03:05:48Z

Thanks @davidfowl . we really just want to install this as a subpath in a k8s ingress :)
To save you some time, you can take the first commit from the 5 that are there and run your tests

ewassef · 2025-03-26T01:03:23Z

Any progress?

WeihanLi · 2025-03-31T09:40:52Z

Is it possible to use the forwarded header for it, ASP.NET supports the X-Forwarded-Prefix since .NET 8

Maybe configure the ForwardedHeadersOptions is more simple to implement

https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.forwardedheadersoptions.forwardedheaders?view=aspnetcore-9.0#microsoft-aspnetcore-builder-forwardedheadersoptions-forwardedheaders

dotnet/aspnetcore#23263

JamesNK

I haven't tested the branch, just looked at code. My knowledge of the things in this PR (running an ASP.NET Core with a base path, running behind a proxy, forwarding headers) is low. An expert should take another look.

I mentioned coming URLs with OrdinalIgnoreCase a number of times. FYI we have StringComparers/StringComparisons with known comparison types. One already might be there for URLs. If not then you could add one.

JamesNK · 2025-04-04T02:31:43Z

playground/TestShop/TestShop.AppHost/HostingExtensions.cs

+    /// Adds a rference to the dashboard resource so that the required environment variables to allow service discovery to the Aspire dashboard
+    /// are added to this resource. Also configures a reference relationship to the dashboard resource.


Needs proof reading

JamesNK · 2025-04-04T02:33:23Z

playground/TestShop/TestShop.AppHost/HostingExtensions.cs

+        var dashboardUris = builder.ApplicationBuilder.Configuration["ASPNETCORE_URLS"]?.Split(';')
+            ?.Select(u => Uri.TryCreate(u, UriKind.Absolute, out var uri) is { } ? uri : null)
+            ?.Where(u => u is not null)
+            ?.Cast<Uri>()
+            ?.GroupBy(u => u.Scheme)
+            ?? [];


Suggested change

var dashboardUris = builder.ApplicationBuilder.Configuration["ASPNETCORE_URLS"]?.Split(';')

?.Select(u => Uri.TryCreate(u, UriKind.Absolute, out var uri) is { } ? uri : null)

?.Where(u => u is not null)

?.Cast<Uri>()

?.GroupBy(u => u.Scheme)

?? [];

var dashboardUris = builder.ApplicationBuilder.Configuration["ASPNETCORE_URLS"]?.Split(';')

.Select(u => Uri.TryCreate(u, UriKind.Absolute, out var uri) is { } ? uri : null)

.OfType<Uri>()

.GroupBy(u => u.Scheme)

?? [];

JamesNK · 2025-04-04T02:37:30Z

playground/TestShop/TestShop.AppHost/HostingExtensions.cs

+                    if (https is not null || http is not null)
+                    {
+                        var endpoint = https ?? http!;
+                        context.Urls.Add(new() { Url = $"{endpoint.Url}{proxyPath}", DisplayText = "Proxied Dashboard" });


A string concat of URL + path could mean there is no forward slash, or multiple forward slashes in the new URL. Use a better way to combine them?

JamesNK · 2025-04-04T02:38:33Z

playground/TestShop/TestShop.AppHost/Properties/launchSettings.json

@@ -26,7 +27,8 @@
        "ASPIRE_DASHBOARD_OTLP_HTTP_ENDPOINT_URL": "http://localhost:16032",
        "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:17031",
        "ASPIRE_SHOW_DASHBOARD_RESOURCES": "true",
-        "ASPIRE_ALLOW_UNSECURED_TRANSPORT": "true"
+        "ASPIRE_ALLOW_UNSECURED_TRANSPORT": "true",
+        "Dashboard__ReverseProxy__ForwardHeaders": "true"


This is probably answered in later code, but how does this env var to the host make its way to the dashboard?

JamesNK · 2025-04-04T02:39:00Z

src/Aspire.Dashboard/Components/App.razor

@@ -39,3 +42,22 @@
    <script src="_content/Microsoft.FluentUI.AspNetCore.Components/Microsoft.FluentUI.AspNetCore.Components.lib.module.js" type="module"></script>
 </body>
 </html>
+
+@code {
+    private string pathBase = "/";


Suggested change

private string pathBase = "/";

private string _pathBase = "/";

JamesNK · 2025-04-04T02:44:59Z

src/Aspire.Dashboard/DashboardEndpointsBuilder.cs

@@ -3,7 +3,7 @@

 using Aspire.Dashboard.Configuration;
 using Aspire.Dashboard.Model;
-using Aspire.Dashboard.Utils;
+using Aspire.Dashboard.Utils; 


Suggested change

using Aspire.Dashboard.Utils;

using Aspire.Dashboard.Utils;

JamesNK · 2025-04-04T02:47:01Z

src/Aspire.Dashboard/DashboardWebApplication.cs

+            {
+                // In development we want to ensure that requests outside of the path base return a 404 to mimic what would
+                // happen when the dashboard is being served from behind a reverse-proxy at a configured path. Note we still let
+                // ~/login requests through as that's what VS launches the browser to. In that case we redirect instead.


Need intergration tests of this:

Base path + good path = 200
Base path + bad path = 404
Base path + /login = 302

JamesNK · 2025-04-04T02:49:32Z

src/Aspire.Dashboard/Utils/DashboardUrls.cs

+        if (baseRelativePath == targetPagePath)
+        {
+            return true;
+        }
+
+        var queryIndex = baseRelativePath.IndexOf('?');
+        var testPath = queryIndex >= 0 ? baseRelativePath[..queryIndex] : baseRelativePath;
+        var isMatch = testPath.TrimEnd('/') == targetPagePath;
+        return isMatch;


Path comparisons here should ignore case and culture, e.g. OrdinalIgnoreCase

JamesNK · 2025-04-04T02:50:35Z

src/Aspire.Hosting/OtlpConfigurationExtensions.cs

+            if (!string.IsNullOrEmpty(dashboardPathBase))
+            {
+                // Ensure OTLP URLs are rewritten to include the path base.
+                if (Uri.TryCreate(dashboardOtlpGrpcUrl, UriKind.Absolute, out var otlpGrpcUri) && !otlpGrpcUri.AbsolutePath.StartsWith(dashboardPathBase))


OrdinalIgnoreCase?

JamesNK · 2025-04-04T02:50:39Z

src/Aspire.Hosting/OtlpConfigurationExtensions.cs

+                    uriBuilder.Path = dashboardPathBase + uriBuilder.Path.TrimStart('/');
+                    dashboardOtlpGrpcUrl = uriBuilder.Uri.ToString();
+                }
+                if (Uri.TryCreate(dashboardOtlpHttpUrl, UriKind.Absolute, out var otlpHttpUri) && !otlpHttpUri.AbsolutePath.StartsWith(dashboardPathBase))


OrdinalIgnoreCase?

JamesNK · 2025-04-04T02:55:12Z

playground/TestShop/TestShop.AppHost/HostingExtensions.cs

+            ?.Select(u => Uri.TryCreate(u, UriKind.Absolute, out var uri) is { } ? uri : null)
+            ?.Where(u => u is not null)
+            ?.Cast<Uri>()
+            ?.GroupBy(u => u.Scheme)


I think scheme is always lower case. Maybe ToLowerInvariant() in the group by in case it isn't and someone does:

ASPNETCORE_URLS=https://localhost:80;HTTPS://LOCALHOST:8080

JamesNK · 2025-04-04T02:57:13Z

This is going to require a lot of new tests. For example, does all the existing authentication functionality work properly when running with a base path.

DamianEdwards · 2025-04-10T21:25:20Z

This is going to require a lot of new tests. For example, does all the existing authentication functionality work properly when running with a base path.

@JamesNK yep for sure. This is now functionally complete more or less and the next step is to figure out a testing strategy.

danmoseley · 2025-05-01T20:43:54Z

@ewassef do you plan to continue with this PR?

ewassef · 2025-05-01T21:53:30Z

@ewassef do you plan to continue with this PR?

Are you serious? All the maintainers did their best to discourage contributions, said they would fix it and then let it rot. Most of the people i know have forked this and run it themselves.

I would Love to not have to do that, but the style police is stopping everything. So I'm waiting for them to fulfill their commitment ( see thread )

DamianEdwards · 2025-05-02T18:56:10Z

@ewassef apologies for confusion. My intent is to complete this PR, it's just a priority and sequencing question right now. No asks on you right now.

Adding basepath to the config

7c65251

This will allow the aspire app to handle running behind a reverse proxy such as a k8s ingress on a subpath dotnet#4159 dotnet#4528 dotnet#5134

dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label Dec 18, 2024

updating the logging helpers as they dont have refernce to the utility

c4c4976

This was referenced Dec 18, 2024

Hosting Dashboard from child path (https://domain/my/child/path) does not appear to work correctly #4159

Open

Add PathBaseMiddleware to Aspire Dashboard #4528

Open

Make it possible to run the dashboard behind a reverse proxy or load balancer #5134

Open

adamint reviewed Dec 19, 2024

View reviewed changes

src/Aspire.Dashboard/Utils/DashboardUrls.cs Outdated Show resolved Hide resolved

Adding tests

4836ed3

build-analysis bot mentioned this pull request Dec 23, 2024

The Operation will be canceled. The next steps may not contain expected logs. dotnet/dnceng#3008

Open

3 tasks

Update README.md

7240866

rerunning the PR checks

Merge branch 'dotnet:main' into main

67c626f

github-actions bot added the area-dashboard label Mar 10, 2025

DamianEdwards added 4 commits April 1, 2025 10:23

Fix redirects

3652118

Move pathbase redirection into middleware class

40895da

Fix JS imports & OTLP URLs

e474a8a

Fix dashboard options validation

a82cc32

DamianEdwards removed the needs-author-action An issue or pull request that requires more info or actions from the author. label Apr 1, 2025

DamianEdwards added 7 commits April 1, 2025 15:20

Ensure cookie path is set when PathBase is set

68d3850

Update PathBaseRedirectionMiddleware.cs

b881534

Ensure legacy browser token env var name is honored

93a5b22

Update DistributedApplicationBuilder.cs

18ed556

Enforce path base in dev

650593a

Fix app-theme.js to import relative path

9f33f25

More JS module import fixes

9825ccf

DamianEdwards requested review from adamint, JamesNK and davidfowl April 1, 2025 23:13

Fix redirects

961dfef

DamianEdwards marked this pull request as draft April 3, 2025 01:07

Add dashboard proxy using YARP to TestShop

939d0a9

DamianEdwards mentioned this pull request Apr 3, 2025

Updated Dashboard to accept/map forwarded headers #6969

Closed

18 tasks

Add reverse proxy configuration options for dashboard

57824dd

JamesNK reviewed Apr 4, 2025

View reviewed changes

DamianEdwards added 3 commits April 4, 2025 16:41

Fix img links assuming root on login page

8c2ac1e

More cookie & request path fixes

23832a3

Validate reverse proxy options

04737bc

		/// Adds a rference to the dashboard resource so that the required environment variables to allow service discovery to the Aspire dashboard
		/// are added to this resource. Also configures a reference relationship to the dashboard resource.

	private string pathBase = "/";
	private string _pathBase = "/";

Adding basepath to the config #6963

Are you sure you want to change the base?

Adding basepath to the config #6963

Uh oh!

Conversation

ewassef commented Dec 18, 2024 • edited by dotnet-policy-service bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Microsoft Reviewers: Open in CodeFlow

Uh oh!

adamint left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adamint commented Dec 19, 2024

Uh oh!

ewassef commented Dec 23, 2024

Uh oh!

davidfowl commented Dec 24, 2024

Uh oh!

ewassef commented Dec 26, 2024

Uh oh!

adamint commented Dec 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

davidfowl commented Dec 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adamint commented Dec 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

davidfowl commented Dec 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JamesNK commented Dec 28, 2024

Uh oh!

JamesNK commented Dec 28, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

davidfowl commented Jan 14, 2025

Uh oh!

davidfowl commented Jan 14, 2025

Uh oh!

azure-pipelines bot commented Jan 14, 2025

Uh oh!

ewassef commented Feb 2, 2025

Uh oh!

davidfowl commented Feb 2, 2025

Uh oh!

ewassef commented Feb 4, 2025

Uh oh!

ewassef commented Mar 26, 2025

Uh oh!

WeihanLi commented Mar 31, 2025

Uh oh!

JamesNK left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ewassef commented Dec 18, 2024 •

edited by dotnet-policy-service bot

Loading

adamint commented Dec 26, 2024 •

edited

Loading

davidfowl commented Dec 26, 2024 •

edited

Loading

adamint commented Dec 27, 2024 •

edited

Loading

davidfowl commented Dec 28, 2024 •

edited

Loading

JamesNK commented Dec 28, 2024 •

edited

Loading

JamesNK left a comment •

edited

Loading

JamesNK Apr 4, 2025 •

edited

Loading