Merge branch 'main' into koesie10/ast-cfg-typed-commands

Author: koesie10

extensions/ql-vscode/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## [UNRELEASED]
 
 - Show data flow paths of a variant analysis in a new tab
+- Show labels of entities in exported CSV results [#2170](https://github.com/github/vscode-codeql/pull/2170)
 
 ## 1.8.0 - 9 March 2023
 

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

@@ -78,27 +78,42 @@ export type QueryHistoryCommands = {
 
 // Commands used for the local databases panel
 export type LocalDatabasesCommands = {
-  "codeQL.setCurrentDatabase": (uri: Uri) => Promise<void>;
-  "codeQL.setDefaultTourDatabase": () => Promise<void>;
+  // Command palette commands
+  "codeQL.chooseDatabaseFolder": () => Promise<void>;
+  "codeQL.chooseDatabaseArchive": () => Promise<void>;
+  "codeQL.chooseDatabaseInternet": () => Promise<void>;
+  "codeQL.chooseDatabaseGithub": () => Promise<void>;
   "codeQL.upgradeCurrentDatabase": () => Promise<void>;
   "codeQL.clearCache": () => Promise<void>;
 
+  // Explorer context menu
+  "codeQL.setCurrentDatabase": (uri: Uri) => Promise<void>;
+
+  // Database panel view title commands
   "codeQLDatabases.chooseDatabaseFolder": () => Promise<void>;
   "codeQLDatabases.chooseDatabaseArchive": () => Promise<void>;
   "codeQLDatabases.chooseDatabaseInternet": () => Promise<void>;
   "codeQLDatabases.chooseDatabaseGithub": () => Promise<void>;
+  "codeQLDatabases.sortByName": () => Promise<void>;
+  "codeQLDatabases.sortByDateAdded": () => Promise<void>;
+
+  // Database panel context menu
   "codeQLDatabases.setCurrentDatabase": (
     databaseItem: DatabaseItem,
   ) => Promise<void>;
-  "codeQLDatabases.sortByName": () => Promise<void>;
-  "codeQLDatabases.sortByDateAdded": () => Promise<void>;
-  "codeQLDatabases.removeOrphanedDatabases": () => Promise<void>;
 
+  // Database panel selection commands
   "codeQLDatabases.removeDatabase": SelectionCommandFunction<DatabaseItem>;
   "codeQLDatabases.upgradeDatabase": SelectionCommandFunction<DatabaseItem>;
   "codeQLDatabases.renameDatabase": SelectionCommandFunction<DatabaseItem>;
   "codeQLDatabases.openDatabaseFolder": SelectionCommandFunction<DatabaseItem>;
   "codeQLDatabases.addDatabaseSource": SelectionCommandFunction<DatabaseItem>;
+
+  // Codespace template commands
+  "codeQL.setDefaultTourDatabase": () => Promise<void>;
+
+  // Internal commands
+  "codeQLDatabases.removeOrphanedDatabases": () => Promise<void>;
 };
 
 // Commands tied to variant analysis

extensions/ql-vscode/src/extension.ts

@@ -64,6 +64,7 @@ import {
   showInformationMessageWithAction,
   tmpDir,
   tmpDirDisposal,
+  prepareCodeTour,
 } from "./helpers";
 import {
   asError,
@@ -523,6 +524,14 @@ async function installOrUpdateThenTryActivate(
 ): Promise<CodeQLExtensionInterface | Record<string, never>> {
   await installOrUpdateDistribution(ctx, distributionManager, config);
 
+  try {
+    await prepareCodeTour();
+  } catch (e: unknown) {
+    void extLogger.log(
+      `Could not open tutorial workspace automatically: ${getErrorMessage(e)}`,
+    );
+  }
+
   // Display the warnings even if the extension has already activated.
   const distributionResult =
     await getDistributionDisplayingDistributionWarnings(distributionManager);
@@ -972,49 +981,6 @@ async function activateWithInstalledDistribution(
     ),
   );
 
-  ctx.subscriptions.push(
-    commandRunnerWithProgress(
-      "codeQL.chooseDatabaseFolder",
-      (progress: ProgressCallback, token: CancellationToken) =>
-        databaseUI.chooseDatabaseFolder(progress, token),
-      {
-        title: "Choose a Database from a Folder",
-      },
-    ),
-  );
-  ctx.subscriptions.push(
-    commandRunnerWithProgress(
-      "codeQL.chooseDatabaseArchive",
-      (progress: ProgressCallback, token: CancellationToken) =>
-        databaseUI.chooseDatabaseArchive(progress, token),
-      {
-        title: "Choose a Database from an Archive",
-      },
-    ),
-  );
-  ctx.subscriptions.push(
-    commandRunnerWithProgress(
-      "codeQL.chooseDatabaseGithub",
-      async (progress: ProgressCallback, token: CancellationToken) => {
-        await databaseUI.chooseDatabaseGithub(progress, token);
-      },
-      {
-        title: "Adding database from GitHub",
-      },
-    ),
-  );
-  ctx.subscriptions.push(
-    commandRunnerWithProgress(
-      "codeQL.chooseDatabaseInternet",
-      (progress: ProgressCallback, token: CancellationToken) =>
-        databaseUI.chooseDatabaseInternet(progress, token),
-
-      {
-        title: "Adding database from URL",
-      },
-    ),
-  );
-
   ctx.subscriptions.push(
     commandRunner("codeQL.copyVersion", async () => {
       const text = `CodeQL extension version: ${

extensions/ql-vscode/src/helpers.ts

@@ -16,6 +16,7 @@ import {
   window as Window,
   workspace,
   env,
+  commands,
 } from "vscode";
 import { CodeQLCliServer, QlpacksInfo } from "./cli";
 import { UserCancellationException } from "./commandRunner";
@@ -25,6 +26,7 @@ import { telemetryListener } from "./telemetry";
 import { RedactableError } from "./pure/errors";
 import { getQlPackPath } from "./pure/ql";
 import { dbSchemeToLanguage } from "./common/query-language";
+import { isCodespacesTemplate } from "./config";
 
 // Shared temporary folder for the extension.
 export const tmpDir = dirSync({
@@ -266,6 +268,51 @@ export function isFolderAlreadyInWorkspace(folderName: string) {
   );
 }
 
+/** Check if the current workspace is the CodeTour and open the workspace folder.
+ * Without this, we can't run the code tour correctly.
+ **/
+export async function prepareCodeTour(): Promise<void> {
+  if (workspace.workspaceFolders?.length) {
+    const currentFolder = workspace.workspaceFolders[0].uri.fsPath;
+
+    const tutorialWorkspacePath = join(
+      currentFolder,
+      "tutorial.code-workspace",
+    );
+    const toursFolderPath = join(currentFolder, ".tours");
+
+    /** We're opening the tutorial workspace, if we detect it.
+     * This will only happen if the following three conditions are met:
+     * - the .tours folder exists
+     * - the tutorial.code-workspace file exists
+     * - the CODESPACES_TEMPLATE setting doesn't exist (it's only set if the user has already opened
+     * the tutorial workspace so it's a good indicator that the user is in the folder but has ignored
+     * the prompt to open the workspace)
+     */
+    if (
+      (await pathExists(tutorialWorkspacePath)) &&
+      (await pathExists(toursFolderPath)) &&
+      !isCodespacesTemplate()
+    ) {
+      const answer = await showBinaryChoiceDialog(
+        "We've detected you're in the CodeQL Tour repo. We will need to open the workspace file to continue. Reload?",
+      );
+
+      if (!answer) {
+        return;
+      }
+
+      const tutorialWorkspaceUri = Uri.parse(tutorialWorkspacePath);
+
+      void extLogger.log(
+        `In prepareCodeTour() method, going to open the tutorial workspace file: ${tutorialWorkspacePath}`,
+      );
+
+      await commands.executeCommand("vscode.openFolder", tutorialWorkspaceUri);
+    }
+  }
+}
+
 /**
  * Provides a utility method to invoke a function only if a minimum time interval has elapsed since
  * the last invocation of that function.

extensions/ql-vscode/src/local-databases-ui.ts

@@ -208,6 +208,13 @@ export class DatabaseUI extends DisposableObject {
 
   public getCommands(): LocalDatabasesCommands {
     return {
+      "codeQL.chooseDatabaseFolder":
+        this.handleChooseDatabaseFolderFromPalette.bind(this),
+      "codeQL.chooseDatabaseArchive":
+        this.handleChooseDatabaseArchiveFromPalette.bind(this),
+      "codeQL.chooseDatabaseInternet":
+        this.handleChooseDatabaseInternet.bind(this),
+      "codeQL.chooseDatabaseGithub": this.handleChooseDatabaseGithub.bind(this),
       "codeQL.setCurrentDatabase": this.handleSetCurrentDatabase.bind(this),
       "codeQL.setDefaultTourDatabase":
         this.handleSetDefaultTourDatabase.bind(this),
@@ -242,7 +249,7 @@ export class DatabaseUI extends DisposableObject {
     await this.databaseManager.setCurrentDatabaseItem(databaseItem);
   }
 
-  public async chooseDatabaseFolder(
+  private async chooseDatabaseFolder(
     progress: ProgressCallback,
     token: CancellationToken,
   ): Promise<void> {
@@ -268,6 +275,17 @@ export class DatabaseUI extends DisposableObject {
     );
   }
 
+  private async handleChooseDatabaseFolderFromPalette(): Promise<void> {
+    return withProgress(
+      async (progress, token) => {
+        await this.chooseDatabaseFolder(progress, token);
+      },
+      {
+        title: "Choose a Database from a Folder",
+      },
+    );
+  }
+
   private async handleSetDefaultTourDatabase(): Promise<void> {
     return withProgress(
       async (progress, token) => {
@@ -392,7 +410,7 @@ export class DatabaseUI extends DisposableObject {
     }
   }
 
-  public async chooseDatabaseArchive(
+  private async chooseDatabaseArchive(
     progress: ProgressCallback,
     token: CancellationToken,
   ): Promise<void> {
@@ -418,50 +436,47 @@ export class DatabaseUI extends DisposableObject {
     );
   }
 
-  public async chooseDatabaseInternet(
-    progress: ProgressCallback,
-    token: CancellationToken,
-  ): Promise<DatabaseItem | undefined> {
-    return await promptImportInternetDatabase(
-      this.databaseManager,
-      this.storagePath,
-      progress,
-      token,
-      this.queryServer?.cliServer,
+  private async handleChooseDatabaseArchiveFromPalette(): Promise<void> {
+    return withProgress(
+      async (progress, token) => {
+        await this.chooseDatabaseArchive(progress, token);
+      },
+      {
+        title: "Choose a Database from an Archive",
+      },
     );
   }
 
   private async handleChooseDatabaseInternet(): Promise<void> {
     return withProgress(
       async (progress, token) => {
-        await this.chooseDatabaseInternet(progress, token);
+        await promptImportInternetDatabase(
+          this.databaseManager,
+          this.storagePath,
+          progress,
+          token,
+          this.queryServer?.cliServer,
+        );
       },
       {
         title: "Adding database from URL",
       },
     );
   }
 
-  public async chooseDatabaseGithub(
-    progress: ProgressCallback,
-    token: CancellationToken,
-  ): Promise<DatabaseItem | undefined> {
-    const credentials = isCanary() ? this.app.credentials : undefined;
-
-    return await promptImportGithubDatabase(
-      this.databaseManager,
-      this.storagePath,
-      credentials,
-      progress,
-      token,
-      this.queryServer?.cliServer,
-    );
-  }
-
   private async handleChooseDatabaseGithub(): Promise<void> {
     return withProgress(
       async (progress, token) => {
-        await this.chooseDatabaseGithub(progress, token);
+        const credentials = isCanary() ? this.app.credentials : undefined;
+
+        await promptImportGithubDatabase(
+          this.databaseManager,
+          this.storagePath,
+          credentials,
+          progress,
+          token,
+          this.queryServer?.cliServer,
+        );
       },
       {
         title: "Adding database from GitHub",

extensions/ql-vscode/src/query-history/query-history-manager.ts

@@ -48,7 +48,7 @@ import {
 import {
   deserializeQueryHistory,
   serializeQueryHistory,
-} from "../query-serialization";
+} from "./store/query-history-store";
 import { pathExists } from "fs-extra";
 import { CliVersionConstraint } from "../cli";
 import { HistoryItemLabelProvider } from "./history-item-label-provider";

…ons/ql-vscode/src/query-serialization.ts …ery-history/store/query-history-store.tsextensions/ql-vscode/src/query-serialization.ts renamed to extensions/ql-vscode/src/query-history/store/query-history-store.ts extensions/ql-vscode/src/query-serialization.ts renamed to extensions/ql-vscode/src/query-history/store/query-history-store.ts

@@ -1,18 +1,18 @@
 import { pathExists, readFile, remove, mkdir, writeFile } from "fs-extra";
 import { dirname } from "path";
 
-import { showAndLogExceptionWithTelemetry } from "./helpers";
+import { showAndLogExceptionWithTelemetry } from "../../helpers";
 import {
   asError,
   asyncFilter,
   getErrorMessage,
   getErrorStack,
-} from "./pure/helpers-pure";
-import { CompletedQueryInfo, LocalQueryInfo } from "./query-results";
-import { QueryHistoryInfo } from "./query-history/query-history-info";
-import { QueryEvaluationInfo } from "./run-queries-shared";
-import { QueryResultType } from "./pure/legacy-messages";
-import { redactableError } from "./pure/errors";
+} from "../../pure/helpers-pure";
+import { CompletedQueryInfo, LocalQueryInfo } from "../../query-results";
+import { QueryHistoryInfo } from "../query-history-info";
+import { QueryEvaluationInfo } from "../../run-queries-shared";
+import { QueryResultType } from "../../pure/legacy-messages";
+import { redactableError } from "../../pure/errors";
 
 export async function deserializeQueryHistory(
   fsPath: string,

extensions/ql-vscode/src/run-queries-shared.ts

@@ -30,7 +30,7 @@ import { nanoid } from "nanoid";
 import { CodeQLCliServer } from "./cli";
 import { SELECT_QUERY_NAME } from "./contextual/locationFinder";
 import { DatabaseManager } from "./local-databases";
-import { DecodedBqrsChunk } from "./pure/bqrs-cli-types";
+import { DecodedBqrsChunk, EntityValue } from "./pure/bqrs-cli-types";
 import { extLogger, Logger } from "./common";
 import { generateSummarySymbolsFile } from "./log-insights/summary-parser";
 import { getErrorMessage } from "./pure/helpers-pure";
@@ -351,11 +351,17 @@ export class QueryEvaluationInfo {
       chunk.tuples.forEach((tuple) => {
         out.write(
           `${tuple
-            .map((v, i) =>
-              chunk.columns[i].kind === "String"
-                ? `"${typeof v === "string" ? v.replaceAll('"', '""') : v}"`
-                : v,
-            )
+            .map((v, i) => {
+              if (chunk.columns[i].kind === "String") {
+                return `"${
+                  typeof v === "string" ? v.replaceAll('"', '""') : v
+                }"`;
+              } else if (chunk.columns[i].kind === "Entity") {
+                return (v as EntityValue).label;
+              } else {
+                return v;
+              }
+            })
             .join(",")}\n`,
         );
       });

extensions/ql-vscode/supported_cli_versions.json

@@ -1,5 +1,5 @@
 [
-  "v2.12.4",
+  "v2.12.5",
   "v2.11.6",
   "v2.7.6",
   "v2.8.5",