Move error handling from Program.cs to BaseCommand SetAction delegate#17310
Open
JamesNK wants to merge 3 commits into
Open
Move error handling from Program.cs to BaseCommand SetAction delegate#17310JamesNK wants to merge 3 commits into
JamesNK wants to merge 3 commits into
Conversation
Move the OperationCanceledException and generic Exception catch blocks from Program.Main into the BaseCommand try/catch around ExecuteAsync. This centralizes error handling so all commands benefit from consistent cancellation and unexpected error behavior. Also suppress log file path display for cancelled commands by adding CliExitCodes.Cancelled to the suppression list.
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 17310Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 17310" |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors Aspire CLI error handling by moving cancellation (OperationCanceledException) and unexpected exception handling from Program.Main into the centralized BaseCommand action wrapper around ExecuteAsync, aiming for consistent behavior across commands.
Changes:
- Centralized handling of cancellation and unexpected exceptions in
BaseCommand, producing consistentCommandResult/exit codes. - Suppressed the “see logs at …” message for additional exit codes (now including
Cancelled). - Removed the corresponding catch blocks from
Program.Main.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Aspire.Cli/Commands/BaseCommand.cs | Adds centralized cancellation/unexpected-exception handling and expands suppression of the log-path message for certain exit codes. |
| src/Aspire.Cli/Program.cs | Removes OperationCanceledException and generic Exception handling from Main. |
IEvangelist
approved these changes
May 20, 2026
Member
IEvangelist
left a comment
IEvangelist
left a comment
There was a problem hiding this comment.
✅ PR Testing Complete — Approved
Dogfooded the PR build (13.4.0-pr.17310.gba7be86c, matches head ba7be86c) on Windows. Refactor works as intended and delivers a real user-visible improvement.
Scenarios
| # | Scenario | Result |
|---|---|---|
| 1 | Install + version verification | ✅ PASS |
| 2 | Regression: aspire --help, aspire new aspire-empty |
✅ PASS — exit 0, no See logs at hint |
| 3 | MissingRequiredArgument (exit 21) suppresses See logs at |
✅ PASS |
| 4 | Cancelled (exit 130) suppresses See logs at |
|
| 5 | Unexpected exception path: error displayed + See logs at shown |
✅ PASS — key behavioral improvement |
| Bonus | Normal failure (exit 7, FailedToFindProject) still shows See logs at |
✅ PASS |
Scenario 5 evidence (the key behavioral change)
aspire init --non-interactive in an empty dir triggered an unhandled exception that escapes ExecuteAsync. Output:
❌ An unexpected error occurred: This prompt requires interactive input but the CLI is running in non-interactive mode. This operation does not yet support non-interactive execution.
📄 See logs at C:\Users\…\.aspire\logs\cli_…log
Exit: 1
Pre-PR this would have been caught only by Program.Main's catch (Exception) and surfaced as a generic log entry with nothing useful on the console. Post-PR, the new generic catch in BaseCommand formats the message via InteractionServiceStrings.UnexpectedErrorOccurred, calls interactionService.DisplayError, records telemetry, returns Failure(InvalidCommand), and the post-execution path shows the See logs at hint. 👍
Scenario 3 evidence (suppression preserved)
❌ A template must be specified when running in non-interactive mode. Use 'aspire new <template>'.
Available values: aspire-starter, aspire-ts-cs-starter, aspire-ts-starter, aspire-py-starter, aspire-ts-empty, aspire-empty
Exit: 21
Exit 21, no See logs at hint — correctly suppressed.
Note on scenario 4 (Ctrl+C)
Empirical SIGINT delivery on Windows from non-interactive PowerShell automation is unreliable: child processes spawned with redirected stdin/out share the parent's console, so AttachConsole+GenerateConsoleCtrlEvent can't reach them. Behavior is symmetric with the verified MissingRequiredArgument suppression (same s_suppressErrorLogsMessageExitCodes array, same check) and the new BaseCommandTests plus this PR's manual testing (3345 tests passed) cover the path.
Conclusion
Small, well-scoped refactor with a real UX improvement. No regressions observed.
Contributor
|
❓ CLI E2E Tests unknown — 91 passed, 0 failed, 2 unknown (commit View all recordings
📹 Recordings uploaded automatically from CI run #26165336380 |
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
Move the
OperationCanceledExceptionand genericExceptioncatch blocks fromProgram.Maininto theBaseCommandtry/catch aroundExecuteAsync. This centralizes error handling so all commands benefit from consistent cancellation and unexpected error behavior.Changes
OperationCanceledException(when cancelled orExtensionOperationCanceledException) and genericExceptionto the existing try/catch aroundExecuteAsync. Also addedCliExitCodes.Cancelledto the exit codes that suppress the "see logs at" message since log files don't contain useful context for user-initiated cancellations.Main.Testing
Ran the full CLI test suite — 3345 passed, 3 failed (all pre-existing unrelated failures in
RemoteExecutortests), 12 skipped.