Check CAD eligibility across mixed selections

Author: dukenv0307

src/hooks/useSearchBulkActions.ts

@@ -535,9 +535,10 @@ function useSearchBulkActions({queryJSON}: UseSearchBulkActionsParams) {
         [selectedTransactions],
     );
 
-    // A bulk selection can span several workspaces, so the Canadian Multiple Tax Export template is only offered when every selected item belongs to a workspace that outputs in CAD
+    // A bulk selection can span several workspaces, so the Canadian Multiple Tax Export template is only offered when every selected item belongs to a workspace that outputs in CAD.
+    // Reports and transactions are both checked because a selection can mix whole reports with individual transactions from other reports, and the export request covers all of them.
     const doAllSelectedItemsBelongToCADPolicies = useMemo(() => {
-        const selectedItems = selectedReports.length > 0 ? selectedReports : Object.values(selectedTransactions);
+        const selectedItems = [...selectedReports, ...Object.values(selectedTransactions)];
         if (selectedItems.length === 0) {
             return false;
         }

tests/unit/SearchActionsTest.ts

@@ -9,6 +9,7 @@ import ONYXKEYS from '@src/ONYXKEYS';
 import type {ExportTemplate, Policy} from '@src/types/onyx';
 import type {AnyOnyxUpdate} from '@src/types/onyx/Request';
 
+import createRandomPolicy from '../utils/collections/policies';
 import {translateLocal} from '../utils/TestHelper';
 
 jest.mock('@libs/API');
@@ -219,6 +220,7 @@ describe('getExportTemplates', () => {
     const translate = translateLocal;
     const localeCompare = (first: string, second: string) => first.localeCompare(second);
     const makeTemplate = (name: string): ExportTemplate => ({name, templateName: name, type: '', policyID: undefined, description: ''});
+    const makePolicyWithOutputCurrency = (outputCurrency: string): Policy => ({...createRandomPolicy(1), outputCurrency});
 
     it('returns the custom templates and the default templates as separate groups, each sorted alphabetically', () => {
         const integrationsExportTemplates: ExportTemplate[] = [makeTemplate('Zebra integration'), makeTemplate('Apple integration')];
@@ -260,15 +262,13 @@ describe('getExportTemplates', () => {
     });
 
     it('includes the Canadian Multiple Tax Export template when the policy outputs in CAD', () => {
-        const policy = {outputCurrency: CONST.CURRENCY.CAD} as Policy;
-        const {defaultTemplates} = getExportTemplates([], {}, translate, localeCompare, policy);
+        const {defaultTemplates} = getExportTemplates([], {}, translate, localeCompare, makePolicyWithOutputCurrency(CONST.CURRENCY.CAD));
 
         expect(defaultTemplates.map((template) => template.templateName)).toContain(CONST.REPORT.EXPORT_OPTIONS.MULTIPLE_TAX_EXPORT);
     });
 
     it('excludes the Canadian Multiple Tax Export template when the policy outputs in another currency', () => {
-        const policy = {outputCurrency: CONST.CURRENCY.USD} as Policy;
-        const {defaultTemplates} = getExportTemplates([], {}, translate, localeCompare, policy);
+        const {defaultTemplates} = getExportTemplates([], {}, translate, localeCompare, makePolicyWithOutputCurrency(CONST.CURRENCY.USD));
 
         expect(defaultTemplates.map((template) => template.templateName)).not.toContain(CONST.REPORT.EXPORT_OPTIONS.MULTIPLE_TAX_EXPORT);
     });
@@ -280,8 +280,7 @@ describe('getExportTemplates', () => {
     });
 
     it('excludes the Canadian Multiple Tax Export template when includeMultipleTaxExport is false for a CAD policy', () => {
-        const policy = {outputCurrency: CONST.CURRENCY.CAD} as Policy;
-        const {defaultTemplates} = getExportTemplates([], {}, translate, localeCompare, policy, true, false, false);
+        const {defaultTemplates} = getExportTemplates([], {}, translate, localeCompare, makePolicyWithOutputCurrency(CONST.CURRENCY.CAD), true, false, false);
 
         expect(defaultTemplates.map((template) => template.templateName)).not.toContain(CONST.REPORT.EXPORT_OPTIONS.MULTIPLE_TAX_EXPORT);
     });

tests/unit/hooks/useSearchBulkActionsExportTest.ts

@@ -5,6 +5,7 @@ import type {SearchQueryJSON, SelectedReports, SelectedTransactions} from '@comp
 
 import useSearchBulkActions from '@hooks/useSearchBulkActions';
 
+import {getExportTemplates} from '@libs/actions/Search';
 import type * as ReportSecondaryActionUtilsModule from '@libs/ReportSecondaryActionUtils';
 
 import CONST from '@src/CONST';
@@ -229,6 +230,8 @@ jest.mock('@components/Search/SearchContext', () => ({
     }),
 }));
 
+const mockGetExportTemplates = jest.mocked(getExportTemplates);
+
 const CURRENT_USER_ACCOUNT_ID = 1;
 
 jest.mock('@hooks/useCurrentUserPersonalDetails', () => ({
@@ -486,4 +489,54 @@ describe('useSearchBulkActions - export options', () => {
             expect(getExportOptionTexts(result.current.headerButtonsOptions)).toEqual(['export.currentView']);
         });
     });
+
+    describe('Canadian Multiple Tax Export eligibility', () => {
+        const SECOND_POLICY_ID = 'policy2';
+        const SECOND_REPORT_ID = 'report2';
+
+        /** The includeMultipleTaxExport argument getExportTemplates was last called with */
+        function getIncludeMultipleTaxExportArgument() {
+            return mockGetExportTemplates.mock.calls.at(-1)?.at(7);
+        }
+
+        beforeEach(async () => {
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.POLICY}${POLICY_ID}`, {outputCurrency: CONST.CURRENCY.CAD});
+        });
+
+        it('offers the template when every selected workspace outputs in CAD, even across several workspaces', async () => {
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.POLICY}${SECOND_POLICY_ID}`, {id: SECOND_POLICY_ID, outputCurrency: CONST.CURRENCY.CAD});
+
+            mockCurrentSearchResults = makeSearchResults([makeSnapshotReport()]);
+            mockSelectedReports = [makeSelectedReport(), makeSelectedReport({reportID: SECOND_REPORT_ID, policyID: SECOND_POLICY_ID})];
+            mockSelectedTransactions = {
+                tx1: makeSelectedTransaction(),
+                tx2: makeSelectedTransaction({reportID: SECOND_REPORT_ID, policyID: SECOND_POLICY_ID}),
+            };
+
+            renderHook(() => useSearchBulkActions({queryJSON: expenseReportQueryJSON}), {wrapper: OnyxListItemProvider});
+
+            await waitFor(() => {
+                expect(getIncludeMultipleTaxExportArgument()).toBe(true);
+            });
+        });
+
+        it('hides the template when a transaction from a non-CAD workspace is selected alongside a CAD report', async () => {
+            await Onyx.merge(`${ONYXKEYS.COLLECTION.POLICY}${SECOND_POLICY_ID}`, {id: SECOND_POLICY_ID, outputCurrency: CONST.CURRENCY.USD});
+
+            mockCurrentSearchResults = makeSearchResults([makeSnapshotReport()]);
+            // Only the CAD report is fully selected, but an extra transaction from a USD workspace is part of the same export request
+            mockSelectedReports = [makeSelectedReport()];
+            mockSelectedTransactions = {
+                tx1: makeSelectedTransaction(),
+                tx2: makeSelectedTransaction({reportID: SECOND_REPORT_ID, policyID: SECOND_POLICY_ID}),
+            };
+
+            renderHook(() => useSearchBulkActions({queryJSON: expenseReportQueryJSON}), {wrapper: OnyxListItemProvider});
+
+            await waitFor(() => {
+                expect(mockGetExportTemplates).toHaveBeenCalled();
+            });
+            expect(getIncludeMultipleTaxExportArgument()).toBe(false);
+        });
+    });
 });