Skip to content

Part 4: Remove Onyx.connect() for ONYXKEYS.COLLECTION.REPORT_ACTIONS in shareTrackedExpense path#90317

Merged
Gonals merged 3 commits into
Expensify:mainfrom
DylanDylann:refactor-66578-shareTrackedExpense
May 20, 2026
Merged

Part 4: Remove Onyx.connect() for ONYXKEYS.COLLECTION.REPORT_ACTIONS in shareTrackedExpense path#90317
Gonals merged 3 commits into
Expensify:mainfrom
DylanDylann:refactor-66578-shareTrackedExpense

Conversation

@DylanDylann
Copy link
Copy Markdown
Contributor

@DylanDylann DylanDylann commented May 12, 2026

Explanation of Change

This PR is part of deprecating the module-scoped Onyx.connect() cache deprecatedAllReportActions in src/libs/actions/Policy/Policy.ts. deprecatedAllReportActions is read inside createPolicyExpenseChats (Policy.ts:1612) when the if (oldChat) branch is entered. Callers should supply an explicit reportActionsList (from the useAllPolicyExpenseChatReportActions() hook) instead of relying on the module-scoped fallback.

After PR #88312 the last remaining live caller path that still relied on the Onyx fallback was shareTrackedExpense (deferred at the time to keep that PR small). This PR threads reportActionsList through that path.

Threading

Chain: UI/hook → trackExpense → SHARE branch → shareTrackedExpensebuildAddMembersToWorkspaceOnyxDatacreatePolicyExpenseChats.

Changes:

  • Added reportActionsList?: OnyxCollection<OnyxTypes.ReportActions> to both TrackedExpenseParams and CreateTrackExpenseParams (each with a // TODO: Remove optional (?) comment pointing at [Due for payment 2026-05-29] Remove Onyx.connect() for the key: ONYXKEYS.COLLECTION.REPORT_ACTIONS in src/libs/actions/Policy/Policy.ts #66578).
  • shareTrackedExpense (TrackExpense.ts) now destructures reportActionsList from trackedExpenseParams and forwards it to buildAddMembersToWorkspaceOnyxData.
  • trackExpense (TrackExpense.ts) now forwards reportActionsList to the SHARE-branch TrackedExpenseParams it constructs (the CATEGORIZE branch does not call createPolicyExpenseChats, so it does not need it).
  • The only UI caller that actually reaches the SHARE branch — useExpenseSubmission.ts — now calls useAllPolicyExpenseChatReportActions() and passes the result through to trackExpense. Other trackExpense callers do not pass action: SHARE and never reach shareTrackedExpense, so they were not touched.
  • Retry path: the receipt-upload retry handler deserializes retryParams from a stored JSON string, so any reportActionsList baked into the original call would be stale at retry time. DotIndicatorMessage now calls useAllPolicyExpenseChatReportActions() and passes it down through handleRetryPress (both .ts and .android.ts) into handleFileRetry, which overwrites trackExpenseParams.reportActionsList with the fresh value before invoking TrackExpense.trackExpense(...).
  • Added a comment at the buildPolicyDatacreatePolicyExpenseChats call (Policy.ts:3019) explaining that the undefined reportActionsList argument is intentional dead code: buildPolicyData always uses a fresh policyID (generatePolicyID()), so the if (oldChat) branch — the sole reader of reportActionsList — is never entered. The only caller that passes adminParticipant (IOURequestStepUpgrade.tsx) also passes policyID: undefined, confirming the path is dead.
  • Added a unit test (TrackExpenseTest.ts) that:
    • Seeds an orphaned archived policy expense chat for the accountant + an archived nested expense report.
    • Builds a REPORT_PREVIEW action outside Onyx and supplies it via the explicit reportActionsList.
    • Calls trackExpense with action: SHARE and asserts both NVPs end up private_isArchived falsy — proving the explicit param wins over the deprecated Onyx.connect() fallback (which would not contain the preview action).

Deferred to the follow-up PR of #66578:

  • Once this lands, every live caller of createPolicyExpenseChats / buildAddMembersToWorkspaceOnyxData supplies reportActionsList. The final cleanup PR will make the parameter required, delete the ?? deprecatedAllReportActions fallback inside createPolicyExpenseChats, remove the Onyx.connect() block + deprecatedAllReportActions variable in Policy.ts, drop the // TODO: Remove optional (?) markers, and decrement the allowable Onyx.connect ESLint warning count in package.json.

Fixed Issues

$ #66578
PROPOSAL:

Tests

  1. Track an expense
  2. Verify that the flow is working well
  • Verify that no errors appear in the JS console

Offline tests

N/A - This is a refactoring change that does not affect offline behavior.

QA Steps

  1. Track an expense
  2. Verify that the flow is working well
  • 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 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

Screen.Recording.2026-05-12.at.17.28.36.mov

@DylanDylann DylanDylann requested review from a team as code owners May 12, 2026 09:07
@melvin-bot melvin-bot Bot requested a review from parasharrajat May 12, 2026 09:07
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 12, 2026

@parasharrajat 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 requested review from flaviadefaria and removed request for a team May 12, 2026 09:07
Comment thread src/components/DotIndicatorMessage.tsx Outdated
Comment thread src/components/DotIndicatorMessage.tsx Outdated
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: ab02cad531

ℹ️ 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/libs/actions/IOU/TrackExpense.ts
Comment thread src/components/DotIndicatorMessage.tsx Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented May 12, 2026

Codecov Report

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

Files with missing lines Coverage Δ
src/libs/actions/IOU/TrackExpense.ts 80.86% <100.00%> (ø)
src/libs/actions/Policy/Policy.ts 69.42% <ø> (ø)
src/libs/actions/Report/index.ts 69.63% <ø> (ø)
.../request/step/confirmation/useExpenseSubmission.ts 52.77% <100.00%> (+0.21%) ⬆️
... and 6 files with indirect coverage changes

@DylanDylann DylanDylann force-pushed the refactor-66578-shareTrackedExpense branch from ab02cad to 88ccf0f Compare May 12, 2026 09:49
Comment thread src/libs/actions/Policy/Policy.ts Outdated
makeMeAdmin?: boolean;
policyID?: string;
currency?: string;
currency: string;
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.

This is a safe change. I forgot to update it in the previous PR

@DylanDylann
Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Keep them coming!

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

@flaviadefaria flaviadefaria removed their request for review May 12, 2026 15:15
@flaviadefaria
Copy link
Copy Markdown
Contributor

No new product considerations - removing my assignment and unsubscribing.

Copy link
Copy Markdown
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

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.
16.05.2026_15.26.05_REC.mp4

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot Bot requested a review from Gonals May 16, 2026 09:57
@DylanDylann DylanDylann requested a review from a team as a code owner May 18, 2026 04:39
@github-actions
Copy link
Copy Markdown
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@DylanDylann DylanDylann marked this pull request as draft May 18, 2026 04:40
@DylanDylann DylanDylann force-pushed the refactor-66578-shareTrackedExpense branch from e1c7b8d to 88ccf0f Compare May 18, 2026 05:36
…TrackedExpense path

Threads reportActionsList through trackExpense -> shareTrackedExpense ->
buildAddMembersToWorkspaceOnyxData so the share-with-accountant flow uses the
explicit hook value from useAllPolicyExpenseChatReportActions() instead of the
module-scoped deprecatedAllReportActions cache.

- Added reportActionsList? to TrackedExpenseParams and CreateTrackExpenseParams
- shareTrackedExpense forwards it to buildAddMembersToWorkspaceOnyxData
- trackExpense forwards it to the SHARE-branch TrackedExpenseParams
- useExpenseSubmission supplies it from useAllPolicyExpenseChatReportActions()
- DotIndicatorMessage threads it through ReceiptUploadRetryHandler so the
  TRACK_EXPENSE retry path injects a fresh value (the deserialized retry
  params would otherwise carry a stale list)
- Added a unit test asserting the explicit param wins over the Onyx fallback
- Documented the dead-code undefined arg at the buildPolicyData ->
  createPolicyExpenseChats call site

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@DylanDylann DylanDylann force-pushed the refactor-66578-shareTrackedExpense branch from 88ccf0f to 9029a4c Compare May 18, 2026 05:54
@DylanDylann DylanDylann marked this pull request as ready for review May 18, 2026 05:56
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: 9029a4cd58

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

isSelfTourViewed,
defaultWorkspaceName: generateDefaultWorkspaceName(email, lastWorkspaceNumber, translate),
previousOdometerDraft: odometerDraft,
reportActionsList: policyExpenseChatReportActions,
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 the report-actions fallback until loaded

When this confirmation screen mounts before useAllPolicyExpenseChatReportActions() has received the report-actions collection, the hook returns {} rather than undefined; passing that empty object here makes createPolicyExpenseChats() choose the explicit empty map over its reportActionsList ?? deprecatedAllReportActions fallback. In the share-with-accountant path where the accountant is newly added but already has an archived policy expense chat, that skips the REPORT_PREVIEW actions and leaves the nested expense reports archived. Please pass undefined until the collection is actually loaded, or otherwise let the callee fall back.

Useful? React with 👍 / 👎.

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.

@DylanDylann, thoughts on this?

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.

This comment is about the function being triggered before the data is loaded. If that's a problem, using onyx.connect as before would also cause the same issue. However, I don't think we need to worry about this because the function needs to be triggered by user actions. Therefore, it shouldn't be executed during the initial phase when the data hasn't been loaded yet

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.

@Gonals Back to you

@Gonals Gonals merged commit add5f68 into Expensify:main May 20, 2026
50 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

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

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

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor

No help site changes are required for this PR.

This is a purely internal code refactoring that threads a reportActionsList parameter through internal function calls to deprecate a module-scoped Onyx.connect() cache. There are no user-facing behavior changes, no new features, and no UI changes — the help site docs under App/docs/articles do not need to be updated.

@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