@paypal/checkout-components 5.0.289-alpha.0 → 5.0.289

package/__sdk__.js

@@ -64,7 +64,7 @@ module.exports = {
   },
   connect: {
     entry: "./src/connect/interface",
-    globals
+    globals,
   },
   // @deprecated - renamed to payment-fields to be removed
   fields: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paypal/checkout-components",
-  "version": "5.0.289-alpha.0",
+  "version": "5.0.289",
   "description": "PayPal Checkout components, for integrating checkout products.",
   "main": "index.js",
   "scripts": {
@@ -33,6 +33,7 @@
     "percy-screenshot": "npx playwright install && babel-node ./test/percy/server/createButtonConfigs.js && percy exec -- playwright test --config=./test/percy/playwright.config.js --reporter=dot --pass-with-no-tests",
     "typecheck": "npm run flow-typed && npm run flow",
     "version": "./scripts/version.sh",
+    "vitest": "vitest",
     "webpack": "babel-node $(npm bin)/webpack",
     "webpack-size": "npm run webpack -- --config webpack.config.size",
     "prepare": "husky install",
@@ -109,7 +110,7 @@
     "@krakenjs/zoid": "^10.3.1",
     "@paypal/common-components": "^1.0.35",
     "@paypal/funding-components": "^1.0.31",
-    "@paypal/connect-loader-component": "^1.1.0",
+    "@paypal/connect-loader-component": "1.1.1",
     "@paypal/sdk-client": "^4.0.176",
     "@paypal/sdk-constants": "^1.0.133",
     "@paypal/sdk-logos": "^2.2.6"

package/src/connect/component.jsx

@@ -1,48 +1,79 @@
 /* @flow */
 import { loadAxo } from "@paypal/connect-loader-component";
+import { stringifyError } from "@krakenjs/belter/src";
 import {
   getClientID,
   getClientMetadataID,
   getUserIDToken,
+  getLogger,
 } from "@paypal/sdk-client/src";
 
-// eslint-disable-next-line flowtype/no-weak-types
-export type ConnectComponent = any;
-// TODO: What's the expected structure/approach for this interface. It's not a zoid
-// scenario, so what do we return?
-// -> Looks like it returns a function that accepts the props
-// How do we define the input of merchant params here?
+import { sendCountMetric } from "./sendCountMetric";
+
 // $FlowFixMe
 export const getConnectComponent = async (merchantProps) => {
+  sendCountMetric({
+    name: "pp.app.paypal_sdk.connect.init.count",
+    dimensions: {},
+  });
+
   const cmid = getClientMetadataID();
   const clientID = getClientID();
   const userIdToken = getUserIDToken();
   const { metadata } = merchantProps;
-  // TODO: Sort out integration specifics for inputs
+
+  let loadResult = {};
   try {
-    const loadResult = await loadAxo({
+    loadResult = await loadAxo({
       platform: "PPCP",
       btSdkVersion: "3.97.3-connect-alpha.6.1",
-      minified: false,
+      minified: true,
       metadata,
     });
+  } catch (error) {
+    sendCountMetric({
+      name: "pp.app.paypal_sdk.connect.init.error.count",
+      event: "error",
+      dimensions: {
+        errorName: "connect_load_error",
+      },
+    });
+
+    getLogger().error("load_axo_error", { err: stringifyError(error) });
+
+    throw new Error(error);
+  }
 
-    // FPTI: sdkversion, fraudnet info
-    return await window.braintree.connect.create({
+  try {
+    const connect = await window.braintree.connect.create({
       ...loadResult.metadata, // returns a localeURL for assets
       ...merchantProps, // AXO specific props
       platformOptions: {
         platform: "PPCP",
-        userIdToken, // <merchant-specified-via-data-user-id-token>
-        clientID, // <merchant-specified-to-SDK-on-query-param>
-        clientMetadataID: cmid, // <merchant-specified-via-data-client-metadata-id>
-        fraudnet: () => {
-          return "";
-        }, // Pattern TBD
+        userIdToken,
+        clientID,
+        clientMetadataID: cmid,
       },
     });
+
+    sendCountMetric({
+      name: "pp.app.paypal_sdk.connect.init.success.count",
+      event: "success",
+      dimensions: {},
+    });
+
+    return connect;
   } catch (error) {
-    // FPTI Log here
-    return new Error(error);
+    sendCountMetric({
+      name: "pp.app.paypal_sdk.connect.init.error.count",
+      event: "error",
+      dimensions: {
+        errorName: "connect_init_error",
+      },
+    });
+
+    getLogger().error("init_axo_error", { err: stringifyError(error) });
+
+    throw new Error(error);
   }
 };

package/src/connect/component.test.js

@@ -9,36 +9,41 @@ import { loadAxo } from "@paypal/connect-loader-component";
 import { describe, expect, test, vi } from "vitest";
 
 import { getConnectComponent } from "./component";
+import { sendCountMetric } from "./sendCountMetric";
+
+vi.mock("@paypal/sdk-client/src", () => {
+  return {
+    getClientID: vi.fn(() => "mock-client-id"),
+    getClientMetadataID: vi.fn(() => "mock-cmid"),
+    getUserIDToken: vi.fn(() => "mock-uid"),
+    getLogger: vi.fn(() => ({ metric: vi.fn(), error: vi.fn() })),
+  };
+});
+
+vi.mock("@paypal/connect-loader-component", () => {
+  return {
+    loadAxo: vi.fn(),
+  };
+});
+
+vi.mock("./sendCountMetric", () => {
+  return {
+    sendCountMetric: vi.fn(),
+  };
+});
 
 describe("getConnectComponent: returns ConnectComponent", () => {
   const mockAxoMetadata = { someData: "data" };
   const mockProps = { someProp: "value" };
   beforeEach(() => {
+    vi.clearAllMocks();
     window.braintree = {
       connect: {
         create: vi.fn(),
       },
     };
 
-    vi.mock("@paypal/sdk-client/src", () => {
-      return {
-        getClientID: vi.fn(() => "mock-client-id"),
-        getClientMetadataID: vi.fn(() => "mock-cmid"),
-        getUserIDToken: vi.fn(() => "mock-uid"),
-      };
-    });
-
-    vi.mock("@paypal/connect-loader-component", () => {
-      return {
-        loadAxo: vi.fn(),
-      };
-    });
-
     loadAxo.mockResolvedValue({ metadata: mockAxoMetadata });
-
-    // getClientID.mockReturnValue("mock-client-id");
-    // getClientMetadataID.mockReturnValue("mock-cmid");
-    // getUserIDToken.mockReturnValue("mock-uid");
   });
 
   test("loadAxo and window.braintree.connect.create are called with proper data", async () => {
@@ -57,18 +62,28 @@ describe("getConnectComponent: returns ConnectComponent", () => {
         clientID: "mock-client-id",
         clientMetadataID: "mock-cmid",
         userIdToken: "mock-uid",
-        fraudnet: expect.any(Function),
       },
     });
+    expect(sendCountMetric).toBeCalledTimes(2);
   });
 
   test("loadAxo failure is handled", async () => {
     const errorMessage = "Something went wrong";
     loadAxo.mockRejectedValue(errorMessage);
 
-    const error = await getConnectComponent(mockProps);
+    await expect(() => getConnectComponent(mockProps)).rejects.toThrow(
+      errorMessage
+    );
+    expect(sendCountMetric).toHaveBeenCalledTimes(2);
+  });
+
+  test("connect create failure is handled", async () => {
+    const expectedError = "create failed";
+    window.braintree.connect.create.mockRejectedValue(expectedError);
 
-    expect(error).toBeInstanceOf(Error);
-    expect(error.message).toEqual(errorMessage);
+    await expect(() => getConnectComponent(mockProps)).rejects.toThrow(
+      expectedError
+    );
+    expect(sendCountMetric).toBeCalledTimes(2);
   });
 });

package/src/connect/interface.js

@@ -2,11 +2,11 @@
 /* @flow */
 // flow-disable
 
-import { getConnectComponent, type ConnectComponent } from "./component";
+import { getConnectComponent } from "./component";
 
-type ConnectThing = (merchantProps: any) => ConnectComponent;
+type ConnectComponent = (merchantProps: any) => ConnectComponent;
 // $FlowFixMe
-export const Connect: ConnectThing = async (
+export const Connect: ConnectComponent = async (
   merchantProps: any
 ): ConnectComponent => {
   // $FlowFixMe

package/src/connect/sendCountMetric.js

@@ -0,0 +1,25 @@
+/* @flow */
+import { getLogger } from "@paypal/sdk-client/src";
+
+// TODO: This will be pulled in to a shared sdk-client util
+export const sendCountMetric = ({
+  dimensions,
+  event = "unused",
+  name,
+  value = 1,
+}: {|
+  event?: string,
+  name: string,
+  value?: number,
+  dimensions: {
+    [string]: mixed,
+  },
+  // $FlowIssue return type
+|}) =>
+  getLogger().metric({
+    dimensions,
+    metricEventName: event,
+    metricNamespace: name,
+    metricValue: value,
+    metricType: "counter",
+  });