Fix flaky Windows tests: dispose file watchers and use retried cleanup#4415
Open
cklin wants to merge 1 commit into
Open
Fix flaky Windows tests: dispose file watchers and use retried cleanup#4415cklin wants to merge 1 commit into
cklin wants to merge 1 commit into
Conversation
The root cause was twofold: 1. MultiFileSystemWatcher.addWatcher() never disposed the FileSystemWatcher object itself — only its event subscriptions. This leaked OS file handles on Windows, preventing temp directory deletion. 2. The tests used tmp's synchronous rimrafSync for cleanup, which has no retry logic for Windows' asynchronous handle release. Fix: - Dispose the FileSystemWatcher itself in MultiFileSystemWatcher - Replace removeCallback with async fs.rm with maxRetries, giving Windows time to release handles between retries Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
cklin
force-pushed
the
cklin/clean-discovery-disposal
branch
from
3192e44 to
5ba5584
Compare
cklin
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request addresses flaky Windows tests by ensuring file system watchers are fully disposed (releasing OS handles) and by updating test temp-directory cleanup to use fs.promises.rm with retry logic, which is more resilient to Windows’ delayed handle release.
Changes:
- Dispose the
FileSystemWatcheritself (not just its event subscriptions) inMultiFileSystemWatcher/WatcherCollection. - Replace
tmp’sremoveCallback-based cleanup withawait fs.promises.rm(..., { maxRetries, retryDelay })in several tests to reduce Windows cleanup flakiness.
Show a summary per file
| File | Description |
|---|---|
| extensions/ql-vscode/src/common/vscode/multi-file-system-watcher.ts | Ensures watchers are disposed to prevent leaking file handles (particularly impactful on Windows). |
| extensions/ql-vscode/test/vscode-tests/minimal-workspace/queries-panel/query-pack-discovery.test.ts | Switches temp cleanup to async rm with retries to improve reliability on Windows. |
| extensions/ql-vscode/test/vscode-tests/minimal-workspace/queries-panel/query-discovery.test.ts | Switches temp cleanup to async rm with retries to improve reliability on Windows. |
| extensions/ql-vscode/test/vscode-tests/minimal-workspace/common/vscode/file-path-discovery.test.ts | Switches temp cleanup to async rm with retries to improve reliability on Windows. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 4/4 changed files
- Comments generated: 0
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.
The root cause was twofold:
MultiFileSystemWatcher.addWatcher()never disposed theFileSystemWatcherobject itself — only its event subscriptions. This leaked OS file handles on Windows, preventing temp directory deletion.rimrafSyncfor cleanup, which has no retry logic for Windows' asynchronous handle release.Fix:
FileSystemWatcheritself inMultiFileSystemWatcherremoveCallbackwith asyncfs.rmwithmaxRetries, giving Windows time to release handles between retries