Cache source archive list inside DataBaseItemImpl

Author: hvitved

extensions/ql-vscode/src/databases/local-databases/database-item-impl.ts

@@ -1,6 +1,6 @@
 // Exported for testing
 import type { CodeQLCliServer, DbInfo } from "../../codeql-cli/cli";
-import { Uri, workspace } from "vscode";
+import { FileType, Uri, workspace } from "vscode";
 import type { FullDatabaseOptions } from "./database-options";
 import { basename, dirname, extname, join } from "path";
 import {
@@ -9,7 +9,11 @@ import {
   encodeSourceArchiveUri,
   zipArchiveScheme,
 } from "../../common/vscode/archive-filesystem-provider";
-import type { DatabaseItem, PersistedDatabaseItem } from "./database-item";
+import type {
+  DatabaseItem,
+  PersistedDatabaseItem,
+  SourceArchiveFile,
+} from "./database-item";
 import { isLikelyDatabaseRoot } from "./db-contents-heuristics";
 import { stat } from "fs-extra";
 import { containsPath, pathsEqual } from "../../common/files";
@@ -22,6 +26,8 @@ export class DatabaseItemImpl implements DatabaseItem {
   public contents: DatabaseContents | undefined;
   /** A cache of database info */
   private _dbinfo: DbInfo | undefined;
+  /** A cache of source archive files */
+  private _sourceArchiveFiles: SourceArchiveFile[] | undefined;
 
   public constructor(
     public readonly databaseUri: Uri,
@@ -234,4 +240,66 @@ export class DatabaseItemImpl implements DatabaseItem {
       return false;
     }
   }
+
+  public async getSourceArchiveFiles(): Promise<SourceArchiveFile[]> {
+    if (this._sourceArchiveFiles === undefined) {
+      this._sourceArchiveFiles = await this.collectSourceArchiveFiles();
+    }
+    return this._sourceArchiveFiles;
+  }
+
+  private async collectSourceArchiveFiles(): Promise<SourceArchiveFile[]> {
+    const explorerUri = this.getSourceArchiveExplorerUri();
+    const sourceArchiveZipPath =
+      decodeSourceArchiveUri(explorerUri).sourceArchiveZipPath;
+
+    const items: SourceArchiveFile[] = [];
+    await this.collectFilesRecursive(
+      explorerUri,
+      sourceArchiveZipPath,
+      "",
+      items,
+    );
+    // Sort by file name, then by path
+    items.sort((a, b) => {
+      const nameCmp = a.name.localeCompare(b.name);
+      if (nameCmp !== 0) {
+        return nameCmp;
+      }
+      return a.path.localeCompare(b.path);
+    });
+    return items;
+  }
+
+  private async collectFilesRecursive(
+    dirUri: Uri,
+    sourceArchiveZipPath: string,
+    prefix: string,
+    items: SourceArchiveFile[],
+  ): Promise<void> {
+    const entries = await workspace.fs.readDirectory(dirUri);
+
+    for (const [name, type] of entries) {
+      const childPath = prefix ? `${prefix}/${name}` : name;
+      const childUri = encodeSourceArchiveUri({
+        sourceArchiveZipPath,
+        pathWithinSourceArchive: `${decodeSourceArchiveUri(dirUri).pathWithinSourceArchive}/${name}`,
+      });
+
+      if (type === FileType.File) {
+        items.push({
+          name,
+          path: prefix,
+          uri: childUri,
+        });
+      } else if (type === FileType.Directory) {
+        await this.collectFilesRecursive(
+          childUri,
+          sourceArchiveZipPath,
+          childPath,
+          items,
+        );
+      }
+    }
+  }
 }

extensions/ql-vscode/src/databases/local-databases/database-item.ts

@@ -4,6 +4,16 @@ import type { DatabaseContents } from "./database-contents";
 import type { DatabaseOptions } from "./database-options";
 import type { DatabaseOrigin } from "./database-origin";
 
+/** A file entry from the database's source archive. */
+export interface SourceArchiveFile {
+  /** The file name (basename). */
+  name: string;
+  /** The path prefix (directory path relative to the source archive root). */
+  path: string;
+  /** The URI that can be used to open the file. */
+  uri: Uri;
+}
+
 /** An item in the list of available databases */
 export interface DatabaseItem {
   /** The URI of the database */
@@ -92,6 +102,12 @@ export interface DatabaseItem {
    * Verifies that this database item has a zipped source folder. Returns an error message if it does not.
    */
   verifyZippedSources(): string | undefined;
+
+  /**
+   * Returns all files in the database's source archive.
+   * The result is lazily computed and cached.
+   */
+  getSourceArchiveFiles(): Promise<SourceArchiveFile[]>;
 }
 
 export interface PersistedDatabaseItem {

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

@@ -4,7 +4,7 @@ export {
   DatabaseKind,
 } from "./database-contents";
 export { DatabaseChangedEvent, DatabaseEventKind } from "./database-events";
-export { DatabaseItem } from "./database-item";
+export { DatabaseItem, SourceArchiveFile } from "./database-item";
 export { DatabaseItemImpl } from "./database-item-impl";
 export { DatabaseManager } from "./database-manager";
 export { DatabaseResolver } from "./database-resolver";

extensions/ql-vscode/src/databases/source-archive-file-search.ts

@@ -1,65 +1,19 @@
 import type { QuickPickItem, Uri } from "vscode";
-import { FileType, window, workspace } from "vscode";
+import { window, workspace } from "vscode";
 import type { DatabaseItem } from "./local-databases";
-import {
-  encodeSourceArchiveUri,
-  decodeSourceArchiveUri,
-} from "../common/vscode/archive-filesystem-provider";
 
 interface SourceArchiveFileQuickPickItem extends QuickPickItem {
   uri: Uri;
 }
 
-/**
- * Recursively collects all file URIs from a source archive directory.
- */
-async function collectFiles(
-  dirUri: Uri,
-  sourceArchiveZipPath: string,
-  prefix: string,
-  items: SourceArchiveFileQuickPickItem[] = [],
-): Promise<SourceArchiveFileQuickPickItem[]> {
-  const entries = await workspace.fs.readDirectory(dirUri);
-
-  for (const [name, type] of entries) {
-    const childPath = prefix ? `${prefix}/${name}` : name;
-    const childUri = encodeSourceArchiveUri({
-      sourceArchiveZipPath,
-      pathWithinSourceArchive: `${decodeSourceArchiveUri(dirUri).pathWithinSourceArchive}/${name}`,
-    });
-
-    if (type === FileType.File) {
-      items.push({
-        label: name,
-        description: prefix,
-        uri: childUri,
-      });
-    } else if (type === FileType.Directory) {
-      await collectFiles(childUri, sourceArchiveZipPath, childPath, items);
-    }
-  }
-
-  return items;
-}
-
 /**
  * Shows a Quick Pick to search for and open a file from the source archive
  * of the given database.
  */
 export async function searchSourceArchiveFiles(
   databaseItem: DatabaseItem,
 ): Promise<void> {
-  let explorerUri: Uri;
-  try {
-    explorerUri = databaseItem.getSourceArchiveExplorerUri();
-  } catch (e) {
-    void window.showErrorMessage(e instanceof Error ? e.message : String(e));
-    return;
-  }
-  const sourceArchiveZipPath =
-    decodeSourceArchiveUri(explorerUri).sourceArchiveZipPath;
-
-  const filesPromise = collectFiles(explorerUri, sourceArchiveZipPath, "");
+  const filesPromise = databaseItem.getSourceArchiveFiles();
 
   const quickPick = window.createQuickPick<SourceArchiveFileQuickPickItem>();
   quickPick.placeholder = "Go to File in Selected Database...";
@@ -68,16 +22,12 @@ export async function searchSourceArchiveFiles(
   quickPick.show();
 
   try {
-    const items = await filesPromise;
-    // Sort items by file name, then by path
-    items.sort((a, b) => {
-      const nameCmp = a.label.localeCompare(b.label);
-      if (nameCmp !== 0) {
-        return nameCmp;
-      }
-      return (a.description ?? "").localeCompare(b.description ?? "");
-    });
-    quickPick.items = items;
+    const files = await filesPromise;
+    quickPick.items = files.map((f) => ({
+      label: f.name,
+      description: f.path,
+      uri: f.uri,
+    }));
     quickPick.busy = false;
   } catch (e) {
     quickPick.dispose();