Fix banner crash when stdout is redirected#17443
Merged
Merged
Conversation
When --banner was explicitly passed, the condition bypassed the SupportsInteractiveOutput check. Spectre.Console's Live display then tried to set Console.CursorVisible on an invalid handle, throwing IOException. The fix ensures SupportsInteractiveOutput is always required for the animated banner, even when explicitly requested via --banner.
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 17443Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 17443" |
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes a CLI crash when --banner is used while stdout is redirected by ensuring the banner is only shown when ICliHostEnvironment.SupportsInteractiveOutput is true (the Spectre.Console Live banner requires valid console handles).
Changes:
- Updates the banner-display condition to always require
SupportsInteractiveOutput, even when--banneris explicitly passed. - Adjusts/extends unit tests to cover explicit
--bannerbehavior in non-interactive environments and to force an interactive host environment in tests that expect the banner.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Aspire.Cli/Program.cs | Tightens banner gating so animated banner only runs in interactive output environments. |
| tests/Aspire.Cli.Tests/Commands/RootCommandTests.cs | Updates tests to reflect the new interactive-output requirement for --banner and adds coverage for the redirected/non-interactive scenario. |
mitchdenny
approved these changes
May 24, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
|
❓ CLI E2E Tests unknown — 96 passed, 0 failed, 5 unknown (commit View all recordings
📹 Recordings uploaded automatically from CI run #26361816430 |
Contributor
|
✅ No documentation update needed. docs_required → already documented by name Triggered signal (1): The This PR is a bug fix: it ensures the animated banner is only shown when |
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
--bannerwas explicitly passed and stdout was redirected (e.g.,aspire --version --banner > test.txt), the CLI crashed withSystem.IO.IOException: The handle is invalidbecause Spectre.Console'sLivedisplay tried to setConsole.CursorVisibleon an invalid handle.The root cause was that the
showBannerflag bypassed theSupportsInteractiveOutputcheck in the OR condition. The fix ensuresSupportsInteractiveOutputis always required for the animated banner, even when explicitly requested via--banner.Fixes #17410
Checklist