fix(payment): PI-4290 google pay shipping address required fix

Author: bc-dronov

packages/google-pay-integration/src/gateways/google-pay-gateway.spec.ts

@@ -8,6 +8,7 @@ import {
 } from '@bigcommerce/checkout-sdk/payment-integration-api';
 import {
     getBillingAddress,
+    getCart,
     getConfig,
     getConsignment,
     getShippingOption,
@@ -33,6 +34,8 @@ describe('GooglePayGateway', () => {
             features: {
                 ...storeConfig.checkoutSettings.features,
                 'PI-2875.googlepay_coupons_handling': true,
+                // experiment name will be added after code freeze
+                experiment_shouldRequestShipping: true,
             },
         },
     };
@@ -166,6 +169,31 @@ describe('GooglePayGateway', () => {
         });
     });
 
+    describe('#setShouldRequestShipping', () => {
+        beforeEach(() => {
+            jest.spyOn(paymentIntegrationService.getState(), 'getCartOrThrow').mockReturnValue(
+                getCart(),
+            );
+        });
+
+        it('_isShippingAddressRequired should return false', async () => {
+            await gateway.initialize(getGeneric);
+            gateway.setShouldRequestShipping(false);
+
+            expect(gateway.getCallbackIntents()).toStrictEqual([CallbackIntentsType.OFFER]);
+        });
+
+        it('_isShippingAddressRequired should be true by default', async () => {
+            await gateway.initialize(getGeneric);
+
+            expect(gateway.getCallbackIntents()).toStrictEqual([
+                CallbackIntentsType.OFFER,
+                CallbackIntentsType.SHIPPING_ADDRESS,
+                CallbackIntentsType.SHIPPING_OPTION,
+            ]);
+        });
+    });
+
     describe('#getMerchantInfo', () => {
         it('should get merchant info', async () => {
             const expectedInfo = {

packages/google-pay-integration/src/gateways/google-pay-gateway.ts

@@ -16,6 +16,7 @@ import {
     PaymentMethod,
     ShippingOption,
 } from '@bigcommerce/checkout-sdk/payment-integration-api';
+import { isExperimentEnabled } from '@bigcommerce/checkout-sdk/utility';
 
 import isGooglePayCardNetworkKey from '../guards/is-google-pay-card-network-key';
 import {
@@ -44,6 +45,7 @@ import {
 export default class GooglePayGateway {
     private _getPaymentMethodFn?: () => PaymentMethod<GooglePayInitializationData>;
     private _isBuyNowFlow = false;
+    private _shouldRequestShipping = true;
     private _currencyCode?: string;
     private _currencyService?: CurrencyService;
 
@@ -423,6 +425,10 @@ export default class GooglePayGateway {
         }
     }
 
+    setShouldRequestShipping(isRequired: boolean): void {
+        this._shouldRequestShipping = isRequired;
+    }
+
     protected getGooglePayInitializationData(): GooglePayInitializationData {
         return guard(
             this.getPaymentMethod().initializationData,
@@ -446,13 +452,26 @@ export default class GooglePayGateway {
     }
 
     private _isShippingAddressRequired(): boolean {
-        const { getCartOrThrow, getStoreConfig, getShippingAddress } =
+        const { getCartOrThrow, getStoreConfigOrThrow, getShippingAddress } =
             this._paymentIntegrationService.getState();
+        const storeConfig = getStoreConfigOrThrow();
+        const features = storeConfig.checkoutSettings.features;
 
-        return (
-            getShippingAddress() === undefined &&
-            itemsRequireShipping(getCartOrThrow(), getStoreConfig())
+        const checkWithExperiment = isExperimentEnabled(
+            features,
+            // experiment name will be added after code freeze
+            'experiment_shouldRequestShipping',
         );
+
+        let shippingContextRequiresCheck: boolean;
+
+        if (checkWithExperiment) {
+            shippingContextRequiresCheck = this._shouldRequestShipping;
+        } else {
+            shippingContextRequiresCheck = getShippingAddress() === undefined;
+        }
+
+        return shippingContextRequiresCheck && itemsRequireShipping(getCartOrThrow(), storeConfig);
     }
 
     private _mapToAddressRequestBody(

packages/google-pay-integration/src/google-pay-payment-processor.ts

@@ -145,6 +145,10 @@ export default class GooglePayPaymentProcessor {
         return this._gateway.getCallbackTriggers();
     }
 
+    setShouldRequestShipping(isRequired: boolean): void {
+        return this._gateway.setShouldRequestShipping(isRequired);
+    }
+
     async handleShippingAddressChange(
         shippingAddress: GooglePayFullBillingAddress,
     ): Promise<ShippingOptionParameters | undefined> {

packages/google-pay-integration/src/google-pay-payment-strategy.ts

@@ -152,6 +152,7 @@ export default class GooglePayPaymentStrategy implements PaymentStrategy {
 
             // TODO: Dispatch Widget Actions
             try {
+                this._googlePayPaymentProcessor.setShouldRequestShipping(false);
                 await this._googlePayPaymentProcessor.initializeWidget();
                 await this._interactWithPaymentSheet();
             } catch (error) {