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

Implement get all ancestor of the thread #34640

Merged
merged 21 commits into from
Feb 2, 2024
Merged

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Jan 17, 2024

Details

Implement get all ancestor of the thread

Fixed Issues

$ #32618
PROPOSAL: #32618 (comment)

Tests

  1. Open any report
  2. Send a message
  3. Reply in the thread of this message
  4. Report steps 2-3 serval times
  5. Verify that in each thread, all ancestors of this thread are displayed
  6. Click on any ancestor action, and verify that we go to the current thread of this action
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

  1. Open any report
  2. Send a message
  3. Reply in the thread of this message
  4. Report steps 2-3 serval times
  5. Verify that in each thread, all ancestors of this thread are displayed
  6. Click on any ancestor action, and verify that we go to the current thread of this action
  7. Test these step above with an account that has many reports and report actions.
  8. Verify that all ancestor actions are displayed as well.
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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
      • 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 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 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 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-01-17.at.17.57.44.mov
Android: mWeb Chrome
Screen.Recording.2024-01-17.at.17.53.57.mov
iOS: Native
iOS: mWeb Safari
Screen.Recording.2024-01-17.at.17.47.08.mov
MacOS: Chrome / Safari
Screen.Recording.2024-01-17.at.17.45.02.mov
MacOS: Desktop
Screen.Recording.2024-01-17.at.18.07.28.mov

@dukenv0307 dukenv0307 marked this pull request as ready for review January 17, 2024 11:08
@dukenv0307 dukenv0307 requested a review from a team as a code owner January 17, 2024 11:08
@melvin-bot melvin-bot bot requested review from mollfpr and removed request for a team January 17, 2024 11:09
Copy link

melvin-bot bot commented Jan 17, 2024

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

@mollfpr
Copy link
Contributor

mollfpr commented Jan 19, 2024

  1. I can't mark unread the parent ancestor on a one-level thread
Screen.Recording.2024-01-19.at.23.11.34.mp4
  1. The marker position seems wrong. The marker should be on the top of the report action.
Screen.Recording.2024-01-19.at.23.14.07.mp4

canEvict: false,
allReports: {
key: ONYXKEYS.COLLECTION.REPORT,
selector: reportSelector,
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need to make a selection here even though the props are not used?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mollfpr The reason to make a selection here is to decrease re-render of this component. We have another solution which is to use memo to only compare the ancestors. What do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think using memo will be ideal. We already use it for several components, which fits what we are trying to do here.

@dukenv0307
Copy link
Contributor Author

I can't mark unread the parent ancestor on a one-level thread
The marker position seems wrong. The marker should be on the top of the report action.

Fixed these cases.

@mollfpr
Copy link
Contributor

mollfpr commented Jan 24, 2024

@dukenv0307 Friendly bump on to update using memo and also fixed the conflicts. Thanks!

@dukenv0307
Copy link
Contributor Author

Thanks I will update in the early morning tomorrow.

@dukenv0307
Copy link
Contributor Author

@mollfpr I updated. Please help to review again.

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

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

Mark unread the ancestor is randomly mark unread the message in other reports.

Screen.Recording.2024-01-25.at.23.58.27.mp4

@dukenv0307
Copy link
Contributor Author

Mark unread the ancestor is randomly mark unread the message in other reports.

@mollfpr As I see the mark as unread work correct. when we mark as unread an ancestor, the current report of this action will be marked as unread in LHN. Correct me if I missed something.

@mollfpr
Copy link
Contributor

mollfpr commented Jan 26, 2024

@dukenv0307 You're right! My bad; I should have paid more attention to which parent action and the report. I'll finish the testing and recording then!

@mollfpr
Copy link
Contributor

mollfpr commented Jan 26, 2024

@dukenv0307 Could you check the failing performance test?

@dukenv0307
Copy link
Contributor Author

@mollfpr Passed test after merge newest main

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

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

Almost looks good. One more things to clean up the warning.

onClose={() => Report.navigateToConciergeChatAndDeleteReport(ancestor.report.reportID)}
>
<ReportActionItem
key={ancestor.reportAction.reportActionID}
Copy link
Contributor

Choose a reason for hiding this comment

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

It's still showing the warning. We might move it to the above component to clear the warning.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mollfpr I updated.

@mollfpr
Copy link
Contributor

mollfpr commented Jan 29, 2024

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.

Screenshots/Videos

Android: Native
34640.Android.mp4
Android: mWeb Chrome
34640.mWeb-Chrome.mp4
iOS: Native
34640.iOS.mov
iOS: mWeb Safari
34640.mWeb-Safari.mov
MacOS: Chrome / Safari
34640.Web.mp4
MacOS: Desktop
34640.Desktop.mp4

@marcaaron
Copy link
Contributor

Thanks for the changes @dukenv0307. Went through and resolved a bunch of comments. I believe most of my remaining comments are minor. But we're still failing the "Reassure Performance Tests". I'll try to re-run them now.

marcaaron
marcaaron previously approved these changes Feb 1, 2024
@marcaaron
Copy link
Contributor

@dukenv0307 We need to merge main here to fix the failing Reassure Performance Tests / perf-tests action.

@dukenv0307
Copy link
Contributor Author

@marcaaron Merged main and the test is passed now.

Co-authored-by: Luthfi <luthfi.ufi14@gmail.com>
Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

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

Updated test recordings

It feels a bit slow on the Android when navigating through the thread, but it also does the same when I run on the main.

Screenshots/Videos

Android: Native
34640.Android.mov
Android: mWeb Chrome
34640.mWeb-Chrome.mov
iOS: Native
34640.iOS.mov
iOS: mWeb Safari
34640.mWeb-Safari.mov
MacOS: Chrome / Safari
34640.Web.mp4
MacOS: Desktop
34640.Desktop.mp4

@melvin-bot melvin-bot bot requested a review from marcaaron February 2, 2024 09:08
Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

Thanks for the changes and your fast work here!

@marcaaron marcaaron merged commit 3a610af into Expensify:main Feb 2, 2024
18 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Feb 2, 2024

✋ 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

OSBotify commented Feb 5, 2024

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 1.4.36-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Feb 5, 2024

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 1.4.36-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@lanitochka17
Copy link

This PR is failing because of issue #35914

The issue is reproducible in: Android, IOS

Bug6369468_1707233930280.Stpc4893.1.mp4

@Julesssss
Copy link
Contributor

Julesssss commented Feb 7, 2024

This PR is failing because of issue #35914

Just noting that the linked issue was demoted from being a blocker, so I'm not going to hold the release on this

@OSBotify
Copy link
Contributor

OSBotify commented Feb 7, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.37-7 🚀

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

Comment on lines +48 to +53
onyxSubscribe({
key: `${ONYXKEYS.COLLECTION.REPORT}${ancestorReportID}`,
callback: () => {
setAllAncestors(ReportUtils.getAllAncestorReportActions(report, shouldHideThreadDividerLine));
},
}),
Copy link
Contributor

Choose a reason for hiding this comment

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

This does not follow our Onyx practices. Components should use withOnyx and not Onyx.connect

Copy link
Contributor

Choose a reason for hiding this comment

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

Could possibly have been a performance optimization? If we can explore getting rid of it that would be 👍

Copy link
Contributor

Choose a reason for hiding this comment

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

Components should use withOnyx and not Onyx.connect

Or useOnyx is a good option too now.

@@ -4663,6 +4675,78 @@ function shouldDisableThread(reportAction: OnyxEntry<ReportAction>, reportID: st
);
}

function getAllAncestorReportActions(report: Report | null | undefined, shouldHideThreadDividerLine: boolean): Ancestor[] {
Copy link
Member

Choose a reason for hiding this comment

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

This PR caused an issue - #41519

Detailed root cause here - #41519 (comment)

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.

9 participants