Make *.localhost resource endpoint URLs the primary endpoint URL (#12466)

* Make *.localhost resource endpoint URLs the primary endpoint URL
Fixes #12465

* Update test

Author: DamianEdwards

src/Aspire.Hosting/Orchestrator/ApplicationOrchestrator.cs

@@ -267,6 +267,9 @@ private async Task ProcessResourceUrlCallbacks(IResource resource, CancellationT
                         // If the additional URL is a *.localhost address we want to highlight that URL in the dashboard
                         additionalUrl.DisplayLocation = UrlDisplayLocation.SummaryAndDetails;
                         url.DisplayLocation = UrlDisplayLocation.DetailsOnly;
+
+                        // Swap so that the *.localhost URL is the primary URL shown in the dashboard and targeted by `WithUrlForEndpoint` calls.
+                        (additionalUrl, url) = (url, additionalUrl);
                     }
                     else if ((string.Equals(endpoint.UriScheme, "http", StringComparison.OrdinalIgnoreCase) || string.Equals(endpoint.UriScheme, "https", StringComparison.OrdinalIgnoreCase))
                              && additionalUrl is null && EndpointHostHelpers.IsDevLocalhostTld(_dashboardUri))
@@ -278,14 +281,18 @@ private async Task ProcessResourceUrlCallbacks(IResource resource, CancellationT
                         // Strip any "apphost" suffix that might be present on the dashboard name.
                         subdomainSuffix = TrimSuffix(subdomainSuffix, "apphost");
 
-                        additionalUrl = new ResourceUrlAnnotation
+                        // Make the existing localhost URL the additional URL so it's not the primary endpoint URL shown in the dashboard or targeted by `WithUrlForEndpoint` calls.
+                        additionalUrl = url;
+                        additionalUrl.DisplayLocation = UrlDisplayLocation.DetailsOnly;
+
+                        // Create the new primary URL using the *.dev.localhost pattern.
+                        url = new ResourceUrlAnnotation
                         {
                             // <scheme>://<resource-name>-<subdomain-suffix>.dev.localhost:<port>
                             Url = $"{allocatedEndpoint.UriScheme}://{resource.Name.ToLowerInvariant()}-{subdomainSuffix}.dev.localhost:{allocatedEndpoint.Port}",
                             Endpoint = endpointReference,
                             DisplayLocation = UrlDisplayLocation.SummaryAndDetails
                         };
-                        url.DisplayLocation = UrlDisplayLocation.DetailsOnly;
 
                         static string TrimSuffix(string value, string suffix)
                         {

tests/Aspire.Hosting.Tests/WithEndpointTests.cs

@@ -637,8 +637,8 @@ public async Task LocalhostTopLevelDomainSetsAnnotationValues()
 
         var urls = projectA.Resource.Annotations.OfType<ResourceUrlAnnotation>();
         Assert.Collection(urls,
-            url => Assert.StartsWith("https://localhost:", url.Url),
-            url => Assert.StartsWith("https://example.localhost:", url.Url));
+            url => Assert.StartsWith("https://example.localhost:", url.Url),
+            url => Assert.StartsWith("https://localhost:", url.Url));
 
         EndpointAnnotation endpoint = Assert.Single(projectA.Resource.Annotations.OfType<EndpointAnnotation>());
         Assert.NotNull(endpoint.AllocatedEndpoint);

tests/Aspire.Hosting.Tests/WithUrlsTests.cs

@@ -250,6 +250,7 @@ public async Task EndpointsGetDevLocalhostUrlsWhenDashboardHasDevLocalhostUrl(st
         var tcs = new TaskCompletionSource();
         var projectB = builder.AddProject<ProjectB>("projectb")
             .WithEndpoint(scheme: "tcp")
+            .WithUrlForEndpoint("http", u => u.DisplayText = "Custom Display Text")
             .OnBeforeResourceStarted((_, _, _) =>
             {
                 tcs.SetResult();
@@ -261,13 +262,27 @@ public async Task EndpointsGetDevLocalhostUrlsWhenDashboardHasDevLocalhostUrl(st
         await tcs.Task.DefaultTimeout();
 
         var urls = projectB.Resource.Annotations.OfType<ResourceUrlAnnotation>();
-        Assert.Equal(3, urls.Count());
-        Assert.Single(urls, u => u.Url.StartsWith("http://localhost") && u.Endpoint?.EndpointName == "http" && u.DisplayLocation == UrlDisplayLocation.DetailsOnly);
-        Assert.Single(urls, u => u.Url.StartsWith($"http://{projectB.Resource.Name.ToLowerInvariant()}{expectedHostSuffix}") && u.Url.EndsWith("/sub-path")
-                                 && u.Endpoint?.EndpointName == "http" && u.DisplayLocation == UrlDisplayLocation.SummaryAndDetails);
-
-        Assert.Single(urls, u => u.Url.StartsWith("tcp://localhost") && u.Endpoint?.EndpointName == "tcp");
-        Assert.DoesNotContain(urls, u => u.Url.Contains(expectedHostSuffix) && u.Endpoint?.EndpointName == "tcp");
+        Assert.Collection(urls,
+            u =>
+            {
+                Assert.StartsWith($"http://{projectB.Resource.Name.ToLowerInvariant()}{expectedHostSuffix}", u.Url);
+                Assert.EndsWith("/sub-path", u.Url);
+                Assert.Equal("http", u.Endpoint?.EndpointName);
+                Assert.Equal(UrlDisplayLocation.SummaryAndDetails, u.DisplayLocation);
+                Assert.Equal("Custom Display Text", u.DisplayText);
+            },
+            u =>
+            {
+                Assert.StartsWith("http://localhost", u.Url);
+                Assert.Equal("http", u.Endpoint?.EndpointName);
+                Assert.Equal(UrlDisplayLocation.DetailsOnly, u.DisplayLocation);
+            },
+            u =>
+            {
+                Assert.StartsWith("tcp://localhost", u.Url);
+                Assert.Equal("tcp", u.Endpoint?.EndpointName);
+            }
+        );
 
         await app.StopAsync();
     }