Fix/23003: Placeholders are overlapping with auto-filled text #24525

dukenv0307 · 2023-08-14T04:10:51Z

Details

Placeholders are overlapping with auto-filled text. We need to update the state of label after running animation to fix that

Fixed Issues

$ #23003
PROPOSAL: #23003 (comment)

Tests

Make sure you are already logged out before visiting this link, if not reload the page after logging out.
Let the Login details be auto-filled (make sure not to click anywhere on the page before performing the next step)
Click on the share button on the address bar
Verify that the placeholder should not overlap auto-filled text

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Make sure you are already logged out before visiting this link, if not reload the page after logging out.
Let the Login details be auto-filled (make sure not to click anywhere on the page before performing the next step)
Click on the share button on the address bar
Verify that the placeholder should not overlap auto-filled text

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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-08-17.at.12.01.30.mp4

Mobile Web - Chrome

Screenrecording_20230816_160417.mp4

Mobile Web - Safari

Screen.Recording.2023-08-16.at.15.56.03.mp4

Desktop

This PR is only visible on web

iOS

This PR is only visible on web

Android

This PR is only visible on web

melvin-bot · 2023-08-14T04:10:54Z

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-14T04:10:56Z

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

dukenv0307 · 2023-08-14T05:24:44Z

@situchan Could you help to review this PR? I still find a way to enable auto-fill on mobile web, will try to done soon

dukenv0307 · 2023-08-14T05:25:15Z

Unit test also be failed on the main branch

situchan · 2023-08-14T17:33:22Z

@dukenv0307 please pull main

dukenv0307 · 2023-08-15T01:47:19Z

@situchan Merged main, please help to review

src/components/TextInput/BaseTextInput.js

situchan · 2023-08-15T13:51:47Z

src/components/TextInput/BaseTextInput.js

+            return;
+        }
+        updateLabel();
+    }, [updateLabel, inputValue]);


Why inputValue is needed in dependency?

@situchan I don't add inputValue in dependency here, I keep it in dependency as before. But IMO, we also need to update the label when inputValue changed

Co-authored-by: Situ Chandra Shil <[email protected]>

situchan · 2023-08-15T14:11:58Z

Found regression: label is not activated first time even though focused (for test, you should not have any autofill on browser or enable Use your screen lock when filling passwords in chrome password setting)

Screen.Recording.2023-08-15.at.8.09.58.PM.mov

situchan · 2023-08-15T16:00:53Z

@dukenv0307 are you investigating?
Here's root cause:
https://stackoverflow.com/questions/55198517/react-usestate-why-settimeout-function-does-not-have-latest-state-value

dukenv0307 · 2023-08-15T16:31:35Z

Thanks for your comment, I am still checking, I will ping you when I finish my investigating

dukenv0307 · 2023-08-15T16:46:54Z

@situchan I agree with RC you pointed out. Looking for solution

dukenv0307 · 2023-08-16T08:47:06Z

@situchan The root cause is that we only use runAfterInteractions() in the first render.
In the first render, isFocus still be false and the update label will be moved to callback queue with isFocus is false (because runAfterInteractions is an async action)
In the second render, isFocus is true and update label is executed with isFocus is true immediately (sync action)
Then update label function from the callback queue is executed with isFocused is false. So this bug happen

So I suggest that we should always use runAfterInteractions instead of only the first time

situchan · 2023-08-16T09:33:12Z

So I suggest that we should always use runAfterInteractions instead of only the first time

yes but as this is general component, it will apply to all inputs throughout the app where runAfterInteractions is not needed at all

dukenv0307 · 2023-08-16T10:45:18Z

@situchan We can use accessibilityLabel props or label props to know that it is login form and then use runAfterInteractions like this

if (props.accessibilityLabel={translate('loginForm.phoneOrEmail')}) {
            
            InteractionManager.runAfterInteractions(() => {
                if (hasValueRef.current || isFocused || isInputAutoFilled(input.current)) {
                    activateLabel();
                } else {
                    deactivateLabel();
                }
            });
        }

What do you think about this way?

situchan · 2023-08-16T10:49:11Z

@situchan We can use accessibilityLabel props or label props to know that it is login form and then use runAfterInteractions like this
if (props.accessibilityLabel={translate('loginForm.phoneOrEmail')}) {
            
            InteractionManager.runAfterInteractions(() => {
                if (hasValueRef.current || isFocused || isInputAutoFilled(input.current)) {
                    activateLabel();
                } else {
                    deactivateLabel();
                }
            });
        }
What do you think about this way?

That's an intelligent idea. You think it's better than introducing new prop?

situchan · 2023-08-16T10:53:47Z

As this is tricky, I think we can fix only original issue without InteractionManager.runAfterInteractions. We can leave the 2nd issue I reported as is for now as it's edge case - user will not be likely to leave app before loading login screen after launch.
What do you think?
cc: @francoisl

dukenv0307 · 2023-08-17T04:24:13Z

@francoisl bump above comment: #24525 (comment)

francoisl · 2023-08-17T04:34:02Z

An alternative would be to introduce a new boolean prop such as useInteractionManagerOnFocusChangeEffects (terrible name but I can't think of something better right now), and then pass it on the inputs of the login page?

If that's not an option, then yes I'd say let's just fix the original issue without using runAfterInteractions. While the accessibility prop solution would work, it sounds like it would become messy to maintain if we end up making new pages that would require the same logic.

situchan · 2023-08-17T04:40:26Z

If that's not an option, then yes I'd say let's just fix the original issue without using runAfterInteractions

I am 👍 on this.

If we land on this, below needs to be removed from Tests step

Reload again
Quickly switch to another mac app (Terminal in my case)
Observe newDot app
Verify that the placeholder should not overlap auto-filled text

situchan · 2023-08-17T05:00:51Z

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

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

situchan · 2023-08-17T05:04:08Z

For crash safe, let's add !input || condition here:

App/src/libs/isInputAutoFilled.js

Line 9 in 6e055d0

if (!input.matches) return false;

config/webpack/webpack.dev.js

situchan

LGTM
@francoisl all yours

melvin-bot · 2023-08-17T05:34:58Z

@francoisl looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

francoisl · 2023-08-17T05:36:01Z

Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

Tests were passing, I think this is a bug with melvin.

OSBotify · 2023-08-17T05:38:51Z

✋ 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-21T22:26:16Z

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

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

mvtglobally · 2023-08-22T03:49:59Z

@dukenv0307 Can you update the steps? What link are we visiting? need more details to QA

situchan · 2023-08-22T05:14:25Z

@dukenv0307 Can you update the steps? What link are we visiting? need more details to QA

It's just app start link
https://staging.new.expensify.com/

OSBotify · 2023-08-24T03:09:17Z

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

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

active label after run interaction

ec28d7b

dukenv0307 requested a review from a team as a code owner August 14, 2023 04:10

melvin-bot bot removed the request for review from a team August 14, 2023 04:10

melvin-bot bot requested a review from situchan August 14, 2023 04:10

dukenv0307 added 2 commits August 14, 2023 11:12

remove empty line

23ed652

fix lint

3f2811d

merge main

dbf5fa9

situchan reviewed Aug 15, 2023

View reviewed changes

Update src/components/TextInput/BaseTextInput.js

9f2e13a

Co-authored-by: Situ Chandra Shil <[email protected]>

dukenv0307 added 2 commits August 16, 2023 15:50

runAfterInteractions everytime

5ed86fe

fix comment

e9a2b7f

remove interaction

86e14db

add safe condition to avoid crash

387bb83

situchan reviewed Aug 17, 2023

View reviewed changes

config/webpack/webpack.dev.js Outdated Show resolved Hide resolved

revert redandunt change

1ac6ea7

situchan approved these changes Aug 17, 2023

View reviewed changes

melvin-bot bot requested a review from francoisl August 17, 2023 05:08

merge main

72e8f05

francoisl approved these changes Aug 17, 2023

View reviewed changes

francoisl merged commit 0bdf183 into Expensify:main Aug 17, 2023

melvin-bot bot added the Emergency label Aug 17, 2023

francoisl removed the Emergency label Aug 17, 2023

OSBotify mentioned this pull request Aug 21, 2023

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

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix/23003: Placeholders are overlapping with auto-filled text #24525

Fix/23003: Placeholders are overlapping with auto-filled text #24525

dukenv0307 commented Aug 14, 2023 •

edited by mvtglobally

Loading

melvin-bot bot commented Aug 14, 2023

melvin-bot bot commented Aug 14, 2023

dukenv0307 commented Aug 14, 2023

dukenv0307 commented Aug 14, 2023

situchan commented Aug 14, 2023

dukenv0307 commented Aug 15, 2023

situchan Aug 15, 2023

dukenv0307 Aug 15, 2023

situchan commented Aug 15, 2023

situchan commented Aug 15, 2023

dukenv0307 commented Aug 15, 2023 •

edited

Loading

dukenv0307 commented Aug 15, 2023

dukenv0307 commented Aug 16, 2023

situchan commented Aug 16, 2023

dukenv0307 commented Aug 16, 2023

situchan commented Aug 16, 2023

situchan commented Aug 16, 2023

dukenv0307 commented Aug 17, 2023

francoisl commented Aug 17, 2023

situchan commented Aug 17, 2023 •

edited

Loading

situchan commented Aug 17, 2023

situchan commented Aug 17, 2023

situchan left a comment

melvin-bot bot commented Aug 17, 2023

francoisl commented Aug 17, 2023

OSBotify commented Aug 17, 2023

OSBotify commented Aug 21, 2023

mvtglobally commented Aug 22, 2023

situchan commented Aug 22, 2023

OSBotify commented Aug 24, 2023

Fix/23003: Placeholders are overlapping with auto-filled text #24525

Fix/23003: Placeholders are overlapping with auto-filled text #24525

Conversation

dukenv0307 commented Aug 14, 2023 • edited by mvtglobally Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 14, 2023

melvin-bot bot commented Aug 14, 2023

dukenv0307 commented Aug 14, 2023

dukenv0307 commented Aug 14, 2023

situchan commented Aug 14, 2023

dukenv0307 commented Aug 15, 2023

situchan Aug 15, 2023

Choose a reason for hiding this comment

dukenv0307 Aug 15, 2023

Choose a reason for hiding this comment

situchan commented Aug 15, 2023

situchan commented Aug 15, 2023

dukenv0307 commented Aug 15, 2023 • edited Loading

dukenv0307 commented Aug 15, 2023

dukenv0307 commented Aug 16, 2023

situchan commented Aug 16, 2023

dukenv0307 commented Aug 16, 2023

situchan commented Aug 16, 2023

situchan commented Aug 16, 2023

dukenv0307 commented Aug 17, 2023

francoisl commented Aug 17, 2023

situchan commented Aug 17, 2023 • edited Loading

situchan commented Aug 17, 2023

Reviewer Checklist

Screenshots/Videos

situchan commented Aug 17, 2023

situchan left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Aug 17, 2023

francoisl commented Aug 17, 2023

OSBotify commented Aug 17, 2023

OSBotify commented Aug 21, 2023

mvtglobally commented Aug 22, 2023

situchan commented Aug 22, 2023

OSBotify commented Aug 24, 2023

dukenv0307 commented Aug 14, 2023 •

edited by mvtglobally

Loading

dukenv0307 commented Aug 15, 2023 •

edited

Loading

situchan commented Aug 17, 2023 •

edited

Loading