[$250] Refactor `getPolicyExpenseReportOption()` to change `privateIsArchived` parameter to boolean

[tgolen]

coming from https://github.com/Expensify/App/pull/80209/changes#diff-010911fd56cd74ff46fd42cd2a137e01f8a050eaf4a038d837ffa3b5912a5607 cc @dukenv0307

Problem

There is a long chain of code that starts with getPolicyExpenseReportOption() accepting a string value for privateIsArchived. When you trace the code down through createOption(), you can see that privateIsArchived is always cast to a boolean by prepending the value with !!.

Solution

Update the code path for this value to be a boolean all the way from the view components (use the useReportIsArchived() hook) down to where the value is used.

Issue Owner

Current Issue Owner: @TaduJR

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~022031040957245803210
• Upwork Job ID: 2031040957245803210
• Last Price Increase: 2026-03-16

[melvin-bot]

Auto-assigning issues to engineers is no longer supported. If you think this issue should receive engineering attention, please raise it in #whatsnext.

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @QichenZhu (External)

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~022031040957245803210

[melvin-bot]

Triggered auto assignment to @joekaufmanexpensify (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[mukhrr]

🚨 Edited by proposal-police: This proposal was edited at 2026-03-12 17:06:55 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

When privateIsArchived flows through the options pipeline — from view components through getPolicyExpenseReportOption(), getReportOption(), getReportDisplayOption(), and createOption() — it is passed and stored as a string | undefined type. However, every downstream consumer immediately coerces it to boolean with !! (e.g., !!result.private_isArchived), which means the string representation carries no useful information beyond truthiness. Meanwhile, the useReportIsArchived() hook already exists and returns a clean boolean, but view components can't use it because the downstream chain expects a string.

What is the root cause of that problem?

The root cause is that private_isArchived is typed as string | undefined in the ReportNameValuePairs Onyx type, and this string type propagates unchecked through the entire options pipeline — from hooks, through utility functions, to option data types — without ever being converted to boolean at the boundary.

The useReportIsArchived() hook already correctly converts to boolean via isArchivedReport(), but view components like IOURequestStepDistance, SplitBillDetailsPage, etc. cannot use it because getPolicyExpenseReportOption() and the downstream functions (createOption(), getReportOption(), etc.) all accept string | undefined.

Similarly, usePrivateIsArchivedMap() returns Record<string, string | undefined> instead of booleans, forcing every consumer to double-bang the values.

What changes do you think we should make in order to solve the problem?

The approach is two-fold: (A) update the downstream pipeline to accept boolean, then (B) update view components to use useReportIsArchived() at the source.

A. Update the downstream pipeline to accept boolean:

1. Update OptionsListUtils/index.ts — Change privateIsArchived parameter types from string | undefined to boolean | undefined in createOption(), getReportOption(), getReportDisplayOption(), getPolicyExpenseReportOption(), processReport(), createOptionFromReport(), and formatSectionsFromSearchTerm().

 function createOption(
     ...
-    privateIsArchived?: string,
+    privateIsArchived?: boolean,
     ...

 function getReportOption(
     ...
-    privateIsArchived: string | undefined,
+    privateIsArchived: boolean | undefined,
     ...

 function getReportDisplayOption(
     ...
-    privateIsArchived: string | undefined,
+    privateIsArchived: boolean | undefined,
     ...

 function getPolicyExpenseReportOption(
     ...
-    privateIsArchived: string | undefined,
+    privateIsArchived: boolean | undefined,
     ...

 function processReport(
     ...
-    privateIsArchived: string | undefined,
+    privateIsArchived: boolean | undefined,
     ...

 function createOptionFromReport(
     ...
-    privateIsArchived: string | undefined,
+    privateIsArchived: boolean | undefined,
     ...

-    privateIsArchivedMap: Record<string, string | undefined>,
+    privateIsArchivedMap: Record<string, boolean>,

2. Override private_isArchived to boolean on OptionData in ReportUtils.ts — OptionData inherits private_isArchived: string from ReportNameValuePairs. Override it to boolean since the options pipeline always stores boolean.

 } & Report &
-    ReportNameValuePairs;
+    Omit<ReportNameValuePairs, 'private_isArchived'> & {
+        private_isArchived?: boolean;
+    };

3. Override private_isArchived to boolean on SearchOptionData in OptionsListUtils/types.ts.

     // Status properties
-    | 'private_isArchived'
     | 'lastVisibleActionCreated'
     ...
     | 'selected'
-> & {
+> & {
+    private_isArchived?: boolean;
+};

4. Update PersonalDetailOptionsListUtils types and function — Change private_isArchived and PrivateIsArchivedMap to boolean.

-    private_isArchived?: string;
+    private_isArchived?: boolean;
 ...
-type PrivateIsArchivedMap = Record<string, string | undefined>;
+type PrivateIsArchivedMap = Record<string, boolean>;
 ...
-    isReportArchived?: string,
+    isReportArchived?: boolean,

5. Update usePrivateIsArchivedMap() to return Record<string, boolean> — Convert to boolean at the source.

-type PrivateIsArchivedMap = Record<string, string | undefined>;
+type PrivateIsArchivedMap = Record<string, boolean>;
 ...
-            map[key] = value?.private_isArchived;
+            map[key] = !!value?.private_isArchived;

6. Update privateIsArchivedSelector to return boolean.

-const privateIsArchivedSelector = (reportNameValuePairs: OnyxEntry<ReportNameValuePairs>): string | undefined => reportNameValuePairs?.private_isArchived;
+const privateIsArchivedSelector = (reportNameValuePairs: OnyxEntry<ReportNameValuePairs>): boolean => !!reportNameValuePairs?.private_isArchived;

7. Update MoneyRequest.ts — Change privateIsArchived property types to boolean.

-    privateIsArchived?: string;
+    privateIsArchived?: boolean;
 ...
-    privateIsArchived?: string,
+    privateIsArchived?: boolean,

B. Update view components to use useReportIsArchived() hook:

8. Replace reportNameValuePairs?.private_isArchived with useReportIsArchived() in view components — These components currently subscribe to the full reportNameValuePairs NVP just to extract private_isArchived. Replace with the purpose-built hook. This also lets them drop the isArchivedReport(reportNameValuePairs) call since useReportIsArchived() returns the same boolean.

This affects:

• IOURequestStepDistance.tsx
• IOURequestStepDistanceGPS/index.native.tsx
• IOURequestStepDistanceMap.tsx
• IOURequestStepDistanceOdometer.tsx
• IOURequestStepDistanceManual.tsx
• useReceiptScan.ts

+import useReportIsArchived from '@hooks/useReportIsArchived';
 ...
-    const [reportNameValuePairs] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${report?.reportID}`);
-    const isArchived = isArchivedReport(reportNameValuePairs);
+    const isArchived = useReportIsArchived(report?.reportID);
 ...
-            privateIsArchived: !!reportNameValuePairs?.private_isArchived,
+            privateIsArchived: isArchived,

9. Update SplitBillDetailsPage.tsx — Same pattern: use useReportIsArchived() instead of useOnyx with privateIsArchivedSelector.

+import useReportIsArchived from '@hooks/useReportIsArchived';
 ...
-    const [privateIsArchived] = useOnyx(`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${reportID}`, {selector: privateIsArchivedSelector});
+    const privateIsArchived = useReportIsArchived(reportID);

10. Update usePersonalDetailOptions.ts — Convert to boolean in the filterRNVPs helper.

-                map[reportID] = value?.private_isArchived;
+                map[reportID] = !!value?.private_isArchived;

11. Update SidebarUtils.ts — Convert to boolean when assigning to result.private_isArchived.

-    result.private_isArchived = reportNameValuePairs?.private_isArchived;
+    result.private_isArchived = !!reportNameValuePairs?.private_isArchived;

12. Replace usePrivateIsArchivedMap() with useReportIsArchived() in components that only do single-report lookups — These components subscribe to the entire archived map but only look up one report. Replace with the lighter useReportIsArchived() hook:

• IOURequestStepAmount.tsx
• SubmitDetailsPage.tsx
• ShareDetailsPage.tsx
• SearchRouter.tsx

-import usePrivateIsArchivedMap from '@hooks/usePrivateIsArchivedMap';
+import useReportIsArchived from '@hooks/useReportIsArchived';
 ...
-    const privateIsArchivedMap = usePrivateIsArchivedMap();
-    const privateIsArchived = privateIsArchivedMap[`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${reportID}`];
+    const privateIsArchived = useReportIsArchived(reportID);

13. For components that need both the map and a single-report lookup, use useReportIsArchived() for the single lookup — These components pass the full map to formatSectionsFromSearchTerm() so usePrivateIsArchivedMap() must stay, but the single-report lookup should use useReportIsArchived() instead of indexing the map:

• MoneyRequestParticipantsSelector.tsx
• MoneyRequestAttendeeSelector.tsx
• MoneyRequestAccountantSelector.tsx

+import useReportIsArchived from '@hooks/useReportIsArchived';
 ...
+    const userToInviteIsArchived = useReportIsArchived(userToInviteExpenseReport?.reportID);
 ...
-    const privateIsArchived = privateIsArchivedMap[`${ONYXKEYS.COLLECTION.REPORT_NAME_VALUE_PAIRS}${userToInviteExpenseReport?.reportID}`];
     return isPolicyExpenseChat
-        ? getPolicyExpenseReportOption(participant, privateIsArchived, ...)
+        ? getPolicyExpenseReportOption(participant, userToInviteIsArchived, ...)