Skip to content

Order endpoints in resource details #4798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JamesNK merged 3 commits into from
Jul 15, 2024
Merged

Order endpoints in resource details #4798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed67ef8
Order endpoints in resource details
JamesNK Jul 5, 2024
3e83061
Update
JamesNK Jul 5, 2024
fb5de07
Update
JamesNK Jul 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions src/Aspire.Dashboard/Components/Pages/Resources.razor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,17 +363,6 @@ private List<DisplayedEndpoint> GetDisplayedEndpoints(ResourceViewModel resource

additionalMessage = null;

// Make sure that endpoints have a consistent ordering. Show https first, then everything else.
return [.. GetEndpoints(resource)
.OrderByDescending(e => e.Url?.StartsWith("https") == true)
.ThenBy(e=> e.Url ?? e.Text)];
}

/// <summary>
/// A resource has services and endpoints. These can overlap. This method attempts to return a single list without duplicates.
/// </summary>
private static List<DisplayedEndpoint> GetEndpoints(ResourceViewModel resource)
{
return ResourceEndpointHelpers.GetEndpoints(resource, includeInteralUrls: false);
}

Expand Down
13 changes: 12 additions & 1 deletion src/Aspire.Dashboard/Model/ResourceEndpointHelpers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,18 @@ public static List<DisplayedEndpoint> GetEndpoints(ResourceViewModel resource, b
}
}

return endpoints;
// Make sure that endpoints have a consistent ordering.
// Order:
// - https
// - other urls
// - endpoint name
var orderedEndpoints = endpoints
.OrderByDescending(e => e.Url?.StartsWith("https") == true)
.ThenByDescending(e => e.Url != null)
.ThenBy(e => e.Name, StringComparers.EndpointAnnotationName)
.ToList();

return orderedEndpoints;
}
}

Expand Down
19 changes: 19 additions & 0 deletions tests/Aspire.Dashboard.Tests/Model/ResourceEndpointHelpersTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,25 @@ public void GetEndpoints_IncludesIncludeInternalUrls()
});
}

[Fact]
public void GetEndpoints_OrderByName()
{
var endpoints = GetEndpoints(CreateResource([
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)
]));

Assert.Collection(endpoints,
e => Assert.Equal("Z", e.Name),
e => Assert.Equal("a", e.Name),
e => Assert.Equal("C", e.Name),
e => Assert.Equal("B", e.Name),
e => Assert.Equal("D", e.Name));
}

private static ResourceViewModel CreateResource(ImmutableArray<UrlViewModel> urls)
{
return new ResourceViewModel
Expand Down