Fix CLI cancellation disposal race on shutdown#17179
Merged
Merged
Conversation
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 17179Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 17179" |
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes an Aspire CLI shutdown race where Ctrl+C/SIGTERM callbacks can attempt to cancel a CancellationTokenSource after it has been disposed, causing ObjectDisposedException during teardown.
Changes:
- Switches Ctrl+C and SIGTERM handling to use removable handlers and a shared
TryCancelhelper. - Guards late-signal cancellation with an
ObjectDisposedExceptioncatch to avoid process-aborting crashes. - Explicitly unregisters signal handlers and disposes signal registrations/CTS during shutdown.
danegsta
approved these changes
May 16, 2026
Ctrl+C/SIGTERM handlers and CancellationTokenSource were only cleaned up in a finally block after command invocation. If BuildApplicationAsync or StartAsync failed, the early catch returned without reaching that finally, leaking the handlers. Introduce ConsoleCancellationManager (IDisposable) that encapsulates signal registration and CTS lifetime. A using declaration at the top of Main guarantees cleanup on all exit paths. The CancellationToken is captured at construction so it remains usable after disposal.
Contributor
|
Re-running the failed jobs in the CI workflow for this pull request because 1 job was identified as retry-safe transient failures in the CI run attempt.
Matched test failure patterns (1 test)
|
Contributor
|
❌ CLI E2E Tests failed — 84 passed, 1 failed, 1 unknown (commit Failed Tests
View all recordings
📹 Recordings uploaded automatically from CI run #25975341405 |
Contributor
|
✅ No documentation update needed. docs_required → already documented by name Triggered signals (1): Evidence: The signal fired on
The PR itself ( |
6 tasks
nellshamrell
pushed a commit
to nellshamrell/aspire
that referenced
this pull request
May 18, 2026
This was referenced May 18, 2026
1 task
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
Fixes a shutdown race in the Aspire CLI where signal callbacks can call
CancellationTokenSource.Cancel()after the source is disposed, causing:System.ObjectDisposedException: The CancellationTokenSource has been disposed.For example: #17141 (comment)
The change in src/Aspire.Cli/Program.cs updates startup cancellation wiring to:
ObjectDisposedExceptionin that helper for late-signal races.This keeps shutdown cancellation behavior intact while preventing process aborts from late signal delivery during teardown.
Validation run:
dotnet test --project .\tests\Aspire.Cli.Tests\Aspire.Cli.Tests.csproj --no-launch-profile -- --filter-not-trait "quarantined=true" --filter-not-trait "outerloop=true"(passed: 3073, skipped: 12)dotnet test --project .\tests\Aspire.Cli.EndToEnd.Tests\Aspire.Cli.EndToEnd.Tests.csproj --no-launch-profile -- --filter-not-trait "quarantined=true" --filter-not-trait "outerloop=true"(failed in local environment because Docker daemon pipe//./pipe/dockerDesktopLinuxEnginewas unavailable)Fixes # (issue)
Checklist
<remarks />and<code />elements on your triple slash comments?