Merge remote-tracking branch 'upstream/main' into aeisenberg/run-with-all-data-extensions

Author: aeisenberg

.gitattributes

@@ -22,7 +22,7 @@ CHANGELOG.md                merge=union
 
 # Mark some JSON files containing test data as generated so they are not included
 # as part of diffs or language statistics.
-extensions/ql-vscode/src/stories/remote-queries/data/*.json     linguist-generated
+extensions/ql-vscode/src/stories/variant-analysis/data/*.json     linguist-generated
 
 # Always use LF line endings, also on Windows
 * text=auto eol=lf

.github/codeql/queries/unique-command-use.ql

@@ -0,0 +1,134 @@
+/**
+ * @name A VS Code command should not be used in multiple locations
+ * @kind problem
+ * @problem.severity warning
+ * @id vscode-codeql/unique-command-use
+ * @description Using each VS Code command from only one location makes
+ * our telemetry more useful, because we can differentiate more user
+ * interactions and know which features of the UI our users are using.
+ * To fix this alert, new commands will need to be made so that each one
+ * is only used from one location. The commands should share the same
+ * implementation so we do not introduce duplicate code.
+ * When fixing this alert, search the codebase for all other references
+ * to the command name. The location of the alert is an arbitrarily
+ * chosen usage of the command, and may not necessarily be the location
+ * that should be changed to fix the alert.
+ */
+
+ import javascript
+
+ /**
+  * The name of a VS Code command.
+  */
+ class CommandName extends string {
+   CommandName() { exists(CommandUsage e | e.getCommandName() = this) }
+ 
+   /**
+    * In how many ways is this command used. Will always be at least 1.
+    */
+   int getNumberOfUsages() { result = count(this.getAUse()) }
+
+   /**
+    * Get a usage of this command.
+    */
+   CommandUsage getAUse() { result.getCommandName() = this }
+ 
+   /**
+    * Get the canonical first usage of this command, to use for the location
+    * of the alert. The implementation of this ordering of usages is arbitrary
+    * and the usage given may not be the one that should be changed when fixing
+    * the alert.
+    */
+   CommandUsage getFirstUsage() {
+     result =
+       max(CommandUsage use |
+         use = this.getAUse()
+       |
+         use
+         order by
+           use.getFile().getRelativePath(), use.getLocation().getStartLine(),
+           use.getLocation().getStartColumn()
+       )
+   }
+ }
+ 
+ /**
+  * Represents a single usage of a command, either from within code or
+  * from the command's definition in package.json
+  */
+ abstract class CommandUsage extends Locatable {
+   abstract string getCommandName();
+ }
+ 
+ /**
+  * A usage of a command from the typescript code, by calling `executeCommand`.
+  */
+ class CommandUsageCallExpr extends CommandUsage, CallExpr {
+   CommandUsageCallExpr() {
+     this.getCalleeName() = "executeCommand" and
+     this.getArgument(0).(StringLiteral).getValue().matches("%codeQL%") and
+     not this.getFile().getRelativePath().matches("extensions/ql-vscode/test/%")
+   }
+ 
+   override string getCommandName() { result = this.getArgument(0).(StringLiteral).getValue() }
+ }
+ 
+ /**
+  * A usage of a command from any menu that isn't the command palette.
+  * This means a user could invoke the command by clicking on a button in
+  * something like a menu or a dropdown.
+  */
+ class CommandUsagePackageJsonMenuItem extends CommandUsage, JsonObject {
+   CommandUsagePackageJsonMenuItem() {
+     exists(this.getPropValue("command")) and
+     exists(PackageJson packageJson, string menuName |
+       packageJson
+           .getPropValue("contributes")
+           .getPropValue("menus")
+           .getPropValue(menuName)
+           .getElementValue(_) = this and
+       menuName != "commandPalette"
+     )
+   }
+ 
+   override string getCommandName() { result = this.getPropValue("command").getStringValue() }
+ }
+ 
+ /**
+  * Is the given command disabled for use in the command palette by
+  * a block with a `"when": "false"` field.
+  */
+ predicate isDisabledInCommandPalette(string commandName) {
+   exists(PackageJson packageJson, JsonObject commandPaletteObject |
+     packageJson
+         .getPropValue("contributes")
+         .getPropValue("menus")
+         .getPropValue("commandPalette")
+         .getElementValue(_) = commandPaletteObject and
+     commandPaletteObject.getPropValue("command").getStringValue() = commandName and
+     commandPaletteObject.getPropValue("when").getStringValue() = "false"
+   )
+ }
+ 
+ /**
+  * Represents a command being usable from the command palette.
+  * This means that a user could choose to manually invoke the command.
+  */
+ class CommandUsagePackageJsonCommandPalette extends CommandUsage, JsonObject {
+   CommandUsagePackageJsonCommandPalette() {
+     this.getFile().getBaseName() = "package.json" and
+     exists(this.getPropValue("command")) and
+     exists(PackageJson packageJson |
+       packageJson.getPropValue("contributes").getPropValue("commands").getElementValue(_) = this
+     ) and
+     not isDisabledInCommandPalette(this.getPropValue("command").getStringValue())
+   }
+ 
+   override string getCommandName() { result = this.getPropValue("command").getStringValue() }
+ }
+ 
+ from CommandName c
+ where c.getNumberOfUsages() > 1
+ select c.getFirstUsage(),
+   "The " + c + " command is used from " + c.getNumberOfUsages() + " locations"
+ 

.github/workflows/main.yml

@@ -132,7 +132,12 @@ jobs:
       - name: Run unit tests
         working-directory: extensions/ql-vscode
         run: |
-          npm run test
+          npm run test:unit
+
+      - name: Run view tests
+        working-directory: extensions/ql-vscode
+        run: |
+          npm run test:view
 
   test:
     name: Test
@@ -173,15 +178,15 @@ jobs:
           VSCODE_CODEQL_GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
         run: |
           unset DBUS_SESSION_BUS_ADDRESS
-          /usr/bin/xvfb-run npm run integration
+          /usr/bin/xvfb-run npm run test:vscode-integration
 
       - name: Run integration tests (Windows)
         if: matrix.os == 'windows-latest'
         working-directory: extensions/ql-vscode
         env:
           VSCODE_CODEQL_GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
         run: |
-          npm run integration
+          npm run test:vscode-integration
 
   set-matrix:
     name: Set Matrix for cli-test
@@ -254,10 +259,10 @@ jobs:
         if: matrix.os == 'ubuntu-latest'
         run: |
           unset DBUS_SESSION_BUS_ADDRESS
-          /usr/bin/xvfb-run npm run cli-integration
+          /usr/bin/xvfb-run npm run test:cli-integration
 
       - name: Run CLI tests (Windows)
         working-directory: extensions/ql-vscode
         if: matrix.os == 'windows-latest'
         run: |
-          npm run cli-integration
+          npm run test:cli-integration

.github/workflows/release.yml

@@ -54,7 +54,7 @@ jobs:
           echo "ref_name=$REF_NAME" >> "$GITHUB_OUTPUT"
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v3
         with:
           name: vscode-codeql-extension
           path: artifacts

.vscode/launch.json

@@ -11,6 +11,7 @@
         "--extensionDevelopmentPath=${workspaceRoot}/extensions/ql-vscode",
         // Add a reference to a workspace to open. Eg-
         // "${workspaceRoot}/../vscode-codeql-starter/vscode-codeql-starter.code-workspace"
+        // "${workspaceRoot}/../codespaces-codeql/tutorial.code-workspace"
       ],
       "sourceMaps": true,
       "outFiles": [

CODEOWNERS

@@ -1,4 +1,3 @@
 **/* @github/codeql-vscode-reviewers
-**/remote-queries/ @github/code-scanning-secexp-reviewers
 **/variant-analysis/ @github/code-scanning-secexp-reviewers
 **/databases/ @github/code-scanning-secexp-reviewers

CONTRIBUTING.md

@@ -98,10 +98,11 @@ We have several types of tests:
 * Unit tests: these live in the `tests/unit-tests/` directory
 * View tests: these live in `src/view/variant-analysis/__tests__/`
 * VSCode integration tests:
-  * `test/vscode-tests/no-workspace` tests: These are intended to cover functionality that is meant to work before you even have a workspace open. 
+  * `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 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 intendended to be cover functionality that is related to the integration between the CodeQL CLI and the extension.
+  * 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.
 
@@ -119,7 +120,7 @@ Then, from the `extensions/ql-vscode` directory, use the appropriate command to
 
 * Unit tests: `npm run test:unit`
 * View Tests: `npm test:view`
-* VSCode integration tests: `npm run integration`
+* VSCode integration tests: `npm run test:vscode-integration`
 
 ###### CLI integration tests
 
@@ -130,7 +131,7 @@ The CLI integration tests require the CodeQL standard libraries in order to run
 2. Run your test command:
 
 ```shell
-cd extensions/ql-vscode && npm run cli-integration
+cd extensions/ql-vscode && npm run test:cli-integration
 ```
 
 ##### 2. From VSCode
@@ -161,13 +162,13 @@ The easiest way to run a single test is to change the `it` of the test to `it.on
 to only run tests for this specific file. For example, to run the test `test/vscode-tests/cli-integration/run-queries.test.ts`:
 
 ```shell
-npm run cli-integration -- --runTestsByPath test/vscode-tests/cli-integration/run-queries.test.ts
+npm run test:cli-integration -- --runTestsByPath test/vscode-tests/cli-integration/run-queries.test.ts
 ```
 
 You can also use the `--testNamePattern` option to run a specific test within a file. For example, to run the test `test/vscode-tests/cli-integration/run-queries.test.ts`:
 
 ```shell
-npm run cli-integration -- --runTestsByPath test/vscode-tests/cli-integration/run-queries.test.ts --testNamePattern "should create a QueryEvaluationInfo"
+npm run test:cli-integration -- --runTestsByPath test/vscode-tests/cli-integration/run-queries.test.ts --testNamePattern "should create a QueryEvaluationInfo"
 ```
 
 ##### 2. From VSCode

README.md

@@ -7,7 +7,7 @@ The extension is released. You can download it from the [Visual Studio Marketpla
 To see what has changed in the last few versions of the extension, see the [Changelog](https://github.com/github/vscode-codeql/blob/main/extensions/ql-vscode/CHANGELOG.md).
 
 [![CI status badge](https://github.com/github/vscode-codeql/workflows/Build%20Extension/badge.svg)](https://github.com/github/vscode-codeql/actions?query=workflow%3A%22Build+Extension%22+branch%3Amaster)
-[![VS Marketplace badge](https://vsmarketplacebadge.apphb.com/version/github.vscode-codeql.svg)](https://marketplace.visualstudio.com/items?itemName=github.vscode-codeql)
+[![VS Marketplace badge](https://vsmarketplacebadges.dev/version/github.vscode-codeql.svg)](https://marketplace.visualstudio.com/items?itemName=github.vscode-codeql)
 
 ## Features
 

extensions/ql-vscode/.eslintrc.js

@@ -29,6 +29,7 @@ const baseConfig = {
     "plugin:@typescript-eslint/recommended",
   ],
   rules: {
+    "@typescript-eslint/await-thenable": "error",
     "@typescript-eslint/no-use-before-define": 0,
     "@typescript-eslint/no-unused-vars": [
       "warn",

extensions/ql-vscode/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 ## [UNRELEASED]
 
+- Send telemetry about unhandled errors happening within the extension. [#2125](https://github.com/github/vscode-codeql/pull/2125)
+
+## 1.7.11 - 1 March 2023
+
+- Enable collection of telemetry concerning interactions with UI elements, including buttons, links, and other inputs. [#2114](https://github.com/github/vscode-codeql/pull/2114)
+- Prevent the automatic installation of CodeQL CLI version 2.12.3 to avoid a bug in the language server. CodeQL CLI 2.12.2 will be used instead. [#2126](https://github.com/github/vscode-codeql/pull/2126)
+
+## 1.7.10 - 23 February 2023
+
+- Fix bug that was causing unwanted error notifications.
+
+## 1.7.9 - 20 February 2023
+
+No user facing changes.
+
 ## 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)