Skip to content

Fix: include 1:1 DM participants in OpenReport so stale optimistic reportIDs self-heal - #98855

Open
elirangoshen wants to merge 4 commits into
Expensify:mainfrom
callstack-internal:eliran/openreport-dm-participants-selfheal
Open

Fix: include 1:1 DM participants in OpenReport so stale optimistic reportIDs self-heal#98855
elirangoshen wants to merge 4 commits into
Expensify:mainfrom
callstack-internal:eliran/openreport-dm-participants-selfheal

Conversation

@elirangoshen

@elirangoshen elirangoshen commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

When a 1:1 DM is opened by reportID alone (chat switcher, LHN, deep link), the OpenReport API call was sent with empty emailList/accountIDList. If the cached reportID was a stale optimistic one that was never reconciled to the real report (the request that would have reconciled it was lost — e.g. dropped connection or the app was closed), the server had nothing to resolve against and returned 403 Report not found, showing the user a "not found" screen. Production logs show ~900 such failures per day across ~470 users.

The server already self-heals a bad/optimistic reportID when the request includes the DM participant: it looks up the real DM between the two users and returns it as preexistingReportID. The client already handles that response end-to-end — HandleUnusedOptimisticID middleware rewrites queued requests, and replaceOptimisticReportWithActualReport swaps navigation to the real report and deletes the stale optimistic report from Onyx.

This PR supplies the missing piece: in openReport, when the caller passed no participants and the cached report is a 1:1 DM, derive accountIDList from the cached report's participants (excluding the current user) and emailList from personal details, and include them in the API call. The change is deliberately scoped to 1:1 DMs, where the participant pair uniquely identifies the chat — rooms, threads, group chats, and expense reports are untouched. When the caller passes participants explicitly (new-chat flows), those are kept as-is.

Fixed Issues

$ #98765

Tests

  1. Open a 1:1 DM you already have from the chat switcher (magnifying glass, top right).
  2. Verify the DM opens normally.
  3. With browser dev tools open (Network tab), filter for OpenReport and open another existing 1:1 DM.
  4. Verify the request payload now contains the other participant's email in emailList and their accountID in accountIDList.
  5. Open a workspace room and a thread; verify their OpenReport requests still send empty emailList/accountIDList.
  6. Start a brand-new DM with a user you've never chatted with (search router → type their email); verify the chat is created and opens normally.

Automated coverage: tests/actions/ReportTest.tsdescribe('openReport participants self-heal') — derives participants for a cached 1:1 DM, leaves them empty for non-DM reports, and preserves caller-provided participants.

  • Verify that no errors appear in the JS console

Offline tests

  1. Go offline.
  2. Open an existing 1:1 DM from the chat switcher — verify cached messages render and no error screen appears.

QA Steps

  1. Open several existing 1:1 DMs from the chat switcher (top-right search) — verify each opens without a "not found" page.
  2. Open a workspace room and a thread — verify they open normally.
  3. Start a new DM with a user you've never chatted with — verify the chat is created and opens normally.
  • 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
  • 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 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 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)
  • 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)
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari Screenshot 2026-08-18 at 12 03 53 Screenshot 2026-08-18 at 12 19 56

…Ds self-heal

When a cached DM is opened by reportID only (LHN, search router, deep link),
OpenReport was sent with empty emailList/accountIDList. If the cached reportID
was a stale optimistic one, the server had nothing to resolve against and
returned 403 "Report not found". Deriving the participant list from the cached
report lets the server resolve the real chat and return preexistingReportID,
which the existing reconciliation middleware already handles.
Covers: deriving emailList/accountIDList from a cached 1:1 DM, leaving them
empty for non-DM reports, and preserving caller-provided participants.
…m-participants-selfheal

# Conflicts:
#	src/libs/actions/Report/index.ts
@elirangoshen
elirangoshen marked this pull request as ready for review August 18, 2026 10:40
@elirangoshen
elirangoshen requested review from a team as code owners August 18, 2026 10:40
@melvin-bot
melvin-bot Bot requested review from hoangzinh and trjExpensify August 18, 2026 10:40
@melvin-bot

melvin-bot Bot commented Aug 18, 2026

Copy link
Copy Markdown

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

@melvin-bot
melvin-bot Bot removed request for a team August 18, 2026 10:40
@hoangzinh

Copy link
Copy Markdown
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 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
  • 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 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 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)
  • 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)
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately
    • 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
    • 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 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.
  • 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
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari

Comment thread src/libs/actions/Report/index.ts Outdated
const participantAccountIDList = participants.map((p) => p.accountID).filter((id): id is number => id !== undefined);
const existingReportName = allReports?.[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`]?.reportName;
let participantAccountIDList = participants.map((p) => p.accountID).filter((id): id is number => id !== undefined);
const existingReport = allReports?.[`${ONYXKEYS.COLLECTION.REPORT}${reportID}`];

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I know we previously used allReports to obtain the report name, but since allReports will be deprecated soon, we should avoid using it to retrieve participants. Do you know why the participants argument of openReport is empty?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

only new-chat creation flows had participant info; fetch-by-reportID paths never did — now ReportFetchHandler derives it from its own useOnyx data.

I fixed the other comment related to allReports

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@elirangoshen, do you know why it has been happening recently?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes — and it turns out to be very recent and very sharp. I pulled the backend log trend for this exact failure (401 Unauthorized thrown from Report.cpp while processing OpenReport, which is what the client renders as the not-found page):

  • Zero occurrences before 2026-07-23. Not one, going back through June.
  • On Jul 23 it jumps to ~3.2k/day and has been sustained at ~4–6k/day on weekdays ever since (~91k total in 4 weeks). The weekend dips track business usage.
  • I also checked the week before Jul 23 for any 401 exception on OpenReport under any message shape/file, in case a refactor just moved the throw — nothing. This failure class genuinely did not exist before that date.

So the mechanism (stale optimistic reportIDs from lost reconciling writes) is old, but something that deployed around Jul 22–23 — on the Auth side (the access check throwing at Report.cpp:17792) or in the App version that hit production that day — flipped this from theoretical to ~5k/day. Recent queue/auth bugs like the stale-token 407 drops discussed in #98314 likely feed the stale-ID population, but the hard on/off edge points at a specific deploy. Worth someone with Auth access diffing what changed around that throw in the Jul-23 deploy.

Either way, the fix here is deploy-agnostic: it gives the server what it needs to self-heal regardless of which producer created the stale ID.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @elirangoshen

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@elirangoshen can you test again on this PR? I can see emailList, but accountIDList is still empty

image

Per review feedback: openReport no longer reads allReports/allPersonalDetails
(both slated for deprecation). A pure ReportUtils.getOneOnOneChatParticipants
helper derives the other DM participant from data the component already
subscribes to via useOnyx, and ReportFetchHandler passes it through the
existing participants param.

@trjExpensify trjExpensify left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the server had nothing to resolve against and returned 403 Report not found, showing the user a "not found" screen. Production logs show ~900 such failures per day across ~470 users.

Wowza, nice. 👍

Comment thread src/libs/ReportUtils.ts
}
return Object.keys(report?.participants ?? {})
.map(Number)
.filter((accountID) => accountID !== currentUserAccountID)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we need to exclude currentUserAccountID?

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.

3 participants