Merge pull request #2563 from bigcommerce/lazy_strategies

CHECKOUT-9388: Lazy load payment strategies by importing them on demand

Author: davidchin

.eslintrc.json

@@ -84,6 +84,18 @@
                         "fixStyle": "inline-type-imports",
                         "disallowTypeAnnotations": false
                     }
+                ],
+                "@typescript-eslint/no-restricted-imports": [
+                    "error",
+                    {
+                        "paths": [
+                            {
+                                "name": "@bigcommerce/checkout-sdk",
+                                "message": "Direct imports from '@bigcommerce/checkout-sdk' are not allowed. Use type-only imports (import type { ... }) or import from subpaths like '@bigcommerce/checkout-sdk/essential' or '@bigcommerce/checkout-sdk/integrations'.",
+                                "allowTypeImports": true
+                            }
+                        ]
+                    }
                 ]
             }
         },
@@ -138,7 +150,17 @@
                 "plugin:jest-dom/recommended"
             ],
             "rules": {
-                "@typescript-eslint/consistent-type-assertions": "off"
+                "@typescript-eslint/consistent-type-assertions": "off",
+                "@typescript-eslint/no-restricted-imports": "off"
+            }
+        },
+        {
+            "files": [
+                "*.mock.ts",
+                "*.mock.tsx"
+            ],
+            "rules": {
+                "@typescript-eslint/no-restricted-imports": "off"
             }
         }
     ]

packages/adyen-integration/src/adyenv2/AdyenV2PaymentMethod.test.tsx

@@ -6,6 +6,7 @@ import {
     type PaymentInitializeOptions,
     type PaymentMethod,
 } from '@bigcommerce/checkout-sdk';
+import { createAdyenV2PaymentStrategy } from '@bigcommerce/checkout-sdk/integrations/adyen';
 import { act, fireEvent, render, screen } from '@testing-library/react';
 import { Formik } from 'formik';
 import { noop } from 'lodash';
@@ -98,6 +99,7 @@ describe('when using Adyen V2 payment', () => {
 
         expect(initializePayment).toHaveBeenCalledWith(
             expect.objectContaining({
+                integrations: [createAdyenV2PaymentStrategy],
                 adyenv2: {
                     additionalActionOptions: {
                         containerId: 'adyen-scheme-additional-action-component-field',

packages/adyen-integration/src/adyenv2/AdyenV2PaymentMethod.tsx

@@ -5,6 +5,7 @@ import {
     type CardInstrument,
     type PaymentInitializeOptions,
 } from '@bigcommerce/checkout-sdk';
+import { createAdyenV2PaymentStrategy } from '@bigcommerce/checkout-sdk/integrations/adyen';
 import React, { type FunctionComponent, useCallback, useRef, useState } from 'react';
 
 import { type HostedWidgetComponentProps } from '@bigcommerce/checkout/hosted-widget-integration';
@@ -107,6 +108,7 @@ const AdyenV2PaymentMethod: FunctionComponent<PaymentMethodProps> = ({
 
             return checkoutService.initializePayment({
                 ...options,
+                integrations: [createAdyenV2PaymentStrategy],
                 adyenv2: {
                     cardVerificationContainerId:
                         selectedInstrumentId && cardVerificationContainerId,

packages/adyen-integration/src/adyenv3/AdyenV3PaymentMethod.test.tsx

@@ -6,6 +6,7 @@ import {
     type PaymentInitializeOptions,
     type PaymentMethod,
 } from '@bigcommerce/checkout-sdk';
+import { createAdyenV3PaymentStrategy } from '@bigcommerce/checkout-sdk/integrations/adyen';
 import { act, fireEvent, render, screen } from '@testing-library/react';
 import { Formik } from 'formik';
 import { noop } from 'lodash';
@@ -95,6 +96,7 @@ describe('when using AdyenV3 payment', () => {
 
         expect(initializePayment).toHaveBeenCalledWith(
             expect.objectContaining({
+                integrations: [createAdyenV3PaymentStrategy],
                 adyenv3: {
                     cardVerificationContainerId: undefined,
                     containerId: 'adyen-scheme-component-field',

packages/adyen-integration/src/adyenv3/AdyenV3PaymentMethod.tsx

@@ -4,6 +4,7 @@ import {
     type CardInstrument,
     type PaymentInitializeOptions,
 } from '@bigcommerce/checkout-sdk';
+import { createAdyenV3PaymentStrategy } from '@bigcommerce/checkout-sdk/integrations/adyen';
 import React, { type FunctionComponent, useCallback, useRef, useState } from 'react';
 
 import { type HostedWidgetComponentProps } from '@bigcommerce/checkout/hosted-widget-integration';
@@ -105,6 +106,7 @@ const AdyenV3PaymentMethod: FunctionComponent<PaymentMethodProps> = ({
 
             return checkoutService.initializePayment({
                 ...options,
+                integrations: [createAdyenV3PaymentStrategy],
                 adyenv3: {
                     cardVerificationContainerId:
                         selectedInstrumentId && cardVerificationContainerId,

packages/affirm-integration/src/AffirmPaymentMethod.tsx

@@ -1,4 +1,6 @@
-import React, { type FunctionComponent, useMemo } from 'react';
+import { type PaymentInitializeOptions } from '@bigcommerce/checkout-sdk';
+import { createAffirmPaymentStrategy } from '@bigcommerce/checkout-sdk/integrations/affirm';
+import React, { type FunctionComponent, useCallback, useMemo } from 'react';
 
 import { HostedPaymentComponent } from '@bigcommerce/checkout/hosted-payment-integration';
 import { TranslatedString } from '@bigcommerce/checkout/locale';
@@ -14,13 +16,23 @@ const AffirmPaymentMethod: FunctionComponent<PaymentMethodProps> = ({
 }) => {
     const description = useMemo(() => <TranslatedString id="payment.affirm_body_text" />, []);
 
+    const initializeAffirmPayment = useCallback(
+        (options: PaymentInitializeOptions) => {
+            return checkoutService.initializePayment({
+                ...options,
+                integrations: [createAffirmPaymentStrategy],
+            });
+        },
+        [checkoutService],
+    );
+
     return (
         <HostedPaymentComponent
             {...rest}
             checkoutService={checkoutService}
             deinitializePayment={checkoutService.deinitializePayment}
             description={description}
-            initializePayment={checkoutService.initializePayment}
+            initializePayment={initializeAffirmPayment}
         />
     );
 };

packages/amazon-pay-v2-integration/src/AmazonPayV2PaymentMethod.test.tsx

@@ -6,6 +6,7 @@ import {
     type PaymentInitializeOptions,
     type PaymentMethod,
 } from '@bigcommerce/checkout-sdk';
+import { createAmazonPayV2PaymentStrategy } from '@bigcommerce/checkout-sdk/integrations/amazon-pay';
 import { render } from '@testing-library/react';
 import { Formik } from 'formik';
 import { noop } from 'lodash';
@@ -90,6 +91,7 @@ describe('when using AmazonPay payment', () => {
             expect.objectContaining({
                 gatewayId: method.gateway,
                 methodId: 'amazonpay',
+                integrations: [createAmazonPayV2PaymentStrategy],
                 amazonpay: {
                     editButtonId: 'editButtonId',
                 },
@@ -106,6 +108,7 @@ describe('when using AmazonPay payment', () => {
             expect.objectContaining({
                 methodId: method.id,
                 gatewayId: method.gateway,
+                integrations: [createAmazonPayV2PaymentStrategy],
                 [method.id]: {
                     editButtonId: 'editButtonId',
                 },

packages/amazon-pay-v2-integration/src/AmazonPayV2PaymentMethod.tsx

@@ -1,4 +1,5 @@
 import { type PaymentInitializeOptions } from '@bigcommerce/checkout-sdk';
+import { createAmazonPayV2PaymentStrategy } from '@bigcommerce/checkout-sdk/integrations/amazon-pay';
 import { some } from 'lodash';
 import React, { type FunctionComponent, useCallback } from 'react';
 
@@ -27,6 +28,7 @@ const AmazonPayV2PaymentMethod: FunctionComponent<PaymentMethodProps> = ({
         (options: PaymentInitializeOptions) =>
             checkoutService.initializePayment({
                 ...options,
+                integrations: [createAmazonPayV2PaymentStrategy],
                 amazonpay: {
                     editButtonId: 'editButtonId',
                 },

packages/analytics/src/AnalyticsProvider.test.tsx

@@ -1,4 +1,4 @@
-import * as CheckoutSdk from '@bigcommerce/checkout-sdk';
+import * as CheckoutSdk from '@bigcommerce/checkout-sdk/essential';
 import { render } from '@testing-library/react';
 import React, { useEffect } from 'react';
 
@@ -8,12 +8,12 @@ import AnalyticsProvider from './AnalyticsProvider';
 import * as createAnalyticsService from './createAnalyticsService';
 import useAnalytics from './useAnalytics';
 
-jest.mock('@bigcommerce/checkout-sdk', () => {
+jest.mock('@bigcommerce/checkout-sdk/essential', () => {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-return
     return {
         // eslint-disable-next-line @typescript-eslint/naming-convention
         __esModule: true,
-        ...jest.requireActual('@bigcommerce/checkout-sdk'),
+        ...jest.requireActual('@bigcommerce/checkout-sdk/essential'),
     };
 });
 

packages/analytics/src/AnalyticsProvider.tsx

@@ -9,7 +9,7 @@ import {
     createStepTracker,
     type PayPalCommerceAnalyticTrackerService,
     type StepTracker,
-} from '@bigcommerce/checkout-sdk';
+} from '@bigcommerce/checkout-sdk/essential';
 import React, { type ReactNode, useMemo } from 'react';
 
 import AnalyticsContext, { type AnalyticsEvents } from './AnalyticsContext';