Deprecate codeQL.runningQueries.saveCache setting
#4210
Merged
Conversation
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
nickrolfe
force-pushed
the
nickrolfe/rm-save-cache
branch
from
1f960f1 to
74ac0fb
Compare
cklin
reviewed
Nov 25, 2025
extensions/ql-vscode/CHANGELOG.md
Outdated
| ## [UNRELEASED] | ||
|
|
||
| - Rename command "CodeQL: Trim Overlay Base Cache" to "CodeQL: Trim Cache to Overlay-Base" for consistency with "CodeQL: Warm Overlay-Base Cache for [...]" commands. [#4204](https://github.com/github/vscode-codeql/pull/4204) | ||
| - Deprecate the setting (`codeQL.runningQueries.saveCache`) to aggressively save intermediate results to the disk cache. [#4210](https://github.com/github/vscode-codeql/pull/4210) |
Contributor
There was a problem hiding this comment.
(nit) There is some ambiguity, as the sentence can be parsed in two ways:
- Deprecate (the setting to aggressively save ...)
- (Deprecate the setting) to aggressively save ...
Please consider rewording it for greater clarity. Thanks!
Contributor
Author
There was a problem hiding this comment.
Good point; fixed.
nickrolfe
force-pushed
the
nickrolfe/rm-save-cache
branch
from
74ac0fb to
f7fcc9e
Compare
Copilot finished reviewing on behalf of
nickrolfe
November 25, 2025 17:40
Contributor
There was a problem hiding this comment.
Pull request overview
This PR deprecates the codeQL.runningQueries.saveCache setting which aggressively saved intermediate query results to disk cache but generally degraded performance. The setting is marked as deprecated in VS Code's configuration UI (showing for users who previously set it) while removing its functionality from the codebase.
Key changes:
- Added deprecation message to the setting in package.json
- Removed all code that implemented the saveCache functionality
- Updated tests to remove references to the deprecated setting
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| extensions/ql-vscode/package.json | Added deprecationMessage to the saveCache setting to mark it as deprecated in VS Code UI |
| extensions/ql-vscode/src/config.ts | Removed SAVE_CACHE_SETTING constant, saveCache property from QueryServerConfig interface, and saveCache getter from QueryServerConfigListener class |
| extensions/ql-vscode/src/query-server/query-server-client.ts | Removed the code that added the --save-cache flag to query server arguments |
| extensions/ql-vscode/test/vscode-tests/minimal-workspace/config.test.ts | Removed saveCache from the test configuration settings array |
| extensions/ql-vscode/test/vscode-tests/cli-integration/query-server/query-server-client.test.ts | Removed saveCache: false from the QueryServerClient test initialization |
| extensions/ql-vscode/CHANGELOG.md | Added entry documenting the deprecation of the setting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cklin
approved these changes
Nov 25, 2025
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.
This setting was a bit of a footgun for users, and generally only caused performance to get worse.
By adding a
deprecationMessagetopackage.json, the docs suggest, and my testing confirms, that this will cause the setting to be hidden for users who haven't set it. For those who have explicitly set it (to either true or false), the settings UI will show the deprecation message.