Ensure we're selecting database in single rooted workspace

After some testing of the wizard with a single rooted workspace
(`github/code-scanning`) we discovered a general VSCode extension
bug whereby after we download a database, we don't select it.

This isn't an issue in the wizard, but it does affect us as it means
we'll generate the QL pack, download the db for you but then you won't
know that we haven't selected your database.

So let's make sure our flow works for this case by explicitly selecting
the database once it's downloaded.

We've noticed by testing that we need to set the current database item
before we call `addDatabaseSourceArchiveFolder()`. Once that method is
called, the call to `setCurrentDatabaseItem()` is ignored.

We've had to make some changes to the openDatabase() method to select
a database item by default, since most places where we call `openDatabase()`
also immediately select the item.

There is one exception [1] in the test-runner.ts file, where we set the
current database item under special conditions.

For this reason, we've made the behaviour configurable and tried to add
some descriptive naming to the params so that it's easy to understand
what the config is doing.

[1]: https://github.com/github/vscode-codeql/blob/4170e7f7a7026b3ebcc75b7509dd55f317293a4d/extensions/ql-vscode/src/test-runner.ts#L120-L124

Author: elenatanasoiu

extensions/ql-vscode/src/databaseFetcher.ts

@@ -317,13 +317,15 @@ async function databaseArchiveFetcher(
     });
     await ensureZippedSourceLocation(dbPath);
 
+    const makeSelected = true;
+
     const item = await databaseManager.openDatabase(
       progress,
       token,
       Uri.file(dbPath),
+      makeSelected,
       nameOverride,
     );
-    await databaseManager.setCurrentDatabaseItem(item);
     return item;
   } else {
     throw new Error("Database not found in archive.");

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

@@ -307,17 +307,20 @@ export class DatabaseUI extends DisposableObject {
             );
 
             let databaseItem = this.databaseManager.findDatabaseItem(uri);
-            const isTutorialDatabase = true;
             if (databaseItem === undefined) {
+              const makeSelected = true;
+              const nameOverride = "CodeQL Tutorial Database";
+              const isTutorialDatabase = true;
+
               databaseItem = await this.databaseManager.openDatabase(
                 progress,
                 token,
                 uri,
-                "CodeQL Tutorial Database",
+                makeSelected,
+                nameOverride,
                 isTutorialDatabase,
               );
             }
-            await this.databaseManager.setCurrentDatabaseItem(databaseItem);
             await this.handleTourDependencies();
           }
         } catch (e) {
@@ -758,14 +761,17 @@ export class DatabaseUI extends DisposableObject {
     uri: Uri,
   ): Promise<DatabaseItem | undefined> {
     let databaseItem = this.databaseManager.findDatabaseItem(uri);
+
+    const makeSelected = true;
+
     if (databaseItem === undefined) {
       databaseItem = await this.databaseManager.openDatabase(
         progress,
         token,
         uri,
+        makeSelected,
       );
     }
-    await this.databaseManager.setCurrentDatabaseItem(databaseItem);
 
     return databaseItem;
   }

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

@@ -621,6 +621,7 @@ export class DatabaseManager extends DisposableObject {
     progress: ProgressCallback,
     token: vscode.CancellationToken,
     uri: vscode.Uri,
+    makeSelected = false,
     displayName?: string,
     isTutorialDatabase?: boolean,
   ): Promise<DatabaseItem> {
@@ -629,6 +630,7 @@ export class DatabaseManager extends DisposableObject {
     return await this.addExistingDatabaseItem(
       databaseItem,
       progress,
+      makeSelected,
       token,
       isTutorialDatabase,
     );
@@ -643,6 +645,7 @@ export class DatabaseManager extends DisposableObject {
   public async addExistingDatabaseItem(
     databaseItem: DatabaseItem,
     progress: ProgressCallback,
+    makeSelected = true,
     token: vscode.CancellationToken,
     isTutorialDatabase?: boolean,
   ): Promise<DatabaseItem> {
@@ -652,6 +655,9 @@ export class DatabaseManager extends DisposableObject {
     }
 
     await this.addDatabaseItem(progress, token, databaseItem);
+    if (makeSelected) {
+      await this.setCurrentDatabaseItem(databaseItem);
+    }
     await this.addDatabaseSourceArchiveFolder(databaseItem);
 
     if (isCodespacesTemplate() && !isTutorialDatabase) {

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

@@ -708,6 +708,7 @@ describe("local databases", () => {
   describe("openDatabase", () => {
     let createSkeletonPacksSpy: jest.SpyInstance;
     let resolveDatabaseContentsSpy: jest.SpyInstance;
+    let setCurrentDatabaseItemSpy: jest.SpyInstance;
     let addDatabaseSourceArchiveFolderSpy: jest.SpyInstance;
     let mockDbItem: DatabaseItemImpl;
 
@@ -722,6 +723,11 @@ describe("local databases", () => {
         .spyOn(DatabaseResolver, "resolveDatabaseContents")
         .mockResolvedValue({} as DatabaseContentsWithDbScheme);
 
+      setCurrentDatabaseItemSpy = jest.spyOn(
+        databaseManager,
+        "setCurrentDatabaseItem",
+      );
+
       addDatabaseSourceArchiveFolderSpy = jest.spyOn(
         databaseManager,
         "addDatabaseSourceArchiveFolder",
@@ -746,6 +752,19 @@ describe("local databases", () => {
       expect(resolveDatabaseContentsSpy).toBeCalledTimes(1);
     });
 
+    it("should set the database as the currently selected one", async () => {
+      const makeSelected = true;
+
+      await databaseManager.openDatabase(
+        {} as ProgressCallback,
+        {} as CancellationToken,
+        mockDbItem.databaseUri,
+        makeSelected,
+      );
+
+      expect(setCurrentDatabaseItemSpy).toBeCalledTimes(1);
+    });
+
     it("should add database source archive folder", async () => {
       await databaseManager.openDatabase(
         {} as ProgressCallback,
@@ -762,12 +781,15 @@ describe("local databases", () => {
           jest.spyOn(Setting.prototype, "getValue").mockReturnValue(true);
 
           const isTutorialDatabase = true;
+          const makeSelected = true;
+          const nameOverride = "CodeQL Tutorial Database";
 
           await databaseManager.openDatabase(
             {} as ProgressCallback,
             {} as CancellationToken,
             mockDbItem.databaseUri,
-            "CodeQL Tutorial Database",
+            makeSelected,
+            nameOverride,
             isTutorialDatabase,
           );