Merge branch 'main' into koesie10/retry-tests

Author: koesie10

.github/workflows/release.yml

@@ -94,6 +94,23 @@ jobs:
           asset_name: ${{ format('vscode-codeql-{0}.vsix', steps.prepare-artifacts.outputs.ref_name) }}
           asset_content_type: application/zip
 
+      - name: Create sourcemap ZIP file
+        run: |
+          cd dist/vscode-codeql/out
+          zip -r ../../vscode-codeql-sourcemaps.zip *.map
+
+      - name: Upload sourcemap ZIP file
+        uses: actions/upload-release-asset@v1.0.1
+        if: success()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          # Get the `upload_url` from the `create-release` step above.
+          upload_url: ${{ steps.create-release.outputs.upload_url }}
+          asset_path: dist/vscode-codeql-sourcemaps.zip
+          asset_name: ${{ format('vscode-codeql-sourcemaps-{0}.zip', steps.prepare-artifacts.outputs.ref_name) }}
+          asset_content_type: application/zip
+
       ###
       # Do Post release work: version bump and changelog PR
       # Only do this if we are running from a PR (ie- this is part of the release process)

.vscode/settings.json

@@ -48,6 +48,14 @@
     "env": {
       "LANG": "en-US",
       "TZ": "UTC",
+
+      // Uncomment to set a custom path to a CodeQL checkout.
+      // "TEST_CODEQL_PATH": "../codeql",
+
+      // Uncomment to set a custom path to a CodeQL CLI executable.
+      // This is the CodeQL version that will be used in the tests.
+      // "CLI_PATH": "/path/to/customg/codeql",
+
       // Uncomment to debug integration tests
       // "VSCODE_WAIT_FOR_DEBUGGER": "true",
     }

CONTRIBUTING.md

@@ -99,10 +99,10 @@ We have several types of tests:
 * View tests: these live in `src/view/variant-analysis/__tests__/`
 * VSCode integration tests:
   * `test/vscode-tests/activated-extension` tests: These are intended to cover functionality that require the full extension to be activated but don't require the CLI. This suite is not run against multiple versions of the CLI in CI.
-  * `test/vscode-tests/no-workspace` tests: These are intended to cover functionality that is meant to work before you even have a workspace open but don't require the extension to be activated.
+  * `test/vscode-tests/no-workspace` tests: These are intended to cover functionality around not having a workspace. The extension is not activated in these tests.
   * `test/vscode-tests/minimal-workspace` tests: These are intended to cover functionality that need a workspace but don't require the full extension to be activated.
 * CLI integration tests: these live in `test/vscode-tests/cli-integration`
-  * These tests are intended to be cover functionality that is related to the integration between the CodeQL CLI and the extension. These tests are run against all supported versions of the CLI in CI.
+  * These tests are intended to cover functionality that is related to the integration between the CodeQL CLI and the extension. These tests are run against each supported versions of the CLI in CI.
 
 The CLI integration tests require an instance of the CodeQL CLI to run so they will require some extra setup steps. When adding new tests to our test suite, please be mindful of whether they need to be in the cli-integration folder. If the tests don't depend on the CLI, they are better suited to being a VSCode integration test.
 
@@ -229,6 +229,13 @@ Pre-recorded scenarios are stored in `./src/mocks/scenarios`. However, it's poss
 1. Double-check the `CHANGELOG.md` contains all desired change comments and has the version to be released with date at the top.
     * Go through all recent PRs and make sure they are properly accounted for.
     * Make sure all changelog entries have links back to their PR(s) if appropriate.
+    * For picking the new version number, we default to increasing the patch version number, but make our own judgement about whether a change is big enough to warrant a minor version bump. Common reasons for a minor bump could include:
+      * Making substantial new features available to all users. This can include lifting a feature flag.
+      * Breakage in compatibility with recent versions of the CLI.
+      * Minimum required version of VS Code is increased.
+      * New telemetry events are added.
+      * Deprecation or removal of commands.
+      * Accumulation of many changes, none of which are individually big enough to warrant a minor bump, but which together are. This does not include changes which are purely internal to the extension, such as refactoring, or which are only available behind a feature flag.
 1. Double-check that the node version we're using matches the one used for VS Code. If it doesn't, you will then need to update the node version in the following files:
     * `.nvmrc` - this will enable `nvm` to automatically switch to the correct node version when you're in the project folder
     * `.github/workflows/main.yml` - all the "node-version: <version>" settings

extensions/ql-vscode/package.json

@@ -364,8 +364,8 @@
       },
       {
         "command": "codeQLVariantAnalysisRepositories.openConfigFile",
-        "title": "Open Database Configuration File",
-        "icon": "$(edit)"
+        "title": "Open database configuration file",
+        "icon": "$(json)"
       },
       {
         "command": "codeQLVariantAnalysisRepositories.addNewDatabase",
@@ -379,7 +379,7 @@
       },
       {
         "command": "codeQLVariantAnalysisRepositories.setSelectedItem",
-        "title": "✓"
+        "title": "Select"
       },
       {
         "command": "codeQLVariantAnalysisRepositories.setSelectedItemContextMenu",
@@ -463,7 +463,7 @@
       },
       {
         "command": "codeQLDatabases.setCurrentDatabase",
-        "title": "Set Current Database"
+        "title": "Select"
       },
       {
         "command": "codeQLDatabases.removeDatabase",
@@ -822,7 +822,7 @@
         },
         {
           "command": "codeQLVariantAnalysisRepositories.setSelectedItem",
-          "when": "view == codeQLVariantAnalysisRepositories && viewItem =~ /canBeSelected/ && false",
+          "when": "view == codeQLVariantAnalysisRepositories && viewItem =~ /canBeSelected/",
           "group": "inline"
         },
         {
@@ -1326,7 +1326,7 @@
   "scripts": {
     "build": "gulp",
     "watch": "gulp watch",
-    "test": "npm-run-all -p test:*",
+    "test": "npm-run-all test:*",
     "test:unit": "cross-env TZ=UTC LANG=en-US jest --projects test/unit-tests",
     "test:view": "jest --projects src/view",
     "test:vscode-integration": "npm-run-all test:vscode-integration:*",

extensions/ql-vscode/scripts/source-map.ts

@@ -20,6 +20,7 @@ import { spawnSync } from "child_process";
 import { basename, resolve } from "path";
 import { pathExists, readJSON } from "fs-extra";
 import { RawSourceMap, SourceMapConsumer } from "source-map";
+import { Open } from "unzipper";
 
 if (process.argv.length !== 4) {
   console.error(
@@ -36,6 +37,12 @@ const versionNumber = process.argv[2].startsWith("v")
 const stacktrace = process.argv[3];
 
 async function extractSourceMap() {
+  const releaseAssetsDirectory = resolve(
+    __dirname,
+    "..",
+    "release-assets",
+    versionNumber,
+  );
   const sourceMapsDirectory = resolve(
     __dirname,
     "..",
@@ -47,34 +54,64 @@ async function extractSourceMap() {
   if (!(await pathExists(sourceMapsDirectory))) {
     console.log("Downloading source maps...");
 
-    const workflowRuns = runGhJSON<WorkflowRunListItem[]>([
-      "run",
-      "list",
-      "--workflow",
-      "release.yml",
-      "--branch",
+    const release = runGhJSON<Release>([
+      "release",
+      "view",
       versionNumber,
       "--json",
-      "databaseId,number",
+      "id,name,assets",
     ]);
 
-    if (workflowRuns.length !== 1) {
-      throw new Error(
-        `Expected exactly one workflow run for ${versionNumber}, got ${workflowRuns.length}`,
+    const sourcemapAsset = release.assets.find(
+      (asset) => asset.name === `vscode-codeql-sourcemaps-${versionNumber}.zip`,
+    );
+
+    if (sourcemapAsset) {
+      // This downloads a ZIP file of the source maps
+      runGh([
+        "release",
+        "download",
+        versionNumber,
+        "--pattern",
+        sourcemapAsset.name,
+        "--dir",
+        releaseAssetsDirectory,
+      ]);
+
+      const file = await Open.file(
+        resolve(releaseAssetsDirectory, sourcemapAsset.name),
       );
+      await file.extract({ path: sourceMapsDirectory });
+    } else {
+      const workflowRuns = runGhJSON<WorkflowRunListItem[]>([
+        "run",
+        "list",
+        "--workflow",
+        "release.yml",
+        "--branch",
+        versionNumber,
+        "--json",
+        "databaseId,number",
+      ]);
+
+      if (workflowRuns.length !== 1) {
+        throw new Error(
+          `Expected exactly one workflow run for ${versionNumber}, got ${workflowRuns.length}`,
+        );
+      }
+
+      const workflowRun = workflowRuns[0];
+
+      runGh([
+        "run",
+        "download",
+        workflowRun.databaseId.toString(),
+        "--name",
+        "vscode-codeql-sourcemaps",
+        "--dir",
+        sourceMapsDirectory,
+      ]);
     }
-
-    const workflowRun = workflowRuns[0];
-
-    runGh([
-      "run",
-      "download",
-      workflowRun.databaseId.toString(),
-      "--name",
-      "vscode-codeql-sourcemaps",
-      "--dir",
-      sourceMapsDirectory,
-    ]);
   }
 
   if (stacktrace.includes("at")) {
@@ -172,6 +209,17 @@ function runGhJSON<T>(args: readonly string[]): T {
   return JSON.parse(runGh(args));
 }
 
+type ReleaseAsset = {
+  id: string;
+  name: string;
+};
+
+type Release = {
+  id: string;
+  name: string;
+  assets: ReleaseAsset[];
+};
+
 type WorkflowRunListItem = {
   databaseId: number;
   number: number;

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

@@ -19,6 +19,7 @@ import { CancellationToken, Uri } from "vscode";
 import { ProgressCallback } from "../commandRunner";
 import { QueryRunner } from "../queryRunner";
 import { redactableError } from "../pure/errors";
+import { QLPACK_FILENAMES } from "../pure/ql";
 
 export async function qlpackOfDatabase(
   cli: CodeQLCliServer,
@@ -113,7 +114,7 @@ async function resolveContextualQuery(
   // Work out the enclosing pack.
   const packContents = await cli.packPacklist(query, false);
   const packFilePath = packContents.find((p) =>
-    ["codeql-pack.yml", "qlpack.yml"].includes(basename(p)),
+    QLPACK_FILENAMES.includes(basename(p)),
   );
   if (packFilePath === undefined) {
     // Should not happen; we already resolved this query.

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

@@ -254,6 +254,11 @@ export class DbPanel extends DisposableObject {
         "Not a selectable database item. Please select a valid item.",
       );
     }
+
+    // Optimistically update the UI to select the item that the user
+    // selected to avoid delay in the UI.
+    this.dataProvider.updateSelectedItem(treeViewItem);
+
     await this.dbManager.setSelectedDbItem(treeViewItem.dbItem);
   }
 

extensions/ql-vscode/src/databases/ui/db-tree-data-provider.ts

@@ -48,6 +48,23 @@ export class DbTreeDataProvider
     });
   }
 
+  /**
+   * Updates the selected item and re-renders the tree.
+   * @param selectedItem The item to select.
+   */
+  public updateSelectedItem(selectedItem: DbTreeViewItem): void {
+    // Unselect all items
+    for (const item of this.dbTreeItems) {
+      item.setAsUnselected();
+    }
+
+    // Select the new item
+    selectedItem.setAsSelected();
+
+    // Re-render the tree
+    this._onDidChangeTreeData.fire(undefined);
+  }
+
   /**
    * Called when expanding a node (including the root node).
    * @param node The node to expand.

extensions/ql-vscode/src/databases/ui/db-tree-view-item.ts

@@ -36,11 +36,19 @@ export class DbTreeViewItem extends vscode.TreeItem {
     if (dbItem) {
       this.contextValue = getContextValue(dbItem);
       if (isSelectableDbItem(dbItem) && dbItem.selected) {
-        // Define the resource id to drive the UI to render this item as selected.
-        this.resourceUri = vscode.Uri.parse(SELECTED_DB_ITEM_RESOURCE_URI);
+        this.setAsSelected();
       }
     }
   }
+
+  public setAsSelected(): void {
+    // Define the resource id to drive the UI to render this item as selected.
+    this.resourceUri = vscode.Uri.parse(SELECTED_DB_ITEM_RESOURCE_URI);
+  }
+
+  public setAsUnselected(): void {
+    this.resourceUri = undefined;
+  }
 }
 
 function getContextValue(dbItem: DbItem): string | undefined {