Fix the emoji picker does not close when editing message is deleted #22984

hoangzinh · 2023-07-17T06:37:06Z

Details

Fixed Issues

$ #22214
PROPOSAL: #22214 (comment)

Tests

Login with userA’s account
Click FAB => Go to the “New room” section
Create a public room with userA workspace
Go to the room details
Share code > Copy URL to clipboard 
Open other browser and login with userB’s account
Join the room by pasting room URL 
Send a message in room from userB
Click on “Edit comment” message after sent
Open emoji picker
Switch back to UserA's account and delete the message sent by UserB
Verify that The emoji picker should close when UserA deletes the message that UserB is editing

Verify that no errors appear in the JS console

Offline tests

Could not test when network is offline

QA Steps

Same as Tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-07-17.at.20.39.07.-.web.mov

Mobile Web - Chrome

Screen.Recording.2023-07-17.at.20.54.58.-.android.chrome.mov

Mobile Web - Safari

Screen.Recording.2023-07-17.at.20.53.05.-.ios.safari.mov

Desktop

Screen.Recording.2023-07-17.at.20.45.05.-.desktop.mp4

iOS

Screen.Recording.2023-07-17.at.20.49.58.-.ios.mp4

Android

Screen.Recording.2023-07-17.at.20.53.58.-.android.mov

melvin-bot · 2023-07-17T13:56:54Z

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

allroundexperts · 2023-07-17T14:52:31Z

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 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

Screen.Recording.2023-07-18.at.2.16.27.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-07-18.at.2.28.34.PM.mov

Mobile Web - Safari

Screen.Recording.2023-07-18.at.2.23.04.PM.mov

Desktop

Screen.Recording.2023-07-18.at.2.19.48.PM.mov

iOS

Screen.Recording.2023-07-18.at.2.25.15.PM.mov

Android

Screen.Recording.2023-07-18.at.2.33.44.PM.mov

allroundexperts · 2023-07-18T09:49:11Z

src/pages/home/report/ReportActionItemMessageEdit.js

-            if (!isFocusedRef.current) {
+            // Skip if this is not the focused message so the other edit composer stays focused.
+            // In small screen devices, when EmojiPicker is show, the current edit message will be lost focus, we need to check this case as well.
+            if (!isFocusedRef.current && !EmojiPickerAction.isActiveReportAction(props.action.reportActionID)) {


Shouldn't this be || instead?

if we go with || it should be !(isFocusedRef.current || EmojiPickerAction.isActiveReportAction(..)) then. So my intention here is would like to cover a case in small screen device, when we edit a message, then open Emoji, the edit composer will be lost focus => With current implement, when we hide the EmojiPicker, the main composer won't be show in small screen devices.

Sorry, I'm not getting the logic. Can you please explain further more clearly?

Alright. With our change according to my proposal, we reveal another bug that I think we should fix it in this PR.

Step to reproduce: on small screen devices:

Login with userA’s account

Create a public room with userA workspace

Copy public room URL

Open other browser and login with userB’s account

Join the room by pasting room URL 

Send a message in room from userB

Click on “Edit comment” message after sent

Open emoji picker

Switch back to UserA's account and delete the message sent by UserB
We can observe that EmojiPicker is hided but the main composer is hide as well.

Screen.Recording.2023-07-18.at.20.42.56.mov

So previously in the componentWillUnmount logic of ReportActionItemMessageEdit:

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

Lines 120 to 129 in 38bc5b3

return () => {

// Skip if this is not the focused message so the other edit composer stays focused

if (!isFocusedRef.current) {

return;

}

// Show the main composer when the focused message is deleted from another client

// to prevent the main composer stays hidden until we swtich to another chat.

ComposerActions.setShouldShowComposeInput(true);

};

We will check

If we're focusing on a Edit message => When it's unmounted due to deleted

If we're out focus on a Edit message => We're already show the main composer => Not need to show main composer anymore.

But with our change, when an Edit message is out focus, it might be there is a EmojiPicker is opening. So when we unmount an Edit message, we should check if there is an EmojiPicker related to the current Edit message is opening, we should show the main composer as well.

Thanks for the explanation. This makes sense!

allroundexperts

LGTM!

src/pages/home/report/ReportActionItemMessageEdit.js

marcaaron · 2023-07-18T21:14:16Z

src/pages/home/report/ReportActionItemMessageEdit.js

@@ -118,16 +119,17 @@ function ReportActionItemMessageEdit(props) {
        });

        return () => {
-            // Skip if this is not the focused message so the other edit composer stays focused
-            if (!isFocusedRef.current) {
+            // Skip if this is not the focused message so the other edit composer stays focused.


I'm sort of confused by this comment. Do we mean something like this?

Suggested change

// Skip if this is not the focused message so the other edit composer stays focused.

// Skip showing the main composer if the context menu is active for this reportAction. We want the "Edit composer" text input stay focused in this case.

Ah nope @marcaaron . I'm not really full understand the first comment as well. But I guess what they mean is if we have multiple Editing messages, and if the current edit message is not focus when unmount => we can skip show main composer to let another editing message still be focused.

Back to our case, I would like to say if the current edit message is not focus by opening its EmojiPicker, we should treat as it's still focus and show main composer (because we are still editing this message)

Co-authored-by: Marc Glasser <marc.aaron.glasser@gmail.com>

OSBotify · 2023-07-20T01:03:50Z

✋ 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-07-21T18:51:09Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.44-0 🚀

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

OSBotify · 2023-07-25T01:25:06Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.44-2 🚀

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

OSBotify · 2023-07-25T01:45:42Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.45-0 🚀

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

OSBotify · 2023-07-26T15:55:13Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.45-7 🚀

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

s77rt · 2023-09-21T14:53:41Z

src/pages/home/report/ReportActionItemMessageEdit.js

-            if (!isFocusedRef.current) {
+            // Skip if this is not the focused message so the other edit composer stays focused.
+            // In small screen devices, when EmojiPicker is shown, the current edit message will lose focus, we need to check this case as well.
+            if (!isFocusedRef.current && !EmojiPickerAction.isActiveReportAction(props.action.reportActionID)) {


This caused a regression (case 3). If we focus on message A, open it's emoji picker and close it, then focus on message B and delete message A then the main composer will show up. This is due to the faulty EmojiPickerAction.isActiveReportAction check as it returns true for message A even though the emoji picker is no longer open.

What we had to do is to clear the active report action accordingly i.e. if we are deleting message A and it's emoji picker is not open then EmojiPickerAction.isActiveReportAction should return false.

alitoshmatov · 2024-01-03T10:50:29Z

src/pages/home/report/ReportActionItemMessageEdit.js

-            if (!isFocusedRef.current) {
+            // Skip if this is not the focused message so the other edit composer stays focused.
+            // In small screen devices, when EmojiPicker is shown, the current edit message will lose focus, we need to check this case as well.
+            if (!isFocusedRef.current && !EmojiPickerAction.isActiveReportAction(props.action.reportActionID)) {


This caused a bug where this condition returns false when composer is not focused but save button is pressed, since onFocus function is synchronous and takes some times to get focus. Thus causing edit input to be still open and main composer not to show: #32218

hoangzinh added 4 commits July 17, 2023 13:33

Fix the emoji picker does not close when editing message is deleted

8e54486

Dont mark as required prop

376aa82

Show chat compose when editing a message and open emoji picker

e0f14cd

Update comment

08f8abf

hoangzinh marked this pull request as ready for review July 17, 2023 13:56

hoangzinh requested a review from a team as a code owner July 17, 2023 13:56

melvin-bot bot requested review from allroundexperts and removed request for a team July 17, 2023 13:56

hoangzinh mentioned this pull request Jul 17, 2023

[HOLD for payment 2023-08-01] [$1000] The emoji picker does not close when UserA deletes the message that UserB is in the process of editing #22214

Closed

6 tasks

allroundexperts reviewed Jul 18, 2023

View reviewed changes

allroundexperts approved these changes Jul 18, 2023

View reviewed changes

melvin-bot bot requested a review from marcaaron July 18, 2023 18:44

marcaaron requested changes Jul 18, 2023

View reviewed changes

Update comment

2906498

Co-authored-by: Marc Glasser <marc.aaron.glasser@gmail.com>

marcaaron self-requested a review July 19, 2023 23:59

marcaaron approved these changes Jul 20, 2023

View reviewed changes

marcaaron merged commit 4a8b431 into Expensify:main Jul 20, 2023
11 checks passed

marcaaron assigned hoangzinh Jul 20, 2023

OSBotify mentioned this pull request Jul 21, 2023

Deploy Checklist: New Expensify 2023-07-21 #23362

Closed

OSBotify mentioned this pull request Jul 25, 2023

Deploy Checklist: New Expensify 2023-07-25 #23522

Closed

s77rt reviewed Sep 21, 2023

View reviewed changes

s77rt mentioned this pull request Sep 21, 2023

[HOLD for payment 2023-09-27] [$2000] Chat - Main composer is displayed when editing two messages #23908

Closed

6 tasks

alitoshmatov reviewed Jan 3, 2024

View reviewed changes

alitoshmatov mentioned this pull request Jan 3, 2024

[HOLD for payment 2023-12-29] [$500] mWeb/Safari - Chat - Compose box disappears while editing a message #32218

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix the emoji picker does not close when editing message is deleted #22984

Fix the emoji picker does not close when editing message is deleted #22984

hoangzinh commented Jul 17, 2023 •

edited

Loading

melvin-bot bot commented Jul 17, 2023

allroundexperts commented Jul 17, 2023 •

edited

Loading

allroundexperts Jul 18, 2023

hoangzinh Jul 18, 2023

allroundexperts Jul 18, 2023

hoangzinh Jul 18, 2023

allroundexperts Jul 18, 2023

allroundexperts left a comment

marcaaron Jul 18, 2023

hoangzinh Jul 18, 2023

OSBotify commented Jul 20, 2023

OSBotify commented Jul 21, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

s77rt Sep 21, 2023

alitoshmatov Jan 3, 2024

	return () => {
	// Skip if this is not the focused message so the other edit composer stays focused
	if (!isFocusedRef.current) {
	return;
	}

	// Show the main composer when the focused message is deleted from another client
	// to prevent the main composer stays hidden until we swtich to another chat.
	ComposerActions.setShouldShowComposeInput(true);
	};

	// Skip if this is not the focused message so the other edit composer stays focused.
	// Skip showing the main composer if the context menu is active for this reportAction. We want the "Edit composer" text input stay focused in this case.

Fix the emoji picker does not close when editing message is deleted #22984

Fix the emoji picker does not close when editing message is deleted #22984

Conversation

hoangzinh commented Jul 17, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 17, 2023

allroundexperts commented Jul 17, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

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

allroundexperts left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Jul 20, 2023

OSBotify commented Jul 21, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hoangzinh commented Jul 17, 2023 •

edited

Loading

allroundexperts commented Jul 17, 2023 •

edited

Loading