Skip to content

Deprecate codeQL.runningQueries.saveCache setting #4210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 26, 2025
Merged

Deprecate codeQL.runningQueries.saveCache setting #4210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79745f3
Deprecate `codeQL.runningQueries.saveCache` setting
nickrolfe Nov 25, 2025
f7fcc9e
Add changenote for deprecating codeQL.runningQueries.saveCache
nickrolfe Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions extensions/ql-vscode/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## [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`) that aggressively saved intermediate results to the disk cache. [#4210](https://github.com/github/vscode-codeql/pull/4210)

## 1.17.6 - 24 October 2025

Expand Down
1 change: 1 addition & 0 deletions extensions/ql-vscode/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@
"type": "boolean",
"default": false,
"scope": "window",
"deprecationMessage": "This setting no longer has any effect.",
"description": "Aggressively save intermediate results to the disk cache. This may speed up subsequent queries if they are similar. Be aware that using this option will greatly increase disk usage and initial evaluation time."
},
"codeQL.runningQueries.cacheSize": {
Expand Down
7 changes: 0 additions & 7 deletions extensions/ql-vscode/src/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,6 @@ const NUMBER_OF_THREADS_SETTING = new Setting(
"numberOfThreads",
RUNNING_QUERIES_SETTING,
);
const SAVE_CACHE_SETTING = new Setting("saveCache", RUNNING_QUERIES_SETTING);
const CACHE_SIZE_SETTING = new Setting("cacheSize", RUNNING_QUERIES_SETTING);
const TIMEOUT_SETTING = new Setting("timeout", RUNNING_QUERIES_SETTING);
const MEMORY_SETTING = new Setting("memory", RUNNING_QUERIES_SETTING);
Expand Down Expand Up @@ -257,7 +256,6 @@ const CUSTOM_LOG_DIRECTORY_SETTING = new Setting(
/** When these settings change, the running query server should be restarted. */
const QUERY_SERVER_RESTARTING_SETTINGS = [
NUMBER_OF_THREADS_SETTING,
SAVE_CACHE_SETTING,
CACHE_SIZE_SETTING,
MEMORY_SETTING,
DEBUG_SETTING,
Expand All @@ -268,7 +266,6 @@ export interface QueryServerConfig {
codeQlPath: string;
debug: boolean;
numThreads: number;
saveCache: boolean;
cacheSize: number;
queryMemoryMb?: number;
timeoutSecs: number;
Expand Down Expand Up @@ -432,10 +429,6 @@ export class QueryServerConfigListener
return NUMBER_OF_THREADS_SETTING.getValue<number>();
}

public get saveCache(): boolean {
return SAVE_CACHE_SETTING.getValue<boolean>();
}

public get cacheSize(): number {
return CACHE_SIZE_SETTING.getValue<number | null>() || 0;
}
Expand Down
4 changes: 0 additions & 4 deletions extensions/ql-vscode/src/query-server/query-server-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,6 @@ export class QueryServerClient extends DisposableObject {
ramArgs,
);

if (this.config.saveCache) {
args.push("--save-cache");
}

if (this.config.cacheSize > 0) {
args.push("--max-disk-cache");
args.push(this.config.cacheSize.toString());
Expand Down
1 change: 0 additions & 1 deletion ...ions/ql-vscode/test/vscode-tests/cli-integration/query-server/query-server-client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@ describeWithCodeQL()("using the query server", () => {
debug: false,
cacheSize: 0,
numThreads: 1,
saveCache: false,
timeoutSecs: 0,
},
cliServer,
Expand Down
5 changes: 0 additions & 5 deletions extensions/ql-vscode/test/vscode-tests/minimal-workspace/config.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,6 @@ describe("config listeners", () => {
property: "numThreads",
values: [0, 1],
},
{
name: "codeQL.runningQueries.saveCache",
property: "saveCache",
values: [false, true],
},
{
name: "codeQL.runningQueries.cacheSize",
property: "cacheSize",
Expand Down
Loading