Fix unread marker disappearing when the report action is deleted

[arosiclair]

Details

Simplifies unread marker logic and fixes the marker disappearing when someone else in the chat deletes the report action below the unread marker.

• Tracking the timestamp for the unread marker in unreadMarkerTime
• The report action for the unread marker is calculated as unreadMarkerReportActionID
  • This recalculates whenever the unreadMarkerTime or report actions change

Fixed Issues

$ #41935

Tests

Actively reading new messages

1. Log in as user A and B
2. [user A] open the chat with user B
3. [user B] send 2 messages to user A
4. [user A] verify an unread marker does NOT display

Viewing the chat above the new messages threshold

5. Add enough messages in user A and B's chat to fill the screen
6. [user A] scroll up a few messages
7. [user B] send another message to user A
8. [user A] verify "new messages" message pops up
9. [user A] scroll down and verify the unread marker displays above the new message

Receiving new messages while viewing another chat

10. [user A] switch to the concierge chat
11. [user B] send 2 more messages to user A
12. [user A] Verify the messages are received and the chat is marked unread
13. [user A] open the chat and verify
    • an unread marker displays above the new messages
    • the chat is marked read in the LHN

Unread marker still shows after deleting the message below it

14. [user B] delete the message below the marker
15. [user A] Verify the message is deleted and the unread marker displays above the next message

Offline tests

QA Steps

Same as Tests

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[arosiclair]

There are some issues with marking the report as read

1. Open a chat
2. Scroll to bottom
3. Received 2 messages
4. Verified they appear read
5. Scroll up
6. Received 2 more messages
7. Verified they are marked as unread
8. Switch chats
9. Switch back to the original chat
10. Report is NOT marked read

[arosiclair]

Alright I've fixed the last issue I mentioned. This is testing pretty well however a jest test is failing:

  ● Unread Indicators › Shows a browser notification and bold text when a new message arrives for a chat that is read

    expect(received).toBe(expected) // Object.is equality

    Expected: undefined
    Received: "400"

      368 |                 const displayNameTexts = screen.queryAllByLabelText(hintText);
      369 |                 expect(displayNameTexts).toHaveLength(2);
    > 370 |                 expect((displayNameTexts[0]?.props?.style as TextStyle)?.fontWeight).toBe(undefined);

This scenario (opening an unread chat and the report being marked read in the LHN) is working correctly in my testing so I think we just need to update/rewrite this test

[melvin-bot]

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

[arosiclair]

@allroundexperts can you review and test? If everything looks good on your end, I'll go ahead and rewrite the jest test to get it fixed since it doesn't seem to be accurate anymore.

Please be thorough with your test too. Let's try to get this one through without any regressions 🙏

[allroundexperts]

Hi @arosiclair!
I won't be able to review this soon. I have asked for help in the channel.

[allroundexperts]

@ikevin127 will take this one over.

[ikevin127]

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

1. Actively reading new messages

android.mov

2. Viewing the chat above the new messages threshold

android.mov

3. Receiving new messages while viewing another chat

android.mov

4. Unread marker still shows after deleting the message below it

android.mov

Android: mWeb Chrome

⚠️ I could not test on on Android: mWeb after all the tests because I was getting 429 Too Many requests. All platforms pass the tests so this shouldn't be an issue since it has the same parameters and behaviour as all other web-based platforms.

iOS: Native

1. Actively reading new messages

ios.mov

2. Viewing the chat above the new messages threshold

ios.mov

3. Receiving new messages while viewing another chat

ios.mov

4. Unread marker still shows after deleting the message below it

ios.mov

iOS: mWeb Safari

1. Actively reading new messages

ios-mweb.mov

2. Viewing the chat above the new messages threshold

ios-mweb.mov

3. Receiving new messages while viewing another chat

ios-mweb.mov

4. Unread marker still shows after deleting the message below it

ios-mweb.mov

MacOS: Chrome / Safari

1. Actively reading new messages

web-1.mov

2. Viewing the chat above the new messages threshold

web-2.mov

3. Receiving new messages while viewing another chat

web-3.mov

4. Unread marker still shows after deleting the message below it

web-4.mov

MacOS: Desktop

1. Actively reading new messages

desktop.mov

2. Viewing the chat above the new messages threshold

desktop.mov

3. Receiving new messages while viewing another chat

desktop.mov

4. Unread marker still shows after deleting the message below it

desktop.mov

[ikevin127]

@arosiclair LGTM 🎉 Tests well and code is clean!

🟢 I tested this thoroughly and all tests are passing, I even tested a previous regression from issue #44204 to ensure that it won't happen here!

Not sure how much you tested this, as I noticed you only posted 1 screenshot for each platform which does not actually illustrate the behaviour of each test - but if you tested this thoroughly as well then we shouldn't have any issues 🤞

✅ PR Reviewer Checklist is completed, will Approve as soon as I'm assigned as reviewer here.

[arosiclair]

Thanks for testing @ikevin127. I added you as reviewer and I'll go ahead and update the jest test soon.

[ikevin127]

Thanks! Let me know once the tests are fixed so I can Approve 👍

[arosiclair]

Alright after a second look, fixing the test required just a one line change 😄.

I also had to resolve some conflicts from #46569 which included simplifying the isUnarchivedReport check that was added. The logic should be the same though. Everything is still testing well. Ready for another review @ikevin127

[ikevin127]

LGTM 🚀

[melvin-bot]

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

[blimpich]

Looks great! Thanks for making the code a lot more concise/simple! 👍

[OSBotify]

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

🚀 Deployed to staging by https://github.com/blimpich in version: 9.0.20-0 🚀

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

[Beamanator]

FYI I believe this was deployed to prod yesterday, from this checklist - #47356