Skip to content

Strip /login path from dashboard base URL in describe JSON output#15495

Open
JamesNK wants to merge 1 commit intorelease/13.2from
fix/describe-dashboard-url-trim
Open

Strip /login path from dashboard base URL in describe JSON output#15495
JamesNK wants to merge 1 commit intorelease/13.2from
fix/describe-dashboard-url-trim

Conversation

@JamesNK
Copy link
Member

@JamesNK JamesNK commented Mar 23, 2026

Description

The aspire describe --format json command was using BaseUrlWithLoginToken (e.g., http://localhost:18888/login?t=token) directly as the dashboard base URL when building per-resource dashboard URLs. DashboardUrls.CombineUrl simply concatenates strings, producing broken URLs like http://localhost:18888/login?t=token/?resource=redis.

This change reuses TelemetryCommandHelpers.ExtractDashboardBaseUrl (changed from private to internal) to strip the /login?t=... path before combining with resource URLs, producing correct URLs like http://localhost:18888/?resource=redis.

Two new integration tests verify the fix for both snapshot and follow/NDJSON JSON output modes.

Fixes #15171

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?
        • Yes
        • No
      • Did you add <remarks /> and <code /> elements on your triple slash comments?
        • Yes
        • No
    • No
  • Does the change make any security assumptions or guarantees?
    • Yes
      • If yes, have you done a threat model and had a security review?
        • Yes
        • No
    • No
  • Does the change require an update in our Aspire docs?

The describe command was passing BaseUrlWithLoginToken (e.g.,
http://localhost:18888/login?t=token) directly to the resource
snapshot mapper, producing broken dashboard URLs like
http://localhost:18888/login?t=token/?resource=redis.

Reuse TelemetryCommandHelpers.ExtractDashboardBaseUrl to strip the
/login?t=... path before combining with resource URLs.
Copilot AI review requested due to automatic review settings March 23, 2026 06:08
@github-actions
Copy link
Contributor

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 15495

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 15495"

@JamesNK JamesNK added Servicing-consider Issue for next servicing release review area-cli labels Mar 23, 2026
@JamesNK JamesNK requested a review from joperezr March 23, 2026 06:11
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes aspire describe --format json producing broken per-resource dashboardUrl values by stripping the /login?t=... portion from the dashboard URL before combining it with resource-specific paths.

Changes:

  • Reuse TelemetryCommandHelpers.ExtractDashboardBaseUrl (now internal) to derive a clean dashboard base URL in DescribeCommand.
  • Add integration tests covering both snapshot JSON output and --follow NDJSON output to verify correct dashboardUrl composition.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
tests/Aspire.Cli.Tests/Commands/DescribeCommandTests.cs Adds tests ensuring dashboard URLs in JSON/NDJSON output don’t include /login?t=... before resource URL composition.
src/Aspire.Cli/Commands/TelemetryCommandHelpers.cs Makes ExtractDashboardBaseUrl internal so it can be reused by other commands.
src/Aspire.Cli/Commands/DescribeCommand.cs Uses ExtractDashboardBaseUrl to avoid combining resource URLs onto /login?t=... dashboard URLs.

@github-actions
Copy link
Contributor

🎬 CLI E2E Test Recordings — 54 recordings uploaded (commit 8097992)

View recordings
Test Recording
AddPackageInteractiveWhileAppHostRunningDetached ▶️ View Recording
AddPackageWhileAppHostRunningDetached ▶️ View Recording
AgentCommands_AllHelpOutputs_AreCorrect ▶️ View Recording
AgentInitCommand_DefaultSelection_InstallsSkillOnly ▶️ View Recording
AgentInitCommand_MigratesDeprecatedConfig ▶️ View Recording
AspireAddPackageVersionToDirectoryPackagesProps ▶️ View Recording
AspireUpdateRemovesAppHostPackageVersionFromDirectoryPackagesProps ▶️ View Recording
Banner_DisplayedOnFirstRun ▶️ View Recording
Banner_DisplayedWithExplicitFlag ▶️ View Recording
CertificatesClean_RemovesCertificates ▶️ View Recording
CertificatesTrust_WithNoCert_CreatesAndTrustsCertificate ▶️ View Recording
CertificatesTrust_WithUntrustedCert_TrustsCertificate ▶️ View Recording
ConfigSetGet_CreatesNestedJsonFormat ▶️ View Recording
CreateAndDeployToDockerCompose ▶️ View Recording
CreateAndDeployToDockerComposeInteractive ▶️ View Recording
CreateAndPublishToKubernetes ▶️ View Recording
CreateAndRunAspireStarterProject ▶️ View Recording
CreateAndRunAspireStarterProjectWithBundle ▶️ View Recording
CreateAndRunEmptyAppHostProject ▶️ View Recording
CreateAndRunJsReactProject ▶️ View Recording
CreateAndRunPythonReactProject ▶️ View Recording
CreateAndRunTypeScriptEmptyAppHostProject ▶️ View Recording
CreateAndRunTypeScriptStarterProject ▶️ View Recording
CreateStartAndStopAspireProject ▶️ View Recording
CreateTypeScriptAppHostWithViteApp ▶️ View Recording
DescribeCommandResolvesReplicaNames ▶️ View Recording
DescribeCommandShowsRunningResources ▶️ View Recording
DetachFormatJsonProducesValidJson ▶️ View Recording
DoctorCommand_DetectsDeprecatedAgentConfig ▶️ View Recording
DoctorCommand_WithSslCertDir_ShowsTrusted ▶️ View Recording
DoctorCommand_WithoutSslCertDir_ShowsPartiallyTrusted ▶️ View Recording
GlobalMigration_HandlesCommentsAndTrailingCommas ▶️ View Recording
GlobalMigration_HandlesMalformedLegacyJson ▶️ View Recording
GlobalMigration_PreservesAllValueTypes ▶️ View Recording
GlobalMigration_SkipsWhenNewConfigExists ▶️ View Recording
GlobalSettings_MigratedFromLegacyFormat ▶️ View Recording
InvalidAppHostPathWithComments_IsHealedOnRun ▶️ View Recording
LegacySettingsMigration_AdjustsRelativeAppHostPath ▶️ View Recording
LogsCommandShowsResourceLogs ▶️ View Recording
PsCommandListsRunningAppHost ▶️ View Recording
PsFormatJsonOutputsOnlyJsonToStdout ▶️ View Recording
PublishWithDockerComposeServiceCallbackSucceeds ▶️ View Recording
RestoreGeneratesSdkFiles ▶️ View Recording
RunFromParentDirectory_UsesExistingConfigNearAppHost ▶️ View Recording
RunWithMissingAwaitShowsHelpfulError ▶️ View Recording
SecretCrudOnDotNetAppHost ▶️ View Recording
SecretCrudOnTypeScriptAppHost ▶️ View Recording
StagingChannel_ConfigureAndVerifySettings_ThenSwitchChannels ▶️ View Recording
StopAllAppHostsFromAppHostDirectory ▶️ View Recording
StopAllAppHostsFromUnrelatedDirectory ▶️ View Recording
StopNonInteractiveMultipleAppHostsShowsError ▶️ View Recording
StopNonInteractiveSingleAppHost ▶️ View Recording
StopWithNoRunningAppHostExitsSuccessfully ▶️ View Recording
TypeScriptAppHostWithProjectReferenceIntegration ▶️ View Recording

📹 Recordings uploaded automatically from CI run #23423898514

@joperezr
Copy link
Member

Likley a dumb question, but won't you also need the token for deep linking to work on browsers where the main dashboard hasn't authenticated yet? In that case, should the fix be just to make it send the two query params (with the right & instead of ?)

@adamint
Copy link
Member

adamint commented Mar 23, 2026

Likley a dumb question, but won't you also need the token for deep linking to work on browsers where the main dashboard hasn't authenticated yet? In that case, should the fix be just to make it send the two query params (with the right & instead of ?)

Correct, you would need the token - the operating assumption is that the user would already be logged in when navigating to these pages

@JamesNK
Copy link
Member Author

JamesNK commented Mar 23, 2026

Or you login after going to that page using the login screen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-cli Servicing-consider Issue for next servicing release review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants