Merge pull request #2036 from github/shati-elena/create-skeleton

Introduce command for creating skeleton QL packs

Author: elenatanasoiu

extensions/ql-vscode/src/databases.ts

@@ -9,6 +9,8 @@ import {
   showAndLogInformationMessage,
   isLikelyDatabaseRoot,
   showAndLogExceptionWithTelemetry,
+  isFolderAlreadyInWorkspace,
+  showBinaryChoiceDialog,
 } from "./helpers";
 import { ProgressCallback, withProgress } from "./commandRunner";
 import {
@@ -23,6 +25,7 @@ import { asError, getErrorMessage } from "./pure/helpers-pure";
 import { QueryRunner } from "./queryRunner";
 import { pathsEqual } from "./pure/files";
 import { redactableError } from "./pure/errors";
+import { isCodespacesTemplate } from "./config";
 
 /**
  * databases.ts
@@ -621,9 +624,38 @@ export class DatabaseManager extends DisposableObject {
     await this.addDatabaseItem(progress, token, databaseItem);
     await this.addDatabaseSourceArchiveFolder(databaseItem);
 
+    if (isCodespacesTemplate()) {
+      await this.createSkeletonPacks(databaseItem);
+    }
+
     return databaseItem;
   }
 
+  public async createSkeletonPacks(databaseItem: DatabaseItem) {
+    if (databaseItem === undefined) {
+      void this.logger.log(
+        "Could not create QL pack because no database is selected. Please add a database.",
+      );
+      return;
+    }
+
+    if (databaseItem.language === "") {
+      void this.logger.log(
+        "Could not create skeleton QL pack because the selected database's language is not set.",
+      );
+      return;
+    }
+
+    const folderName = `codeql-custom-queries-${databaseItem.language}`;
+    if (isFolderAlreadyInWorkspace(folderName)) {
+      return;
+    }
+
+    await showBinaryChoiceDialog(
+      `We've noticed you don't have a QL pack downloaded to analyze this database. Can we set up a ${databaseItem.language} query pack for you`,
+    );
+  }
+
   private async reregisterDatabases(
     progress: ProgressCallback,
     token: vscode.CancellationToken,

extensions/ql-vscode/src/helpers.ts

@@ -255,6 +255,15 @@ export function getOnDiskWorkspaceFolders() {
   return diskWorkspaceFolders;
 }
 
+/** Check if folder is already present in workspace */
+export function isFolderAlreadyInWorkspace(folderName: string) {
+  const workspaceFolders = workspace.workspaceFolders || [];
+
+  return !!workspaceFolders.find(
+    (workspaceFolder) => workspaceFolder.name === folderName,
+  );
+}
+
 /**
  * Provides a utility method to invoke a function only if a minimum time interval has elapsed since
  * the last invocation of that function.

extensions/ql-vscode/test/vscode-tests/minimal-workspace/config.test.ts

@@ -108,7 +108,7 @@ describe("config listeners", () => {
           await wait();
           const newValue = listener[setting.property as keyof typeof listener];
           expect(newValue).toEqual(setting.values[1]);
-          expect(onDidChangeConfiguration).toHaveBeenCalledTimes(1);
+          expect(onDidChangeConfiguration).toHaveBeenCalled();
         });
       });
     });