Fix aspire run failing when DisableDashboard is true#16773
Merged
Conversation
When DisableDashboard = true, aspire run would exit with a DashboardFailure error while aspire start succeeded. Two changes: 1. AppHostRpcTarget: Return DashboardUrlsState with DashboardHealthy=false instead of throwing InvalidOperationException when the dashboard is disabled. 2. RunCommand: Treat an unhealthy dashboard as a warning instead of a fatal error, allowing the app host to continue running without the dashboard. Fixes #16619
JamesNK
requested review from
danegsta,
davidfowl,
karolz-ms and
mitchdenny
as code owners
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 16773Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 16773" |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes an inconsistency where aspire run failed when an AppHost disables the dashboard (DisableDashboard = true), while aspire start succeeded. It adjusts both the AppHost backchannel behavior and the CLI’s handling so running without a dashboard is treated as a supported configuration.
Changes:
- AppHost backchannel now returns an unhealthy
DashboardUrlsState(instead of throwing) when the dashboard is disabled. aspire runno longer treats an unhealthy dashboard as fatal; it emits a warning and continues, showing “N/A” for the dashboard URL.- Updated CLI string resources and adjusted the related unit test to expect success.
Reviewed changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/Aspire.Cli.Tests/Commands/RunCommandTests.cs | Updates test to validate run succeeds when the dashboard is unhealthy/disabled. |
| src/Aspire.Hosting/Backchannel/AppHostRpcTarget.cs | Returns DashboardUrlsState with DashboardHealthy=false instead of throwing when dashboard is disabled. |
| src/Aspire.Cli/Commands/RunCommand.cs | Downgrades unhealthy dashboard from fatal error/exit code to a warning and continues. |
| src/Aspire.Cli/Resources/RunCommandStrings.resx | Updates the user-facing message to include the “disabled” case. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.zh-Hant.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.zh-Hans.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.tr.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.ru.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.pt-BR.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.pl.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.ko.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.ja.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.it.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.fr.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.es.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.de.xlf | Updates localized source string; marks translation for review. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.cs.xlf | Updates localized source string; marks translation for review. |
adamint
approved these changes
May 5, 2026
Member
Author
|
…sert warning in test
Contributor
|
🎬 CLI E2E Test Recordings — 77 recordings uploaded (commit View all recordings
📹 Recordings uploaded automatically from CI run #25421239338 |
Contributor
|
No documentation PR is required for this change. This PR is a bug fix that corrects an inconsistency where
|
This was referenced May 12, 2026
nellshamrell
pushed a commit
to nellshamrell/aspire
that referenced
this pull request
May 18, 2026
Contributor
|
@adamint we should verify this in the extension. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
When
DisableDashboard = trueis set in an app host,aspire runwould fail with aDashboardFailureexit code whileaspire startsucceeded. This PR fixes the inconsistency so both commands work when the dashboard is disabled.Two changes:
src/Aspire.Hosting): ReturnDashboardUrlsStatewithDashboardHealthy = falseinstead of throwingInvalidOperationExceptionwhen the dashboard is disabled. Also downgraded the log level fromErrortoDebugsince this is an expected configuration.src/Aspire.Cli): Treat an unhealthy dashboard as a warning instead of a fatal error, allowing the app host to continue running without the dashboard. The dashboard URL shows as "N/A" in the summary output.Fixes #16619
Checklist