Skip to content
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

Added recovery code option to 2fa #23390

Merged
merged 10 commits into from
Sep 20, 2023

Conversation

alitoshmatov
Copy link
Contributor

Details

User can use recovery code instead of two-factor authentication code by switching to recovery code input

Fixed Issues

$ #22335
PROPOSAL: #22335 (comment)

Tests

  1. Have a user whose 2fa is enabled
  2. Sign in with this user
  3. At two-factor authentication step make sure Use recovery code text link is present
  4. Make sure pressing it switches input type to simple text input
  5. Enter recovery code
  6. Make sure recovery code is being validated correctly and you can sign in with correct recovery code
  • Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Same as tests

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
web-recovery-code.mov
Mobile Web - Chrome
Screenrecorder-2023-07-22-10-34-18-534.mp4
Mobile Web - Safari
safari-recovery-code.mp4
Desktop
desktop-recovery-code.mov
iOS
ios-recovery-code.mp4
Android
Screenrecorder-2023-07-22-10-35-37-94.mp4

@alitoshmatov alitoshmatov requested a review from a team as a code owner July 22, 2023 06:09
@melvin-bot melvin-bot bot removed the request for review from a team July 22, 2023 06:09
@melvin-bot
Copy link

melvin-bot bot commented Jul 22, 2023

@abdulrahuman5196 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

src/languages/en.js Outdated Show resolved Hide resolved
@alitoshmatov
Copy link
Contributor Author

@abdulrahuman5196 Friendly bump

@twisterdotcom twisterdotcom mentioned this pull request Aug 2, 2023
5 tasks
@MonilBhavsar MonilBhavsar self-requested a review August 2, 2023 13:50
@github-actions
Copy link
Contributor

github-actions bot commented Aug 19, 2023

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@alitoshmatov
Copy link
Contributor Author

Translations are confirmed, and updated code with the latest main branch and solved conflicts.

Sorry for force push, I have changed my system and had some problems authenticating with github.

It is ready for review now
@abdulrahuman5196

@abdulrahuman5196
Copy link
Contributor

Thanks for the confirmation @alitoshmatov . Since this is a critical flow, I would need to through test this and might need some time. Will keep this PR updated

@abdulrahuman5196
Copy link
Contributor

@abdulrahuman5196
Copy link
Contributor

@MonilBhavsar The recovery code field doesn't have auto-check after entering recovery code. Like we have to press signin after the recovery code has entered in the text input. But both magic code and 2FA code auto hit API after just entering value.
Do we want that? If so in this issue or followup issue?

@abdulrahuman5196
Copy link
Contributor

@alitoshmatov There are multiple useEffects involving clearing/focusing of input based on magicCode and 2FA code status, can we check and include recovery code as well to logics or create useEffects for recovery code in similar way

@alitoshmatov
Copy link
Contributor Author

@alitoshmatov We should clear recovery code data as well here https://github.com/Expensify/App/pull/23390/files#diff-873bd2e06c31caa8e7ca519b38cbd825dad372a68ea5f4e4f00bb27f60b9a9c7R185

Added clearing recovery code there.

@alitoshmatov There are multiple useEffects involving clearing/focusing of input based on magicCode and 2FA code status, can we check and include recovery code as well to logics or create useEffects for recovery code in similar way

I don't think there is a need for handling recovery code in similar cases

@abdulrahuman5196

@abdulrahuman5196
Copy link
Contributor

There are multiple useEffects involving clearing/focusing of input based on magicCode and 2FA code status, can we check and include recovery code as well to logics or create useEffects for recovery code in similar way

I don't think there is a need for handling recovery code in similar cases.

@alitoshmatov Could you kindly add information on why? Anyways i wasn't able to find any visible issues based on the same, but we need to be sure if we don't want to add similar effects. The reason I think is if something is applicable to 2FA code then the same logic should be applicable for recovery codes as well.

@MonilBhavsar
Copy link
Contributor

@MonilBhavsar The recovery code field doesn't have auto-check after entering recovery code. Like we have to press signin after the recovery code has entered in the text input. But both magic code and 2FA code auto hit API after just entering value. Do we want that? If so in this issue or followup issue?

By auto check, you mean auto submit? I think it is only for those numeric inputs. We can leave it here

@alitoshmatov
Copy link
Contributor Author

Not sure why this exists, but it looks like it was introduced when refactoring to functional components, and these changes were commited under Guarantee clearing after state change message. As this message suggests, these changes make sure inputs are cleared when user goes from general validation code to 2fa code inputs.

useEffect(() => {
if (!inputValidateCodeRef.current || validateCode.length > 0) {
return;
}
inputValidateCodeRef.current.clear();
}, [validateCode]);
useEffect(() => {
if (!input2FARef.current || twoFactorAuthCode.length > 0) {
return;
}
input2FARef.current.clear();
}, [twoFactorAuthCode]);

This is one is here since we store validateCode in onyx state, and it makes sure they are matched.

useEffect(() => {
if (prevValidateCode || !props.credentials.validateCode) {
return;
}
setValidateCode(props.credentials.validateCode);
}, [props.credentials.validateCode, prevValidateCode]);

And these are for managing focus state of validate code input, not sure why we need this since providing autofocus should work properly, and it seems redundant.

useEffect(() => {
if (!(inputValidateCodeRef.current && hasError && (props.session.autoAuthState === CONST.AUTO_AUTH_STATE.FAILED || props.account.isLoading))) {
return;
}
inputValidateCodeRef.current.blur();
}, [props.account.isLoading, props.session.autoAuthState, hasError]);
useEffect(() => {
if (!inputValidateCodeRef.current || !canFocusInputOnScreenFocus()) {
return;
}
inputValidateCodeRef.current.focus();
}, []);

To conclude, most of these useEffects are here to manage MagicCodeInput. But I think there are some redundant code and this could be optimized. Anyways I think there is no need for similar changes for simple TextInput

@abdulrahuman5196 Let me know what you think.

@alitoshmatov
Copy link
Contributor Author

@abdulrahuman5196 Friendly bump!

@MonilBhavsar
Copy link
Contributor

@abdulrahuman5196 👋

@alitoshmatov
Copy link
Contributor Author

@abdulrahuman5196 I mean, we declare isUsingRecoveryCode state in SignInPage and pass its value, and change function to BaseValidateCodeForm, thus making this state available in both places. We add additional condition using this state to determine the message.

Another way is to declare new state in onyx data and keep track of if user is using recovery code

@abdulrahuman5196
Copy link
Contributor

I would prefer a onyx state inside account data or something similar like how we have the state to determine 2FA present or not information.

@MonilBhavsar what do you think?

@MonilBhavsar
Copy link
Contributor

To be honest, a new Onyx data for maintaining state or user method sounds overkill. Would be great if we can do with state

@alitoshmatov
Copy link
Contributor Author

@abdulrahuman5196 Moved state to SignInPage from BaseValidateCodeForm, thus making welcome text respond when switched to recovery code

@abdulrahuman5196
Copy link
Contributor

@abdulrahuman5196 Moved state to SignInPage from BaseValidateCodeForm, thus making welcome text respond when switched to recovery code

@MonilBhavsar I am not in that much agreement to this approach, but still i agree on the point of onyx being overkill as well. So I am 50-50 on this. Could you kindly give a quick look at the new changes and let me know if this kind of state management is fine?

@MonilBhavsar
Copy link
Contributor

That looks good to me. We're taking it one component up to pass the correct welcomeText prop, right? @abdulrahuman5196 anything specific you think does not follow good state management practice?

@alitoshmatov
Copy link
Contributor Author

We're taking it one component up to pass the correct welcomeText prop, right?

That's correct

@alitoshmatov
Copy link
Contributor Author

@abdulrahuman5196 Friendly bump

@abdulrahuman5196
Copy link
Contributor

abdulrahuman5196 commented Sep 16, 2023

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screen.Recording.2023-09-16.at.4.36.23.PM.mp4
Mobile Web - Chrome
az_recorder_20230916_170026.mp4
Mobile Web - Safari
Screen.Recording.2023-09-16.at.4.55.39.PM.mp4
Desktop
Screen.Recording.2023-09-16.at.5.08.43.PM.mp4
iOS
Screen.Recording.2023-09-16.at.4.44.04.PM.mp4
Android
Screen.Recording.2023-09-16.at.4.47.16.PM.mp4

Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @MonilBhavsar

🎀 👀 🎀
C+ Reviewed

@MonilBhavsar
Copy link
Contributor

@alitoshmatov could you please merge main in this branch

@alitoshmatov
Copy link
Contributor Author

@MonilBhavsar Done

Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good and works well! Thank you!!

@MonilBhavsar MonilBhavsar merged commit 724ac0e into Expensify:main Sep 20, 2023
14 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.73-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.74-0 🚀

platform result
🤖 android 🤖 failure ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

accessibilityLabel={props.translate('recoveryCodeForm.recoveryCode')}
value={recoveryCode}
onChangeText={(text) => onTextInput(text, 'recoveryCode')}
maxLength={CONST.RECOVERY_CODE_LENGTH}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This caused a regression here #35947
When we paste a recovery code with spaces at the beginning it will cut out some letters from the end.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants