refactor: isolates buildOptimisticPolicyRecentlyUsedTags from Onyx.connect data by dariusz-biela · Pull Request #70393 · Expensify/App

dariusz-biela · 2025-09-11T13:19:07Z

Explanation of Change

This PR is part of a refactor to remove Onyx.connect from the ssrc/libs/actions/Policy/Tag.ts file and replace it with useOnyx.

It isolates the buildOptimisticPolicyRecentlyUsedTags function from the Onyx.connect data.

To ensure this refactor doesn't break anything, it adds automated tests to the buildOptimisticPolicyRecentlyUsedTags function.

Important

I've temporarily added a function, getPolicyRecentlyUsedTagsData, that returns data from Onyx.connect.

I created it to avoid refactoring functions that use buildOptimisticPolicyRecentlyUsedTags in this PR.

I've marked getPolicyRecentlyUsedTagsData as deprecated and added the comment // TODO: Replace getPolicyRecentlyUsedTagsData with useOnyx hook above each use.

Fixed Issues

This PR partially addresses these issues:
$ #69022
$ #69023
PROPOSAL:

Tests

Prerequisites:

User added to the workspace
Workspace with the Tags extension enabled
At least 8 tags added from the workspace

Log in
Disconnect the app from the internet
Add Expense with a tag that is not in the recent section
Add another Expense and check if the Tags screen in the recent section contains the tag you selected in the previous step.

Verify that no errors appear in the JS console

Offline tests

Same as in the Tests section

QA Steps

Same as in the Tests section

PR Author Checklist

Screenshots/Videos

Nagranie.z.ekranu.2025-09-12.o.12.45.05.mov

… data

tests/actions/Policy/BuildOptimisticPolicyRecentlyUsedTagsTest.ts

… to PolicyTagTest.ts

…issing"

…x-connect/1-src-libs-actions-Policy-Tag.ts

war-in · 2025-09-17T15:09:23Z

src/libs/actions/Policy/Tag.ts

+    transactionTags?: string;
+};
+
+function buildOptimisticPolicyRecentlyUsedTags({policyTags, policyRecentlyUsedTags, policyID, transactionTags}: BuildOptimisticPolicyRecentlyUsedTagsProps): RecentlyUsedTags {


I think we can get rid of policyID 👀

You're right. Good thing you noticed.

war-in · 2025-09-17T15:13:16Z

src/libs/actions/Policy/Tag.ts

+/**
+ * @deprecated This function uses Onyx.connect and should be replaced with useOnyx for reactive data access.
+ * All usages of this function should be replaced with useOnyx hook in React components.
+ */
+function getPolicyRecentlyUsedTagsData(policyID: string | undefined) {
+    return allRecentlyUsedTags?.[`${ONYXKEYS.COLLECTION.POLICY_RECENTLY_USED_TAGS}${policyID}`] ?? {};
+}


How about creating a follow-up PR now and merging it as soon as this one gets merged?

I'd prefer not to do this, as it falls under the responsibility of the person refactoring the src/libs/actions/IOU.ts file.

But I'll actually move the entire getPolicyRecentlyUsedTagsData implementation to src/libs/actions/IOU.ts to remove the completely invalid code from the src/libs/actions/Policy/Tag.ts file.

I don't think you are allowed to do that. If you are adding Onyx.connect somewhere, you need to remove that usage later.

cc @tgolen

I think that as long as it's part of the issue to remove it completely, and it's all part of trying to make smaller incremental steps to not break a bunch of things with a big refactor, then what @dariusz-biela is doing here is probably OK. Just as long as whoever is doing IOU.ts knows about it and @dariusz-biela is still going to do the work to remove the Onyx.connect() in the end.

@tgolen, I've commented this code:

// TODO: remove `allRecentlyUsedTags` from this file // `allRecentlyUsedTags` was moved here temporarily from `src/libs/actions/Policy/Tag.ts` during the `Deprecate Onyx.connect` refactor. // All uses of this variable should be replaced with `useOnyx`. let allRecentlyUsedTags: OnyxCollection<RecentlyUsedTags> = {}; Onyx.connect({ key: ONYXKEYS.COLLECTION.POLICY_RECENTLY_USED_TAGS, waitForCollectionCallback: true, callback: (val) => (allRecentlyUsedTags = val), });

Lately, I've had less time due to being involved in another project as part of Expensify. But I still plan to work on the src/libs/actions/Policy/Tag.ts and src/libs/actions/Transaction.ts files as part of the refactor, removing Onyx.connect.

I've found that it's most efficient to decouple one function at a time from Onyx.connect, regardless of how many Onyx.connects it has attached.

This allows me to focus on a single functionality in PRs and unit tests.

@tgolen, it might be worth adding an additional subissue to src/libs/actions/IOU.ts to remove ONYXKEYS.COLLECTION.POLICY_RECENTLY_USED_TAGS after merging this PR.

I've found that it's most efficient to decouple one function at a time from Onyx.connect, regardless of how many Onyx.connects it has attached.

Yep, I 100% agree with this! I'll get that issue created and assigned to you.

Here you go: #71491

war-in · 2025-09-17T15:16:24Z

tests/actions/PolicyTagTest.ts

+        it('should return empty object when policyID is undefined', () => {
+            const result = buildOptimisticPolicyRecentlyUsedTags({
+                policyTags: {},
+                policyRecentlyUsedTags: {},
+                policyID: undefined,
+                transactionTags: 'tag1',
+            });
+            expect(result).toEqual({});
+        });


Once we remove the policyID from the function we can get rid of this test

war-in · 2025-09-17T15:16:38Z

tests/actions/PolicyTagTest.ts

+            expect(result).toEqual({});
+        });
+
+        it('should return empty object when policyID is empty string', () => {


war-in · 2025-09-17T15:19:14Z

tests/actions/PolicyTagTest.ts

+            const existingRecentlyUsedTags: RecentlyUsedTags = {
+                [tagListName]: ['Marketing', 'Sales'],
+            };


I'd remove the const and create the object in the function call. There should be no confusion since arguments are named and the object is small

war-in · 2025-09-17T15:23:51Z

tests/actions/PolicyTagTest.ts

+            const policyTags: PolicyTagLists = {
+                Tag: {
+                    name: 'Tag',
+                    orderWeight: 0,
+                    required: false,
+                    tags: {
+                        Engineering: {name: 'Engineering', enabled: true},
+                        Marketing: {name: 'Marketing', enabled: true},
+                        Sales: {name: 'Sales', enabled: true},
+                    },
+                },
+            };


We use this one a few times. How about extracting it and creating once with some meaningful name?

war-in · 2025-09-17T15:25:43Z

src/libs/actions/Policy/Tag.ts

+    policyTags: PolicyTagLists;
+    policyRecentlyUsedTags: RecentlyUsedTags;


Shouldn't this function handle the missing values? So we don't have to ?? {} each time?

I'd honestly prefer to avoid this, as this function needs this data to function properly. They might be empty at times, but they should always be passed.

…from Marcin Warchol

…x-connect/1-src-libs-actions-Policy-Tag.ts

melvin-bot · 2025-09-18T12:21:35Z

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

src/libs/actions/IOU.ts

…x-connect/1-src-libs-actions-Policy-Tag.ts # Conflicts: # tests/actions/PolicyTagTest.ts

tgolen · 2025-09-25T23:25:45Z

Is this ready to review again @dariusz-biela ?

tgolen · 2025-09-26T14:47:18Z

bump please @dariusz-biela

dariusz-biela · 2025-09-27T15:05:06Z

@tgolen @shubham1206agra

It's now ready for further review.

I apologize for not responding. I've been writing documentation for the last two days, which is why I haven't been on GitHub.

tgolen · 2025-09-29T17:09:57Z

src/libs/actions/IOU.ts

-        const optimisticPolicyRecentlyUsedTags = buildOptimisticPolicyRecentlyUsedTags(iouReport?.policyID, transactionChanges.tag);
+        const optimisticPolicyRecentlyUsedTags = buildOptimisticPolicyRecentlyUsedTags({
+            policyTags: getPolicyTagsData(iouReport?.policyID),
+            // TODO: Replace getPolicyRecentlyUsedTagsData with useOnyx hook


For all these TODOs, can you please include a link to the GH that it will be removed with?

Bump @dariusz-biela

I will add link to this issue #66507

and write a comment there about it

I see that you created new issue #71491 for file src/libs/actions/Policy/Tag.ts

but this code it is not related to src/libs/actions/Policy/Tag.ts anymore, now it is in src/libs/actions/IOU.ts

@tgolen could you change the name of the issue to reflect that?

also I think that parent issue should be set to #66507

Additional context

In this PR, I moved this code to src/libs/actions/IOU.ts:

let allRecentlyUsedTags: OnyxCollection<RecentlyUsedTags> = {}; Onyx.connect({ key: ONYXKEYS.COLLECTION.POLICY_RECENTLY_USED_TAGS, waitForCollectionCallback: true, callback: (val) => (allRecentlyUsedTags = val), });

Because src/libs/actions/Policy/Tag.ts doesnt need this data.

I added a link like this to the issue you created:

// TODO: Replace getPolicyRecentlyUsedTagsData with useOnyx hook // (https://github.com/Expensify/App/issues/71491)

OK, thanks! I made the adjustments.

tgolen · 2025-10-01T14:33:14Z

There is a newer version of the checklist that you'll need to update the PR description with in order to get the tests to pass.

shubham1206agra · 2025-10-01T15:35:34Z

Let me do the review now.

tgolen · 2025-10-04T02:13:19Z

@shubham1206agra this is waiting on you for review

shubham1206agra · 2025-10-06T13:15:35Z

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
- MacOS: Desktop
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 there are no new alerts related to the canBeMissing param for useOnyx
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
xIf 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

Screen.Recording.2025-10-06.at.6.03.35.PM.mov

OSBotify · 2025-10-06T15:05:55Z

✋ 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 · 2025-10-06T20:11:16Z

🚀 Deployed to staging by https://github.com/tgolen in version: 9.2.24-0 🚀

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

OSBotify · 2025-10-07T15:18:38Z

🚀 Deployed to staging by https://github.com/tgolen in version: 9.2.26-0 🚀

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

OSBotify · 2025-10-08T04:50:09Z

🚀 Deployed to production by https://github.com/lakchote in version: 9.2.26-7 🚀

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

refactor: cut buildOptimisticPolicyRecentlyUsedTags from Onyx.connect…

f2937ee

… data

melvin-bot bot assigned dariusz-biela Sep 11, 2025

dariusz-biela commented Sep 11, 2025

View reviewed changes

tests/actions/Policy/BuildOptimisticPolicyRecentlyUsedTagsTest.ts Outdated Show resolved Hide resolved

dariusz-biela added 6 commits September 11, 2025 16:40

refactor: move test from BuildOptimisticPolicyRecentlyUsedTagsTest.ts…

bb4d8c5

… to PolicyTagTest.ts

fix: fix eslint error useOnyx() calls require you to pass the "canBeM…

aac1e64

…issing"

fix: fix eslint error Do not default string IDs to any value

e01e540

fix: fix eslint error 'getPolicyRecentlyUsedTagsData' is deprecated.

a2de818

Merge branch 'main' into dariusz-biela/refactor/useonyx-deprecate-ony…

7b56ce5

…x-connect/1-src-libs-actions-Policy-Tag.ts

refactor: changes custom tag name in test to default "Tag"

6446fae

war-in reviewed Sep 17, 2025

View reviewed changes

dariusz-biela added 2 commits September 18, 2025 13:38

refactor: buildOptimisticPolicyRecentlyUsedTags based on PR comments …

038c278

…from Marcin Warchol

refactor: moves getPolicyRecentlyUsedTagsData to src/libs/actions/IOU.ts

eb1507f

war-in approved these changes Sep 18, 2025

View reviewed changes

Merge branch 'main' into dariusz-biela/refactor/useonyx-deprecate-ony…

f47e6f3

…x-connect/1-src-libs-actions-Policy-Tag.ts

dariusz-biela marked this pull request as ready for review September 18, 2025 12:21

dariusz-biela requested a review from a team as a code owner September 18, 2025 12:21

melvin-bot bot requested review from shubham1206agra and removed request for a team September 18, 2025 12:21

shubham1206agra reviewed Sep 19, 2025

View reviewed changes

src/libs/actions/IOU.ts Show resolved Hide resolved

dariusz-biela added 2 commits September 23, 2025 17:00

refactor: adds comment to allRecentlyUsedTags in src/libs/actions/IOU.ts

28a14df

Merge branch 'main' into dariusz-biela/refactor/useonyx-deprecate-ony…

cdff516

…x-connect/1-src-libs-actions-Policy-Tag.ts # Conflicts: # tests/actions/PolicyTagTest.ts

dariusz-biela requested review from shubham1206agra and tgolen September 27, 2025 15:05

tgolen requested changes Sep 29, 2025

View reviewed changes

chore: add issue link to todos in IOU.ts

e8b27ea

dariusz-biela requested a review from tgolen September 30, 2025 20:38

tgolen approved these changes Oct 1, 2025

View reviewed changes

shubham1206agra approved these changes Oct 6, 2025

View reviewed changes

melvin-bot bot requested a review from tgolen October 6, 2025 13:17

tgolen approved these changes Oct 6, 2025

View reviewed changes

tgolen merged commit 69a7673 into Expensify:main Oct 6, 2025
22 of 26 checks passed

OSBotify mentioned this pull request Oct 6, 2025

Deploy Checklist: New Expensify 2025-10-06 #71926

Closed

73 tasks

Skalakid mentioned this pull request Oct 15, 2025

refactor: move getPolicyTagsData to IOU and Transaction files #72678

Merged

54 tasks

		policyTags: PolicyTagLists;
		policyRecentlyUsedTags: RecentlyUsedTags;

Conversation

dariusz-biela commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Important

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Sep 18, 2025

Uh oh!

Uh oh!

tgolen commented Sep 25, 2025

Uh oh!

tgolen commented Sep 26, 2025

Uh oh!

dariusz-biela commented Sep 27, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Additional context

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tgolen commented Oct 1, 2025

Uh oh!

shubham1206agra commented Oct 1, 2025

Uh oh!

tgolen commented Oct 4, 2025

Uh oh!

shubham1206agra commented Oct 6, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

Uh oh!

OSBotify commented Oct 6, 2025

Uh oh!

OSBotify commented Oct 6, 2025

Uh oh!

dariusz-biela commented Sep 11, 2025 •

edited

Loading