Fix: Form validation runs on blur in New task details page by tienifr · Pull Request #24011 · Expensify/App

tienifr · 2023-08-01T15:55:16Z

Details

Form validation runs inadvertently when the page is blurred. This PR fixes that.

Fixed Issues

$ #23552
PROPOSAL: #23552 (comment)

Tests

Login with any account
Press FAB >> Assign task
Move focus to another window (i.e. put the App to background)
Move focus back to the App
Verify that no errors appear in the form

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Login with any account
Press FAB >> Assign task
Move focus to another window (i.e. put the App to background)
Move focus back to the App
Verify that no errors appear in the form

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-08-01.at.22.56.39.mov

Mobile Web - Chrome

video_2023-08-01_23-20-19.mp4

Mobile Web - Safari

Screen.Recording.2023-08-02.at.03.15.47.mov

Desktop

Screen.Recording.2023-08-02.at.00.11.59.mov

iOS

Screen.Recording.2023-08-01.at.23.19.50.mov

Android

Screen.Recording.2023-08-02.at.00.56.02.mov

melvin-bot · 2023-08-01T15:55:20Z

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

melvin-bot · 2023-08-01T17:57:29Z

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

tienifr · 2023-08-01T20:38:22Z

While testing on Safari, I found out that the active text input was forced to re-focused by this (made by #21656):

App/src/components/TextInput/index.js

Lines 20 to 27 in 5034433

    
           // Forcefully activate the soft keyboard when the user switches between tabs while input was focused. 
        
           this.removeVisibilityListener = Visibility.onVisibilityChange(() => { 
        
               if (!Visibility.isVisible() || !this.textInput || DomUtils.getActiveElement() !== this.textInput) { 
        
                   return; 
        
               } 
        
               this.textInput.blur(); 
        
               this.textInput.focus(); 
        
           });

which re-triggered onBlur whenever we switch tab or window. Thus the validation still runs and we can not solve this issue. This is not right because the user does not intentionally blurs it.

Why does this not happen on Chrome? Because on Chrome , if blur and focus were called consecutively, the focus would cancel out the blur, thus onBlur would not be triggered, while that's not the case for Safari.

Moreover, the original issue of #21656 only happens in mWeb Chrome. I have tried removing the changes, tested on all platforms and the app still worked as expected (i.e. keyboard still opens on focused element even when we switch to other tabs), attached video below. Thus, I suggested adding the isMobileChrome check to the above lines so that it won't break other platforms' functionalities.

Screen.Recording.2023-08-02.at.03.36.26.mov

cc @akinwale, @parasharrajat as you're the authors of the PR.

tienifr · 2023-08-03T07:03:34Z

Bump @eVoloshchak.

parasharrajat · 2023-08-03T09:33:28Z

        // Forcefully activate the soft keyboard when the user switches between tabs while input was focused.
        this.removeVisibilityListener = Visibility.onVisibilityChange(() => {
-            if (!Visibility.isVisible() || !this.textInput || DomUtils.getActiveElement() !== this.textInput) {
+            if (!Browser.isMobileChrome() || !Visibility.isVisible() || !this.textInput || DomUtils.getActiveElement() !== this.textInput) {


This breaks the original implementation. You will find more summary on the issue and PR.

Can you specifically point out what it did break? As I've tested on both Safari (attached above) and Chrome (attached below), it still worked.

video_2023-08-03_18-09-19.mp4

In short, the original issue only happened on Chrome, Safari would be fine without the PR. The only thing that is not right without it is:

iOS Safari: The soft keyboard does not remain open (due to a system limitation which only allows the soft keyboard to be open from a user interaction event). The screen automatically scrolls to the email input.

On iOS Safari, the keyboard still opens but screen won't scroll automatically until we type.

I will check it and let you know later. But it was my intuition that it might break. I wasn't sure on that.

Thanks in advance!

Run the tests from #21656 and make sure they are intact.

cc @eVoloshchak

parasharrajat · 2023-08-03T09:33:47Z

-                            }
-                        }, 200);
+                        // Only run validation when user proactively blurs the input.
+                        if (Visibility.isVisible() && Visibility.hasFocus()) {


Always prefer early returns.

Thanks but we still have other codes below which are not relating to the check.

Maybe move the other code above this if block if there are no issue with it and then use return.

tienifr · 2023-08-04T19:40:29Z

@eVoloshchak Let me know your thoughts here when you have time.

eVoloshchak · 2023-08-07T14:02:28Z

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

Mobile Web - Chrome

screen-20230807-175626.mp4

Mobile Web - Safari

Screen.Recording.2023-08-07.at.17.55.19.mov

Desktop

Screen.Recording.2023-08-07.at.17.54.26.mov

iOS

Screen.Recording.2023-08-07.at.17.57.02.mov

Android

screen-20230807-175332.mp4

eVoloshchak

Both tests for this and #21656 are working good

eVoloshchak · 2023-08-07T15:04:37Z

@parasharrajat, huge thank you for weighing in on this

OSBotify · 2023-08-07T17:31:21Z

✋ 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-07T18:54:13Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.51-0 🚀

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

OSBotify · 2023-08-09T08:43:21Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.51-2 🚀

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

OSBotify · 2023-08-09T09:12:17Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-09T09:51:00Z

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-10T20:09:26Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.52-5 🚀

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

fix: form validation runs on blur

f7bab13

fix lint

c16ef56

tienifr marked this pull request as ready for review August 1, 2023 17:57

tienifr requested a review from a team as a code owner August 1, 2023 17:57

melvin-bot bot requested review from eVoloshchak and removed request for a team August 1, 2023 17:57

tienifr changed the title ~~Fix: Form validation runs on blur in New task page~~ Fix: Form validation runs on blur in New task details page Aug 1, 2023

tienifr added 2 commits August 2, 2023 03:14

refocus text input in Chrome only

dde8208

fix lint

671ca30

fix lint

81010c0

tienifr mentioned this pull request Aug 1, 2023

[HOLD for payment 2023-08-16] [$1000] Web - Task - Error is shown as soon as app is put in background when creating a task #23552

Closed

6 tasks

parasharrajat reviewed Aug 3, 2023

View reviewed changes

Merge branch 'main' into fix/23552

4897c4d

eVoloshchak approved these changes Aug 7, 2023

View reviewed changes

melvin-bot bot requested a review from thienlnam August 7, 2023 15:02

thienlnam approved these changes Aug 7, 2023

View reviewed changes

thienlnam merged commit 6c22eb3 into Expensify:main Aug 7, 2023

OSBotify mentioned this pull request Aug 7, 2023

Deploy Checklist: New Expensify 2023-08-07 #24230

Closed

98 tasks

OSBotify mentioned this pull request Aug 9, 2023

Deploy Checklist: New Expensify 2023-08-09 #24307

Closed

87 tasks

hoangzinh mentioned this pull request Aug 10, 2023

[HOLD for C+ newdot payment] [$1000] Web - Bank - Error message 'bank account should end with 1111' disappears after blurring the routing number input field #21838

Closed

6 tasks

aldo-expensify mentioned this pull request Oct 2, 2023

[HOLD for payment 2023-10-16] [$500] Attachment - Red error message appears briefly when closing password protected PDF #28195

Closed

6 tasks

Conversation

tienifr 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!

melvin-bot bot commented Aug 1, 2023

Uh oh!

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

Uh oh!

Uh oh!

tienifr commented Aug 3, 2023

Uh oh!

parasharrajat Aug 3, 2023

Choose a reason for hiding this comment

Uh oh!

tienifr Aug 3, 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!

parasharrajat Aug 3, 2023

Choose a reason for hiding this comment

Uh oh!

tienifr Aug 3, 2023

Choose a reason for hiding this comment

Uh oh!

parasharrajat Aug 3, 2023

Choose a reason for hiding this comment

Uh oh!

tienifr Aug 3, 2023

Choose a reason for hiding this comment

Uh oh!

parasharrajat Aug 3, 2023

Choose a reason for hiding this comment

Uh oh!

tienifr Aug 3, 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!

parasharrajat Aug 3, 2023

Choose a reason for hiding this comment

Uh oh!

tienifr commented Aug 4, 2023

Uh oh!

eVoloshchak commented Aug 7, 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!

eVoloshchak commented Aug 7, 2023

Uh oh!

OSBotify commented Aug 7, 2023

Uh oh!

OSBotify commented Aug 7, 2023

Uh oh!

OSBotify commented Aug 9, 2023

Uh oh!

OSBotify commented Aug 9, 2023

Uh oh!

OSBotify commented Aug 9, 2023

Uh oh!

OSBotify commented Aug 10, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

tienifr commented Aug 1, 2023 •

edited

Loading

tienifr commented Aug 1, 2023 •

edited

Loading

tienifr Aug 3, 2023 •

edited

Loading

tienifr Aug 3, 2023 •

edited

Loading

eVoloshchak commented Aug 7, 2023 •

edited

Loading