-
Notifications
You must be signed in to change notification settings - Fork 3.3k
[CP Staging] add validate code modal #48628
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
f9a20e3
778c68b
4582516
541f282
ae40d6a
2cc3b95
5022fa8
35d064c
7578c92
cdcd287
3915b4b
e1d133b
d88b0c3
5296333
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,257 @@ | ||
import {useFocusEffect} from '@react-navigation/native'; | ||
import type {ForwardedRef} from 'react'; | ||
import React, {useCallback, useEffect, useImperativeHandle, useRef, useState} from 'react'; | ||
import {View} from 'react-native'; | ||
import type {OnyxEntry} from 'react-native-onyx'; | ||
import {withOnyx} from 'react-native-onyx'; | ||
import Button from '@components/Button'; | ||
import DotIndicatorMessage from '@components/DotIndicatorMessage'; | ||
import MagicCodeInput from '@components/MagicCodeInput'; | ||
import type {AutoCompleteVariant, MagicCodeInputHandle} from '@components/MagicCodeInput'; | ||
import OfflineWithFeedback from '@components/OfflineWithFeedback'; | ||
import PressableWithFeedback from '@components/Pressable/PressableWithFeedback'; | ||
import Text from '@components/Text'; | ||
import useLocalize from '@hooks/useLocalize'; | ||
import useNetwork from '@hooks/useNetwork'; | ||
import useStyleUtils from '@hooks/useStyleUtils'; | ||
import useTheme from '@hooks/useTheme'; | ||
import useThemeStyles from '@hooks/useThemeStyles'; | ||
import * as ErrorUtils from '@libs/ErrorUtils'; | ||
import * as ValidationUtils from '@libs/ValidationUtils'; | ||
import * as User from '@userActions/User'; | ||
import CONST from '@src/CONST'; | ||
import type {TranslationPaths} from '@src/languages/types'; | ||
import ONYXKEYS from '@src/ONYXKEYS'; | ||
import type {Account, ValidateMagicCodeAction} from '@src/types/onyx'; | ||
import type {Errors, PendingAction} from '@src/types/onyx/OnyxCommon'; | ||
import {isEmptyObject} from '@src/types/utils/EmptyObject'; | ||
|
||
type ValidateCodeFormHandle = { | ||
focus: () => void; | ||
focusLastSelected: () => void; | ||
}; | ||
|
||
type ValidateCodeFormError = { | ||
validateCode?: TranslationPaths; | ||
}; | ||
|
||
type BaseValidateCodeFormOnyxProps = { | ||
/** The details about the account that the user is signing in with */ | ||
account: OnyxEntry<Account>; | ||
}; | ||
|
||
type ValidateCodeFormProps = { | ||
/** If the magic code has been resent previously */ | ||
hasMagicCodeBeenSent?: boolean; | ||
|
||
/** Specifies autocomplete hints for the system, so it can provide autofill */ | ||
autoComplete?: AutoCompleteVariant; | ||
|
||
/** Forwarded inner ref */ | ||
innerRef?: ForwardedRef<ValidateCodeFormHandle>; | ||
|
||
/** The state of magic code that being sent */ | ||
validateCodeAction?: ValidateMagicCodeAction; | ||
|
||
/** The pending action for submitting form */ | ||
validatePendingAction?: PendingAction | null; | ||
|
||
/** The error of submitting */ | ||
validateError?: Errors; | ||
|
||
/** Function is called when submitting form */ | ||
handleSubmitForm: (validateCode: string) => void; | ||
|
||
/** Function to clear error of the form */ | ||
clearError: () => void; | ||
}; | ||
|
||
type BaseValidateCodeFormProps = BaseValidateCodeFormOnyxProps & ValidateCodeFormProps; | ||
|
||
function BaseValidateCodeForm({ | ||
account = {}, | ||
hasMagicCodeBeenSent, | ||
autoComplete = 'one-time-code', | ||
innerRef = () => {}, | ||
validateCodeAction, | ||
validatePendingAction, | ||
validateError, | ||
handleSubmitForm, | ||
clearError, | ||
}: BaseValidateCodeFormProps) { | ||
const {translate} = useLocalize(); | ||
const {isOffline} = useNetwork(); | ||
const theme = useTheme(); | ||
const styles = useThemeStyles(); | ||
const StyleUtils = useStyleUtils(); | ||
const [formError, setFormError] = useState<ValidateCodeFormError>({}); | ||
const [validateCode, setValidateCode] = useState(''); | ||
const inputValidateCodeRef = useRef<MagicCodeInputHandle>(null); | ||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing -- nullish coalescing doesn't achieve the same result in this case | ||
const shouldDisableResendValidateCode = !!isOffline || account?.isLoading; | ||
const focusTimeoutRef = useRef<NodeJS.Timeout | null>(null); | ||
|
||
useImperativeHandle(innerRef, () => ({ | ||
focus() { | ||
inputValidateCodeRef.current?.focus(); | ||
}, | ||
focusLastSelected() { | ||
if (!inputValidateCodeRef.current) { | ||
return; | ||
} | ||
if (focusTimeoutRef.current) { | ||
clearTimeout(focusTimeoutRef.current); | ||
} | ||
focusTimeoutRef.current = setTimeout(() => { | ||
inputValidateCodeRef.current?.focusLastSelected(); | ||
}, CONST.ANIMATED_TRANSITION); | ||
}, | ||
})); | ||
|
||
useFocusEffect( | ||
useCallback(() => { | ||
if (!inputValidateCodeRef.current) { | ||
return; | ||
} | ||
if (focusTimeoutRef.current) { | ||
clearTimeout(focusTimeoutRef.current); | ||
} | ||
focusTimeoutRef.current = setTimeout(() => { | ||
inputValidateCodeRef.current?.focusLastSelected(); | ||
}, CONST.ANIMATED_TRANSITION); | ||
return () => { | ||
if (!focusTimeoutRef.current) { | ||
return; | ||
} | ||
clearTimeout(focusTimeoutRef.current); | ||
}; | ||
}, []), | ||
); | ||
|
||
useEffect(() => { | ||
if (!validateError) { | ||
return; | ||
} | ||
clearError(); | ||
// eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps | ||
}, [clearError, validateError]); | ||
|
||
useEffect(() => { | ||
if (!hasMagicCodeBeenSent) { | ||
return; | ||
} | ||
inputValidateCodeRef.current?.clear(); | ||
}, [hasMagicCodeBeenSent]); | ||
|
||
/** | ||
* Request a validate code / magic code be sent to verify this contact method | ||
*/ | ||
const resendValidateCode = () => { | ||
User.requestValidateCodeAction(); | ||
inputValidateCodeRef.current?.clear(); | ||
}; | ||
|
||
/** | ||
* Handle text input and clear formError upon text change | ||
*/ | ||
const onTextInput = useCallback( | ||
(text: string) => { | ||
setValidateCode(text); | ||
setFormError({}); | ||
|
||
if (validateError) { | ||
clearError(); | ||
User.clearValidateCodeActionError('actionVerified'); | ||
} | ||
}, | ||
[validateError, clearError], | ||
); | ||
|
||
/** | ||
* Check that all the form fields are valid, then trigger the submit callback | ||
*/ | ||
const validateAndSubmitForm = useCallback(() => { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Coming from #54009, we should show the error when |
||
if (!validateCode.trim()) { | ||
setFormError({validateCode: 'validateCodeForm.error.pleaseFillMagicCode'}); | ||
return; | ||
} | ||
|
||
if (!ValidationUtils.isValidValidateCode(validateCode)) { | ||
setFormError({validateCode: 'validateCodeForm.error.incorrectMagicCode'}); | ||
return; | ||
} | ||
|
||
setFormError({}); | ||
handleSubmitForm(validateCode); | ||
}, [validateCode, handleSubmitForm]); | ||
|
||
return ( | ||
<> | ||
<MagicCodeInput | ||
autoComplete={autoComplete} | ||
ref={inputValidateCodeRef} | ||
name="validateCode" | ||
value={validateCode} | ||
onChangeText={onTextInput} | ||
errorText={formError?.validateCode ? translate(formError?.validateCode) : ErrorUtils.getLatestErrorMessage(account ?? {})} | ||
hasError={!isEmptyObject(validateError)} | ||
onFulfill={validateAndSubmitForm} | ||
autoFocus={false} | ||
/> | ||
<OfflineWithFeedback | ||
pendingAction={validateCodeAction?.pendingFields?.validateCodeSent} | ||
errors={ErrorUtils.getLatestErrorField(validateCodeAction, 'actionVerified')} | ||
errorRowStyles={[styles.mt2]} | ||
onClose={() => User.clearValidateCodeActionError('actionVerified')} | ||
> | ||
<View style={[styles.mt2, styles.dFlex, styles.flexColumn, styles.alignItemsStart]}> | ||
<PressableWithFeedback | ||
disabled={shouldDisableResendValidateCode} | ||
style={[styles.mr1]} | ||
onPress={resendValidateCode} | ||
underlayColor={theme.componentBG} | ||
hoverDimmingValue={1} | ||
pressDimmingValue={0.2} | ||
role={CONST.ROLE.BUTTON} | ||
accessibilityLabel={translate('validateCodeForm.magicCodeNotReceived')} | ||
> | ||
<Text style={[StyleUtils.getDisabledLinkStyles(shouldDisableResendValidateCode)]}>{translate('validateCodeForm.magicCodeNotReceived')}</Text> | ||
</PressableWithFeedback> | ||
{hasMagicCodeBeenSent && ( | ||
<DotIndicatorMessage | ||
type="success" | ||
style={[styles.mt6, styles.flex0]} | ||
// eslint-disable-next-line @typescript-eslint/naming-convention | ||
messages={{0: translate('validateCodeModal.successfulNewCodeRequest')}} | ||
/> | ||
)} | ||
</View> | ||
</OfflineWithFeedback> | ||
<OfflineWithFeedback | ||
pendingAction={validatePendingAction} | ||
errors={validateError} | ||
errorRowStyles={[styles.mt2]} | ||
onClose={() => clearError()} | ||
> | ||
<Button | ||
isDisabled={isOffline} | ||
text={translate('common.verify')} | ||
onPress={validateAndSubmitForm} | ||
style={[styles.mt4]} | ||
success | ||
pressOnEnter | ||
large | ||
isLoading={account?.isLoading} | ||
/> | ||
</OfflineWithFeedback> | ||
</> | ||
); | ||
} | ||
|
||
BaseValidateCodeForm.displayName = 'BaseValidateCodeForm'; | ||
|
||
export type {ValidateCodeFormProps, ValidateCodeFormHandle}; | ||
|
||
export default withOnyx<BaseValidateCodeFormProps, BaseValidateCodeFormOnyxProps>({ | ||
account: {key: ONYXKEYS.ACCOUNT}, | ||
})(BaseValidateCodeForm); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
import React, {forwardRef} from 'react'; | ||
import BaseValidateCodeForm from './BaseValidateCodeForm'; | ||
import type {ValidateCodeFormHandle, ValidateCodeFormProps} from './BaseValidateCodeForm'; | ||
|
||
const ValidateCodeForm = forwardRef<ValidateCodeFormHandle, ValidateCodeFormProps>((props, ref) => ( | ||
<BaseValidateCodeForm | ||
autoComplete="sms-otp" | ||
// eslint-disable-next-line react/jsx-props-no-spreading | ||
{...props} | ||
innerRef={ref} | ||
/> | ||
)); | ||
|
||
export default ValidateCodeForm; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
import React, {forwardRef} from 'react'; | ||
import BaseValidateCodeForm from './BaseValidateCodeForm'; | ||
import type {ValidateCodeFormHandle, ValidateCodeFormProps} from './BaseValidateCodeForm'; | ||
|
||
const ValidateCodeForm = forwardRef<ValidateCodeFormHandle, ValidateCodeFormProps>((props, ref) => ( | ||
<BaseValidateCodeForm | ||
autoComplete="one-time-code" | ||
// eslint-disable-next-line react/jsx-props-no-spreading | ||
{...props} | ||
innerRef={ref} | ||
/> | ||
)); | ||
|
||
export default ValidateCodeForm; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
import React, {useCallback, useEffect, useRef} from 'react'; | ||
import {View} from 'react-native'; | ||
import {useOnyx} from 'react-native-onyx'; | ||
import HeaderWithBackButton from '@components/HeaderWithBackButton'; | ||
import Modal from '@components/Modal'; | ||
import ScreenWrapper from '@components/ScreenWrapper'; | ||
import Text from '@components/Text'; | ||
import useThemeStyles from '@hooks/useThemeStyles'; | ||
import * as User from '@libs/actions/User'; | ||
import CONST from '@src/CONST'; | ||
import ONYXKEYS from '@src/ONYXKEYS'; | ||
import type {ValidateCodeActionModalProps} from './type'; | ||
import ValidateCodeForm from './ValidateCodeForm'; | ||
import type {ValidateCodeFormHandle} from './ValidateCodeForm/BaseValidateCodeForm'; | ||
|
||
function ValidateCodeActionModal({isVisible, title, description, onClose, validatePendingAction, validateError, handleSubmitForm, clearError}: ValidateCodeActionModalProps) { | ||
const themeStyles = useThemeStyles(); | ||
const firstRenderRef = useRef(true); | ||
const validateCodeFormRef = useRef<ValidateCodeFormHandle>(null); | ||
|
||
const [validateCodeAction] = useOnyx(ONYXKEYS.VALIDATE_ACTION_CODE); | ||
|
||
const hide = useCallback(() => { | ||
clearError(); | ||
onClose(); | ||
}, [onClose, clearError]); | ||
|
||
useEffect(() => { | ||
if (!firstRenderRef.current || !isVisible) { | ||
return; | ||
} | ||
firstRenderRef.current = false; | ||
User.requestValidateCodeAction(); | ||
}, [isVisible]); | ||
|
||
return ( | ||
<Modal | ||
type={CONST.MODAL.MODAL_TYPE.RIGHT_DOCKED} | ||
isVisible={isVisible} | ||
onClose={hide} | ||
onModalHide={hide} | ||
hideModalContentWhileAnimating | ||
useNativeDriver | ||
shouldUseModalPaddingStyle={false} | ||
> | ||
<ScreenWrapper | ||
includeSafeAreaPaddingBottom={false} | ||
shouldEnableMaxHeight | ||
testID={ValidateCodeActionModal.displayName} | ||
offlineIndicatorStyle={themeStyles.mtAuto} | ||
> | ||
<HeaderWithBackButton | ||
title={title} | ||
onBackButtonPress={hide} | ||
/> | ||
|
||
<View style={[themeStyles.ph5, themeStyles.mt3, themeStyles.mb7]}> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. themeStyles.mb7 was applied to the ValidateCodeForm container which has 28px of margin, this caused inconsistency in padding between the validate code and issue expensify cards flow, which caused #53583 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The page should have been wrapped in , This cause a regression here #56818 |
||
<Text style={[themeStyles.mb3]}>{description}</Text> | ||
<ValidateCodeForm | ||
validateCodeAction={validateCodeAction} | ||
validatePendingAction={validatePendingAction} | ||
validateError={validateError} | ||
handleSubmitForm={handleSubmitForm} | ||
clearError={clearError} | ||
ref={validateCodeFormRef} | ||
/> | ||
</View> | ||
</ScreenWrapper> | ||
</Modal> | ||
); | ||
} | ||
|
||
ValidateCodeActionModal.displayName = 'ValidateCodeActionModal'; | ||
|
||
export default ValidateCodeActionModal; |
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should have also cleared this when user has
actionVerified
error as improvement. #55490