Add cancellation support for dependency search during environment creation #932
+53
−0
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.
Problem
When creating a Python virtual environment in a very large workspace folder (e.g., a dev folder with many subdirectories and files), the "Searching for dependencies" progress notification would run for an extended period with no way to cancel. Users were forced to either wait indefinitely or exit VS Code entirely to escape the operation.
Solution
Added cancellation support to the dependency search progress by setting
cancellable: true
in thewithProgress
options. This enables a Cancel button (X) on the progress notification, allowing users to gracefully exit the operation.Changes
Modified
src/managers/builtin/pipUtils.ts
:cancellable: true
to the progress options in thegetProjectInstallable
functionfindFiles
calls, so no additional changes were neededAdded tests in
src/test/managers/builtin/pipUtils.unit.test.ts
:cancellable
flag is set correctlyHow Cancellation Works
token.isCancellationRequested = true
findFiles
API calls check the token and terminate the searchCancellationError
is thrown and propagates up the call stackImpact
Test Results
Fixes #[issue-number]
Original prompt
Fixes #924
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.