File size: 5,389 Bytes
1e92f2d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | import debugFactory from 'debug';
import { useCallback, useMemo, useReducer } from 'react';
import {
FormStatus,
FormAndTransactionStatus,
FormAndTransactionStatusAction,
TransactionStatusPayloads,
FormStatusSetter,
FormAndTransactionStatusManager,
TransactionStatusManager,
TransactionStatusState,
TransactionStatus,
} from '../types';
const debug = debugFactory( 'composite-checkout:form-and-transaction-status' );
/**
* A React hook to create the context required by the `FormAndTransactionProvider`.
*
* The state can be accessed with `useFormStatus` and `useTransactionStatus`.
*
*/
export function useFormAndTransactionStatusManager(): FormAndTransactionStatusManager {
const initialState: FormAndTransactionStatus = {
formStatus: FormStatus.LOADING,
transactionStatus: {
transactionStatus: TransactionStatus.NOT_STARTED,
previousTransactionStatus: TransactionStatus.NOT_STARTED,
transactionError: null,
transactionLastResponse: null,
transactionRedirectUrl: null,
},
};
const [ formAndTransactionStatus, dispatchStatusChange ] = useReducer(
formAndTransactionStatusReducer,
initialState
);
const setFormStatus = useCallback< FormStatusSetter >( ( payload ) => {
return dispatchStatusChange( { type: 'FORM_STATUS_CHANGE', payload } );
}, [] );
debug( `form status is ${ formAndTransactionStatus }` );
const resetTransaction = useCallback< TransactionStatusManager[ 'resetTransaction' ] >( () => {
debug( 'resetting transaction' );
dispatchStatusChange( {
type: 'TRANSACTION_STATUS_CHANGE',
payload: { status: TransactionStatus.NOT_STARTED },
} );
}, [] );
const setTransactionComplete = useCallback<
TransactionStatusManager[ 'setTransactionComplete' ]
>( ( response ) => {
debug( 'setting transaction complete' );
dispatchStatusChange( {
type: 'TRANSACTION_STATUS_CHANGE',
payload: { status: TransactionStatus.COMPLETE, response },
} );
}, [] );
const setTransactionError = useCallback< TransactionStatusManager[ 'setTransactionError' ] >(
( errorMessage ) => {
debug( 'setting transaction as error' );
dispatchStatusChange( {
type: 'TRANSACTION_STATUS_CHANGE',
payload: { status: TransactionStatus.ERROR, error: errorMessage },
} );
},
[]
);
const setTransactionPending = useCallback<
TransactionStatusManager[ 'setTransactionPending' ]
>( () => {
debug( 'setting transaction as pending' );
dispatchStatusChange( {
type: 'TRANSACTION_STATUS_CHANGE',
payload: { status: TransactionStatus.PENDING },
} );
}, [] );
const setTransactionRedirecting = useCallback<
TransactionStatusManager[ 'setTransactionRedirecting' ]
>( ( url ) => {
debug( 'setting transaction as redirecting' );
dispatchStatusChange( {
type: 'TRANSACTION_STATUS_CHANGE',
payload: { status: TransactionStatus.REDIRECTING, url },
} );
}, [] );
const {
transactionStatus,
previousTransactionStatus,
transactionLastResponse,
transactionError,
transactionRedirectUrl,
}: TransactionStatusState = formAndTransactionStatus.transactionStatus;
const finalFormStatus = shouldTransactionStatusOverrideFormStatus( transactionStatus )
? FormStatus.SUBMITTING
: formAndTransactionStatus.formStatus;
return useMemo(
() => ( {
formStatus: finalFormStatus,
setFormStatus,
transactionStatus,
previousTransactionStatus,
transactionError,
transactionLastResponse,
transactionRedirectUrl,
resetTransaction,
setTransactionError,
setTransactionComplete,
setTransactionPending,
setTransactionRedirecting,
} ),
[
finalFormStatus,
setFormStatus,
transactionStatus,
previousTransactionStatus,
transactionError,
transactionLastResponse,
transactionRedirectUrl,
resetTransaction,
setTransactionError,
setTransactionComplete,
setTransactionPending,
setTransactionRedirecting,
]
);
}
/**
* If the transaction has started and hasn't failed, then the form status
* should always be SUBMITTING. This function makes that decision.
*/
function shouldTransactionStatusOverrideFormStatus(
transactionStatus: TransactionStatus
): boolean {
if (
transactionStatus !== TransactionStatus.NOT_STARTED &&
transactionStatus !== TransactionStatus.ERROR
) {
return true;
}
return false;
}
function formAndTransactionStatusReducer(
state: FormAndTransactionStatus,
action: FormAndTransactionStatusAction
): FormAndTransactionStatus {
switch ( action.type ) {
case 'FORM_STATUS_CHANGE':
validateFormStatus( action.payload );
debug( 'setting form status to', action.payload );
return { ...state, formStatus: action.payload };
case 'TRANSACTION_STATUS_CHANGE': {
const {
status: newTransactionStatus,
response = null,
error = null,
url = null,
} = action.payload as TransactionStatusPayloads;
return {
...state,
transactionStatus: {
...state.transactionStatus,
previousTransactionStatus: state.transactionStatus.transactionStatus,
transactionStatus: newTransactionStatus,
transactionLastResponse: response,
transactionRedirectUrl: url,
transactionError: error,
},
};
}
default:
return state;
}
}
function validateFormStatus( status: unknown ): asserts status is FormStatus {
if ( ! Object.values( FormStatus ).includes( status as never ) ) {
throw new Error( `Invalid form status '${ status }'` );
}
}
|