Remove Onyx.connect() usage for ONYXKEYS.COLLECTION.POLICY_TAGS in createDistanceRequest function from src/libs/actions/IOU/Split.ts#90353
Conversation
Guccio163
changed the title
Codecov Report✅ Changes either increased or maintained existing code coverage, great job!
|
melvin-bot
Bot
requested review from
joekaufmanexpensify and
parasharrajat
and removed request for
a team
|
@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] |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| const hasViolations = hasViolationsReportUtils(report?.reportID, transactionViolations, currentUserPersonalDetails.accountID, currentUserPersonalDetails.login ?? ''); | ||
|
|
||
| // Policy-scoped Onyx data | ||
| const policyID = policy?.id; |
There was a problem hiding this comment.
❌ PERF-11 (docs)
useOnyx(ONYXKEYS.COLLECTION.POLICY_TAGS) subscribes to the entire policy tags collection, causing re-renders whenever any policy's tags change. However, only a single entry is accessed (allPolicyTags?.[key]). Use a targeted useOnyx call with the specific policy key instead, e.g., useOnyx(\${ONYXKEYS.COLLECTION.POLICY_TAGS}${iouReportPolicyID}`). If iouReportPolicyID` is not yet known at hook call time, consider restructuring so the lookup can use a specific key.
Reviewed at: c040501 | Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.
| const reportTransactions = useReportTransactions(report?.reportID); | ||
| const isMoneyRequestReport = isMoneyRequestReportReportUtils(report); | ||
| const currentChatReport = isMoneyRequestReport ? getReportOrDraftReport(report?.chatReportID) : report; | ||
| const moneyRequestReportID = isMoneyRequestReport ? report?.reportID : ''; |
There was a problem hiding this comment.
❌ PERF-11 (docs)
useOnyx(ONYXKEYS.COLLECTION.REPORT) subscribes to the entire reports collection without a selector. The reports collection can be very large, and this will re-render the component on every report change. The only usage is allReports?.[key]?.policyID to get a single report's policyID. Use a targeted useOnyx with the specific report key, or if the key depends on runtime values, use a selector that extracts only the needed policyID.
Reviewed at: c040501 | Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.
|
No product review needed |
| // Policy-scoped Onyx data | ||
| const policyID = policy?.id; | ||
| const [policyTags] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`); | ||
| const [allPolicyTags] = useOnyx(ONYXKEYS.COLLECTION.POLICY_TAGS); |
There was a problem hiding this comment.
Not really a good Idea to subscribe to the whole collection. Can you only subscribe to the necessary child? Please update all other subscriptions that you have added.
|
Add a single line comment for deprecated rules. |
…-fork into Guccio163/onyx-connect/policy_tags/createDistanceRequest
|
I used participants that were already being passed to the useExpenseSubmissions to extract selectedParticipants - it's the same value as used for onConfirm when it's called (and hence all the functions inside), so I also adjusted all Also it looks like the same problem surfaced in this PR, so these changes should solve both problems 😄 |
…-fork into Guccio163/onyx-connect/policy_tags/createDistanceRequest
…-fork into Guccio163/onyx-connect/policy_tags/createDistanceRequest
…-fork into Guccio163/onyx-connect/policy_tags/createDistanceRequest
…-fork into Guccio163/onyx-connect/policy_tags/createDistanceRequest
parasharrajat
left a comment
parasharrajat
left a comment
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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.
toggleReportand notonIconClick). - 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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
Designlabel and/or tagged@Expensify/designso the design team can review the changes.
- If a new page is added, I verified it's using the
ScrollViewcomponent 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
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
01.06.2026_16.20.37_REC.mp4
🎀 👀 🎀 C+ reviewed
amyevans
left a comment
amyevans
left a comment
There was a problem hiding this comment.
@Guccio163 there are conflicts to resolve please! Otherwise looking good though
|
Bump on the conflict resolution ^ |
…-fork into Guccio163/onyx-connect/policy_tags/createDistanceRequest
|
@amyevans conflicts resolved, please take a look if everything's still fine 👀 |
|
🚧 @amyevans has triggered a test Expensify/App build. You can view the workflow run here. |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
|
|
🚀 Deployed to staging by https://github.com/amyevans in version: 9.4.0-0 🚀
Bundle Size Analysis (Sentry): |
|
🤖 No help site changes required. I reviewed the changes in this PR against the help site articles under This is an internal code refactor — part of the
None of this alters user-facing behavior: distance expense creation, tag selection/application, and duplicate detection all work exactly as before — only the mechanism for retrieving the policy tag list internally changed. There are no new or changed feature names, tabs, settings labels, or buttons, so no draft PR is being created. If you believe a specific documented flow is affected, reply with the article and I'll take another look. |
|
🚀 Deployed to production by https://github.com/Julesssss in version: 9.4.0-7 🚀
|
6 participants
Explanation of Change
This PR is part of a refactor to remove Onyx.connect for the keys: ONYXKEYS.COLLECTION.POLICY_TAGS from the src/libs/actions/IOU/Split.ts file and replace it with useOnyx.
It isolates the
createDistanceRequestfunction from the ONYXKEYS.COLLECTION.POLICY_TAGS Onyx.connect key .Fixed Issues
$ #72721
PROPOSAL:
Tests
Preconditions (all scenarios)
Tags) with valuesTag 1,Tag 2,Tag 3.Tag 2.1,Tag 2.2,Tag 2.3.Scenario 1 — Create distance expense in a Workspace A expense chat
Expected result:
Tag 1,Tag 2,Tag 3).Tag 2.1,Tag 2.2,Tag 2.3) are not shown.Tag 1→ tap Save → back on confirmation tap Submit.Expected result:
Tag 1applied.Scenario 2 — Add a distance expense to an existing expense report (different chat)
open expense report exists with Workspace A policy. Note the
report.
report header → Add expense → Distance.
Expected result:
Tag 1,Tag 2,Tag 3),matching the existing expense report's policy.
Tag 2→ Save → Submit.Expected result:
Tag 2applied.Scenario 3 — Duplicate a distance expense (Duplicate.ts path)
Setup: In Workspace A, create two distance expenses with the same
amount and date so the app treats them as duplicates. Both expenses
must have a tag from Workspace A applied (e.g.,
Tag 1) — this isrequired because
Duplicate.tspasses the resolvedpolicyTagList(the policy's available tag set) to the new distance request, so
without tags on the originals there is nothing observable to verify.
Open the report preview that shows the Duplicates detected banner.
expense.
detail).
the duplicate decision (this triggers
Duplicate.ts→createExpenseByTypewithtransactionType: DISTANCE).Expected result:
Tag 1from theoriginal expense (i.e., the policy tag list resolves to Workspace
A — same as the existing IOU report — so the applied tag survives
validation).
list (
Tag 1,Tag 2,Tag 3).Offline tests
QA Steps
Same as tests
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))npm run compress-svg)Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
Scenario 1
s1.mov
Scenario 2
s2.mov
Scenario 3
s3.mov