Removed isVisible prop from ValidateCodeForm

[huzaifa-99]

Details

Fixed Issues

$ #19787
PROPOSAL: #19787 (comment)

Tests

1. Logout
2. Enter your email and continue
3. Verify the magic code input is focused
4. Type some random digits (less than 6), go back and again click continue
5. Verify that magic code input is focused again and that it is empty (does not have the random numbers you entered earlier)

• Verify that no errors appear in the JS console

Offline tests

Same as 'Tests' section above

QA Steps

Same as 'Tests' section above

• 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
  • 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

Chrome

Web.Chrome.mp4

Safari

Web.Safari.mp4

Mobile Web - Chrome

mWeb.Chrome.mp4

Mobile Web - Safari

mWeb.Safari.mp4

Desktop

Desktop.Native.mp4

iOS

IOS.Native.mp4

Android

Android.Native.mp4

[melvin-bot]

@rushatgabhane 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]

[hayata-suenaga]

@huzaifa-99 thank you for the quick PR 👍 I put a hold on the PR as we're on merge freeze right now until Wednesday.

I'll review this PR soon though

[huzaifa-99]

@hayata-suenaga Sure, Thank you for the heads up

[hayata-suenaga]

Code LGTM

[huzaifa-99]

Bumping for visibility @hayata-suenaga @rushatgabhane

[rushatgabhane]

can you remove the hold please?

[rushatgabhane]

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-07-18.at.22.03.09.mov

Mobile Web - Chrome

WhatsApp.Video.2023-07-18.at.22.07.32.mp4

Mobile Web - Safari

Screen.Recording.2023-07-18.at.22.03.58.mov

Desktop

Screen.Recording.2023-07-03.at.20.55.15.mov

iOS

Screen.Recording.2023-07-03.at.21.12.26.mov

Android

Screen.Recording.2023-07-18.at.20.13.42.mov

[rushatgabhane]

Bug: the focused input in magic code stays at first position.
Merging with main didn't fix it

Screen.Recording.2023-06-30.at.12.41.16.mov

[huzaifa-99]

@rushatgabhane fixed. Can you try again plz? Thank you!

[hayata-suenaga]

merge freeze is over. removing HOLD

[huzaifa-99]

Bump @rushatgabhane

[rushatgabhane]

@huzaifa-99 Bug android: keyboard doesn't stay open when navigating to code page.
Steps:

1. On Android, Enter email
2. Go next

Expected: keyboard stays open
Actual: keyboard is closed.

I verified that it stays open on main

Screen.Recording.2023-07-03.at.21.13.39.mov

[huzaifa-99]

@huzaifa-99 Bug android: keyboard doesn't stay open when navigating to code page.
Steps:
On Android, Enter email
Go next
Expected: keyboard stays open
Actual: keyboard is closed.
I verified that it stays open on main

@rushatgabhane Apologies for the late reply, I actually got caught up in testing and its painfully slow to run on M1 mac, don't know why. But I managed to test the main branch on android emulator, and the problem is present on main as well (for me at least)

Android Emulator M1

Android.Emulator.M1.mp4

I thought it might just be some cache issue so I cleared out every possible cache and retried 2-3 times, these were the caches I cleared

• android build, gradle
• the metro cache in /temp folder (even tho it looked unrelated)
• npm (even tho it looked unrelated)

but still the same result.

I had the intuition that it might be just an issue with Mac android emulator, to remove this doubt I tried on a windows machine, but that too had the same result

Android Emulator Windows

Android.Emulator.Intel.mp4

I cleared the same caches here as well and tried again but still no luck.

And just to be sure, I tested the main branch on a physical device and that too had the same result

Android Physical Device

Andriod.Physical.Device.mp4

No matter which device I tried, the keyboard (if opened) got closed on android native after navigating to magic code form.

With the testing above, I feel like the issue is also on main branch, but just to confirm I will ask in slack if anyone can verify if they face the same issue on android.

cc: @rushatgabhane @hayata-suenaga

[rushatgabhane]

@huzaifa-99 let me retest main.
Maybe I wasn't using the latest code?

[huzaifa-99]

That would be great, thank you @rushatgabhane

Maybe I wasn't using the latest code?

maybe not sure, the code is pretty much the same i think

[rushatgabhane]

@huzaifa-99 i retested on the latest main, and it doesn't have this bug.

Screen.Recording.2023-07-04.at.18.48.45.mov

[huzaifa-99]

Thank you for testing @rushatgabhane, i will update here soon

[hayata-suenaga]

@huzaifa-99 thank you for the detailed explanation. Could you kindly tell me why the autoFocus prop is not working?

[huzaifa-99]

Thanks for having a look @hayata-suenaga.

I don't know the exact reason why it happens but I am confident its some kind of race condition and falls in either or both of these categories

• A bug in react native in android
• Inconsistent prop/state/transition preventing the keyboard from opening in android

and this comment explains it a bit more.

I will try to explain it a bit more from my understanding (apologies for this big paragraph below)

A similar issue that got fixed 14 hours ago

Just saw the latest main and shouldDelayFocus seems to be implemented and merged in 14 hours ago in #22164 for the src/pages/settings/Profile/Contacts/ValidateCodeForm/BaseValidateCodeForm.js page. The issue in question is #21415, which is again the same issue we are facing here and the fix for that issue is similar to what I suggested here.

Why this issue is with MagicCodeInput and not with our custom TextInput

To add, we are already using the setTimout() workaround in our base text input component, (that's not to say we should be doing workaround but just for a general idea) and not passing autoFocus to the base text input which would explain why the regular text input focus and keyboard management works in android.

In MagicCodeInput, we are use 6x TextInput and passing the autoFocus prop and also not delaying the focus which causes the bug on android.

Both are text inputs but with different focus management techniques, the focus and keyboard works everywhere with one techniques but not with the other.

Other remaining areas with the same issue

We still have 2 other pages that have the same issue

• src/pages/settings/Security/TwoFactorAuth/TwoFactorAuthForm/BaseTwoFactorAuthForm.js
• src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js

Proposed fix

We would have to add delayed focus to the first cell of MagicCodeInput in case of android. That delayed focus will be added here and here with a setTimeout and we can condition this for android native

Summary

• Both our custom TextInput and MagicCodeInput components are using the react native TextInput component
• The keyboard management (opening up on input focus) works fine with the custom TextInput and not with the MagicCodeInput
• The custom TextInput does not pass autoFocus to react native text input but MagicCodeInput does pass it.
• The only method of autoFocus we are using in the custom TextInput is via refs, which in MagicCodeInput we are using both the refs and the autoFocus prop to react native text input to focus the input and open keyboard.
• The solution is to make the focus management of MagicCodeInput similar to how we do it in our custom TextInput, please see the proposed fix section above for more details.

---

If you guys agree then I can add the fix in this PR or maybe we can move those to a separate PR, whatever works best.

cc: @hayata-suenaga @rushatgabhane

[hayata-suenaga]

@rushatgabhane can you check the message @huzaifa-99 sent above? 🙇

[huzaifa-99]

Bump @rushatgabhane

[huzaifa-99]

Bump @rushatgabhane

[huzaifa-99]

friendly bump @rushatgabhane ^

[huzaifa-99]

@rushatgabhane bump on this msg

[rushatgabhane]

@huzaifa-99 i agree! we can add something like shouldDelayFocus on Android only.

Let's add a comment on why we're doing it also

[rushatgabhane]

@huzaifa-99 but why is this issue not happening on main?

[huzaifa-99]

@huzaifa-99 but why is this issue not happening on main?

@rushatgabhane I believe it's something related to the test device. The keyboard is not reliably opening up on Android, I got the issue on all devices I tried but it's not happening in your case, and I think some other people also reproduced the issue (like those who worked on #21415), maybe we can tag them to confirm if they face it in these screens?

• src/pages/settings/Security/TwoFactorAuth/TwoFactorAuthForm/BaseTwoFactorAuthForm.js
• src/pages/signin/ValidateCodeForm/BaseValidateCodeForm.js

In the meantime, I will add the shouldFocusDelay on android

[huzaifa-99]

@huzaifa-99 but why is this issue not happening on main?

Update: I merge the main into this branch and now it's not happening for me either. I think the changes (specially in MagicCodeInput) in #22164 fixed it.

Screen.Recording.2023-07-13.at.3.52.07.PM.mov

Question: do we still add shouldFocusDelay in the magic code and 2fa code screens?

cc: @rushatgabhane @hayata-suenaga

[huzaifa-99]

bump ^

[hayata-suenaga]

@rushatgabhane

[huzaifa-99]

Bump on this @rushatgabhane

[huzaifa-99]

Bump @rushatgabhane

[rushatgabhane]

Question: do we still add shouldFocusDelay in the magic code and 2fa code screens

if it's fixed by merging with main, they let's not add it.

[huzaifa-99]

Sure, Thank you @rushatgabhane. I believe next step is to complete this?

cc: @hayata-suenaga

[rushatgabhane]

LGTM

[huzaifa-99]

Thank you @rushatgabhane

[hayata-suenaga]

👍

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.42-20 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.42-26 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.44-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.44-2 🚀

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