Migrate SignInPage to functional component #19498
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| import {useContext} from 'react'; | ||
| import {LocaleContext} from '../components/withLocalize'; | ||
|
|
||
| export default function useLocalize() { | ||
| return useContext(LocaleContext); | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| import _ from 'underscore'; | ||
| import {useContext, useMemo} from 'react'; | ||
| import Permissions from '../libs/Permissions'; | ||
| import {BetasContext} from '../components/OnyxProvider'; | ||
|
|
||
| export default function usePermissions() { | ||
| const betas = useContext(BetasContext); | ||
| return useMemo( | ||
| () => | ||
| _.reduce( | ||
| Permissions, | ||
| (memo, checkerFunction, beta) => { | ||
| // eslint-disable-next-line no-param-reassign | ||
| memo[beta] = checkerFunction(betas); | ||
| return memo; | ||
| }, | ||
| {}, | ||
| ), | ||
| [betas], | ||
| ); | ||
| } | ||
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 |
|---|---|---|
| @@ -1,30 +1,27 @@ | ||
| import React, {useEffect} from 'react'; | ||
| import {View} from 'react-native'; | ||
| import PropTypes from 'prop-types'; | ||
| import {withOnyx} from 'react-native-onyx'; | ||
| import Str from 'expensify-common/lib/str'; | ||
| import {useSafeAreaInsets} from 'react-native-safe-area-context'; | ||
| import ONYXKEYS from '../../ONYXKEYS'; | ||
| import styles from '../../styles/styles'; | ||
| import SignInPageLayout from './SignInPageLayout'; | ||
| import LoginForm from './LoginForm'; | ||
| import PasswordForm from './PasswordForm'; | ||
| import ValidateCodeForm from './ValidateCodeForm'; | ||
| import ResendValidationForm from './ResendValidationForm'; | ||
| import Performance from '../../libs/Performance'; | ||
| import * as App from '../../libs/actions/App'; | ||
| import UnlinkLoginForm from './UnlinkLoginForm'; | ||
| import * as Localize from '../../libs/Localize'; | ||
| import useLocalize from '../../hooks/useLocalize'; | ||
| import usePermissions from '../../hooks/usePermissions'; | ||
| import useWindowDimensions from '../../hooks/useWindowDimensions'; | ||
| import Log from '../../libs/Log'; | ||
| import * as StyleUtils from '../../styles/StyleUtils'; | ||
|
|
||
| const propTypes = { | ||
| /** The details about the account that the user is signing in with */ | ||
| account: PropTypes.shape({ | ||
| /** Error to display when there is an account error returned */ | ||
|
|
@@ -35,153 +32,149 @@ const propTypes = { | |
|
|
||
| /** The primaryLogin associated with the account */ | ||
| primaryLogin: PropTypes.string, | ||
|
|
||
| /** Has the user pressed the forgot password button? */ | ||
| forgotPassword: PropTypes.bool, | ||
|
|
||
| /** Does this account require 2FA? */ | ||
| requiresTwoFactorAuth: PropTypes.bool, | ||
| }), | ||
|
|
||
| /** The credentials of the person signing in */ | ||
| credentials: PropTypes.shape({ | ||
| login: PropTypes.string, | ||
| password: PropTypes.string, | ||
| twoFactorAuthCode: PropTypes.string, | ||
| validateCode: PropTypes.string, | ||
| }), | ||
| }; | ||
|
|
||
| const defaultProps = { | ||
| account: {}, | ||
| credentials: {}, | ||
| }; | ||
|
|
||
| /** | ||
| * @param {Boolean} hasLogin | ||
| * @param {Boolean} hasPassword | ||
| * @param {Boolean} hasValidateCode | ||
| * @param {Boolean} isPrimaryLogin | ||
| * @param {Boolean} isAccountValidated | ||
| * @param {Boolean} didForgetPassword | ||
| * @param {Boolean} canUsePasswordlessLogins | ||
| * @returns {Object} | ||
| */ | ||
| function getRenderOptions({hasLogin, hasPassword, hasValidateCode, isPrimaryLogin, isAccountValidated, didForgetPassword, canUsePasswordlessLogins}) { | ||
| const shouldShowLoginForm = !hasLogin && !hasValidateCode; | ||
| const isUnvalidatedSecondaryLogin = hasLogin && !isPrimaryLogin && !isAccountValidated; | ||
| const shouldShowPasswordForm = hasLogin && isAccountValidated && !hasPassword && !didForgetPassword && !isUnvalidatedSecondaryLogin && !canUsePasswordlessLogins; | ||
| const shouldShowValidateCodeForm = (hasLogin || hasValidateCode) && !isUnvalidatedSecondaryLogin && canUsePasswordlessLogins; | ||
| const shouldShowResendValidationForm = hasLogin && (!isAccountValidated || didForgetPassword) && !isUnvalidatedSecondaryLogin && !canUsePasswordlessLogins; | ||
| const shouldShowWelcomeHeader = shouldShowLoginForm || shouldShowPasswordForm || shouldShowValidateCodeForm || isUnvalidatedSecondaryLogin; | ||
| const shouldShowWelcomeText = shouldShowLoginForm || shouldShowPasswordForm || shouldShowValidateCodeForm; | ||
|
Comment on lines
+67
to
+74
There was a problem hiding this comment. Please add back the comments which were present before the refactor. They were useful. There was a problem hiding this comment. I disagree. I feel these variables have been renamed such that the comments became trivial / added no value. For some examples, we would've had this: Each line in the comment is just saying the same thing as the boolean statement in more words. not useful imo |
||
| return { | ||
| shouldShowLoginForm, | ||
| shouldShowUnlinkLoginForm: isUnvalidatedSecondaryLogin, | ||
| shouldShowPasswordForm, | ||
| shouldShowValidateCodeForm, | ||
| shouldShowResendValidationForm, | ||
| shouldShowWelcomeHeader, | ||
| shouldShowWelcomeText, | ||
| }; | ||
| } | ||
|
|
||
| function SignInPage({account, credentials}) { | ||
| const {translate, formatPhoneNumber} = useLocalize(); | ||
roryabraham marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const {canUsePasswordlessLogins} = usePermissions(); | ||
| const {isSmallScreenWidth} = useWindowDimensions(); | ||
| const safeAreaInsets = useSafeAreaInsets(); | ||
|
|
||
|
There was a problem hiding this comment. here we also check for the |
||
| useEffect(() => Performance.measureTTI(), []); | ||
| useEffect(() => { | ||
| App.setLocale(Localize.getDevicePreferredLocale()); | ||
| }, []); | ||
|
|
||
| const { | ||
| shouldShowLoginForm, | ||
| shouldShowUnlinkLoginForm, | ||
| shouldShowPasswordForm, | ||
| shouldShowValidateCodeForm, | ||
| shouldShowResendValidationForm, | ||
| shouldShowWelcomeHeader, | ||
| shouldShowWelcomeText, | ||
| } = getRenderOptions({ | ||
| hasLogin: Boolean(credentials.login), | ||
|
There was a problem hiding this comment. but here we dont have it, I have tried changing this to |
||
| hasPassword: Boolean(credentials.password), | ||
| hasValidateCode: Boolean(credentials.validateCode), | ||
| isPrimaryLogin: account.primaryLogin && account.primaryLogin === credentials.login, | ||
|
There was a problem hiding this comment. Suggestion |
||
| isAccountValidated: Boolean(account.validated), | ||
| didForgetPassword: Boolean(account.forgotPassword), | ||
| canUsePasswordlessLogins, | ||
| }); | ||
|
|
||
| let welcomeHeader; | ||
| let welcomeText; | ||
|
Comment on lines
+115
to
+116
There was a problem hiding this comment. Seems like this has caused a console warning #22923. welcomeHeader and welcomeText are required props in SigninPage layout, and not initialzing them as empty string displays an error. Yes, in unlinklogin form case, it is also not initialized in the condition below |
||
| if (shouldShowValidateCodeForm) { | ||
| if (account.requiresTwoFactorAuth) { | ||
| // We will only know this after a user signs in successfully, without their 2FA code | ||
| welcomeHeader = isSmallScreenWidth ? '' : translate('welcomeText.welcomeBack'); | ||
| welcomeText = translate('validateCodeForm.enterAuthenticatorCode'); | ||
| } else { | ||
| const userLogin = Str.removeSMSDomain(credentials.login || ''); | ||
|
|
||
| // replacing spaces with "hard spaces" to prevent breaking the number | ||
| const userLoginToDisplay = Str.isSMSLogin(userLogin) ? formatPhoneNumber(userLogin).replace(/ /g, '\u00A0') : userLogin; | ||
| if (account.validated) { | ||
| welcomeHeader = isSmallScreenWidth ? '' : translate('welcomeText.welcomeBack'); | ||
| welcomeText = isSmallScreenWidth | ||
| ? `${translate('welcomeText.welcomeBack')} ${translate('welcomeText.welcomeEnterMagicCode', {login: userLoginToDisplay})}` | ||
| : translate('welcomeText.welcomeEnterMagicCode', {login: userLoginToDisplay}); | ||
| } else { | ||
| welcomeHeader = isSmallScreenWidth ? '' : translate('welcomeText.welcome'); | ||
| welcomeText = isSmallScreenWidth | ||
| ? `${translate('welcomeText.welcome')} ${translate('welcomeText.newFaceEnterMagicCode', {login: userLoginToDisplay})}` | ||
| : translate('welcomeText.newFaceEnterMagicCode', {login: userLoginToDisplay}); | ||
| } | ||
| } | ||
| } else if (shouldShowPasswordForm) { | ||
| welcomeHeader = isSmallScreenWidth ? '' : translate('welcomeText.welcomeBack'); | ||
| welcomeText = isSmallScreenWidth ? `${translate('welcomeText.welcomeBack')} ${translate('welcomeText.enterPassword')}` : translate('welcomeText.enterPassword'); | ||
| } else if (shouldShowUnlinkLoginForm) { | ||
| welcomeHeader = isSmallScreenWidth ? translate('login.hero.header') : translate('welcomeText.welcomeBack'); | ||
| } else if (!shouldShowResendValidationForm) { | ||
| welcomeHeader = isSmallScreenWidth ? translate('login.hero.header') : translate('welcomeText.getStarted'); | ||
| welcomeText = isSmallScreenWidth ? translate('welcomeText.getStarted') : ''; | ||
| } else { | ||
| Log.warn('SignInPage in unexpected state!'); | ||
| } | ||
|
|
||
| return ( | ||
| <View style={[styles.signInPage, StyleUtils.getSafeAreaPadding(safeAreaInsets, 1)]}> | ||
| <SignInPageLayout | ||
| welcomeHeader={welcomeHeader} | ||
| welcomeText={welcomeText} | ||
| shouldShowWelcomeHeader={shouldShowWelcomeHeader || !isSmallScreenWidth} | ||
| shouldShowWelcomeText={shouldShowWelcomeText} | ||
| > | ||
| {/* LoginForm and PasswordForm must use the isVisible prop. This keeps them mounted, but visually hidden | ||
| so that password managers can access the values. Conditionally rendering these components will break this feature. */} | ||
| <LoginForm | ||
| isVisible={shouldShowLoginForm} | ||
| blurOnSubmit={account.validated === false} | ||
| /> | ||
| {shouldShowValidateCodeForm ? <ValidateCodeForm isVisible={shouldShowValidateCodeForm} /> : <PasswordForm isVisible={shouldShowPasswordForm} />} | ||
| {shouldShowResendValidationForm && <ResendValidationForm />} | ||
| {shouldShowUnlinkLoginForm && <UnlinkLoginForm />} | ||
| </SignInPageLayout> | ||
| </View> | ||
| ); | ||
| } | ||
|
|
||
| SignInPage.propTypes = propTypes; | ||
| SignInPage.defaultProps = defaultProps; | ||
| SignInPage.displayName = 'SignInPage'; | ||
|
|
||
| export default withOnyx({ | ||
| account: {key: ONYXKEYS.ACCOUNT}, | ||
| credentials: {key: ONYXKEYS.CREDENTIALS}, | ||
| })(SignInPage); | ||
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
IMO, it will be cleaner to break this into statements.
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.
I thought about that, but it would be a lot more verbose, and anyone adding or removing betas would also have to remember to update the hook. This way, you just have to add a new function to
libs/Permissionsand the hook will automatically handle that. This seems more robust to me.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.
Yeah, that is fine. I was just saying to break this nested logic into multiple statements. It is hard to read.