Merge remote-tracking branch 'origin/main' into koesie10/mocked-config

Author: koesie10

extensions/ql-vscode/CHANGELOG.md

@@ -2,7 +2,9 @@
 
 ## [UNRELEASED]
 
-- Renamed command "CodeQL: Run Query" to "CodeQL: Run Query on Selected Dababase".
+## 1.7.8 - 2 February 2023
+
+- Renamed command "CodeQL: Run Query" to "CodeQL: Run Query on Selected Database". [#1962](https://github.com/github/vscode-codeql/pull/1962)
 - Remove support for CodeQL CLI versions older than 2.7.6. [#1788](https://github.com/github/vscode-codeql/pull/1788)
 
 ## 1.7.7 - 13 December 2022

extensions/ql-vscode/databases-schema.json

@@ -4,6 +4,9 @@
     "$schema": {
       "type": "string"
     },
+    "version": {
+      "type": "integer"
+    },
     "databases": {
       "type": "object",
       "properties": {
@@ -119,6 +122,6 @@
       ]
     }
   },
-  "required": ["databases"],
+  "required": ["databases", "version"],
   "additionalProperties": false
 }

extensions/ql-vscode/package-lock.json

@@ -4,7 +4,7 @@
   "description": "CodeQL for Visual Studio Code",
   "author": "GitHub",
   "private": true,
-  "version": "1.7.8",
+  "version": "1.7.9",
   "publisher": "GitHub",
   "license": "MIT",
   "icon": "media/VS-marketplace-CodeQL-icon.png",

extensions/ql-vscode/package.json

@@ -638,3 +638,16 @@ export class MockGitHubApiConfigListener
 export function getMockGitHubApiServerScenariosPath(): string | undefined {
   return MOCK_GH_API_SERVER_SCENARIOS_PATH.getValue<string>();
 }
+
+/**
+ * Enables features that are specific to the codespaces-codeql template workspace from
+ * https://github.com/github/codespaces-codeql.
+ */
+export const CODESPACES_TEMPLATE = new Setting(
+  "codespacesTemplate",
+  ROOT_SETTING,
+);
+
+export function isCodespacesTemplate() {
+  return !!CODESPACES_TEMPLATE.getValue<boolean>();
+}

extensions/ql-vscode/src/config.ts

@@ -12,6 +12,7 @@ import {
   CancellationToken,
   ThemeIcon,
   ThemeColor,
+  workspace,
 } from "vscode";
 import { pathExists, stat, readdir, remove } from "fs-extra";
 
@@ -218,6 +219,15 @@ export class DatabaseUI extends DisposableObject {
         },
       ),
     );
+    this.push(
+      commandRunnerWithProgress(
+        "codeQL.setDefaultTourDatabase",
+        this.handleSetDefaultTourDatabase,
+        {
+          title: "Set Default Database for Codespace CodeQL Tour",
+        },
+      ),
+    );
     this.push(
       commandRunnerWithProgress(
         "codeQL.upgradeCurrentDatabase",
@@ -348,6 +358,40 @@ export class DatabaseUI extends DisposableObject {
     }
   };
 
+  private handleSetDefaultTourDatabase = async (
+    progress: ProgressCallback,
+    token: CancellationToken,
+  ): Promise<void> => {
+    try {
+      if (!workspace.workspaceFolders?.length) {
+        throw new Error("No workspace folder is open.");
+      } else {
+        // This specifically refers to the database folder in
+        // https://github.com/github/codespaces-codeql
+        const uri = Uri.parse(
+          `${workspace.workspaceFolders[0].uri}/codeql-tutorial-database`,
+        );
+
+        let databaseItem = this.databaseManager.findDatabaseItem(uri);
+        if (databaseItem === undefined) {
+          databaseItem = await this.databaseManager.openDatabase(
+            progress,
+            token,
+            uri,
+          );
+        }
+        await this.databaseManager.setCurrentDatabaseItem(databaseItem);
+      }
+    } catch (e) {
+      // rethrow and let this be handled by default error handling.
+      throw new Error(
+        `Could not set the database for the Code Tour. Please make sure you are using the default workspace in your codespace: ${getErrorMessage(
+          e,
+        )}`,
+      );
+    }
+  };
+
   handleRemoveOrphanedDatabases = async (): Promise<void> => {
     void extLogger.log("Removing orphaned databases from workspace storage.");
     let dbDirs = undefined;

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

@@ -14,6 +14,7 @@ import {
   renameLocalList,
   renameRemoteList,
   SelectedDbItem,
+  DB_CONFIG_VERSION,
 } from "./db-config";
 import * as chokidar from "chokidar";
 import { DisposableObject, DisposeHandler } from "../../pure/disposable-object";
@@ -459,6 +460,7 @@ export class DbConfigStore extends DisposableObject {
 
   private createEmptyConfig(): DbConfig {
     return {
+      version: DB_CONFIG_VERSION,
       databases: {
         variantAnalysis: {
           repositoryLists: [],

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

@@ -1,6 +1,10 @@
-// Contains models for the data we want to store in the database config
+// Contains models and consts for the data we want to store in the database config.
+// Changes to these models should be done carefully and account for backwards compatibility of data.
+
+export const DB_CONFIG_VERSION = 1;
 
 export interface DbConfig {
+  version: number;
   databases: DbConfigDatabases;
   selected?: SelectedDbItem;
 }
@@ -89,6 +93,7 @@ export interface LocalDatabase {
 
 export function cloneDbConfig(config: DbConfig): DbConfig {
   return {
+    version: config.version,
     databases: {
       variantAnalysis: {
         repositoryLists: config.databases.variantAnalysis.repositoryLists.map(

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

@@ -5,6 +5,7 @@ import {
   LocalList,
   RemoteRepositoryList,
   SelectedDbItem,
+  DB_CONFIG_VERSION,
 } from "../../src/databases/config/db-config";
 
 export function createDbConfig({
@@ -23,6 +24,7 @@ export function createDbConfig({
   selected?: SelectedDbItem;
 } = {}): DbConfig {
   return {
+    version: DB_CONFIG_VERSION,
     databases: {
       variantAnalysis: {
         repositoryLists: remoteLists,

extensions/ql-vscode/test/factories/db-config-factories.ts

@@ -1,4 +1,5 @@
 {
+  "version": 1,
   "databases": {
     "variantAnalysis": {
       "repositoryLists": [