fix: revalidate upon input and refocus if error occurs by samh-nl · Pull Request #23995 · Expensify/App

samh-nl · 2023-08-01T13:21:25Z

Details

After submitting the magic code input form, the input should be focused again if an error occurs.

Fixed Issues

$ #21958
PROPOSAL: #21958 (comment)

Tests

Go to the Sign in page
Enter an email
Continue
Enter a wrong magic code
Verify that the magic code is focused again after an error occurs
Enter the same last digit
Verify that the form is submitted

Verify that no errors appear in the JS console

Offline tests

N/A: Sign in is not available while offline.

QA Steps

Go to the Sign in page
Enter an email
Continue
Enter a wrong magic code
Verify that the magic code is focused again after an error occurs
Enter the same last digit
Verify that the form is submitted

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Web.Screen.Recording.2023-08-10.at.14.43.27.mp4

Mobile Web - Chrome

mWeb.Chrome.Screen.Recording.2023-08-10.at.15.18.19.mp4

Mobile Web - Safari

mWeb.Safari.Screen.Recording.2023-08-10.at.16.22.56.mp4

Desktop

Desktop.Screen.Recording.2023-08-10.at.14.47.33.mp4

iOS

Native.iOS.Screen.Recording.2023-08-10.at.16.16.29.mp4

Android

Native.Android.Screen.Recording.2023-08-10.at.15.14.30.mp4

melvin-bot · 2023-08-01T13:21:30Z

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

samh-nl · 2023-08-02T19:56:46Z

Friendly bump.

eVoloshchak · 2023-08-04T12:10:34Z

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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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-08-14.at.17.06.14.mov

Mobile Web - Chrome

video_2023-08-14_17-13-22.mp4

Mobile Web - Safari

Screen.Recording.2023-08-14.at.17.04.42.mov

Desktop

Screen.Recording.2023-08-14.at.17.10.54.mov

iOS

Screen.Recording.2023-08-14.at.17.01.38.mov

Android

screen-20230814-171020.mp4

eVoloshchak

@samh-nl, the initial issue (#21958) is still present

Screen.Recording.2023-08-04.at.16.41.17.mov

samh-nl · 2023-08-04T16:40:37Z

Indeed, please see the additional changes. I will update the Q&A tests and re-test all platforms.

samh-nl · 2023-08-09T09:48:23Z

Bump

eVoloshchak · 2023-08-09T12:29:10Z

-            if (inputValidateCodeRef.current) {
-                inputValidateCodeRef.current.blur();
-            }
            if (!validateCode.trim()) {


As per this comment

Refocusing the magic code input if its incorrect seems like the expected behavior

Thanks for clarifying what the correct expected behavior is. I have reverted the blur commit and pushed a new commit to reflect this. Re-testing all platforms now & updating QA tests.

This reverts commit 65014c0.

samh-nl · 2023-08-10T14:36:30Z

The videos and QA steps have been updated.

eVoloshchak · 2023-08-14T14:17:01Z

@samh-nl, looks good and tests well, let's change the tests section a little bit. Change step 6 to Enter the same last digit

samh-nl · 2023-08-14T14:24:21Z

I've updated step 6 of the tests with the provided text.

OSBotify · 2023-08-14T22:57:41Z

✋ 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 · 2023-08-17T02:21:58Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.55-0 🚀

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

Pujan92 · 2023-08-17T16:53:00Z

@samh-nl @eVoloshchak I am seeing one issue after the below change - after pasting the same magic code and pressing back crashes the app(reason seems to be last input not gets focused for pasting same code on error)
https://github.com/Expensify/App/pull/23995/files#diff-913e8c5633c454fc244676c3b1bb09d85b256cc5b65763a9b02b58c58fab31bbR224-R227

Screen.Recording.2023-08-17.at.10.21.53.PM.mov

samh-nl · 2023-08-17T18:01:49Z

Thanks. Interesting situation, there seems to be a conflict happening with the focusing here: https://github.com/Expensify/App/pull/23995/files#diff-913e8c5633c454fc244676c3b1bb09d85b256cc5b65763a9b02b58c58fab31bbR219

Possibly because inside validateAndSubmit we then immediately blur an input, maybe the browser puts a throttle on this? If I switch to a different tab and return, it's focused.

Moving it down like this, the refocusing happens correctly:

if (props.value === finalInput) {
	validateAndSubmit(finalInput);
} else {
	inputRefs.current[updatedFocusedIndex].focus();
}

I am not sure yet why exactly this is blocking the refocusing happening inside useEffect, because this happens much later. Any idea?
Let me further test this case.

Pujan92 · 2023-08-18T09:11:21Z

I am also trying to find the exact cause but have not been successful yet.

OSBotify · 2023-08-21T22:28:43Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.56-0 🚀

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

samh-nl · 2023-08-22T21:43:18Z

Here is the problem: it actually does place the focus in the last input but onFocus is not triggered. This causes focusedIndex to not update and remain undefined.

The reason onFocus is not triggered is because we blur the wrong input (see below). editIndex still contains the old value of 0 (first input). But after pasting we change the focus to the last input using inputRefs.current[updatedFocusedIndex].focus(); in onChangeText.

const blurMagicCodeInput = () => {
    inputRefs.current[editIndex].blur();
    setFocusedIndex(undefined);
};

Why it does work the first time you copy-paste: when submitting, we call props.onFulfill(value); and blur the input there. This blur happens after editIndex has been updated.

It's more easy to see what is happening by making the cursor visible (by removing inputStyle), see video:

chrome_sJ0rmQw89q.mp4

The solution I mentioned earlier (see below) still seems to be valid and now there's a good understanding why. It correctly blurs the input, causing onFocus to be triggered when the focus is returned. It still needs to be tested on all platforms, and I will give an update asap.

if (props.value === finalInput) {
    validateAndSubmit(finalInput);
} else {
    inputRefs.current[updatedFocusedIndex].focus();
}

jjcoffee · 2023-08-23T14:35:17Z

@samh-nl Just flagging that there's a deploy blocker related to this: if the code is entered implicitly via deeplink or from another tab, the last input is still focused (even though the input itself is empty).

There's a PR to fix it, but we're still having some issues with the fix there that look like they might get sorted with your proposed solution above. If you have a minute to check, I'd appreciate it!

amyevans · 2023-08-23T16:05:49Z

I think we should revert this PR to unblock the deploy, and proceed once @samh-nl has had a chance to redo the PR incorporating the above changes. That will give us more time to test without the time pressure of a blocked deploy. This was an edge case to begin with so let's not merge something hastily unnecessarily.

cc @roryabraham @jjcoffee @eVoloshchak

roryabraham · 2023-08-23T16:06:42Z

I'm down @amyevans 👍🏼

I'll close #25741 and let's put up a revert instead

samh-nl · 2023-08-23T16:26:40Z

@amyevans Good call, let me investigate @jjcoffee, thanks.

OSBotify · 2023-08-24T03:11:44Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

fix: prevent automatic blurring on submit

65014c0

samh-nl requested a review from a team as a code owner August 1, 2023 13:21

melvin-bot Bot requested review from eVoloshchak and removed request for a team August 1, 2023 13:21

samh-nl mentioned this pull request Aug 1, 2023

[$1000] Log in - User unable to proceed after re-enter last digit of magic code number #21958

Closed

6 tasks

eVoloshchak suggested changes Aug 4, 2023

View reviewed changes

samh-nl added 2 commits August 4, 2023 17:34

fix: submit if number entered w/o causing change

e2f4d4e

style: prettify

0d4bd85

eVoloshchak suggested changes Aug 9, 2023

View reviewed changes

samh-nl added 3 commits August 10, 2023 13:24

Revert "fix: prevent automatic blurring on submit"

d3a97c4

This reverts commit 65014c0.

fix: focus magic code input upon error

efaad07

style: prettify

3d8bad4

samh-nl changed the title ~~fix: prevent automatic blurring on submit~~ fix: revalidate upon input and refocus if error occurs Aug 10, 2023

eVoloshchak approved these changes Aug 14, 2023

View reviewed changes

melvin-bot Bot requested a review from amyevans August 14, 2023 14:17

amyevans approved these changes Aug 14, 2023

View reviewed changes

amyevans merged commit 6d1b992 into Expensify:main Aug 14, 2023

OSBotify mentioned this pull request Aug 17, 2023

Deploy Checklist: New Expensify 2023-08-17 #25160

Closed

75 tasks

OSBotify mentioned this pull request Aug 21, 2023

Deploy Checklist: New Expensify 2023-08-21 #25625

Closed

roryabraham mentioned this pull request Aug 23, 2023

Do not focus the last magic code input if it is empty #25741

Closed

58 tasks

roryabraham mentioned this pull request Aug 23, 2023

Revert "fix: revalidate upon input and refocus if error occurs" #25781

Merged

Conversation

samh-nl commented Aug 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Aug 1, 2023

Uh oh!

samh-nl commented Aug 2, 2023

Uh oh!

eVoloshchak commented Aug 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

eVoloshchak left a comment

Choose a reason for hiding this comment

Uh oh!

samh-nl commented Aug 4, 2023

Uh oh!

samh-nl commented Aug 9, 2023

Uh oh!

eVoloshchak Aug 9, 2023

Choose a reason for hiding this comment

Uh oh!

samh-nl Aug 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samh-nl commented Aug 10, 2023

Uh oh!

eVoloshchak commented Aug 14, 2023

Uh oh!

samh-nl commented Aug 14, 2023

Uh oh!

OSBotify commented Aug 14, 2023

Uh oh!

OSBotify commented Aug 17, 2023

Uh oh!

Pujan92 commented Aug 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samh-nl commented Aug 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Pujan92 commented Aug 18, 2023

Uh oh!

OSBotify commented Aug 21, 2023

Uh oh!

samh-nl commented Aug 22, 2023

Uh oh!

jjcoffee commented Aug 23, 2023

Uh oh!

amyevans commented Aug 23, 2023

Uh oh!

roryabraham commented Aug 23, 2023

Uh oh!

samh-nl commented Aug 23, 2023

Uh oh!

OSBotify commented Aug 24, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

samh-nl commented Aug 1, 2023 •

edited

Loading

eVoloshchak commented Aug 4, 2023 •

edited

Loading

samh-nl Aug 10, 2023 •

edited

Loading

Pujan92 commented Aug 17, 2023 •

edited

Loading

samh-nl commented Aug 17, 2023 •

edited

Loading