Merge pull request #2080 from github/shati-elena/fix-database-prompt

Don't offer to create skeleton pack for default database in CodeTour

Author: elenatanasoiu

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

@@ -379,11 +379,14 @@ export class DatabaseUI extends DisposableObject {
         );
 
         let databaseItem = this.databaseManager.findDatabaseItem(uri);
+        const isTutorialDatabase = true;
         if (databaseItem === undefined) {
           databaseItem = await this.databaseManager.openDatabase(
             progress,
             token,
             uri,
+            "CodeQL Tutorial Database",
+            isTutorialDatabase,
           );
         }
         await this.databaseManager.setCurrentDatabaseItem(databaseItem);

extensions/ql-vscode/src/databases.ts

@@ -606,6 +606,7 @@ export class DatabaseManager extends DisposableObject {
     token: vscode.CancellationToken,
     uri: vscode.Uri,
     displayName?: string,
+    isTutorialDatabase?: boolean,
   ): Promise<DatabaseItem> {
     const contents = await DatabaseResolver.resolveDatabaseContents(uri);
     // Ignore the source archive for QLTest databases by default.
@@ -629,7 +630,7 @@ export class DatabaseManager extends DisposableObject {
     await this.addDatabaseItem(progress, token, databaseItem);
     await this.addDatabaseSourceArchiveFolder(databaseItem);
 
-    if (isCodespacesTemplate()) {
+    if (isCodespacesTemplate() && !isTutorialDatabase) {
       await this.createSkeletonPacks(databaseItem);
     }
 

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

@@ -711,16 +711,36 @@ describe("databases", () => {
     });
 
     describe("when codeQL.codespacesTemplate is set to true", () => {
-      it("should create a skeleton QL pack", async () => {
-        jest.spyOn(Setting.prototype, "getValue").mockReturnValue(true);
+      describe("when we add the tutorial database to the codespace", () => {
+        it("should not offer to create a skeleton QL pack", async () => {
+          jest.spyOn(Setting.prototype, "getValue").mockReturnValue(true);
 
-        await databaseManager.openDatabase(
-          {} as ProgressCallback,
-          {} as CancellationToken,
-          mockDbItem.databaseUri,
-        );
+          const isTutorialDatabase = true;
+
+          await databaseManager.openDatabase(
+            {} as ProgressCallback,
+            {} as CancellationToken,
+            mockDbItem.databaseUri,
+            "CodeQL Tutorial Database",
+            isTutorialDatabase,
+          );
 
-        expect(createSkeletonPacksSpy).toBeCalledTimes(1);
+          expect(createSkeletonPacksSpy).toBeCalledTimes(0);
+        });
+      });
+
+      describe("when we add a new database that isn't the tutorial one", () => {
+        it("should create a skeleton QL pack", async () => {
+          jest.spyOn(Setting.prototype, "getValue").mockReturnValue(true);
+
+          await databaseManager.openDatabase(
+            {} as ProgressCallback,
+            {} as CancellationToken,
+            mockDbItem.databaseUri,
+          );
+
+          expect(createSkeletonPacksSpy).toBeCalledTimes(1);
+        });
       });
     });