Refactor reportAction of context menu #26741

dukenv0307 · 2023-09-05T03:14:56Z

Details

Instead of passing reportAction into ContextMenu, we will pass reportActionID and get reportAction through withOnyx

Fixed Issues

$ #25538
PROPOSAL: #25538 (comment)

Tests

Login with any account
Open the report with any user
On another device, login with this account again
From device 2, send a message to the report
From device 1, open the context menu of the message above
From device 2, edit the message
From device 1, click on copy to clipboard
Verify that the message is copied is the edited message
From both devices, open the context menu of the same message
From device 2, click on reply in thread and send a message
From device 1, click on reply in thread
Verify that no error appears and the thread shows with one message sent

Verify that no errors appear in the JS console

Offline tests

QA Steps

Login with any account
Open the report with any user
On another device, login with this account again
From device 2, send a message to the report
From device 1, open the context menu of the message above
From device 2, edit the message
From device 1, click on copy to clipboard
Verify that the message is copied is the edited message
From both devices, open the context menu of the same message
From device 2, click on reply in thread and send a message
From device 1, click on reply in thread
Verify that no error appears and the thread shows with one message sent

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screencast.from.06-09-2023.23.46.25.webm

Mobile Web - Chrome

Screencast.from.06-09-2023.23.46.25.webm

Mobile Web - Safari

Screen-Recording-2023-09-07-at-09.43.41.mp4

Desktop

Screen.Recording.2023-09-07.at.09.48.22.mov

iOS

Screen-Recording-2023-09-07-at-09.41.32.mp4

Android

25538.mp4

melvin-bot · 2023-09-06T17:33:06Z

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

dukenv0307 · 2023-09-06T17:34:07Z

@jjcoffee Have some problems with WebSocket so I will complete all the screenshots tomorrow.

dukenv0307 · 2023-09-07T02:50:47Z

Updated all screenshots

jjcoffee · 2023-09-07T14:54:27Z

src/pages/home/report/ContextMenu/genericReportActionContextMenuPropTypes.js

+    reportActionID: PropTypes.string.isRequired,
+
+    /** The ID of the current report of this report action is attached to. */
+    originalReportID: PropTypes.string.isRequired,


Just need a bit of clarity on this one. Can you explain (maybe with an example) what you mean when you say in your proposal "The thread first chat originalReportID and reportID is different."?

The thread first chat is the parent report action. When we pass the reportID to BaseContextMenu it is the ID of the thread report. Because now we pass the reportActionID to BaseContextMenu, we also need to pass the originalReportID that is the correct reportID of the reportAction to get the detail of the reportAction in Onyx.

Screencast.from.07-09-2023.22.07.10.webm

As you can see in the video, the first message in the thread is the thread first chat.

Thanks, I think I get what you mean now! Maybe a clearer name would be parentReportID if I understand you correctly?

@jjcoffee Other places in the App also use this name. And if the reportAction isn't the thread first chat reportID and originalReportID will be the same. So I think this name is better.

Ah ignore me, I see that we're using the same naming elsewhere!

jjcoffee · 2023-09-07T14:55:10Z

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-09-08_14.52.10.mp4

Mobile Web - Chrome

android-chrome.mp4

Mobile Web - Safari

ios-safari-2023-09-08_15.28.32.mp4

Desktop

mac-desktop-2023-09-08_15.31.45.mp4

iOS

ios-native-2023-09-08_15.12.34.mp4

Android

android-native.mp4

jjcoffee · 2023-09-07T14:56:12Z

@dukenv0307 Could you explain the additional "copy message" steps you added? Just curious, there's nothing wrong with extra steps!

Verify that the message is copied is the edited message

dukenv0307 · 2023-09-07T14:59:42Z

@jjcoffee The PR also fixed this issue #25539. So I have the step for this.

src/pages/home/report/ContextMenu/genericReportActionContextMenuPropTypes.js

jjcoffee · 2023-09-08T12:38:41Z

src/pages/home/report/ContextMenu/genericReportActionContextMenuPropTypes.js

+    /** The ID of report action this context menu is attached to. */
+    reportActionID: PropTypes.string.isRequired,
+
+    /** The ID of the current report of this report action is attached to. */


Could you reword this comment, it's a bit unclear how it's different from the one for reportID

/** The ID of the report this report action is attached to. */

@jjcoffee Updated.

…nuPropTypes.js Co-authored-by: Joel Davies <[email protected]>

jjcoffee · 2023-09-08T12:42:52Z

The PR also fixed this issue #25539. So I have the step for this.

@dukenv0307 Sorry, completely forgot that there were two linked issues! Could you update the test steps to refer to Open context menu rather than hover, and also clarify that this is not two different users but the same user on two different platforms.

…x/25538

dukenv0307 · 2023-09-08T12:56:03Z

@jjcoffee Updated the step.

jjcoffee

LGTM!

tgolen · 2023-09-08T20:37:28Z

src/components/ShowContextMenuContext.js

@@ -32,7 +32,8 @@ function showContextMenuForReport(event, anchor, reportID, action, checkIfContex
        '',
        anchor,
        reportID,
-        action,
+        action.reportActionID,
+        reportID,


Is it necessary to pass reportID twice? I see it a couple lines above too.

Oh, I see that maybe it is OK as in another place you are passing originalReportID here. Could you maybe add code comments to each place to explain why it's different (or the same) as reportID?

You're right, we also need to get originalReportID here.

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.js

tgolen · 2023-09-08T20:39:31Z

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.js

+        },
+    }),
+)(
+    memo(BaseReportActionContextMenu, (prevProps, nextProps) => {


Can you please add code comments to explain why this memo is here and what it's purpose is?

Co-authored-by: Tim Golen <[email protected]>

dukenv0307 · 2023-09-09T02:52:53Z

@tgolen Just updated all suggestions.

jjcoffee · 2023-09-11T08:36:59Z

@dukenv0307 Can you merge main and retest (see here on Slack)?

dukenv0307 · 2023-09-11T08:43:59Z

@jjcoffee Merged main and tested.

tgolen · 2023-09-11T15:17:56Z

Removing HOLD and merging this

OSBotify · 2023-09-11T15:23:57Z

✋ 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-09-12T00:16:55Z

🚀 Deployed to staging by https://github.com/tgolen in version: 1.3.68-0 🚀

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

hungvu193 · 2023-09-12T11:08:05Z

src/pages/home/report/ContextMenu/BaseReportActionContextMenu.js

+    withWindowDimensions,
+    withOnyx({
+        reportActions: {
+            key: ({originalReportID}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${originalReportID}`,


with thread report, this will lead to empty reportAction because it always get the reportActions of the parent.
Slack report: https://expensify.slack.com/archives/C049HHMV9SM/p1694515263690629

cc @dukenv0307 @tgolen @jjcoffee

@hungvu193 Because the structure of the complete task is wrong. This is stored in the task report but the field means this is the parent report action #24644

OSBotify · 2023-09-13T08:43:22Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.68-17 🚀

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

c3024 · 2024-07-03T05:01:45Z

src/pages/home/report/ReportActionItem.js

-                            isArchivedRoom={ReportUtils.isArchivedRoom(originalReport)}
+                            reportActionID={props.action.reportActionID}
+                            originalReportID={originalReportID}
+                            isArchivedRoom={ReportUtils.isArchivedRoom(props.report)}


@dukenv0307

We are using report to check isArchivedRoom here in the MiniReportActionContextMenu but originalReport/originalReportID to check isArchivedRoom in ReportActionContextMenu.showContextMenu. Was this a mistake or was there some logic in this?

dukenv0307 added 2 commits September 5, 2023 10:23

update reportAction for context menu

5005161

merge main

068cc42

dukenv0307 force-pushed the fix/25538 branch from ce78838 to 068cc42 Compare September 5, 2023 03:24

dukenv0307 added 5 commits September 5, 2023 10:34

use lodashGet

2c3260a

update for thread first chat

037ce5f

Merge branch 'main' into fix/25538

c30867c

Merge branch 'main' into fix/25538

4fa87ac

refactor logic for original reportID

017c714

dukenv0307 marked this pull request as ready for review September 6, 2023 17:33

dukenv0307 requested a review from a team as a code owner September 6, 2023 17:33

melvin-bot bot requested review from jjcoffee and removed request for a team September 6, 2023 17:33

jjcoffee reviewed Sep 7, 2023

View reviewed changes

jjcoffee reviewed Sep 8, 2023

View reviewed changes

src/pages/home/report/ContextMenu/genericReportActionContextMenuPropTypes.js Outdated Show resolved Hide resolved

jjcoffee reviewed Sep 8, 2023

View reviewed changes

Update src/pages/home/report/ContextMenu/genericReportActionContextMe…

88eaa80

…nuPropTypes.js Co-authored-by: Joel Davies <[email protected]>

dukenv0307 added 3 commits September 8, 2023 19:48

edit the comment

14c6745

Merge branch 'fix/25538' of https://github.com/dukenv0307/App into fi…

985c5c2

…x/25538

Merge branch 'main' into fix/25538

05eae4e

jjcoffee approved these changes Sep 8, 2023

View reviewed changes

melvin-bot bot requested a review from tgolen September 8, 2023 13:46

tgolen changed the title ~~Refactor reportAction of context menu~~ [HOLD Feature-freeze] Refactor reportAction of context menu Sep 8, 2023

tgolen requested changes Sep 8, 2023

View reviewed changes

dukenv0307 and others added 2 commits September 9, 2023 09:40

Update src/pages/home/report/ContextMenu/BaseReportActionContextMenu.js

ed1a7ec

Co-authored-by: Tim Golen <[email protected]>

fix bug when calling show context menu for report

50120ef

Merge branch 'main' into fix/25538

88bd1b6

tgolen approved these changes Sep 11, 2023

View reviewed changes

tgolen changed the title ~~[HOLD Feature-freeze] Refactor reportAction of context menu~~ Refactor reportAction of context menu Sep 11, 2023

tgolen merged commit 0ca3dcb into Expensify:main Sep 11, 2023

OSBotify mentioned this pull request Sep 12, 2023

Deploy Checklist: New Expensify 2023-09-12 #27210

Closed

hungvu193 reviewed Sep 12, 2023

View reviewed changes

Pluto0104 mentioned this pull request Sep 12, 2023

[$500] [HOLD for payment 2023-09-21] [HOLD for payment 2023-09-20] mWeb-LHN- Site crashes while interacting with Pinned and mark as unread menu options #27238

Closed

6 tasks

melvin-bot bot mentioned this pull request Sep 13, 2023

[HOLD for payment 2023-09-20] [$1000] Chat - Shows error “OpenReport returned error” when click Reply in new thread #25538

Closed

6 tasks

dummy-1111 mentioned this pull request Sep 14, 2023

fix: issue 23908 #27190

Merged

59 tasks

tienifr mentioned this pull request Sep 27, 2023

[$500] Task - Unable to copy task complete/reopen message #27884

Closed

6 tasks

c3024 reviewed Jul 3, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor reportAction of context menu #26741

Refactor reportAction of context menu #26741

dukenv0307 commented Sep 5, 2023 •

edited

Loading

melvin-bot bot commented Sep 6, 2023

dukenv0307 commented Sep 6, 2023 •

edited

Loading

dukenv0307 commented Sep 7, 2023

jjcoffee Sep 7, 2023

dukenv0307 Sep 7, 2023

dukenv0307 Sep 7, 2023

jjcoffee Sep 8, 2023

dukenv0307 Sep 8, 2023

jjcoffee Sep 8, 2023

jjcoffee commented Sep 7, 2023 •

edited

Loading

jjcoffee commented Sep 7, 2023

dukenv0307 commented Sep 7, 2023

jjcoffee Sep 8, 2023

dukenv0307 Sep 8, 2023

jjcoffee commented Sep 8, 2023 •

edited

Loading

dukenv0307 commented Sep 8, 2023

jjcoffee left a comment

tgolen Sep 8, 2023

tgolen Sep 8, 2023

dukenv0307 Sep 9, 2023

tgolen Sep 8, 2023

dukenv0307 commented Sep 9, 2023

jjcoffee commented Sep 11, 2023

dukenv0307 commented Sep 11, 2023

tgolen commented Sep 11, 2023

OSBotify commented Sep 11, 2023

OSBotify commented Sep 12, 2023

hungvu193 Sep 12, 2023 •

edited

Loading

dukenv0307 Sep 12, 2023

OSBotify commented Sep 13, 2023

c3024 Jul 3, 2024

Refactor reportAction of context menu #26741

Refactor reportAction of context menu #26741

Conversation

dukenv0307 commented Sep 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 6, 2023

dukenv0307 commented Sep 6, 2023 • edited Loading

dukenv0307 commented Sep 7, 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

jjcoffee commented Sep 7, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

jjcoffee commented Sep 7, 2023

dukenv0307 commented Sep 7, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjcoffee commented Sep 8, 2023 • edited Loading

dukenv0307 commented Sep 8, 2023

jjcoffee left a 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

dukenv0307 commented Sep 9, 2023

jjcoffee commented Sep 11, 2023

dukenv0307 commented Sep 11, 2023

tgolen commented Sep 11, 2023

OSBotify commented Sep 11, 2023

OSBotify commented Sep 12, 2023

hungvu193 Sep 12, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Sep 13, 2023

Choose a reason for hiding this comment

dukenv0307 commented Sep 5, 2023 •

edited

Loading

dukenv0307 commented Sep 6, 2023 •

edited

Loading

jjcoffee commented Sep 7, 2023 •

edited

Loading

jjcoffee commented Sep 8, 2023 •

edited

Loading

hungvu193 Sep 12, 2023 •

edited

Loading