From 2b2ba6dd38ded38c6db30acabf7e3476f03bd714 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Ska=C5=82ka?= Date: Mon, 13 Oct 2025 13:13:55 +0200 Subject: [PATCH 1/5] refactor: isolate setPolicyTagsRequired from Onyx.connect data --- src/libs/actions/Policy/Tag.ts | 11 +- .../workspace/tags/WorkspaceTagsPage.tsx | 2 +- .../workspace/tags/WorkspaceViewTagsPage.tsx | 4 +- tests/actions/PolicyTagTest.ts | 169 ++++++++++++++++++ 4 files changed, 181 insertions(+), 5 deletions(-) diff --git a/src/libs/actions/Policy/Tag.ts b/src/libs/actions/Policy/Tag.ts index 69171310f946..ae47701df11c 100644 --- a/src/libs/actions/Policy/Tag.ts +++ b/src/libs/actions/Policy/Tag.ts @@ -963,8 +963,15 @@ function setPolicyRequiresTag(policyID: string, requiresTag: boolean) { API.write(WRITE_COMMANDS.SET_POLICY_REQUIRES_TAG, parameters, onyxData); } -function setPolicyTagsRequired(policyID: string, requiresTag: boolean, tagListIndex: number) { - const policyTag = PolicyUtils.getTagLists(allPolicyTags?.[`${ONYXKEYS.COLLECTION.POLICY_TAGS}${policyID}`] ?? {})?.at(tagListIndex); +type SetPolicyTagsRequiredProps = { + policyID: string; + requiresTag: boolean; + tagListIndex: number; + policyTags: OnyxEntry; +}; + +function setPolicyTagsRequired({policyID, requiresTag, tagListIndex, policyTags}: SetPolicyTagsRequiredProps) { + const policyTag = PolicyUtils.getTagLists(policyTags ?? {})?.at(tagListIndex); if (!policyTag) { return; diff --git a/src/pages/workspace/tags/WorkspaceTagsPage.tsx b/src/pages/workspace/tags/WorkspaceTagsPage.tsx index 43f4c0cc5832..37cbc474c585 100644 --- a/src/pages/workspace/tags/WorkspaceTagsPage.tsx +++ b/src/pages/workspace/tags/WorkspaceTagsPage.tsx @@ -209,7 +209,7 @@ function WorkspaceTagsPage({route}: WorkspaceTagsPageProps) { const updateWorkspaceRequiresTag = useCallback( (value: boolean, orderWeight: number) => { - setPolicyTagsRequired(policyID, value, orderWeight); + setPolicyTagsRequired({policyID, requiresTag: value, tagListIndex: orderWeight, policyTags}); }, [policyID], ); diff --git a/src/pages/workspace/tags/WorkspaceViewTagsPage.tsx b/src/pages/workspace/tags/WorkspaceViewTagsPage.tsx index cad3d7f11255..527563bcbc09 100644 --- a/src/pages/workspace/tags/WorkspaceViewTagsPage.tsx +++ b/src/pages/workspace/tags/WorkspaceViewTagsPage.tsx @@ -315,7 +315,7 @@ function WorkspaceViewTagsPage({route}: WorkspaceViewTagsProps) { }; if (!!currentPolicyTag?.required && !Object.values(currentPolicyTag?.tags ?? {}).some((tag) => tag.enabled)) { - setPolicyTagsRequired(policyID, false, route.params.orderWeight); + setPolicyTagsRequired({policyID, requiresTag: false, tagListIndex: route.params.orderWeight, policyTags}); } const navigateToEditTag = () => { @@ -375,7 +375,7 @@ function WorkspaceViewTagsPage({route}: WorkspaceViewTagsProps) { return; } - setPolicyTagsRequired(policyID, on, route.params.orderWeight); + setPolicyTagsRequired({policyID, requiresTag: on, tagListIndex: route.params.orderWeight, policyTags}); }} pendingAction={currentPolicyTag.pendingFields?.required} errors={currentPolicyTag?.errorFields?.required ?? undefined} diff --git a/tests/actions/PolicyTagTest.ts b/tests/actions/PolicyTagTest.ts index d1aac4939607..14f645e7eeb4 100644 --- a/tests/actions/PolicyTagTest.ts +++ b/tests/actions/PolicyTagTest.ts @@ -12,6 +12,7 @@ import { renamePolicyTag, renamePolicyTagList, setPolicyRequiresTag, + setPolicyTagsRequired, setWorkspaceTagEnabled, } from '@libs/actions/Policy/Tag'; import CONST from '@src/CONST'; @@ -1382,4 +1383,172 @@ describe('actions/Policy', () => { }); }); }); + + describe('SetPolicyTagsRequired', () => { + it('should set tag list as required when requiresTag is true', async () => { + // Given a policy with a tag list that is not required + const fakePolicy = createRandomPolicy(0); + const tagListName = 'Test Tag List'; + const fakePolicyTags = createRandomPolicyTags(tagListName, 2); + + fakePolicyTags[tagListName] = { + ...fakePolicyTags[tagListName], + required: false, + orderWeight: 0, + }; + + mockFetch?.pause?.(); + + await Onyx.set(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, fakePolicyTags); + + // When setPolicyTagsRequired is called with requiresTag = true + setPolicyTagsRequired({policyID: fakePolicy.id, requiresTag: true, tagListIndex: 0, policyTags: fakePolicyTags}); + await waitForBatchedUpdates(); + + // Then the tag list should be marked as required with pending fields + let updatedPolicyTags: PolicyTagLists | undefined; + await TestHelper.getOnyxData({ + key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, + callback: (val) => (updatedPolicyTags = val), + }); + + expect(updatedPolicyTags?.[tagListName]?.required).toBe(true); + // Check optimistic data - pendingFields should be set + if (updatedPolicyTags?.[tagListName]?.pendingFields?.required) { + expect(updatedPolicyTags[tagListName].pendingFields.required).toBe(CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE); + } + + await mockFetch?.resume?.(); + await waitForBatchedUpdates(); + + // Then after API success, pending fields should be cleared + await TestHelper.getOnyxData({ + key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, + callback: (val) => (updatedPolicyTags = val), + }); + + expect(updatedPolicyTags?.[tagListName]?.required).toBe(true); + expect(updatedPolicyTags?.[tagListName]?.pendingFields?.required).toBeUndefined(); + }); + + it('should set tag list as not required when requiresTag is false', async () => { + // Given a policy with a tag list that is required + const fakePolicy = createRandomPolicy(0); + const tagListName = 'Test Tag List'; + const fakePolicyTags = createRandomPolicyTags(tagListName, 2); + + fakePolicyTags[tagListName] = { + ...fakePolicyTags[tagListName], + required: true, + orderWeight: 0, + }; + + mockFetch?.pause?.(); + + await Onyx.set(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, fakePolicyTags); + + // When setPolicyTagsRequired is called with requiresTag = false + setPolicyTagsRequired({policyID: fakePolicy.id, requiresTag: false, tagListIndex: 0, policyTags: fakePolicyTags}); + await waitForBatchedUpdates(); + + // Then the tag list should be marked as not required with pending fields + let updatedPolicyTags: PolicyTagLists | undefined; + await TestHelper.getOnyxData({ + key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, + callback: (val) => (updatedPolicyTags = val), + }); + + expect(updatedPolicyTags?.[tagListName]?.required).toBe(false); + // Check optimistic data - pendingFields should be set + if (updatedPolicyTags?.[tagListName]?.pendingFields?.required) { + expect(updatedPolicyTags[tagListName].pendingFields.required).toBe(CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE); + } + + await mockFetch?.resume?.(); + await waitForBatchedUpdates(); + + // Then after API success, pending fields should be cleared + await TestHelper.getOnyxData({ + key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, + callback: (val) => (updatedPolicyTags = val), + }); + + expect(updatedPolicyTags?.[tagListName]?.required).toBe(false); + expect(updatedPolicyTags?.[tagListName]?.pendingFields?.required).toBeUndefined(); + }); + + it('should handle API failure and restore original state with error', async () => { + // Given a policy with a tag list that is not required + const fakePolicy = createRandomPolicy(0); + const tagListName = 'Test Tag List'; + const fakePolicyTags = createRandomPolicyTags(tagListName, 2); + + fakePolicyTags[tagListName] = { + ...fakePolicyTags[tagListName], + required: false, + orderWeight: 0, + }; + + mockFetch?.pause?.(); + + await Onyx.set(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, fakePolicyTags); + + // When setPolicyTagsRequired is called and API fails + mockFetch?.fail?.(); + setPolicyTagsRequired({policyID: fakePolicy.id, requiresTag: true, tagListIndex: 0, policyTags: fakePolicyTags}); + await waitForBatchedUpdates(); + + await mockFetch?.resume?.(); + await waitForBatchedUpdates(); + + // Then the tag list should be restored to original state with error + let updatedPolicyTags: PolicyTagLists | undefined; + await TestHelper.getOnyxData({ + key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, + callback: (val) => (updatedPolicyTags = val), + }); + + expect(updatedPolicyTags?.[tagListName]?.required).toBe(false); + expect(updatedPolicyTags?.[tagListName]?.pendingFields?.required).toBeUndefined(); + expect(updatedPolicyTags?.[tagListName]?.errorFields?.required).toBeTruthy(); + }); + + it('should work with data from useOnyx hook', async () => { + // Given a policy with a tag list that is not required + const fakePolicy = createRandomPolicy(0); + const tagListName = 'Test Tag List'; + const fakePolicyTags = createRandomPolicyTags(tagListName, 2); + + fakePolicyTags[tagListName] = { + ...fakePolicyTags[tagListName], + required: false, + orderWeight: 0, + }; + + await Onyx.set(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, fakePolicyTags); + + const {result} = renderHook(() => useOnyx(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`)); + + await waitFor(() => { + expect(result.current[0]).toBeDefined(); + }); + + // When setPolicyTagsRequired is called with data from useOnyx + setPolicyTagsRequired({policyID: fakePolicy.id, requiresTag: true, tagListIndex: 0, policyTags: result.current[0]}); + await waitForBatchedUpdates(); + + // Then the tag list should be marked as required + let updatedPolicyTags: PolicyTagLists | undefined; + await TestHelper.getOnyxData({ + key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, + callback: (val) => (updatedPolicyTags = val), + }); + + expect(updatedPolicyTags?.[tagListName]?.required).toBe(true); + // Check optimistic data - pendingFields should be set + if (updatedPolicyTags?.[tagListName]?.pendingFields?.required) { + expect(updatedPolicyTags[tagListName].pendingFields.required).toBe(CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE); + } + }); + }); }); From 42dbaebdcd5355f3ed86943a0994ff44658e710a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Ska=C5=82ka?= Date: Mon, 13 Oct 2025 13:26:07 +0200 Subject: [PATCH 2/5] fix: add policyTags to dependency array --- src/pages/workspace/tags/WorkspaceTagsPage.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/workspace/tags/WorkspaceTagsPage.tsx b/src/pages/workspace/tags/WorkspaceTagsPage.tsx index 37cbc474c585..16527e118327 100644 --- a/src/pages/workspace/tags/WorkspaceTagsPage.tsx +++ b/src/pages/workspace/tags/WorkspaceTagsPage.tsx @@ -211,7 +211,7 @@ function WorkspaceTagsPage({route}: WorkspaceTagsPageProps) { (value: boolean, orderWeight: number) => { setPolicyTagsRequired({policyID, requiresTag: value, tagListIndex: orderWeight, policyTags}); }, - [policyID], + [policyID, policyTags], ); const tagList = useMemo(() => { From 0eaa0a2e8da9d5dc9dfe99e1b05d316103d0ebc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Ska=C5=82ka?= Date: Mon, 13 Oct 2025 13:28:55 +0200 Subject: [PATCH 3/5] chore: fix early return --- src/libs/actions/Policy/Tag.ts | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/src/libs/actions/Policy/Tag.ts b/src/libs/actions/Policy/Tag.ts index ae47701df11c..d083760532ab 100644 --- a/src/libs/actions/Policy/Tag.ts +++ b/src/libs/actions/Policy/Tag.ts @@ -972,12 +972,7 @@ type SetPolicyTagsRequiredProps = { function setPolicyTagsRequired({policyID, requiresTag, tagListIndex, policyTags}: SetPolicyTagsRequiredProps) { const policyTag = PolicyUtils.getTagLists(policyTags ?? {})?.at(tagListIndex); - - if (!policyTag) { - return; - } - - if (!policyTag.name) { + if (!policyTag?.name) { return; } From 7781f7141ff2a8aa3d060dbeea204bc1ba42419c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Ska=C5=82ka?= Date: Tue, 14 Oct 2025 16:01:00 +0200 Subject: [PATCH 4/5] refactor: add review cahnges --- tests/actions/PolicyTagTest.ts | 56 +++++++++++----------------------- 1 file changed, 18 insertions(+), 38 deletions(-) diff --git a/tests/actions/PolicyTagTest.ts b/tests/actions/PolicyTagTest.ts index 14f645e7eeb4..4769bed06fbf 100644 --- a/tests/actions/PolicyTagTest.ts +++ b/tests/actions/PolicyTagTest.ts @@ -1,4 +1,4 @@ -import {renderHook, waitFor} from '@testing-library/react-native'; +import {act, renderHook, waitFor} from '@testing-library/react-native'; import Onyx from 'react-native-onyx'; import OnyxUtils from 'react-native-onyx/dist/OnyxUtils'; import useOnyx from '@hooks/useOnyx'; @@ -1397,7 +1397,7 @@ describe('actions/Policy', () => { orderWeight: 0, }; - mockFetch?.pause?.(); + mockFetch.pause(); await Onyx.set(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, fakePolicyTags); @@ -1406,11 +1406,7 @@ describe('actions/Policy', () => { await waitForBatchedUpdates(); // Then the tag list should be marked as required with pending fields - let updatedPolicyTags: PolicyTagLists | undefined; - await TestHelper.getOnyxData({ - key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, - callback: (val) => (updatedPolicyTags = val), - }); + let updatedPolicyTags = await OnyxUtils.get(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`); expect(updatedPolicyTags?.[tagListName]?.required).toBe(true); // Check optimistic data - pendingFields should be set @@ -1418,14 +1414,11 @@ describe('actions/Policy', () => { expect(updatedPolicyTags[tagListName].pendingFields.required).toBe(CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE); } - await mockFetch?.resume?.(); + mockFetch.resume(); await waitForBatchedUpdates(); // Then after API success, pending fields should be cleared - await TestHelper.getOnyxData({ - key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, - callback: (val) => (updatedPolicyTags = val), - }); + updatedPolicyTags = await OnyxUtils.get(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`); expect(updatedPolicyTags?.[tagListName]?.required).toBe(true); expect(updatedPolicyTags?.[tagListName]?.pendingFields?.required).toBeUndefined(); @@ -1443,7 +1436,7 @@ describe('actions/Policy', () => { orderWeight: 0, }; - mockFetch?.pause?.(); + mockFetch.pause(); await Onyx.set(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, fakePolicyTags); @@ -1452,11 +1445,7 @@ describe('actions/Policy', () => { await waitForBatchedUpdates(); // Then the tag list should be marked as not required with pending fields - let updatedPolicyTags: PolicyTagLists | undefined; - await TestHelper.getOnyxData({ - key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, - callback: (val) => (updatedPolicyTags = val), - }); + let updatedPolicyTags = await OnyxUtils.get(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`); expect(updatedPolicyTags?.[tagListName]?.required).toBe(false); // Check optimistic data - pendingFields should be set @@ -1464,14 +1453,11 @@ describe('actions/Policy', () => { expect(updatedPolicyTags[tagListName].pendingFields.required).toBe(CONST.RED_BRICK_ROAD_PENDING_ACTION.UPDATE); } - await mockFetch?.resume?.(); + mockFetch.resume(); await waitForBatchedUpdates(); // Then after API success, pending fields should be cleared - await TestHelper.getOnyxData({ - key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, - callback: (val) => (updatedPolicyTags = val), - }); + updatedPolicyTags = await OnyxUtils.get(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`); expect(updatedPolicyTags?.[tagListName]?.required).toBe(false); expect(updatedPolicyTags?.[tagListName]?.pendingFields?.required).toBeUndefined(); @@ -1489,7 +1475,7 @@ describe('actions/Policy', () => { orderWeight: 0, }; - mockFetch?.pause?.(); + mockFetch.pause(); await Onyx.set(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, fakePolicyTags); @@ -1498,15 +1484,11 @@ describe('actions/Policy', () => { setPolicyTagsRequired({policyID: fakePolicy.id, requiresTag: true, tagListIndex: 0, policyTags: fakePolicyTags}); await waitForBatchedUpdates(); - await mockFetch?.resume?.(); + mockFetch.resume(); await waitForBatchedUpdates(); // Then the tag list should be restored to original state with error - let updatedPolicyTags: PolicyTagLists | undefined; - await TestHelper.getOnyxData({ - key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, - callback: (val) => (updatedPolicyTags = val), - }); + const updatedPolicyTags = await OnyxUtils.get(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`); expect(updatedPolicyTags?.[tagListName]?.required).toBe(false); expect(updatedPolicyTags?.[tagListName]?.pendingFields?.required).toBeUndefined(); @@ -1533,16 +1515,14 @@ describe('actions/Policy', () => { expect(result.current[0]).toBeDefined(); }); - // When setPolicyTagsRequired is called with data from useOnyx - setPolicyTagsRequired({policyID: fakePolicy.id, requiresTag: true, tagListIndex: 0, policyTags: result.current[0]}); - await waitForBatchedUpdates(); + await act(async () => { + // When setPolicyTagsRequired is called with data from useOnyx + setPolicyTagsRequired({policyID: fakePolicy.id, requiresTag: true, tagListIndex: 0, policyTags: result.current[0]}); + await waitForBatchedUpdates(); + }); // Then the tag list should be marked as required - let updatedPolicyTags: PolicyTagLists | undefined; - await TestHelper.getOnyxData({ - key: `${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, - callback: (val) => (updatedPolicyTags = val), - }); + const updatedPolicyTags = await OnyxUtils.get(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`); expect(updatedPolicyTags?.[tagListName]?.required).toBe(true); // Check optimistic data - pendingFields should be set From 9402b86abe1779165f4e1d7f67172388ebff42fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Ska=C5=82ka?= Date: Wed, 15 Oct 2025 08:23:45 +0200 Subject: [PATCH 5/5] refactor: remove optional chaining --- tests/actions/PolicyTagTest.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/actions/PolicyTagTest.ts b/tests/actions/PolicyTagTest.ts index 4769bed06fbf..904690b06d0f 100644 --- a/tests/actions/PolicyTagTest.ts +++ b/tests/actions/PolicyTagTest.ts @@ -1480,7 +1480,7 @@ describe('actions/Policy', () => { await Onyx.set(`${ONYXKEYS.COLLECTION.POLICY_TAGS}${fakePolicy.id}`, fakePolicyTags); // When setPolicyTagsRequired is called and API fails - mockFetch?.fail?.(); + mockFetch.fail(); setPolicyTagsRequired({policyID: fakePolicy.id, requiresTag: true, tagListIndex: 0, policyTags: fakePolicyTags}); await waitForBatchedUpdates();