fix: 23886 Composer out focus when the thread has many messages #24369

tienifr · 2023-08-10T13:18:23Z

Details

Fixed Issues

$ #23886
PROPOSAL: #23886 (comment)

Tests

Open any report
Chat a message
Go reply in thread
Click edit parent message
Click composer and send many messages (about > 22 messages)
Verify that the composer doesn't lose focus

Note: The test for mWeb/Safari is excluded, we will create another issue for the mWeb/Safari issue

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Open any report
Chat a message
Go reply in thread
Click edit parent message
Click composer and send many messages (about > 22 messages)
Verify that the composer doesn't lose focus

Note: The test for mWeb/Safari is excluded, we will create another issue for the mWeb/Safari issue

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-08-10.at.18.21.12.mov

Mobile Web - Chrome

original-AB65C07F-1DF4-4EA1-BC13-BCEE4CA17EE5.mp4

Mobile Web - Safari

original-12591D72-86BC-42AF-8A9C-40FCDB5AB5CD.mp4

Desktop

desktop-compressed.mov

iOS

Screen.Recording.2023-08-10.at.22.14.42.mov

Android

Screen.Recording.2023-08-10.at.22.16.24.mov

melvin-bot · 2023-08-10T15:20:27Z

@mollfpr 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-11T04:57:04Z

@mollfpr

App/src/pages/home/report/ReportActionItemMessageEdit.js

Lines 110 to 114 in 893d943

    
           useEffect(() => { 
        
               // For mobile Safari, updating the selection prop on an unfocused input will cause it to automatically gain focus 
        
               // and subsequent programmatic focus shifts (e.g., modal focus trap) to show the blue frame (:focus-visible style), 
        
               // so we need to ensure that it is only updated after focus. 
        
               setDraft((prevDraft) => {

In ReportActionItemMessageEdit we have the logic to init selection whenever this component is mounted. As the comment, the input will be re-focused after the selections are updated on Safari. So I decide to add the logic to prevent selections init when the main composer is focused.

 if (!ReportActionComposeFocusManager.isFocused()) {
            didInitSelection.current = true;
            initSelection();
        }

tienifr · 2023-08-14T02:41:24Z

@mollfpr Pls help take a look at my PR when you have time. Thanks

mollfpr · 2023-08-14T03:14:05Z

Sorry for the delay @tienifr. I got sick a few days ago 🙏

I'll complete the review today.

Regarding the init selection changes, is that regression from the original solution?

tienifr · 2023-08-14T03:40:26Z

Regarding the init selection changes, is that regression from the original solution?

my original proposal works well on web but on mweb we need to change the code a little more to make it work on Safari.

App/src/pages/home/report/ReportActionItemMessageEdit.js

Lines 110 to 114 in 893d943

    
           useEffect(() => { 
        
               // For mobile Safari, updating the selection prop on an unfocused input will cause it to automatically gain focus 
        
               // and subsequent programmatic focus shifts (e.g., modal focus trap) to show the blue frame (:focus-visible style), 
        
               // so we need to ensure that it is only updated after focus. 
        
               setDraft((prevDraft) => {

mollfpr · 2023-08-14T14:05:22Z

@tienifr In mWeb/Safari refresh the page and navigate to the report focusing on the edit composer.

Simulator.Screen.Recording.-.iPhone.14.Pro.-.2023-08-14.at.21.01.50.mp4

tienifr · 2023-08-14T16:48:35Z

@tienifr In mWeb/Safari refresh the page and navigate to the report focusing on the edit composer.

Do you think it's the bug? As I can see it happens even on staging

mollfpr · 2023-08-14T16:57:10Z

Do you think it's the bug? As I can see it happens even on staging

Previously, it was happening on all platforms. In this PR, it's not changed on mWeb/Safari. I think we can create another issue, specifically for the mWeb/Safari, since it needs more time to debug and search for the solution.

tienifr · 2023-08-15T03:02:37Z

Previously, it was happening on all platforms. In this PR, it's not changed on mWeb/Safari

@mollfpr Is it out of the scope? If so, we should proceed to get this GH done first.

mollfpr · 2023-08-16T17:25:50Z

@tienifr Do we get the same result for isFirstRender on the mWeb/Safari for this issue?

…-has-many-messages

tienifr · 2023-08-21T04:23:46Z

@mollfpr Yes, we get the same result on this PR and staging

mollfpr · 2023-08-21T05:55:49Z

Thanks @tienifr I'll finish the review now.

mollfpr · 2023-08-21T13:20:16Z

@tienifr Could you check on the mWeb/Safari? It seems the new logic on ReportActionItemMessageEdit didn't work anymore. Other platforms seem working well.

Simulator.Screen.Recording.-.iPhone.14.Pro.-.2023-08-21.at.20.00.29.mp4

tienifr · 2023-08-22T07:42:57Z

@mollfpr After merging the newest main, I still face this problem again. I swear it worked before. The problem is on iOS, updating the selections makes the input focus, that why when the edit composer is re-mount, the edit composer is focused again. So I just want to pass the selections into the input only when it's focused. Sorry for this inconvenience

mollfpr · 2023-08-22T11:24:15Z

src/components/Composer/index.js

    return (
        <>
            <RNTextInput
                autoComplete="off"
                autoCorrect={!Browser.isMobileSafari()}
                placeholderTextColor={themeColors.placeholderText}
                ref={(el) => (textInput.current = el)}
-                selection={selection}
+                selection={isFocused ? selection : null}


@tienifr Could you make the condition only apply to mobile safari? You said that this happened due to the edit composer being re-mount; why do we need to put the logic in the generic composer component?

Updated! Thanks for your suggestion

Thanks @tienifr, for the quick update.

It's looking good, but I am trying to understand why we need to put the logic in the generic composer component. Could you explain it?

In the generic composer we init the selections for the input, if we don't do that, when the input re-mounts, the selection will make the input be re-focused. I also think it's the good place to fix because we can prevent all inputs re-focus unexpectedly

mollfpr · 2023-08-23T14:32:09Z

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

24369.Web.mov

Mobile Web - Chrome

24369.mWeb.Chrome.webm

Mobile Web - Safari

Desktop

24369.Desktop.mov

iOS

24369.iOS.mp4

Android

24369.Android.webm

mollfpr

LGTM and tests well 👍

Some suggestion on the tests step. On the step 5, we should provide the way to show the main composer. On the Web/Desktop, we can press/click any other part of the chat, but on the native it's not working the same way.

thienlnam

Hmm, platform specific code is stuff we are actively trying to avoid in this repo as much as possible. I overlooked this when looking at the proposal but it seems like the root cause is within safari handling blurred elements. Do you agree?

tienifr · 2023-08-24T03:35:02Z

@thienlnam The problem here is, on Safari the input will be focused if we update the selection for it. We already mentioned it here

App/src/pages/home/report/ReportActionItemMessageEdit.js

Lines 120 to 122 in bb2386b

    
           // For mobile Safari, updating the selection prop on an unfocused input will cause it to automatically gain focus 
        
           // and subsequent programmatic focus shifts (e.g., modal focus trap) to show the blue frame (:focus-visible style), 
        
           // so we need to ensure that it is only updated after focus.

Unfortunately, when the edit composer is out of viewport, it will be re-mounted if users add new message => the edit composer will be focused because it receive the new selection.

mollfpr · 2023-08-24T10:14:32Z

@thienlnam @tienifr Otherwise, we can revert the platform-specific safari, and let's find the fix. I think the original proposal should be fixed on all platforms if we don't have a problem with the selection on safari.

mollfpr · 2023-08-24T10:57:16Z

Should we hold this PR until the ReportActionCompose refactor is merged? https://expensify.slack.com/archives/C01GTK53T8Q/p1692859954067409

tienifr · 2023-08-25T02:43:19Z

I didn't change ReportActionCompose, so I think we can merge this PR. cc @thienlnam

thienlnam · 2023-08-28T17:45:54Z

The problem here is, on Safari the input will be focused if we update the selection for it. We already mentioned it here

Yeah, but that sounds like a Safari specific bug we're making exceptions for

@thienlnam @tienifr Otherwise, we can revert the platform-specific safari, and let's find the fix. I think the original proposal should be fixed on all platforms if we don't have a problem with the selection on safari.

I agree with this - we should be fixing the root cause so we don't continue to add platform specific fixes in the code. Let's

Remove the platform specific handling in this PR and merge this - creating another issue to remove the platform specific changes in ReportActionItemEdit

tienifr · 2023-08-29T03:14:52Z

@mollfpr I removed the platform specific handling. Can you help take a look at my PR? Thanks

mollfpr

It looks good on all platforms except mWeb/Safari. @tienifr Could you add a note for QA that the test for mWeb/Safari is excluded, and we will create another issue for the mWeb/Safari selection issue?

thienlnam

Great - thank you both

OSBotify · 2023-08-29T17:43:56Z

✋ 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-30T01:53:24Z

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

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

OSBotify · 2023-08-31T01:03:06Z

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

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

OSBotify · 2023-08-31T01:46:31Z

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

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

OSBotify · 2023-08-31T01:53:42Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.59-5 🚀

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

OSBotify · 2023-08-31T22:50:43Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.60-3 🚀

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

fix: 23886 Composer out focus when the thread has many messages

750634a

tienifr marked this pull request as ready for review August 10, 2023 15:20

tienifr requested a review from a team as a code owner August 10, 2023 15:20

melvin-bot bot requested review from mollfpr and removed request for a team August 10, 2023 15:20

tienifr mentioned this pull request Aug 10, 2023

[HOLD for payment 2023-09-07] [$1000] Web - Composer out focus when the thread has many messages #23886

Closed

6 tasks

tienifr added 2 commits August 17, 2023 13:33

merge main

850e689

Merge branch 'main' into fix/23886-composer-out-focus-when-the-thread…

ea03ef5

…-has-many-messages

update selections makes input auto focus

93078cc

prettier fix

deb5389

mollfpr reviewed Aug 22, 2023

View reviewed changes

tienifr added 3 commits August 22, 2023 19:31

add safari check

ed2842f

add comments

7d3bd2d

format fix

9ecf331

mollfpr approved these changes Aug 23, 2023

View reviewed changes

melvin-bot bot requested a review from thienlnam August 23, 2023 14:57

thienlnam requested changes Aug 23, 2023

View reviewed changes

revert platform specific handling

f74dbb1

mollfpr approved these changes Aug 29, 2023

View reviewed changes

melvin-bot bot requested a review from thienlnam August 29, 2023 13:44

thienlnam approved these changes Aug 29, 2023

View reviewed changes

thienlnam merged commit 430a837 into Expensify:main Aug 29, 2023

OSBotify mentioned this pull request Aug 30, 2023

Deploy Checklist: New Expensify 2023-08-30 #26268

Closed

OSBotify mentioned this pull request Aug 31, 2023

Deploy Checklist: New Expensify 2023-08-31 #26359

Closed

69 tasks

fix: 23886 Composer out focus when the thread has many messages #24369

fix: 23886 Composer out focus when the thread has many messages #24369

Conversation

tienifr commented Aug 10, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 10, 2023

tienifr commented Aug 11, 2023 • edited Loading

tienifr commented Aug 14, 2023

mollfpr commented Aug 14, 2023

tienifr commented Aug 14, 2023 • edited Loading

mollfpr commented Aug 14, 2023

tienifr commented Aug 14, 2023

mollfpr commented Aug 14, 2023

tienifr commented Aug 15, 2023

mollfpr commented Aug 16, 2023

tienifr commented Aug 21, 2023

mollfpr commented Aug 21, 2023

mollfpr commented Aug 21, 2023

tienifr commented Aug 22, 2023

mollfpr Aug 22, 2023

Choose a reason for hiding this comment

tienifr Aug 22, 2023

Choose a reason for hiding this comment

mollfpr Aug 22, 2023

Choose a reason for hiding this comment

tienifr Aug 22, 2023

Choose a reason for hiding this comment

mollfpr commented Aug 23, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr left a comment

Choose a reason for hiding this comment

thienlnam left a comment

Choose a reason for hiding this comment

tienifr commented Aug 24, 2023

mollfpr commented Aug 24, 2023

mollfpr commented Aug 24, 2023

tienifr commented Aug 25, 2023

thienlnam commented Aug 28, 2023

tienifr commented Aug 29, 2023

mollfpr left a comment

Choose a reason for hiding this comment

thienlnam left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 29, 2023

OSBotify commented Aug 30, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Aug 31, 2023

OSBotify commented Aug 31, 2023

tienifr commented Aug 10, 2023 •

edited

Loading

tienifr commented Aug 11, 2023 •

edited

Loading

tienifr commented Aug 14, 2023 •

edited

Loading

mollfpr commented Aug 23, 2023 •

edited

Loading