Defining ThreeDomainSecureClient component interface (#2447)

* chore: prettier

* allow three-domain-secure component

* refactor threedomainsecure component to class

* correct typo

* refactor test for class component

* chore: fix lint

* chore: fix flow issues

* pin flow-remove-types and hermes-parser version due to flow errors

* return methods only instead of entire class

* modify interface to reflect future state

Author: mchoun

Diff for: __sdk__.js

@@ -93,4 +93,7 @@ module.exports = {
   "shopper-insights": {
     entry: "./src/shopper-insights/interface",
   },
+  "three-domain-secure": {
+    entry: "./src/three-domain-secure/interface",
+  },
 };

Diff for: dist/button.js

@@ -101,7 +101,9 @@
     "puppeteer": "^1.20.0",
     "serve": "^14.0.0",
     "vite": "^3.2.4",
-    "vitest": "^1.3.1"
+    "vitest": "^1.3.1",
+    "flow-remove-types": "2.246.0",
+    "hermes-parser": "0.23.1"
   },
   "dependencies": {
     "@krakenjs/beaver-logger": "^5.7.0",

Diff for: dist/test/button.js

@@ -1,30 +1,54 @@
 /* @flow */
-import { getLogger, getSDKToken } from "@paypal/sdk-client/src";
+import { type LoggerType } from "@krakenjs/beaver-logger/src";
+import { ZalgoPromise } from "@krakenjs/zalgo-promise/src";
+import { create, type ZoidComponent } from "@krakenjs/zoid/src";
 import { FPTI_KEY } from "@paypal/sdk-constants/src";
 
 import { ValidationError } from "../lib";
 
-export const getThreeDomainSecure = (): Function => {
-  const sdkToken = getSDKToken();
-  const ThreeDomainSecureAuth = () => {
-    if (sdkToken) {
-      // eslint-disable-next-line no-console
-      console.log("Three Domain Secure Called");
-      // Make a Zoid component and introduce methods here
-      // onSuccess
-      // onCancel
-      // onClose
-      getLogger()
-        .info("three domain secure v2 invoked")
-        .track({
-          [FPTI_KEY.TRANSITION]: "three_DS_auth_v2",
-        });
-    } else {
-      throw new ValidationError(
-        `script data attribute sdk-client-token is required but was not passed`
-      );
-    }
-  };
-
-  return ThreeDomainSecureAuth;
+type SdkConfig = {|
+  sdkToken: ?string,
+|};
+
+const parseSdkConfig = ({ sdkConfig, logger }): SdkConfig => {
+  if (!sdkConfig.sdkToken) {
+    throw new ValidationError(
+      `script data attribute sdk-client-token is required but was not passed`
+    );
+  }
+
+  logger.info("three domain secure v2 invoked").track({
+    [FPTI_KEY.TRANSITION]: "three_DS_auth_v2",
+  });
+
+  return sdkConfig;
 };
+export interface ThreeDomainSecureComponentInterface {
+  isEligible(): ZalgoPromise<boolean>;
+  show(): ZoidComponent<void>;
+}
+export class ThreeDomainSecureComponent {
+  logger: LoggerType;
+  sdkConfig: SdkConfig;
+
+  constructor({
+    logger,
+    sdkConfig,
+  }: {|
+    logger: LoggerType,
+    sdkConfig: SdkConfig,
+  |}) {
+    this.logger = logger;
+    this.sdkConfig = parseSdkConfig({ sdkConfig, logger });
+  }
+
+  isEligible(): ZalgoPromise<boolean> {
+    return new ZalgoPromise((resolve) => {
+      resolve(false);
+    });
+  }
+
+  show() {
+    create({ tag: "", url: "" });
+  }
+}

Diff for: package.json

@@ -1,44 +1,59 @@
 /* @flow */
-import { describe, expect, it, vi } from "vitest";
-import { getSDKToken } from "@paypal/sdk-client/src";
+import { describe, expect, vi } from "vitest";
 
-import { ValidationError } from "../lib";
+import { ThreeDomainSecureComponent } from "./component";
 
-import { getThreeDomainSecure } from "./component";
+const defaultSdkConfig = {
+  sdkToken: "sdk-client-token",
+};
 
-vi.mock("@paypal/sdk-client/src", () => ({
-  getSDKToken: vi.fn(),
-  getLogger: vi.fn(() => ({
+const createThreeDomainSecureComponent = ({
+  sdkConfig = defaultSdkConfig,
+  logger = {
     info: vi.fn().mockReturnThis(),
+    warn: vi.fn().mockReturnThis(),
+    error: vi.fn().mockReturnThis(),
     track: vi.fn().mockReturnThis(),
-    flush: vi.fn().mockReturnThis(),
-  })),
-}));
-vi.mock("../lib", () => ({
-  ValidationError: vi.fn(),
-}));
-describe("getThreeDomainSecure returns ThreeDomainSecureComponent", () => {
-  it("should throw an error if sdkToken is not present", () => {
-    // $FlowFixMe prop missing error
-    getSDKToken.mockReturnValue(undefined);
-    const ThreeDomainSecureComponent = getThreeDomainSecure();
-    expect(() => ThreeDomainSecureComponent()).toThrowError(ValidationError);
-    expect(ValidationError).toHaveBeenCalledWith(
-      `script data attribute sdk-client-token is required but was not passed`
-    );
+    metricCounter: vi.fn().mockReturnThis(),
+  },
+} = {}) =>
+  new ThreeDomainSecureComponent({
+    sdkConfig,
+    // $FlowIssue
+    logger,
   });
-  it("should return the ThreeDomainSecure component and log the correct message", async () => {
-    // eslint-disable-next-line no-empty-function
-    const consoleSpy = vi.spyOn(console, "log").mockImplementation(() => {});
-    // $FlowFixMe prop missing error
-    getSDKToken.mockReturnValue("84ghb8984");
-    const ThreeDomainSecureComponent = getThreeDomainSecure();
-    expect(typeof ThreeDomainSecureComponent).toBe("function");
 
-    // Call the returned component and check the console log
-    await ThreeDomainSecureComponent();
-    expect(consoleSpy).toHaveBeenCalledWith("Three Domain Secure Called");
+afterEach(() => {
+  vi.clearAllMocks();
+});
+
+describe("three domain secure component - isEligible method", () => {
+  test("should return false", async () => {
+    const threeDomainSecuretClient = createThreeDomainSecureComponent();
+    const eligibility = await threeDomainSecuretClient.isEligible();
+    expect(eligibility).toEqual(false);
+  });
+});
 
-    consoleSpy.mockRestore();
+describe("three domain descure component - show method", () => {
+  test.skip("should return a zoid component", () => {
+    const threeDomainSecuretClient = createThreeDomainSecureComponent();
+    threeDomainSecuretClient.show();
+    // create test for zoid component
+  });
+});
+
+describe("three domain secure component - initialization", () => {
+  test("should throw an error if sdkToken is not present", () => {
+    expect(() =>
+      createThreeDomainSecureComponent({
+        sdkConfig: {
+          ...defaultSdkConfig,
+          sdkToken: "",
+        },
+      })
+    ).toThrowError(
+      `script data attribute sdk-client-token is required but was not passed`
+    );
   });
 });

Diff for: src/three-domain-secure/component.jsx

@@ -1,13 +1,26 @@
 /* @flow */
-import { type ZoidComponent } from "@krakenjs/zoid/src";
+import { getLogger, getSDKToken } from "@paypal/sdk-client/src";
 
 import type { LazyExport } from "../types";
 import { protectedExport } from "../lib";
 
-import { getThreeDomainSecure } from "./component";
+import {
+  ThreeDomainSecureComponent,
+  type ThreeDomainSecureComponentInterface,
+} from "./component";
 
-type ThreeDomainSecureAuth = ZoidComponent<void>;
-
-export const ThreeDomainSecureComponent: LazyExport<ThreeDomainSecureAuth> = {
-  __get__: () => protectedExport(getThreeDomainSecure()),
-};
+export const ThreeDomainSecureClient: LazyExport<ThreeDomainSecureComponentInterface> =
+  {
+    __get__: () => {
+      const threeDomainSecureInstance = new ThreeDomainSecureComponent({
+        logger: getLogger(),
+        sdkConfig: {
+          sdkToken: getSDKToken(),
+        },
+      });
+      return protectedExport({
+        isEligible: () => threeDomainSecureInstance.isEligible(),
+        show: () => threeDomainSecureInstance.show(),
+      });
+    },
+  };

Diff for: src/three-domain-secure/component.test.js

@@ -48,11 +48,11 @@ const CARD_FIELD_TYPE = {
 };
 
 type InstallmentsConfiguration = {|
-  financingCountryCode : string,
-  currencyCode : string,
-  billingCountryCode : string,
-  amount : string,
-  includeBuyerInstallments ? : boolean
+  financingCountryCode: string,
+  currencyCode: string,
+  billingCountryCode: string,
+  amount: string,
+  includeBuyerInstallments?: boolean,
 |};
 
 type CardFieldsProps = {|
@@ -109,10 +109,12 @@ type CardFieldsProps = {|
   hcfSessionID: string,
   partnerAttributionID: string,
   merchantID: $ReadOnlyArray<string>,
-  installments? : {|
-    onInstallmentsRequested : () => InstallmentsConfiguration | ZalgoPromise<InstallmentsConfiguration>,
-    onInstallmentsAvailable : (Object) => void,
-    onInstallmentsError? : (Object) => void
+  installments?: {|
+    onInstallmentsRequested: () =>
+      | InstallmentsConfiguration
+      | ZalgoPromise<InstallmentsConfiguration>,
+    onInstallmentsAvailable: (Object) => void,
+    onInstallmentsError?: (Object) => void,
   |},
 |};
 
@@ -445,7 +447,7 @@ export const getCardFieldsComponent: () => CardFieldsComponent = memoize(
           installments: {
             type: "object",
             required: false,
-            value: ({ props }) => props.parent.props.installments
+            value: ({ props }) => props.parent.props.installments,
           },
         },
       });