Merge pull request #2250 from github/elena/yer-a-wizard-query

Adapt skeleton pack generation to work with new queries panel

Author: elenatanasoiu

extensions/ql-vscode/package.json

@@ -361,6 +361,10 @@
         "command": "codeQL.quickQuery",
         "title": "CodeQL: Quick Query"
       },
+      {
+        "command": "codeQL.createSkeletonQuery",
+        "title": "CodeQL: Create Query"
+      },
       {
         "command": "codeQL.openDocumentation",
         "title": "CodeQL: Open Documentation"

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

@@ -99,6 +99,7 @@ export type LocalQueryCommands = {
   "codeQL.quickEvalContextEditor": (uri: Uri) => Promise<void>;
   "codeQL.codeLensQuickEval": (uri: Uri, range: Range) => Promise<void>;
   "codeQL.quickQuery": () => Promise<void>;
+  "codeQL.createSkeletonQuery": () => Promise<void>;
 };
 
 export type ResultsViewCommands = {

extensions/ql-vscode/src/databaseFetcher.ts

@@ -78,6 +78,10 @@ export async function promptImportInternetDatabase(
  *
  * @param databaseManager the DatabaseManager
  * @param storagePath where to store the unzipped database.
+ * @param credentials the credentials to use to authenticate with GitHub
+ * @param progress the progress callback
+ * @param token the cancellation token
+ * @param cli the CodeQL CLI server
  */
 export async function promptImportGithubDatabase(
   commandManager: AppCommandManager,
@@ -103,6 +107,49 @@ export async function promptImportGithubDatabase(
     return;
   }
 
+  const databaseItem = await downloadGitHubDatabase(
+    githubRepo,
+    databaseManager,
+    storagePath,
+    credentials,
+    progress,
+    token,
+    cli,
+  );
+
+  if (databaseItem) {
+    await commandManager.execute("codeQLDatabases.focus");
+    void showAndLogInformationMessage(
+      "Database downloaded and imported successfully.",
+    );
+    return databaseItem;
+  }
+
+  return;
+}
+
+/**
+ * Downloads a database from GitHub
+ *
+ * @param githubRepo the GitHub repository to download the database from
+ * @param databaseManager the DatabaseManager
+ * @param storagePath where to store the unzipped database.
+ * @param credentials the credentials to use to authenticate with GitHub
+ * @param progress the progress callback
+ * @param token the cancellation token
+ * @param cli the CodeQL CLI server
+ * @param language the language to download. If undefined, the user will be prompted to choose a language.
+ **/
+export async function downloadGitHubDatabase(
+  githubRepo: string,
+  databaseManager: DatabaseManager,
+  storagePath: string,
+  credentials: Credentials | undefined,
+  progress: ProgressCallback,
+  token: CancellationToken,
+  cli?: CodeQLCliServer,
+  language?: string,
+): Promise<DatabaseItem | undefined> {
   const nwo = getNwoFromGitHubUrl(githubRepo) || githubRepo;
   if (!isValidGitHubNwo(nwo)) {
     throw new Error(`Invalid GitHub repository: ${githubRepo}`);
@@ -112,7 +159,12 @@ export async function promptImportGithubDatabase(
     ? await credentials.getOctokit()
     : new Octokit.Octokit({ retry });
 
-  const result = await convertGithubNwoToDatabaseUrl(nwo, octokit, progress);
+  const result = await convertGithubNwoToDatabaseUrl(
+    nwo,
+    octokit,
+    progress,
+    language,
+  );
   if (!result) {
     return;
   }
@@ -130,7 +182,7 @@ export async function promptImportGithubDatabase(
    * We only need the actual token string.
    */
   const octokitToken = ((await octokit.auth()) as { token: string })?.token;
-  const item = await databaseArchiveFetcher(
+  return await databaseArchiveFetcher(
     databaseUrl,
     {
       Accept: "application/zip",
@@ -143,14 +195,6 @@ export async function promptImportGithubDatabase(
     token,
     cli,
   );
-  if (item) {
-    await commandManager.execute("codeQLDatabases.focus");
-    void showAndLogInformationMessage(
-      "Database downloaded and imported successfully.",
-    );
-    return item;
-  }
-  return;
 }
 
 /**
@@ -450,6 +494,7 @@ export async function convertGithubNwoToDatabaseUrl(
   nwo: string,
   octokit: Octokit.Octokit,
   progress: ProgressCallback,
+  language?: string,
 ): Promise<
   | {
       databaseUrl: string;
@@ -468,9 +513,11 @@ export async function convertGithubNwoToDatabaseUrl(
 
     const languages = response.data.map((db: any) => db.language);
 
-    const language = await promptForLanguage(languages, progress);
-    if (!language) {
-      return;
+    if (!language || !languages.includes(language)) {
+      language = await promptForLanguage(languages, progress);
+      if (!language) {
+        return;
+      }
     }
 
     return {
@@ -484,7 +531,7 @@ export async function convertGithubNwoToDatabaseUrl(
   }
 }
 
-async function promptForLanguage(
+export async function promptForLanguage(
   languages: string[],
   progress: ProgressCallback,
 ): Promise<string | undefined> {

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

@@ -897,6 +897,20 @@ export class DatabaseManager extends DisposableObject {
     }
   }
 
+  public async digForDatabaseItem(
+    language: string,
+    databaseNwo: string,
+  ): Promise<DatabaseItem | undefined> {
+    const dbItems = this.databaseItems || [];
+    const dbs = dbItems.filter(
+      (db) => db.language === language && db.name === databaseNwo,
+    );
+    if (dbs.length === 0) {
+      return undefined;
+    }
+    return dbs[0];
+  }
+
   /**
    * Returns the index of the workspace folder that corresponds to the source archive of `item`
    * if there is one, and -1 otherwise.

extensions/ql-vscode/src/local-queries.ts

@@ -8,7 +8,7 @@ import {
   window,
 } from "vscode";
 import { BaseLogger, extLogger, Logger, TeeLogger } from "./common";
-import { MAX_QUERIES } from "./config";
+import { isCanary, MAX_QUERIES } from "./config";
 import { gatherQlFiles } from "./pure/files";
 import { basename } from "path";
 import {
@@ -51,6 +51,7 @@ import { App } from "./common/app";
 import { DisposableObject } from "./pure/disposable-object";
 import { QueryResultType } from "./pure/new-messages";
 import { redactableError } from "./pure/errors";
+import { SkeletonQueryWizard } from "./skeleton-query-wizard";
 
 interface DatabaseQuickPickItem extends QuickPickItem {
   databaseItem: DatabaseItem;
@@ -237,6 +238,7 @@ export class LocalQueries extends DisposableObject {
       "codeQL.quickEvalContextEditor": this.quickEval.bind(this),
       "codeQL.codeLensQuickEval": this.codeLensQuickEval.bind(this),
       "codeQL.quickQuery": this.quickQuery.bind(this),
+      "codeQL.createSkeletonQuery": this.createSkeletonQuery.bind(this),
     };
   }
 
@@ -375,6 +377,26 @@ export class LocalQueries extends DisposableObject {
     );
   }
 
+  private async createSkeletonQuery(): Promise<void> {
+    await withProgress(
+      async (progress: ProgressCallback, token: CancellationToken) => {
+        const credentials = isCanary() ? this.app.credentials : undefined;
+        const skeletonQueryWizard = new SkeletonQueryWizard(
+          this.cliServer,
+          progress,
+          credentials,
+          extLogger,
+          this.databaseManager,
+          token,
+        );
+        await skeletonQueryWizard.execute();
+      },
+      {
+        title: "Create Query",
+      },
+    );
+  }
+
   /**
    * Creates a new `LocalQueryRun` object to track a query evaluation. This creates a timestamp
    * file in the query's output directory, creates a `LocalQueryInfo` object, and registers that

extensions/ql-vscode/src/qlpack-generator.ts

@@ -66,8 +66,8 @@ export class QlPackGenerator {
     await writeFile(qlPackFilePath, this.header + dump(qlPackYml), "utf8");
   }
 
-  private async createExampleQlFile() {
-    const exampleQlFilePath = join(this.folderUri.fsPath, "example.ql");
+  public async createExampleQlFile(fileName = "example.ql") {
+    const exampleQlFilePath = join(this.folderUri.fsPath, fileName);
 
     const exampleQl = `
 /**