[release/13.4] Fix VS Code AppHost launch path resolution#17560
Open
adamint wants to merge 1 commit into
Open
Conversation
* Fix VS Code AppHost launch path resolution * Use aspire ls for extension AppHost discovery * Refresh AppHost discovery consumers on changes * Use CLI language ids for AppHost discovery * Handle AppHost discovery failures in editor commands Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add TypeScript AppHost launch discovery coverage Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Harden AppHost discovery process handling Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Honor configured AppHosts in discovery Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Consolidate extension AppHost discovery Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix workspace test path separators Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Fix AppHost configured path selection Ensure workspace AppHost selection checks all configured paths before falling back to the single discovered candidate, and add a regression test for multiple config files.\n\nCo-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Keep extension-launched AppHost CLI alive Keep the Aspire CLI process alive after VS Code launches an AppHost so the CLI-owned backchannel remains available for the lifetime of the extension-managed debug session. Propagate extension backchannel startup failures instead of returning success. Also ignore generated .modules directories for polyglot AppHosts. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update extension build and CLI debug logging Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address AppHost launch review feedback Keep extension-managed CLI runs alive only until the AppHost backchannel disconnects, align configured AppHost discovery UX with scanned candidates, restore dynamic debug fallbacks, and return no disposable for async workspace prompts. Restore Yarn 1 frozen install compatibility for extension CI and avoid the npx package-name/bin-name mismatch in localization export. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address extension discovery review feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Stabilize pipeline unit tests without Docker Use the existing fake container runtime resolver in the pipeline unit test context so the built-in container runtime check doesn't depend on Docker availability on CI runners. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Use ordinal comparison in pipeline test provider Keep the fake container runtime service-provider lookup null-safe and explicit. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Revert pipeline test isolation changes Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Adam Ratzman <adam@adamratzman.com> (cherry picked from commit 00eff9d)
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 17560Or
iex "& { $(irm https://raw.githubusercontent.com/microsoft/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 17560" |
Contributor
There was a problem hiding this comment.
Pull request overview
Backports PR #17408 to release/13.4 to fix Aspire VS Code AppHost launch/discovery path handling (notably resolving SDK-style Program.cs editor/debug targets to the owning .csproj), unify the extension’s AppHost discovery on aspire ls --format json, and keep extension-launched AppHost CLI backchannels alive for the debug session lifetime.
Changes:
- Adds CLI/extension backchannel lifetime handling so the CLI stays alive until the AppHost backchannel disconnects when launched by the VS Code extension.
- Introduces a shared VS Code extension
AppHostDiscoveryService(CLI-first, legacy fallback) and wires it through editor commands, debug configuration provider, and workspace tree discovery/refresh. - Expands CLI and extension test coverage for configured AppHosts outside the working directory and TypeScript AppHost scenarios.
Reviewed changes
Copilot reviewed 30 out of 31 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/Aspire.Cli.Tests/TestServices/TestAppHostCliBackchannel.cs | Adds disconnect signaling to the test backchannel implementation. |
| tests/Aspire.Cli.Tests/Projects/ProjectLocatorTests.cs | Adds coverage for configured AppHost selection messaging and unsupported configured AppHost paths. |
| tests/Aspire.Cli.Tests/DotNet/DotNetCliRunnerTests.cs | Updates tests to assert CLI stays alive until backchannel disconnects and propagates backchannel failures. |
| tests/Aspire.Cli.Tests/Commands/PublishCommandPromptingIntegrationTests.cs | Updates test backchannel to implement the new disconnect-wait API. |
| tests/Aspire.Cli.Tests/Commands/LsCommandTests.cs | Adds coverage ensuring aspire ls --format json includes configured AppHosts outside the working directory. |
| src/Aspire.Cli/Templating/Templates/ts-starter/.gitignore | Ignores generated .modules/ output in TS starter template. |
| src/Aspire.Cli/Templating/Templates/py-starter/.gitignore | Ignores generated .modules/ output in Python starter template. |
| src/Aspire.Cli/Templating/Templates/java-starter/.gitignore | Ignores generated .modules/ output in Java starter template. |
| src/Aspire.Cli/Projects/ProjectLocator.cs | Ensures configured AppHost from settings is included as a discovery candidate (with validation/status reporting). |
| src/Aspire.Cli/Program.cs | Ensures console debug logging still flows when hosted by the VS Code extension. |
| src/Aspire.Cli/DotNet/DotNetCliRunner.cs | Keeps CLI alive for extension-launched AppHosts by awaiting backchannel disconnect. |
| src/Aspire.Cli/Backchannel/AppHostCliBackchannel.cs | Adds a disconnect-wait primitive driven by JsonRpc.Disconnected. |
| playground/TypeScriptAppHost/.gitignore | Ignores .modules/ in the playground TS AppHost. |
| extension/src/views/AppHostDataRepository.ts | Switches workspace AppHost fetch to shared discovery service + change notifications. |
| extension/src/utils/workspace.ts | Removes ad-hoc aspire ls spawning in favor of shared discovery service usage. |
| extension/src/utils/settings.ts | Adds setting for AppHost discovery timeout (bounded minimum). |
| extension/src/utils/cliTypes.ts | Fixes JSON file decoding by converting Uint8Array to UTF-8 string correctly. |
| extension/src/utils/appHostDiscovery.ts | New shared discovery implementation (CLI-first, legacy fallback, caching/watchers, editor target resolution). |
| extension/src/test/workspace.test.ts | Updates workspace tests to use the new shared discovery service and path-separator handling. |
| extension/src/test/aspireEditorCommandProvider.test.ts | Adds coverage for editor Run/Debug target resolution and discovery-failure behavior. |
| extension/src/test/aspireDebugConfigurationProvider.test.ts | Adds coverage for debug config normalization and dynamic debug config behavior. |
| extension/src/test/appHostDiscovery.test.ts | Adds direct tests for discovery parsing, caching, watcher invalidation, timeouts, and configured-path selection. |
| extension/src/test/appHostDataRepository.test.ts | Updates repository tests for shared discovery timing and config-file discovery stubbing. |
| extension/src/extension.ts | Wires a single AppHostDiscoveryService instance through extension components. |
| extension/src/editor/AspireEditorCommandProvider.ts | Replaces heuristic AppHost detection with discovery-backed candidate resolution and workspace context updates. |
| extension/src/debugger/AspireDebugConfigurationProvider.ts | Resolves launch targets via discovery (including substituted variable paths) and improves dynamic config selection. |
| extension/package.nls.json | Adds localized string for new discovery timeout setting. |
| extension/package.json | Registers new aspire.appHostDiscoveryTimeoutMs setting metadata. |
| extension/loc/xlf/aspire-vscode.xlf | Updates localization bundle with new/previously-missing strings. |
| extension/gulpfile.js | Hardens l10n export by invoking the @vscode/l10n-dev CLI via Node (execFile). |
| .gitignore | Ignores .modules/ at repo root. |
| all_project_file_candidates: string[]; | ||
| } | ||
|
|
||
| const discoveryExcludePattern = '{**/artifacts/**,**/[Bb]in/**,**/[Oo]bj/**,**/node_modules/**,**/.git/**,**/.vs/**,**/.vscode-test/**,**/.idea/**,**/.aspire/modules/**}'; |
| || lowerSegment === '.git' | ||
| || lowerSegment === '.vs' | ||
| || lowerSegment === '.vscode-test' | ||
| || lowerSegment === '.idea' |
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.
|
Contributor
|
❌ CLI E2E Tests failed — 105 passed, 2 failed, 2 unknown (commit Failed Tests
View all recordings
📹 Recordings uploaded automatically from CI run #26539425937 |
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.
Backport of #17408 to release/13.4
/cc @davidfowl
Customer Impact
Customers launching or debugging Aspire AppHosts from VS Code can fail when the active file or launch config points at an SDK-style AppHost
Program.csinstead of the project file. Configured AppHosts outside normal workspace discovery can also be missed.Testing
Manual, using playground apps
Risk
Low. Localized VS Code AppHost discovery/launch path handling and CLI AppHost path/lifetime handling, covered by targeted tests.
Regression?
No