This repository has been archived by the owner on Feb 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 219
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for extensions to filter express payment methods (#4774)
* Support express payment methods filtering by extensions * Add tests for getCanMakePayment and fix payment tests' TS errors * Add comments for payment-method-config-helper test
- Loading branch information
1 parent
410eb43
commit e84577d
Showing
7 changed files
with
205 additions
and
86 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,29 +2,88 @@ | |
| * External dependencies | ||
| */ | ||
| import { registerPaymentMethodExtensionCallbacks } from '@woocommerce/blocks-registry'; | ||
|
|
||
| /** | ||
| * Internal dependencies | ||
| */ | ||
| import * as helpers from '../payment-method-config-helper'; | ||
| import { canMakePaymentExtensionsCallbacks } from '../extensions-config'; | ||
| import { canMakePaymentWithExtensions } from '../payment-method-config-helper'; | ||
|
|
||
| describe( 'canMakePaymentWithExtensions', () => { | ||
| const canMakePaymentArgument = { | ||
| cartTotals: { | ||
| total_items: '1488', | ||
| total_items_tax: '312', | ||
| total_fees: '0', | ||
| total_fees_tax: '0', | ||
| total_discount: '0', | ||
| total_discount_tax: '0', | ||
| total_shipping: '0', | ||
| total_shipping_tax: '0', | ||
| total_price: '1800', | ||
| total_tax: '312', | ||
| tax_lines: [ | ||
| { | ||
| name: 'BTW', | ||
| price: '312', | ||
| rate: '21%', | ||
| }, | ||
| ], | ||
| currency_code: 'EUR', | ||
| currency_symbol: '€', | ||
| currency_minor_unit: 2, | ||
| currency_decimal_separator: ',', | ||
| currency_thousand_separator: '.', | ||
| currency_prefix: '€', | ||
| currency_suffix: '', | ||
| }, | ||
| cartNeedsShipping: true, | ||
| billingData: { | ||
| first_name: 'name', | ||
| last_name: 'Name', | ||
| company: '', | ||
| address_1: 'fdsfdsfdsf', | ||
| address_2: '', | ||
| city: 'Berlin', | ||
| state: '', | ||
| postcode: 'xxxxx', | ||
| country: 'DE', | ||
| email: '[email protected]', | ||
| phone: '1234', | ||
| }, | ||
| shippingAddress: { | ||
| first_name: 'name', | ||
| last_name: 'Name', | ||
| company: '', | ||
| address_1: 'fdsfdsfdsf', | ||
| address_2: '', | ||
| city: 'Berlin', | ||
| state: '', | ||
| postcode: 'xxxxx', | ||
| country: 'DE', | ||
| phone: '1234', | ||
| }, | ||
| selectedShippingMethods: { | ||
| '0': 'free_shipping:1', | ||
| }, | ||
| paymentRequirements: [ 'products' ], | ||
| }; | ||
| describe( 'payment-method-config-helper', () => { | ||
| const trueCallback = jest.fn().mockReturnValue( true ); | ||
| const falseCallback = jest.fn().mockReturnValue( false ); | ||
| const bacsCallback = jest.fn().mockReturnValue( false ); | ||
| const throwsCallback = jest.fn().mockImplementation( () => { | ||
| throw new Error(); | ||
| } ); | ||
| beforeAll( () => { | ||
| // Register extension callbacks for two payment methods. | ||
| registerPaymentMethodExtensionCallbacks( | ||
| 'woocommerce-marketplace-extension', | ||
| { | ||
| // cod: one extension returns true, the other returns false. | ||
| cod: () => trueCallback, | ||
| cod: trueCallback, | ||
| // cheque: returns true only if arg.billingData.postcode is 12345. | ||
| cheque: ( arg ) => arg.billingData.postcode === '12345', | ||
| // bacs: both extensions return false. | ||
| bacs: falseCallback, | ||
| bacs: bacsCallback, | ||
| // woopay: both extensions return true. | ||
| woopay: trueCallback, | ||
| // testpay: one callback errors, one returns true | ||
|
|
@@ -35,9 +94,9 @@ describe( 'canMakePaymentWithExtensions', () => { | |
| 'other-woocommerce-marketplace-extension', | ||
| { | ||
| cod: falseCallback, | ||
| bacs: falseCallback, | ||
| woopay: trueCallback, | ||
| testpay: trueCallback, | ||
| bacs: bacsCallback, | ||
| } | ||
| ); | ||
| } ); | ||
|
|
@@ -46,54 +105,101 @@ describe( 'canMakePaymentWithExtensions', () => { | |
| trueCallback.mockClear(); | ||
| throwsCallback.mockClear(); | ||
| falseCallback.mockClear(); | ||
| bacsCallback.mockClear(); | ||
| } ); | ||
| describe( 'getCanMakePayment', () => { | ||
| it( 'returns callback canMakePaymentWithFeaturesCheck if no extension callback is detected', () => { | ||
| // Define arguments from a payment method ('missing-payment-method') with no registered extension callbacks. | ||
| const args = { | ||
| canMakePayment: jest.fn().mockImplementation( () => true ), | ||
| features: [ 'products' ], | ||
| paymentMethodName: 'missing-payment-method', | ||
| }; | ||
|
|
||
| it( "Returns false without executing the registered callbacks, if the payment method's canMakePayment callback returns false.", () => { | ||
| const canMakePayment = () => false; | ||
| const canMakePaymentWithExtensionsResult = canMakePaymentWithExtensions( | ||
| canMakePayment, | ||
| canMakePaymentExtensionsCallbacks, | ||
| 'cod' | ||
| )(); | ||
| expect( canMakePaymentWithExtensionsResult ).toBe( false ); | ||
| expect( trueCallback ).not.toHaveBeenCalled(); | ||
| } ); | ||
| const canMakePayment = helpers.getCanMakePayment( | ||
| args.canMakePayment, | ||
| args.features, | ||
| args.paymentMethodName | ||
| )( canMakePaymentArgument ); | ||
|
|
||
| it( 'Returns early when a registered callback returns false, without executing all the registered callbacks', () => { | ||
| canMakePaymentWithExtensions( | ||
| () => true, | ||
| canMakePaymentExtensionsCallbacks, | ||
| 'bacs' | ||
| )(); | ||
| expect( falseCallback ).toHaveBeenCalledTimes( 1 ); | ||
| } ); | ||
| // Expect that the result of getCanMakePayment is the result of | ||
| // the payment method's own canMakePayment, as no extension callbacks are called. | ||
| expect( canMakePayment ).toEqual( args.canMakePayment() ); | ||
| } ); | ||
|
|
||
| it( 'Returns true if all extension callbacks return true', () => { | ||
| const result = canMakePaymentWithExtensions( | ||
| () => true, | ||
| canMakePaymentExtensionsCallbacks, | ||
| 'woopay' | ||
| )(); | ||
| expect( result ).toBe( true ); | ||
| } ); | ||
| it( 'returns callbacks from the extensions when they are defined', () => { | ||
| // Define arguments from a payment method (bacs) with registered extension callbacks. | ||
| const args = { | ||
| canMakePaymentConfiguration: jest | ||
| .fn() | ||
| .mockImplementation( () => true ), | ||
| features: [ 'products' ], | ||
| paymentMethodName: 'bacs', | ||
| }; | ||
|
|
||
| it( 'Passes canPayArg to the callback', () => { | ||
| canMakePaymentWithExtensions( | ||
| () => true, | ||
| canMakePaymentExtensionsCallbacks, | ||
| 'woopay' | ||
| )( 'canPayArg' ); | ||
| expect( trueCallback ).toHaveBeenCalledWith( 'canPayArg' ); | ||
| const canMakePayment = helpers.getCanMakePayment( | ||
| args.canMakePaymentConfiguration, | ||
| args.features, | ||
| args.paymentMethodName | ||
| )( canMakePaymentArgument ); | ||
|
|
||
| // Expect that the result of getCanMakePayment is not the result of | ||
| // the payment method's own canMakePayment (args.canMakePaymentConfiguration), | ||
| // but of the registered bacsCallback. | ||
| expect( canMakePayment ).toBe( bacsCallback() ); | ||
| } ); | ||
| } ); | ||
|
|
||
| it( 'Allows all valid callbacks to run, even if one causes an error', () => { | ||
| canMakePaymentWithExtensions( | ||
| () => true, | ||
| canMakePaymentExtensionsCallbacks, | ||
| 'testpay' | ||
| )(); | ||
| expect( console ).toHaveErrored(); | ||
| expect( throwsCallback ).toHaveBeenCalledTimes( 1 ); | ||
| expect( trueCallback ).toHaveBeenCalledTimes( 1 ); | ||
| describe( 'canMakePaymentWithExtensions', () => { | ||
| it( "Returns false without executing the registered callbacks, if the payment method's canMakePayment callback returns false.", () => { | ||
| const canMakePayment = () => false; | ||
| const canMakePaymentWithExtensionsResult = helpers.canMakePaymentWithExtensions( | ||
| canMakePayment, | ||
| canMakePaymentExtensionsCallbacks, | ||
| 'cod' | ||
| )( canMakePaymentArgument ); | ||
| expect( canMakePaymentWithExtensionsResult ).toBe( false ); | ||
| expect( trueCallback ).not.toHaveBeenCalled(); | ||
| } ); | ||
|
|
||
| it( 'Returns early when a registered callback returns false, without executing all the registered callbacks', () => { | ||
| helpers.canMakePaymentWithExtensions( | ||
| () => true, | ||
| canMakePaymentExtensionsCallbacks, | ||
| 'bacs' | ||
| )( canMakePaymentArgument ); | ||
| expect( bacsCallback ).toHaveBeenCalledTimes( 1 ); | ||
| } ); | ||
|
|
||
| it( 'Returns true if all extension callbacks return true', () => { | ||
| const result = helpers.canMakePaymentWithExtensions( | ||
| () => true, | ||
| canMakePaymentExtensionsCallbacks, | ||
| 'woopay' | ||
| )( canMakePaymentArgument ); | ||
| expect( result ).toBe( true ); | ||
| } ); | ||
|
|
||
| it( 'Passes canPayArg to the callback', () => { | ||
| helpers.canMakePaymentWithExtensions( | ||
| () => true, | ||
| canMakePaymentExtensionsCallbacks, | ||
| 'woopay' | ||
| )( canMakePaymentArgument ); | ||
| expect( trueCallback ).toHaveBeenCalledWith( | ||
| canMakePaymentArgument | ||
| ); | ||
| } ); | ||
|
|
||
| it( 'Allows all valid callbacks to run, even if one causes an error', () => { | ||
| helpers.canMakePaymentWithExtensions( | ||
| () => true, | ||
| canMakePaymentExtensionsCallbacks, | ||
| 'testpay' | ||
| )( canMakePaymentArgument ); | ||
| expect( console ).toHaveErrored(); | ||
| expect( throwsCallback ).toHaveBeenCalledTimes( 1 ); | ||
| expect( trueCallback ).toHaveBeenCalledTimes( 1 ); | ||
| } ); | ||
| } ); | ||
| } ); | ||
Oops, something went wrong.