Merge remote-tracking branch 'origin/main' into koesie10/fix-no-error-empty-repositories

Author: koesie10

README.md

@@ -20,6 +20,13 @@ To see what has changed in the last few versions of the extension, see the [Chan
 
 This project will track new feature development in CodeQL and, whenever appropriate, bring that functionality to the Visual Studio Code experience.
 
+## Dependencies
+
+This extension depends on the following two extensions for required functionality. They will be installed automatically when you install VS Code CodeQL.
+
+- [Test Adapter Converter](https://marketplace.visualstudio.com/items?itemName=ms-vscode.test-adapter-converter)
+- [Test Explorer UI](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer)
+
 ## Contributing
 
 This project welcomes contributions. See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to build, install, and contribute.

extensions/ql-vscode/README.md

@@ -16,7 +16,9 @@ For information about other configurations, see the separate [CodeQL help](https
 
 ### Quick start: Installing and configuring the extension
 
-1. [Install the extension](#installing-the-extension).
+1. [Install the extension](#installing-the-extension).  
+   *Note: vscode-codeql installs the following dependencies for required functionality: [Test Adapter Converter](https://marketplace.visualstudio.com/items?itemName=ms-vscode.test-adapter-converter), [Test Explorer UI](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer).*
+
 1. [Check access to the CodeQL CLI](#checking-access-to-the-codeql-cli).
 1. [Clone the CodeQL starter workspace](#cloning-the-codeql-starter-workspace).
 

extensions/ql-vscode/package-lock.json

@@ -61,6 +61,8 @@
     "onCommand:codeQL.chooseDatabaseLgtm",
     "onCommand:codeQLDatabases.chooseDatabase",
     "onCommand:codeQLDatabases.setCurrentDatabase",
+    "onCommand:codeQLDatabasesExperimental.openConfigFile",
+    "onCommand:codeQLDatabasesExperimental.setSelectedItem",
     "onCommand:codeQL.quickQuery",
     "onCommand:codeQL.restartQueryServer",
     "onWebviewPanel:resultsView",
@@ -364,6 +366,11 @@
           "dark": "media/dark/edit.svg"
         }
       },
+      {
+        "command": "codeQLDatabasesExperimental.setSelectedItem",
+        "title": "Select Item",
+        "icon": "$(circle-small-filled)"
+      },
       {
         "command": "codeQLDatabases.chooseDatabaseFolder",
         "title": "Choose Database from Folder",
@@ -795,6 +802,11 @@
           "group": "9_qlCommands",
           "when": "view == codeQLDatabases"
         },
+        {
+          "command": "codeQLDatabasesExperimental.setSelectedItem",
+          "when": "view == codeQLDatabasesExperimental && viewItem == selectableDbItem",
+          "group": "inline"
+        },
         {
           "command": "codeQLQueryHistory.openQuery",
           "group": "9_qlCommands",
@@ -985,6 +997,10 @@
           "command": "codeQLDatabasesExperimental.openConfigFile",
           "when": "false"
         },
+        {
+          "command": "codeQLDatabasesExperimental.setSelectedItem",
+          "when": "false"
+        },
         {
           "command": "codeQLDatabases.setCurrentDatabase",
           "when": "false"

extensions/ql-vscode/package.json

@@ -1,6 +1,11 @@
 import { pathExists, writeJSON, readJSON, readJSONSync } from "fs-extra";
 import { join } from "path";
-import { cloneDbConfig, DbConfig } from "./db-config";
+import {
+  cloneDbConfig,
+  DbConfig,
+  ExpandedDbItem,
+  SelectedDbItem,
+} from "./db-config";
 import * as chokidar from "chokidar";
 import { DisposableObject, DisposeHandler } from "../../pure/disposable-object";
 import { DbConfigValidator } from "./db-config-validator";
@@ -56,11 +61,44 @@ export class DbConfigStore extends DisposableObject {
     return this.configPath;
   }
 
+  public async setSelectedDbItem(dbItem: SelectedDbItem): Promise<void> {
+    if (!this.config) {
+      // If the app is trying to set the selected item without a config
+      // being set it means that there is a bug in our code, so we throw
+      // an error instead of just returning an error result.
+      throw Error("Cannot select database item if config is not loaded");
+    }
+
+    const config: DbConfig = {
+      ...this.config,
+      selected: dbItem,
+    };
+
+    await this.writeConfig(config);
+  }
+
+  public async updateExpandedState(expandedItems: ExpandedDbItem[]) {
+    if (!this.config) {
+      throw Error("Cannot update expansion state if config is not loaded");
+    }
+
+    const config: DbConfig = {
+      ...this.config,
+      expanded: expandedItems,
+    };
+
+    await this.writeConfig(config);
+  }
+
+  private async writeConfig(config: DbConfig): Promise<void> {
+    await writeJSON(this.configPath, config, {
+      spaces: 2,
+    });
+  }
+
   private async loadConfig(): Promise<void> {
     if (!(await pathExists(this.configPath))) {
-      await writeJSON(this.configPath, this.createEmptyConfig(), {
-        spaces: 2,
-      });
+      await this.writeConfig(this.createEmptyConfig());
     }
 
     await this.readConfig();
@@ -117,6 +155,7 @@ export class DbConfigStore extends DisposableObject {
           databases: [],
         },
       },
+      expanded: [],
     };
   }
 }

extensions/ql-vscode/src/databases/config/db-config-store.ts

@@ -2,6 +2,7 @@
 
 export interface DbConfig {
   databases: DbConfigDatabases;
+  expanded: ExpandedDbItem[];
   selected?: SelectedDbItem;
 }
 
@@ -87,6 +88,37 @@ export interface LocalDatabase {
   storagePath: string;
 }
 
+export type ExpandedDbItem =
+  | RootLocalExpandedDbItem
+  | LocalUserDefinedListExpandedDbItem
+  | RootRemoteExpandedDbItem
+  | RemoteUserDefinedListExpandedDbItem;
+
+export enum ExpandedDbItemKind {
+  RootLocal = "rootLocal",
+  LocalUserDefinedList = "localUserDefinedList",
+  RootRemote = "rootRemote",
+  RemoteUserDefinedList = "remoteUserDefinedList",
+}
+
+export interface RootLocalExpandedDbItem {
+  kind: ExpandedDbItemKind.RootLocal;
+}
+
+export interface LocalUserDefinedListExpandedDbItem {
+  kind: ExpandedDbItemKind.LocalUserDefinedList;
+  listName: string;
+}
+
+export interface RootRemoteExpandedDbItem {
+  kind: ExpandedDbItemKind.RootRemote;
+}
+
+export interface RemoteUserDefinedListExpandedDbItem {
+  kind: ExpandedDbItemKind.RemoteUserDefinedList;
+  listName: string;
+}
+
 export function cloneDbConfig(config: DbConfig): DbConfig {
   return {
     databases: {
@@ -108,6 +140,7 @@ export function cloneDbConfig(config: DbConfig): DbConfig {
         databases: config.databases.local.databases.map((db) => ({ ...db })),
       },
     },
+    expanded: config.expanded.map(cloneDbConfigExpandedItem),
     selected: config.selected
       ? cloneDbConfigSelectedItem(config.selected)
       : undefined,
@@ -150,3 +183,17 @@ function cloneDbConfigSelectedItem(selected: SelectedDbItem): SelectedDbItem {
       };
   }
 }
+
+function cloneDbConfigExpandedItem(item: ExpandedDbItem): ExpandedDbItem {
+  switch (item.kind) {
+    case ExpandedDbItemKind.RootLocal:
+    case ExpandedDbItemKind.RootRemote:
+      return { kind: item.kind };
+    case ExpandedDbItemKind.LocalUserDefinedList:
+    case ExpandedDbItemKind.RemoteUserDefinedList:
+      return {
+        kind: item.kind,
+        listName: item.listName,
+      };
+  }
+}