Merge branch 'main' into robertbrignull/logged_error_telemetry

Author: robertbrignull

extensions/ql-vscode/.eslintrc.js

@@ -49,7 +49,6 @@ const baseConfig = {
     "@typescript-eslint/no-throw-literal": "error",
     "no-useless-escape": 0,
     camelcase: "off",
-    eqeqeq: "off",
     "escompat/no-regexp-lookbehind": "off",
     "etc/no-implicit-any-catch": "error",
     "filenames/match-regex": "off",

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",
@@ -1483,7 +1483,7 @@
   "husky": {
     "hooks": {
       "pre-commit": "npm run format-staged",
-      "pre-push": "npm run lint && scripts/forbid-test-only"
+      "pre-push": "scripts/forbid-test-only"
     }
   },
   "lint-staged": {

extensions/ql-vscode/package.json

@@ -51,7 +51,7 @@ export abstract class AbstractWebview<
   }
 
   protected async getPanel(): Promise<WebviewPanel> {
-    if (this.panel == undefined) {
+    if (this.panel === undefined) {
       const { ctx } = this;
 
       // This is an async method, so in theory this method can be called concurrently. To ensure that we don't

extensions/ql-vscode/src/abstract-webview.ts

@@ -384,7 +384,7 @@ export class CodeQLCliServer implements Disposable {
         this.killProcessIfRunning();
         // Report the error (if there is a stderr then use that otherwise just report the error cod or nodejs error)
         const newError =
-          stderrBuffers.length == 0
+          stderrBuffers.length === 0
             ? new Error(`${description} failed: ${err}`)
             : new Error(
                 `${description} failed: ${Buffer.concat(stderrBuffers).toString(

extensions/ql-vscode/src/cli.ts

@@ -357,7 +357,7 @@ export class QueryServerConfigListener
     if (memory === null) {
       return undefined;
     }
-    if (memory == 0 || typeof memory !== "number") {
+    if (memory === 0 || typeof memory !== "number") {
       void extLogger.log(
         `Ignoring value '${memory}' for setting ${MEMORY_SETTING.qualifiedName}`,
       );
@@ -647,3 +647,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

@@ -128,9 +128,9 @@ function createTemplates(path: string): Record<string, string> {
 function isValidSelect(selectInfo: ResultSetSchema | undefined) {
   return (
     selectInfo &&
-    selectInfo.columns.length == 3 &&
-    selectInfo.columns[0].kind == ColumnKindCode.ENTITY &&
-    selectInfo.columns[1].kind == ColumnKindCode.ENTITY &&
-    selectInfo.columns[2].kind == ColumnKindCode.STRING
+    selectInfo.columns.length === 3 &&
+    selectInfo.columns[0].kind === ColumnKindCode.ENTITY &&
+    selectInfo.columns[1].kind === ColumnKindCode.ENTITY &&
+    selectInfo.columns[2].kind === ColumnKindCode.STRING
   );
 }

extensions/ql-vscode/src/contextual/locationFinder.ts

@@ -12,6 +12,7 @@ import {
   CancellationToken,
   ThemeIcon,
   ThemeColor,
+  workspace,
 } from "vscode";
 import { pathExists, stat, readdir, remove } from "fs-extra";
 
@@ -220,6 +221,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",
@@ -354,6 +364,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;