feat: new error handling (Open-Attestation#110)

* feat: new error handling (429, 500 etc)

* feat: add new error types

* chore: rm dist from gitignore

* chore: add dist to gitignore

* chore: add oa-verify dist as workaround

- this will trigger GitGuardian

* chore: cleanup and refactor

* feat: handle missing response (429)

* feat: refactor errors, using EthersError to check instead

- using INVALID_ARGUMENT and SERVER_ERROR

* chore: refactor error + error msg

* fix: lint

* feat: added Mock Svc Worker, test case coverage

- installed msw (mock service worker) to mock http responses
- added test case coverage for ethers SERVER_ERROR

* fix: removed focused test .only

* feat: test case coverage for HTTP response errors

* feat: invalid argument/merkleRoot test coverage

* fix: update test snapshot

* chore: remove dist

* fix: tests, moved msw to devDep

* fix: eslint no-extraneous-dependencies

* chore: dist

* chore: remove dist

.eslintrc.json

@@ -27,6 +27,7 @@
     "@typescript-eslint/explicit-module-boundary-types": "off",
     "@typescript-eslint/no-explicit-any": "off",
     "no-unused-expressions": "off",
-    "no-else-return": "off"
+    "no-else-return": "off",
+    "import/no-extraneous-dependencies": ["error", {"devDependencies": ["**/*.test.ts", "**/*.test.tsx"]}]
   }
 }

package.json

@@ -49,6 +49,7 @@
     "eslint-plugin-prettier": "^3.1.4",
     "git-cz": "^4.7.0",
     "jest": "^26.1.0",
+    "msw": "^0.20.5",
     "prettier": "^2.0.5",
     "semantic-release": "^17.1.1",
     "ts-jest": "^26.1.1",

src/types/error.ts

@@ -7,7 +7,9 @@ export enum OpenAttestationEthereumDocumentStoreStatusCode {
   ETHERS_UNHANDLED_ERROR = 3,
   SKIPPED = 4,
   DOCUMENT_REVOKED = 5,
+  INVALID_ARGUMENT = 6,
   CONTRACT_NOT_FOUND = 404,
+  SERVER_ERROR = 500,
 }
 export enum OpenAttestationDocumentSignedCode {
   UNEXPECTED_ERROR = 0,
@@ -21,7 +23,9 @@ export enum OpenAttestationEthereumTokenRegistryStatusCode {
   CONTRACT_ADDRESS_INVALID = 2,
   ETHERS_UNHANDLED_ERROR = 3,
   SKIPPED = 4,
+  INVALID_ARGUMENT = 6,
   CONTRACT_NOT_FOUND = 404,
+  SERVER_ERROR = 500,
 }
 export enum OpenAttestationDnsTxtCode {
   UNEXPECTED_ERROR = 0,

src/common/smartContract/documentStoreErrors.ts → src/verifiers/documentStoreStatus/errors.ts

@@ -9,6 +9,7 @@ const contractNotFound = (address: Hash): Reason => {
     message: `Contract ${address} was not found`,
   };
 };
+
 const contractAddressInvalid = (address: Hash): Reason => {
   return {
     code: OpenAttestationEthereumDocumentStoreStatusCode.CONTRACT_ADDRESS_INVALID,
@@ -19,6 +20,7 @@ const contractAddressInvalid = (address: Hash): Reason => {
     message: `Contract address ${address} is invalid`,
   };
 };
+
 export const contractNotIssued = (merkleRoot: Hash, address: string): Reason => {
   return {
     code: OpenAttestationEthereumDocumentStoreStatusCode.DOCUMENT_NOT_ISSUED,
@@ -39,6 +41,27 @@ export const contractRevoked = (merkleRoot: string, address: string): Reason =>
   };
 };
 
+// This function handles ALL of Ethers SERVER_ERRORs, most likely caused by HTTP 4xx or 5xx errors.
+export const serverError = (): Reason => {
+  return {
+    code: OpenAttestationEthereumDocumentStoreStatusCode.SERVER_ERROR,
+    codeString:
+      OpenAttestationEthereumDocumentStoreStatusCode[OpenAttestationEthereumDocumentStoreStatusCode.SERVER_ERROR],
+    message: `Unable to connect to the Ethereum network, please try again later`,
+  };
+};
+
+// This function handles all INVALID_ARGUMENT errors likely due to invalid hex string,
+// hex data is odd-length or incorrect data length
+export const invalidArgument = (error: EthersError, address: string): Reason => {
+  return {
+    code: OpenAttestationEthereumDocumentStoreStatusCode.INVALID_ARGUMENT,
+    codeString:
+      OpenAttestationEthereumDocumentStoreStatusCode[OpenAttestationEthereumDocumentStoreStatusCode.INVALID_ARGUMENT],
+    message: `Error with smart contract ${address}: ${error.reason}`,
+  };
+};
+
 export const getErrorReason = (error: EthersError, address: string): Reason | null => {
   const reason = error.reason && Array.isArray(error.reason) ? error.reason[0] : error.reason ?? "";
   if (
@@ -55,7 +78,12 @@ export const getErrorReason = (error: EthersError, address: string): Reason | nu
     (reason.toLowerCase() === "invalid address".toLowerCase() && error.code === errors.INVALID_ARGUMENT)
   ) {
     return contractAddressInvalid(address);
+  } else if (error.code === errors.SERVER_ERROR) {
+    return serverError();
+  } else if (error.code === errors.INVALID_ARGUMENT) {
+    return invalidArgument(error, address);
   }
+
   return {
     message: `Error with smart contract ${address}: ${error.reason}`,
     code: OpenAttestationEthereumDocumentStoreStatusCode.ETHERS_UNHANDLED_ERROR,

src/verifiers/documentStoreStatus/openAttestationEthereumDocumentStoreStatus.ts

@@ -3,7 +3,7 @@ import { DocumentStoreFactory } from "@govtechsg/document-store";
 import { DocumentStore } from "@govtechsg/document-store/src/contracts/DocumentStore";
 import { Hash, VerificationFragmentType, VerificationFragment, Verifier } from "../../types/core";
 import { OpenAttestationEthereumDocumentStoreStatusCode } from "../../types/error";
-import { contractNotIssued, getErrorReason, contractRevoked } from "../../common/smartContract/documentStoreErrors";
+import { contractNotIssued, getErrorReason, contractRevoked } from "./errors";
 import { getIssuersDocumentStore, getProvider } from "../../common/utils";
 
 interface IssuanceStatus {