Fix no selection identifier on magic code input field once the field displays an error status

[hoangzinh]

Details

Fixed Issues

$ #19314
PROPOSAL: #19314 (comment)

Tests

1. Navigate to the Sign in page, enter a valid email of an existing account and click on the "Continue" button
2. Enter an Invalid Magic Code and verify that it is marked red
3. Click on one of the cells and verify that a green dash is displayed beneath it indicating it is focused
4. Clear one of the cells and try to submit the Magic Code, make sure everything is marked red and the cell loses focus

• Verify that no errors appear in the JS console

Offline tests

Can't test when offline

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

Screen.Recording.2023-06-01.at.06.37.06.mp4

Mobile Web - Chrome

Screen.Recording.2023-05-30.at.14.51.16.-.android.chrome.mov

Mobile Web - Safari

Screen.Recording.2023-05-30.at.14.43.11.-.ios.safari.mov

Desktop

Screen.Recording.2023-05-30.at.13.40.29.-.desktop.1.mov

iOS

Screen.Recording.2023-05-30.at.14.40.33.-.ios.mov

Android

Screen.Recording.2023-05-30.at.15.40.47.-.android.1.mov

[hoangzinh]

During testing in IOS native/IOS safari. I found there are 2 existing bugs:

• In IOS native: We can't input magic code one by one
• In IOS safari: there is a cursor appear when we input magic code

Both of them are not introduced by this PR

[melvin-bot]

@PauloGasparSv @mananjadhav 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]

[PauloGasparSv]

In IOS native: We can't input magic code one by one

I think we are referencing #18218 and last discussed here so that's already reported!

In IOS safari: there is a cursor appear when we input magic code

I don't think this was reported but I also don't think it's worth fixing. IMO let's wait to see if someone reports this as a problem.

[PauloGasparSv]

@hoangzinh I had to stop mid-review to focus on something else and now that I'm back we have some conflicts.

Can you please fix those so I can restart testing?

[hoangzinh]

@hoangzinh I had to stop mid-review to focus on something else and now that I'm back we have some conflicts.

Can you please fix those so I can restart testing?

@PauloGasparSv Sure. I just solved the conflict. Please help me to review it again. Thanks

[PauloGasparSv]

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.mov

Mobile Web - Chrome

mweb.Chrome.mov

Mobile Web - Safari

Screen.Recording.2023-06-01.at.11.55.39.mov

Desktop

Desktop.mov

iOS

iOS.mov

Android

Screen.Recording.2023-06-01.at.11.58.00.mov

[PauloGasparSv]

@hoangzinh can we update the logic so clicking in the "Sign In" button focus out of the Magic Code input field?

I ask that because it looks strange in the following scenario:

1. Type a wrong magic code
2. Remove 1 digit from the magic code
3. Hit submit
4. Try to type

Expected: Since one of the digits is highlighted as green I expect the keyboard input to fill it
What happens: Nothing because the field itself isn't focused

I think we should do one of the following:

1. Make sure the keyboard input is added to the highlighted magic code input for that case
2. Remove the highlight from the digit when we click the "Sign In" button
3. Do nothing because this is an edge case. I don't think users will do that and if they do we can wait for someone to open a GH about this.

Lmk your thoughts, cc @mananjadhav

[hoangzinh]

Expected: Since one of the digits is highlighted as green I expect the keyboard input to fill it

@PauloGasparSv yeah it looks weird to me too. We all agree I can do that. My proposal here it:

• We can add a another blur function here with logic here
• Then call it in submit function of form here

[PauloGasparSv]

Expected: Since one of the digits is highlighted as green I expect the keyboard input to fill it

@PauloGasparSv yeah it looks weird to me too. We all agree I can do that. My proposal here it:

• We can add a another blur function here with logic here
• Then call it in submit function of form here

Sounds good to me @hoangzinh please do : )

[hoangzinh]

@PauloGasparSv @mananjadhav I have updated PR for above discussion. I also extended the Test steps to cover above changes too. Please help me review it again. Thanks

[mananjadhav]

@hoangzinh @PauloGasparSv I think we need to fix this condition

1. Enter a wrong magic code and all the cells are underlined red.
2. Focusing one of the cells makes it green
3. Removing the digit from the cell
4. Click on submit
5. The blank digit cell should've been red, but it still green.

web-magic-code-focused.mov

[hoangzinh]

@mananjadhav nice catch! I have updated again my PR to also fix above issue.

[mananjadhav]

Thanks for the fix @hoangzinh. Testing this now again.

[PauloGasparSv]

I think we should change the Test/QA steps to include this and this as tests.

@hoangzinh LMK your opinions and if you agree feel free to update the GH body!

1. Navigate to the Sign in page, enter a valid email of an existing account and click on the "Continue" button
2. Enter an Invalid Magic Code and verify that it is marked red
3. Click on one of the cells and verify that a green dash is displayed beneath it indicating it is focused
4. Clear one of the cells and try to submit the Magic Code, make sure everything is marked red and the cell loses focus
5. Enter the valid magic code and verify you can sign-in successfully

[hoangzinh]

@PauloGasparSv LGTM, except the 5th step. Do we need to verify sign in successfully here? Just my opinion.

[PauloGasparSv]

@PauloGasparSv LGTM, except the 5th step. Do we need to verify sign in successfully here? Just my opinion.

Not really, we can remove it :D

[hoangzinh]

@PauloGasparSv I just updated PR description for Test steps above. Thanks again

[PauloGasparSv]

LGTM!

[mananjadhav]

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-magic-code-focus-style.mov

Mobile Web - Chrome

mweb-chrome-magic-code-focus-style.mov

Mobile Web - Safari

mweb-safari-magic-code-focus-style.mov

Desktop

desktop-magic-code-focus-style.mov

iOS

ios-magic-code-focus-style.mov

Android

android-magic-code-focus-style.mov

[mananjadhav]

@PauloGasparSv I was still finishing the checklist 😄 Yet to upload screenshots for all the platforms. Doing that now.

[PauloGasparSv]

Sorry @mananjadhav!!! I assumed you weren't going to send those and didn't realize you had just approved 🤦‍♂️ will refrain from merging as soon as someone approves next time, sorry for that!

[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.

[mananjadhav]

No worries @PauloGasparSv. I was anyway just left with getting the screencasts. I've updated the checklist with screencasts for all platforms.

[OSBotify]

🚀 Deployed to staging by https://github.com/PauloGasparSv in version: 1.3.23-0 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/PauloGasparSv in version: 1.3.23-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.23-7 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.23-7 🚀

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