Add "CodeQL: Trim Overlay Base Cache" command

Author: d10c

extensions/ql-vscode/package.json

@@ -790,6 +790,11 @@
         "command": "codeQL.trimCache",
         "title": "CodeQL: Trim Cache"
       },
+      {
+        "command": "codeQL.trimOverlayBaseCache",
+        "title": "CodeQL: Trim Overlay Base Cache",
+        "when": "codeQL.cliFeatures.queryServerModeInTrimCache"
+      },
       {
         "command": "codeQL.installPackDependencies",
         "title": "CodeQL: Install Pack Dependencies"

extensions/ql-vscode/src/common/commands.ts

@@ -221,6 +221,7 @@ export type LocalDatabasesCommands = {
   "codeQL.upgradeCurrentDatabase": () => Promise<void>;
   "codeQL.clearCache": () => Promise<void>;
   "codeQL.trimCache": () => Promise<void>;
+  "codeQL.trimOverlayBaseCache": () => Promise<void>;
 
   // Explorer context menu
   "codeQL.setCurrentDatabase": (uri: Uri) => Promise<void>;

extensions/ql-vscode/src/databases/local-databases-ui.ts

@@ -284,6 +284,7 @@ export class DatabaseUI extends DisposableObject {
         this.handleUpgradeCurrentDatabase.bind(this),
       "codeQL.clearCache": this.handleClearCache.bind(this),
       "codeQL.trimCache": this.handleTrimCache.bind(this),
+      "codeQL.trimOverlayBaseCache": this.handleTrimOverlayBaseCache.bind(this),
       "codeQLDatabases.chooseDatabaseFolder":
         this.handleChooseDatabaseFolder.bind(this),
       "codeQLDatabases.chooseDatabaseArchive":
@@ -688,6 +689,24 @@ export class DatabaseUI extends DisposableObject {
     );
   }
 
+  private async handleTrimOverlayBaseCache(): Promise<void> {
+    return withProgress(
+      async () => {
+        if (
+          this.queryServer !== undefined &&
+          this.databaseManager.currentDatabaseItem !== undefined
+        ) {
+          await this.queryServer.trimOverlayBaseCacheInDatabase(
+            this.databaseManager.currentDatabaseItem,
+          );
+        }
+      },
+      {
+        title: "Removing all overlay-dependent data from cache",
+      },
+    );
+  }
+
   private async handleGetCurrentDatabase(): Promise<string | undefined> {
     const dbItem = await this.getDatabaseItemInternal(undefined);
     return dbItem?.databaseUri.fsPath;

extensions/ql-vscode/src/query-server/messages.ts

@@ -40,6 +40,10 @@ export interface TrimCacheParams {
    * The dataset that we want to trim the cache of.
    */
   db: string;
+  /**
+   * The cache cleanup mode to use (default: "trim")
+   */
+  mode?: "clear" | "trim" | "fit" | "overlay";
 }
 
 /**

extensions/ql-vscode/src/query-server/query-runner.ts

@@ -142,6 +142,21 @@ export class QueryRunner {
     await this.qs.sendRequest(trimCache, params);
   }
 
+  async trimOverlayBaseCacheInDatabase(dbItem: DatabaseItem): Promise<void> {
+    if (dbItem.contents === undefined) {
+      throw new Error(
+        "Can't trim the overlay base cache in an invalid database.",
+      );
+    }
+
+    const db = dbItem.databaseUri.fsPath;
+    const params: TrimCacheParams = {
+      db,
+      mode: "overlay",
+    };
+    await this.qs.sendRequest(trimCache, params);
+  }
+
   public async compileAndRunQueryAgainstDatabaseCore(
     dbPath: string,
     queries: CoreQueryTarget[],