fix: prevent unnecessary diagnostic refreshes on irrelevant watch events (#4589)#4604
Open
ibesuperv wants to merge 10 commits into
Open
fix: prevent unnecessary diagnostic refreshes on irrelevant watch events (#4589)#4604ibesuperv wants to merge 10 commits into
ibesuperv wants to merge 10 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR optimizes the language server’s Session.DidChangeWatchedFiles path by gating workspace/diagnostic/refresh so it only runs when a watch batch includes changes that could affect the TypeScript program, reducing client RPC/CPU spikes during noisy filesystem activity (e.g. npm install).
Changes:
- Added relevance detection in
DidChangeWatchedFilesto conditionally scheduleScheduleDiagnosticsRefresh(). - Preserved unconditional cache invalidation behavior on all watch events.
- Added a Go regression test sub-suite to verify refresh behavior for relevant vs irrelevant watch events.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| internal/project/session.go | Adds relevance gating for ScheduleDiagnosticsRefresh() based on watched file URI extensions / extensionless paths. |
| internal/project/session_test.go | Adds a new DidChangeWatchedFiles test sub-suite covering refresh-triggering behavior across several event scenarios. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Fixes #4589
This PR optimizes
Session.DidChangeWatchedFilesto only trigger the expensiveworkspace/diagnostic/refreshRPC round-trip when the watch events contain files that could actually affect the TypeScript program.Changes
ScheduleDiagnosticsRefresh()is now only invoked if the batch contains files with relevant extensions (using the canonical extension list fromisRelevantFileName), or directories (files with no extension).cancelWarmAutoImportCache,scheduleIdleCacheClean) continue to execute unconditionally on all watch events, ensuring that package installs (which generate noise like.svgand.md) still correctly invalidate stale cache state.TestSession/DidChangeWatchedFiles/skips_irrelevant_extensionsto verify that diagnostic refreshes correctly trigger (or skip) for.ts,tsconfig.json, directories, and irrelevant files.Why this matters
Currently, when a user installs a package (e.g., via
npm install), the LSP receives hundreds of watch events for irrelevant files like.svg,.png, and.md. Previously, this unconditionally triggeredScheduleDiagnosticsRefresh(), causing a CPU and RPC spike on the VS Code client. This patch filters the noise at the transport layer, eliminating the spurious refreshes while maintaining correctness.