[fix] add timeout to Form's onBlur method to prevent focus losing when toggling checkboxes #16444

fabioh8010 · 2023-03-23T12:38:00Z

Details

This PR aims to add a timeout to Form's onBlur() method in order to prevent Checkbox focus loss when the user are focusing a TextInput and proceeds to toggle a CheckBox in web and mobile web.

Fixed Issues

$ #13623
PROPOSAL: #13623 (comment)

Tests

Navigate to any form that has text inputs and checkboxes (e.g. Connect bank account manually, Add debit card, etc).
Focus any text input.
Toggle a checkbox. You should be able to toggle it properly.

Verify that no errors appear in the JS console

Offline tests

Same as above.

QA Steps

Same as above.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-03-23.at.12.29.00.mov

Screen.Recording.2023-03-23.at.12.30.19.mov

Mobile Web - Chrome

Screen.Recording.2023-03-23.at.12.32.58.mov

Mobile Web - Safari

Screen.Recording.2023-03-23.at.12.33.38.mov

Desktop

Screen.Recording.2023-03-23.at.12.31.00.mov

iOS

Screen.Recording.2023-03-23.at.12.31.32.mov

Android

Screen.Recording.2023-03-23.at.12.31.54.mov

…n toggling checkboxes

MelvinBot · 2023-03-23T12:38:07Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

MelvinBot · 2023-03-23T12:38:07Z

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

src/components/Form.js

…method

luacmartins

LGTM

luacmartins · 2023-03-24T14:41:29Z

@rushatgabhane could you complete the reviewer checklist please?

rushatgabhane · 2023-03-24T15:00:22Z

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 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 correct English and 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 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-03-24.at.21.51.55.mov

Mobile Web - Chrome

Screen.Recording.2023-03-24.at.21.54.51.mov

Mobile Web - Safari

Screen.Recording.2023-03-24.at.21.55.57.mov

Desktop

Screen.Recording.2023-03-24.at.21.53.37.mov

iOS

Screen.Recording.2023-03-24.at.21.49.50.mov

Android

Screen.Recording.2023-03-24.at.21.48.55.mov

rushatgabhane · 2023-03-24T15:05:19Z

@ArekChr I don't think the delay is enough -
On web, I can consistently reproduce the bug on add debit card page.

Screen.Recording.2023-03-24.at.20.33.13.mov

rushatgabhane · 2023-03-24T15:07:02Z

150ms delay works for me @ArekChr

fabioh8010 · 2023-03-24T15:20:06Z

Hi @rushatgabhane , 100ms works fine for me but maybe we should increase to 150ms like you said or even 200ms to have a safer margin. I made some videos so we can compare:

100ms

Screen.Recording.2023-03-24.at.15.15.10.mov

150ms

Screen.Recording.2023-03-24.at.15.15.39.mov

200ms

Screen.Recording.2023-03-24.at.15.16.07.mov

WDYT?

rushatgabhane · 2023-03-24T15:31:17Z

200ms feels a little bit too slow? Maybe it's just the dev environment on Android because 200ms looks good on web.

200ms android

Screen.Recording.2023-03-24.at.20.58.54.mov

200ms web

Screen.Recording.2023-03-24.at.21.01.30.mov

rushatgabhane · 2023-03-24T15:34:24Z

@ArekChr I like 200ms because it feels nicer on web.

But I'll let you make the call between 150ms and 200ms.

ArekChr · 2023-03-24T15:35:39Z

Hey @rushatgabhane, I think you are tagging me by mistake instead of tagging @fabioh8010

rushatgabhane · 2023-03-24T15:39:35Z

thanks and sorry. i looked at the reviewer list 🤦

rushatgabhane · 2023-03-24T15:41:22Z

cc: @fabioh8010

fabioh8010 · 2023-03-24T15:54:56Z

@rushatgabhane Android builds in DEV environment are quite slower, specially timeouts. Also as it is a emulator, it can be slower or faster depending on the machine. You can try open the RN DevMenu, click Settings and then disable JS Dev Mode and enable JS Minify. It will become closer to the Release environment and you should notice gains in performance during the tests.

I suggest we go with 200ms, tested here and seems fine.

rushatgabhane · 2023-03-24T16:09:49Z

@fabioh8010 that makes sense to me. Thanks for the JS minify trick.

Agree! 200ms 🚀

fabioh8010 · 2023-03-24T16:17:34Z

@rushatgabhane PR updated!

rushatgabhane · 2023-03-24T16:27:28Z

@luacmartins LGTM!

thanks for the quick changes @fabioh8010 🚀

luacmartins · 2023-03-24T21:03:49Z

Changes look good, but tests are failing with an expired certificate. I'll check with the team and try to get that sorted out!

OSBotify · 2023-03-24T22:04:42Z

✋ 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-03-27T11:34:23Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.2.90-0 🚀

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

OSBotify · 2023-03-28T17:20:07Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.90-7 🚀

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

[fix] add timeout to Form's onBlur method to prevent focus losing whe…

5deed50

…n toggling checkboxes

fabioh8010 requested a review from a team as a code owner March 23, 2023 12:38

melvin-bot bot requested review from luacmartins and rushatgabhane and removed request for a team March 23, 2023 12:38

fabioh8010 mentioned this pull request Mar 23, 2023

[HOLD for payment 2023-04-04] [$1000] [Tracking issue] Form validation inconsistencies #13623

Closed

4 tasks

ArekChr previously approved these changes Mar 23, 2023

View reviewed changes

luacmartins requested changes Mar 23, 2023

View reviewed changes

src/components/Form.js Show resolved Hide resolved

[fix] add a comment explaining the use of timeout in Form's onBlur() …

bc04b79

…method

fabioh8010 dismissed ArekChr’s stale review via bc04b79 March 24, 2023 11:40

rushatgabhane previously approved these changes Mar 24, 2023

View reviewed changes

luacmartins previously approved these changes Mar 24, 2023

View reviewed changes

This comment was marked as outdated.

Sign in to view

[fix] Increase Form's onBlur() timeout in order to have a safer margin

0150666

fabioh8010 dismissed stale reviews from luacmartins and rushatgabhane via 0150666 March 24, 2023 16:16

rushatgabhane approved these changes Mar 24, 2023

View reviewed changes

luacmartins approved these changes Mar 24, 2023

View reviewed changes

luacmartins merged commit 2e130e5 into Expensify:main Mar 24, 2023

OSBotify mentioned this pull request Mar 27, 2023

Deploy Checklist: New Expensify 2023-03-27 #16536

Closed

18 tasks

kowczarz mentioned this pull request Nov 22, 2023

[Form Provider Refactor] AddDebitCardPage fixes #31133

Merged

58 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[fix] add timeout to Form's onBlur method to prevent focus losing when toggling checkboxes #16444

[fix] add timeout to Form's onBlur method to prevent focus losing when toggling checkboxes #16444

fabioh8010 commented Mar 23, 2023 •

edited

Loading

MelvinBot commented Mar 23, 2023

MelvinBot commented Mar 23, 2023

luacmartins left a comment

luacmartins commented Mar 24, 2023

rushatgabhane commented Mar 24, 2023 •

edited

Loading

rushatgabhane commented Mar 24, 2023 •

edited

Loading

rushatgabhane commented Mar 24, 2023

fabioh8010 commented Mar 24, 2023

This comment was marked as outdated.

rushatgabhane commented Mar 24, 2023 •

edited

Loading

rushatgabhane commented Mar 24, 2023 •

edited

Loading

ArekChr commented Mar 24, 2023

rushatgabhane commented Mar 24, 2023

rushatgabhane commented Mar 24, 2023

fabioh8010 commented Mar 24, 2023

rushatgabhane commented Mar 24, 2023

fabioh8010 commented Mar 24, 2023

rushatgabhane commented Mar 24, 2023

luacmartins commented Mar 24, 2023

OSBotify commented Mar 24, 2023

OSBotify commented Mar 27, 2023

OSBotify commented Mar 28, 2023

[fix] add timeout to Form's onBlur method to prevent focus losing when toggling checkboxes #16444

[fix] add timeout to Form's onBlur method to prevent focus losing when toggling checkboxes #16444

Conversation

fabioh8010 commented Mar 23, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Mar 23, 2023

MelvinBot commented Mar 23, 2023

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Mar 24, 2023

rushatgabhane commented Mar 24, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

rushatgabhane commented Mar 24, 2023 • edited Loading

rushatgabhane commented Mar 24, 2023

fabioh8010 commented Mar 24, 2023

This comment was marked as outdated.

rushatgabhane commented Mar 24, 2023 • edited Loading

200ms android

200ms web

rushatgabhane commented Mar 24, 2023 • edited Loading

ArekChr commented Mar 24, 2023

rushatgabhane commented Mar 24, 2023

rushatgabhane commented Mar 24, 2023

fabioh8010 commented Mar 24, 2023

rushatgabhane commented Mar 24, 2023

fabioh8010 commented Mar 24, 2023

rushatgabhane commented Mar 24, 2023

luacmartins commented Mar 24, 2023

OSBotify commented Mar 24, 2023

OSBotify commented Mar 27, 2023

OSBotify commented Mar 28, 2023

fabioh8010 commented Mar 23, 2023 •

edited

Loading

rushatgabhane commented Mar 24, 2023 •

edited

Loading

rushatgabhane commented Mar 24, 2023 •

edited

Loading

rushatgabhane commented Mar 24, 2023 •

edited

Loading

rushatgabhane commented Mar 24, 2023 •

edited

Loading