Support specifying custom URLs for resources #8229

DamianEdwards · 2025-03-21T01:24:20Z

Description

This change introduces support for resource URLs. Resource endpoints get automatically projected into URLs, which can be customized, and extra URLs can be added that aren't associated with endpoints at all.

Fixes #6457
Fixes #7104
Fixes #4319
Contributes to #5209

Screen.Recording.2025-03-21.125917.mp4

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
- No
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 (please use this doc-idea template): [pending]

DamianEdwards · 2025-03-21T01:34:23Z

@JamesNK right now the dashboard is not showing URLs that aren't associated with an endpoint in the resource details grid as there's currently a requirement for property grid items to have a name as that's used as the key. @davidfowl is suggesting we change the current "Endpoints" grid to instead just show URLs, and re-think the columns to match, but we'll need to figure out how to handle items with no name. Would appreciate your help there. I guess we might want to revisit the column header in the Resources page too, i.e. change "Endpoints" to "URLs".

JamesNK · 2025-03-21T03:45:53Z

I think we change "Endpoints" to "Urls" everywhere.

Edit: However, there can be TCP endpoints which aren't Urls. It would be a little weird having a column called "Urls" that then contains values like tcp://localhost:8080. Technically they're URIs.

In the resource details we could change the columns to:

"Link" and "Endpoint name"

"Link" would be a hyperlink with the display name as the text, and fallback to the URL if there is no display name.
"Endpoint name" would be the optional endpoint name. If there is no endpoint name then the table cell would display "-" like other columns.

we'll need to figure out how to handle items with no name

Anything can be the row key, as long as it is unique. I'm guessing it is possible to have the same URL multiple times so that couldn't be the key. There wasn't a good key for volume so we used the index of the volume instance in the collection as the key.

aspire/src/Aspire.Dashboard/Model/ResourceViewModel.cs

Line 348 in e9aa3c2

object IPropertyGridItem.Key => index;

I think you could do the same thing here.

JamesNK · 2025-03-21T03:51:01Z

src/Aspire.Dashboard/Components/Controls/ResourceDetails.razor

+                        <AspireTemplateColumn Sortable="true" SortBy="@(GridSort<DisplayedEndpoint>.ByAscending(i => i.DisplayName))" Title="@ControlStringsLoc[nameof(ControlsStrings.DisplayNameColumnHeader)]">
+                            <GridValue ValueDescription="@ControlStringsLoc[nameof(ControlsStrings.DisplayNameColumnHeader)]"
+                                       Value="@context.DisplayName"
+                                       EnableHighlighting="@(!string.IsNullOrEmpty(_filter))"
+                                       HighlightText="@_filter" />
+                        </AspireTemplateColumn>


I'm not a fan of having the URL and display name as separate columns. I'd rather there was just a "Link" column which displayed a hyperlink. If there is a display name then it is the text for the link. If there isn't then use the URL.

Opening the text visualizer or copy would use the URL value.

Hmm, but there could also be values that aren't links, e.g. tcp://localhost:8080. Maybe link isn't the right header

OK so we're saying back to two columns. "Endpoint name" is one of them and I think that's clear. The second one will contain the hyperlink if it's a URL, otherwise it will just be the URI text. Do we simply give it a combo name like "URI / Link"? Or should we just settle on "Link" and not worry too much about the non-hyperlinked URI case?

I lean towards the latter option

@adamint just go with "Link"?

I went with "Link", take a look in the video in the PR description.

src/Aspire.Dashboard/Model/ResourceEndpointHelpers.cs

adamint · 2025-03-21T22:12:20Z

src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs

+                var url = context.Urls.FirstOrDefault(u => u.Endpoint?.EndpointName == endpointName);
+                if (url is not null)
+                {
+                    url.DisplayText = Resources.DataExplorerUrlText;


I don't think this will work, because the requesting browser may be using a different locale than hosting. I think it should go in the place I linked before

Ah right. We need this to be localized in the dashboard itself then, as a known string?

Right. I'm concerned just using the endpoint name will be too broad, we could use a combo of resource type + endpoint name? But since AzureCosmosDBEmulatorResource is just a container resource.. we can't use the resource type. Am I missing something or do we need to add a more specific identifier too

OK rigged it up.

JamesNK · 2025-03-21T22:55:19Z

I think the link column should come first:

The optional Endpoint name first feels wierd. Especially since the grid is no longer focused on endpoints.

src/Aspire.Dashboard/Components/Controls/ResourceDetails.razor

src/Aspire.Hosting/ApplicationModel/ResourceUrlsCallbackContext.cs

JamesNK · 2025-03-21T23:08:29Z

src/Aspire.Hosting/Dashboard/proto/resource_service.proto

-    // The name of the url
-    string name = 1;
+    // The name of endpoint associated with the url
+    optional string endpoint_name = 1;


FYI this change to the proto is binary compatible. It's ok to make

JamesNK · 2025-03-21T23:13:42Z

Two column widths in URLs grid isn't consistent with others:

It should be consistent.

JamesNK · 2025-03-21T23:16:05Z

@mitchdenny @davidfowl There is a lot in this PR. I'm focusing on dashboard changes and taking a brief look at hosting changes.

It would be good for hosting experts (ya'll) to double check hosting changes.

DamianEdwards · 2025-03-21T23:17:34Z

@JamesNK

Two column widths in URLs grid isn't consistent with others:

Given the column order will be reversed so the link is first and the endpoint name second, and I'd expect the link to be longer than the endpoint name in most cases, do you still think it makes sense to have the column widths match that of a standard name/value property grid?

JamesNK · 2025-03-21T23:20:29Z

I don't think either of them will be that long. A good URL display name will be short so it fits in the main grid so it should fit here. And most values here will still be the underlying URL anyway.

I think the consisency of grid widths, i.e. looking good, trumps showing a bit more of very long display names IMO.

DamianEdwards · 2025-03-21T23:22:33Z

I think the consisency of grid widths, i.e. looking good, trumps showing a bit more of very long display names IMO.

I'm not sure I agree but I'm fine with making them match until such time that we see evidence of it being a problem.

JamesNK · 2025-03-21T23:23:10Z

src/Aspire.Dashboard/Model/ResourceGraph/ResourceGraphMapper.cs

+        var text = endpoint?.Url;
        if (string.IsNullOrEmpty(text))
        {
            return "No endpoints";


This should say "No URLs". And while you're here, could you move the text to a resource file. I should have done that 😄

Actually the resource graph only looks at endpoint-associated URLs right now. When it was showing all URLs it would pick the first one and then show the display text un-hyperlinked which wasn't useful at all. Having it show the actual endpoint address is more useful IMO.

src/Aspire.Dashboard/Model/ResourceUrlHelpers.cs

davidfowl · 2025-03-22T02:53:42Z

src/Aspire.Hosting/ProjectResourceBuilderExtensions.cs

+                                    var url = context.Urls.FirstOrDefault(u => string.Equals(u.Endpoint?.EndpointName, endpoint.Name, StringComparisons.EndpointAnnotationName));
+                                    if (url is not null)
+                                    {
+                                        if (launchUri.IsAbsoluteUri)


Follow up: Discuss if an absolute launch urls wins over all over urls and becomes the only ones that shows up.

davidfowl · 2025-03-22T04:12:35Z

src/Shared/KnownUrls.cs

+
+internal static class KnownUrls
+{
+    public static class DataExplorer


This is the most .NET thing ever. Why is this shared it's cosmos specific.

Cos localization has to happen in the context of the dashboard. We do this for known commands too. We can add stuff to this for any other known link text we want to localize.

davidfowl

@DamianEdwards do a follow up and fix the AzureProvisioner to use this for deployments

DamianEdwards · 2025-03-22T21:43:13Z

do a follow up and fix the AzureProvisioner to use this for deployments

@davidfowl can you elaborate? Which URLs should the provisioner use exactly and for what scenarios? Maybe put details in an issue?

Adam Ratzman and others added 17 commits February 6, 2025 15:13

Add display name and priority to Urls

d510d16

Make sure to plumb new properties through gRPC

ed426a4

Add third display name column for endpoints when there is a display name

d5a5876

add Data Explorer display name to cosmos db, make properties settable

8cc202c

clean up DisplayedEndpoint type

cf8f358

Merge branch 'main' into dev/adamint/add-display-name-endpoint-support

61720f9

Use display properties object instead on EndpointAnnotation

5d46e88

Add unit test, remove breaking api changes

a9ac084

Customize testshop frontend access endpoint

a9f3a83

Merge branch 'main' into dev/adamint/add-display-name-endpoint-support

dca882f

Make display properties not nullable, remove breaking change

51f030c

Fix build

8d1fe66

Merge branch 'main' into dev/adamint/add-display-name-endpoint-support

98958d2

Post-merge fixes

11ae34e

WIP

80660e5

WIP

f372a1d

Working

e581c0d

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

DamianEdwards requested review from JamesNK, adamint and davidfowl March 21, 2025 01:24

davidfowl mentioned this pull request Mar 21, 2025

Allow specifying an address hostname for project/service binding #4319

Closed

comment clean up

fc9790d

Fix test project build break

05403ff

JamesNK reviewed Mar 21, 2025

View reviewed changes

src/Aspire.Dashboard/Model/ResourceEndpointHelpers.cs Outdated Show resolved Hide resolved

DamianEdwards added 2 commits March 21, 2025 09:49

PR feedback

728918b

Remove unused resx string

8dbab13

DamianEdwards added 2 commits March 21, 2025 13:10

More endpoints -> urls renaming

b2fb461

Merge branch 'main' into damianedwards/endpoint-display

1e12ee7

DamianEdwards requested review from JamesNK and adamint March 21, 2025 20:15

Undo member name change

0eba3a5

adamint reviewed Mar 21, 2025

View reviewed changes

DamianEdwards added 2 commits March 21, 2025 15:17

Add tests for WithUrls

580df68

Fix localization of Data Explorer URL link text

df96919

JamesNK reviewed Mar 21, 2025

View reviewed changes

Flesh out doc comments.

1aa4682

JamesNK reviewed Mar 21, 2025

View reviewed changes

src/Aspire.Dashboard/Model/ResourceUrlHelpers.cs Outdated Show resolved Hide resolved

PR feedback

cef6d34

DamianEdwards marked this pull request as ready for review March 21, 2025 23:55

DamianEdwards requested a review from mitchdenny as a code owner March 21, 2025 23:55

Update resource strings

79df229

davidfowl reviewed Mar 22, 2025

View reviewed changes

davidfowl approved these changes Mar 22, 2025

View reviewed changes

davidfowl merged commit a8e7db7 into main Mar 22, 2025
163 checks passed

davidfowl deleted the damianedwards/endpoint-display branch March 22, 2025 04:13

davidfowl mentioned this pull request Apr 6, 2025

What's new in .NET Aspire 9.2 dotnet/docs-aspire#2877

Merged

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

Support specifying custom URLs for resources #8229

Support specifying custom URLs for resources #8229

Uh oh!

Conversation

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

Uh oh!

Description

Checklist

Uh oh!

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

Uh oh!

Uh oh!

JamesNK commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JamesNK Mar 21, 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!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adamint Mar 21, 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!

JamesNK commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

JamesNK commented Mar 21, 2025

Uh oh!

JamesNK commented Mar 21, 2025

Uh oh!

DamianEdwards commented Mar 21, 2025

Uh oh!

JamesNK commented Mar 21, 2025

Uh oh!

DamianEdwards commented Mar 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

davidfowl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

Reviewers

Assignees

DamianEdwards commented Mar 21, 2025 •

edited

Loading

DamianEdwards commented Mar 21, 2025 •

edited

Loading

JamesNK commented Mar 21, 2025 •

edited

Loading

JamesNK Mar 21, 2025 •

edited

Loading

adamint Mar 21, 2025 •

edited

Loading

JamesNK commented Mar 21, 2025 •

edited

Loading

DamianEdwards commented Mar 22, 2025 •

edited

Loading