enable useUnknownInCatchVariables typescript compiler

examples/cactus-example-carbon-accounting-backend/src/test/typescript/integration/admin-enroll-v1-endpoint.test.ts

@@ -12,7 +12,7 @@ import {
 } from "jose";
 import { StatusCodes } from "http-status-codes";
 import jsonStableStringify from "json-stable-stringify";
-
+import { AxiosError } from "axios";
 import {
   AuthorizationProtocol,
   ConfigService,
@@ -46,6 +46,17 @@ const log = LoggerProvider.getOrCreate({
   level: logLevel,
 });
 
+interface ResponseError extends AxiosError {
+  response: {
+    data: any;
+    status: number;
+    statusText: string;
+    headers: any;
+    config: any;
+    request?: any;
+  };
+}
+
 test("BEFORE " + testCase, async (t: Test) => {
   const pruning = pruneDockerAllIfGithubAction({ logLevel });
   await t.doesNotReject(pruning, "Pruning didn't throw OK");
@@ -181,16 +192,18 @@ test.skip(testCase, async (t: Test) => {
   try {
     await apiClientBad.enrollAdminV1({ orgName: "does-not-matter" });
     t.fail("enroll admin response status === 403 FAIL");
-  } catch (out) {
-    t.ok(out, "error thrown for forbidden endpoint truthy OK");
-    t.ok(out.response, "enroll admin response truthy OK");
+  } catch (err) {
+    const e = err as ResponseError;
+
+    t.ok(e, "error thrown for forbidden endpoint truthy OK");
+    t.ok(e.response, "enroll admin response truthy OK");
     t.equal(
-      out.response.status,
+      e?.response?.status,
       StatusCodes.FORBIDDEN,
       "enroll admin response status === 403 OK",
     );
-    t.notok(out.response.data.data, "out.response.data.data falsy OK");
-    t.notok(out.response.data.success, "out.response.data.success falsy OK");
+    t.notok(e?.response?.data?.data, "out.response.data.data falsy OK");
+    t.notok(e?.response?.data?.success, "out.response.data.success falsy OK");
   }
 
   t.end();

examples/cactus-example-discounted-asset-trade-client/src/main/typescript/scripts/run-discounted-asset-trade-client.ts

@@ -189,7 +189,12 @@ async function menuLoop(agent: AnoncredAgent) {
           break;
       }
     } catch (error) {
-      if (error.isTtyError) {
+      if (
+        error &&
+        typeof error === "object" &&
+        "isTtyError" in error &&
+        error.isTtyError
+      ) {
         log.error("Prompt couldn't be rendered in the current environment:");
         isRunning = false;
       }

examples/cactus-example-discounted-asset-trade/indy-endpoints.ts

@@ -7,6 +7,7 @@ import escapeHtml from "escape-html";
 import { getLogger } from "log4js";
 import { ConfigUtil } from "@hyperledger/cactus-cmd-socketio-server";
 import { connectToClientAgent } from "./transaction-indy";
+import { safeStringifyException } from "@hyperledger/cactus-common";
 
 const config: any = ConfigUtil.getConfig();
 const moduleName = "indy-endpoints";
@@ -38,7 +39,7 @@ router.post(
       });
     } catch (err) {
       res.status(500).send({
-        error: escapeHtml(err),
+        error: escapeHtml(safeStringifyException(err)),
       });
       next(err);
     }

extensions/cactus-plugin-htlc-coordinator-besu/src/main/typescript/plugin-htlc-coordinator-besu.ts

@@ -334,7 +334,7 @@ export class PluginHTLCCoordinatorBesu
         try {
           const res = await pluginHtlc.withdraw(withdrawRequest);
           return res;
-        } catch (ex: unknown) {
+        } catch (ex) {
           const cause = ex instanceof Error ? ex : fastSafeStringify(ex);
           throw new WithdrawCounterpartyTxReverted(`EVM tx reverted:`, cause);
         }

extensions/cactus-plugin-htlc-coordinator-besu/src/main/typescript/web-services/counterparty-htlc-endpoint.ts

@@ -15,6 +15,7 @@ import {
 } from "@hyperledger/cactus-common";
 import {
   PluginRegistry,
+  handleRestEndpointException,
   registerWebServiceEndpoint,
 } from "@hyperledger/cactus-core";
 import { CounterpartyHTLCRequest } from "../generated/openapi/typescript-axios";
@@ -108,10 +109,8 @@ export class CounterpartyHTLCEndpoint implements IWebServiceEndpoint {
       res.json(resBody);
     } catch (ex) {
       this.log.error(`Crash while serving ${reqTag}`, ex);
-      res.status(500).json({
-        message: "Internal Server Error",
-        error: ex?.stack || ex?.message,
-      });
+      const errorMsg = "Internal Server Error";
+      handleRestEndpointException({ errorMsg, log: this.log, error: ex, res });
     }
   }
 }

extensions/cactus-plugin-htlc-coordinator-besu/src/main/typescript/web-services/own-htlc-endpoint.ts

@@ -16,6 +16,7 @@ import {
 import {
   registerWebServiceEndpoint,
   PluginRegistry,
+  handleRestEndpointException,
 } from "@hyperledger/cactus-core";
 import { PluginHTLCCoordinatorBesu } from "../plugin-htlc-coordinator-besu";
 import { OwnHTLCRequest } from "../generated/openapi/typescript-axios";
@@ -103,10 +104,8 @@ export class OwnHTLCEndpoint implements IWebServiceEndpoint {
       res.json(resBody);
     } catch (ex) {
       this.log.error(`Crash while serving ${reqTag}`, ex);
-      res.status(500).json({
-        message: "Internal Server Error",
-        error: ex,
-      });
+      const errorMsg = "Internal Server Error";
+      handleRestEndpointException({ errorMsg, log: this.log, error: ex, res });
     }
   }
 }

extensions/cactus-plugin-htlc-coordinator-besu/src/main/typescript/web-services/withdraw-counterparty-endpoint.ts

@@ -104,7 +104,7 @@ export class WithdrawCounterpartyEndpoint implements IWebServiceEndpoint {
       }) as unknown as PluginHTLCCoordinatorBesu;
       const resBody = await connector.withdrawCounterparty(request);
       res.json(resBody);
-    } catch (ex: unknown) {
+    } catch (ex) {
       if (ex instanceof WithdrawCounterpartyTxReverted) {
         this.log.debug("%o %o", reqTag, ex);
         res.status(400).json(ex);

extensions/cactus-plugin-object-store-ipfs/src/main/typescript/plugin-object-store-ipfs.ts

@@ -183,12 +183,12 @@ export class PluginObjectStoreIpfs implements IPluginObjectStore {
       this.log.debug(`StatResult for ${req.key}: %o`, statResult);
       return { key: req.key, checkedAt, isPresent: true };
     } catch (ex) {
-      if (ex?.stack?.includes(K_IPFS_JS_HTTP_ERROR_FILE_DOES_NOT_EXIST)) {
+      if (ex instanceof Error && ex?.stack?.includes(K_IPFS_JS_HTTP_ERROR_FILE_DOES_NOT_EXIST)) {
         const msg = `Stat ${req.key} failed with error message containing phrase "${K_IPFS_JS_HTTP_ERROR_FILE_DOES_NOT_EXIST}" Returning isPresent=false ...`;
         this.log.debug(msg);
         return { key: req.key, checkedAt, isPresent: false };
       } else {
-        throw new RuntimeError(`Checking presence of ${req.key} crashed:`, ex);
+        throw new RuntimeError(`Checking presence of ${req.key} crashed: ${ex}`,);
       }
     }
   }
@@ -204,7 +204,7 @@ export class PluginObjectStoreIpfs implements IPluginObjectStore {
         parents: true,
       });
     } catch (ex) {
-      throw new RuntimeError(`Can't set object ${keyPath}. Write failed:`, ex);
+      throw new RuntimeError(`Can't set object ${keyPath}. Write failed: ${ex}`);
     }
     return {
       key: req.key,

extensions/cactus-plugin-object-store-ipfs/src/main/typescript/web-services/get-object-endpoint-v1.ts

@@ -16,7 +16,10 @@ import {
   IWebServiceEndpoint,
 } from "@hyperledger/cactus-core-api";
 
-import { registerWebServiceEndpoint } from "@hyperledger/cactus-core";
+import {
+  handleRestEndpointException,
+  registerWebServiceEndpoint,
+} from "@hyperledger/cactus-core";
 
 import OAS from "../../json/openapi.json";
 
@@ -93,8 +96,8 @@ export class GetObjectEndpointV1 implements IWebServiceEndpoint {
       res.json(resBody);
     } catch (ex) {
       this.log.error(`${tag} Failed to serve request:`, ex);
-      res.status(500);
-      res.json({ error: ex.stack });
+      const errorMsg = "Internal Server Error";
+      handleRestEndpointException({ errorMsg, log: this.log, error: ex, res });
     }
   }
 }

extensions/cactus-plugin-object-store-ipfs/src/main/typescript/web-services/has-object-endpoint-v1.ts

@@ -16,7 +16,10 @@ import {
   IWebServiceEndpoint,
 } from "@hyperledger/cactus-core-api";
 
-import { registerWebServiceEndpoint } from "@hyperledger/cactus-core";
+import {
+  handleRestEndpointException,
+  registerWebServiceEndpoint,
+} from "@hyperledger/cactus-core";
 
 import OAS from "../../json/openapi.json";
 
@@ -93,8 +96,8 @@ export class HasObjectEndpointV1 implements IWebServiceEndpoint {
       res.json(resBody);
     } catch (ex) {
       this.log.error(`${tag} Failed to serve request:`, ex);
-      res.status(500);
-      res.json({ error: ex.stack });
+      const errorMsg = "Internal Server Error";
+      handleRestEndpointException({ errorMsg, log: this.log, error: ex, res });
     }
   }
 }

extensions/cactus-plugin-object-store-ipfs/src/main/typescript/web-services/set-object-endpoint-v1.ts

@@ -16,7 +16,10 @@ import {
   IWebServiceEndpoint,
 } from "@hyperledger/cactus-core-api";
 
-import { registerWebServiceEndpoint } from "@hyperledger/cactus-core";
+import {
+  handleRestEndpointException,
+  registerWebServiceEndpoint,
+} from "@hyperledger/cactus-core";
 
 import OAS from "../../json/openapi.json";
 
@@ -93,8 +96,8 @@ export class SetObjectEndpointV1 implements IWebServiceEndpoint {
       res.json(resBody);
     } catch (ex) {
       this.log.error(`${tag} Failed to serve request:`, ex);
-      res.status(500);
-      res.json({ error: ex.stack });
+      const errorMsg = "Internal Server Error";
+      handleRestEndpointException({ errorMsg, log: this.log, error: ex, res });
     }
   }
 }

packages/cactus-api-client/src/main/typescript/default-consortium-provider.ts

@@ -18,8 +18,7 @@ export interface IDefaultConsortiumProviderOptions {
 }
 
 export class DefaultConsortiumProvider
-  implements IAsyncProvider<ConsortiumDatabase>
-{
+  implements IAsyncProvider<ConsortiumDatabase> {
   public static readonly CLASS_NAME = "DefaultConsortiumProvider";
 
   private readonly log: Logger;
@@ -64,9 +63,15 @@ export class DefaultConsortiumProvider
       const res = await this.options.apiClient.getConsortiumJwsV1();
       return this.parseConsortiumJws(res.data);
     } catch (ex) {
-      const innerException = (ex.toJSON && ex.toJSON()) || ex;
-      this.log.error(`Request for Consortium JWS failed: `, innerException);
-      throw ex;
+      if (ex instanceof Date && ex !== null) {
+        const innerException = (ex.toJSON && ex.toJSON())
+        this.log.error(`Request for Consortium JWS failed: `, innerException);
+        throw ex;
+      } else {
+        this.log.error(`Request for Consortium JWS failed: `, ex);
+        throw ex;
+      }
+
     }
   }
 }

packages/cactus-api-client/src/test/typescript/integration/default-consortium-provider.test.ts

@@ -32,14 +32,23 @@ test("Reports failures with meaningful information", async (t: Test) => {
       await provider.get();
       t2.fail("Provider.get() did not throw despite API errors.");
     } catch (ex) {
-      t2.ok(ex, "Thrown error truthy OK");
-      t2.ok(ex.message, "Thrown error.message truthy OK");
-      t2.equal(
-        typeof ex.message,
-        "string",
-        "Thrown error.message type string OK",
-      );
-      t2.true(ex.message.includes("timeout"), "Has timeout in msg OK");
+      if (
+        typeof ex === "object" &&
+        ex !== null &&
+        "message" in ex &&
+        typeof ex.message === "string"
+      ) {
+        t2.ok(ex, "Thrown error truthy OK");
+        t2.ok(ex.message, "Thrown error.message truthy OK");
+        t2.equal(
+          typeof ex.message,
+          "string",
+          "Thrown error.message type string OK",
+        );
+        t2.true(ex.message.includes("timeout"), "Has timeout in msg OK");
+      } else {
+        t2.ok(ex, "Thrown error truthy OK");
+      }
     }
     t2.end();
   });
@@ -57,17 +66,23 @@ test("Reports failures with meaningful information", async (t: Test) => {
       await provider.get();
       t2.fail("Provider.get() did not throw despite API errors.");
     } catch (ex) {
-      t2.ok(ex, "Thrown error truthy OK");
-      t2.ok(ex.message, "Thrown error.message truthy OK");
-      t2.equal(
-        typeof ex.message,
-        "string",
-        "Thrown error.message type string OK",
-      );
-      t2.true(
-        ex.message.includes("status code 404"),
-        "Has Status Code in msg OK",
-      );
+      if (typeof ex === "object" && ex !== null) {
+        if ("message" in ex && typeof ex.message === "string") {
+          t2.ok(ex, "Thrown error truthy OK");
+          t2.ok(ex.message, "Thrown error.message truthy OK");
+          t2.equal(
+            typeof ex.message,
+            "string",
+            "Thrown error.message type string OK",
+          );
+          t2.true(
+            ex.message.includes("status code 404"),
+            "Has Status Code in msg OK",
+          );
+        }
+      } else {
+        t2.ok(ex, "Thrown error truthy OK");
+      }
     }
     t2.end();
   });