Skip to content

Fix: New message marker is not displayed on the first message in expense report#65918

Merged
youssef-lr merged 5 commits intoExpensify:mainfrom
nyomanjyotisa:issue-63427-2
Jul 29, 2025
Merged

Fix: New message marker is not displayed on the first message in expense report#65918
youssef-lr merged 5 commits intoExpensify:mainfrom
nyomanjyotisa:issue-63427-2

Conversation

@nyomanjyotisa
Copy link
Member

@nyomanjyotisa nyomanjyotisa commented Jul 11, 2025

Explanation of Change

Fixed Issues

$ #63427
PROPOSAL: #63427 (comment)

Tests

Same as QA Steps

  • Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

  1. Navigate to workspace chat
  2. Create two expenses
  3. Click on Expense preview
  4. Send a message in the expense report
  5. Right click on the message > Mark as unread
  6. Verify that the green new message marker displayed on the message
  7. Delete the message
  8. Click More > Download as CSV
  9. Go back to main workspace chat
  10. Open the expense report
  11. Verify that the new message marker appears above "exported to CSV" message
  12. Go back to main workspace chat
  13. Reopen the expense report
  14. Verify that the new message marker disappear after reopening the expense report
  • 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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-Native.mp4
Android: mWeb Chrome
Android-mWeb.Chrome.mp4
iOS: Native
iOS-Native.mp4
iOS: mWeb Safari
iOS-mWeb.Safari.mp4
MacOS: Chrome / Safari
MacOS-Chrome.mp4
MacOS: Desktop
MacOS-Desktop.mp4

@nyomanjyotisa nyomanjyotisa marked this pull request as ready for review July 14, 2025 05:32
@nyomanjyotisa nyomanjyotisa requested a review from a team as a code owner July 14, 2025 05:32
@melvin-bot melvin-bot bot requested review from c3024 and removed request for a team July 14, 2025 05:32
@melvin-bot
Copy link

melvin-bot bot commented Jul 14, 2025

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

@nyomanjyotisa
Copy link
Member Author

@c3024 Regarding the regression, here's the RCA and the solution implemented in this PR

RCA

When checking for unread actions to determine whether to call readNewestAction(), we explicitly excludes actions from the current user

const hasUnreadReportAction = reportActions.some(
(reportAction) => newMessageTimeReference && newMessageTimeReference < reportAction.created && reportAction.actorAccountID !== getCurrentUserAccountID(),
);

And since system-generated messages (like CSV export, approval, etc.) are created with the current user as the actor, this condition excludes them from being considered as "unread actions". As a result, readNewestAction is never called when reopening the expense report, and the new message marker is not removed

Solution

We should update the hasUnreadReportAction condition to include system messages that can be identified by checking if the action is NOT an ADD_COMMENT

@c3024
Copy link
Contributor

c3024 commented Jul 14, 2025

The same logic is used in ReportActionsList. But, it works well there.

For example,

  1. Create a workspace
  2. Invite a member
  3. #admins room shows the invited message
  4. Mark this as unread if required
  5. Click on another report from LHN
  6. Go back to the #admins room
  7. The unread marker goes away

But, this does not happen for MoneyRequestReportActionsList for the steps in #65487 even though it is a similar flow.

@nyomanjyotisa
Copy link
Member Author

nyomanjyotisa commented Jul 17, 2025

After looking into the issue, I found that the problem actually comes from this condition

if (isUnread(report, transactionThreadReport) || (lastAction && isCurrentActionUnread(report, lastAction))) {

RCA

isCurrentActionUnread only considers an action as "current unread" if it's the oldest unread action in a sequence.

function isCurrentActionUnread(report: OnyxEntry<Report>, reportAction: ReportAction): boolean {
const lastReadTime = report?.lastReadTime ?? '';
const sortedReportActions = getSortedReportActions(Object.values(getAllReportActions(report?.reportID)));
const currentActionIndex = sortedReportActions.findIndex((action) => action.reportActionID === reportAction.reportActionID);
if (currentActionIndex === -1) {
return false;
}
const prevReportAction = sortedReportActions.at(currentActionIndex - 1);
return isReportActionUnread(reportAction, lastReadTime) && (currentActionIndex === 0 || !prevReportAction || !isReportActionUnread(prevReportAction, lastReadTime));
}

The function returns true only when an action is unread AND either it's the first action OR the previous action is already read.
In the MoneyRequestReportActionsList case, when we add 2 expense to a report and export it as CSV, we have 4 consecutive unread actions: IOUIOUBILLABLEUPDATETRANSACTIONEXPORTCSV

image

When isCurrentActionUnread is called on the EXPORTCSV action (the lastAction), it returns false because the previous action (BILLABLEUPDATETRANSACTION) is also unread. The function only considers the first unread action in a sequence as "current unread"

In contrast, the ReportActionsList case works because there's only one unread action (POLICYCHANGELOG_ADD_EMPLOYEE), making it both the first and last unread action in the sequence, so isCurrentActionUnread returns true

image

BUT we could get the same issue on ReportActionsList if we have 2 consecutive unread actions as well

image

Here is how to reproduce it:

  1. Create a workspace
  2. Invite 2 members
  3. Upgrade workspace to Control
  4. #admins room shows the system message
  5. Note that the first thread reply marked as unread
  6. Click on another report from LHN
  7. Go back to the thread on #admins room
  8. The unread marker does not disappear
New-Expensify.mp4

Solution

We should update the condition in MoneyRequestReportActionsList and ReportActionsList to also check if there are any unread actions at all, not just if the current action is the "first" unread action

const hasAnyUnreadActions = reportActions.some(action => isReportActionUnread(action, report?.lastReadTime ?? ''));

if (isUnread(report, transactionThreadReport) || (lastAction && isCurrentActionUnread(report, lastAction)) || hasAnyUnreadActions) {
    ...
}

if (isUnread(report, transactionThreadReport) || (lastAction && isCurrentActionUnread(report, lastAction))) {

@c3024
Copy link
Contributor

c3024 commented Jul 21, 2025

Thanks for the digging. Even when there are four unread actions the unread marker shows up only on the exported report action because the other actions are excluded from the visible actions here.

const visibleReportActions = useMemo(() => {
const filteredActions = reportActions.filter((reportAction) => {
const isActionVisibleOnMoneyReport = isActionVisibleOnMoneyRequestReport(reportAction);
return (
isActionVisibleOnMoneyReport &&
(isOffline || isDeletedParentAction(reportAction) || reportAction.pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE || reportAction.errors) &&
shouldReportActionBeVisible(reportAction, reportAction.reportActionID, canPerformWriteAction) &&
isIOUActionMatchingTransactionList(reportAction, reportTransactionIDs)
);
});

So, would it be better to match this unread logic with the unread marker logic with passing the visibleActions to isCurrentActionUnread like

if (isUnread(report, transactionThreadReport) || (lastAction && isCurrentActionUnread(report, lastAction, visibleReportActions)))

here and use it first before finding the sortedReportActions in the isCurrentActionUnread function?

function isCurrentActionUnread(report: OnyxEntry<Report>, reportAction: ReportAction, visibleReportActions?: ReportAction[]): boolean {
    const lastReadTime = report?.lastReadTime ?? '';
    const sortedReportActions = visibleReportActions ?? getSortedReportActions(Object.values(getAllReportActions(report?.reportID)));
   /* remaining code */
}

@nyomanjyotisa
Copy link
Member Author

Yeah, I think your approach is better than broadly checking for any unread actions. Thanks for the suggestion! I'll update the PR accordingly

@c3024
Copy link
Contributor

c3024 commented Jul 27, 2025

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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: HybridApp
unreadAndroid.mov
Android: mWeb Chrome
unreadAndroidmWeb.mov
iOS: HybridApp
unreadiOS.mov
iOS: mWeb Safari
unreadiOSmWeb.mov
MacOS: Chrome / Safari
unreadChrome1.mov
MacOS: Desktop
unreadDesktop.mov

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from youssef-lr July 27, 2025 12:54
@youssef-lr youssef-lr merged commit f5add7b into Expensify:main Jul 29, 2025
19 checks passed
@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.

@github-actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/youssef-lr in version: 9.1.88-0 🚀

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

@nyomanjyotisa
Copy link
Member Author

Seems like when we do this steps:

  1. Add a comment in the report chat
  2. Mark it as unread
  3. Go to another chat
  4. Go back to the report chat
  5. The green new message marker appears
  6. Go to another chat
  7. Go back to the report chat
  8. The green new message marker disappears
  9. Delete the comment
  10. Export the report to CSV
  11. Wait until "exported to CSV" system message appears
  12. Navigate back to the same workspace chat

The EXPORTCSV is marked as read, even when the page that displaying the system message is not focused yet

This behavior does not occur if:

  1. We skip step 1-9 (no comment is added) and start from step 10, or
  2. We navigate to a different chat after the export (e.g., Concierge instead of the same workspace chat)

Scenario 1 (Fail):

MacOS-Chrome.mp4

Scenario 2 (Success):

MacOS-Chrome-2.mp4

Scenario 3 (Success):

MacOS-Chrome-3.mp4

We can fix this by adding early check here to ensures that the report is only marked as read when the user is actually viewing it

        if (!isFocused) {
            return;
        }

cc @c3024

@github-actions
Copy link
Contributor

github-actions bot commented Aug 4, 2025

🚀 Deployed to production by https://github.com/grgia in version: 9.1.88-3 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 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.

5 participants