Merge remote-tracking branch 'origin/main' into koesie10/upload-sourcemaps-release

Author: koesie10

CONTRIBUTING.md

@@ -228,6 +228,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/docs/test-plan.md

@@ -244,7 +244,7 @@ This requires running a MRVA query and seeing the results view.
    1. By name 
    2. By results 
    3. By stars 
-   4. By last commit
+   4. By last updated
 9. Can filter repos
 10. Shows correct statistics 
     1. Total number of results 

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

@@ -0,0 +1,193 @@
+/**
+ * This scripts helps finding the original source file and line number for a
+ * given file and line number in the compiled extension. It currently only
+ * works with released extensions.
+ *
+ * Usage: npx ts-node scripts/source-map.ts <version-number> <filename>:<line>:<column>
+ * For example: npx ts-node scripts/source-map.ts v1.7.8 "/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131164:13"
+ *
+ * Alternative usage: npx ts-node scripts/source-map.ts <version-number> <multi-line-stacktrace>
+ * For example: npx ts-node scripts/source-map.ts v1.7.8 'Error: Failed to find CodeQL distribution.
+ *     at CodeQLCliServer.getCodeQlPath (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131164:13)
+ *     at CodeQLCliServer.launchProcess (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131169:24)
+ *     at CodeQLCliServer.runCodeQlCliInternal (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131194:24)
+ *     at CodeQLCliServer.runJsonCodeQlCliCommand (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131330:20)
+ *     at CodeQLCliServer.resolveRam (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:131455:12)
+ *     at QueryServerClient2.startQueryServerImpl (/Users/user/.vscode/extensions/github.vscode-codeql-1.7.8/out/extension.js:138618:21)'
+ */
+
+import { spawnSync } from "child_process";
+import { basename, resolve } from "path";
+import { pathExists, readJSON } from "fs-extra";
+import { RawSourceMap, SourceMapConsumer } from "source-map";
+
+if (process.argv.length !== 4) {
+  console.error(
+    "Expected 2 arguments - the version number and the filename:line number",
+  );
+}
+
+const stackLineRegex =
+  /at (?<name>.*)? \((?<file>.*):(?<line>\d+):(?<column>\d+)\)/gm;
+
+const versionNumber = process.argv[2].startsWith("v")
+  ? process.argv[2]
+  : `v${process.argv[2]}`;
+const stacktrace = process.argv[3];
+
+async function extractSourceMap() {
+  const sourceMapsDirectory = resolve(
+    __dirname,
+    "..",
+    "artifacts",
+    "source-maps",
+    versionNumber,
+  );
+
+  if (!(await pathExists(sourceMapsDirectory))) {
+    console.log("Downloading source maps...");
+
+    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,
+    ]);
+  }
+
+  if (stacktrace.includes("at")) {
+    const rawSourceMaps = new Map<string, RawSourceMap>();
+
+    const mappedStacktrace = await replaceAsync(
+      stacktrace,
+      stackLineRegex,
+      async (match, name, file, line, column) => {
+        if (!rawSourceMaps.has(file)) {
+          const rawSourceMap: RawSourceMap = await readJSON(
+            resolve(sourceMapsDirectory, `${basename(file)}.map`),
+          );
+          rawSourceMaps.set(file, rawSourceMap);
+        }
+
+        const originalPosition = await SourceMapConsumer.with(
+          rawSourceMaps.get(file) as RawSourceMap,
+          null,
+          async function (consumer) {
+            return consumer.originalPositionFor({
+              line: parseInt(line, 10),
+              column: parseInt(column, 10),
+            });
+          },
+        );
+
+        if (!originalPosition.source) {
+          return match;
+        }
+
+        const originalFilename = resolve(file, "..", originalPosition.source);
+
+        return `at ${originalPosition.name ?? name} (${originalFilename}:${
+          originalPosition.line
+        }:${originalPosition.column})`;
+      },
+    );
+
+    console.log(mappedStacktrace);
+  } else {
+    // This means it's just a filename:line:column
+    const [filename, line, column] = stacktrace.split(":", 3);
+
+    const fileBasename = basename(filename);
+
+    const sourcemapName = `${fileBasename}.map`;
+    const sourcemapPath = resolve(sourceMapsDirectory, sourcemapName);
+
+    if (!(await pathExists(sourcemapPath))) {
+      throw new Error(`No source map found for ${fileBasename}`);
+    }
+
+    const rawSourceMap: RawSourceMap = await readJSON(sourcemapPath);
+
+    const originalPosition = await SourceMapConsumer.with(
+      rawSourceMap,
+      null,
+      async function (consumer) {
+        return consumer.originalPositionFor({
+          line: parseInt(line, 10),
+          column: parseInt(column, 10),
+        });
+      },
+    );
+
+    if (!originalPosition.source) {
+      throw new Error(`No source found for ${stacktrace}`);
+    }
+
+    const originalFilename = resolve(filename, "..", originalPosition.source);
+
+    console.log(
+      `${originalFilename}:${originalPosition.line}:${originalPosition.column}`,
+    );
+  }
+}
+
+extractSourceMap().catch((e: unknown) => {
+  console.error(e);
+  process.exit(2);
+});
+
+function runGh(args: readonly string[]): string {
+  const gh = spawnSync("gh", args);
+  if (gh.status !== 0) {
+    throw new Error(
+      `Failed to get the source map for ${versionNumber}: ${gh.stderr}`,
+    );
+  }
+  return gh.stdout.toString("utf-8");
+}
+
+function runGhJSON<T>(args: readonly string[]): T {
+  return JSON.parse(runGh(args));
+}
+
+type WorkflowRunListItem = {
+  databaseId: number;
+  number: number;
+};
+
+async function replaceAsync(
+  str: string,
+  regex: RegExp,
+  replacer: (substring: string, ...args: any[]) => Promise<string>,
+) {
+  const promises: Array<Promise<string>> = [];
+  str.replace(regex, (match, ...args) => {
+    const promise = replacer(match, ...args);
+    promises.push(promise);
+    return match;
+  });
+  const data = await Promise.all(promises);
+  return str.replace(regex, () => data.shift() as string);
+}

extensions/ql-vscode/src/config.ts

@@ -56,15 +56,6 @@ export class Setting {
       .getConfiguration(this.parent.qualifiedName)
       .update(this.name, value, target);
   }
-
-  inspect<T>(): InspectionResult<T> | undefined {
-    if (this.parent === undefined) {
-      throw new Error("Cannot update the value of a root setting.");
-    }
-    return workspace
-      .getConfiguration(this.parent.qualifiedName)
-      .inspect(this.name);
-  }
 }
 
 export interface InspectionResult<T> {