diff --git a/src/libs/moveReceiptToDurableStorage/index.native.ts b/src/libs/moveReceiptToDurableStorage/index.native.ts new file mode 100644 index 000000000000..768ac5a2314f --- /dev/null +++ b/src/libs/moveReceiptToDurableStorage/index.native.ts @@ -0,0 +1,42 @@ +import RNFS from 'react-native-fs'; +import getReceiptsUploadFolderPath from '@libs/getReceiptsUploadFolderPath'; +import Log from '@libs/Log'; +import {rand64} from '@libs/NumberUtils'; +import type MoveReceiptToDurableStorage from './types'; + +/** + * Moves a receipt image from an ephemeral location (e.g., ImageManipulator cache) + * to the durable Receipts-Upload directory so it persists until the upload completes. + * + * iOS can purge files in Library/Caches/ at any time, so receipts that are queued + * for upload via the SequentialQueue must live in a durable directory. + */ +const moveReceiptToDurableStorage: MoveReceiptToDurableStorage = async (sourceUri, fileName) => { + const uploadFolder = getReceiptsUploadFolderPath(); + if (!uploadFolder) { + return sourceUri; + } + + try { + await RNFS.mkdir(uploadFolder); + + if (!(await RNFS.exists(uploadFolder))) { + Log.alert('[moveReceiptToDurableStorage] Upload folder does not exist after mkdir', {uploadFolder}); + return sourceUri; + } + + const sourcePath = sourceUri.replace('file://', ''); + const dotIndex = fileName.lastIndexOf('.'); + const uniqueName = dotIndex > 0 ? `${fileName.slice(0, dotIndex)}_${rand64()}${fileName.slice(dotIndex)}` : `${fileName}_${rand64()}`; + const destPath = `${uploadFolder}/${uniqueName}`; + + await RNFS.moveFile(sourcePath, destPath); + + return `file://${destPath}`; + } catch (error) { + Log.warn('[moveReceiptToDurableStorage] Failed to move receipt, using original path', {error: error instanceof Error ? error.message : String(error)}); + return sourceUri; + } +}; + +export default moveReceiptToDurableStorage; diff --git a/src/libs/moveReceiptToDurableStorage/index.ts b/src/libs/moveReceiptToDurableStorage/index.ts new file mode 100644 index 000000000000..7ad9c66f55c0 --- /dev/null +++ b/src/libs/moveReceiptToDurableStorage/index.ts @@ -0,0 +1,8 @@ +import type MoveReceiptToDurableStorage from './types'; + +/** + * Web no-op: blob/object URLs are held in memory and don't need durable filesystem storage. + */ +const moveReceiptToDurableStorage: MoveReceiptToDurableStorage = (sourceUri) => Promise.resolve(sourceUri); + +export default moveReceiptToDurableStorage; diff --git a/src/libs/moveReceiptToDurableStorage/types.ts b/src/libs/moveReceiptToDurableStorage/types.ts new file mode 100644 index 000000000000..dd3ef3465d9b --- /dev/null +++ b/src/libs/moveReceiptToDurableStorage/types.ts @@ -0,0 +1,3 @@ +type MoveReceiptToDurableStorage = (sourceUri: string, fileName: string) => Promise; + +export default MoveReceiptToDurableStorage; diff --git a/src/libs/prepareRequestPayload/index.native.ts b/src/libs/prepareRequestPayload/index.native.ts index 5232f8d3365e..d84c505f0618 100644 --- a/src/libs/prepareRequestPayload/index.native.ts +++ b/src/libs/prepareRequestPayload/index.native.ts @@ -1,5 +1,6 @@ import checkFileExists from '@libs/fileDownload/checkFileExists'; import {readFileAsync} from '@libs/fileDownload/FileUtils'; +import Log from '@libs/Log'; import validateFormDataParameter from '@libs/validateFormDataParameter'; import type PrepareRequestPayload from './types'; @@ -24,6 +25,7 @@ const prepareRequestPayload: PrepareRequestPayload = (command, data, initiatedOf if (source) { return checkFileExists(source).then((exists) => { if (!exists) { + Log.alert('[prepareRequestPayload] Receipt file missing at upload time', {command, source, fileName: name}); return; } const receiptFormData = { diff --git a/src/pages/iou/request/step/IOURequestStepOdometerImage/index.native.tsx b/src/pages/iou/request/step/IOURequestStepOdometerImage/index.native.tsx index e668e5223967..da8ab2491c0f 100644 --- a/src/pages/iou/request/step/IOURequestStepOdometerImage/index.native.tsx +++ b/src/pages/iou/request/step/IOURequestStepOdometerImage/index.native.tsx @@ -30,6 +30,7 @@ import type Platform from '@libs/getPlatform/types'; import getReceiptsUploadFolderPath from '@libs/getReceiptsUploadFolderPath'; import {shouldUseTransactionDraft} from '@libs/IOUUtils'; import Log from '@libs/Log'; +import moveReceiptToDurableStorage from '@libs/moveReceiptToDurableStorage'; import Navigation from '@libs/Navigation/Navigation'; import {getOdometerImageUri} from '@libs/OdometerImageUtils'; import type {SkeletonSpanReasonAttributes} from '@libs/telemetry/useSkeletonSpan'; @@ -241,6 +242,7 @@ function IOURequestStepOdometerImage({ .then((photo: PhotoFile) => { const imageObject: ImageObject = {file: photo, filename: photo.path, source: getPhotoSource(photo.path)}; cropImageToAspectRatio(imageObject, viewfinderLayout.current?.width, viewfinderLayout.current?.height, undefined, photo.orientation) + .then(({file, filename, source}) => moveReceiptToDurableStorage(source, filename).then((durableSource) => ({file, filename, source: durableSource}))) .then(({file, filename, source}) => { setMoneyRequestOdometerImage( transaction, diff --git a/src/pages/media/AttachmentModalScreen/routes/TransactionReceiptModalContent.tsx b/src/pages/media/AttachmentModalScreen/routes/TransactionReceiptModalContent.tsx index 4b96afbce989..248dccda4713 100644 --- a/src/pages/media/AttachmentModalScreen/routes/TransactionReceiptModalContent.tsx +++ b/src/pages/media/AttachmentModalScreen/routes/TransactionReceiptModalContent.tsx @@ -25,6 +25,7 @@ import cropOrRotateImage from '@libs/cropOrRotateImage'; import fetchImage from '@libs/fetchImage'; import getNonEmptyStringOnyxID from '@libs/getNonEmptyStringOnyxID'; import getPlatform from '@libs/getPlatform'; +import moveReceiptToDurableStorage from '@libs/moveReceiptToDurableStorage'; import Navigation from '@libs/Navigation/Navigation'; import {getThumbnailAndImageURIs} from '@libs/ReceiptUtils'; import {getReportAction, isTrackExpenseAction} from '@libs/ReportActionsUtils'; @@ -282,6 +283,32 @@ function TransactionReceiptModalContent({navigation, route}: AttachmentModalScre const allowDownload = !isEReceipt; + const applyDurableReceipt = useCallback( + (imageUri: string, filename: string, file: File, isSameReceipt?: boolean) => { + if (!transaction?.transactionID) { + return Promise.resolve(); + } + return moveReceiptToDurableStorage(imageUri, filename).then((durableUri) => { + const durableFile = Object.assign(new File([file], file.name || filename, {type: file.type}), {uri: durableUri, source: durableUri}); + if (isOdometerImage) { + setMoneyRequestOdometerImage(transaction, imageType, durableFile, isDraftTransaction, !isEditingConfirmation); + } else if (isDraftTransaction) { + setMoneyRequestReceipt(transaction.transactionID, durableUri, filename, isDraftTransaction, fileType); + } else { + replaceReceipt({ + transactionID: transaction.transactionID, + file: durableFile, + source: durableUri, + transactionPolicyCategories: policyCategories, + transactionPolicy: policy, + ...(isSameReceipt ? {state: transaction?.receipt?.state, isSameReceipt: true} : {}), + }); + } + }); + }, + [transaction, isDraftTransaction, isOdometerImage, isEditingConfirmation, imageType, fileType, policyCategories, policy], + ); + const rotateReceipt = useCallback(() => { if (!transaction?.transactionID || !sourceUri || !isImage) { return; @@ -296,39 +323,26 @@ function TransactionReceiptModalContent({navigation, route}: AttachmentModalScre .then((rotatedImage) => { if (!rotatedImage) { setIsRotating(false); - return; + return Promise.resolve(); } const imageUriResult = 'uri' in rotatedImage && rotatedImage.uri ? rotatedImage.uri : undefined; if (!imageUriResult) { setIsRotating(false); - return; + return Promise.resolve(); } const file = rotatedImage as File; const rotatedFilename = file.name ?? receiptFilename; - if (isOdometerImage) { - setMoneyRequestOdometerImage(transaction, imageType, file, isDraftTransaction, !isEditingConfirmation); - } else if (isDraftTransaction) { - setMoneyRequestReceipt(transaction.transactionID, imageUriResult, rotatedFilename, isDraftTransaction, fileType); - } else { - replaceReceipt({ - transactionID: transaction.transactionID, - file, - source: imageUriResult, - state: transaction.receipt?.state, - transactionPolicyCategories: policyCategories, - transactionPolicy: policy, - isSameReceipt: true, - }); - } - setIsRotating(false); + return applyDurableReceipt(imageUriResult, rotatedFilename, file, true).then(() => { + setIsRotating(false); + }); }) .catch(() => { setIsRotating(false); }); - }, [transaction, sourceUri, isImage, fileName, fileType, receiptFilename, isOdometerImage, isDraftTransaction, imageType, isEditingConfirmation, policyCategories, policy]); + }, [transaction?.transactionID, sourceUri, isImage, receiptFilename, fileName, fileType, applyDurableReceipt]); const shouldShowRotateAndCropReceiptButton = useMemo( () => @@ -383,53 +397,27 @@ function TransactionReceiptModalContent({navigation, route}: AttachmentModalScre .then((croppedImage) => { if (!croppedImage) { setIsCropSaving(false); - return; + return Promise.resolve(); } const imageUriResult = 'uri' in croppedImage && croppedImage.uri ? croppedImage.uri : undefined; if (!imageUriResult) { setIsCropSaving(false); - return; + return Promise.resolve(); } const file = croppedImage as File; const croppedFilename = file.name ?? receiptFilename; - if (isOdometerImage) { - setMoneyRequestOdometerImage(transaction, imageType, file, isDraftTransaction, !isEditingConfirmation); - } else if (isDraftTransaction) { - setMoneyRequestReceipt(transaction.transactionID, imageUriResult, croppedFilename, isDraftTransaction, fileType); - } else { - replaceReceipt({ - transactionID: transaction.transactionID, - file, - source: imageUriResult, - transactionPolicyCategories: policyCategories, - transactionPolicy: policy, - }); - } - setIsCropSaving(false); - exitCropMode(); + return applyDurableReceipt(imageUriResult, croppedFilename, file).then(() => { + setIsCropSaving(false); + exitCropMode(); + }); }) .catch(() => { setIsCropSaving(false); }); - }, [ - transaction, - sourceUri, - isImage, - cropRect, - fileName, - fileType, - exitCropMode, - receiptFilename, - isOdometerImage, - isDraftTransaction, - imageType, - isEditingConfirmation, - policyCategories, - policy, - ]); + }, [transaction?.transactionID, sourceUri, isImage, cropRect, receiptFilename, fileName, fileType, exitCropMode, applyDurableReceipt]); const threeDotsMenuItems: ThreeDotsMenuItemFactory = useCallback( ({file, source: innerSource, isLocalSource}) => { diff --git a/tests/unit/libs/prepareRequestPayloadNativeTest.ts b/tests/unit/libs/prepareRequestPayloadNativeTest.ts new file mode 100644 index 000000000000..cf03f39fd67d --- /dev/null +++ b/tests/unit/libs/prepareRequestPayloadNativeTest.ts @@ -0,0 +1,87 @@ +import type PrepareRequestPayload from '@libs/prepareRequestPayload/types'; + +const mockCheckFileExists = jest.fn, [string | undefined]>(); +jest.mock('@libs/fileDownload/checkFileExists', () => ({ + // eslint-disable-next-line @typescript-eslint/naming-convention + __esModule: true, + default: mockCheckFileExists, +})); + +jest.mock('@libs/fileDownload/FileUtils', () => ({ + readFileAsync: jest.fn(() => Promise.resolve(null)), +})); + +jest.mock('@libs/validateFormDataParameter', () => ({ + // eslint-disable-next-line @typescript-eslint/naming-convention + __esModule: true, + default: jest.fn(), +})); + +const mockLogAlert = jest.fn(); +jest.mock('@libs/Log', () => ({ + // eslint-disable-next-line @typescript-eslint/naming-convention + __esModule: true, + default: {alert: mockLogAlert}, +})); + +// Bypass the global jest/setup.ts mock to test the real native implementation. +// Dependencies above are still resolved through their respective mocks. +// eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires +const {default: prepareRequestPayload}: {default: PrepareRequestPayload} = jest.requireActual('@libs/prepareRequestPayload/index.native.ts'); + +describe('prepareRequestPayload (native)', () => { + afterEach(() => { + jest.clearAllMocks(); + }); + + it('should include receipt in FormData when the file exists', async () => { + mockCheckFileExists.mockResolvedValue(true); + + const receipt = { + source: 'file:///var/mobile/Documents/Receipts-Upload/receipt.jpg', + name: 'receipt.jpg', + type: 'image/jpeg', + uri: 'file:///var/mobile/Documents/Receipts-Upload/receipt.jpg', + }; + + const formData = await prepareRequestPayload('RequestMoney', {receipt, amount: '100'}, false); + + expect(formData.has('receipt')).toBe(true); + expect(formData.get('amount')).toBe('100'); + }); + + it('should log an alert and omit receipt from FormData when file does not exist', async () => { + mockCheckFileExists.mockResolvedValue(false); + + const receipt = { + source: 'file:///var/mobile/Library/Caches/ImageManipulator/receipt.jpg', + name: 'receipt.jpg', + type: 'image/jpeg', + uri: 'file:///var/mobile/Library/Caches/ImageManipulator/receipt.jpg', + }; + + const formData = await prepareRequestPayload('RequestMoney', {receipt, amount: '100'}, false); + + expect(formData.has('receipt')).toBe(false); + expect(formData.get('amount')).toBe('100'); + expect(mockLogAlert).toHaveBeenCalledWith('[prepareRequestPayload] Receipt file missing at upload time', { + command: 'RequestMoney', + source: 'file:///var/mobile/Library/Caches/ImageManipulator/receipt.jpg', + fileName: 'receipt.jpg', + }); + }); + + it('should handle non-receipt data normally', async () => { + const formData = await prepareRequestPayload('SomeCommand', {amount: '100', currency: 'USD'}, false); + + expect(formData.get('amount')).toBe('100'); + expect(formData.get('currency')).toBe('USD'); + }); + + it('should skip undefined values', async () => { + const formData = await prepareRequestPayload('SomeCommand', {amount: '100', undefinedField: undefined}, false); + + expect(formData.get('amount')).toBe('100'); + expect(formData.has('undefinedField')).toBe(false); + }); +}); diff --git a/tests/unit/libs/receiptDurableStorageTest.ts b/tests/unit/libs/receiptDurableStorageTest.ts new file mode 100644 index 000000000000..ea2e9e96f710 --- /dev/null +++ b/tests/unit/libs/receiptDurableStorageTest.ts @@ -0,0 +1,64 @@ +jest.mock('react-native-fs', () => ({ + exists: jest.fn(() => Promise.resolve(true)), + mkdir: jest.fn(() => Promise.resolve()), + moveFile: jest.fn(() => Promise.resolve()), +})); + +const DURABLE_UPLOAD_DIR = '/var/mobile/Documents/Receipts-Upload'; +jest.mock('@libs/getReceiptsUploadFolderPath', () => ({ + // eslint-disable-next-line @typescript-eslint/naming-convention + __esModule: true, + default: () => DURABLE_UPLOAD_DIR, +})); + +jest.mock('@libs/Log', () => ({ + // eslint-disable-next-line @typescript-eslint/naming-convention + __esModule: true, + default: {warn: jest.fn(), alert: jest.fn()}, +})); + +type MoveReceiptFn = (uri: string, fileName: string) => Promise; + +// Bypass the global jest/setup.ts mock to test the real native implementation. +// eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires +const {default: moveReceiptToDurableStorage}: {default: MoveReceiptFn} = jest.requireActual('@libs/moveReceiptToDurableStorage/index.native.ts'); + +describe('Receipt flows should persist to durable storage after crop/rotate', () => { + it('should move a cropped receipt out of ImageManipulator cache into Receipts-Upload', async () => { + const cachePath = 'file:///var/mobile/Library/Caches/ImageManipulator/cropped-abc123.jpg'; + + const result = await moveReceiptToDurableStorage(cachePath, 'receipt.jpg'); + + expect(result).toContain('Receipts-Upload'); + expect(result).not.toContain('Library/Caches'); + }); + + it('should move a rotated receipt out of ImageManipulator cache into Receipts-Upload', async () => { + const cachePath = 'file:///var/mobile/Library/Caches/ImageManipulator/rotated-def456.jpg'; + + const result = await moveReceiptToDurableStorage(cachePath, 'rotated-receipt.jpg'); + + expect(result).toContain('Receipts-Upload'); + expect(result).not.toContain('Library/Caches'); + }); + + it('should generate unique destination paths to avoid filename collisions', async () => { + const cachePath1 = 'file:///var/mobile/Library/Caches/ImageManipulator/img1.jpg'; + const cachePath2 = 'file:///var/mobile/Library/Caches/ImageManipulator/img2.jpg'; + + const result1 = await moveReceiptToDurableStorage(cachePath1, 'receipt.jpg'); + const result2 = await moveReceiptToDurableStorage(cachePath2, 'receipt.jpg'); + + expect(result1).not.toBe(result2); + expect(result1).toMatch(/\.jpg$/); + expect(result2).toMatch(/\.jpg$/); + }); + + it('should preserve receipts already in a durable directory', async () => { + const durablePath = `file://${DURABLE_UPLOAD_DIR}/existing-receipt.jpg`; + + const result = await moveReceiptToDurableStorage(durablePath, 'existing-receipt.jpg'); + + expect(result).toContain('Receipts-Upload'); + }); +});