Show the user a selection box before downloading database

At the moment, we're always deciding which database to download for the
user for an example query.

We'd like to give them a chance to change the database, so here we're
adding a step where we're showing the user a selection box with the
suggested database pre-filled.

They can choose to type in a different database before continuing the
skeleton generation process.

Author: elenatanasoiu

extensions/ql-vscode/src/databaseFetcher.ts

@@ -1,7 +1,7 @@
 import fetch, { Response } from "node-fetch";
 import { zip } from "zip-a-folder";
 import { Open } from "unzipper";
-import { Uri, CancellationToken, window } from "vscode";
+import { Uri, CancellationToken, window, InputBoxOptions } from "vscode";
 import { CodeQLCliServer } from "./cli";
 import {
   ensureDir,
@@ -92,17 +92,7 @@ export async function promptImportGithubDatabase(
   token: CancellationToken,
   cli?: CodeQLCliServer,
 ): Promise<DatabaseItem | undefined> {
-  progress({
-    message: "Choose repository",
-    step: 1,
-    maxStep: 2,
-  });
-  const githubRepo = await window.showInputBox({
-    title:
-      'Enter a GitHub repository URL or "name with owner" (e.g. https://github.com/github/codeql or github/codeql)',
-    placeHolder: "https://github.com/<owner>/<repo> or <owner>/<repo>",
-    ignoreFocusOut: true,
-  });
+  const githubRepo = await askForGitHubRepo(progress);
   if (!githubRepo) {
     return;
   }
@@ -128,6 +118,30 @@ export async function promptImportGithubDatabase(
   return;
 }
 
+export async function askForGitHubRepo(
+  progress: ProgressCallback,
+  suggestedValue?: string,
+): Promise<string | undefined> {
+  progress({
+    message: "Choose repository",
+    step: 1,
+    maxStep: 2,
+  });
+
+  const options: InputBoxOptions = {
+    title:
+      'Enter a GitHub repository URL or "name with owner" (e.g. https://github.com/github/codeql or github/codeql)',
+    placeHolder: "https://github.com/<owner>/<repo> or <owner>/<repo>",
+    ignoreFocusOut: true,
+  };
+
+  if (suggestedValue) {
+    options.value = suggestedValue;
+  }
+
+  return await window.showInputBox(options);
+}
+
 /**
  * Downloads a database from GitHub
  *

extensions/ql-vscode/src/skeleton-query-wizard.ts

@@ -201,9 +201,17 @@ export class SkeletonQueryWizard {
     });
 
     const githubRepoNwo = this.QUERY_LANGUAGE_TO_DATABASE_REPO[this.language];
+    const chosenRepo = await databaseFetcher.askForGitHubRepo(
+      this.progress,
+      githubRepoNwo,
+    );
+
+    if (!chosenRepo) {
+      throw new Error("No GitHub repository provided");
+    }
 
     await databaseFetcher.downloadGitHubDatabase(
-      githubRepoNwo,
+      chosenRepo,
       this.databaseManager,
       this.storagePath,
       this.credentials,

extensions/ql-vscode/test/vscode-tests/cli-integration/skeleton-query-wizard.test.ts

@@ -29,13 +29,17 @@ describe("SkeletonQueryWizard", () => {
   let createExampleQlFileSpy: jest.SpiedFunction<
     typeof QlPackGenerator.prototype.createExampleQlFile
   >;
-  let chosenLanguage: string;
   let downloadGitHubDatabaseSpy: jest.SpiedFunction<
     typeof databaseFetcher.downloadGitHubDatabase
   >;
+  let askForGitHubRepoSpy: jest.SpiedFunction<
+    typeof databaseFetcher.askForGitHubRepo
+  >;
   let openTextDocumentSpy: jest.SpiedFunction<
     typeof workspace.openTextDocument
   >;
+  let chosenLanguage: string;
+  let suggestedGitHubRepo: string;
 
   beforeEach(async () => {
     dir = tmp.dirSync({
@@ -107,6 +111,13 @@ describe("SkeletonQueryWizard", () => {
       mockDatabaseManager,
       token,
     );
+
+    suggestedGitHubRepo =
+      wizard.QUERY_LANGUAGE_TO_DATABASE_REPO[chosenLanguage];
+
+    askForGitHubRepoSpy = jest
+      .spyOn(databaseFetcher, "askForGitHubRepo")
+      .mockResolvedValue(suggestedGitHubRepo);
   });
 
   afterEach(() => {
@@ -293,10 +304,30 @@ describe("SkeletonQueryWizard", () => {
           .mockResolvedValue(undefined);
       });
 
-      it("should download a new database for language", async () => {
-        await wizard.execute();
+      describe("if the user choses to downloaded the suggested database from GitHub", () => {
+        it("should download a new database for language", async () => {
+          await wizard.execute();
+
+          expect(askForGitHubRepoSpy).toHaveBeenCalled();
+          expect(downloadGitHubDatabaseSpy).toHaveBeenCalled();
+        });
+      });
+
+      describe("if the user choses to download a different database from GitHub than the one suggested", () => {
+        beforeEach(() => {
+          const chosenGitHubRepo = "pickles-owner/pickles-repo";
+
+          askForGitHubRepoSpy = jest
+            .spyOn(databaseFetcher, "askForGitHubRepo")
+            .mockResolvedValue(chosenGitHubRepo);
+        });
+
+        it("should download the newly chosen database", async () => {
+          await wizard.execute();
 
-        expect(downloadGitHubDatabaseSpy).toHaveBeenCalled();
+          expect(askForGitHubRepoSpy).toHaveBeenCalled();
+          expect(downloadGitHubDatabaseSpy).toHaveBeenCalled();
+        });
       });
     });
   });