Skip to content

Bound the dependency and Auto Find file searches in a home folder workspace - #2002

Draft
Jean-François Gagné (JeanFrancoisGagne) wants to merge 5 commits into
microsoft:mainfrom
JeanFrancoisGagne:home-folder-search-cap
Draft

Jean-François Gagné (JeanFrancoisGagne) wants to merge 5 commits into
microsoft:mainfrom
JeanFrancoisGagne:home-folder-search-cap

Conversation

@JeanFrancoisGagne

Copy link
Copy Markdown

Summary

In a VS Code window opened on the user's home folder (for example C:\Users\<name>), three actions start file searches that walk the whole profile, AppData and tool caches included, and take minutes:

  • opening the package install picker for a venv, which searches before it can offer Install project dependencies
  • creating a venv with Quick Create
  • Auto Find Projects when adding a Python project

Until ripgrep finishes, the Searching for dependencies notification stays up or Auto Find shows nothing, and ripgrep keeps the CPU and disk busy the whole time.

Cause

workspace.findFiles runs ripgrep with --no-ignore and, by default, --follow. The excludes these callers pass leave most of a profile in scope, and none of the calls passes maxResults:

  • src/managers/builtin/pipUtils.ts:459-462 (before this PR) runs four searches in parallel in getProjectInstallable.
  • src/features/creators/autoFindProjects.ts:94 (before this PR) runs one search in AutoFindProjects.create.

Fix

  • src/common/workspaceSearch.ts:42 adds findFilesInWorkspace({ label, include, exclude, maxResults, neededFolders, token }):
    • If no workspace folder is os.homedir() or one of its parents, it makes the same single findFiles call as before, plus maxResults. The caller's token goes to findFiles unchanged.
    • It never searches such a folder whole. In its place it searches each of the caller's neededFolders inside it, one RelativePattern each, and skips a needed folder that is itself home or a parent of home. The check uses isSameOrParentPath, so separators, a trailing separator and case on Windows do not matter. traceLog names the folder, the reason and the folders searched instead.
    • It skips a needed path that is a file or does not exist, because ripgrep cannot start there and a failed start fails the whole findFiles call. Projects can be single .py files. A folder inside another needed folder is searched once.
    • The other workspace folders of a multi-root workspace are searched whole, as before.
    • It has no time limit. A cancelled findFiles resolves to an empty list, not to the matches found so far: searchService.ts races the provider against the token, mainThreadWorkspace.ts returns null on cancel, and extHostWorkspace.ts maps null to []. A limit would turn a slow search into "nothing found".
    • traceWarn records a search that reached its cap.
  • pipUtils.ts:431,464-484: each of the four dependency searches goes through the helper with maxResults 10,000 per pattern and the project folders as neededFolders. getProjectInstallable already keeps only files under those projects, so in a home folder workspace it finds the same files as before without walking the rest of the profile. Quick Create installs from every match under the project, so this cap sits far above what a large monorepo holds. The progress notification and the caller's token still cancel every search.
  • autoFindProjects.ts:20,101: the marker search goes through the helper with maxResults 1,000 and no neededFolders. Each folder with a marker becomes one item in a multi-select picker, and a picker with 1,000 items is already too long to use.

In a home folder workspace:

  • Quick Create and the package picker search each project folder inside home and find its dependency files, without the profile walk.
  • A project that is the home folder itself is not searched, so it gets no workspace dependency files.
  • Auto Find reports No projects found. Opening the project folder itself, or adding it as a second workspace folder, searches it as before.

Not changed:

  • src/features/views/workspacePythonContext.ts:31 already passes maxResults 1, and Avoid a full workspace search per Python file event #1999 adds its token.
  • src/features/inlineScript/setupEnvironment.ts:288 already passes maxResults 1,000 (MAX_INLINE_SCRIPT_FILES) but no token. A follow-up could move it to the helper.

Testing

Windows 11, Node 24.21.0.

  • npm ci, then npx tsc -p . --outDir out (the compile-tests command): exit 0.
  • npx eslint --config=eslint.config.mjs on the seven touched files: exit 0.
  • The touched unit test files, with the options from build/.mocha.unittests.json:
    npx mocha --no-config --ui tdd --require source-map-support/register --require out/test/unittests.js --timeout 180000 out/test/common/workspaceSearch.unit.test.js out/test/managers/builtin/pipUtils.unit.test.js out/test/features/creators/autoFindProjects.unit.test.js
    Result: 88 passing. out/test/managers/common/packageWatcher.unit.test.js, which also builds RelativePattern through the vscode mock: 39 passing.
  • Each change failed its tests first:
    • Caps and home folder: the five call-site tests failed (66 passing, 5 failing): no result cap at either site, the home folder searched at both sites, and the other folder of a multi-root workspace not scoped. The helper tests failed to compile until the module existed.
    • No time limit: with a findFiles fake that returns [] once its token cancels, as VS Code does, the tests for a search that runs for minutes failed for the helper, getProjectInstallable and Auto Find, and so did the tests that check the caller's token reaches findFiles (73 passing, 9 failing).
    • Project folders: a project at ~/code/app in a home folder workspace got no dependency files, and the helper searched no needed folder (85 passing, 3 failing).
  • The new tests check:
    • each findFiles call's maxResults and token
    • that a search that runs for minutes keeps every match
    • which folders are searched: a home folder workspace, a parent of home, and the home path with another case or a trailing separator are not searched whole; a folder inside home is searched; needed folders inside a home workspace folder are searched once each; a needed folder that is home, a file or a missing path is not searched
  • Changed tests:
    • Both getProjectInstallable suites now stub getWorkspaceFolders, which the helper reads.
    • The vscode mock's RelativePattern accepts a Uri base, as VS Code's does.
  • Not run on this change: the full unit suite, and a running VS Code.

Context

#1989 reports a VS Code window opened on the home folder that froze a Windows laptop. #1999 fixes the workspaceHasPython watcher behind that report. Reviewing #1999 turned up these unbounded findFiles calls, which #1999 does not touch. They run on user actions rather than on file events, so each action starts one walk instead of one per changed file, but each walk still covers the whole profile.

🤖 Generated with Claude Code

findFilesInWorkspace wraps workspace.findFiles with a result cap and a
30 second time limit, linked to the caller's cancellation token. A
workspace folder that is the user's home folder, or one of its parents,
is not searched and the skip is logged; the other folders are searched
through a RelativePattern each. With no home folder open, the call is
the same single search as before.

findFiles runs ripgrep with --no-ignore and follows symlinks, so a
search rooted at the home folder walks the whole profile.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
getProjectInstallable ran four findFiles calls with no maxResults. In a
workspace opened on the home folder each one walked the whole profile
for minutes before the package picker or Quick Create could continue.

Each search now goes through findFilesInWorkspace with a cap of 10,000
files and the 30 second time limit, and skips a home folder workspace.
The progress and caller tokens still cancel every search.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
AutoFindProjects.create ran findFiles with no maxResults and no token,
so in a workspace opened on the home folder it walked the whole profile
before showing the picker.

The search now goes through findFilesInWorkspace with a cap of 1,000
marker files and the 30 second time limit, and skips a home folder
workspace.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
VS Code resolves a cancelled findFiles to an empty list, not to the
matches found so far (searchService.ts raceCancellationError,
mainThreadWorkspace.ts returns null, extHostWorkspace.ts maps null to
[]). The 30 second limit therefore turned a slow dependency search
into "no dependencies", so Quick Create made a venv without them, and
a slow Auto Find search into "No projects found".

findFilesInWorkspace now passes the caller's token to findFiles
unchanged. The dependency search keeps its cancellable progress
notification or the caller's token, as before this branch. The tests
that checked a linked token go back to checking the caller's token.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
getProjectInstallable keeps only files under the projects it is given,
but the home folder check skipped the whole workspace folder. With the
workspace on the home folder and a project at ~/code/app, Quick Create
made the venv without the project's dependencies and the package
picker left out its requirements files.

findFilesInWorkspace takes neededFolders. In place of a workspace
folder that is the home folder or contains it, it searches each needed
folder inside it, one RelativePattern each, and still skips a needed
folder that is home or contains it. It skips a needed path that is a
file or missing, because ripgrep cannot start there and a failed start
fails the whole findFiles call. Nested and repeated folders are
searched once. The dependency search passes the project folders; Auto
Find passes none and keeps skipping the home folder.

The vscode mock's RelativePattern now takes a Uri base, as VS Code's
does.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@microsoft-github-policy-service

Copy link
Copy Markdown

Jean-François Gagné (@JeanFrancoisGagne) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant