focus logic update for multiline fields #27702

chiragxarora · 2023-09-18T17:16:36Z

Details

Fixed Issues

$ #21654
PROPOSAL: #21654 (comment)

Tests

Open the app and visit the following pages after adding multiline text in the fields
Pages: request money description, task description, room welcome message, private notes room page
Add data to those and open again
Verify that the input fields are focused correctly and the cursor is at the end

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Open the app and visit the following pages after adding multiline text in the fields
Pages: request money description, task description, room welcome message, private notes room page
Add data to those and open again
Verify that the input fields are focused correctly and the cursor is at the end

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-09-18.at.11.22.38.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-09-19.at.12.09.28.AM.mov

Mobile Web - Safari

Screen.Recording.2023-09-19.at.12.06.11.AM.mov

Desktop

Screen.Recording.2023-09-19.at.12.23.37.AM.mov

iOS

Screen.Recording.2023-09-19.at.12.02.32.AM.mov

Android

Screen.Recording.2023-09-19.at.12.09.28.AM.mov

melvin-bot · 2023-09-18T17:16:41Z

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

chiragxarora · 2023-09-19T08:48:09Z

PR is ready for review @0xmiroslav

chiragxarora · 2023-09-19T18:47:20Z

Hi @thienlnam
Need your input on this issue,

what we are dealing with is the top down transition on multiline inputs where we set focus using the ref and set cursor and scroll all together. The transition's (which is the actual bug report) RCA is that focus is set immediately and cursor is set using selection range and scroll is also adjusted together, so by the time second and third operations complete, the field is already in focus and after completion of other operations, we see the top down transition.

The solution I came up with is setting the cursor and scroll as soon as input ref is available but set the focus after the transition delay, which is in line with the newly agreed focus logic here and correct solution wrt the rca

https://expensify.slack.com/archives/C01GTK53T8Q/p1694660990479979

But the problem is that scroll does not work in native iOS platform which is an RN bug (I suppose, got insights from this PR: #20836 ) and this scroll issue for ios is still persistent in the app along with the top down transition for all platform.

Now we have 2 ways: either we let the ios issue be and wait for the real fix to come regarding the scroll and continue with the top down transition fix on all other platforms,
or we handle ios case separately by focusing it instantly without any delay (it seems to be working on ios) together with the main top down issue fix

(these are the options which we have as per mine and @0xmiroslav 's debugging)

you can see the pr for reference, holding this PR on your response

@0xmiroslav @thienlnam

chiragxarora · 2023-09-19T18:49:15Z

let me know your thoughts so we can proceed

0xmiros · 2023-09-19T18:54:07Z

Adding my cents here:

either we let the ios issue be and wait for the real fix to come regarding the scroll and continue with the top down transition fix on all other platforms,
pros: don't put workaround
cons: doesn't fix iOS scrolling issue
or we handle ios case separately by focusing it instantly without any delay (it seems to be working on ios) together with the main top down issue fix
pros: platform consistency, fixes all platforms including iOS
cons: workaround, focus() is called twice (immediate & after setTimeout) though not affect the behavior

chiragxarora · 2023-09-20T09:59:38Z

Friendly reminder @thienlnam

thienlnam · 2023-09-21T01:54:28Z

Thanks for the summary - let's go with option 2 so we fix the mentioned bug and then create a separate tracking issue for the iOS scrolling issue and add comments in the code about why we're doing this and link to the tracking issue.

chiragxarora · 2023-09-21T02:28:00Z

Got it, will amend the PR accordingly

0xmiros · 2023-09-21T07:00:44Z

Got it, will amend the PR accordingly

ok please let me know when ready

chiragxarora · 2023-09-21T15:05:58Z

on it now @0xmiroslav

chiragxarora · 2023-09-21T16:13:57Z

pr is ready for review, tests passed @0xmiroslav

0xmiros

Update multiline data to multiline text in Test step.
Also capitalize first letter in each sentence.

src/libs/UpdateMultilineInputRange/index.ios.js

chiragxarora · 2023-09-21T18:38:26Z

done @0xmiroslav

0xmiros · 2023-09-22T03:44:25Z

@chiragxarora please fix conflict

chiragxarora · 2023-09-22T04:29:25Z

done @0xmiroslav , pls check again

0xmiros · 2023-09-22T08:11:39Z

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

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

0xmiros

LGTM!

@thienlnam all yours

thienlnam

Awesome, thank ya!

OSBotify · 2023-09-22T08:23:02Z

✋ 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-09-22T13:58:44Z

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

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

OSBotify · 2023-09-25T09:33:35Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

OSBotify · 2023-09-25T10:05:33Z

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

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

OSBotify · 2023-09-28T18:47:54Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

jjcoffee · 2023-10-11T14:59:35Z

@0xmiroslav @thienlnam Sorry to jump in on this fairly old issue, but any idea if a tracking issue (as suggested here) was created for the iOS issue. The code just links here.

0xmiros · 2023-10-11T15:03:05Z

I don't think issue was created for that. And not worth fixing for now I believe, focusing on other priority issues.

chiragxarora added 2 commits September 18, 2023 22:34

multiline focus logic updated

5ba5ee7

merge main

9e2c1e1

chiragxarora requested a review from a team as a code owner September 18, 2023 17:16

melvin-bot bot requested review from 0xmiros and removed request for a team September 18, 2023 17:16

chiragxarora added 2 commits September 19, 2023 01:02

using focus hook

32168a2

using hook in other multiline inputs

cadf082

chiragxarora added 4 commits September 19, 2023 22:59

refactor

82361a7

merge main

05f8ae6

prettier

4ed922b

rename

1984a13

chiragxarora added 4 commits September 20, 2023 21:21

merge conflicts

f4010d6

jsdoc edit

208325c

lint fix

8cb5296

rename

8e85845

chiragxarora added 4 commits September 21, 2023 20:37

merge main

66a9849

ios specific patch

423d6b6

revert last

48c10bb

ios specific patch for scroll issue

ab6ba9d

0xmiros reviewed Sep 21, 2023

View reviewed changes

src/libs/UpdateMultilineInputRange/index.ios.js Outdated Show resolved Hide resolved

src/libs/UpdateMultilineInputRange/index.ios.js Outdated Show resolved Hide resolved

refactor

b6122b4

chiragxarora requested a review from 0xmiros September 21, 2023 18:53

chiragxarora added 2 commits September 22, 2023 09:56

merge conflicts

fc932f1

prettier

723402c

merge conflicts

6675aa2

0xmiros approved these changes Sep 22, 2023

View reviewed changes

melvin-bot bot requested a review from thienlnam September 22, 2023 08:12

thienlnam approved these changes Sep 22, 2023

View reviewed changes

thienlnam merged commit 28a434c into Expensify:main Sep 22, 2023
14 checks passed

OSBotify mentioned this pull request Sep 22, 2023

Deploy Checklist: New Expensify 2023-09-22 #28013

Closed

96 tasks

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

melvin-bot bot mentioned this pull request Sep 25, 2023

[WAITING ON MIROSLAV FOR PAYMENT] [HOLD for payment 2023-10-02] [$1000] content of input jumps from top to bottom in multi-line inputs #21654

Closed

6 tasks

Ollyws mentioned this pull request Sep 25, 2023

[$500] Web - Private Note - Input is not focused after reloading the page. #27695

Closed

6 tasks

dukenv0307 mentioned this pull request Oct 5, 2023

[$500] Edit private note form doesn't submit by enter key #28860

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

focus logic update for multiline fields #27702

focus logic update for multiline fields #27702

chiragxarora commented Sep 18, 2023 •

edited

Loading

melvin-bot bot commented Sep 18, 2023

chiragxarora commented Sep 19, 2023

chiragxarora commented Sep 19, 2023

chiragxarora commented Sep 19, 2023

0xmiros commented Sep 19, 2023 •

edited

Loading

chiragxarora commented Sep 20, 2023

thienlnam commented Sep 21, 2023 •

edited

Loading

chiragxarora commented Sep 21, 2023

0xmiros commented Sep 21, 2023

chiragxarora commented Sep 21, 2023

chiragxarora commented Sep 21, 2023

0xmiros left a comment

chiragxarora commented Sep 21, 2023

0xmiros commented Sep 22, 2023

chiragxarora commented Sep 22, 2023

0xmiros commented Sep 22, 2023

0xmiros left a comment

thienlnam left a comment

OSBotify commented Sep 22, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

jjcoffee commented Oct 11, 2023

0xmiros commented Oct 11, 2023

focus logic update for multiline fields #27702

focus logic update for multiline fields #27702

Conversation

chiragxarora commented Sep 18, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 18, 2023

chiragxarora commented Sep 19, 2023

chiragxarora commented Sep 19, 2023

chiragxarora commented Sep 19, 2023

0xmiros commented Sep 19, 2023 • edited Loading

chiragxarora commented Sep 20, 2023

thienlnam commented Sep 21, 2023 • edited Loading

chiragxarora commented Sep 21, 2023

0xmiros commented Sep 21, 2023

chiragxarora commented Sep 21, 2023

chiragxarora commented Sep 21, 2023

0xmiros left a comment

Choose a reason for hiding this comment

chiragxarora commented Sep 21, 2023

0xmiros commented Sep 22, 2023

chiragxarora commented Sep 22, 2023

0xmiros commented Sep 22, 2023

Reviewer Checklist

Screenshots/Videos

0xmiros left a comment

Choose a reason for hiding this comment

thienlnam left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 22, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

jjcoffee commented Oct 11, 2023

0xmiros commented Oct 11, 2023

chiragxarora commented Sep 18, 2023 •

edited

Loading

0xmiros commented Sep 19, 2023 •

edited

Loading

thienlnam commented Sep 21, 2023 •

edited

Loading