Create new shouldRetry method in useEmitResponse

woocommerce · Oct 9, 2020 · 7fa0582 · 7fa0582
1 parent cca9407
commit 7fa0582
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 8 deletions.
diff --git a/assets/js/base/context/cart-checkout/checkout-state/index.js b/assets/js/base/context/cart-checkout/checkout-state/index.js
@@ -101,6 +101,7 @@ export const CheckoutStateProvider = ( {
 		isSuccessResponse,
 		isErrorResponse,
 		isFailResponse,
+		shouldRetry,
 	} = useEmitResponse();
 
 	// set observers on ref so it's always current.
@@ -237,10 +238,7 @@ export const CheckoutStateProvider = ( {
 							addErrorNotice( response.message, errorOptions );
 						}
 						// irrecoverable error so set complete
-						if (
-							typeof response.retry !== 'undefined' &&
-							response.retry !== true
-						) {
+						if ( ! shouldRetry( response ) ) {
 							dispatch( actions.setComplete( response ) );
 						} else {
 							dispatch( actions.setIdle() );
@@ -278,10 +276,7 @@ export const CheckoutStateProvider = ( {
 								: undefined;
 							addErrorNotice( response.message, errorOptions );
 						}
-						if (
-							typeof response.retry !== 'undefined' &&
-							response.retry !== true
-						) {
+						if ( ! shouldRetry( response ) ) {
 							dispatch( actions.setComplete( response ) );
 						} else {
 							// this will set an error which will end up

diff --git a/assets/js/base/hooks/checkout/use-emit-response.js b/assets/js/base/hooks/checkout/use-emit-response.js
@@ -37,6 +37,10 @@ const isFailResponse = ( response ) => {
 	return isResponseOf( response, responseTypes.FAIL );
 };
 
+const shouldRetry = ( response ) => {
+	return typeof response.retry === 'undefined' || response.retry === true;
+};
+
 /**
  * A custom hook exposing response utilities for emitters.
  *
@@ -47,6 +51,7 @@ export const useEmitResponse = () => {
 	return {
 		responseTypes,
 		noticeContexts,
+		shouldRetry,
 		isSuccessResponse,
 		isErrorResponse,
 		isFailResponse,

diff --git a/assets/js/type-defs/hooks.js b/assets/js/type-defs/hooks.js
@@ -148,6 +148,8 @@
  *                                                        be used in returned response objects.
  * @property {NoticeContexts}           noticeContexts    An object of various notice contexts that can
  *                                                        be used for targeting where a notice appears.
+ * @property {function(Object):boolean} shouldRetry       Returns whether the user is allowed to retry
+ *                                                        the payment after a failed one.
  * @property {function(Object):boolean} isSuccessResponse Returns whether the given response is of a
  *                                                        success response type.
  * @property {function(Object):boolean} isErrorResponse   Returns whether the given response is of an

diff --git a/docs/extensibility/checkout-flow-and-events.md b/docs/extensibility/checkout-flow-and-events.md
@@ -174,6 +174,7 @@ const Component = () => {
 		isFailResponse,
 		noticeContexts,
 		responseTypes,
+		shouldRetry,
 	} = useEmitResponse;
 	return null;
 };
@@ -186,6 +187,7 @@ The properties of the object returned by this hook are:
     -   `PAYMENTS`: This is a reference to the notice area in the payment methods step.
     -   `EXPRESS_PAYMENTS`: This is a reference to the notice area in the express payment methods step.
 -   `responseTypes`: This is an object containing properties referencing the various response types that can be returned by observers for some event emitters. It makes it easier for autocompleting the types and avoiding typos due to human error. The types are `SUCCESS`, `FAIL`, `ERROR`. The values for these types also correspond to the [payment status types](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/34e17c3622637dbe8b02fac47b5c9b9ebf9e3596/src/Payments/PaymentResult.php#L21) from the [checkout endpoint response from the server](https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/34e17c3622637dbe8b02fac47b5c9b9ebf9e3596/src/RestApi/StoreApi/Schemas/CheckoutSchema.php#L103-L113).
+-   `shouldRetry`: This is a function containing the logic whether the checkout flow should allow the user to retry the payment after a previous payment failed. It receives the `response` object and by default checks whether the `retry` property is true/undefined or false. Refer to the [`onCheckoutAfterProcessingWithSuccess`](#oncheckoutafterprocessingwithsuccess) documentation for more details.
 
 Note: `noticeContexts` and `responseTypes` are exposed to payment methods via the `emitResponse` prop given to their component: