fix(payment): CHECKOUT-2789 Add PaypalProPaymentStrategy to handle special conditions for Paypal Payments Pro US

Author: davidchin

src/core/create-payment-strategy-registry.js

@@ -5,6 +5,7 @@ import {
     OfflinePaymentStrategy,
     OffsitePaymentStrategy,
     PaypalExpressPaymentStrategy,
+    PaypalProPaymentStrategy,
     SagePayPaymentStrategy,
 } from './payment/strategies';
 import { PaymentStrategyRegistry } from './payment';
@@ -24,6 +25,7 @@ export default function createPaymentStrategyRegistry(store, placeOrderService)
     registry.addStrategy('legacy', new LegacyPaymentStrategy(store, placeOrderService));
     registry.addStrategy('offline', new OfflinePaymentStrategy(store, placeOrderService));
     registry.addStrategy('offsite', new OffsitePaymentStrategy(store, placeOrderService));
+    registry.addStrategy('paypal', new PaypalProPaymentStrategy(store, placeOrderService));
     registry.addStrategy('paypalexpress', new PaypalExpressPaymentStrategy(store, placeOrderService, scriptLoader));
     registry.addStrategy('paypalexpresscredit', new PaypalExpressPaymentStrategy(store, placeOrderService, scriptLoader));
     registry.addStrategy('sagepay', new SagePayPaymentStrategy(store, placeOrderService, createFormPoster()));

src/core/payment/strategies/index.js

@@ -4,4 +4,5 @@ export { default as OfflinePaymentStrategy } from './offline-payment-strategy';
 export { default as OffsitePaymentStrategy } from './offsite-payment-strategy';
 export { default as PaymentStrategy } from './payment-strategy';
 export { default as PaypalExpressPaymentStrategy } from './paypal-express-payment-strategy';
+export { default as PaypalProPaymentStrategy } from './paypal-pro-payment-strategy';
 export { default as SagePayPaymentStrategy } from './sage-pay-payment-strategy';

src/core/payment/strategies/paypal-pro-payment-strategy.js

@@ -0,0 +1,33 @@
+import { omit, pick } from 'lodash';
+import * as paymentStatusTypes from '../payment-status-types';
+import PaymentStrategy from './payment-strategy';
+
+export default class PaypalProPaymentStrategy extends PaymentStrategy {
+    /**
+     * @inheritdoc
+     */
+    execute(payload, options) {
+        if (this._isPaymentAcknowledged()) {
+            return this._placeOrderService.submitOrder({
+                ...payload,
+                payment: pick(payload.payment, 'name'),
+            }, options);
+        }
+
+        return this._placeOrderService.submitOrder(omit(payload, 'payment'), options)
+            .then(() =>
+                this._placeOrderService.submitPayment(payload.payment, payload.useStoreCredit, options)
+            );
+    }
+
+    /**
+     * @private
+     * @return {boolean}
+     */
+    _isPaymentAcknowledged() {
+        const { checkout } = this._store.getState();
+        const { payment = {} } = checkout.getOrder();
+
+        return payment.status === paymentStatusTypes.ACKNOWLEDGE;
+    }
+}

src/core/payment/strategies/paypal-pro-payment-strategy.spec.js

@@ -0,0 +1,74 @@
+import { omit } from 'lodash';
+import { getOrderRequestBody, getIncompleteOrder } from '../../order/orders.mock';
+import * as paymentStatusTypes from '../payment-status-types';
+import createCheckoutStore from '../../create-checkout-store';
+import PaypalProPaymentStrategy from './paypal-pro-payment-strategy';
+
+describe('PaypalProPaymentStrategy', () => {
+    let placeOrderService;
+    let store;
+    let strategy;
+
+    beforeEach(() => {
+        placeOrderService = {
+            submitOrder: jest.fn(() => Promise.resolve(store.getState())),
+            submitPayment: jest.fn(() => Promise.resolve(store.getState())),
+        };
+
+        store = createCheckoutStore();
+
+        strategy = new PaypalProPaymentStrategy(store, placeOrderService);
+    });
+
+    it('submits order without payment data', async () => {
+        const payload = getOrderRequestBody();
+
+        await strategy.execute(payload);
+
+        expect(placeOrderService.submitOrder).toHaveBeenCalledWith(omit(payload, 'payment'), undefined);
+    });
+
+    it('submits payment separately', async () => {
+        const payload = getOrderRequestBody();
+
+        await strategy.execute(payload);
+
+        expect(placeOrderService.submitPayment).toHaveBeenCalledWith(payload.payment, payload.useStoreCredit, undefined);
+    });
+
+    it('returns checkout state', async () => {
+        const output = await strategy.execute(getOrderRequestBody());
+
+        expect(output).toEqual(store.getState());
+    });
+
+    describe('if payment is acknowledged', () => {
+        beforeEach(() => {
+            const { checkout } = store.getState();
+
+            jest.spyOn(checkout, 'getOrder').mockReturnValue({
+                ...getIncompleteOrder(),
+                payment: { status: paymentStatusTypes.ACKNOWLEDGE },
+            });
+        });
+
+        it('submits order with payment method name', async () => {
+            const payload = getOrderRequestBody();
+
+            await strategy.execute(payload);
+
+            expect(placeOrderService.submitOrder).toHaveBeenCalledWith({
+                ...payload,
+                payment: { name: payload.payment.name },
+            }, undefined);
+        });
+
+        it('does not submit payment separately', async () => {
+            const payload = getOrderRequestBody();
+
+            await strategy.execute(payload);
+
+            expect(placeOrderService.submitPayment).not.toHaveBeenCalled();
+        });
+    });
+});