Skip to content

perf: stabilize ReportActionItem with getStableReportSelector and index context#91296

Open
LukasMod wants to merge 5 commits into
Expensify:mainfrom
callstack-internal:perf/stable-report
Open

perf: stabilize ReportActionItem with getStableReportSelector and index context#91296
LukasMod wants to merge 5 commits into
Expensify:mainfrom
callstack-internal:perf/stable-report

Conversation

@LukasMod
Copy link
Copy Markdown
Contributor

@LukasMod LukasMod commented May 21, 2026

Explanation of Change

1. getStableReportSelector

A useOnyx selector that strips heartbeat-style fields from a Report (lastMessageText, lastVisibleActionCreated, lastReadTime, lastReadSequenceNumber, lastMentionedTime, lastVisibleActionLastModified, lastMessageHtml, lastActorAccountID, lastActionType). Subscribed components stop re-rendering on heartbeat-only Onyx pushes.

Applied at 4 production useOnyx subscription sites:

  • MoneyRequestReportActionsList — expense report scroll
  • ReportActionsList — chat scroll
  • ReportActionItem (originalReport subscription) — runs per visible action
  • ChatListItem — search results list
2. ReportActionIndexContext (src/pages/inbox/report/ReportActionIndexContext.tsx)

A tiny React context that carries the action item's position index from the list renderer to the rare consumers that read it (ReportActionItemMessageEdit for scroll-to-index during edit mode). Replaces prop drilling — a new message arriving no longer cascades index re-renders through every item.

3. Whisper-handler fix (MentionWhisperContent, ReportMentionWhisperContent, ConfirmWhisperContent)

resolveActionableMentionWhisper / resolveActionableReportMentionWhisper / resolveActionableMentionConfirmWhisper build a failure-revert payload from report.lastMessageText / lastVisibleActionCreated / lastActorAccountID. Those are exactly the heartbeat fields the selector strips. Without a fix, an API failure would merge {lastMessageText: undefined, …} into Onyx and clobber the user's LHN preview.

Fix: each whisper component adds one useOnyx subscription without a selector to fetch the full report, and passes that wide value into the resolve action.

  • ReportMentionWhisperContent and ConfirmWhisperContent also swap their actionReport: OnyxEntry<Report> prop for actionReportID: string | undefined (the prop was only used for its ID anyway).
  • MentionWhisperContent keeps its existing prop shape — minimal diff, lowest regression surface. Only change is one added useOnyx line and three call-site swaps from actionReport to actionReportFull.

Fixed Issues

$ #91394
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

1. Chat — send & receive

  1. Open a long chat, scroll up from the bottom.
  2. Send a message.
  3. Receive a message from another user.
  4. Leave chat and return.
  5. Verify LHN preview updates with the latest message.
  6. Pass: Messages send/receive correctly, scroll position intact on return, LHN preview updates, no scroll jumps

2. Message edit — scroll-to-index

  1. In a chat with 20+ messages, scroll to the middle.
  2. Edit an message → Save.
  3. Edit another message → Cancel.
  4. Pass: View stays near the edited message on save/cancel (no jump to top or wrong index)

3. Expense report activity

  1. Open an expense report with activity/comments.
  2. Scroll the activity list.
  3. Add a comment or trigger new activity.
  4. Leave and return.
  5. Pass: Activity list scrolls and updates correctly, new items appear without flicker

4. Search — chat results

  1. Search → type:chat
  2. Verify rows show avatar, name, last message preview, timestamp.
  3. Open a result.
  4. Send a message
  5. Pass: Search previews are correct and update after new messages, opened chat loads normally

5. Whisper — user mention

  1. In a workspace chat, @mention someone not in the chat.
  2. Tap Invite to chat only.
  3. Repeat with Do nothing.
  4. (Admin) Invite to submit expenses → confirm whisper
  5. Pass: Whisper actions resolve cleanly online

6. Whisper — room mention

  1. #mention a room → tap Yes.
  2. Repeat → tap No.
  3. Creates new room
  4. Pass: All whisper buttons resolve correctly online

7. Offline — general

  1. Open chat offline.
  2. Queue a message offline → go online.
  3. Pass: Cached messages display offline, queued message sends on reconnect and LHN updates

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • Verify that no errors appear in the JS console

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
  • 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 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.
  • 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
1.mov
2.mov
3.mov
4.mov

@LukasMod
Copy link
Copy Markdown
Contributor Author

@codex review

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 683bb63e10

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".


function ReportActionItemMessageEdit({action, reportID, originalReportID, policyID, index, isGroupPolicyReport, shouldDisableEmojiPicker = false, ref}: ReportActionItemMessageEditProps) {
function ReportActionItemMessageEdit({action, reportID, originalReportID, policyID, isGroupPolicyReport, shouldDisableEmojiPicker = false, ref}: ReportActionItemMessageEditProps) {
const index = useContext(ReportActionIndexContext);
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Preserve edit index outside list context

ReportActionItemMessageEdit now reads index only from ReportActionIndexContext, whose default value is 0. ReportActionItem is rendered in flows that are not wrapped by that provider (for example src/pages/TransactionDuplicate/DuplicateTransactionItem.tsx and src/components/Search/SearchList/ListItem/ChatListItem.tsx), so those paths will treat every edited action as index 0 and useEditMessage will incorrectly execute scrollToIndex(0) on save/cancel for non-first items, causing scroll jumps/regressed edit behavior compared to the prior explicit index prop plumbing.

Useful? React with 👍 / 👎.

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.

  • ChatListItem: old code was item.index ?? 0, but search never populates item.index, always undefined → always 0. Same as today.
  • DuplicateTransactionItem: renders IOU previews, not ReportActionItemMessageEdit; no report flatListRef in that modal anyway.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
...equestReportView/MoneyRequestReportActionsList.tsx 65.03% <100.00%> (+0.13%) ⬆️
...Debug/ReportAction/DebugReportActionCreatePage.tsx 0.00% <ø> (ø)
...es/Debug/ReportAction/DebugReportActionPreview.tsx 0.00% <ø> (ø)
src/pages/inbox/report/PureReportActionItem.tsx 91.62% <ø> (-0.05%) ⬇️
...rc/pages/inbox/report/ReportActionIndexContext.tsx 100.00% <100.00%> (ø)
src/pages/inbox/report/ReportActionItem.tsx 100.00% <100.00%> (ø)
...pages/inbox/report/ReportActionItemMessageEdit.tsx 53.26% <100.00%> (+0.25%) ⬆️
...ages/inbox/report/ReportActionItemParentAction.tsx 0.00% <ø> (ø)
src/pages/inbox/report/ReportActionsList.tsx 78.44% <100.00%> (+0.19%) ⬆️
...ges/inbox/report/ReportActionsListItemRenderer.tsx 81.25% <ø> (ø)
... and 7 more
... and 11 files with indirect coverage changes

@LukasMod LukasMod changed the title [WIP] add getStableReportSelector perf: remove PureReportActionItem and use stable report #51 May 21, 2026
@LukasMod LukasMod changed the title perf: remove PureReportActionItem and use stable report #51 perf: stabilize ReportActionItem with getStableReportSelector and index context May 21, 2026
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 22, 2026

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

@joekaufmanexpensify
Copy link
Copy Markdown
Contributor

No product review needed

@joekaufmanexpensify joekaufmanexpensify removed their request for review May 22, 2026 21:14
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.

2 participants