Fix: Composer not focused on click while editor's emoji modal is open #28238

tienifr · 2023-09-26T08:25:57Z

Details

Composer is not focused on click while editor's emoji modal is still open. This PR fixes that.

Fixed Issues

$ #25892
PROPOSAL: #25892 (comment)

Tests

Web & Desktop

Go to any chat
Switch a message to edit mode (A)
Click Emoji button of A, leave the modal open
Click main composer
Verify that main composer is focused
=====
Click A composer
Right click LHN item >> Mark as unread
Verify that A is focused
Right click another message >> Copy to clipboard
Verify that A is focused
=====
Switch another message to edit mode (B)
Click Emoji button of A >> Close the modal
Verify that A is focused
Repeat step 12-13 with B
=====
Click then Close B composer
Verify that main composer is focused
=====
Click A composer
Delete A from another device/browser
Right click another message >> Copy to clipboard
Verify that main composer is focused

mWeb & Android & iOS

Go to any chat
Switch a message to edit mode (A)
Verify main composer hides
Click Emoji button of A >> Close the modal
Verify that A is focused
=====
Right click a message >> Copy to clipboard
Verify that A is focused
=====
Switch another message to edit mode (B)
Click Emoji button of A >> Close the modal
mWeb & Android: Verify that A is focused
mWeb & Android: Repeat step 9-10 with B
iOS: Verify that B is focused
=====
Press then Close B composer
Verify main composer appears
=====
Click A composer
Delete A from another device/browser
Verify that main composer appears
Right click another message >> Copy to clipboard
mWeb: Verify that main composer is focused

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Go to any chat
Switch a message to edit mode
Click Emoji button in the edit composer, leave the modal open
Click the main composer
Verify that the main composer is focused

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web-compressed.mov

web1-compressed.mov

web2-compressed.mov

Mobile Web - Chrome

Screenrecording_20231004_163233.mp4

Screenrecording_20231004_163521.mp4

Mobile Web - Safari

safari-compressed.mov

safari2-compressed.mov

Desktop

desktop-compressed.mov

iOS

ios-compressed.mov

ios2-compressed.mov

Android

android-compressed.mov

MitchExpensify · 2023-09-30T00:43:07Z

When do you think this will be ready for review @tienifr ?

melvin-bot · 2023-10-04T17:57:10Z

@parasharrajat 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-10-04T18:36:26Z

@parasharrajat The expected behaviors in above test cases are referenced from production.

parasharrajat · 2023-10-06T05:37:16Z

src/libs/ReportActionComposeFocusManager.ts

@@ -15,6 +15,7 @@ let mainComposerFocusCallback: FocusCallback | null = null;
 * Typical uses of this would be call the focus on the ReportActionComposer.
 *
 * @param callback callback to register
+ * @param isMainComposer


There is no use of this unless you define the param via a comment.

parasharrajat · 2023-10-06T05:42:52Z

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

@@ -517,7 +520,10 @@ function ComposerWithSuggestions({
                    onKeyPress={triggerHotkeyActions}
                    style={[styles.textInputCompose, isComposerFullSize ? styles.textInputFullCompose : styles.flex4]}
                    maxLines={maxComposerLines}
-                    onFocus={onFocus}
+                    onFocus={() => {
+                        setUpComposeFocusManager(false);


Can you explain this?

Just a note: Explained here #28238 (comment).

parasharrajat · 2023-10-06T05:45:54Z

src/pages/home/report/ReportActionItemMessageEdit.js

+    /**
+     * Focus the composer text input
+     * @param {Boolean} [shouldDelay=false] Impose delay before focusing the composer
+     * @memberof ReportActionCompose
+     */
+    const focus = useCallback((shouldDelay = false) => {
+        focusWithDelay(textInputRef.current)(shouldDelay);
+    }, []);


Why did you recreate this if it was already present below? If you want to use useCallback, we can do so

Suggested change

/**

* Focus the composer text input

* @param {Boolean} [shouldDelay=false] Impose delay before focusing the composer

* @memberof ReportActionCompose

*/

const focus = useCallback((shouldDelay = false) => {

focusWithDelay(textInputRef.current)(shouldDelay);

}, []);

const focus = useCallback(focusWithDelay(textInputRef.current), []);

This was referenced from ComposerWithSuggestions which allows the shouldDelay param:

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

Lines 383 to 385 in 30b3992

const focus = useCallback((shouldDelay = false) => {

focusWithDelay(textInputRef.current)(shouldDelay);

}, []);

Anw, the former implementation without useCallback is still fine if you want to stick with it.

Actually, focusWithDelay is a curry function that returns a callback that accepts shouldDelay by default. IMO, it was done in this way to be explicit about parameters. If the suggested code works, let's do that instead.

const focus = useCallback(focusWithDelay(textInputRef.current), []);

This would cause lint error: ESLint: React Hook useCallback received a function whose dependencies are unknown. Pass an inline function instead. I think the implementation referenced from ComposerWithSuggestions is better.

parasharrajat · 2023-10-06T05:50:20Z

src/pages/home/report/ReportActionItemMessageEdit.js

+        ReportActionComposeFocusManager.onComposerFocus(() => {
+            focus(true);
+        });


Suggested change

ReportActionComposeFocusManager.onComposerFocus(() => {

focus(true);

});

ReportActionComposeFocusManager.onComposerFocus(() => {

focus(true);

}, false);

The dafault param for isMainComposer is false so no need to specify this again.

it is more readable and understandable to be explicit about it.

parasharrajat · 2023-10-06T05:52:11Z

src/pages/home/report/ReportActionItemMessageEdit.js

@@ -145,6 +162,8 @@ function ReportActionItemMessageEdit(props) {
        }

        return () => {
+            ReportActionComposeFocusManager.clear();


let's create a new effect for the setting of focus thing. We should not pollute other effects

parasharrajat · 2023-10-06T07:31:27Z

src/pages/home/report/ReportActionItemMessageEdit.js

+                            onPress={() => {
+                                setUpComposeFocusManager();
+                            }}


Suggested change

onPress={() => {

setUpComposeFocusManager();

}}

onPress={setUpComposeFocusManager}

PLease add a comment

parasharrajat · 2023-10-06T07:32:10Z

src/pages/home/report/ReportActionItemMessageEdit.js

@@ -365,6 +379,7 @@ function ReportActionItemMessageEdit(props) {
                                setIsFocused(true);
                                reportScrollManager.scrollToIndex({animated: true, index: props.index}, true);
                                setShouldShowComposeInputKeyboardAware(false);
+                                setUpComposeFocusManager();


This will cause recursion.

In other words, We will resubscribe to focusHandler(ReportActionComposeFocusManager) every time, it gets focused where focus might be triggered from the same focushandler(ReportActionComposeFocusManager).

The purpose of this is to let the last focused composer to re-gain focus:

We need to make sure the ReportActionComposeFocusManager can handle both:

general composer (which includes the edit composer): If this is the last composer that was focused on, we want to refocus on this

main composer: If there's no last composer that was focused on before, this should be the fallback composer that we need to focus

This also explains why I did the same with ComposerWithSuggestions above.

I don't think this could cause recursion because focusCallback is overwritten.

From code perspective, previously the onComposerFocus callback was overwritten onFocus in Composer component. Thus if we removed the callback there, we need to do the same with parent composers.

Speaking of this, I realized that we should not subscribe the focus callback when composer mounts but when it's focused instead. Subscribe on mount is redundant.

src/pages/home/report/ReportActionItemMessageEdit.js

parasharrajat · 2024-08-27T07:57:55Z

But we blurred the input by clicking outside so no edit composer was focused, thus main composer should be focused. But I think it is not a big problem either can be focused.

parasharrajat · 2024-08-28T16:43:20Z

BUG: Web: Edit comment does not focus the message being edited.

28.08.2024_22.12.12_REC.mp4

parasharrajat · 2024-08-28T16:45:06Z

BUG: Web: Main composer focus does not work.

28.08.2024_22.14.26_REC.mp4

parasharrajat · 2024-08-30T10:36:59Z

@tienifr Do you know why we are seeing these issues now?

tienifr · 2024-08-30T15:40:21Z

@parasharrajat Sorry for the delay, I'm checking now

tienifr · 2024-08-30T16:21:33Z

@parasharrajat Did you disable strict mode? Everything works well on my side without strict mode

web-resize.mp4

parasharrajat · 2024-08-30T16:56:18Z

Aha, damn StrictMode. I will recheck.

parasharrajat · 2024-09-03T11:26:54Z

I will check this in 2 hours.

parasharrajat · 2024-09-03T20:22:59Z

Screenshots

🔲 iOS / native

04.09.2024_12.43.24_REC.mp4

🔲 iOS / Safari

04.09.2024_12.45.41_REC.mp4

🔲 MacOS / Desktop

04.09.2024_12.40.05_REC.mp4

🔲 MacOS / Chrome

04.09.2024_12.19.12_REC.mp4

🔲 Android / Chrome

04.09.2024_12.50.15_REC.mp4

🔲 Android / native

04.09.2024_14.36.27_REC.mp4

parasharrajat · 2024-09-04T07:19:52Z

I noticed that focusing does not work properly on iOS Safari. When we edit a message while another edit composer is focused, focus does not switch to new edit composer. @tienifr

parasharrajat · 2024-09-04T09:09:37Z

Overall, the PR looks good. I noticed that focus work different on safari mobile. What are your thoughts on this?

Also, on mweb chrome, the main composer does not hide when we edit a message.

parasharrajat · 2024-09-04T11:29:24Z

As soon as the above queries are cleared, I will complete the checklist. I have already tested the PR. @tienifr

parasharrajat · 2024-09-05T09:27:05Z

@tienifr Would love to hear you first?

tienifr · 2024-09-06T03:17:47Z

@parasharrajat I'm checking

parasharrajat · 2024-09-06T19:21:25Z

@tienifr Anything?

tienifr · 2024-09-07T15:18:42Z

@parasharrajat Here's what I found on Safari

the main composer does not hide when we edit a message.

Screen.Recording.2024-09-07.at.21.59.54.mov

When we edit a message while another edit composer is focused, focus does not switch to new edit composer

Screen.Recording.2024-09-07.at.22.04.21.mov

These issues happen even on staging, here's the logic to trigger focus on edit composer and hide main composer

App/src/pages/home/report/ReportActionItem.tsx

Line 277 in 7ebfaa0

focusTextInputAfterAnimation(textInputRef.current, 100);

but it doesn't work on Safari, I think it's because of the keyboard animation. After using setTimeout likes we already did in android native, it works well

App/src/libs/focusTextInputAfterAnimation/index.android.ts

Lines 20 to 24 in 7ebfaa0

    
           const focusTextInputAfterAnimation: FocusTextInputAfterAnimation = (inputRef, animationLength = 0) => { 
        
               setTimeout(() => { 
        
                   inputRef?.focus(); 
        
               }, animationLength); 
        
           };

Screen.Recording.2024-09-07.at.22.08.21.mov

I'm not sure we should fix it here, since they already happen on staging/main and not really related to this issue. We can create the separate issue and find the deeper RCA

parasharrajat

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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(theme.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 the PR modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label so the design team can review the changes.
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.

🎀 👀 🎀 C+ reviewed

tienifr · 2024-09-10T03:21:55Z

@johnmlee101 Can you take a look at this PR? Thanks

tienifr · 2024-09-11T03:11:18Z

@johnmlee101 friendly bump

OSBotify · 2024-09-12T16:02: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 · 2024-09-12T21:37:21Z

🚀 Deployed to staging by https://github.com/johnmlee101 in version: 9.0.34-0 🚀

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

OSBotify · 2024-09-13T22:45:03Z

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

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

tienifr added 2 commits September 26, 2023 15:25

fix: composer not focused on click

0f02054

add focus check

86d30a4

tienifr changed the title ~~fix: composer not focused on click~~ Fix: Composer not focused on click while editor's emoji modal is open Sep 26, 2023

tienifr added 3 commits September 26, 2023 17:13

reuse existing functions

27f6a05

clear FocusManager on unmount

24d1fa9

Merge branch 'main' of https://github.com/tienifr/App into fix/25892

d262d65

tienifr added 7 commits October 2, 2023 14:41

Merge branch 'main' of https://github.com/tienifr/App into fix/25892

f9a54af

Merge branch 'main' of https://github.com/tienifr/App into fix/25892

83f7745

focus main composer

801066c

re-focus the right composer on emoji modal hide

0472812

Merge branch 'main' of https://github.com/tienifr/App into fix/25892

e7c2fb5

refocus composer on context menu close

b2dede8

Merge branch 'main' of https://github.com/tienifr/App into fix/25892

c6b17d5

tienifr marked this pull request as ready for review October 4, 2023 17:57

tienifr requested a review from a team as a code owner October 4, 2023 17:57

melvin-bot bot requested review from parasharrajat and removed request for a team October 4, 2023 17:57

tienifr mentioned this pull request Oct 4, 2023

[$1000] Chat - Composer Not focused when clicking on composer box #25892

Closed

6 tasks

remove willBlurOnTapOutside check to re-focus the correct composer

3f4e9d7

Merge branch 'main' of https://github.com/tienifr/App into fix/25892

fb99586

parasharrajat suggested changes Oct 6, 2023

View reviewed changes

parasharrajat reviewed Oct 6, 2023

View reviewed changes

tienifr added 2 commits October 6, 2023 17:42

clear focus callback on unmount

6bcd089

add comment

b1025c1

parasharrajat reviewed Oct 6, 2023

View reviewed changes

src/pages/home/report/ReportActionItemMessageEdit.js Outdated Show resolved Hide resolved

parasharrajat reviewed Oct 6, 2023

View reviewed changes

src/pages/home/report/ReportActionItemMessageEdit.js Outdated Show resolved Hide resolved

tienifr added 2 commits August 30, 2024 22:43

Merge branch 'main' into fix/25892

031ab6c

lint fix

dc73745

Merge branch 'main' into fix/25892

b41e23c

parasharrajat approved these changes Sep 7, 2024

View reviewed changes

melvin-bot bot requested a review from johnmlee101 September 7, 2024 15:50

johnmlee101 approved these changes Sep 12, 2024

View reviewed changes

johnmlee101 merged commit d389de2 into Expensify:main Sep 12, 2024
16 checks passed

github-actions bot mentioned this pull request Sep 12, 2024

Deploy Checklist: New Expensify 2024-09-12 #49139

Closed

30 tasks

eVoloshchak mentioned this pull request Sep 15, 2024

[HOLD for payment 2024-10-17] [$500] Chat - Edit composer is focused even if emoji picker is open #27612

Closed

6 tasks

	const focus = useCallback((shouldDelay = false) => {
	focusWithDelay(textInputRef.current)(shouldDelay);
	}, []);

Fix: Composer not focused on click while editor's emoji modal is open #28238

Fix: Composer not focused on click while editor's emoji modal is open #28238

Conversation

tienifr commented Sep 26, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Web & Desktop

mWeb & Android & iOS

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MitchExpensify commented Sep 30, 2023

melvin-bot bot commented Oct 4, 2023

tienifr commented Oct 4, 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

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

parasharrajat 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

parasharrajat Oct 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tienifr Oct 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tienifr Oct 6, 2023 • edited Loading

Choose a reason for hiding this comment

parasharrajat commented Aug 27, 2024

parasharrajat commented Aug 28, 2024 • edited Loading

parasharrajat commented Aug 28, 2024

parasharrajat commented Aug 30, 2024

tienifr commented Aug 30, 2024

tienifr commented Aug 30, 2024

parasharrajat commented Aug 30, 2024

parasharrajat commented Sep 3, 2024

parasharrajat commented Sep 3, 2024 • edited Loading

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

parasharrajat commented Sep 4, 2024

parasharrajat commented Sep 4, 2024

parasharrajat commented Sep 4, 2024 • edited Loading

parasharrajat commented Sep 5, 2024 • edited Loading

tienifr commented Sep 6, 2024

parasharrajat commented Sep 6, 2024

tienifr commented Sep 7, 2024

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

tienifr commented Sep 10, 2024

tienifr commented Sep 11, 2024

OSBotify commented Sep 12, 2024

OSBotify commented Sep 12, 2024

OSBotify commented Sep 13, 2024

tienifr commented Sep 26, 2023 •

edited by github-actions bot

Loading

parasharrajat Oct 6, 2023 •

edited

Loading

parasharrajat Oct 6, 2023 •

edited

Loading

tienifr Oct 6, 2023 •

edited

Loading

tienifr Oct 6, 2023 •

edited

Loading

parasharrajat commented Aug 28, 2024 •

edited

Loading

parasharrajat commented Sep 3, 2024 •

edited

Loading

parasharrajat commented Sep 4, 2024 •

edited

Loading

parasharrajat commented Sep 5, 2024 •

edited

Loading