Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Unmatched parent report ID and report action ID #20574

Merged

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Jun 12, 2023

Details

When we call any API for thread's first message, we're sending the reportID of the thread (child) report, but together with the reportActionID of the parent report; while this reportActionID does not exist in the child report. This makes most of the APIs failed. This PR fixes that issue.

Fixed Issues

$ #19363
$ #19348
$ #19352
$ #19901
$ #20390
$ #20907
$ #21598
PROPOSAL: #19363 (comment), #19363 (comment)

Tests

  1. Login with any account
  2. Go to any chat
  3. Reply your message in thread
  4. Toggle report action context menu by hovering over the thread's first message (A)
    ======
  5. Verify that the Reply in thread option is not available in A's context menu but available in the parent message's (B)
    ======
  6. Add/remove any reaction to A
  7. Verify that the reactions apply to both A and B
    ======
  8. Copy link A
  9. Verify that the copied link has correct report ID, i.e. /r/A_reportID/actionID for A and /r/B_reportID/actionID for B
    ======
  10. Mark as unread A
  11. Verify that A is marked as unread but not B
    ======
  12. Edit comment A
  13. Verify that the edited content also applies to B
    ======
  14. Delete comment A
  15. Verify that B is also deleted
    ======
  16. Reply the other account's message in thread
  17. Flag as offensive A
  18. Verify that B is also flagged

Repeat step 6-18 with B message.

  • Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

  1. Login with any account
  2. Go to any chat
  3. Reply your message in thread
  4. Toggle report action context menu by hovering over the thread's first message (A)
    ======
  5. Verify that the Reply in thread option is not available in A's context menu but available in the parent message's (B)
    ======
  6. Add/remove any reaction to A
  7. Verify that the reactions apply to both A and B
    ======
  8. Copy link A
  9. Verify that the copied link has correct report ID, i.e. /r/A_reportID/actionID for A and /r/B_reportID/actionID for B
    ======
  10. Mark as unread A
  11. Verify that A is marked as unread but not B
    ======
  12. Edit comment A
  13. Verify that the edited content also applies to B
    ======
  14. Delete comment A
  15. Verify that B is also deleted
    ======
  16. Reply the other account's message in thread
  17. Flag as offensive A
  18. Verify that B is also flagged

Repeat step 6-18 with B message.

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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 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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 correct English and 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screencast.from.12-06-2023.17.35.29.webm
Mobile Web - Chrome
video-20230613-160657-edit_2vcfrcj9.mp4
Screenrecording_20230613_161506.mp4
Mobile Web - Safari
6763031456571314782_RmJkiXgb.mp4
Desktop
screen-recording-2023-06-14-at-010657_3FXUvD8O.mp4
iOS
screen-recording-2023-06-14-at-011947_nvc0z2aL.mp4
Android

@tienifr tienifr changed the title fix: unmatched parent report id and report action id Fix: Unmatched parent report ID and report action ID Jun 12, 2023
@tienifr tienifr marked this pull request as ready for review June 14, 2023 03:45
@tienifr tienifr requested a review from a team as a code owner June 14, 2023 03:45
@melvin-bot melvin-bot bot requested review from aimane-chnaif and cristipaval and removed request for a team June 14, 2023 03:45
@melvin-bot
Copy link

melvin-bot bot commented Jun 14, 2023

@cristipaval @aimane-chnaif One of you needs to 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

This comment was marked as outdated.

src/libs/Navigation/Navigation.js Outdated Show resolved Hide resolved
src/libs/ReportUtils.js Outdated Show resolved Hide resolved
@aimane-chnaif
Copy link
Contributor

I don't think getTopmostReportId approach will work. After navigation refactor, we allow multiple report screens open on mobile devices.
So when we open thread report from parent report, parent report gets wrong reportId, though the screen is hidden by thread report.

Here's example:

Screen.Recording.2023-06-14.at.5.44.02.AM.mov

@aimane-chnaif
Copy link
Contributor

Let's still pass reportID as before and don't change navigation related code if it's not related to this PR.

@aimane-chnaif
Copy link
Contributor

@tienifr please let me know when ready for review again

@tienifr
Copy link
Contributor Author

tienifr commented Jun 14, 2023

@aimane-chnaif Did you test on my branch? I cannot reproduce the bug you mentioned. Actually I've added the currentReportId (which is returned by getTopMostReportId) as a memo dependency of the ReportActionItem component. So whenever currentReportId changes, the action item'll get rerendered.

@aimane-chnaif
Copy link
Contributor

aimane-chnaif commented Jun 14, 2023

@tienifr yes, I tested your branch. And pulled main locally. This is reproducible only on mobile.
I think you don't get what the bug is yet.
Here's clear reproducible video:

Screen.Recording.2023-06-14.at.1.04.40.PM.mov

@tienifr
Copy link
Contributor Author

tienifr commented Jun 15, 2023

@aimane-chnaif Please take a look. Basically isParentReport tells whether the report action comes with the parent report, since it's normally passed with the current report.

@tienifr
Copy link
Contributor Author

tienifr commented Jun 19, 2023

Bump @aimane-chnaif

Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is very buggy at the moment. Not able to continue testing

src/pages/home/report/ContextMenu/ContextMenuActions.js Outdated Show resolved Hide resolved
src/pages/home/report/ReportActionItem.js Outdated Show resolved Hide resolved
@@ -37,6 +38,7 @@ function showContextMenuForReport(event, anchor, reportID, action, checkIfContex
checkIfContextMenuActive,
checkIfContextMenuActive,
isArchivedRoom,
isParentReport,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this param passed anywhere? showContextMenuForReport is called from various places.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i.e. In BasePreRenderer onLongPress event, isParentReport is not passed at all.

Screen.Recording.2023-06-21.at.6.58.34.PM.mov

I started concerning about this approach of passing isParentReport

                {parentReportAction && (
                    <ReportActionItem
                        isParentReport
                        report={props.parentReport}

@tienifr
Copy link
Contributor Author

tienifr commented Jun 23, 2023

About the draft status mentioned here: #19363 (comment). If we proceed with the latest changes, we can agree upon the initial behavior:

edit A and don't save -> A is drafted but B doesn't follow A status so not drafted
edit B and don't save -> B is drafted but A doesn't follow B status so not drafted

@aimane-chnaif
Copy link
Contributor

The latest code looks much simpler and less possible regressions.
@cristipaval do you agree with the approach we finally landed on?

@cristipaval
Copy link
Contributor

The latest code looks much simpler and less possible regressions. @cristipaval do you agree with the approach we finally landed on?

Yes, and I also like that we are consistent with the way that editing works

Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good. Will test shortly

src/libs/ReportUtils.js Outdated Show resolved Hide resolved
@aimane-chnaif
Copy link
Contributor

After deleting message, context menu is not synced until page refresh.
This is known bug - #21103 and out of scope for this PR.

Screen.Recording.2023-06-23.at.12.04.45.PM.mov

@aimane-chnaif
Copy link
Contributor

I don't think this is bug or at least won't be handled in this PR.
Whisper message for flagging shows only on parent chat

desktop-moderation.mov

@tienifr
Copy link
Contributor Author

tienifr commented Jun 23, 2023

Do you want the whisper message to appear in thread report as well? Do we need to handle that in this PR?

@aimane-chnaif
Copy link
Contributor

When delete message which already has reactions, reactions are cleared at first but after refresh, appears again.
This already happens on production so I also think out of scope.

android-reactions.mov

@aimane-chnaif
Copy link
Contributor

Do you want the whisper message to appear in thread report as well? Do we need to handle that in this PR?

@cristipaval what do you think?

@aimane-chnaif
Copy link
Contributor

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
reaction-edit-unread-link.mov
web-delete.mov
Mobile Web - Chrome
mchrome.mov
Mobile Web - Safari
msafari-delete.mov
Desktop
desktop-moderation.mov
iOS
ios-delete.mov
Android
android-reactions.mov

Copy link
Contributor

@aimane-chnaif aimane-chnaif left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issues found while testing:

#20574 (comment)
#20574 (comment)
#20574 (comment)

I suggest to consider these out of scope. Please comment If you disagree.
Otherwise looks good.
cc: @cristipaval

@tienifr
Copy link
Contributor Author

tienifr commented Jun 26, 2023

Bump @cristipaval

@cristipaval cristipaval merged commit 4ba4d5d into Expensify:main Jun 26, 2023
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.33-0 🚀

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

@aimane-chnaif
Copy link
Contributor

$ https://github.com/Expensify/App/issues/19363, https://github.com/Expensify/App/issues/21598

@tienifr this will break automation

Please update like this:

$ https://github.com/Expensify/App/issues/19348
$ https://github.com/Expensify/App/issues/19352
$ https://github.com/Expensify/App/issues/19901
$ https://github.com/Expensify/App/issues/20390
$ https://github.com/Expensify/App/issues/20907
$ https://github.com/Expensify/App/issues/21598

@tienifr
Copy link
Contributor Author

tienifr commented Jun 27, 2023

Thanks!

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.33-4 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants