Merge pull request #2788 from github/v1.8.11

v1.8.11

.github/workflows/cli-test.yml

@@ -0,0 +1,111 @@
+name: Run CLI tests
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    paths:
+      - .github/workflows/cli-test.yml
+      - extensions/ql-vscode/src/codeql-cli/**
+      - extensions/ql-vscode/src/language-support/**
+      - extensions/ql-vscode/src/query-server/**
+      - extensions/ql-vscode/supported_cli_versions.json
+
+jobs:
+  find-nightly:
+    name: Find Nightly Release
+    runs-on: ubuntu-latest
+    outputs:
+      url: ${{ steps.get-url.outputs.nightly-url }}
+    steps:
+      - name: Get Nightly Release URL
+        id: get-url
+        env:
+          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+        shell: bash
+        # This workflow step gets an unstable testing version of the CodeQL CLI. It should not be used outside of these tests.
+        run: |
+          LATEST=`gh api repos/dsp-testing/codeql-cli-nightlies/releases --jq '.[].tag_name' --method GET --raw-field 'per_page=1'`
+          echo "nightly-url=https://github.com/dsp-testing/codeql-cli-nightlies/releases/download/$LATEST" >> "$GITHUB_OUTPUT"
+
+  set-matrix:
+    name: Set Matrix for cli-test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set the variables
+        id: set-variables
+        run: echo "cli-versions=$(cat ./extensions/ql-vscode/supported_cli_versions.json | jq -rc)" >> $GITHUB_OUTPUT
+    outputs:
+      cli-versions: ${{ steps.set-variables.outputs.cli-versions }}
+
+  cli-test:
+    name: CLI Test
+    runs-on: ${{ matrix.os }}
+    needs: [find-nightly, set-matrix]
+    timeout-minutes: 30
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        version: ${{ fromJson(needs.set-matrix.outputs.cli-versions) }}
+      fail-fast: false
+    env:
+      CLI_VERSION: ${{ matrix.version }}
+      NIGHTLY_URL: ${{ needs.find-nightly.outputs.url }}
+      TEST_CODEQL_PATH: '${{ github.workspace }}/codeql'
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.17.1'
+          cache: 'npm'
+          cache-dependency-path: extensions/ql-vscode/package-lock.json
+
+      - name: Install dependencies
+        working-directory: extensions/ql-vscode
+        run: |
+          npm ci
+        shell: bash
+
+      - name: Build
+        working-directory: extensions/ql-vscode
+        run: |
+          npm run build
+        shell: bash
+
+      - name: Decide on ref of CodeQL repo
+        id: choose-ref
+        shell: bash
+        run: |
+          if [[ "${{ matrix.version }}" == "nightly" ]]
+          then
+            REF="codeql-cli/latest"
+          else
+            REF="codeql-cli/${{ matrix.version }}"
+          fi
+          echo "ref=$REF" >> "$GITHUB_OUTPUT"
+
+      - name: Checkout QL
+        uses: actions/checkout@v3
+        with:
+          repository: github/codeql
+          ref: ${{ steps.choose-ref.outputs.ref }}
+          path: codeql
+
+      - name: Run CLI tests (Linux)
+        working-directory: extensions/ql-vscode
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          unset DBUS_SESSION_BUS_ADDRESS
+          /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 test:cli-integration

.github/workflows/main.yml

@@ -53,22 +53,6 @@ jobs:
           name: vscode-codeql-extension
           path: artifacts
 
-  find-nightly:
-    name: Find Nightly Release
-    runs-on: ubuntu-latest
-    outputs:
-      url: ${{ steps.get-url.outputs.nightly-url }}
-    steps:
-      - name: Get Nightly Release URL
-        id: get-url
-        env:
-          GITHUB_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
-        shell: bash
-        # This workflow step gets an unstable testing version of the CodeQL CLI. It should not be used outside of these tests.
-        run: |
-          LATEST=`gh api repos/dsp-testing/codeql-cli-nightlies/releases --jq '.[].tag_name' --method GET --raw-field 'per_page=1'`
-          echo "nightly-url=https://github.com/dsp-testing/codeql-cli-nightlies/releases/download/$LATEST" >> "$GITHUB_OUTPUT"
-
   lint:
     name: Lint
     runs-on: ubuntu-latest
@@ -198,31 +182,31 @@ jobs:
         run: |
           npm run test:vscode-integration
 
-  set-matrix:
+  get-latest-cli-version:
-    name: Set Matrix for cli-test
+    name: Get latest CLI version
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Set the variables
+      - name: Set the variable
-        id: set-variables
+        id: set-variable
-        run: echo "cli-versions=$(cat ./extensions/ql-vscode/supported_cli_versions.json | jq -rc)" >> $GITHUB_OUTPUT
+        run: |
+          echo "cli-version=$(cat ./extensions/ql-vscode/supported_cli_versions.json | jq -rc '.[0]')" >> $GITHUB_OUTPUT
+          echo "$cli-version"
     outputs:
-      cli-versions: ${{ steps.set-variables.outputs.cli-versions }}
+      cli-version: ${{ steps.set-variable.outputs.cli-version }}
 
   cli-test:
     name: CLI Test
     runs-on: ${{ matrix.os }}
-    needs: [find-nightly, set-matrix]
+    needs: [get-latest-cli-version]
     timeout-minutes: 30
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
-        version: ${{ fromJson(needs.set-matrix.outputs.cli-versions) }}
       fail-fast: false
     env:
-      CLI_VERSION: ${{ matrix.version }}
+      CLI_VERSION: ${{ needs.get-latest-cli-version.outputs.cli-version }}
-      NIGHTLY_URL: ${{ needs.find-nightly.outputs.url }}
       TEST_CODEQL_PATH: '${{ github.workspace }}/codeql'
 
     steps:
@@ -247,23 +231,11 @@ jobs:
           npm run build
         shell: bash
 
-      - name: Decide on ref of CodeQL repo
-        id: choose-ref
-        shell: bash
-        run: |
-          if [[ "${{ matrix.version }}" == "nightly" ]]
-          then
-            REF="codeql-cli/latest"
-          else
-            REF="codeql-cli/${{ matrix.version }}"
-          fi
-          echo "ref=$REF" >> "$GITHUB_OUTPUT"
-
       - name: Checkout QL
         uses: actions/checkout@v3
         with:
           repository: github/codeql
-          ref: ${{ steps.choose-ref.outputs.ref }}
+          ref: 'codeql-cli/${{ needs.get-latest-cli-version.outputs.cli-version }}'
           path: codeql
 
       - name: Run CLI tests (Linux)

CODEOWNERS

@@ -1,5 +1,5 @@
 **/* @github/codeql-vscode-reviewers
 **/variant-analysis/ @github/code-scanning-secexp-reviewers
 **/databases/ @github/code-scanning-secexp-reviewers
-**/data-extensions-editor/ @github/code-scanning-secexp-reviewers
+**/model-editor/ @github/code-scanning-secexp-reviewers
 **/queries-panel/ @github/code-scanning-secexp-reviewers

docs/releasing.md

@@ -1,5 +1,6 @@
 # Releasing (write access required)
 
+1. Run the ["Run CLI tests" workflow](https://github.com/github/vscode-codeql/actions/workflows/cli-test.yml) and make sure the tests are green. If there were no merges between the time the workflow ran (it runs daily), and the release, you can skip this step.  
 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.

docs/testing.md

@@ -133,4 +133,4 @@ Once the scenario has been recorded, it's often useful to remove some of the req
 
 ### Scenario data location
 
-Pre-recorded scenarios are stored in `./src/variant-analysis/github-api/mocks/scenarios`. However, it's possible to configure the location, by setting the `codeQL.mockGitHubApiServer.scenariosPath` configuration property in the VS Code user settings.
+Pre-recorded scenarios are stored in `./src/common/mock-gh-api/scenarios`. However, it's possible to configure the location, by setting the `codeQL.mockGitHubApiServer.scenariosPath` configuration property in the VS Code user settings.

extensions/ql-vscode/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CodeQL for Visual Studio Code: Changelog
 
+## 1.8.11 - 7 September 2023
+
+- Update how variant analysis results are displayed. For queries with ["path-problem" or "problem" `@kind`](https://codeql.github.com/docs/writing-codeql-queries/metadata-for-codeql-queries/#metadata-properties), you can choose to display the results as rendered alerts or as a table of raw results. For queries with any other `@kind`, the results are displayed as a table. [#2745](https://github.com/github/vscode-codeql/pull/2745) & [#2749](https://github.com/github/vscode-codeql/pull/2749)
+- When running variant analyses, don't download artifacts for repositories with no results. [#2736](https://github.com/github/vscode-codeql/pull/2736)
+- Group the extension settings, so that they're easier to find in the Settings UI. [#2706](https://github.com/github/vscode-codeql/pull/2706)
+
 ## 1.8.10 - 15 August 2023
 
 - Add a code lens to make the `CodeQL: Open Referenced File` command more discoverable. Click the "Open referenced file" prompt in a `.qlref` file to jump to the referenced `.ql` file. [#2704](https://github.com/github/vscode-codeql/pull/2704)

extensions/ql-vscode/package.json

@@ -4,7 +4,7 @@
   "description": "CodeQL for Visual Studio Code",
   "author": "GitHub",
   "private": true,
-  "version": "1.8.10",
+  "version": "1.8.11",
   "publisher": "GitHub",
   "license": "MIT",
   "icon": "media/VS-marketplace-CodeQL-icon.png",
@@ -182,215 +182,281 @@
         "path": "./snippets.json"
       }
     ],
-    "configuration": {
+    "configuration": [
-      "type": "object",
+      {
-      "title": "CodeQL",
+        "type": "object",
-      "properties": {
+        "title": "CLI",
-        "codeQL.cli.executablePath": {
+        "order": 0,
-          "scope": "machine-overridable",
+        "properties": {
-          "type": "string",
+          "codeQL.cli.executablePath": {
-          "default": "",
+            "scope": "machine-overridable",
-          "markdownDescription": "Path to the CodeQL executable that should be used by the CodeQL extension. The executable is named `codeql` on Linux/Mac and `codeql.exe` on Windows. If empty, the extension will look for a CodeQL executable on your shell PATH, or if CodeQL is not on your PATH, download and manage its own CodeQL executable (note: if you later introduce CodeQL on your PATH, the extension will prefer a CodeQL executable it has downloaded itself)."
+            "type": "string",
-        },
+            "default": "",
-        "codeQL.runningQueries.numberOfThreads": {
+            "markdownDescription": "Path to the CodeQL executable that should be used by the CodeQL extension. The executable is named `codeql` on Linux/Mac and `codeql.exe` on Windows. If empty, the extension will look for a CodeQL executable on your shell PATH, or if CodeQL is not on your PATH, download and manage its own CodeQL executable (note: if you later introduce CodeQL on your PATH, the extension will prefer a CodeQL executable it has downloaded itself)."
-          "type": "integer",
+          }
-          "default": 1,
+        }
-          "minimum": 0,
+      },
-          "maximum": 1024,
+      {
-          "description": "Number of threads for running queries."
+        "type": "object",
-        },
+        "title": "Running queries",
-        "codeQL.runningQueries.saveCache": {
+        "order": 1,
-          "type": "boolean",
+        "properties": {
-          "default": false,
+          "codeQL.runningQueries.numberOfThreads": {
-          "scope": "window",
+            "type": "integer",
-          "description": "Aggressively save intermediate results to the disk cache. This may speed up subsequent queries if they are similar. Be aware that using this option will greatly increase disk usage and initial evaluation time."
+            "default": 1,
-        },
+            "minimum": 0,
-        "codeQL.runningQueries.cacheSize": {
+            "maximum": 1024,
-          "type": [
+            "description": "Number of threads for running queries."
-            "integer",
+          },
-            "null"
+          "codeQL.runningQueries.saveCache": {
-          ],
+            "type": "boolean",
-          "default": null,
+            "default": false,
-          "minimum": 1024,
+            "scope": "window",
-          "description": "Maximum size of the disk cache (in MB). Leave blank to allow the evaluator to automatically adjust the size of the disk cache based on the size of the codebase and the complexity of the queries being executed."
+            "description": "Aggressively save intermediate results to the disk cache. This may speed up subsequent queries if they are similar. Be aware that using this option will greatly increase disk usage and initial evaluation time."
-        },
+          },
-        "codeQL.runningQueries.timeout": {
+          "codeQL.runningQueries.cacheSize": {
-          "type": [
+            "type": [
-            "integer",
+              "integer",
-            "null"
+              "null"
-          ],
+            ],
-          "default": null,
+            "default": null,
-          "minimum": 0,
+            "minimum": 1024,
-          "maximum": 2147483647,
+            "description": "Maximum size of the disk cache (in MB). Leave blank to allow the evaluator to automatically adjust the size of the disk cache based on the size of the codebase and the complexity of the queries being executed."
-          "description": "Timeout (in seconds) for running queries. Leave blank or set to zero for no timeout."
+          },
-        },
+          "codeQL.runningQueries.timeout": {
-        "codeQL.runningQueries.memory": {
+            "type": [
-          "type": [
+              "integer",
-            "integer",
+              "null"
-            "null"
+            ],
-          ],
+            "default": null,
-          "default": null,
+            "minimum": 0,
-          "minimum": 1024,
+            "maximum": 2147483647,
-          "description": "Memory (in MB) to use for running queries. Leave blank for CodeQL to choose a suitable value based on your system's available memory."
+            "description": "Timeout (in seconds) for running queries. Leave blank or set to zero for no timeout."
-        },
+          },
-        "codeQL.runningQueries.debug": {
+          "codeQL.runningQueries.memory": {
-          "type": "boolean",
+            "type": [
-          "default": false,
+              "integer",
-          "description": "Enable debug logging and tuple counting when running CodeQL queries. This information is useful for debugging query performance."
+              "null"
-        },
+            ],
-        "codeQL.runningQueries.maxPaths": {
+            "default": null,
-          "type": "integer",
+            "minimum": 1024,
-          "default": 4,
+            "description": "Memory (in MB) to use for running queries. Leave blank for CodeQL to choose a suitable value based on your system's available memory."
-          "minimum": 1,
+          },
-          "maximum": 256,
+          "codeQL.runningQueries.debug": {
-          "markdownDescription": "Max number of paths to display for each alert found by a path query (`@kind path-problem`)."
+            "type": "boolean",
-        },
+            "default": false,
-        "codeQL.runningQueries.autoSave": {
+            "description": "Enable debug logging and tuple counting when running CodeQL queries. This information is useful for debugging query performance."
-          "type": "boolean",
+          },
-          "description": "Enable automatically saving a modified query file when running a query.",
+          "codeQL.runningQueries.maxPaths": {
-          "markdownDeprecationMessage": "This property is deprecated and no longer has any effect. To control automatic saving of documents before running queries, use the `debug.saveBeforeStart` setting."
+            "type": "integer",
-        },
+            "default": 4,
-        "codeQL.runningQueries.maxQueries": {
+            "minimum": 1,
-          "type": "integer",
+            "maximum": 256,
-          "default": 20,
+            "markdownDescription": "Max number of paths to display for each alert found by a path query (`@kind path-problem`)."
-          "description": "Max number of simultaneous queries to run using the 'CodeQL: Run Queries' command."
+          },
-        },
+          "codeQL.runningQueries.autoSave": {
-        "codeQL.runningQueries.customLogDirectory": {
+            "type": "boolean",
-          "type": [
+            "description": "Enable automatically saving a modified query file when running a query.",
-            "string",
+            "markdownDeprecationMessage": "This property is deprecated and no longer has any effect. To control automatic saving of documents before running queries, use the `debug.saveBeforeStart` setting."
-            null
+          },
-          ],
+          "codeQL.runningQueries.maxQueries": {
-          "default": null,
+            "type": "integer",
-          "description": "Path to a directory where the CodeQL extension should store query server logs. If empty, the extension stores logs in a temporary workspace folder and deletes the contents after each run.",
+            "default": 20,
-          "markdownDeprecationMessage": "This property is deprecated and no longer has any effect. All query logs are stored in the query history folder next to the query results."
+            "description": "Max number of simultaneous queries to run using the 'CodeQL: Run Queries' command."
-        },
+          },
-        "codeQL.runningQueries.quickEvalCodelens": {
+          "codeQL.runningQueries.customLogDirectory": {
-          "type": "boolean",
+            "type": [
-          "default": true,
+              "string",
-          "description": "Enable the 'Quick Evaluation' CodeLens."
+              null
-        },
+            ],
-        "codeQL.runningQueries.useExtensionPacks": {
+            "default": null,
-          "type": "string",
+            "description": "Path to a directory where the CodeQL extension should store query server logs. If empty, the extension stores logs in a temporary workspace folder and deletes the contents after each run.",
-          "default": "none",
+            "markdownDeprecationMessage": "This property is deprecated and no longer has any effect. All query logs are stored in the query history folder next to the query results."
-          "enum": [
+          },
-            "none",
+          "codeQL.runningQueries.quickEvalCodelens": {
-            "all"
+            "type": "boolean",
-          ],
+            "default": true,
-          "enumDescriptions": [
+            "description": "Enable the 'Quick Evaluation' CodeLens."
-            "Do not use extension packs.",
+          },
-            "Use all extension packs found in the workspace."
+          "codeQL.runningQueries.useExtensionPacks": {
-          ],
+            "type": "string",
-          "description": "Choose whether or not to run queries using extension packs. Requires CodeQL CLI v2.12.3 or later."
+            "default": "none",
-        },
+            "enum": [
-        "codeQL.resultsDisplay.pageSize": {
+              "none",
-          "type": "integer",
+              "all"
-          "default": 200,
+            ],
-          "description": "Max number of query results to display per page in the results view."
+            "enumDescriptions": [
-        },
+              "Do not use extension packs.",
-        "codeQL.queryHistory.format": {
+              "Use all extension packs found in the workspace."
-          "type": "string",
+            ],
-          "default": "%q on %d - %s %r [%t]",
+            "description": "Choose whether or not to run queries using extension packs. Requires CodeQL CLI v2.12.3 or later."
-          "markdownDescription": "Default string for how to label query history items.\n* %t is the time of the query\n* %q is the human-readable query name\n* %f is the query file name\n* %d is the database name\n* %r is the number of results\n* %s is a status string"
+          }
-        },
+        }
-        "codeQL.queryHistory.ttl": {
+      },
-          "type": "number",
+      {
-          "default": 30,
+        "type": "object",
-          "description": "Number of days to retain queries in the query history before being automatically deleted.",
+        "title": "Results",
-          "scope": "machine"
+        "order": 2,
-        },
+        "properties": {
-        "codeQL.runningTests.additionalTestArguments": {
+          "codeQL.resultsDisplay.pageSize": {
-          "scope": "window",
+            "type": "integer",
-          "type": "array",
+            "default": 200,
-          "default": [],
+            "description": "Max number of query results to display per page in the results view."
-          "markdownDescription": "Additional command line arguments to pass to the CLI when [running tests](https://codeql.github.com/docs/codeql-cli/manual/test-run/). This setting should be an array of strings, each containing an argument to be passed."
+          }
-        },
+        }
-        "codeQL.runningTests.numberOfThreads": {
+      },
-          "scope": "window",
+      {
-          "type": "integer",
+        "type": "object",
-          "default": 1,
+        "title": "Query history",
-          "minimum": 0,
+        "order": 3,
-          "maximum": 1024,
+        "properties": {
-          "description": "Number of threads for running CodeQL tests."
+          "codeQL.queryHistory.format": {
-        },
+            "type": "string",
-        "codeQL.telemetry.enableTelemetry": {
+            "default": "%q on %d - %s %r [%t]",
-          "type": "boolean",
+            "markdownDescription": "Default string for how to label query history items.\n* %t is the time of the query\n* %q is the human-readable query name\n* %f is the query file name\n* %d is the database name\n* %r is the number of results\n* %s is a status string"
-          "default": false,
+          },
-          "scope": "application",
+          "codeQL.queryHistory.ttl": {
-          "markdownDescription": "Specifies whether to send CodeQL usage telemetry. This setting AND the global `#telemetry.enableTelemetry#` setting must be checked for telemetry to be sent to GitHub. For more information, see the [telemetry documentation](https://codeql.github.com/docs/codeql-for-visual-studio-code/about-telemetry-in-codeql-for-visual-studio-code)"
+            "type": "number",
-        },
+            "default": 30,
-        "codeQL.telemetry.logTelemetry": {
+            "description": "Number of days to retain queries in the query history before being automatically deleted.",
-          "type": "boolean",
+            "scope": "machine"
-          "default": false,
+          }
-          "scope": "application",
+        }
-          "description": "Specifies whether or not to write telemetry events to the extension log."
+      },
-        },
+      {
-        "codeQL.variantAnalysis.controllerRepo": {
+        "type": "object",
-          "type": "string",
+        "title": "Running tests",
-          "default": "",
+        "order": 4,
-          "pattern": "^$|^(?:[a-zA-Z0-9]+-)*[a-zA-Z0-9]+/[a-zA-Z0-9-_]+$",
+        "properties": {
-          "patternErrorMessage": "Please enter a valid GitHub repository",
+          "codeQL.runningTests.additionalTestArguments": {
-          "markdownDescription": "[For internal use only] The name of the GitHub repository in which the GitHub Actions workflow is run when using the \"Run Variant Analysis\" command. The repository should be of the form `<owner>/<repo>`)."
+            "scope": "window",
-        },
+            "type": "array",
-        "codeQL.variantAnalysis.defaultResultsFilter": {
+            "default": [],
-          "type": "string",
+            "markdownDescription": "Additional command line arguments to pass to the CLI when [running tests](https://codeql.github.com/docs/codeql-cli/manual/test-run/). This setting should be an array of strings, each containing an argument to be passed."
-          "default": "all",
+          },
-          "enum": [
+          "codeQL.runningTests.numberOfThreads": {
-            "all",
+            "scope": "window",
-            "withResults"
+            "type": "integer",
-          ],
+            "default": 1,
-          "enumDescriptions": [
+            "minimum": 0,
-            "Show all repositories in the results view.",
+            "maximum": 1024,
-            "Show only repositories with results in the results view."
+            "description": "Number of threads for running CodeQL tests."
-          ],
+          }
-          "description": "The default filter to apply to the variant analysis results view."
+        }
-        },
+      },
-        "codeQL.variantAnalysis.defaultResultsSort": {
+      {
-          "type": "string",
+        "type": "object",
-          "default": "numberOfResults",
+        "title": "Variant analysis",
-          "enum": [
+        "order": 5,
-            "alphabetically",
+        "properties": {
-            "popularity",
+          "codeQL.variantAnalysis.controllerRepo": {
-            "numberOfResults"
+            "type": "string",
-          ],
+            "default": "",
-          "enumDescriptions": [
+            "pattern": "^$|^(?:[a-zA-Z0-9]+-)*[a-zA-Z0-9]+/[a-zA-Z0-9-_]+$",
-            "Sort repositories alphabetically in the results view.",
+            "patternErrorMessage": "Please enter a valid GitHub repository",
-            "Sort repositories by popularity in the results view.",
+            "markdownDescription": "[For internal use only] The name of the GitHub repository in which the GitHub Actions workflow is run when using the \"Run Variant Analysis\" command. The repository should be of the form `<owner>/<repo>`)."
-            "Sort repositories by number of results in the results view."
+          },
-          ],
+          "codeQL.variantAnalysis.defaultResultsFilter": {
-          "description": "The default sorting order for repositories in the variant analysis results view."
+            "type": "string",
-        },
+            "default": "all",
-        "codeQL.logInsights.joinOrderWarningThreshold": {
+            "enum": [
-          "type": "number",
+              "all",
-          "default": 50,
+              "withResults"
-          "scope": "window",
+            ],
-          "minimum": 0,
+            "enumDescriptions": [
-          "description": "Report a warning for any join order whose metric exceeds this value."
+              "Show all repositories in the results view.",
-        },
+              "Show only repositories with results in the results view."
-        "codeQL.databaseDownload.allowHttp": {
+            ],
-          "type": "boolean",
+            "description": "The default filter to apply to the variant analysis results view."
-          "default": false,
+          },
-          "description": "Allow database to be downloaded via HTTP. Warning: enabling this option will allow downloading from insecure servers."
+          "codeQL.variantAnalysis.defaultResultsSort": {
-        },
+            "type": "string",
-        "codeQL.createQuery.qlPackLocation": {
+            "default": "numberOfResults",
-          "type": "string",
+            "enum": [
-          "patternErrorMessage": "Please enter a valid folder",
+              "alphabetically",
-          "markdownDescription": "The name of the folder where we want to create queries and QL packs via the \"CodeQL: Create Query\" command. The folder should exist."
+              "popularity",
-        },
+              "numberOfResults"
-        "codeQL.createQuery.autogenerateQlPacks": {
+            ],
-          "type": "string",
+            "enumDescriptions": [
-          "default": "ask",
+              "Sort repositories alphabetically in the results view.",
-          "enum": [
+              "Sort repositories by popularity in the results view.",
-            "ask",
+              "Sort repositories by number of results in the results view."
-            "never"
+            ],
-          ],
+            "description": "The default sorting order for repositories in the variant analysis results view."
-          "enumDescriptions": [
+          }
-            "Ask to create a QL pack when a new CodeQL database is added.",
+        }
-            "Never create a QL pack when a new CodeQL database is added."
+      },
-          ],
+      {
-          "description": "Ask the user to generate a QL pack when a new CodeQL database is downloaded."
+        "type": "object",
+        "title": "Downloading databases",
+        "order": 6,
+        "properties": {
+          "codeQL.databaseDownload.allowHttp": {
+            "type": "boolean",
+            "default": false,
+            "description": "Allow database to be downloaded via HTTP. Warning: enabling this option will allow downloading from insecure servers."
+          }
+        }
+      },
+      {
+        "type": "object",
+        "title": "Creating queries",
+        "order": 7,
+        "properties": {
+          "codeQL.createQuery.qlPackLocation": {
+            "type": "string",
+            "patternErrorMessage": "Please enter a valid folder",
+            "markdownDescription": "The name of the folder where we want to create queries and QL packs via the \"CodeQL: Create Query\" command. The folder should exist."
+          },
+          "codeQL.createQuery.autogenerateQlPacks": {
+            "type": "string",
+            "default": "ask",
+            "enum": [
+              "ask",
+              "never"
+            ],
+            "enumDescriptions": [
+              "Ask to create a QL pack when a new CodeQL database is added.",
+              "Never create a QL pack when a new CodeQL database is added."
+            ],
+            "description": "Ask the user to generate a QL pack when a new CodeQL database is downloaded."
+          }
+        }
+      },
+      {
+        "type": "object",
+        "title": "Log insights",
+        "order": 8,
+        "properties": {
+          "codeQL.logInsights.joinOrderWarningThreshold": {
+            "type": "number",
+            "default": 50,
+            "scope": "window",
+            "minimum": 0,
+            "description": "Report a warning for any join order whose metric exceeds this value."
+          }
+        }
+      },
+      {
+        "type": "object",
+        "title": "Telemetry",
+        "order": 9,
+        "properties": {
+          "codeQL.telemetry.enableTelemetry": {
+            "type": "boolean",
+            "default": false,
+            "scope": "application",
+            "markdownDescription": "Specifies whether to send CodeQL usage telemetry. This setting AND the global `#telemetry.enableTelemetry#` setting must be checked for telemetry to be sent to GitHub. For more information, see the [telemetry documentation](https://codeql.github.com/docs/codeql-for-visual-studio-code/about-telemetry-in-codeql-for-visual-studio-code)"
+          },
+          "codeQL.telemetry.logTelemetry": {
+            "type": "boolean",
+            "default": false,
+            "scope": "application",
+            "description": "Specifies whether or not to write telemetry events to the extension log."
+          }
         }
       }
-    },
+    ],
     "commands": [
       {
         "command": "codeQL.authenticateToGitHub",
@@ -531,6 +597,11 @@
         "command": "codeQLQueries.runVariantAnalysisContextMenu",
         "title": "Run against variant analysis repositories"
       },
+      {
+        "command": "codeQLQueries.createQuery",
+        "title": "Create query",
+        "icon": "$(new-file)"
+      },
       {
         "command": "codeQLVariantAnalysisRepositories.openConfigFile",
         "title": "Open database configuration file",
@@ -877,8 +948,8 @@
         "enablement": "codeql.hasQLSource"
       },
       {
-        "command": "codeQL.openDataExtensionsEditor",
+        "command": "codeQL.openModelEditor",
-        "title": "CodeQL: Open Data Extensions Editor"
+        "title": "CodeQL: Open CodeQL Model Editor (Beta)"
       },
       {
         "command": "codeQL.mockGitHubApiServer.startRecording",
@@ -940,6 +1011,11 @@
           "when": "view == codeQLDatabases",
           "group": "navigation"
         },
+        {
+          "command": "codeQLQueries.createQuery",
+          "when": "view == codeQLQueries",
+          "group": "navigation"
+        },
         {
           "command": "codeQLQueryHistory.sortByName",
           "when": "view == codeQLQueryHistory",
@@ -1224,6 +1300,10 @@
           "command": "codeQLQueries.runLocalQueriesFromPanel",
           "when": "false"
         },
+        {
+          "command": "codeQLQueries.createQuery",
+          "when": "false"
+        },
         {
           "command": "codeQL.runLocalQueryFromFileTab",
           "when": "false"
@@ -1349,8 +1429,8 @@
           "when": "false"
         },
         {
-          "command": "codeQL.openDataExtensionsEditor",
+          "command": "codeQL.openModelEditor",
-          "when": "config.codeQL.canary && config.codeQL.dataExtensions.editor"
+          "when": "config.codeQL.canary && config.codeQL.model.editor"
         },
         {
           "command": "codeQLQueries.runLocalQueryContextMenu",
@@ -1586,7 +1666,7 @@
         },
         {
           "command": "codeQL.createQuery",
-          "when": "config.codeQL.codespacesTemplate"
+          "when": "config.codeQL.codespacesTemplate || config.codeQL.canary && config.codeQL.queriesPanel"
         },
         {
           "command": "codeQLTests.acceptOutputContextTestItem",
@@ -1658,8 +1738,8 @@
       ],
       "panel": [
         {
-          "id": "codeql-model-details",
+          "id": "codeql-methods-usage",
-          "title": "CodeQL Model Details",
+          "title": "CodeQL Methods Usage",
           "icon": "media/logo.svg"
         }
       ]
@@ -1693,17 +1773,25 @@
           "when": "config.codeQL.canary"
         }
       ],
-      "codeql-model-details": [
+      "codeql-methods-usage": [
         {
-          "id": "codeQLModelDetails",
+          "id": "codeQLMethodsUsage",
-          "name": "CodeQL Model Details",
+          "name": "CodeQL Methods Usage",
-          "when": "config.codeQL.canary && config.codeQL.dataExtensions.modelDetailsView"
+          "when": "config.codeQL.canary && codeql.modelEditorOpen"
+        }
+      ],
+      "explorer": [
+        {
+          "type": "webview",
+          "id": "codeQLMethodModeling",
+          "name": "CodeQL Method Modeling",
+          "when": "config.codeQL.canary && config.codeQL.model.methodModelingView && codeql.modelEditorOpen"
         }
       ]
     },
     "viewsWelcome": [
       {
-        "view": "codeQLModelDetails",
+        "view": "codeQLMethodsUsage",
         "contents": "Loading..."
       },
       {
@@ -1716,7 +1804,8 @@
       },
       {
         "view": "codeQLQueries",
-        "contents": "Looking for queries..."
+        "contents": "We didn't find any CodeQL queries in this workspace. [Create one to get started](command:codeQLQueries.createQuery).",
+        "when": "codeQL.noQueries"
       },
       {
         "view": "codeQLDatabases",
@@ -1816,7 +1905,7 @@
     "@storybook/react-webpack5": "^7.1.0",
     "@storybook/theming": "^7.1.0",
     "@testing-library/dom": "^9.3.0",
-    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^14.0.0",
     "@testing-library/user-event": "^14.4.3",
     "@types/child-process-promise": "^2.2.1",
@@ -1876,7 +1965,7 @@
     "jest": "^29.0.3",
     "jest-environment-jsdom": "^29.0.3",
     "jest-runner-vscode": "^3.0.1",
-    "lint-staged": "^13.2.0",
+    "lint-staged": "^14.0.0",
     "markdownlint-cli2": "^0.6.0",
     "markdownlint-cli2-formatter-pretty": "^0.0.4",
     "mini-css-extract-plugin": "^2.6.1",

extensions/ql-vscode/scripts/add-fields-to-scenarios.ts

@@ -18,15 +18,15 @@ import { Octokit, type RestEndpointMethodTypes } from "@octokit/rest";
 import { throttling } from "@octokit/plugin-throttling";
 
 import { getFiles } from "./util/files";
-import type { GitHubApiRequest } from "../src/variant-analysis/gh-api/mocks/gh-api-request";
+import type { GitHubApiRequest } from "../src/common/mock-gh-api/gh-api-request";
-import { isGetVariantAnalysisRequest } from "../src/variant-analysis/gh-api/mocks/gh-api-request";
+import { isGetVariantAnalysisRequest } from "../src/common/mock-gh-api/gh-api-request";
 import { VariantAnalysis } from "../src/variant-analysis/gh-api/variant-analysis";
 import { RepositoryWithMetadata } from "../src/variant-analysis/gh-api/repository";
 
 const extensionDirectory = resolve(__dirname, "..");
 const scenariosDirectory = resolve(
   extensionDirectory,
-  "src/variant-analysis/gh-api/mocks/scenarios",
+  "src/common/mock-gh-api/scenarios",
 );
 
 // Make sure we don't run into rate limits by automatically waiting until we can

extensions/ql-vscode/scripts/fix-scenario-file-numbering.ts

@@ -22,7 +22,7 @@ const scenarioName = process.argv[2];
 const extensionDirectory = resolve(__dirname, "..");
 const scenariosDirectory = resolve(
   extensionDirectory,
-  "src/variant-analysis/gh-api/mocks/scenarios",
+  "src/common/mock-gh-api/scenarios",
 );
 const scenarioDirectory = resolve(scenariosDirectory, scenarioName);
 

extensions/ql-vscode/scripts/lint-scenarios.ts

@@ -10,7 +10,7 @@ const extensionDirectory = resolve(__dirname, "..");
 const rootDirectory = resolve(extensionDirectory, "../..");
 const scenariosDirectory = resolve(
   extensionDirectory,
-  "src/variant-analysis/gh-api/mocks/scenarios",
+  "src/common/mock-gh-api/scenarios",
 );
 
 const debug = process.env.RUNNER_DEBUG || process.argv.includes("--debug");
@@ -19,7 +19,7 @@ async function lintScenarios() {
   const schema = createGenerator({
     path: resolve(
       extensionDirectory,
-      "src/variant-analysis/gh-api/mocks/gh-api-request.ts",
+      "src/common/mock-gh-api/gh-api-request.ts",
     ),
     tsconfig: resolve(extensionDirectory, "tsconfig.json"),
     type: "GitHubApiRequest",

extensions/ql-vscode/src/common/commands.ts

@@ -12,7 +12,7 @@ import type {
 } from "../variant-analysis/shared/variant-analysis";
 import type { QLDebugConfiguration } from "../debugger/debug-configuration";
 import type { QueryTreeViewItem } from "../queries-panel/query-tree-view-item";
-import type { Usage } from "../data-extensions-editor/external-api-usage";
+import type { Usage } from "../model-editor/method";
 
 // A command function matching the signature that VS Code calls when
 // a command is invoked from a context menu on a TreeView with
@@ -135,6 +135,7 @@ export type LocalQueryCommands = {
   "codeQLQueries.runLocalQueryContextMenu": TreeViewContextSingleSelectionCommandFunction<QueryTreeViewItem>;
   "codeQLQueries.runLocalQueriesContextMenu": TreeViewContextSingleSelectionCommandFunction<QueryTreeViewItem>;
   "codeQLQueries.runLocalQueriesFromPanel": TreeViewContextSingleSelectionCommandFunction<QueryTreeViewItem>;
+  "codeQLQueries.createQuery": () => Promise<void>;
   "codeQL.runLocalQueryFromFileTab": (uri: Uri) => Promise<void>;
   "codeQL.runQueries": ExplorerSelectionCommandFunction<Uri>;
   "codeQL.quickEval": (uri: Uri) => Promise<void>;
@@ -302,9 +303,9 @@ export type PackagingCommands = {
   "codeQL.downloadPacks": () => Promise<void>;
 };
 
-export type DataExtensionsEditorCommands = {
+export type ModelEditorCommands = {
-  "codeQL.openDataExtensionsEditor": () => Promise<void>;
+  "codeQL.openModelEditor": () => Promise<void>;
-  "codeQLDataExtensionsEditor.jumpToUsageLocation": (
+  "codeQLModelEditor.jumpToUsageLocation": (
     usage: Usage,
     databaseItem: DatabaseItem,
   ) => Promise<void>;
@@ -347,7 +348,7 @@ export type AllExtensionCommands = BaseCommands &
   AstCfgCommands &
   AstViewerCommands &
   PackagingCommands &
-  DataExtensionsEditorCommands &
+  ModelEditorCommands &
   EvalLogViewerCommands &
   SummaryLanguageSupportCommands &
   Partial<TestUICommands> &

extensions/ql-vscode/src/common/interface-types.ts

@@ -17,13 +17,10 @@ import {
 } from "../variant-analysis/shared/variant-analysis-filter-sort";
 import { ErrorLike } from "../common/errors";
 import { DataFlowPaths } from "../variant-analysis/shared/data-flow-paths";
-import {
+import { Method, Usage } from "../model-editor/method";
-  ExternalApiUsage,
+import { ModeledMethod } from "../model-editor/modeled-method";
-  Usage,
+import { ModelEditorViewState } from "../model-editor/shared/view-state";
-} from "../data-extensions-editor/external-api-usage";
+import { Mode } from "../model-editor/shared/mode";
-import { ModeledMethod } from "../data-extensions-editor/modeled-method";
-import { DataExtensionEditorViewState } from "../data-extensions-editor/shared/view-state";
-import { Mode } from "../data-extensions-editor/shared/mode";
 
 /**
  * This module contains types and code that are shared between
@@ -494,13 +491,13 @@ export type ToDataFlowPathsMessage = SetDataFlowPathsMessage;
 export type FromDataFlowPathsMessage = CommonFromViewMessages;
 
 interface SetExtensionPackStateMessage {
-  t: "setDataExtensionEditorViewState";
+  t: "setModelEditorViewState";
-  viewState: DataExtensionEditorViewState;
+  viewState: ModelEditorViewState;
 }
 
-interface SetExternalApiUsagesMessage {
+interface SetMethodsMessage {
-  t: "setExternalApiUsages";
+  t: "setMethods";
-  externalApiUsages: ExternalApiUsage[];
+  methods: Method[];
 }
 
 interface LoadModeledMethodsMessage {
@@ -526,6 +523,7 @@ interface SwitchModeMessage {
 
 interface JumpToUsageMessage {
   t: "jumpToUsage";
+  method: Method;
   usage: Usage;
 }
 
@@ -537,29 +535,29 @@ interface OpenExtensionPackMessage {
   t: "openExtensionPack";
 }
 
-interface RefreshExternalApiUsages {
+interface RefreshMethods {
-  t: "refreshExternalApiUsages";
+  t: "refreshMethods";
 }
 
 interface SaveModeledMethods {
   t: "saveModeledMethods";
-  externalApiUsages: ExternalApiUsage[];
+  methods: Method[];
   modeledMethods: Record<string, ModeledMethod>;
 }
 
-interface GenerateExternalApiMessage {
+interface GenerateMethodMessage {
-  t: "generateExternalApi";
+  t: "generateMethod";
 }
 
-interface GenerateExternalApiFromLlmMessage {
+interface GenerateMethodsFromLlmMessage {
-  t: "generateExternalApiFromLlm";
+  t: "generateMethodsFromLlm";
   packageName: string;
-  externalApiUsages: ExternalApiUsage[];
+  methods: Method[];
   modeledMethods: Record<string, ModeledMethod>;
 }
 
-interface StopGeneratingExternalApiFromLlmMessage {
+interface StopGeneratingMethodsFromLlmMessage {
-  t: "stopGeneratingExternalApiFromLlm";
+  t: "stopGeneratingMethodsFromLlm";
   packageName: string;
 }
 
@@ -567,22 +565,39 @@ interface ModelDependencyMessage {
   t: "modelDependency";
 }
 
-export type ToDataExtensionsEditorMessage =
+interface HideModeledApisMessage {
+  t: "hideModeledApis";
+  hideModeledApis: boolean;
+}
+
+export type ToModelEditorMessage =
   | SetExtensionPackStateMessage
-  | SetExternalApiUsagesMessage
+  | SetMethodsMessage
   | LoadModeledMethodsMessage
   | AddModeledMethodsMessage
   | SetInProgressMethodsMessage;
 
-export type FromDataExtensionsEditorMessage =
+export type FromModelEditorMessage =
   | ViewLoadedMsg
   | SwitchModeMessage
-  | RefreshExternalApiUsages
+  | RefreshMethods
   | OpenDatabaseMessage
   | OpenExtensionPackMessage
   | JumpToUsageMessage
   | SaveModeledMethods
-  | GenerateExternalApiMessage
+  | GenerateMethodMessage
-  | GenerateExternalApiFromLlmMessage
+  | GenerateMethodsFromLlmMessage
-  | StopGeneratingExternalApiFromLlmMessage
+  | StopGeneratingMethodsFromLlmMessage
-  | ModelDependencyMessage;
+  | ModelDependencyMessage
+  | HideModeledApisMessage;
+
+export type FromMethodModelingMessage =
+  | TelemetryMessage
+  | UnhandledErrorMessage;
+
+interface SetMethodMessage {
+  t: "setMethod";
+  method: Method;
+}
+
+export type ToMethodModelingMessage = SetMethodMessage;

extensions/ql-vscode/src/common/mock-gh-api/gh-api-request.ts

@@ -1,5 +1,8 @@
-import { Repository } from "../repository";
+import { Repository } from "../../variant-analysis/gh-api/repository";
-import { VariantAnalysis, VariantAnalysisRepoTask } from "../variant-analysis";
+import {
+  VariantAnalysis,
+  VariantAnalysisRepoTask,
+} from "../../variant-analysis/gh-api/variant-analysis";
 
 // Types that represent requests/responses from the GitHub API
 // that we need to mock.

extensions/ql-vscode/src/common/mock-gh-api/mock-gh-api-server.ts

@@ -2,11 +2,11 @@ import { join, resolve } from "path";
 import { pathExists } from "fs-extra";
 import { setupServer, SetupServer } from "msw/node";
 
-import { DisposableObject } from "../../../common/disposable-object";
+import { DisposableObject } from "../disposable-object";
 
 import { Recorder } from "./recorder";
 import { createRequestHandlers } from "./request-handlers";
-import { getDirectoryNamesInsidePath } from "../../../common/files";
+import { getDirectoryNamesInsidePath } from "../files";
 
 /**
  * Enables mocking of the GitHub API server via HTTP interception, using msw.
@@ -129,11 +129,11 @@ export class MockGitHubApiServer extends DisposableObject {
 
   public async getDefaultScenariosPath(): Promise<string | undefined> {
     // This should be the directory where package.json is located
-    const rootDirectory = resolve(__dirname, "../../../..");
+    const rootDirectory = resolve(__dirname, "../../..");
 
     const scenariosPath = resolve(
       rootDirectory,
-      "src/variant-analysis/gh-api/mocks/scenarios",
+      "src/common/mock-gh-api/scenarios",
     );
     if (await pathExists(scenariosPath)) {
       return scenariosPath;

extensions/ql-vscode/src/common/mock-gh-api/recorder.ts

@@ -8,7 +8,7 @@ import { IsomorphicResponse } from "@mswjs/interceptors";
 import { Headers } from "headers-polyfill";
 import fetch from "node-fetch";
 
-import { DisposableObject } from "../../../common/disposable-object";
+import { DisposableObject } from "../disposable-object";
 
 import {
   GetVariantAnalysisRepoResultRequest,

extensions/ql-vscode/src/common/mock-gh-api/scenarios/mrva-problem-query-success/19-getVariantAnalysisRepoResult.json

@@ -5,7 +5,7 @@
   },
   "response": {
     "status": 200,
-    "body": "file:20-getVariantAnalysisRepoResult.body.zip",
+    "body": "file:19-getVariantAnalysisRepoResult.body.zip",
     "contentType": "application/zip"
   }
 }