Skip to content

Show restore diagnostics when aspire update fails - #22355

Merged
James Newton-King (JamesNK) merged 1 commit into
mainfrom
jamesnk/fix-update-restore-diagnostics
Nov 17, 2026
Merged

James Newton-King (JamesNK) merged 1 commit into
mainfrom
jamesnk/fix-update-restore-diagnostics

Conversation

@JamesNK

@JamesNK James Newton-King (JamesNK) commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

Description

When the post-update package restore fails, aspire update currently reports only a generic failure. This hides actionable NuGet/MSBuild errors such as access denied to a locked task assembly.

Capture restore stdout and stderr in the existing CLI file log and display the captured output after the restore status finishes when restore fails. Successful restores remain quiet, and update rollback and exit code 13 are unchanged. Reuse the existing OutputCollector and update the CLI documentation.

This fixes restore diagnostics only; it does not change DLL locking or stop shared MSBuild servers. No new dependencies.

Fixes #22352

User-facing usage

The existing command requires no new options:

aspire update --channel staging

Failure output before and after

Example for the locked task-assembly failure reported in #22352 (project/log paths abbreviated; progress and status icons omitted):

Before

Failed to restore packages for project <AppHost.csproj> after update.
See logs at <cli.log>

After

error : Access to the path 'Aspire.Hosting.Tasks.dll' is denied.
Failed to restore packages for project <AppHost.csproj> after update.
See logs at <cli.log>

The underlying restore stdout and stderr are now also captured in the CLI log. The generic failure summary, rollback, and exit code 13 are unchanged.

Command help is unchanged; verified from the locally built CLI:

Usage:
  aspire update [options]

Validation

Windows, .NET SDK 11.0.100. Revalidated on this branch based directly on current main.

$env:MSBUILDTERMINALLOGGER='false'; dotnet test --project tests\Aspire.Cli.Tests\Aspire.Cli.Tests.csproj --no-restore --no-launch-profile -- --filter-class '*.ProjectUpdater*' --filter-class '*.UpdateCommandTests' --filter-not-trait 'quarantined=true' --filter-not-trait 'outerloop=true'

Passed: 401 succeeded, 2 platform-specific skips, 0 failures. The four new regression cases cover project and file-based AppHosts, stdout/stderr logging, failure-only display, and rollback. All four failed before the fix because the output was missing.

dotnet exec artifacts\bin\Aspire.Cli\Debug\net11.0\aspire.dll update --help

Passed: command help rendered successfully.

git diff --check

Passed before committing.

The investigation also reproduced task DLL retention using a disposable copy and an isolated MSBuild server. Deletion failed after the build completed, succeeded after stopping only that test server, and succeeded immediately in a server-disabled control. The original worker's caller remains unproven; no shared build servers were stopped.

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

Capture restore stdout and stderr in the CLI log and display them on failure while preserving rollback and exit codes.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
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 -- 22355

Or

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

@github-actions

Copy link
Copy Markdown
Contributor

Tests selector

2 / 101 PR test projects · 4 PR jobs, from 4 changed files.

Selected PR test projects (2 / 101)

Aspire.Cli.EndToEnd.Tests, Aspire.Cli.Tests

Selected PR jobs (4)

cli-starter-validation, extension-e2e, polyglot, typescript-api-compat


How these were chosen — grouped by what changed

📦 affected project Aspire.Cli
→ 1 test: Aspire.Cli.EndToEnd.Tests

🧪 tests/Aspire.Cli.Tests/Projects/ProjectUpdaterNuGetConfigurationTests.cs (changed test)
→ 1 directly: Aspire.Cli.Tests

🧪 tests/Aspire.Cli.Tests/Projects/ProjectUpdaterTests.cs (changed test)
→ 1 directly: Aspire.Cli.Tests

🧪 tests/Aspire.Cli.Tests/Utils/CliTestHelper.cs (changed test)
→ 1 directly: Aspire.Cli.Tests

Job reasons

Job Triggered by
cli-starter-validation affected project Aspire.Cli
extension-e2e • src/Aspire.Cli/Projects/ProjectUpdater.cs
• affected project Aspire.Cli
polyglot affected project Aspire.Cli
typescript-api-compat affected project Aspire.Cli

Selection computed for commit 9361d8f.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues are reported for the restore-diagnostic improvements.

No open issues 🎉

What changed in this PR

Makes aspire update restore failures easier to diagnose, addressing #22352 without changing DLL-lock handling, rollback behavior, or exit code 13.

Changes:

  • Captures restore stdout and stderr in the CLI log and displays them after the restore status finishes on failure; successful restores remain quiet.
  • Adds regression coverage for project and file-based AppHosts, including logging, failure-only display, and rollback.
  • Documents the behavior and updates test construction for the file-logging dependency.
File Description
tests/​Aspire.Cli.Tests/​Utils/​CliTestHelper.cs Supplies the file logger when constructing the updater.
tests/​Aspire.Cli.Tests/​Projects/​ProjectUpdaterTests.cs Updates existing updater construction sites.
tests/​Aspire.Cli.Tests/​Projects/​ProjectUpdaterNuGetConfigurationTests.cs Adds four restore-diagnostic regression cases.
src/​Aspire.Cli/​README.md Documents restore diagnostic display and logging.
src/​Aspire.Cli/​Projects/​ProjectUpdater.cs Captures restore output and displays it on failure after status completion.

Review effort: Balanced

@github-actions

Copy link
Copy Markdown
Contributor

Retrying the failed CI jobs for this pull request from the CI run attempt. The rerun is being tracked in the rerun attempt.

@JamesNK
James Newton-King (JamesNK) merged commit 164d249 into main Nov 17, 2026
436 of 439 checks passed
@microsoft-github-policy-service microsoft-github-policy-service Bot added this to the 17.1 milestone Nov 17, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Pull request created: #2186

Generated by PR Documentation Check · copilot · auto · 24.4 AIC · ⌖ 1.16 AIC · ⊞ 7.4K

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

📝 Documentation has been drafted in microsoft/aspire.dev#2186 targeting release/17.0.

Updated aspire-update.mdx to note that restore stdout/stderr is shown (and logged) when the post-update restore fails. Triggered signals: pr_body_has_cli_flag_mention (aspire update --channel staging), pr_body_has_user_facing_section (failure output before/after).

Note

This draft PR needs human review before merging.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

aspire update hides restore errors caused by a lingering MSBuild task DLL lock

3 participants