add unit tests; update error handling

coinbase · Aug 29, 2024 · 80fceef · 80fceef
1 parent aca460d
commit 80fceef
Show file tree

Hide file tree

Showing 3 changed files with 153 additions and 1 deletion.
diff --git a/src/api/hydrateCharge.test.ts b/src/api/hydrateCharge.test.ts
@@ -0,0 +1,150 @@
+import { afterEach, describe, expect, it, vi } from "vitest";
+import { sendRequest } from "../network/request";
+/**
+ * @vitest-environment node
+ */
+import { hydrateCharge } from "./hydrateCharge";
+import type { HydrateChargeAPIParams, HydrateChargeParams } from "./types";
+import { PAY_HYDRATE_CHARGE } from "../network/definitions/pay";
+import { PAY_INVALID_CHARGE_ERROR_CODE, UNCAUGHT_HYDRATE_CHARGE_ERROR_CODE } from "../pay/constants";
+
+vi.mock("../network/request");
+
+const testCharge = "1b03e80d-4e87-46fd-9772-422a1b693fb7";
+const testSender = "0x98fAbEA34A3A377916EBF7793f37E11EE98D29Eb";
+
+describe("hydrateCharge", () => {
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it("should return a a hydrated charge", async () => {
+    const mockParams: HydrateChargeParams = {
+      sender: testSender,
+      chargeId: testCharge,
+    };
+    const mockAPIParams: HydrateChargeAPIParams = {
+      ...mockParams,
+      chainId: 8453
+    };
+    const mockResponse = {
+      id: 1,
+      jsonrpc: "2.0",
+      result: {
+        id: testCharge,
+        callData: {
+          deadline: "2024-08-29T23:00:38Z",
+          feeAmount: "10000",
+          id: "0xd2e57fb373f246768a193cadd4a5ce1e",
+          operator: "0xd1db362f9d23a029834375afa2b37d91d2e67a95",
+          prefix:
+            "0x4b3220496e666f726d6174696f6e616c204d6573736167653a20333220",
+          recipient: "0xb724dcF5f1156dd8E2AB217921b5Bd46a9e5cAa5",
+          recipientAmount: "990000",
+          recipientCurrency: "0xF175520C52418dfE19C8098071a252da48Cd1C19",
+          refundDestination: testSender,
+          signature:
+            "0xb49a08026bdfdc55e3b1b797a9481fbdb7a9246c73f5f77fece76d5f24e979561f2168862aed0dd72980a4f9930cf23836084f3326b98b5546b280c4f0d57aae1b",
+        },
+        metaData: {
+          chainId: 8453,
+          contractAddress: "0x131642c019AF815Ae5F9926272A70C84AE5C37ab",
+          sender: testSender,
+          settlementCurrencyAddress:
+            "0xF175520C52418dfE19C8098071a252da48Cd1C19",
+        },
+      },
+    };
+    (sendRequest as vi.Mock).mockResolvedValue(mockResponse);
+    const hydratedCharge = await hydrateCharge(mockParams);
+    expect(hydratedCharge).toEqual(mockResponse.result);
+    expect(sendRequest).toHaveBeenCalledTimes(1);
+    expect(sendRequest).toHaveBeenCalledWith(PAY_HYDRATE_CHARGE, [
+      mockAPIParams,
+    ]);
+  });
+
+  it("should return an error if sendRequest fails", async () => {
+    const mockParams: HydrateChargeParams = {
+      sender: testSender,
+      chargeId: testCharge,
+    };
+    const mockAPIParams: HydrateChargeAPIParams = {
+      ...mockParams,
+      chainId: 8453
+    };
+    const mockResponse = {
+      id: 1,
+      jsonrpc: "2.0",
+      result: {
+        id: testCharge,
+        callData: {
+          deadline: "2024-08-29T23:00:38Z",
+          feeAmount: "10000",
+          id: "0xd2e57fb373f246768a193cadd4a5ce1e",
+          operator: "0xd1db362f9d23a029834375afa2b37d91d2e67a95",
+          prefix:
+            "0x4b3220496e666f726d6174696f6e616c204d6573736167653a20333220",
+          recipient: "0xb724dcF5f1156dd8E2AB217921b5Bd46a9e5cAa5",
+          recipientAmount: "990000",
+          recipientCurrency: "0xF175520C52418dfE19C8098071a252da48Cd1C19",
+          refundDestination: testSender,
+          signature:
+            "0xb49a08026bdfdc55e3b1b797a9481fbdb7a9246c73f5f77fece76d5f24e979561f2168862aed0dd72980a4f9930cf23836084f3326b98b5546b280c4f0d57aae1b",
+        },
+        metaData: {
+          chainId: 8453,
+          contractAddress: "0x131642c019AF815Ae5F9926272A70C84AE5C37ab",
+          sender: testSender,
+          settlementCurrencyAddress:
+            "0xF175520C52418dfE19C8098071a252da48Cd1C19",
+        },
+      },
+    };
+    (sendRequest as vi.Mock).mockResolvedValue(mockResponse);
+    const hydratedCharge = await hydrateCharge(mockParams);
+    expect(hydratedCharge).toEqual(mockResponse.result);
+    expect(sendRequest).toHaveBeenCalledTimes(1);
+    expect(sendRequest).toHaveBeenCalledWith(PAY_HYDRATE_CHARGE, [
+      mockAPIParams,
+    ]);
+    const mockError = new Error("hydrateCharge: Error: Failed to send request");
+    (sendRequest as vi.Mock).mockRejectedValue(mockError);
+    const error = await hydrateCharge(mockParams);
+    expect(error).toEqual({
+      code: UNCAUGHT_HYDRATE_CHARGE_ERROR_CODE,
+      error: "Something went wrong",
+      message: "",
+    });
+  });
+
+  it("should return an error object from hydrateCharge", async () => {
+    const mockParams: HydrateChargeParams = {
+      sender: testSender,
+      chargeId: testCharge,
+    };
+    const mockAPIParams: HydrateChargeAPIParams = {
+      ...mockParams,
+      chainId: 8453
+    };
+    const mockResponse = {
+      id: 1,
+      jsonrpc: "2.0",
+      error: {
+        code: -32601,
+        message: "method not found - Not found",
+      },
+    };
+    (sendRequest as vi.Mock).mockResolvedValue(mockResponse);
+    const error = await hydrateCharge(mockParams);
+    expect(error).toEqual({
+      code: PAY_INVALID_CHARGE_ERROR_CODE,
+      error: "method not found - Not found",
+      message: "",
+    });
+    expect(sendRequest).toHaveBeenCalledTimes(1);
+    expect(sendRequest).toHaveBeenCalledWith(PAY_HYDRATE_CHARGE, [
+      mockAPIParams,
+    ]);
+  });
+});
diff --git a/src/api/hydrateCharge.ts b/src/api/hydrateCharge.ts
@@ -1,5 +1,6 @@
 import { PAY_HYDRATE_CHARGE } from '../network/definitions/pay';
 import { sendRequest } from '../network/request';
+import { UNCAUGHT_HYDRATE_CHARGE_ERROR_CODE } from '../pay/constants';
 import { getPayErrorCode } from '../pay/utils/getPayErrorCode';
 import type {
   HydrateChargeAPIParams,
@@ -32,7 +33,7 @@ export async function hydrateCharge({
     return res.result;
   } catch (_error) {
     return {
-      code: getPayErrorCode(),
+      code: UNCAUGHT_HYDRATE_CHARGE_ERROR_CODE,
       error: 'Something went wrong',
       message: '',
     };

diff --git a/src/pay/constants.ts b/src/pay/constants.ts
@@ -2,3 +2,4 @@ export const GENERAL_PAY_ERROR_CODE = 'PAY_ERROR';
 export const PAY_TOO_MANY_REQUESTS_ERROR_CODE = 'PAY_TOO_MANY_REQUESTS_ERROR';
 export const PAY_INVALID_CHARGE_ERROR_CODE = 'PAY_INVALID_CHARGE_ERROR';
 export const PAY_INVALID_PARAMETER_ERROR_CODE = 'PAY_INVALID_PARAMETER_ERROR';
+export const UNCAUGHT_HYDRATE_CHARGE_ERROR_CODE = 'UNCAUGHT_HYDRATE_CHARGE_ERROR';