Refactor BaseValidateCodeForm.js to functional component #20480

Li357 · 2023-06-08T19:52:23Z

Details

Refactor src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js to functional component

Fixed Issues

$ #16302

Tests

Login and wait for magic code
Type in invalid magic code -> Gives error
Error disappears as soon as typing continues
Requesting new code clears current input
Type in invalid 2fa code -> Gives error
Type in valid 2fa code continues to app
If no 2fa, entering magic code continues to app

Verify that no errors appear in the JS console

Offline tests

Offline disables sign in button and form does not submit

QA Steps

Login and wait for magic code
Type in invalid magic code -> Gives error
Error disappears as soon as typing continues
Requesting new code clears current input
Type in invalid 2fa code -> Gives error
Type in valid 2fa code continues to app
If no 2fa, entering magic code continues to app
Test that if network goes offline during any step that Sign In is disabled

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

pr-web-chrome.mov

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Simulator.Screen.Recording.-.iPhone.14.16.1.-.2023-06-08.at.16.05.39.mp4

Desktop

desktop-no-2fa.mov

iOS

Simulator.Screen.Recording.-.iPhone.14.16.1.-.2023-06-08.at.15.55.04.mp4

Simulator.Screen.Recording.-.iPhone.14.16.1.-.2023-06-08.at.15.56.57.mp4

Android

…dency

…separate effects

github-actions · 2023-06-08T19:52:38Z

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

Li357 · 2023-06-08T20:45:43Z

I have read the CLA Document and I hereby sign the CLA

melvin-bot · 2023-06-08T21:08:35Z

@s77rt @AndrewGable One of you needs to 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]

s77rt

Just quick changes to get this moving (will continue review).

src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js

s77rt · 2023-06-09T17:50:41Z

src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js

+    useEffect(() => {
+        if (!inputValidateCode || wasVisible || !props.isVisible || !canFocusInputOnScreenFocus()) {
            return;
        }
-        this.inputValidateCode.focus();
-    }
+        inputValidateCode.focus();
+    }, [inputValidateCode, props.isVisible, wasVisible]);


This seems okay but it actually change the current behaviour as if it was coded as:

componentDidUpdate(prevProps) { if (canFocusInputOnScreenFocus() && !prevProps.isVisible && this.props.isVisible) { this.inputValidateCode.focus(); }

This may be fine so I asked here #13655 (comment)

Actually, I don't think canFocusInputOnScreenFocus can change in the lifetime of the app because it relies on user agent. So we might only need to check it once, though I don't think that's much of an issue

It won't change but the current logic used to relay on that function only on component mount, Now with the refactor it's treated as if that function was being used on componentDIdUpdate too. This is not necessary a bad change, just asked for a confirmation in the linked PR.

src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js

s77rt · 2023-06-09T19:04:41Z

@Li357 Please resolve conflicts

src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js

s77rt · 2023-06-12T21:46:19Z

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

web.mp4

Mobile Web - Chrome

mweb-chrome.mp4

Mobile Web - Safari

mweb-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

s77rt

LGTM! 🚀

cc @AndrewGable

OSBotify · 2023-06-13T00:31:27Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.27-0 🚀

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

OSBotify · 2023-06-13T01:05:38Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.27-0 🚀

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

OSBotify · 2023-06-14T21:21:45Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.27-7 🚀

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

Andrew Li added 3 commits June 7, 2023 11:39

Initial coarse refactor, added usePrevious hook, removed lodash depen…

09cf7dc

…dency

Fix refactor recursion with useCallback and separate focus/blur into …

7f123eb

…separate effects

Linting fixes

cfa42ab

Li357 and others added 2 commits June 8, 2023 16:46

Merge branch 'main' into andrewli-refactor-basevalidatecodeform

cfecf78

Run prettier

084c997

Li357 marked this pull request as ready for review June 8, 2023 21:08

Li357 requested a review from a team as a code owner June 8, 2023 21:08

melvin-bot bot requested review from AndrewGable and s77rt and removed request for a team June 8, 2023 21:08

s77rt suggested changes Jun 9, 2023

View reviewed changes

Li357 self-assigned this Jun 9, 2023

Andrew Li and others added 2 commits June 10, 2023 23:16

Remove duplicate ref and add displayName

da68d4b

Merge branch 'main' into andrewli-refactor-basevalidatecodeform

818ed79

s77rt suggested changes Jun 12, 2023

View reviewed changes

Remove refs from dependencies, fix typo

ae75160

Li357 mentioned this pull request Jun 12, 2023

2FA magic code input doesn't autofocus #20599

Closed

6 tasks

Guarantee clearing after state change

b642637

Li357 commented Jun 12, 2023

View reviewed changes

src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js Show resolved Hide resolved

s77rt approved these changes Jun 12, 2023

View reviewed changes

AndrewGable approved these changes Jun 12, 2023

View reviewed changes

AndrewGable merged commit 96fcede into main Jun 12, 2023

AndrewGable deleted the andrewli-refactor-basevalidatecodeform branch June 12, 2023 21:59

OSBotify mentioned this pull request Jun 12, 2023

Deploy Checklist: New Expensify 2023-06-12 #20640

Closed

71 tasks

melvin-bot bot mentioned this pull request Jun 14, 2023

[HOLD for payment 2023-06-21] [HOLD] [$250] Migrate BaseValidateCodeForm.js to function component #16302

Closed

1 task

allroundexperts mentioned this pull request Jun 26, 2023

[$1000] [HOLD for payment 2023-07-05] Login - No error message when incorrect 2FA code is entered #21545

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor BaseValidateCodeForm.js to functional component #20480

Refactor BaseValidateCodeForm.js to functional component #20480

Li357 commented Jun 8, 2023 •

edited

Loading

github-actions bot commented Jun 8, 2023 •

edited

Loading

Li357 commented Jun 8, 2023

melvin-bot bot commented Jun 8, 2023

s77rt left a comment

s77rt Jun 9, 2023

Li357 Jun 12, 2023 •

edited

Loading

s77rt Jun 12, 2023

s77rt commented Jun 9, 2023

s77rt commented Jun 12, 2023

s77rt left a comment

OSBotify commented Jun 13, 2023

OSBotify commented Jun 13, 2023

OSBotify commented Jun 14, 2023

Refactor BaseValidateCodeForm.js to functional component #20480

Refactor BaseValidateCodeForm.js to functional component #20480

Conversation

Li357 commented Jun 8, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Jun 8, 2023 • edited Loading

Li357 commented Jun 8, 2023

melvin-bot bot commented Jun 8, 2023

s77rt left a comment

Choose a reason for hiding this comment

s77rt Jun 9, 2023

Choose a reason for hiding this comment

Li357 Jun 12, 2023 • edited Loading

Choose a reason for hiding this comment

s77rt Jun 12, 2023

Choose a reason for hiding this comment

s77rt commented Jun 9, 2023

s77rt commented Jun 12, 2023

Reviewer Checklist

Screenshots/Videos

s77rt left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 13, 2023

OSBotify commented Jun 13, 2023

OSBotify commented Jun 14, 2023

Li357 commented Jun 8, 2023 •

edited

Loading

github-actions bot commented Jun 8, 2023 •

edited

Loading

Li357 Jun 12, 2023 •

edited

Loading