Fix message highlight stuck when open the 2nd context menu #47993

bernhardoj · 2024-08-26T11:27:28Z

Details

When we open the 2nd context menu while the 1st one is shown, the highlight becomes stuck.

Fixed Issues

$ #45524
PROPOSAL: #45524 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Web/Desktop

Open any chat that has multiple messages (or send multiple messages on the chat)
Right-click on one message
While the first context menu is open, right-click on another message
Repeat it multiple times
Verify the highlight of the message disappears once the context menu of the message is hidden
Close the context menu
Right-click on a message
Verify the context menu is shown and the message is highlighted

Android/iOS/mWeb

Open any chat that has multiple messages (or send multiple messages on the chat)
Long-press on a message
Close the context menu
Verify the highlight is gone

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android.mweb.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios.mweb.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

…6-fix/45524-message-highlight-is-stukck"

melvin-bot · 2024-08-26T11:27:33Z

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

hungvu193 · 2024-08-27T08:03:37Z

Oh I can now reproduce, try to open and close keyboard and long press on a expense @bernhardoj

Screen.Recording.2024-08-27.at.15.02.53.mov

bernhardoj · 2024-08-27T09:03:45Z

Ah, finally I can reproduce it. No need to open and close the keyboard. The context menu won't show on a component that has a long press to trigger the context menu, another example is image.

App/src/components/HTMLEngineProvider/HTMLRenderers/ImageRenderer.tsx

Lines 98 to 100 in d5cfecf

    
           onLongPress={(event) => 
        
               showContextMenuForReport(event, anchor, report?.reportID ?? '-1', action, checkIfContextMenuActive, ReportUtils.isArchivedRoom(report, reportNameValuePairs)) 
        
           }

In mWeb, long pressing the Image will trigger ReportActionContextMenu.showContextMenu twice. One from the image component and the other one from ReportActionItem. (#12987 adds the second call of showContextMenu because in native, if there is a nested pressable, the parent won't receive the long press)

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

Lines 347 to 365 in d5cfecf

    
           ReportActionContextMenu.showContextMenu( 
        
               CONST.CONTEXT_MENU_TYPES.REPORT_ACTION, 
        
               event, 
        
               selection, 
        
               popoverAnchorRef.current, 
        
               report.reportID, 
        
               action.reportActionID, 
        
               originalReportID, 
        
               draftMessage ?? '', 
        
               () => setIsContextMenuActive(true), 
        
               toggleContextMenuFromActiveReportAction, 
        
               isArchivedRoom, 
        
               isChronosReport, 
        
               false, 
        
               false, 
        
               disabledActions, 
        
               false, 
        
               setIsEmojiPickerActive as () => void, 
        
           );

The first call sets the instance ID but the modal isn't show yet and the 2nd call try to hide it, but because it's never shown, the hide callback isn't called.

App/src/pages/home/report/ContextMenu/ReportActionContextMenu.ts

Lines 128 to 133 in d5cfecf

    
           if (contextMenuRef.current.instanceID) { 
        
               hideContextMenu(); 
        
               contextMenuRef.current.runAndResetOnPopoverHide(); 
        
           } 
        
           contextMenuRef.current.showContextMenu(

I fixed it by make sure the setInstanceID is called within the same block of setting the visibility state of the popover, so we can make sure the instance ID is set when the popover is visible.

hungvu193 · 2024-08-27T09:32:52Z

I think I still can reproduce after a few long press:

Screen.Recording.2024-08-27.at.16.32.00.mov

bernhardoj · 2024-08-27T10:18:09Z

Pushed a new fix. Please check again.

hungvu193 · 2024-08-27T10:37:01Z

Nice! it's working

hungvu193 · 2024-08-27T10:38:08Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.

Screenshots/Videos

Android: Native

Screen.Recording.2024-08-16.at.13.36.07.mov

Android: mWeb Chrome

Screen.Recording.2024-08-27.at.17.36.40.mov

Screen.Recording.2024-08-16.at.13.32.54.mov

iOS: Native

Screen.Recording.2024-08-16.at.13.06.17.mov

iOS: mWeb Safari

Screen.Recording.2024-08-16.at.13.23.35.mov

MacOS: Chrome / Safari

Chrome.mov

MacOS: Desktop

Screen.Recording.2024-08-16.at.10.53.00.mov

hungvu193

Tests well!

OSBotify · 2024-08-27T17:05:34Z

✋ 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-08-28T21:46:04Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.0.26-1 🚀

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

OSBotify · 2024-08-30T18:34:31Z

🚀 Deployed to production by https://github.com/puneetlath in version: 9.0.26-6 🚀

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

Revert "Merge pull request Expensify#47718 from Expensify/revert-4748…

fe67541

…6-fix/45524-message-highlight-is-stukck"

bernhardoj requested a review from a team as a code owner August 26, 2024 11:27

melvin-bot bot requested a review from hungvu193 August 26, 2024 11:27

melvin-bot bot removed the request for review from a team August 26, 2024 11:27

bernhardoj added 2 commits August 27, 2024 16:29

Merge branch 'main' into fix/45524-message-highlight-is-stukck

cbda006

set the instance ID when the modal is visible

3570e9e

set the instance id when the modal show

3be4772

hungvu193 approved these changes Aug 27, 2024

View reviewed changes

melvin-bot bot requested a review from roryabraham August 27, 2024 10:38

roryabraham changed the title ~~#2 - Fix message highlight stuck when open the 2nd context menu~~ Fix message highlight stuck when open the 2nd context menu Aug 27, 2024

roryabraham approved these changes Aug 27, 2024

View reviewed changes

roryabraham merged commit 9fbed40 into Expensify:main Aug 27, 2024
17 checks passed

github-actions bot mentioned this pull request Aug 28, 2024

Deploy Checklist: New Expensify 2024-08-28 #48221

Closed

93 tasks

tsa321 mentioned this pull request Aug 29, 2024

[$250] iOS - Track expense - App crashes after deleting expense offline #48197

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix message highlight stuck when open the 2nd context menu #47993

Fix message highlight stuck when open the 2nd context menu #47993

bernhardoj commented Aug 26, 2024

melvin-bot bot commented Aug 26, 2024

hungvu193 commented Aug 27, 2024

bernhardoj commented Aug 27, 2024

hungvu193 commented Aug 27, 2024

bernhardoj commented Aug 27, 2024

hungvu193 commented Aug 27, 2024

hungvu193 commented Aug 27, 2024

hungvu193 left a comment

OSBotify commented Aug 27, 2024

OSBotify commented Aug 28, 2024

OSBotify commented Aug 30, 2024

Fix message highlight stuck when open the 2nd context menu #47993

Fix message highlight stuck when open the 2nd context menu #47993

Conversation

bernhardoj commented Aug 26, 2024

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 26, 2024

hungvu193 commented Aug 27, 2024

bernhardoj commented Aug 27, 2024

hungvu193 commented Aug 27, 2024

bernhardoj commented Aug 27, 2024

hungvu193 commented Aug 27, 2024

hungvu193 commented Aug 27, 2024

Reviewer Checklist

Screenshots/Videos

hungvu193 left a comment

Choose a reason for hiding this comment

OSBotify commented Aug 27, 2024

OSBotify commented Aug 28, 2024

OSBotify commented Aug 30, 2024