fixup! feat(suite-native): add trade history CSV export

Author: jbazant

suite-common/trading/src/utils/tradeHistoryExportUtils.test.ts

@@ -48,6 +48,8 @@ const resolvers = {
         name === 'btcdirect-sell' ? 'BTC Direct' : name,
 };
 
+const CSV_BOM = '';
+
 const buyTrade: TradingTransactionBuy = {
     tradeType: 'buy',
     date: '2025-04-10T20:21:25.042Z',
@@ -245,7 +247,7 @@ describe('tradeHistoryExportUtils', () => {
         const header = TRADING_HISTORY_CSV_COLUMNS.map(column => labels[column]).join(',');
 
         it('returns only the header for an empty trade list', () => {
-            expect(buildTradingHistoryCsv(labels)([], resolvers)).toBe(header);
+            expect(buildTradingHistoryCsv(labels)([], resolvers)).toBe(CSV_BOM + header);
         });
 
         it('builds a header plus one line per trade', () => {
@@ -254,7 +256,7 @@ describe('tradeHistoryExportUtils', () => {
             const lines = csv.split('\n');
 
             expect(lines).toHaveLength(4);
-            expect(lines[0]).toBe(header);
+            expect(lines[0]).toBe(CSV_BOM + header);
             expect(lines[1]).toBe(
                 'buy-order,2025-04-10T20:21:25.042Z,buy,1234,USD,,,0.462586,ETH,Ethereum,mercuryo,SUCCESS,buy-receive-hash,buy-payment',
             );
@@ -268,7 +270,7 @@ describe('tradeHistoryExportUtils', () => {
             const [headerRow] = buildTradingHistoryCsv(czLabels)([], resolvers).split('\n');
 
             expect(headerRow).toBe(
-                TRADING_HISTORY_CSV_COLUMNS.map(column => `cs:${column}`).join(','),
+                CSV_BOM + TRADING_HISTORY_CSV_COLUMNS.map(column => `cs:${column}`).join(','),
             );
         });
 

suite-common/trading/src/utils/tradeHistoryExportUtils.ts

@@ -12,6 +12,7 @@ import { getTradeOperationData } from './tradeOperationUtils';
 const CSV_NEWLINE = '\n';
 const CSV_SEPARATOR = ',';
 const CSV_LEADING_CHARACTERS_TO_ESCAPE_REGEX = /^[\s\uFEFF]*[=+\-@＝＋－＠]/u;
+const CSV_BOM = '\uFEFF';
 
 export const sanitizeTradingCsvValue = (value: string): string => {
     const sanitizedValue = CSV_LEADING_CHARACTERS_TO_ESCAPE_REGEX.test(value) ? `'${value}` : value;
@@ -118,7 +119,7 @@ export const buildTradingHistoryCsv =
             ).join(CSV_SEPARATOR);
         });
 
-        return [header, ...rows].join(CSV_NEWLINE);
+        return CSV_BOM + [header, ...rows].join(CSV_NEWLINE);
     };
 
 export const prepareTradingHistoryCsv =

suite-native/trading-history/src/components/TradingHistoryExportButton.test.tsx

@@ -142,6 +142,16 @@ describe('TradingHistoryExportButton', () => {
         );
     });
 
+    it('shows no toast when the export is cancelled by dismissing the directory picker', async () => {
+        mockExportTradingHistoryCsv.mockResolvedValue({ success: false, reason: 'cancelled' });
+        renderExportButton();
+
+        await confirmExport();
+
+        expect(mockExportTradingHistoryCsv).toHaveBeenCalledTimes(1);
+        expect(mockShowToast).not.toHaveBeenCalled();
+    });
+
     it('dismisses the alert without exporting when cancelled', () => {
         renderExportButton();
 

suite-native/trading-history/src/components/TradingHistoryExportButton.tsx

@@ -13,7 +13,10 @@ import { Translation, useTranslate } from '@suite-native/intl';
 import { useToast } from '@suite-native/toasts';
 import { exhaustive } from '@trezor/type-utils';
 
-import { exportTradingHistoryCsv } from '../exportTradingHistoryCsv';
+import {
+    type ExportTradingHistoryCsvResult,
+    exportTradingHistoryCsv,
+} from '../exportTradingHistoryCsv';
 import { useTradingHistoryCsvColumnLabels } from '../hooks/useTradingHistoryCsvColumnLabels';
 
 export const TradingHistoryExportButton = () => {
@@ -30,18 +33,22 @@ export const TradingHistoryExportButton = () => {
     }
 
     const performExport = async () => {
-        setIsExporting(true);
+        let result: ExportTradingHistoryCsvResult = { success: false, reason: 'exportFailed' };
 
-        // wait for alert animation to finish before starting the export, 500 ms ought to be enough for anybody.
-        await new Promise(resolve => setTimeout(resolve, 500));
+        try {
+            setIsExporting(true);
 
-        const state = store.getState();
-        const trades = selectDeviceTradingTradesOrderedByDate(state);
-        const csvContent = prepareTradingHistoryCsv(columnLabels)(state, trades);
+            // wait for alert animation to finish before starting the export, 500 ms ought to be enough for anybody.
+            await new Promise(resolve => setTimeout(resolve, 500));
 
-        const result = await exportTradingHistoryCsv(csvContent);
+            const state = store.getState();
+            const trades = selectDeviceTradingTradesOrderedByDate(state);
+            const csvContent = prepareTradingHistoryCsv(columnLabels)(state, trades);
 
-        setIsExporting(false);
+            result = await exportTradingHistoryCsv(csvContent);
+        } finally {
+            setIsExporting(false);
+        }
 
         if (result.success) {
             showToast({
@@ -56,6 +63,9 @@ export const TradingHistoryExportButton = () => {
         }
 
         switch (result.reason) {
+            case 'cancelled':
+                // User dismissed the directory picker; nothing to report.
+                return;
             case 'exportFailed':
                 showToast({
                     intent: 'critical',

suite-native/trading-history/src/exportTradingHistoryCsv.test.ts

@@ -0,0 +1,112 @@
+import { Platform } from 'react-native';
+
+import { Directory } from 'expo-file-system';
+import * as Sharing from 'expo-sharing';
+
+import { exportTradingHistoryCsv } from './exportTradingHistoryCsv';
+
+const mockDirectoryWrite = jest.fn();
+const mockCreateFile = jest.fn(() => ({ write: mockDirectoryWrite }));
+
+jest.mock('expo-file-system', () => ({
+    File: jest.fn().mockImplementation(() => ({
+        exists: false,
+        create: jest.fn(),
+        write: jest.fn(),
+        uri: 'file:///cache/trade-history.csv',
+    })),
+    Paths: { cache: 'file:///cache' },
+    Directory: {
+        pickDirectoryAsync: jest.fn(),
+    },
+}));
+
+jest.mock('expo-sharing', () => ({
+    shareAsync: jest.fn(),
+}));
+
+const mockPickDirectoryAsync = jest.mocked(Directory.pickDirectoryAsync);
+const mockShareAsync = jest.mocked(Sharing.shareAsync);
+
+const originalPlatformOS = Platform.OS;
+const setPlatformOS = (os: typeof Platform.OS) => {
+    Platform.OS = os;
+};
+
+const CSV_CONTENT = 'a,b,c';
+
+describe('exportTradingHistoryCsv', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+
+    afterAll(() => {
+        setPlatformOS(originalPlatformOS);
+    });
+
+    describe('on android', () => {
+        beforeEach(() => {
+            setPlatformOS('android');
+        });
+
+        it('writes the file into the picked directory and returns success', async () => {
+            mockPickDirectoryAsync.mockResolvedValue({ createFile: mockCreateFile } as never);
+
+            const result = await exportTradingHistoryCsv(CSV_CONTENT);
+
+            expect(result).toEqual({ success: true });
+            expect(mockCreateFile).toHaveBeenCalledTimes(1);
+            expect(mockDirectoryWrite).toHaveBeenCalledWith(CSV_CONTENT);
+        });
+
+        it('returns the cancelled reason when the user dismisses the directory picker', async () => {
+            mockPickDirectoryAsync.mockRejectedValue(
+                Object.assign(new Error('The file picker was cancelled by the user'), {
+                    code: 'ERR_PICKER_CANCELLED',
+                }),
+            );
+
+            const result = await exportTradingHistoryCsv(CSV_CONTENT);
+
+            expect(result).toEqual({ success: false, reason: 'cancelled' });
+        });
+
+        it('returns the exportFailed reason for any other picker error', async () => {
+            mockPickDirectoryAsync.mockRejectedValue(new Error('boom'));
+
+            const result = await exportTradingHistoryCsv(CSV_CONTENT);
+
+            expect(result).toEqual({ success: false, reason: 'exportFailed' });
+        });
+    });
+
+    describe('on ios', () => {
+        beforeEach(() => {
+            setPlatformOS('ios');
+        });
+
+        it('shares the cached file and returns success', async () => {
+            mockShareAsync.mockResolvedValue(undefined);
+
+            const result = await exportTradingHistoryCsv(CSV_CONTENT);
+
+            expect(result).toEqual({ success: true });
+            expect(mockShareAsync).toHaveBeenCalledWith(
+                'file:///cache/trade-history.csv',
+                expect.objectContaining({ UTI: 'public.comma-separated-values-text' }),
+            );
+        });
+    });
+
+    describe('on an unsupported platform', () => {
+        beforeEach(() => {
+            setPlatformOS('web');
+        });
+
+        it('returns the fileSavingNotSupported reason', async () => {
+            const result = await exportTradingHistoryCsv(CSV_CONTENT);
+
+            expect(result).toEqual({ success: false, reason: 'fileSavingNotSupported' });
+        });
+    });
+});

suite-native/trading-history/src/exportTradingHistoryCsv.ts

@@ -3,12 +3,14 @@ import { Platform } from 'react-native';
 import { Directory, File, Paths } from 'expo-file-system';
 import * as Sharing from 'expo-sharing';
 
-type ExportTradingHistoryCsvResult =
+export type ExportTradingHistoryCsvResult =
     | { success: true }
-    | { success: false; reason: 'fileSavingNotSupported' | 'exportFailed' };
+    | { success: false; reason: 'fileSavingNotSupported' | 'exportFailed' | 'cancelled' };
 
 const CSV_MIME_TYPE = 'text/csv';
 
+const PICKER_CANCELLED_ERROR_CODE = 'ERR_PICKER_CANCELLED';
+
 const buildFileName = (): string => {
     const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
 
@@ -31,7 +33,6 @@ const saveFile = async (fileName: string, content: string): Promise<void> => {
         newFile.write(content);
     } else if (Platform.OS === 'ios') {
         await Sharing.shareAsync(cachedFile.uri, {
-            mimeType: CSV_MIME_TYPE,
             UTI: 'public.comma-separated-values-text',
         });
     } else {
@@ -51,6 +52,10 @@ export const exportTradingHistoryCsv = async (
             return { success: false, reason: 'fileSavingNotSupported' };
         }
 
+        if (error?.code === PICKER_CANCELLED_ERROR_CODE) {
+            return { success: false, reason: 'cancelled' };
+        }
+
         return { success: false, reason: 'exportFailed' };
     }