Use KnownConfigNames for resource service endpoint URL with legacy fallback#17385
Conversation
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 17385Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 17385" |
There was a problem hiding this comment.
Pull request overview
This PR aligns the dashboard resource service endpoint configuration with the centralized KnownConfigNames constants by preferring KnownConfigNames.ResourceServiceEndpointUrl (ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL) while still supporting the legacy KnownConfigNames.Legacy.ResourceServiceEndpointUrl (DOTNET_RESOURCE_SERVICE_ENDPOINT_URL), and updates related documentation.
Changes:
- Updated
DashboardServiceHostto read the resource service endpoint URL from the new config name with a legacy fallback. - Updated
DashboardClientXML docs to reference the new environment variable name.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/Aspire.Hosting/Dashboard/DashboardServiceHost.cs | Switches env var lookup to KnownConfigNames.* with legacy fallback for the resource service endpoint URL. |
| src/Aspire.Dashboard/ServiceClient/DashboardClient.cs | Updates XML documentation to reference the new env var name. |
…llback Remove hardcoded DOTNET_RESOURCE_SERVICE_ENDPOINT_URL constant from DashboardServiceHost and use KnownConfigNames.ResourceServiceEndpointUrl (ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL) with fallback to KnownConfigNames.Legacy.ResourceServiceEndpointUrl.
9c918ae to
9ff622a
Compare
|
/backport to release/13.4 |
|
Started backporting to |
|
✅ No documentation update needed. docs_optional → bug_fix_restores_documented_behavior No triggered signals ( |
|
❌ CLI E2E Tests failed — 106 passed, 1 failed, 2 unknown (commit ❌ Failed Tests
View all recordings
📹 Recordings uploaded automatically from CI run #26546664612 |
Summary
Remove the hardcoded
DOTNET_RESOURCE_SERVICE_ENDPOINT_URLconstant fromDashboardServiceHostand useKnownConfigNames.ResourceServiceEndpointUrl(ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL) with fallback toKnownConfigNames.Legacy.ResourceServiceEndpointUrl(DOTNET_RESOURCE_SERVICE_ENDPOINT_URL).Changes
ResourceServiceUrlVariableNameprivate const. UpdatedConfigureKestrelto prefer the new config name and fall back to the legacy name, matching the pattern used elsewhere in the codebase.