Skip to content

Remove Onyx.connect() key ONYXKEYS.COLLECTION.REPORT_ACTIONS in src/libs/OptionsListUtils.ts - part 3 - #86643

Merged
grgia merged 36 commits into
Expensify:mainfrom
truph01:fix/66381-part-3
May 20, 2026
Merged

grgia merged 36 commits into
Expensify:mainfrom
truph01:fix/66381-part-3

Conversation

@truph01

@truph01 truph01 commented Mar 30, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

This is the 3rd PR in the migration of Onyx.connect() for ONYXKEYS.COLLECTION.REPORT_ACTIONS in OptionsListUtils. It refactors:

  1. getLastMessageTextForReport -> getAlternateText -> prepareReportOptionsForDisplay -> getValidOptions
  2. getLastMessageTextForReport -> getAlternateText -> prepareReportOptionsForDisplay -> getValidOptions -> getSearchOptions

Fixed Issues

$ #66381
PROPOSAL:

Tests

  1. Open ND
  2. Click Search icon in top right
  3. Verify the recent reports are displayed correctly.
  • Verify that no errors appear in the JS console

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

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
Screen.Recording.2026-03-31.at.00.08.43.mov

@truph01
truph01 marked this pull request as ready for review March 30, 2026 16:37
@truph01
truph01 requested review from a team as code owners March 30, 2026 16:37
@melvin-bot
melvin-bot Bot requested review from DylanDylann and trjExpensify and removed request for a team March 30, 2026 16:37
@melvin-bot

melvin-bot Bot commented Mar 30, 2026

Copy link
Copy Markdown

@DylanDylann 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 March 30, 2026 16:38

@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: 786f594285

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

@codecov

codecov Bot commented Mar 30, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/libs/OptionsListUtils/index.ts 84.68% <50.00%> (+1.08%) ⬆️
... and 158 files with indirect coverage changes

@truph01

truph01 commented Mar 30, 2026

Copy link
Copy Markdown
Contributor Author

@MelvinBot Please check why we have Reassure Performance Tests / perf-tests (pull_request) Failing after 13m

@MelvinBot

Copy link
Copy Markdown
Contributor

The Reassure perf test failure is not caused by this PR — it's a flaky/systemic issue currently affecting many unrelated PRs.

Evidence

  1. No code path overlap: None of the files changed by this PR are in the ReportActionCompose component tree. The perf test wraps ReportActionCompose in OnyxListItemProvider/LocaleContextProvider/KeyboardStateProvider — not OptionListContextProvider (the main component this PR modifies).

  2. Same failure on unrelated PRs: At least 7 other unrelated branches (e.g. workspaces-navigator, clean-session-callback-changed-user, pregenerate-thumbnails, Odometer, fix/66412-part-5) all fail with the identical error on the same baseline commit 71ea695.

  3. Non-deterministic: The workspaces-navigator branch failed this test at 16:42 and then passed at 17:06 with zero code changes — same baseline, same branch.

Root Cause

The baseline commit (71ea695) appears to have made the ReportActionCompose render count marginally non-deterministic, likely due to async timing in Onyx/useSyncExternalStore combined with the strict COUNT_DEVIATION: 0 tolerance. A single extra render across averaged runs triggers the failure.

Recommendation

Re-run the CI. If it continues to fail, the issue is in the baseline (main branch), not in this PR.

@trjExpensify

Copy link
Copy Markdown
Contributor

PR doesn’t need product input as a refactor PR. Unassigning and unsubscribing myself.

@trjExpensify
trjExpensify removed their request for review March 30, 2026 20:32
@DylanDylann

Copy link
Copy Markdown
Contributor

Let’s wait until the previous PR is merged

@DylanDylann

Copy link
Copy Markdown
Contributor

@truph01 we got a failed check, please resolve it and ping the internal engineer to move it forward

@truph01

truph01 commented May 8, 2026

Copy link
Copy Markdown
Contributor Author

@DylanDylann All good now!

@DylanDylann

Copy link
Copy Markdown
Contributor

@grgia This is ready for your review

Comment thread src/hooks/useAutocompleteSuggestions.ts Outdated
loginList: OnyxEntry<Record<string, unknown>>;
policies: NonNullable<OnyxCollection<Policy>>;
visibleReportActionsData?: VisibleReportActionsDerivedValue;
sortedActions: Record<string, ReportAction[]> | undefined;

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.

this hook still uses useSortedActions() later on, is that intentional?

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.

  • if this is unused should it be a ? for not required?

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.

@grgia I removed that param entirely since, within hooks, we can directly use const sortedActions = useSortedActions();.

@grgia grgia 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.

@truph01 would you fix eslint/TS?

@truph01

truph01 commented May 19, 2026

Copy link
Copy Markdown
Contributor Author

@grgia All good now!

@grgia
grgia requested a review from DylanDylann May 19, 2026 14:46
@DylanDylann

Copy link
Copy Markdown
Contributor

Ahh wait....

const reportCache = iouReportID ? visibleReportActionsDataParam?.[iouReportID] : undefined;
const visibleReportActionsForIOUReport = reportCache && Object.keys(reportCache).length > 0 ? visibleReportActionsDataParam : undefined;
const iouReportActions = iouReportID ? deprecatedAllSortedReportActions[iouReportID] : undefined;
const iouReportActions = iouReportID ? sortedActions?.[iouReportID] : undefined;

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.

@truph01 Could you investigate whether we can pass lastIOUMoneyReportAction instead of sortedActions?

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.

@DylanDylann Sorry, what do you mean by passing lastIOUMoneyReportAction instead of sortedActions?
Doesn't lastIOUMoneyReportAction depend on sortedActions?

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.

Yes, sortedActions is only used to get lastIOUMoneyReportAction

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.

@DylanDylann I don't think passing lastIOUMoneyReportAction instead of sortedActions is an improvement — it would violate DRY. The derivation still needs to happen somewhere, and moving it out of getLastMessageTextForReport means every call site must duplicate the same logic to compute it. Keeping it inside the function centralizes that in one place.

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.

sortedActions is a large object, and passing it across components can cause performance problems (triggering many renders when something in sortedActions changes). By passing a smaller parameter, we can help avoid unnecessary renders. Regarding DRY, we could also create a new hook to process lastIOUMoneyReportAction. Happy to discuss further before starting to make sure we're taking the best approach

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.

By passing a smaller parameter, we can help avoid unnecessary renders.

@DylanDylann However, to pass a smaller parameter, we still need to calculate it first. As a result, sortedActions still needs to be subscribed to in the component. Therefore, the number of renders does not change compared to passing sortedActions directly.

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.

@MelvinBot Could you explain the benefits of passing a small prop through a chain of child components? Especially in this case, where we can pass lastIOUMoneyReportAction instead of sortedActions

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.

@MelvinBot

Copy link
Copy Markdown
Contributor

Passing lastIOUMoneyReportAction (a single action) instead of sortedActions (a Record<string, ReportAction[]>) has two main benefits:

  1. Fewer re-renders. React uses referential equality to detect prop changes. sortedActions is a large collection that gets a new reference whenever any report's actions change — even reports unrelated to the one being displayed. A single ReportAction object is a much more stable reference, so components receiving it skip unnecessary re-renders.

  2. Clearer API contract. When a function accepts sortedActions, callers can't tell which report's actions matter without reading the implementation. Accepting lastIOUMoneyReportAction directly makes the dependency explicit — the function needs exactly one action from one IOU report, nothing more.

In this specific case (line 714–724), sortedActions is only used to look up iouReportActions for a single iouReportID and then .find() the last IOU money request action. Computing that before calling getLastMessageTextForReport and passing just the result avoids threading the entire collection through the call chain.

@grgia
grgia merged commit dc7e199 into Expensify:main May 20, 2026
54 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

🚧 @grgia 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/grgia in version: 9.3.79-1 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot

Copy link
Copy Markdown
Contributor

I reviewed the changes in this PR. It's a purely internal code refactoring that threads a sortedActions parameter through several functions in OptionsListUtils as part of the Onyx.connect() migration (#66381). There are no user-facing behavior changes, no new features, and no UI or terminology changes.

No help site documentation changes are required.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 9.3.79-4 🚀

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