Custom URLs improvements #8743

DamianEdwards · 2025-04-11T22:16:45Z

Description

Bunch of changes to resource URL customization based on user feedback in 9.2:

Control whether URL is visible on resources page or not
Add helper method to get resource endpoint from ResourceUrlsCallbackContext
Support relative URLs for endpoints
Add overload of WithUrlForEndpoint for adding extra endpoint URLs

Checklist

Is this feature complete?
- Yes. Ready to ship.
Are you including unit tests for the changes and scenario tests if relevant?
- Yes
Did you add public API?
- Yes
  - If yes, did you have an API Review for it?
    - No
  - Did you add <remarks /> and <code /> elements on your triple slash comments?
    - Yes
Does the change make any security assumptions or guarantees?
- No
Does the change require an update in our Aspire docs?
- Yes
  - Is this introducing a breaking change?
    - No
      - Link to aspire-docs issue: Update resource URL customization doc for improvements in 9.3 docs-aspire#3078

Image shows the Frontend resource in TestShop only showing one URL in the Resources table but all URLs in the details view. The details view has been updated to show three columns so that the URL address, text, and endpoint are now clear.

Here's an example of the details view for a resource with a non-HTTP URL:

- Control whether URL is visible on resources page or not - Add helper method to get resource endpoint from ResourceUrlsCallbackContext - Support relative URLs for endpoints - Add overload of WithUrlForEndpoint for adding extra endpoint URLs Fixes #8725, #8636, #8640, #8638, #6454

DamianEdwards · 2025-04-11T22:57:05Z

src/Aspire.Hosting/ApplicationModel/ResourceUrlAnnotation.cs

+    /// <remarks>
+    /// Set this to <see langword="false"/> to only show this URL in the resource details grid.
+    /// </remarks>
+    public bool ShowOnResourcesPage { get; set; } = true;


Thoughts on the property name? This maps to the IsInternal property on the URL snapshot and resource server APIs but that name is pretty terrible so trying to make it more descriptive here.

make it an enum?

Ha I actually started that way, a flags enum.

Actually not flags as the resource snapshots, dashboard, and resource server protocol currently only support the boolean state (IsInternal). So perhaps something like the following, although I admit I don't love it:

/// <summary> /// Specifies where the URL should be displayed. /// </summary> public enum UrlDisplayLocation { /// <summary> /// Show the URL in locations where either the resource summary or resource details are being displayed. /// </summary> SummaryAndDetails, /// <summary> /// Show the URL in locations where the full details of the resource are being displayed. /// </summary> DetailsOnly }

And modify the protocol?

Maybe flags is wrong anyways because alll combinations aren’t valid so the above is fine?

DamianEdwards · 2025-04-11T23:00:45Z

src/Aspire.Hosting/ApplicationModel/ResourceUrlAnnotation.cs

+    internal ResourceUrlAnnotation WithEndpoint(EndpointReference endpoint)
+    {
+        return new()
+        {
+            Url = Url,
+            DisplayText = DisplayText,
+            Endpoint = endpoint,
+            DisplayOrder = DisplayOrder,
+            ShowOnResourcesPage = ShowOnResourcesPage
+        };
+    }


This was added to support the new overload of WithUrlForEndpoint that allows adding a new URL for an endpoint. The callback in that case has the user return the ResourceUrlAnnotation and then we call this method to ensure the correct endpoint is associated with it. The user could set it themselves in the callback as we pass them the EndpointReference, but this way ensures it's always correct. The Endpoint property is currently marked init and it didn't seem to me that anything else warranted changing it to set but I could be convinced otherwise.

DamianEdwards · 2025-04-11T23:02:02Z

src/Aspire.Hosting/ApplicationModel/ResourceUrlsCallbackContext.cs

+    public EndpointReference? GetEndpoint(string name) =>
+        Resource switch
+        {
+            IResourceWithEndpoints resourceWithEndpoints => resourceWithEndpoints.GetEndpoint(name),
+            _ => null
+        };


Makes it easy for callers of WithUrls to get an endpoint on the resource without needing to do type checking/casting to IResourceWithEndpoints.

Should it throw instead of returning null?

Throwing is a bit mean how do you avoid throwing?

src/Aspire.Hosting/ResourceBuilderExtensions.cs

DamianEdwards · 2025-04-11T23:13:14Z

src/Aspire.Hosting/ResourceBuilderExtensions.cs

+    public static IResourceBuilder<T> WithUrlForEndpoint<T>(this IResourceBuilder<T> builder, string endpointName, Func<EndpointReference, ResourceUrlAnnotation> callback)
+        where T : IResourceWithEndpoints
+    {
+        builder.WithUrls(context =>
+        {
+            var endpoint = builder.GetEndpoint(endpointName);
+            if (endpoint.Exists)
+            {
+                var url = callback(endpoint).WithEndpoint(endpoint);
+                context.Urls.Add(url);
+            }
+            else
+            {
+                context.Logger.LogWarning("Could not execute callback to add an endpoint URL as no endpoint with name '{EndpointName}' could be found on resource '{ResourceName}'.", endpointName, builder.Resource.Name);
+            }
+        });
+
+        return builder;
+    }


This new overload can be used to add a URL for an endpoint, whereas the existing overload is used to update the (first) URL for an endpoint.

davidfowl · 2025-04-11T23:58:20Z

cc @afscrome @paulomorgado

mitchdenny · 2025-04-12T01:18:45Z

This looks good to me. Just one comment about throwing vs. returning null. Should we ever get into the situation where that resource is no IResourceWithEndpoints?

DamianEdwards · 2025-04-12T01:49:33Z

@mitchdenny

This looks good to me. Just one comment about throwing vs. returning null. Should we ever get into the situation where that resource is no IResourceWithEndpoints?

Yes, because you can add URLs to any resource

JamesNK · 2025-04-12T05:42:51Z

Bugs:

There should be - (dashes) in the grid when there are no values.
Clicking the details button for an empty text column shows the address. Instead, the details icon shouldn't be display.

An example of no correctly displaying no value is Source column with resource like a database which has no source. It has a dash, it has no details icon on mouse over:

JamesNK · 2025-04-12T05:45:27Z

#8745

akoeplinger · 2025-04-12T07:23:55Z

FYI this only closed the first issue:

Fixes #8725, #8636, #8640, #8638, #6454

davidfowl · 2025-04-12T07:56:44Z

LLMs can’t parse the comma!?😅

paulomorgado · 2025-04-14T10:50:25Z

Looks like I'm late to the party. 😄

When will this be available?

JamesNK · 2025-04-14T11:36:52Z

9.3

paulomorgado · 2025-04-14T14:10:39Z

9.3

When will that be available? Any previews, in the meantime?

davidfowl · 2025-04-14T14:24:18Z

There’s always daily builds https://github.com/dotnet/aspire/blob/main/docs/using-latest-daily.md

paulomorgado · 2025-04-17T11:21:53Z

@DamianEdwards, does this also add the possibility for the display text for the URL to be only on the summary but not on the details?

The way I see it, on the summary view, the text should be the display name. On the details view, it should show the Link, the Display name and the Endpoint name.

The configuration of the endpoint should assume the Display name as the Endpoint name by default.

DamianEdwards · 2025-04-21T17:15:49Z

@paulomorgado

The way I see it, on the summary view, the text should be the display name. On the details view, it should show the Link, the Display name and the Endpoint name.

That's what it does now.

paulomorgado · 2025-04-21T18:09:31Z

@paulomorgado

The way I see it, on the summary view, the text should be the display name. On the details view, it should show the Link, the Display name and the Endpoint name.

That's what it does now.

"now" == 9.3.0 ?

DamianEdwards · 2025-04-21T23:02:32Z

@paulomorgado yes

github-actions bot added the area-dashboard label Apr 11, 2025

DamianEdwards added 2 commits April 11, 2025 15:45

Update tests

551c242

Fix test name

7b66aaf

DamianEdwards mentioned this pull request Apr 11, 2025

Update resource URL customization doc for improvements in 9.3 dotnet/docs-aspire#3078

Closed

DamianEdwards commented Apr 11, 2025

View reviewed changes

src/Aspire.Hosting/ResourceBuilderExtensions.cs Show resolved Hide resolved

DamianEdwards commented Apr 11, 2025

View reviewed changes

src/Aspire.Hosting/ResourceBuilderExtensions.cs Outdated Show resolved Hide resolved

Always handle relative endpoint URLs

c313048

DamianEdwards commented Apr 11, 2025

View reviewed changes

DamianEdwards marked this pull request as ready for review April 11, 2025 23:13

DamianEdwards requested a review from mitchdenny as a code owner April 11, 2025 23:13

DamianEdwards assigned JamesNK and unassigned JamesNK Apr 11, 2025

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

Use enum for URL display location

3c9d767

davidfowl approved these changes Apr 12, 2025

View reviewed changes

DamianEdwards merged commit 3f9e7d2 into main Apr 12, 2025
174 checks passed

DamianEdwards deleted the damianedwards/WithUrlsImprovements branch April 12, 2025 04:57

JamesNK mentioned this pull request Apr 12, 2025

Dashboard URL display bugs #8745

Closed

paulomorgado mentioned this pull request Apr 15, 2025

Hide keycloak management URL from summary #8788

Merged

4 tasks

davidfowl mentioned this pull request Apr 17, 2025

Multiple WithUrlForEndpoint per one endpoint results in just one link showing #8846

Closed

1 task

davidfowl mentioned this pull request May 13, 2025

.NET Aspire release 9.3 content dotnet/docs-aspire#3368

Merged

github-actions bot locked and limited conversation to collaborators May 22, 2025

Uh oh!

Custom URLs improvements #8743

Custom URLs improvements #8743

Uh oh!

Conversation

DamianEdwards commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

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!

DamianEdwards Apr 12, 2025 • 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!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

davidfowl commented Apr 11, 2025

Uh oh!

mitchdenny commented Apr 12, 2025

Uh oh!

DamianEdwards commented Apr 12, 2025

Uh oh!

Uh oh!

JamesNK commented Apr 12, 2025

Uh oh!

JamesNK commented Apr 12, 2025

Uh oh!

akoeplinger commented Apr 12, 2025

Uh oh!

davidfowl commented Apr 12, 2025

Uh oh!

paulomorgado commented Apr 14, 2025

Uh oh!

JamesNK commented Apr 14, 2025

Uh oh!

paulomorgado commented Apr 14, 2025

Uh oh!

davidfowl commented Apr 14, 2025

Uh oh!

paulomorgado commented Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DamianEdwards commented Apr 21, 2025

Uh oh!

paulomorgado commented Apr 21, 2025

Uh oh!

DamianEdwards commented Apr 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

DamianEdwards commented Apr 11, 2025 •

edited

Loading

DamianEdwards Apr 12, 2025 •

edited

Loading

paulomorgado commented Apr 17, 2025 •

edited

Loading