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

Feat: Redesign thread ancestry #38722

Merged

Conversation

rayane-djouah
Copy link
Contributor

@rayane-djouah rayane-djouah commented Mar 20, 2024

Details

Fixed Issues

$ #36752
PROPOSAL: #36752 (comment)

Tests

  1. Open a chat report.
  2. Send some messages.
  3. Reply to a message in a new thread.
  4. Add replies to the thread.
  5. Reply to one of the messages in another new thread.
  6. Repeat these steps to create thread ancestry.
  7. Verify that ancestor messages are displayed in the thread separated by a thread divider.
  8. Verify that a blue "thread" link is displayed in each separator line.
  9. Verify that a gray "replies" message is displayed in the final separator.
  10. Verify that the entire message (including the blue thread icon) is clickable to navigate you to the thread.
  11. Verify that clicking on an ancestor message should take you to the thread/room where the message originally appeared, not the thread for the message.
  • Verify that no errors appear in the JS console

Offline tests

Same behavior.

QA Steps

Same as above tests.

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

Screenshots/Videos

Android: Native
Recording.2024-03-21.175621.mp4
Android: mWeb Chrome
Recording.2024-03-21.175621.mp4
iOS: Native

Having issues with my ios simulator

iOS: mWeb Safari

Having issues with my ios simulator

MacOS: Chrome / Safari
Recording.2024-03-21.174141.mp4
MacOS: Desktop
Recording.2024-03-21.175038.mp4

@rayane-djouah
Copy link
Contributor Author

Asked regarding translation https://expensify.slack.com/archives/C01GTK53T8Q/p1711020264783399

@rayane-djouah rayane-djouah marked this pull request as ready for review March 21, 2024 17:46
@rayane-djouah rayane-djouah requested a review from a team as a code owner March 21, 2024 17:46
@melvin-bot melvin-bot bot requested review from paultsimura and removed request for a team March 21, 2024 17:46
Copy link

melvin-bot bot commented Mar 21, 2024

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

@rayane-djouah
Copy link
Contributor Author

ccing @Expensify/design to review the changes

@rayane-djouah
Copy link
Contributor Author

@allroundexperts PR ready for review

@rayane-djouah
Copy link
Contributor Author

@Expensify/design do we need to show a cursor pointer also on the message text ?

Recording.2024-03-21.181514.mp4

@allroundexperts
Copy link
Contributor

allroundexperts commented Mar 21, 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 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-03-27.at.12.35.06.AM.mov
Android: mWeb Chrome
Screen.Recording.2024-03-27.at.12.34.09.AM.mov
iOS: Native
Screen.Recording.2024-03-27.at.12.33.27.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-03-26.at.11.46.32.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-03-26.at.11.42.40.PM.mov
MacOS: Desktop
Screen.Recording.2024-03-26.at.11.44.52.PM.mov

@allroundexperts
Copy link
Contributor

allroundexperts commented Mar 21, 2024

@rayane-djouah Are you sure that we want to show the replies section even when there are no replies?

Screenshot 2024-03-21 at 11 36 56 PM

@allroundexperts
Copy link
Contributor

allroundexperts commented Mar 21, 2024

BUG The thread at the top has in-consistent padding with the rest of threads.

Screenshot 2024-03-22 at 12 01 56 AM

@dannymcclain
Copy link
Contributor

@Expensify/design do we need to show a cursor pointer also on the message text ?

Yeah I'd expect to see the pointer cursor when hovering over any part/all parts of the message.

@dannymcclain
Copy link
Contributor

Are you sure that we want to show the replies section even when there are no replies?

I think we should wait to show the replies section until there is at least one reply, yeah?

@allroundexperts
Copy link
Contributor

I think we should wait to show the replies section until there is at least one reply, yeah?

That would be better in my opinion.

@allroundexperts
Copy link
Contributor

@Expensify/design The chat room subtitle looks wrong to me. Shouldn't it be From [Deleted message] in added [email protected] as a user?

Screenshot 2024-03-22 at 12 12 51 AM

@allroundexperts
Copy link
Contributor

BUG Clicking on the edit composer of the thread message takes you back to the thread parent.

Screen.Recording.2024-03-22.at.12.17.52.AM.mov

@dannymcclain
Copy link
Contributor

@Expensify/design The chat room subtitle looks wrong to me. Shouldn't it be From [Deleted message] in added [email protected] as a user?

No, I believe it is working correctly. When chats happen inside a workspace chat we append in {Workspace name} at the end like so:
CleanShot 2024-03-21 at 14 33 44@2x

But for normal chats, we don't add that to the end. Here's an example of a normal chat:
CleanShot 2024-03-21 at 14 33 27@2x

@dannymcclain
Copy link
Contributor

Generally this is coming along nicely! Looks like we have a few bugs we need to take care of (🙌 @allroundexperts) but generally this is pretty slick.

@dannymcclain dannymcclain self-requested a review March 21, 2024 19:37
@rayane-djouah
Copy link
Contributor Author

BUG Clicking on the edit composer of the thread message takes you back to the thread parent.
Screen.Recording.2024-03-22.at.12.17.52.AM.mov

This is also reproducible on main, should we consider it in scope for this PR?

@rayane-djouah rayane-djouah changed the title Feat: Redesign thread ancestry [HIGH] Feat: Redesign thread ancestry Mar 28, 2024
Copy link
Contributor

@chiragsalian chiragsalian left a comment

Choose a reason for hiding this comment

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

Nice, LGTM

@chiragsalian chiragsalian merged commit 903fe8a into Expensify:main Mar 28, 2024
16 checks passed
@melvin-bot melvin-bot bot added the Emergency label Mar 28, 2024
Copy link

melvin-bot bot commented Mar 28, 2024

@chiragsalian looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@chiragsalian
Copy link
Contributor

Not emergency. im pretty sure all the tests had passed when i merged it. Looks like "Reassure Performance Tests" reran at some point. Either way not an emergency.

@rayane-djouah rayane-djouah deleted the Feat-Redesign-thread-ancestry branch March 28, 2024 18:01
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/chiragsalian in version: 1.4.58-0 🚀

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

mountiny added a commit that referenced this pull request Mar 29, 2024
…read-ancestry"

This reverts commit 903fe8a, reversing
changes made to d6fc25a.
@rayane-djouah rayane-djouah restored the Feat-Redesign-thread-ancestry branch March 31, 2024 23:12
@rayane-djouah rayane-djouah changed the title [HIGH] Feat: Redesign thread ancestry Feat: Redesign thread ancestry Mar 31, 2024
@OSBotify
Copy link
Contributor

OSBotify commented Apr 2, 2024

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.58-8 🚀

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

@brunovjk
Copy link
Contributor

brunovjk commented Sep 4, 2024

I wanted to bring to your attention that the recent issue #47892 was traced back to this PR: https://github.com/Expensify/App/pull/38722/files#diff-39be74c7a910e9671d67b25e28736c789ed518dbfbb2f6e0e57bbca058bb53fd

The root cause was using parentReportID instead of reportID when navigating between reports within threads. This caused the "not found" error when clicking on a chat row within a nested thread.

@rayane-djouah
Copy link
Contributor Author

@brunovjk as you can see in #36752 (comment) we decided that the link should take you to the room/thread where the message originally appeared. I wonder if you've kept this behavior in your solution

@brunovjk
Copy link
Contributor

brunovjk commented Sep 4, 2024

@brunovjk as you can see in #36752 (comment) we decided that the link should take you to the room/thread where the message originally appeared. I wonder if you've kept this behavior in your solution

Good question @rayane-djouah, I will verify.

@brunovjk
Copy link
Contributor

brunovjk commented Sep 5, 2024

@rayane-djouah I did some testing and it seems to me that we are following "clicking on an ancestor message should take you to where the message was originally posted—not the thread of that message."

Screen.Recording.2024-09-05.at.08.53.35.mov

What do you think?

@rayane-djouah
Copy link
Contributor Author

Perfect! Thanks for confirming!

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.

8 participants