fix: auto focus and scroll to bottom on large-text in composer #28790

jeet-dhandha · 2023-10-04T06:56:00Z

Details

In web the composer is not scrolling to bottom on large text when a report is opened or if page is refereshed.
We fixed the issue using UpdateMultilineInputRange.
Currently we scroll to each of the platform except iOS, as we don't have a good solution for it.

Fixed Issues

$ #27153
PROPOSAL: #27153 (comment)

Tests

Open a report.
Enter a long enough text to make composer take full height.
Finally close and re-open the report / refresh page of that report.
Verify that the composer is scrolled to bottom for long text for each platforms except iOS.

Verify that no errors appear in the JS console

Offline tests

Open a report.
Enter a long enough text to make composer take full height.
Finally close and re-open the report / refresh page of that report.
Verify that the composer is scrolled to bottom for long text for each platforms except iOS.

QA Steps

Open a report.
Enter a long enough text to make composer take full height.
Finally close and re-open the report / refresh page of that report.
Verify that the composer is scrolled to bottom for long text for each platforms except iOS.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Web.mp4

Mobile Web - Chrome

MobileChrome.mov

Mobile Web - Safari

MobileSafari.mov

Desktop

Desktop.mp4

iOS

iOS.mov

Android

Android.mov

melvin-bot · 2023-10-04T19:49:43Z

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

jjcoffee · 2023-10-05T13:02:03Z

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

chrome-desktop-2023-10-10_17.33.03.mp4

Mobile Web - Chrome

android-chrome.mp4

Mobile Web - Safari

ios-safari-2023-10-13_16.09.20.mp4

Desktop

mac-desktop-2023-10-13_16.06.20.mp4

iOS

ios-native-2023-10-13_16.35.31.mp4

Android

android-native.mp4

jjcoffee · 2023-10-05T14:09:14Z

@jeet-dhandha I'm still getting a delay before the composer scrolls to the bottom, presumably because you're wrapping with InteractionManager.runAfterInteractions. Unless there's a good reason for this that I don't understand, I much prefer the immediate scroll to bottom, feels a lot less janky!

jjcoffee · 2023-10-05T14:09:27Z

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions.js

+
+        InteractionManager.runAfterInteractions(() => {
+            updateMultilineInputRange(textInputRef.current);
+            focus(); // This will focus the composer after its fully rendered.


Unsure why we need to force focus here?

App/src/pages/home/report/ReportActionCompose/ComposerWithSuggestions.js

Line 535 in f070f8b

autoFocus={shouldAutoFocusWithLongText}

If you check above line of code we are disabling autoFocus as we wan't to focus manually after scrollHeight and selection are updated.

So without that, the selection wouldn't be set to the end, is that what you mean? Or what side-effect is there if we don't add that?

Screen.Recording.2023-10-06.at.3.10.04.PM.mov

Without that Composer won't get Focused. As you can see the Cursor isn't there in the end.

Sorry this still isn't really making sense to me. If I remove your change to autoFocus and just have a simple useEffect that runs updateMultilineInputRange, it works fine (on desktop at least). I'm struggling to understand the reason why all this extra logic is necessary here.

Did you check out my video @jjcoffee ?

Lets have a quick chat in Slack here its harder to chat.

@jeet-dhandha Yes, is that with autoFocus set back to shouldAutoFocus? I don't get the same behaviour if so...

The original issue also doesn't show any problem with focusing on the composer. That's why I'm quite sceptical about adding extra focus calls here!

jjcoffee · 2023-10-05T14:11:10Z

@jeet-dhandha Can you please update the test steps to clarify that the text has to be long enough to make the scrollbar appear? It's also probably better to start with entering a long text and then refreshing, otherwise the steps are a bit confusing.

jjcoffee · 2023-10-05T14:18:20Z

@jeet-dhandha One last thing, can you make sure the screenshots follow the test steps? Not all of them seem to have a long enough text.

jeet-dhandha · 2023-10-05T16:48:05Z

Updated Test's and Videos for iOS , Android and Mobile Chrome with longer text
@jjcoffee

jeet-dhandha · 2023-10-05T16:51:28Z

@jeet-dhandha I'm still getting a delay before the composer scrolls to the bottom, presumably because you're wrapping with InteractionManager.runAfterInteractions. Unless there's a good reason for this that I don't understand, I much prefer the immediate scroll to bottom, feels a lot less janky!

Let me check this one.

jeet-dhandha · 2023-10-05T16:56:43Z

True Enough @jjcoffee . InteractionManager was creating janky animation. After Removing it its a lot smoother.

Web

Screen.Recording.2023-10-05.at.10.24.29.PM.mov

jeet-dhandha · 2023-10-05T16:57:54Z

Also updated comment for manual focus().

jeet-dhandha · 2023-10-06T15:15:56Z

Video for difference between with `focus()` and without it.

DEsktop-Video.mp4

jjcoffee · 2023-10-09T16:20:53Z

@jeet-dhandha My point was that if I remove all of your code (including the autoFocus change) and just leave a simple useEffect that runs updateMultilineInputRange, it works fine (on desktop at least). I understand that with the autoFocus change you made, it's necessary to run focus(). I'm seeking clarification from you as to why the autoFocus change is there at all?

jeet-dhandha · 2023-10-09T16:33:48Z

WTH 😵‍💫 it was not working previously as the scroll to bottom animation was coming. But now its working probably due to the removal on InteractionsManager.

@jjcoffee Removing all the unnecessary code.

jeet-dhandha · 2023-10-09T16:36:34Z

@jjcoffee Please review last time 😄

jeet-dhandha · 2023-10-09T16:37:20Z

@jjcoffee If possible lets complete it before 3 day end.

jjcoffee · 2023-10-10T15:18:27Z

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions.js

@@ -445,6 +448,17 @@ function ComposerWithSuggestions({
        textInputRef.current.blur();
    }, []);

+    useEffect(() => {
+        // Initial focus ref to prevent unneccessary focus after first render.
+        if (initialFocusedRef.current || isNativeApp || !shouldAutoFocus) {


I don't think initialFocusedRef is needed anymore since we removed focus calls.

I don't think the isNativeApp check is really necessary here either. Also not sure if you considered under what cases shouldAutoFocus would be false and if we'd not want to scroll to the bottom? It seems to me like we always want to be scrolled to the bottom, but I could be missing some obvious case!

jjcoffee · 2023-10-10T15:46:39Z

@jeet-dhandha As it stands, it doesn't look like we scroll to the bottom on mWeb which I don't think makes sense as you most likely want to continue from the end of your last message, rather than the top (even if we're not focused on the composer!).

jeet-dhandha · 2023-10-11T14:27:37Z

Please check now. @jjcoffee

jeet-dhandha · 2023-10-11T14:28:52Z

I mistakenly added screenshot of index.js instead of index.ios.js.

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

Hmm I see what you mean, can you check the behaviour?

jeet-dhandha · 2023-10-11T14:38:14Z

Yes it focuses it.

jeet-dhandha · 2023-10-11T14:40:19Z

There's a hack which i think we can use, but i don't recommend it.

Screen.Recording.2023-10-11.at.8.08.52.PM.mov

jjcoffee · 2023-10-11T15:10:35Z

Hmm so I think we'll probably need to do the same as on the issue that introduced updateMultilineInputRange and ignore iOS for now as there isn't really a good solution to fix scrolling to the bottom of the input. Looping in @nkuoch here to see if you agree?

Note there's a very old RN issue from 2020 related to this. We could open an issue to see if anyone has a proposal to fix that issue as it would unlock the fix for both this and all pages that rely on updateMultilineInputRange.

jjcoffee · 2023-10-12T11:49:58Z

@jeet-dhandha Could you ensure that iOS doesn't focus on composer, maybe by adding a shouldFocus property to updateMultilineInputRange?

jeet-dhandha · 2023-10-12T17:41:34Z

Added shouldAutoFocus check and below is the output.

Screen.Recording.2023-10-12.at.11.10.11.PM.mov

jjcoffee · 2023-10-13T13:58:36Z

@jeet-dhandha Sweet, thanks! You have conflicts, can you merge main? Hopefully we can get this completed today finally 😄

jjcoffee · 2023-10-13T14:23:11Z

@jeet-dhandha Can you also update the PR description and tests to reflect the latest changes, i.e. we scroll to bottom on all platforms except iOS which we are not supporting for now.

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions.js

…ons.js Co-authored-by: Joel Davies <joeld.dev@gmail.com>

jeet-dhandha · 2023-10-13T14:47:10Z

Done @jjcoffee

jjcoffee

LGTM!

jjcoffee · 2023-10-13T14:53:45Z

@jeet-dhandha Oh actually could you update the description per this comment?

jeet-dhandha · 2023-10-13T18:11:25Z

Updated Description and tests.

OSBotify · 2023-10-17T15:42: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-10-17T23:57:12Z

🚀 Deployed to staging by https://github.com/nkuoch in version: 1.3.86-0 🚀

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

OSBotify · 2023-10-18T23:54:42Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.86-5 🚀

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

jeet-dhandha added 4 commits October 4, 2023 12:22

fix: auto focus and scroll to bottom on large-text in composer

adc3aee

changed shouldAutoFocus to autoFocusCheck in Composer

72bb8a2

updated name for flag and fixed callback dependencies

3828277

removed extra code

f070f8b

jeet-dhandha marked this pull request as ready for review October 4, 2023 19:49

jeet-dhandha requested a review from a team as a code owner October 4, 2023 19:49

melvin-bot bot requested review from jjcoffee and removed request for a team October 4, 2023 19:49

jjcoffee reviewed Oct 5, 2023

View reviewed changes

removed InteractionManager as it was creating a janky animation

f189981

Updated comments and variable name for better understanding

23ff678

jeet-dhandha added 2 commits October 9, 2023 22:04

remove unnecessary code.

2dafa3f

removed focusWithScrolledToBottom

d79641a

jjcoffee reviewed Oct 10, 2023

View reviewed changes

fix: remove extra code and handle web scroll to bottom

317d060

updated checks

8972e44

Merge branch 'main' into fix-27153

fbb9dac

jeet-dhandha mentioned this pull request Oct 13, 2023

[HOLD - App #26239] [$500] Mobile-Safari Auto Focuses Composer in Report on Existing chat #29509

Closed

6 tasks

jjcoffee reviewed Oct 13, 2023

View reviewed changes

src/pages/home/report/ReportActionCompose/ComposerWithSuggestions.js Outdated Show resolved Hide resolved

jeet-dhandha and others added 2 commits October 13, 2023 20:13

Update src/pages/home/report/ReportActionCompose/ComposerWithSuggesti…

1fbbbb0

…ons.js Co-authored-by: Joel Davies <joeld.dev@gmail.com>

Merge branch 'main' into fix-27153

ce44e6e

jjcoffee approved these changes Oct 13, 2023

View reviewed changes

melvin-bot bot requested a review from nkuoch October 13, 2023 14:52

nkuoch approved these changes Oct 17, 2023

View reviewed changes

nkuoch merged commit 7fcb4c1 into Expensify:main Oct 17, 2023
15 checks passed

OSBotify mentioned this pull request Oct 17, 2023

Deploy Checklist: New Expensify 2023-10-17 #29837

Closed

melvin-bot bot mentioned this pull request Oct 18, 2023

[HOLD for payment 2023-10-25] [$1000] Web - App maintains focus but does not scroll to bottom at cursor position on reload #27153

Closed

6 tasks

jeet-dhandha deleted the fix-27153 branch October 19, 2023 17:45

ikevin127 mentioned this pull request Nov 1, 2023

[$1000] IOS - When using multiple lines for the Welcome message, after saving and returning, the app scrolls #30707

Closed

6 tasks

fix: auto focus and scroll to bottom on large-text in composer #28790

fix: auto focus and scroll to bottom on large-text in composer #28790

Conversation

jeet-dhandha commented Oct 4, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 4, 2023

jjcoffee commented Oct 5, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

jjcoffee commented Oct 5, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeet-dhandha Oct 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjcoffee commented Oct 5, 2023

jjcoffee commented Oct 5, 2023

jeet-dhandha commented Oct 5, 2023 • edited Loading

jeet-dhandha commented Oct 5, 2023

jeet-dhandha commented Oct 5, 2023 • edited Loading

jeet-dhandha commented Oct 5, 2023

jeet-dhandha commented Oct 6, 2023

Video for difference between with focus() and without it.

jjcoffee commented Oct 9, 2023

jeet-dhandha commented Oct 9, 2023

jeet-dhandha commented Oct 9, 2023

jeet-dhandha commented Oct 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjcoffee commented Oct 10, 2023

jeet-dhandha commented Oct 11, 2023

jeet-dhandha commented Oct 11, 2023

jjcoffee commented Oct 11, 2023

jeet-dhandha commented Oct 11, 2023

jeet-dhandha commented Oct 11, 2023

jjcoffee commented Oct 11, 2023 • edited Loading

jjcoffee commented Oct 12, 2023

jeet-dhandha commented Oct 12, 2023

jjcoffee commented Oct 13, 2023

jjcoffee commented Oct 13, 2023

jeet-dhandha commented Oct 13, 2023

jjcoffee left a comment

Choose a reason for hiding this comment

jjcoffee commented Oct 13, 2023

jeet-dhandha commented Oct 13, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 18, 2023

jeet-dhandha commented Oct 4, 2023 •

edited

Loading

jjcoffee commented Oct 5, 2023 •

edited

Loading

jeet-dhandha Oct 6, 2023 •

edited

Loading

jeet-dhandha commented Oct 5, 2023 •

edited

Loading

jeet-dhandha commented Oct 5, 2023 •

edited

Loading

Video for difference between with `focus()` and without it.

jjcoffee commented Oct 11, 2023 •

edited

Loading