diff --git a/playground/TestShop/TestShop.AppHost/Program.cs b/playground/TestShop/TestShop.AppHost/Program.cs index cc48c60dac..5a450b4706 100644 --- a/playground/TestShop/TestShop.AppHost/Program.cs +++ b/playground/TestShop/TestShop.AppHost/Program.cs @@ -2,7 +2,10 @@ var catalogDb = builder.AddPostgres("postgres") .WithDataVolume() - .WithPgAdmin() + .WithPgAdmin(resource => + { + resource.WithEndpoint("http", e => e.DisplayProperties.DisplayName = "PG Admin"); + }) .AddDatabase("catalogdb"); var basketCache = builder.AddRedis("basketcache") @@ -12,10 +15,12 @@ basketCache.WithRedisCommander(c => { c.WithHostPort(33801); + c.WithEndpoint("http", e => e.DisplayProperties.DisplayName = "Redis Commander"); }) .WithRedisInsight(c => { c.WithHostPort(33802); + c.WithEndpoint("http", e => e.DisplayProperties.DisplayName = "Redis Insight"); }); #endif @@ -38,6 +43,8 @@ builder.AddProject("frontend") .WithExternalHttpEndpoints() + .WithEndpoint("http", c => c.DisplayProperties.DisplayName = $"TestShop UI ({c.UriScheme})") + .WithEndpoint("https", c => c.DisplayProperties.DisplayName = $"TestShop UI ({c.UriScheme})") .WithReference(basketService) .WithReference(catalogService); diff --git a/src/Aspire.Dashboard/Components/Controls/ResourceDetails.razor b/src/Aspire.Dashboard/Components/Controls/ResourceDetails.razor index 57e4401fc7..6e4f9c564d 100644 --- a/src/Aspire.Dashboard/Components/Controls/ResourceDetails.razor +++ b/src/Aspire.Dashboard/Components/Controls/ResourceDetails.razor @@ -63,14 +63,47 @@ @FilteredEndpoints.Count() - + + @{ + var hasAnyEndpointDisplayNames = FilteredEndpoints.Any(e => !string.IsNullOrEmpty(e.DisplayName)); + } + + + + + + @if (hasAnyEndpointDisplayNames) + { + + + + } + + + + @if (Resource.IsContainer()) { diff --git a/src/Aspire.Dashboard/Model/ResourceEndpointHelpers.cs b/src/Aspire.Dashboard/Model/ResourceEndpointHelpers.cs index e90fc788c5..76e6e3ebc6 100644 --- a/src/Aspire.Dashboard/Model/ResourceEndpointHelpers.cs +++ b/src/Aspire.Dashboard/Model/ResourceEndpointHelpers.cs @@ -22,10 +22,13 @@ public static List GetEndpoints(ResourceViewModel resource, b endpoints.Add(new DisplayedEndpoint { Name = url.Name, - Text = url.Url.OriginalString, Address = url.Url.Host, Port = url.Url.Port, - Url = url.Url.Scheme is "http" or "https" ? url.Url.OriginalString : null + Url = url.Url.Scheme is "http" or "https" ? url.Url.OriginalString : null, + SortOrder = url.DisplayProperties.SortOrder, + DisplayName = url.DisplayProperties.DisplayName, + OriginalUrlString = url.Url.OriginalString, + Text = string.IsNullOrEmpty(url.DisplayProperties.DisplayName) ? url.Url.OriginalString : url.DisplayProperties.DisplayName }); } } @@ -36,7 +39,8 @@ public static List GetEndpoints(ResourceViewModel resource, b // - other urls // - endpoint name var orderedEndpoints = endpoints - .OrderByDescending(e => e.Url?.StartsWith("https") == true) + .OrderByDescending(e => e.SortOrder) + .ThenByDescending(e => e.Url?.StartsWith("https") == true) .ThenByDescending(e => e.Url != null) .ThenBy(e => e.Name, StringComparers.EndpointAnnotationName) .ToList(); @@ -45,7 +49,7 @@ public static List GetEndpoints(ResourceViewModel resource, b } } -[DebuggerDisplay("Name = {Name}, Text = {Text}, Address = {Address}:{Port}, Url = {Url}")] +[DebuggerDisplay("Name = {Name}, Text = {Text}, Address = {Address}:{Port}, Url = {Url}, DisplayName = {DisplayName}, OriginalUrlString = {OriginalUrlString}, SortOrder = {SortOrder}")] public sealed class DisplayedEndpoint : IPropertyGridItem { public required string Name { get; set; } @@ -53,6 +57,9 @@ public sealed class DisplayedEndpoint : IPropertyGridItem public string? Address { get; set; } public int? Port { get; set; } public string? Url { get; set; } + public int SortOrder { get; set; } + public required string DisplayName { get; set; } + public required string OriginalUrlString { get; set; } /// /// Don't display a plain string value here. The URL will be displayed as a hyperlink diff --git a/src/Aspire.Dashboard/Model/ResourceViewModel.cs b/src/Aspire.Dashboard/Model/ResourceViewModel.cs index 0ce9ddf136..9d87dc89a5 100644 --- a/src/Aspire.Dashboard/Model/ResourceViewModel.cs +++ b/src/Aspire.Dashboard/Model/ResourceViewModel.cs @@ -324,18 +324,26 @@ public sealed class UrlViewModel public string Name { get; } public Uri Url { get; } public bool IsInternal { get; } + public UrlDisplayPropertiesViewModel DisplayProperties { get; } - public UrlViewModel(string name, Uri url, bool isInternal) + public UrlViewModel(string name, Uri url, bool isInternal, UrlDisplayPropertiesViewModel displayProperties) { ArgumentException.ThrowIfNullOrWhiteSpace(name); ArgumentNullException.ThrowIfNull(url); + ArgumentNullException.ThrowIfNull(displayProperties); Name = name; Url = url; IsInternal = isInternal; + DisplayProperties = displayProperties; } } +public record UrlDisplayPropertiesViewModel(string DisplayName, int SortOrder) +{ + public static readonly UrlDisplayPropertiesViewModel Empty = new(string.Empty, 0); +} + public sealed record class VolumeViewModel(int index, string Source, string Target, string MountType, bool IsReadOnly) : IPropertyGridItem { string IPropertyGridItem.Name => Source; diff --git a/src/Aspire.Dashboard/ResourceService/Partials.cs b/src/Aspire.Dashboard/ResourceService/Partials.cs index 8ec7e2c22c..d6faa80d9e 100644 --- a/src/Aspire.Dashboard/ResourceService/Partials.cs +++ b/src/Aspire.Dashboard/ResourceService/Partials.cs @@ -95,7 +95,7 @@ ImmutableArray GetUrls() return (from u in Urls let parsedUri = Uri.TryCreate(u.FullUrl, UriKind.Absolute, out var uri) ? uri : null where parsedUri != null - select new UrlViewModel(u.Name, parsedUri, u.IsInternal)) + select new UrlViewModel(u.Name, parsedUri, u.IsInternal,new UrlDisplayPropertiesViewModel(u.DisplayProperties.DisplayName, u.DisplayProperties.SortOrder))) .ToImmutableArray(); } diff --git a/src/Aspire.Dashboard/Resources/ControlsStrings.Designer.cs b/src/Aspire.Dashboard/Resources/ControlsStrings.Designer.cs index e6641c6439..b750af9943 100644 --- a/src/Aspire.Dashboard/Resources/ControlsStrings.Designer.cs +++ b/src/Aspire.Dashboard/Resources/ControlsStrings.Designer.cs @@ -230,6 +230,15 @@ public static string DetailsColumnHeader { } } + /// + /// Looks up a localized string similar to Display name. + /// + public static string DisplayNameColumnHeader { + get { + return ResourceManager.GetString("DisplayNameColumnHeader", resourceCulture); + } + } + /// /// Looks up a localized string similar to Duration. /// diff --git a/src/Aspire.Dashboard/Resources/ControlsStrings.resx b/src/Aspire.Dashboard/Resources/ControlsStrings.resx index 2ab34386f7..01daba50e2 100644 --- a/src/Aspire.Dashboard/Resources/ControlsStrings.resx +++ b/src/Aspire.Dashboard/Resources/ControlsStrings.resx @@ -181,6 +181,9 @@ Name + + Display name + Value @@ -437,4 +440,4 @@ Remove for resource - \ No newline at end of file + diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.cs.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.cs.xlf index d374ef04f8..b55a571e42 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.cs.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.cs.xlf @@ -97,6 +97,11 @@ Podrobnosti + + Display name + Display name + + Duration Doba trvání diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.de.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.de.xlf index de11b75f4a..980a7e19e7 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.de.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.de.xlf @@ -97,6 +97,11 @@ Details + + Display name + Display name + + Duration Dauer diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.es.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.es.xlf index 361186ba3a..1085d9bc4a 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.es.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.es.xlf @@ -97,6 +97,11 @@ Detalles + + Display name + Display name + + Duration Duración diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.fr.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.fr.xlf index 744fa0c273..001ecc49ce 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.fr.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.fr.xlf @@ -97,6 +97,11 @@ Détails + + Display name + Display name + + Duration Durée diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.it.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.it.xlf index e25d40bbed..169575e40b 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.it.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.it.xlf @@ -97,6 +97,11 @@ Dettagli + + Display name + Display name + + Duration Durata diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ja.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ja.xlf index e9d0b0df37..973e42f377 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ja.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ja.xlf @@ -97,6 +97,11 @@ 詳細 + + Display name + Display name + + Duration 継続時間 diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ko.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ko.xlf index 3f666fd51d..d78fd0c66a 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ko.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ko.xlf @@ -97,6 +97,11 @@ 세부 정보 + + Display name + Display name + + Duration 기간 diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.pl.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.pl.xlf index 9555a49b59..15f54e96ec 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.pl.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.pl.xlf @@ -97,6 +97,11 @@ Szczegóły + + Display name + Display name + + Duration Czas trwania diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.pt-BR.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.pt-BR.xlf index c54dd80b96..46ad7c85a9 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.pt-BR.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.pt-BR.xlf @@ -97,6 +97,11 @@ Detalhes + + Display name + Display name + + Duration Duração diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ru.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ru.xlf index 5eacb42082..3a6e51d312 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ru.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.ru.xlf @@ -97,6 +97,11 @@ Сведения + + Display name + Display name + + Duration Длительность diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.tr.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.tr.xlf index 9d24d82c4d..db9d812b7d 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.tr.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.tr.xlf @@ -97,6 +97,11 @@ Ayrıntılar + + Display name + Display name + + Duration Süre diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.zh-Hans.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.zh-Hans.xlf index 837147645e..e28aea1e0f 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.zh-Hans.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.zh-Hans.xlf @@ -97,6 +97,11 @@ 详细信息 + + Display name + Display name + + Duration 持续时间 diff --git a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.zh-Hant.xlf b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.zh-Hant.xlf index 127860d847..a90f548fcf 100644 --- a/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.zh-Hant.xlf +++ b/src/Aspire.Dashboard/Resources/xlf/ControlsStrings.zh-Hant.xlf @@ -97,6 +97,11 @@ 詳細資料 + + Display name + Display name + + Duration 持續時間 diff --git a/src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs b/src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs index ad1b2264be..f04980c831 100644 --- a/src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs +++ b/src/Aspire.Hosting.Azure.CosmosDB/AzureCosmosDBExtensions.cs @@ -288,10 +288,11 @@ public static IResourceBuilder WithDataExplorer(t endpoint.UriScheme = "http"; endpoint.TargetPort = 1234; endpoint.Port = port; + endpoint.DisplayProperties = new EndpointDisplayProperties { DisplayName = "Data Explorer" }; }); } - /// + /// /// Configures the resource to use access key authentication with Azure Cosmos DB. /// /// The Azure Cosmos DB resource builder. diff --git a/src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs b/src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs index 6fe33caaa6..dfb51db8e6 100644 --- a/src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs +++ b/src/Aspire.Hosting/ApplicationModel/CustomResourceSnapshot.cs @@ -178,7 +178,20 @@ public sealed record EnvironmentVariableSnapshot(string Name, string? Value, boo /// The full uri. /// Determines if this url is internal. [DebuggerDisplay("{Url}", Name = "{Name}")] -public sealed record UrlSnapshot(string Name, string Url, bool IsInternal); +public sealed record UrlSnapshot(string Name, string Url, bool IsInternal) +{ + /// + /// The UI display properties for the url. + /// + public UrlDisplayPropertiesSnapshot DisplayProperties { get; init; } = new(); +} + +/// +/// A snapshot of the display properties for a url. +/// +/// The display name of the url. +/// The order of the url in UI. Higher numbers are displayed first in the UI. +public sealed record UrlDisplayPropertiesSnapshot(string DisplayName = "", int SortOrder = 0); /// /// A snapshot of a volume, mounted to a container. diff --git a/src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs b/src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs index 2879fde892..e1ded6fd00 100644 --- a/src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs +++ b/src/Aspire.Hosting/ApplicationModel/EndpointAnnotation.cs @@ -51,6 +51,7 @@ public EndpointAnnotation(ProtocolType protocol, string? uriScheme = null, strin _targetPort = targetPort; IsExternal = isExternal ?? false; IsProxied = isProxied; + DisplayProperties = new EndpointDisplayProperties(); } /// @@ -131,6 +132,11 @@ public string Transport /// Defaults to true. public bool IsProxied { get; set; } = true; + /// + /// Display properties of the endpoint to be displayed in UI. + /// + public EndpointDisplayProperties DisplayProperties { get; set; } + /// /// Gets or sets a value indicating whether the endpoint is from a launch profile. /// diff --git a/src/Aspire.Hosting/ApplicationModel/EndpointDisplayProperties.cs b/src/Aspire.Hosting/ApplicationModel/EndpointDisplayProperties.cs new file mode 100644 index 0000000000..b755da9203 --- /dev/null +++ b/src/Aspire.Hosting/ApplicationModel/EndpointDisplayProperties.cs @@ -0,0 +1,21 @@ +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +namespace Aspire.Hosting.ApplicationModel; + +/// +/// Display properties of the endpoint to be displayed in UI. +/// +public sealed class EndpointDisplayProperties +{ + /// + /// Display name of the endpoint, to be displayed in the Aspire Dashboard. An empty display name will default to the endpoint name. + /// + public string DisplayName { get; set; } = string.Empty; + + /// + /// Integer to control visual ordering of endpoints in the Aspire Dashboard. Higher values are displayed first. + /// Ties are broken by protocol type first (https before others), then by endpoint name. + /// + public int SortOrder { get; set; } +} diff --git a/src/Aspire.Hosting/ApplicationModel/EndpointReference.cs b/src/Aspire.Hosting/ApplicationModel/EndpointReference.cs index a0de3a8eb8..c6d99ee181 100644 --- a/src/Aspire.Hosting/ApplicationModel/EndpointReference.cs +++ b/src/Aspire.Hosting/ApplicationModel/EndpointReference.cs @@ -101,6 +101,11 @@ public EndpointReferenceExpression Property(EndpointProperty property) /// public string Url => AllocatedEndpoint.UriString; + /// + /// Gets the display properties for this endpoint. + /// + public EndpointDisplayProperties DisplayProperties => EndpointAnnotation.DisplayProperties; + internal AllocatedEndpoint AllocatedEndpoint => GetAllocatedEndpoint() ?? throw new InvalidOperationException($"The endpoint `{EndpointName}` is not allocated for the resource `{Resource.Name}`."); diff --git a/src/Aspire.Hosting/Dashboard/proto/Partials.cs b/src/Aspire.Hosting/Dashboard/proto/Partials.cs index 6b067c8a41..034a037325 100644 --- a/src/Aspire.Hosting/Dashboard/proto/Partials.cs +++ b/src/Aspire.Hosting/Dashboard/proto/Partials.cs @@ -40,9 +40,22 @@ public static Resource FromSnapshot(ResourceSnapshot snapshot) resource.Environment.Add(new EnvironmentVariable { Name = env.Name, Value = env.Value ?? "", IsFromSpec = env.IsFromSpec }); } - foreach (var url in snapshot.Urls) + foreach (var urlSnapshot in snapshot.Urls) { - resource.Urls.Add(new Url { Name = url.Name, FullUrl = url.Url, IsInternal = url.IsInternal }); + var url = new Url { Name = urlSnapshot.Name, FullUrl = urlSnapshot.Url, IsInternal = urlSnapshot.IsInternal }; + var displayProperties = new UrlDisplayProperties(); + if (urlSnapshot.DisplayProperties?.DisplayName is not null) + { + displayProperties.DisplayName = urlSnapshot.DisplayProperties.DisplayName; + } + + if (urlSnapshot.DisplayProperties?.SortOrder is not null) + { + displayProperties.SortOrder = urlSnapshot.DisplayProperties.SortOrder; + } + + url.DisplayProperties = displayProperties; + resource.Urls.Add(url); } foreach (var relationship in snapshot.Relationships) diff --git a/src/Aspire.Hosting/Dashboard/proto/resource_service.proto b/src/Aspire.Hosting/Dashboard/proto/resource_service.proto index 2010afe742..090948cfd7 100644 --- a/src/Aspire.Hosting/Dashboard/proto/resource_service.proto +++ b/src/Aspire.Hosting/Dashboard/proto/resource_service.proto @@ -131,6 +131,15 @@ message Url { // Determines if this url shows up in the details view only by default. // If true, the url will not be shown in the list of urls in the top level resources view. bool is_internal = 3; + // Display properties of the Url + UrlDisplayProperties display_properties = 4; +} + +message UrlDisplayProperties { + // The sort order of the url. Lower values are displayed first in the UI. The absence of a value is treated as lowest order. + int32 sort_order = 1; + // The display name of the url, to appear in the UI. + string display_name = 2; } // Data about a volume mounted to a container. diff --git a/src/Aspire.Hosting/Dcp/ResourceSnapshotBuilder.cs b/src/Aspire.Hosting/Dcp/ResourceSnapshotBuilder.cs index 1730503d66..46ece4b625 100644 --- a/src/Aspire.Hosting/Dcp/ResourceSnapshotBuilder.cs +++ b/src/Aspire.Hosting/Dcp/ResourceSnapshotBuilder.cs @@ -236,21 +236,21 @@ string CombineUrls(string url, string launchUrl) { var url = CombineUrls(ep.Url, launchUrl); - urls.Add(new(Name: ep.EndpointName, Url: url, IsInternal: false)); + urls.Add(new(Name: ep.EndpointName, Url: url, IsInternal: false) { DisplayProperties = new(ep.DisplayProperties.DisplayName, ep.DisplayProperties.SortOrder)}); } } else { if (ep.IsAllocated) { - urls.Add(new(Name: ep.EndpointName, Url: ep.Url, IsInternal: false)); + urls.Add(new(Name: ep.EndpointName, Url: ep.Url, IsInternal: false) { DisplayProperties = new(ep.DisplayProperties.DisplayName, ep.DisplayProperties.SortOrder) }); } } if (ep.EndpointAnnotation.IsProxied) { var endpointString = $"{ep.Scheme}://{endpoint.Spec.Address}:{endpoint.Spec.Port}"; - urls.Add(new(Name: $"{ep.EndpointName} target port", Url: endpointString, IsInternal: true)); + urls.Add(new(Name: $"{ep.EndpointName} target port", Url: endpointString, IsInternal: true) { DisplayProperties = new(ep.DisplayProperties.DisplayName, ep.DisplayProperties.SortOrder) }); } } } diff --git a/src/Aspire.Hosting/ResourceBuilderExtensions.cs b/src/Aspire.Hosting/ResourceBuilderExtensions.cs index 67f189a916..40f86ac02f 100644 --- a/src/Aspire.Hosting/ResourceBuilderExtensions.cs +++ b/src/Aspire.Hosting/ResourceBuilderExtensions.cs @@ -1156,7 +1156,7 @@ public static IResourceBuilder WithRelationship( /// /// var builder = DistributedApplication.CreateBuilder(args); /// var backend = builder.AddProject<Projects.Backend>("backend"); - /// + /// /// var frontend = builder.AddProject<Projects.Manager>("frontend") /// .WithParentRelationship(backend.Resource); /// diff --git a/tests/Aspire.Dashboard.Tests/Model/ResourceEndpointHelpersTests.cs b/tests/Aspire.Dashboard.Tests/Model/ResourceEndpointHelpersTests.cs index d52d1356df..495a422532 100644 --- a/tests/Aspire.Dashboard.Tests/Model/ResourceEndpointHelpersTests.cs +++ b/tests/Aspire.Dashboard.Tests/Model/ResourceEndpointHelpersTests.cs @@ -25,7 +25,7 @@ public void GetEndpoints_Empty_NoResults() [Fact] public void GetEndpoints_HasServices_Results() { - var endpoints = GetEndpoints(ModelTestHelpers.CreateResource(urls: [new("Test", new("http://localhost:8080"), isInternal: false)])); + var endpoints = GetEndpoints(ModelTestHelpers.CreateResource(urls: [new("Test", new("http://localhost:8080"), isInternal: false, displayProperties: UrlDisplayPropertiesViewModel.Empty)])); Assert.Collection(endpoints, e => @@ -42,8 +42,8 @@ public void GetEndpoints_HasServices_Results() public void GetEndpoints_HasEndpointAndService_Results() { var endpoints = GetEndpoints(ModelTestHelpers.CreateResource(urls: [ - new("Test", new("http://localhost:8080"), isInternal: false), - new("Test2", new("http://localhost:8081"), isInternal: false)]) + new("Test", new("http://localhost:8080"), isInternal: false, displayProperties: UrlDisplayPropertiesViewModel.Empty), + new("Test2", new("http://localhost:8081"), isInternal: false, displayProperties: UrlDisplayPropertiesViewModel.Empty)]) ); Assert.Collection(endpoints, @@ -69,8 +69,8 @@ public void GetEndpoints_HasEndpointAndService_Results() public void GetEndpoints_OnlyHttpAndHttpsEndpointsSetTheUrl() { var endpoints = GetEndpoints(ModelTestHelpers.CreateResource(urls: [ - new("Test", new("http://localhost:8080"), isInternal: false), - new("Test2", new("tcp://localhost:8081"), isInternal: false)]) + new("Test", new("http://localhost:8080"), isInternal: false, displayProperties: UrlDisplayPropertiesViewModel.Empty), + new("Test2", new("tcp://localhost:8081"), isInternal: false, displayProperties: UrlDisplayPropertiesViewModel.Empty)]) ); Assert.Collection(endpoints, @@ -96,8 +96,8 @@ public void GetEndpoints_OnlyHttpAndHttpsEndpointsSetTheUrl() public void GetEndpoints_IncludeEndpointUrl_HasEndpointAndService_Results() { var endpoints = GetEndpoints(ModelTestHelpers.CreateResource(urls: [ - new("First", new("https://localhost:8080/test"), isInternal:false), - new("Test", new("https://localhost:8081/test2"), isInternal:false) + new("First", new("https://localhost:8080/test"), isInternal:false, displayProperties: UrlDisplayPropertiesViewModel.Empty), + new("Test", new("https://localhost:8081/test2"), isInternal:false, displayProperties: UrlDisplayPropertiesViewModel.Empty) ])); Assert.Collection(endpoints, @@ -123,8 +123,8 @@ public void GetEndpoints_IncludeEndpointUrl_HasEndpointAndService_Results() public void GetEndpoints_ExcludesIncludeInternalUrls() { var endpoints = GetEndpoints(ModelTestHelpers.CreateResource(urls: [ - new("First", new("https://localhost:8080/test"), isInternal:true), - new("Test", new("https://localhost:8081/test2"), isInternal:false) + new("First", new("https://localhost:8080/test"), isInternal:true, displayProperties: UrlDisplayPropertiesViewModel.Empty), + new("Test", new("https://localhost:8081/test2"), isInternal:false, displayProperties: UrlDisplayPropertiesViewModel.Empty) ])); Assert.Collection(endpoints, @@ -142,8 +142,8 @@ public void GetEndpoints_ExcludesIncludeInternalUrls() public void GetEndpoints_IncludesIncludeInternalUrls() { var endpoints = GetEndpoints(ModelTestHelpers.CreateResource(urls: [ - new("First", new("https://localhost:8080/test"), isInternal:true), - new("Test", new("https://localhost:8081/test2"), isInternal:false) + new("First", new("https://localhost:8080/test"), isInternal:true, displayProperties: UrlDisplayPropertiesViewModel.Empty), + new("Test", new("https://localhost:8081/test2"), isInternal:false, displayProperties: UrlDisplayPropertiesViewModel.Empty) ]), includeInternalUrls: true); @@ -170,11 +170,11 @@ public void GetEndpoints_IncludesIncludeInternalUrls() public void GetEndpoints_OrderByName() { var endpoints = GetEndpoints(ModelTestHelpers.CreateResource(urls: [ - new("a", new("http://localhost:8080"), isInternal: false), - new("C", new("http://localhost:8080"), isInternal: false), - new("D", new("tcp://localhost:8080"), isInternal: false), - new("B", new("tcp://localhost:8080"), isInternal: false), - new("Z", new("https://localhost:8080"), isInternal: false) + new("a", new("http://localhost:8080"), isInternal: false, displayProperties: UrlDisplayPropertiesViewModel.Empty), + new("C", new("http://localhost:8080"), isInternal: false, displayProperties: UrlDisplayPropertiesViewModel.Empty), + new("D", new("tcp://localhost:8080"), isInternal: false, displayProperties: UrlDisplayPropertiesViewModel.Empty), + new("B", new("tcp://localhost:8080"), isInternal: false, displayProperties: UrlDisplayPropertiesViewModel.Empty), + new("Z", new("https://localhost:8080"), isInternal: false, displayProperties: UrlDisplayPropertiesViewModel.Empty) ])); Assert.Collection(endpoints, @@ -184,4 +184,37 @@ public void GetEndpoints_OrderByName() e => Assert.Equal("B", e.Name), e => Assert.Equal("D", e.Name)); } + + [Fact] + public void GetEndpoints_SortOrder_Combinations() + { + var endpoints = GetEndpoints(ModelTestHelpers.CreateResource(urls: [ + new("Zero-Https", new("https://localhost:8079"), isInternal: false, displayProperties: new UrlDisplayPropertiesViewModel(string.Empty, 0)), + new("Zero-Http", new("http://localhost:8080"), isInternal: false, displayProperties: new UrlDisplayPropertiesViewModel(string.Empty, 0)), + new("Positive", new("http://localhost:8082"), isInternal: false, displayProperties: new UrlDisplayPropertiesViewModel(string.Empty, 1)), + new("Negative", new("http://localhost:8083"), isInternal: false, displayProperties: new UrlDisplayPropertiesViewModel(string.Empty, -1)) + ])); + + Assert.Collection(endpoints, + e => + { + Assert.Equal("Positive", e.Name); + Assert.Equal("http://localhost:8082", e.Url); + }, + e => + { + Assert.Equal("Zero-Https", e.Name); // tie broken by protocol (https) + Assert.Equal("https://localhost:8079", e.Url); + }, + e => + { + Assert.Equal("Zero-Http", e.Name); + Assert.Equal("http://localhost:8080", e.Url); + }, + e => + { + Assert.Equal("Negative", e.Name); + Assert.Equal("http://localhost:8083", e.Url); + }); + } } diff --git a/tests/Aspire.Dashboard.Tests/ResourceOutgoingPeerResolverTests.cs b/tests/Aspire.Dashboard.Tests/ResourceOutgoingPeerResolverTests.cs index 5509fa4209..8eba2d08f7 100644 --- a/tests/Aspire.Dashboard.Tests/ResourceOutgoingPeerResolverTests.cs +++ b/tests/Aspire.Dashboard.Tests/ResourceOutgoingPeerResolverTests.cs @@ -17,7 +17,7 @@ private static ResourceViewModel CreateResource(string name, string? serviceAddr return ModelTestHelpers.CreateResource( appName: name, displayName: displayName, - urls: serviceAddress is null || servicePort is null ? [] : [new UrlViewModel(name, new($"http://{serviceAddress}:{servicePort}"), isInternal: false)]); + urls: serviceAddress is null || servicePort is null ? [] : [new UrlViewModel(name, new($"http://{serviceAddress}:{servicePort}"), isInternal: false, displayProperties: UrlDisplayPropertiesViewModel.Empty)]); } [Fact]