Skip to content

[NoQA] stabilize stableReportSelector and more reports in the ReportActionItem tree#93421

Merged
cristipaval merged 6 commits into
Expensify:mainfrom
callstack-internal:perf/stable-ReportActionItem-tree
Jun 15, 2026
Merged

[NoQA] stabilize stableReportSelector and more reports in the ReportActionItem tree#93421
cristipaval merged 6 commits into
Expensify:mainfrom
callstack-internal:perf/stable-ReportActionItem-tree

Conversation

@LukasMod

@LukasMod LukasMod commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Stabilizing report subscriptions in the ReportActionItem tree

Wasted re-renders on the report screen were traced to report-shaped useOnyx subscriptions
handing back new references with deep-equal content on nearly every render. Three root causes, three fixes.

  1. Per-instance selector — ReportActionsList.tsx
// Before
const [reportStable] = useOnyx(`${REPORT}${report.reportID}`, {selector: getStableReportSelector});
// After
const stableReportSelector = useCallback((r: OnyxEntry<Report>) => getStableReportSelector(r), []);
const [reportStable] = useOnyx(`${REPORT}${report.reportID}`, {selector: stableReportSelector});

Onyx keys its snapshot cache by selector function identity (cacheKey = ${onyxKey}_${selectorID}).
A shared module-level getStableReportSelector → every consumer on the same report key shares one
cache slot
→ they overwrite each other's deep-equal-but-distinct result objects → reference churns.
useCallback(…, []) gives the hook a unique, stable selector identity → its own cache slot →
stable reference until projected content actually changes.

  1. Stable projection on more subscriptions — ReportActionItem.tsx
// iouReport: added the stable projection selector
const [iouReport] = useOnyx(`${REPORT}${iouReportID}`, {selector: getStableReportSelector});

iouReport previously subscribed to the full report, so it re-rendered on every last* heartbeat
field (lastMessageText, lastVisibleActionCreated, lastReadTime, …) — which change on every
message send
. getStableReportSelector strips those fields, so it only updates on meaningful change.

  1. Push subscription to the leaf consumer — ReportActionItem.tsxActionContentRouter.tsx

The originalReport subscription was moved out of ReportActionItem and into ActionContentRouter,
the only component that consumes it (and the originalReport prop was dropped).

ReportActionItem no longer re-renders when originalReport changes — only the leaf that actually
reads it does.

  1. Lift the chatReport subscription out of every row — ReportActionItem.tsx
// Before — every ReportActionItem subscribed individually
const [chatReport] = useOnyx(`${REPORT}${report?.chatReportID}`, {selector: getStableReportSelector});

// After — subscribe once in the list parent and pass it down as a stable prop
// ReportActionsList.tsx / MoneyRequestReportActionsList.tsx
const [chatReport] = useOnyx(`${REPORT}${reportStable?.chatReportID}`, {selector: stableReportSelector});
// → ReportActionsListItemRenderer → ReportActionItem  (chatReport prop)

chatReport is only ever read inside the dismissError event handler (cleanUpMoneyRequest), never on
the render path. Yet every row in the list subscribed to it independently — and since all rows in a list
share the same report (so the same chatReportID), that was N identical subscriptions to one key,
each re-running the selector on every update to it.

Fixed Issues

$ #93434
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

No tests, simple selector/memoization change to make reference stable.

Offline tests

QA Steps

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

@LukasMod

Copy link
Copy Markdown
Contributor Author

@codex review

@LukasMod

Copy link
Copy Markdown
Contributor Author

Before / after:
Screenshot 2026-06-12 at 13 47 28
Screenshot 2026-06-12 at 13 36 48

Screenshot 2026-06-12 at 13 57 00

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

Copy link
Copy Markdown

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: 4e0d598d2f

ℹ️ 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".

const shouldRenderViewBasedOnAction = useTableReportViewActionRenderConditionals(action);

const [chatReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${getNonEmptyStringOnyxID(report?.chatReportID)}`);
const [chatReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${getNonEmptyStringOnyxID(report?.chatReportID)}`, {selector: getStableReportSelector});

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 Use per-row selector identity for report subscriptions

When a report has many visible actions, every ReportActionItem subscribes to the same chat report key with the module-level selector. Onyx's snapshot cache keys by Onyx key plus selector function identity (the same reason ReportActionsList now wraps its selector), so all rows share one cache entry and can continue replacing each other's selected report object when chat heartbeat fields change. That leaves the row tree re-rendering on the high-volume updates this patch is trying to filter; use a per-instance stable selector here and for the other new row-level report subscriptions.

Useful? React with 👍 / 👎.

@codecov

codecov Bot commented Jun 12, 2026

Copy link
Copy Markdown

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 64.44% <ø> (ø)
src/pages/inbox/report/ReportActionItem.tsx 90.47% <100.00%> (-0.12%) ⬇️
src/pages/inbox/report/ReportActionsList.tsx 69.23% <100.00%> (-1.39%) ⬇️
...ges/inbox/report/ReportActionsListItemRenderer.tsx 82.35% <ø> (ø)
...nbox/report/actionContents/ActionContentRouter.tsx 91.08% <100.00%> (+0.05%) ⬆️
...onents/Search/SearchList/ListItem/ChatListItem.tsx 0.00% <0.00%> (ø)
...es/Debug/ReportAction/DebugReportActionPreview.tsx 0.00% <0.00%> (ø)
...rc/pages/inbox/report/AncestorReportActionItem.tsx 0.00% <0.00%> (ø)
...Debug/ReportAction/DebugReportActionCreatePage.tsx 0.00% <0.00%> (ø)
... and 107 files with indirect coverage changes

@LukasMod

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Another round soon, please!

Reviewed commit: 3ba0da6d4f

ℹ️ 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".

@LukasMod LukasMod marked this pull request as ready for review June 12, 2026 13:19
@LukasMod LukasMod requested review from a team as code owners June 12, 2026 13:19
@melvin-bot melvin-bot Bot requested review from QichenZhu and joekaufmanexpensify and removed request for a team June 12, 2026 13:19
@melvin-bot

melvin-bot Bot commented Jun 12, 2026

Copy link
Copy Markdown

@QichenZhu 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 the request for review from a team June 12, 2026 13:19

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

Copy link
Copy Markdown

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: 6a92b53e8d

ℹ️ 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".

Comment thread src/pages/inbox/report/actionContents/ActionContentRouter.tsx
@LukasMod

Copy link
Copy Markdown
Contributor Author

@codex review

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

Copy link
Copy Markdown

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

ℹ️ 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".

Comment on lines +147 to +148
const stableReportSelector = (reportEntry: OnyxEntry<OnyxTypes.Report>) => getStableReportSelector(reportEntry);
const [originalReport] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT}${originalReportID}`, {selector: stableReportSelector});

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 Memoize original report selector

When an action has an originalReportID (thread parent or merged single-transaction views), this creates a fresh selector function on every render, so Onyx sees a new selector identity/cache key each time and cannot reuse the stable projected report reference. That reintroduces the reference churn this change is trying to remove for any hover/edit/state update in these rows; define the selector with useCallback(..., []) as in ReportActionsList before passing it to useOnyx.

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.

react compiler handles that

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.

I reverted stableReportSelector here. I don't see benefit in Profiler benchmarks. originalReport looks to be stable

@QichenZhu

Copy link
Copy Markdown
Contributor

If this needs my review/testing, I'll get to it this weekend.

@LukasMod

LukasMod commented Jun 12, 2026

Copy link
Copy Markdown
Contributor Author

@QichenZhu I kept the changes minimal based on the Profiler results, which pointed to specific props causing re-renders. You can verify this by comparing Profiler results after sending a few messages if needed

@joekaufmanexpensify

Copy link
Copy Markdown
Contributor

No product review needed

@joekaufmanexpensify joekaufmanexpensify removed their request for review June 12, 2026 17:27
@QichenZhu

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 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
android-native.mov
Android: mWeb Chrome
android-web.mov
iOS: HybridApp
ios-native.mov
iOS: mWeb Safari
ios-web.mov
MacOS: Chrome / Safari

Search

Average: 40.6ms -> 34.1ms (-16%)

Before After
search-before-1 search-after-1
search-before-2 search-after-2
search-before-3 search-after-3

Self DM

Average: 44.1ms -> 33.7ms (-24%)

Before After
self-dm-before-1 self-dm-after-1
self-dm-before-2 self-dm-after-2
self-dm-before-3 self-dm-after-3

@melvin-bot melvin-bot Bot requested a review from cristipaval June 13, 2026 14:26
@cristipaval cristipaval merged commit 1ce133b into Expensify:main Jun 15, 2026
33 of 34 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🚧 @cristipaval has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

Copy link
Copy Markdown
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.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/cristipaval in version: 9.4.8-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 failure ❌
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

@MelvinBot

Copy link
Copy Markdown
Contributor

Help site review — no changes required

I reviewed the changes in this PR against the help site files under App/docs/articles, applying the naming conventions, authoring guidelines, and template.

Conclusion: No help site documentation changes are required, so I did not create a draft PR.

This PR is a purely internal performance/memoization refactor of the ReportActionItem render tree. It changes how report data is subscribed to and passed down — not what the product does:

  • Gives useOnyx selectors stable per-instance identity (useCallback) to avoid cache-slot churn
  • Applies the existing getStableReportSelector projection to more subscriptions (iouReport, chatReport)
  • Lifts the chatReport subscription up to the list parent and passes it down as a prop
  • Pushes the originalReport subscription down to the only leaf that reads it (ActionContentRouter)

There are no changes to user-facing behavior, copy, UI labels, feature names, tab names, settings, or buttons. The only file/prop additions are internal React props (chatReport) and selector wiring. Help site articles describe product behavior for end users, and none of that behavior is affected here.


@LukasMod, since no help site changes are required, there is no linked help site PR to review. If you believe a docs update is warranted here, let me know what behavior should be documented and I'll create the draft PR.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/cristipaval in version: 9.4.8-0 🚀

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

Bundle Size Analysis (Sentry):

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 9.4.8-3 🚀

platform result
🕸 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.

6 participants