Merge pull request #2011 from github/robertbrignull/catch_unknown

Enforce that promise rejection values must have unknown type

Author: robertbrignull

extensions/ql-vscode/.eslintrc.js

@@ -7,7 +7,8 @@ module.exports = {
   },
   plugins: [
     "github",
-    "@typescript-eslint"
+    "@typescript-eslint",
+    "etc"
   ],
   env: {
     node: true,
@@ -45,6 +46,7 @@ module.exports = {
     "camelcase": "off",
     "eqeqeq": "off",
     "escompat/no-regexp-lookbehind": "off",
+    "etc/no-implicit-any-catch": "error",
     "filenames/match-regex": "off",
     "filenames/match-regexp": "off",
     "func-style": "off",

extensions/ql-vscode/package-lock.json

@@ -1436,6 +1436,7 @@
     "esbuild": "^0.15.15",
     "eslint": "^8.23.1",
     "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-etc": "^2.0.2",
     "eslint-plugin-github": "^4.4.1",
     "eslint-plugin-jest-dom": "^4.0.2",
     "eslint-plugin-prettier": "^4.2.1",

extensions/ql-vscode/package.json

@@ -136,7 +136,7 @@ async function addFieldsToScenarios() {
   }
 }
 
-addFieldsToScenarios().catch((e) => {
+addFieldsToScenarios().catch((e: unknown) => {
   console.error(e);
   process.exit(2);
 });

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

@@ -72,7 +72,7 @@ async function fixScenarioFiles() {
   }
 }
 
-fixScenarioFiles().catch((e) => {
+fixScenarioFiles().catch((e: unknown) => {
   console.error(e);
   process.exit(2);
 });

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

@@ -66,7 +66,7 @@ async function lintScenarios() {
   }
 }
 
-lintScenarios().catch((e) => {
+lintScenarios().catch((e: unknown) => {
   console.error(e);
   process.exit(2);
 });

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

@@ -931,7 +931,7 @@ export class DatabaseManager extends DisposableObject {
       void extLogger.log("Deleting database from filesystem.");
       await remove(item.databaseUri.fsPath).then(
         () => void extLogger.log(`Deleted '${item.databaseUri.fsPath}'`),
-        (e) =>
+        (e: unknown) =>
           void extLogger.log(
             `Failed to delete '${
               item.databaseUri.fsPath

extensions/ql-vscode/src/databases.ts

@@ -1,5 +1,6 @@
 import { DisposableObject } from "./pure/disposable-object";
 import { extLogger } from "./common";
+import { getErrorMessage } from "./pure/helpers-pure";
 
 /**
  * Base class for "discovery" operations, which scan the file system to find specific kinds of
@@ -61,8 +62,10 @@ export abstract class Discovery<T> extends DisposableObject {
         }
       })
 
-      .catch((err) => {
-        void extLogger.log(`${this.name} failed. Reason: ${err.message}`);
+      .catch((err: unknown) => {
+        void extLogger.log(
+          `${this.name} failed. Reason: ${getErrorMessage(err)}`,
+        );
       })
 
       .finally(() => {

extensions/ql-vscode/src/discovery.ts

@@ -36,7 +36,7 @@ import {
 } from "./remote-query-result";
 import { DownloadLink } from "./download-link";
 import { AnalysesResultsManager } from "./analyses-results-manager";
-import { assertNever } from "../pure/helpers-pure";
+import { assertNever, getErrorMessage } from "../pure/helpers-pure";
 import { QueryStatus } from "../query-status";
 import { DisposableObject } from "../pure/disposable-object";
 import { AnalysisResults } from "./shared/analysis-result";
@@ -149,7 +149,7 @@ export class RemoteQueriesManager extends DisposableObject {
       // Open results in the background
       void this.openResults(remoteQuery, remoteQueryResult).then(
         noop,
-        (err) => void showAndLogErrorMessage(err),
+        (err: unknown) => void showAndLogErrorMessage(getErrorMessage(err)),
       );
     } catch (e) {
       void showAndLogErrorMessage(`Could not open query results. ${e}`);
@@ -473,9 +473,12 @@ export class RemoteQueriesManager extends DisposableObject {
       );
 
       // Ask if the user wants to open the results in the background.
-      void this.askToOpenResults(remoteQuery, queryResult).then(noop, (err) => {
-        void showAndLogErrorMessage(err);
-      });
+      void this.askToOpenResults(remoteQuery, queryResult).then(
+        noop,
+        (err: unknown) => {
+          void showAndLogErrorMessage(getErrorMessage(err));
+        },
+      );
     } else {
       const controllerRepo = `${remoteQuery.controllerRepository.owner}/${remoteQuery.controllerRepository.name}`;
       const workflowRunUrl = `https://github.com/${controllerRepo}/actions/runs/${remoteQuery.actionsWorkflowRunId}`;