Merge branch 'main' into robertbrignull/details-multiple-editors

Author: robertbrignull

extensions/ql-vscode/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## [UNRELEASED]
 
+## 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)
+
 ## 1.8.9 - 3 August 2023
 
 - Remove "last updated" information and sorting from variant analysis results view. [#2637](https://github.com/github/vscode-codeql/pull/2637)

extensions/ql-vscode/package-lock.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",
@@ -14,7 +14,7 @@
   },
   "engines": {
     "vscode": "^1.67.0",
-    "node": "^16.13.0",
+    "node": "^16.17.1",
     "npm": ">=7.20.6"
   },
   "categories": [

extensions/ql-vscode/package.json

@@ -34,16 +34,27 @@ export class ModelDetailsDataProvider
     return this.onDidChangeTreeDataEmitter.event;
   }
 
+  /**
+   * Update the data displayed in the tree view.
+   *
+   * Will only trigger an update if the data has changed. This relies on
+   * object identity, so be sure to not mutate the data passed to this
+   * method and instead always pass new objects/arrays.
+   */
   public async setState(
     externalApiUsages: ExternalApiUsage[],
     databaseItem: DatabaseItem,
   ): Promise<void> {
-    this.externalApiUsages = externalApiUsages;
-    this.databaseItem = databaseItem;
-    this.sourceLocationPrefix = await this.databaseItem.getSourceLocationPrefix(
-      this.cliServer,
-    );
-    this.onDidChangeTreeDataEmitter.fire();
+    if (
+      this.externalApiUsages !== externalApiUsages ||
+      this.databaseItem !== databaseItem
+    ) {
+      this.externalApiUsages = externalApiUsages;
+      this.databaseItem = databaseItem;
+      this.sourceLocationPrefix =
+        await this.databaseItem.getSourceLocationPrefix(this.cliServer);
+      this.onDidChangeTreeDataEmitter.fire();
+    }
   }
 
   getTreeItem(item: ModelDetailsTreeViewItem): TreeItem {

extensions/ql-vscode/src/data-extensions-editor/model-details/model-details-data-provider.ts

@@ -134,6 +134,7 @@ import { TestRunner } from "./query-testing/test-runner";
 import { TestManagerBase } from "./query-testing/test-manager-base";
 import { NewQueryRunner, QueryRunner, QueryServerClient } from "./query-server";
 import { QueriesModule } from "./queries-panel/queries-module";
+import { OpenReferencedFileCodeLensProvider } from "./local-queries/open-referenced-file-code-lens-provider";
 
 /**
  * extension.ts
@@ -332,10 +333,17 @@ export async function activate(
 
   const app = new ExtensionApp(ctx);
 
-  const codelensProvider = new QuickEvalCodeLensProvider();
+  const quickEvalCodeLensProvider = new QuickEvalCodeLensProvider();
   languages.registerCodeLensProvider(
     { scheme: "file", language: "ql" },
-    codelensProvider,
+    quickEvalCodeLensProvider,
+  );
+
+  const openReferencedFileCodeLensProvider =
+    new OpenReferencedFileCodeLensProvider();
+  languages.registerCodeLensProvider(
+    { scheme: "file", pattern: "**/*.qlref" },
+    openReferencedFileCodeLensProvider,
   );
 
   ctx.subscriptions.push(distributionConfigListener);

extensions/ql-vscode/src/extension.ts

@@ -8,6 +8,7 @@ import {
   CancellationTokenSource,
   QuickPickItem,
   Range,
+  TabInputText,
   Uri,
   window,
 } from "vscode";
@@ -300,20 +301,18 @@ export class LocalQueries extends DisposableObject {
   }
 
   /**
-   * Gets the current active query.
-   *
-   * For now, the "active query" is just whatever query is in the active text editor. Once we have a
-   * proper "queries" panel, we can provide a way to select the current query there.
+   * Gets the current active query. This is the query that is open in the active tab.
    */
   public async getCurrentQuery(allowLibraryFiles: boolean): Promise<string> {
-    const editor = window.activeTextEditor;
-    if (editor === undefined) {
+    const input = window.tabGroups.activeTabGroup.activeTab?.input;
+
+    if (input === undefined || !isTabInputText(input)) {
       throw new Error(
         "No query was selected. Please select a query and try again.",
       );
     }
 
-    return validateQueryUri(editor.document.uri, allowLibraryFiles);
+    return validateQueryUri(input.uri, allowLibraryFiles);
   }
 
   private async createSkeletonQuery(): Promise<void> {
@@ -581,3 +580,7 @@ export class LocalQueries extends DisposableObject {
       : [];
   }
 }
+
+function isTabInputText(input: any): input is TabInputText {
+  return input?.uri !== undefined;
+}

extensions/ql-vscode/src/local-queries/local-queries.ts

@@ -0,0 +1,34 @@
+import {
+  CodeLensProvider,
+  TextDocument,
+  CodeLens,
+  Command,
+  Range,
+} from "vscode";
+
+export class OpenReferencedFileCodeLensProvider implements CodeLensProvider {
+  async provideCodeLenses(document: TextDocument): Promise<CodeLens[]> {
+    const codeLenses: CodeLens[] = [];
+
+    // A .qlref file is a file that contains a single line with a path to a .ql file.
+    if (document.fileName.endsWith(".qlref")) {
+      const textLine = document.lineAt(0);
+      const range: Range = new Range(
+        textLine.range.start.line,
+        textLine.range.start.character,
+        textLine.range.start.line,
+        textLine.range.end.character,
+      );
+
+      const command: Command = {
+        command: "codeQL.openReferencedFile",
+        title: `Open referenced file`,
+        arguments: [document.uri],
+      };
+      const codeLens = new CodeLens(range, command);
+      codeLenses.push(codeLens);
+    }
+
+    return codeLenses;
+  }
+}

extensions/ql-vscode/src/local-queries/open-referenced-file-code-lens-provider.ts

@@ -0,0 +1,36 @@
+import * as React from "react";
+import { ALERTS_TABLE_NAME } from "../../common/interface-types";
+import {
+  alertExtrasClassName,
+  toggleDiagnosticsClassName,
+} from "./result-table-utils";
+
+interface Props {
+  selectedTable: string;
+  problemsViewSelected: boolean;
+  handleCheckboxChanged: (event: React.ChangeEvent<HTMLInputElement>) => void;
+}
+
+export function ProblemsViewCheckbox(props: Props): JSX.Element | null {
+  const { selectedTable, problemsViewSelected, handleCheckboxChanged } = props;
+
+  if (selectedTable !== ALERTS_TABLE_NAME) {
+    return null;
+  }
+  return (
+    <div className={alertExtrasClassName}>
+      <div className={toggleDiagnosticsClassName}>
+        <input
+          type="checkbox"
+          id="toggle-diagnostics"
+          name="toggle-diagnostics"
+          onChange={handleCheckboxChanged}
+          checked={problemsViewSelected}
+        />
+        <label htmlFor="toggle-diagnostics">
+          Show results in Problems view
+        </label>
+      </div>
+    </div>
+  );
+}

extensions/ql-vscode/src/view/results/ProblemsViewCheckbox.tsx

@@ -0,0 +1,29 @@
+import * as React from "react";
+import { ResultSet } from "../../common/interface-types";
+import { tableHeaderItemClassName } from "./result-table-utils";
+
+interface Props {
+  resultSet?: ResultSet;
+}
+
+function getResultCount(resultSet: ResultSet): number {
+  switch (resultSet.t) {
+    case "RawResultSet":
+      return resultSet.schema.rows;
+    case "InterpretedResultSet":
+      return resultSet.interpretation.numTotalResults;
+  }
+}
+
+export function ResultCount(props: Props): JSX.Element | null {
+  if (!props.resultSet) {
+    return null;
+  }
+
+  const resultCount = getResultCount(props.resultSet);
+  return (
+    <span className={tableHeaderItemClassName}>
+      {resultCount} {resultCount === 1 ? "result" : "results"}
+    </span>
+  );
+}