Merge remote-tracking branch 'origin/main' into koesie10/rename-last-commit-to-last-updated

Author: koesie10

extensions/ql-vscode/.eslintrc.js

@@ -49,7 +49,6 @@ const baseConfig = {
     "@typescript-eslint/no-throw-literal": "error",
     "no-useless-escape": 0,
     camelcase: "off",
-    eqeqeq: "off",
     "escompat/no-regexp-lookbehind": "off",
     "etc/no-implicit-any-catch": "error",
     "filenames/match-regex": "off",

extensions/ql-vscode/package.json

@@ -1483,7 +1483,7 @@
   "husky": {
     "hooks": {
       "pre-commit": "npm run format-staged",
-      "pre-push": "npm run lint && scripts/forbid-test-only"
+      "pre-push": "scripts/forbid-test-only"
     }
   },
   "lint-staged": {

extensions/ql-vscode/src/abstract-webview.ts

@@ -51,7 +51,7 @@ export abstract class AbstractWebview<
   }
 
   protected async getPanel(): Promise<WebviewPanel> {
-    if (this.panel == undefined) {
+    if (this.panel === undefined) {
       const { ctx } = this;
 
       // This is an async method, so in theory this method can be called concurrently. To ensure that we don't

extensions/ql-vscode/src/astViewer.ts

@@ -25,7 +25,9 @@ import {
 } from "./pure/bqrs-utils";
 import { commandRunner } from "./commandRunner";
 import { DisposableObject } from "./pure/disposable-object";
-import { showAndLogErrorMessage } from "./helpers";
+import { showAndLogExceptionWithTelemetry } from "./helpers";
+import { asError, getErrorMessage } from "./pure/helpers-pure";
+import { redactableError } from "./pure/errors";
 
 export interface AstItem {
   id: BqrsId;
@@ -146,7 +148,12 @@ export class AstViewer extends DisposableObject {
       () => {
         /**/
       },
-      (err) => showAndLogErrorMessage(err),
+      (error: unknown) =>
+        showAndLogExceptionWithTelemetry(
+          redactableError(
+            asError(error),
+          )`Failed to reveal AST: ${getErrorMessage(error)}`,
+        ),
     );
   }
 
@@ -204,7 +211,12 @@ export class AstViewer extends DisposableObject {
           () => {
             /**/
           },
-          (err) => showAndLogErrorMessage(err),
+          (error: unknown) =>
+            showAndLogExceptionWithTelemetry(
+              redactableError(
+                asError(error),
+              )`Failed to reveal AST: ${getErrorMessage(error)}`,
+            ),
         );
       }
     }

extensions/ql-vscode/src/cli.ts

@@ -384,7 +384,7 @@ export class CodeQLCliServer implements Disposable {
         this.killProcessIfRunning();
         // Report the error (if there is a stderr then use that otherwise just report the error cod or nodejs error)
         const newError =
-          stderrBuffers.length == 0
+          stderrBuffers.length === 0
             ? new Error(`${description} failed: ${err}`)
             : new Error(
                 `${description} failed: ${Buffer.concat(stderrBuffers).toString(

extensions/ql-vscode/src/commandRunner.ts

@@ -6,10 +6,14 @@ import {
   Disposable,
   ProgressLocation,
 } from "vscode";
-import { showAndLogErrorMessage, showAndLogWarningMessage } from "./helpers";
+import {
+  showAndLogExceptionWithTelemetry,
+  showAndLogWarningMessage,
+} from "./helpers";
 import { extLogger } from "./common";
 import { asError, getErrorMessage, getErrorStack } from "./pure/helpers-pure";
 import { telemetryListener } from "./telemetry";
+import { redactableError } from "./pure/errors";
 
 export class UserCancellationException extends Error {
   /**
@@ -125,23 +129,28 @@ export function commandRunner(
     try {
       return await task(...args);
     } catch (e) {
-      const errorMessage = `${getErrorMessage(e) || e} (${commandId})`;
       error = asError(e);
+      const errorMessage = redactableError(error)`${
+        getErrorMessage(e) || e
+      } (${commandId})`;
       const errorStack = getErrorStack(e);
       if (e instanceof UserCancellationException) {
         // User has cancelled this action manually
         if (e.silent) {
-          void extLogger.log(errorMessage);
+          void extLogger.log(errorMessage.fullMessage);
         } else {
-          void showAndLogWarningMessage(errorMessage);
+          void showAndLogWarningMessage(errorMessage.fullMessage);
         }
       } else {
         // Include the full stack in the error log only.
         const fullMessage = errorStack
-          ? `${errorMessage}\n${errorStack}`
-          : errorMessage;
-        void showAndLogErrorMessage(errorMessage, {
+          ? `${errorMessage.fullMessage}\n${errorStack}`
+          : errorMessage.fullMessage;
+        void showAndLogExceptionWithTelemetry(errorMessage, {
           fullMessage,
+          extraTelemetryProperties: {
+            command: commandId,
+          },
         });
       }
       return undefined;
@@ -178,24 +187,31 @@ export function commandRunnerWithProgress<R>(
     try {
       return await withProgress(progressOptionsWithDefaults, task, ...args);
     } catch (e) {
-      const errorMessage = `${getErrorMessage(e) || e} (${commandId})`;
       error = asError(e);
+      const errorMessage = redactableError`${
+        getErrorMessage(e) || e
+      } (${commandId})`;
       const errorStack = getErrorStack(e);
       if (e instanceof UserCancellationException) {
         // User has cancelled this action manually
         if (e.silent) {
-          void outputLogger.log(errorMessage);
+          void outputLogger.log(errorMessage.fullMessage);
         } else {
-          void showAndLogWarningMessage(errorMessage, { outputLogger });
+          void showAndLogWarningMessage(errorMessage.fullMessage, {
+            outputLogger,
+          });
         }
       } else {
         // Include the full stack in the error log only.
         const fullMessage = errorStack
-          ? `${errorMessage}\n${errorStack}`
-          : errorMessage;
-        void showAndLogErrorMessage(errorMessage, {
+          ? `${errorMessage.fullMessage}\n${errorStack}`
+          : errorMessage.fullMessage;
+        void showAndLogExceptionWithTelemetry(errorMessage, {
           outputLogger,
           fullMessage,
+          extraTelemetryProperties: {
+            command: commandId,
+          },
         });
       }
       return undefined;

extensions/ql-vscode/src/config.ts

@@ -357,7 +357,7 @@ export class QueryServerConfigListener
     if (memory === null) {
       return undefined;
     }
-    if (memory == 0 || typeof memory !== "number") {
+    if (memory === 0 || typeof memory !== "number") {
       void extLogger.log(
         `Ignoring value '${memory}' for setting ${MEMORY_SETTING.qualifiedName}`,
       );

extensions/ql-vscode/src/contextual/locationFinder.ts

@@ -128,9 +128,9 @@ function createTemplates(path: string): Record<string, string> {
 function isValidSelect(selectInfo: ResultSetSchema | undefined) {
   return (
     selectInfo &&
-    selectInfo.columns.length == 3 &&
-    selectInfo.columns[0].kind == ColumnKindCode.ENTITY &&
-    selectInfo.columns[1].kind == ColumnKindCode.ENTITY &&
-    selectInfo.columns[2].kind == ColumnKindCode.STRING
+    selectInfo.columns.length === 3 &&
+    selectInfo.columns[0].kind === ColumnKindCode.ENTITY &&
+    selectInfo.columns[1].kind === ColumnKindCode.ENTITY &&
+    selectInfo.columns[2].kind === ColumnKindCode.STRING
   );
 }

extensions/ql-vscode/src/contextual/queryResolver.ts

@@ -7,8 +7,8 @@ import {
   getPrimaryDbscheme,
   getQlPackForDbscheme,
   getOnDiskWorkspaceFolders,
-  showAndLogErrorMessage,
   QlPacksForLanguage,
+  showAndLogExceptionWithTelemetry,
 } from "../helpers";
 import { KeyType, kindOfKeyType, nameOfKeyType, tagOfKeyType } from "./keyType";
 import { CodeQLCliServer } from "../cli";
@@ -18,6 +18,7 @@ import { createInitialQueryInfo } from "../run-queries-shared";
 import { CancellationToken, Uri } from "vscode";
 import { ProgressCallback } from "../commandRunner";
 import { QueryRunner } from "../queryRunner";
+import { redactableError } from "../pure/errors";
 
 export async function qlpackOfDatabase(
   cli: CodeQLCliServer,
@@ -88,22 +89,16 @@ export async function resolveQueries(
   }
 
   // No queries found. Determine the correct error message for the various scenarios.
-  const errorMessage = `No ${nameOfKeyType(
-    keyType,
-  )} queries (tagged "${tagOfKeyType(
-    keyType,
-  )}") could be found in the current library path. \
-    Try upgrading the CodeQL libraries. If that doesn't work, then ${nameOfKeyType(
-      keyType,
-    )} queries are not yet available \
-    for this language.`;
+  const keyTypeName = nameOfKeyType(keyType);
+  const keyTypeTag = tagOfKeyType(keyType);
+  const joinedPacksToSearch = packsToSearch.join(", ");
+  const error = redactableError`No ${keyTypeName} queries (tagged "${keyTypeTag}") could be found in the \
+current library path (tried searching the following packs: ${joinedPacksToSearch}). \
+Try upgrading the CodeQL libraries. If that doesn't work, then ${keyTypeName} queries are not yet available \
+for this language.`;
 
-  void showAndLogErrorMessage(errorMessage);
-  throw new Error(
-    `Couldn't find any queries tagged ${tagOfKeyType(
-      keyType,
-    )} in any of the following packs: ${packsToSearch.join(", ")}.`,
-  );
+  void showAndLogExceptionWithTelemetry(error);
+  throw error;
 }
 
 async function resolveContextualQuery(

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

@@ -30,18 +30,20 @@ import {
   isLikelyDatabaseRoot,
   isLikelyDbLanguageFolder,
   showAndLogErrorMessage,
+  showAndLogExceptionWithTelemetry,
 } from "./helpers";
 import { extLogger } from "./common";
 import {
   importArchiveDatabase,
   promptImportGithubDatabase,
   promptImportInternetDatabase,
 } from "./databaseFetcher";
-import { asyncFilter, getErrorMessage } from "./pure/helpers-pure";
+import { asError, asyncFilter, getErrorMessage } from "./pure/helpers-pure";
 import { QueryRunner } from "./queryRunner";
 import { isCanary } from "./config";
 import { App } from "./common/app";
 import { Credentials } from "./common/authentication";
+import { redactableError } from "./pure/errors";
 
 enum SortOrder {
   NameAsc = "NameAsc",
@@ -354,7 +356,11 @@ export class DatabaseUI extends DisposableObject {
     try {
       await this.chooseAndSetDatabase(true, progress, token);
     } catch (e) {
-      void showAndLogErrorMessage(getErrorMessage(e));
+      void showAndLogExceptionWithTelemetry(
+        redactableError(
+          asError(e),
+        )`Failed to choose and set database: ${getErrorMessage(e)}`,
+      );
     }
   };
 
@@ -437,6 +443,11 @@ export class DatabaseUI extends DisposableObject {
           void extLogger.log(`Deleting orphaned database '${dbDir}'.`);
           await remove(dbDir);
         } catch (e) {
+          void showAndLogExceptionWithTelemetry(
+            redactableError(
+              asError(e),
+            )`Failed to delete orphaned database: ${getErrorMessage(e)}`,
+          );
           failures.push(`${basename(dbDir)}`);
         }
       }),
@@ -458,8 +469,12 @@ export class DatabaseUI extends DisposableObject {
   ): Promise<void> => {
     try {
       await this.chooseAndSetDatabase(false, progress, token);
-    } catch (e) {
-      void showAndLogErrorMessage(getErrorMessage(e));
+    } catch (e: unknown) {
+      void showAndLogExceptionWithTelemetry(
+        redactableError(
+          asError(e),
+        )`Failed to choose and set database: ${getErrorMessage(e)}`,
+      );
     }
   };