diff --git a/src/hooks/useFilesValidation.tsx b/src/hooks/useFilesValidation.tsx index 4ed4903692ec..58cb5260d5ab 100644 --- a/src/hooks/useFilesValidation.tsx +++ b/src/hooks/useFilesValidation.tsx @@ -32,7 +32,7 @@ const sortFilesByOriginalOrder = (files: FileObject[], orderMap: Map (orderMap.get(a.uri ?? '') ?? 0) - (orderMap.get(b.uri ?? '') ?? 0)); }; -const isImageFile = (file: FileObject) => hasHeicOrHeifExtension(file) ?? Str.isImage(file.name ?? ''); +const isImageFile = (file: FileObject): boolean => hasHeicOrHeifExtension(file) || Str.isImage(file.name ?? ''); function useFilesValidation(onFilesValidated: (files: FileObject[], dataTransferItems: DataTransferItem[]) => void) { const styles = useThemeStyles(); @@ -166,13 +166,13 @@ function useFilesValidation(onFilesValidated: (files: FileObject[], dataTransfer return; } - if (result.error === CONST.FILE_VALIDATION_ERRORS.FILE_TOO_LARGE && isImageFile(file) && validationState.isValidatingReceipts) { - filesToResize.push(file); + if (result.error === CONST.FILE_VALIDATION_ERRORS.HEIC_OR_HEIF_IMAGE) { + filesToConvert.push(file); return; } - if (result.error === CONST.FILE_VALIDATION_ERRORS.HEIC_OR_HEIF_IMAGE) { - filesToConvert.push(file); + if (result.error === CONST.FILE_VALIDATION_ERRORS.FILE_TOO_LARGE && isImageFile(file) && validationState.isValidatingReceipts) { + filesToResize.push(file); return; } diff --git a/src/libs/Navigation/types.ts b/src/libs/Navigation/types.ts index 82f78383a616..3a2a32b8c6cb 100644 --- a/src/libs/Navigation/types.ts +++ b/src/libs/Navigation/types.ts @@ -2883,8 +2883,7 @@ type AttachmentModalScreensParamList = { accountID?: number; attachmentID?: string; source?: AvatarSource; - file?: FileObject | FileObject[]; - dataTransferItems?: DataTransferItem[]; + file: FileObject | FileObject[]; type?: ValueOf; isAuthTokenRequired?: boolean; originalFileName?: string; diff --git a/src/libs/fileDownload/FileUtils.ts b/src/libs/fileDownload/FileUtils.ts index 385f429b2f31..07da71c7c3b1 100644 --- a/src/libs/fileDownload/FileUtils.ts +++ b/src/libs/fileDownload/FileUtils.ts @@ -632,9 +632,8 @@ const isValidReceiptExtension = (file: FileObject) => { ); }; -const hasHeicOrHeifExtension = (file: FileObject) => { - // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing - return file.name?.toLowerCase().endsWith('.heic') || file.name?.toLowerCase().endsWith('.heif'); +const hasHeicOrHeifExtension = (file: FileObject): boolean => { + return (file.name?.toLowerCase().endsWith('.heic') ?? false) || (file.name?.toLowerCase().endsWith('.heif') ?? false); }; /** @@ -706,11 +705,6 @@ const getFileValidationErrorText = ( title: translate('attachmentPicker.someFilesCantBeUploaded'), reason: translate('attachmentPicker.sizeLimitExceeded', maxSize / 1024 / 1024), }; - case CONST.FILE_VALIDATION_ERRORS.FOLDER_NOT_ALLOWED: - return { - title: translate('attachmentPicker.attachmentError'), - reason: translate('attachmentPicker.folderNotAllowedMessage'), - }; case CONST.FILE_VALIDATION_ERRORS.MAX_FILE_LIMIT_EXCEEDED: return { title: translate('attachmentPicker.someFilesCantBeUploaded'), @@ -722,6 +716,11 @@ const getFileValidationErrorText = ( } switch (validationError.error) { + case CONST.FILE_VALIDATION_ERRORS.FOLDER_NOT_ALLOWED: + return { + title: translate('attachmentPicker.attachmentError'), + reason: translate('attachmentPicker.folderNotAllowedMessage'), + }; case CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE: return { title: translate('attachmentPicker.wrongFileType'), diff --git a/src/libs/validateAttachmentFile.ts b/src/libs/validateAttachmentFile.ts index f46fab1eb982..f9fcd853938e 100644 --- a/src/libs/validateAttachmentFile.ts +++ b/src/libs/validateAttachmentFile.ts @@ -2,7 +2,7 @@ import {Str} from 'expensify-common'; import type {ValueOf} from 'type-fest'; import CONST from '@src/CONST'; import type {FileObject} from '@src/types/utils/Attachment'; -import {cleanFileName, hasHeicOrHeifExtension, isValidReceiptExtension, normalizeFileObject, validateImageForCorruption} from './fileDownload/FileUtils'; +import {cleanFileName, cleanFileObject, hasHeicOrHeifExtension, isValidReceiptExtension, normalizeFileObject, validateImageForCorruption} from './fileDownload/FileUtils'; type ValidateAttachmentValidResult = { isValid: true; @@ -17,11 +17,9 @@ type ValidateAttachmentInvalidResult = { type ValidateAttachmentResult = ValidateAttachmentValidResult | ValidateAttachmentInvalidResult; async function validateAttachmentFile(file: FileObject, item?: DataTransferItem, isValidatingReceipts = false): Promise { - if (!file.name || file.size == null) { - return {isValid: false, error: CONST.FILE_VALIDATION_ERRORS.FILE_INVALID}; - } + const fileObject = cleanFileObject(file); - if (isValidatingReceipts && !isValidReceiptExtension(file)) { + if (isValidatingReceipts && !isValidReceiptExtension(fileObject)) { return {isValid: false, error: CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE}; } @@ -29,28 +27,21 @@ async function validateAttachmentFile(file: FileObject, item?: DataTransferItem, return {isValid: false, error: CONST.FILE_VALIDATION_ERRORS.HEIC_OR_HEIF_IMAGE}; } - const isImage = Str.isImage(file.name); - const maxFileSize = isValidatingReceipts ? CONST.API_ATTACHMENT_VALIDATIONS.RECEIPT_MAX_SIZE : CONST.API_ATTACHMENT_VALIDATIONS.MAX_SIZE; - if (!isImage && !hasHeicOrHeifExtension(file) && file.size > maxFileSize) { - return {isValid: false, error: CONST.FILE_VALIDATION_ERRORS.FILE_TOO_LARGE}; - } - - if (isValidatingReceipts && file.size < CONST.API_ATTACHMENT_VALIDATIONS.MIN_SIZE) { - return {isValid: false, error: CONST.FILE_VALIDATION_ERRORS.FILE_TOO_SMALL}; + if (isDataTransferItemDirectory(item)) { + return {isValid: false, error: CONST.FILE_VALIDATION_ERRORS.FOLDER_NOT_ALLOWED}; } - let fileObject = file; - const fileConverted = file.getAsFile?.(); - if (fileConverted) { - fileObject = fileConverted; - } + const fileName = fileObject.name ?? ''; + const fileSize = fileObject.size ?? 0; + const isImage = Str.isImage(fileName); - if (!fileObject) { - return {isValid: false, error: CONST.FILE_VALIDATION_ERRORS.FILE_INVALID}; + const maxFileSize = isValidatingReceipts ? CONST.API_ATTACHMENT_VALIDATIONS.RECEIPT_MAX_SIZE : CONST.API_ATTACHMENT_VALIDATIONS.MAX_SIZE; + if (!isImage && fileSize > maxFileSize) { + return {isValid: false, error: CONST.FILE_VALIDATION_ERRORS.FILE_TOO_LARGE}; } - if (isDataTransferItemDirectory(item)) { - return {isValid: false, error: CONST.FILE_VALIDATION_ERRORS.FOLDER_NOT_ALLOWED}; + if (isValidatingReceipts && fileSize < CONST.API_ATTACHMENT_VALIDATIONS.MIN_SIZE) { + return {isValid: false, error: CONST.FILE_VALIDATION_ERRORS.FILE_TOO_SMALL}; } const normalizedFile = await normalizeFileObject(fileObject); diff --git a/src/pages/inbox/report/ReportActionCompose/useAttachmentUploadValidation.ts b/src/pages/inbox/report/ReportActionCompose/useAttachmentUploadValidation.ts index ce7198781020..9382d05e3f59 100644 --- a/src/pages/inbox/report/ReportActionCompose/useAttachmentUploadValidation.ts +++ b/src/pages/inbox/report/ReportActionCompose/useAttachmentUploadValidation.ts @@ -63,11 +63,12 @@ function useAttachmentUploadValidation({ const reportAttachmentsContext = useContext(AttachmentModalContext); const showAttachmentModalScreen = useCallback( - (file: FileObject | FileObject[], dataTransferItems?: DataTransferItem[]) => { + (file: FileObject[]) => { + const sourceOfFirstAttachment = file.at(0)?.uri; reportAttachmentsContext.setCurrentAttachment({ reportID, + source: sourceOfFirstAttachment, file, - dataTransferItems, headerTitle: translate('reportActionCompose.sendAttachment'), onConfirm: addAttachment, onShow: () => setIsAttachmentPreviewActive(true), @@ -80,13 +81,13 @@ function useAttachmentUploadValidation({ ); const attachmentUploadType = useRef<'receipt' | 'attachment'>(undefined); - const onFilesValidated = (files: FileObject[], dataTransferItems: DataTransferItem[]) => { + const onFilesValidated = (files: FileObject[]) => { if (files.length === 0) { return; } if (attachmentUploadType.current === 'attachment') { - showAttachmentModalScreen(files, dataTransferItems); + showAttachmentModalScreen(files); return; } diff --git a/src/pages/media/AttachmentModalScreen/routes/report/ReportAddAttachmentModalContent/index.tsx b/src/pages/media/AttachmentModalScreen/routes/report/ReportAddAttachmentModalContent/index.tsx index 31606deb2f2e..ac73c30e2872 100644 --- a/src/pages/media/AttachmentModalScreen/routes/report/ReportAddAttachmentModalContent/index.tsx +++ b/src/pages/media/AttachmentModalScreen/routes/report/ReportAddAttachmentModalContent/index.tsx @@ -1,4 +1,4 @@ -import React, {useCallback, useEffect, useMemo, useRef, useState} from 'react'; +import React, {useEffect, useRef} from 'react'; import type {View} from 'react-native'; import useNetwork from '@hooks/useNetwork'; import useOnyx from '@hooks/useOnyx'; @@ -7,7 +7,6 @@ import {openReport} from '@libs/actions/Report'; import {getValidatedImageSource} from '@libs/AvatarUtils'; import Navigation from '@libs/Navigation/Navigation'; import {canUserPerformWriteAction, isReportNotFound} from '@libs/ReportUtils'; -import validateAttachmentFile from '@libs/validateAttachmentFile'; import type {AttachmentModalBaseContentProps} from '@pages/media/AttachmentModalScreen/AttachmentModalBaseContent/types'; import AttachmentModalContainer from '@pages/media/AttachmentModalScreen/AttachmentModalContainer'; import useDownloadAttachment from '@pages/media/AttachmentModalScreen/routes/hooks/useDownloadAttachment'; @@ -24,7 +23,7 @@ import AddAttachmentModalCarouselView from './AddAttachmentModalCarouselView'; function ReportAddAttachmentModalContent({route, navigation}: AttachmentModalScreenProps) { const { attachmentID, - file: fileParam, + file, source: sourceParam, isAuthTokenRequired, attachmentLink, @@ -53,15 +52,13 @@ function ReportAddAttachmentModalContent({route, navigation}: AttachmentModalScr const submitRef = useRef(null); // Extract the reportActionID from the attachmentID (format: reportActionID_index) - const reportActionID = useMemo(() => attachmentID?.split('_')?.[0], [attachmentID]); + const reportActionID = attachmentID?.split('_')?.[0]; - const shouldFetchReport = useMemo(() => { - return isEmptyObject(reportActions?.[reportActionID ?? CONST.DEFAULT_NUMBER_ID]); - }, [reportActions, reportActionID]); + const shouldFetchReport = isEmptyObject(reportActions?.[reportActionID ?? CONST.DEFAULT_NUMBER_ID]); - const fetchReport = useCallback(() => { + const fetchReport = () => { openReport({reportID, introSelected, reportActionID, betas}); - }, [reportID, introSelected, reportActionID, betas]); + }; // Close the modal if user loses write access (e.g., admin switches "Who can post" to Admins only) useEffect(() => { @@ -79,70 +76,41 @@ function ReportAddAttachmentModalContent({route, navigation}: AttachmentModalScr fetchReport(); }, [reportID, fetchReport, shouldFetchReport]); - const [source, setSource] = useState(() => getValidatedImageSource(sourceParam)); + const source = getValidatedImageSource(sourceParam); - const [validFiles, setValidFiles] = useState(fileParam); - useEffect(() => { - async function validateFiles() { - if (!fileParam) { - return; - } - - const files = Array.isArray(fileParam) ? fileParam : [fileParam]; - const results = await Promise.all(files.map(async (file) => validateAttachmentFile(file))); - - const validResults = results.filter((r) => r.isValid); - if (validResults.length === 0) { - return; - } + const modalType = useReportAttachmentModalType(source, file); + useNavigateToReportOnRefresh({source: sourceParam, file, reportID}); - const validatedFiles = validResults.map((r) => r.file); - const firstValidSource = validResults.at(0)?.file.uri; + let isLoading = false; + const isEmptyReport = isEmptyObject(report); + isLoading = + (!isOffline && !isReportNotFound(report) && !!reportID && !!isLoadingApp) || + isEmptyReport || + (reportMetadata?.isLoadingInitialReportActions !== false && shouldFetchReport) || + (Array.isArray(file) && file.length === 0); - setSource(firstValidSource); - setValidFiles(validatedFiles); + const onConfirm = (f: FileObject | FileObject[]) => { + if (Array.isArray(file) && file.length > 0) { + onConfirmParam?.(file); + } else { + onConfirmParam?.(f); } - - validateFiles(); - }, [fileParam]); - - const modalType = useReportAttachmentModalType(source, validFiles); - useNavigateToReportOnRefresh({source: sourceParam, file: validFiles, reportID}); - - const isLoading = useMemo(() => { - if (isOffline || isReportNotFound(report) || !reportID) { - return false; - } - const isEmptyReport = isEmptyObject(report); - return !!isLoadingApp || isEmptyReport || (reportMetadata?.isLoadingInitialReportActions !== false && shouldFetchReport) || (Array.isArray(validFiles) && validFiles.length === 0); - }, [isOffline, report, reportID, isLoadingApp, reportMetadata?.isLoadingInitialReportActions, shouldFetchReport, validFiles]); - - const onConfirm = useCallback( - (f: FileObject | FileObject[]) => { - if (Array.isArray(validFiles) && validFiles.length > 0) { - onConfirmParam?.(validFiles); - } else { - onConfirmParam?.(f); - } - }, - [validFiles, onConfirmParam], - ); + }; const onDownloadAttachment = useDownloadAttachment({ isAuthTokenRequired, }); - useNavigateToReportOnRefresh({source: sourceParam, file: validFiles, reportID}); + useNavigateToReportOnRefresh({source: sourceParam, file, reportID}); - const contentProps = useMemo(() => { - if (validFiles === undefined || (Array.isArray(validFiles) && validFiles.length === 0)) { - return { - isLoading: true, - }; - } - - return { - file: validFiles, + let contentProps: AttachmentModalBaseContentProps; + if (file === undefined || (Array.isArray(file) && file.length === 0)) { + contentProps = { + isLoading: true, + }; + } else { + contentProps = { + file, source, isLoading, isAuthTokenRequired, @@ -157,20 +125,7 @@ function ReportAddAttachmentModalContent({route, navigation}: AttachmentModalScr onDownloadAttachment, AttachmentContent: AddAttachmentModalCarouselView, }; - }, [ - validFiles, - source, - isLoading, - isAuthTokenRequired, - attachmentLink, - originalFileName, - attachmentID, - accountID, - headerTitle, - shouldDisableSendButton, - onConfirm, - onDownloadAttachment, - ]); + } return ( void; + +let mockPDFValidationMode: 'success' | 'password' | 'error' = 'success'; +const mockCaptureConfirmModalProps = jest.fn(); + +const mockValidateAttachmentFile = validateAttachmentFile as jest.MockedFunction; +const mockGetFileValidationErrorText = FileUtils.getFileValidationErrorText as jest.MockedFunction; +const mockResizeImageIfNeeded = FileUtils.resizeImageIfNeeded as jest.MockedFunction; + +jest.mock('@hooks/useThemeStyles', () => ({ + // eslint-disable-next-line @typescript-eslint/naming-convention + __esModule: true, + default: () => + new Proxy( + {}, + { + get: () => ({}), + }, + ), +})); + +jest.mock('@hooks/useLocalize', () => ({ + // eslint-disable-next-line @typescript-eslint/naming-convention + __esModule: true, + default: () => ({ + translate: (key: string) => key, + }), +})); + +jest.mock('@components/FullScreenLoaderContext', () => ({ + useFullScreenLoaderActions: () => ({ + setIsLoaderVisible: jest.fn(), + }), +})); + +jest.mock('@libs/validateAttachmentFile', () => jest.fn()); + +jest.mock('@libs/fileDownload/FileUtils', () => { + const actual = jest.requireActual('@libs/fileDownload/FileUtils'); + + return { + ...actual, + getFileValidationErrorText: jest.fn((_translate: unknown, fileError: {error?: string} | undefined | null) => ({ + title: fileError?.error ?? 'error.title', + reason: fileError?.error ?? 'error.reason', + })), + hasHeicOrHeifExtension: jest.fn((file: FileObject) => !!(file.name?.toLowerCase().endsWith('.heic') ?? file.name?.toLowerCase().endsWith('.heif'))), + splitExtensionFromFileName: jest.fn((fileName: string) => { + const splitFileName = fileName.split('.'); + return {fileExtension: splitFileName.at(-1) ?? ''}; + }), + resizeImageIfNeeded: jest.fn(async (file: FileObject) => file), + }; +}); + +jest.mock('@components/Text', () => { + // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-unsafe-assignment + const {Text: RNText} = require('react-native'); + function MockText({children}: {children: React.ReactNode}) { + return {children}; + } + MockText.displayName = 'Text'; + return MockText; +}); + +jest.mock('@components/TextLink', () => { + // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-unsafe-assignment + const {Text: RNText} = require('react-native'); + function MockTextLink({children, href}: {children: React.ReactNode; href: string}) { + return ( + + {children} + + ); + } + MockTextLink.displayName = 'TextLink'; + return MockTextLink; +}); + +jest.mock('@components/ConfirmModal', () => { + // eslint-disable-next-line @typescript-eslint/no-require-imports + const mockReact = require('react') as {useEffect: (effect: () => void, deps: unknown[]) => void}; + // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-unsafe-assignment + const {Text: RNText, View: RNView} = require('react-native'); + function MockConfirmModal(props: ConfirmModalProps) { + mockReact.useEffect(() => { + mockCaptureConfirmModalProps(props); + }, [props]); + + if (!props.isVisible) { + return null; + } + + return ( + + {props.title} + {props.prompt} + + confirm + + + cancel + + + ); + } + + MockConfirmModal.displayName = 'ConfirmModal'; + return MockConfirmModal; +}); + +jest.mock('@components/PDFThumbnail', () => { + // eslint-disable-next-line @typescript-eslint/no-require-imports + const mockReact = require('react') as {useEffect: (effect: () => void, deps: unknown[]) => void}; + // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-unsafe-assignment + const {View: RNView} = require('react-native'); + function MockPDFThumbnail({onLoadSuccess, onPassword, onLoadError}: {onLoadSuccess: () => void; onPassword: () => void; onLoadError: () => void}) { + mockReact.useEffect(() => { + if (mockPDFValidationMode === 'success') { + onLoadSuccess(); + return; + } + + if (mockPDFValidationMode === 'password') { + onPassword(); + return; + } + + onLoadError(); + }, [onLoadError, onLoadSuccess, onPassword]); + + return ; + } + + MockPDFThumbnail.displayName = 'PDFThumbnail'; + return MockPDFThumbnail; +}); + +function HookHarness({onFilesValidated, onReady}: {onFilesValidated: (files: FileObject[], items: DataTransferItem[]) => void; onReady: (validateFiles: ValidateFiles) => void}) { + const {validateFiles, ErrorModal, PDFValidationComponent} = useFilesValidation(onFilesValidated); + + React.useEffect(() => { + onReady(validateFiles); + }, [onReady, validateFiles]); + + return ( + + {ErrorModal} + {PDFValidationComponent} + + ); +} + +HookHarness.displayName = 'HookHarness'; + +function createFile(overrides?: Partial): FileObject { + return { + name: 'receipt.jpg', + uri: 'file://receipt.jpg', + size: 1000, + ...overrides, + }; +} + +describe('useFilesValidation UI behavior', () => { + beforeEach(() => { + jest.clearAllMocks(); + mockPDFValidationMode = 'success'; + mockCaptureConfirmModalProps.mockReset(); + + jest.spyOn(InteractionManager, 'runAfterInteractions').mockImplementation((task?: unknown) => { + if (typeof task === 'function') { + (task as () => void)(); + } + + return { + then: jest.fn().mockResolvedValue(undefined), + done: jest.fn(), + cancel: jest.fn(), + } as unknown as ReturnType; + }); + }); + + afterEach(() => { + jest.restoreAllMocks(); + }); + + it('renders visible error modal and advances through queued errors on confirm', async () => { + let validateFilesRef: ValidateFiles | undefined; + + mockValidateAttachmentFile + .mockResolvedValueOnce({isValid: false, error: CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE}) + .mockResolvedValueOnce({isValid: false, error: CONST.FILE_VALIDATION_ERRORS.FILE_TOO_SMALL}); + + render( + { + validateFilesRef = validateFiles; + }} + />, + ); + + await act(async () => { + validateFilesRef?.([createFile({name: 'bad.exe'}), createFile({name: 'tiny.jpg'})], undefined, {isValidatingReceipts: true}); + }); + + await waitFor(() => { + expect(screen.getByTestId('error-modal')).toBeTruthy(); + expect(screen.getByTestId('modal-title').props.children).toBe(CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE); + }); + + fireEvent.press(screen.getByTestId('modal-confirm')); + + expect(screen.getByTestId('modal-title').props.children).toBe(CONST.FILE_VALIDATION_ERRORS.FILE_TOO_SMALL); + }); + + it('renders wrong-file-type prompt with learn-more link', async () => { + let validateFilesRef: ValidateFiles | undefined; + mockValidateAttachmentFile.mockResolvedValueOnce({isValid: false, error: CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE}); + + render( + { + validateFilesRef = validateFiles; + }} + />, + ); + + await act(async () => { + validateFilesRef?.([createFile({name: 'bad.xyz'})], undefined, {isValidatingReceipts: true}); + }); + + await waitFor(() => { + expect(screen.getByTestId('text-link')).toBeTruthy(); + }); + expect(screen.getByTestId('text-link').props.accessibilityLabel).toBe(CONST.BULK_UPLOAD_HELP_URL); + }); + + it('renders PDFValidationComponent and opens protected-file error for password-protected PDFs in receipt mode', async () => { + let validateFilesRef: ValidateFiles | undefined; + const pdfFile = createFile({name: 'receipt.pdf', uri: 'file://receipt.pdf'}); + + mockPDFValidationMode = 'password'; + mockValidateAttachmentFile.mockResolvedValueOnce({isValid: true, file: pdfFile}); + mockGetFileValidationErrorText.mockImplementation((_translate: unknown, fileError: {error?: string} | undefined | null) => ({ + title: fileError?.error ?? 'unknown', + reason: fileError?.error ?? 'unknown', + })); + + render( + { + validateFilesRef = validateFiles; + }} + />, + ); + + await act(async () => { + validateFilesRef?.([pdfFile], undefined, {isValidatingReceipts: true}); + }); + + await waitFor(() => { + expect(screen.getByTestId('pdf-thumbnail')).toBeTruthy(); + expect(screen.getByTestId('modal-title').props.children).toBe(CONST.FILE_VALIDATION_ERRORS.PROTECTED_FILE); + }); + + const lastCall = mockCaptureConfirmModalProps.mock.calls.at(-1) as [ConfirmModalProps] | undefined; + expect(lastCall?.[0].isVisible).toBe(true); + }); + + it('shows max file limit error and validates truncated list after confirm', async () => { + let validateFilesRef: ValidateFiles | undefined; + const onFilesValidated = jest.fn(); + + const maxAllowed = CONST.API_ATTACHMENT_VALIDATIONS.MAX_FILE_LIMIT; + const files = Array.from({length: maxAllowed + 1}, (_, index) => createFile({name: `file-${index}.jpg`, uri: `file://${index}.jpg`})); + + mockValidateAttachmentFile.mockImplementation(async (file: FileObject) => ({isValid: true, file})); + + render( + { + validateFilesRef = validateFiles; + }} + />, + ); + + await act(async () => { + validateFilesRef?.(files); + }); + + expect(mockValidateAttachmentFile).not.toHaveBeenCalled(); + expect(screen.getByTestId('modal-title').props.children).toBe(CONST.FILE_VALIDATION_ERRORS.MAX_FILE_LIMIT_EXCEEDED); + + fireEvent.press(screen.getByTestId('modal-confirm')); + + await waitFor(() => { + expect(mockValidateAttachmentFile).toHaveBeenCalledTimes(maxAllowed); + expect(onFilesValidated).toHaveBeenCalledWith(files.slice(0, maxAllowed), []); + }); + }); + + it('maps resize failures to IMAGE_DIMENSIONS_TOO_LARGE and FILE_CORRUPTED errors', async () => { + let validateFilesRef: ValidateFiles | undefined; + const onFilesValidated = jest.fn(); + + const firstImage = createFile({name: 'first.jpg', uri: 'file://first.jpg', size: 3000}); + const secondImage = createFile({name: 'second.jpg', uri: 'file://second.jpg', size: 3000}); + + mockValidateAttachmentFile.mockImplementation(async () => ({ + isValid: false, + error: CONST.FILE_VALIDATION_ERRORS.FILE_TOO_LARGE, + })); + mockResizeImageIfNeeded.mockRejectedValueOnce(new Error(CONST.FILE_VALIDATION_ERRORS.IMAGE_DIMENSIONS_TOO_LARGE)).mockRejectedValueOnce(new Error('unknown')); + + render( + { + validateFilesRef = validateFiles; + }} + />, + ); + + await act(async () => { + validateFilesRef?.([firstImage, secondImage], undefined, {isValidatingReceipts: true}); + }); + + await waitFor(() => { + expect(screen.getByTestId('modal-title').props.children).toBe(CONST.FILE_VALIDATION_ERRORS.IMAGE_DIMENSIONS_TOO_LARGE); + }); + + fireEvent.press(screen.getByTestId('modal-confirm')); + + await waitFor(() => { + expect(screen.getByTestId('modal-title').props.children).toBe(CONST.FILE_VALIDATION_ERRORS.FILE_CORRUPTED); + expect(onFilesValidated).not.toHaveBeenCalled(); + }); + }); + + it('dismisses the error modal on cancel without uploading files', async () => { + let validateFilesRef: ValidateFiles | undefined; + const onFilesValidated = jest.fn(); + + const validFile = createFile({name: 'valid.jpg', uri: 'file://valid.jpg'}); + const invalidFile = createFile({name: 'invalid.xyz', uri: 'file://invalid.xyz'}); + + mockValidateAttachmentFile.mockResolvedValueOnce({isValid: true, file: validFile}).mockResolvedValueOnce({isValid: false, error: CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE}); + + render( + { + validateFilesRef = validateFiles; + }} + />, + ); + + await act(async () => { + validateFilesRef?.([validFile, invalidFile], undefined, {isValidatingReceipts: false}); + }); + + await waitFor(() => { + expect(screen.getByTestId('modal-title').props.children).toBe(CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE); + }); + + fireEvent.press(screen.getByTestId('modal-cancel')); + + await waitFor(() => { + expect(screen.queryByTestId('modal-title')).toBeNull(); + }); + + expect(onFilesValidated).not.toHaveBeenCalled(); + }); +}); diff --git a/tests/unit/useFilesValidationTest.tsx b/tests/unit/useFilesValidationTest.tsx new file mode 100644 index 000000000000..b4f7abf337ff --- /dev/null +++ b/tests/unit/useFilesValidationTest.tsx @@ -0,0 +1,328 @@ +import {act, render, waitFor} from '@testing-library/react-native'; +import React from 'react'; +import {InteractionManager, View} from 'react-native'; +import type {ConfirmModalProps} from '@components/ConfirmModal'; +import * as FullScreenLoaderContext from '@components/FullScreenLoaderContext'; +import useFilesValidation from '@hooks/useFilesValidation'; +import * as FileUtils from '@libs/fileDownload/FileUtils'; +import convertHeicImage from '@libs/fileDownload/heicConverter'; +import Log from '@libs/Log'; +import validateAttachmentFile from '@libs/validateAttachmentFile'; +import type {ValidateAttachmentResult} from '@libs/validateAttachmentFile'; +import CONST from '@src/CONST'; +import type {FileObject} from '@src/types/utils/Attachment'; + +type ValidateFiles = (files: FileObject[], items?: DataTransferItem[], validationOptions?: {isValidatingReceipts?: boolean}) => void; + +const mockCaptureConfirmModalProps = jest.fn(); +let mockPDFValidationMode: 'success' | 'password' | 'error' = 'success'; + +const mockSetIsLoaderVisible = jest.fn(); +const mockWarn = jest.fn(); +const mockValidateAttachmentFile = validateAttachmentFile as jest.MockedFunction; +const mockConvertHeicImage = convertHeicImage as jest.MockedFunction; +const mockResizeImageIfNeeded = FileUtils.resizeImageIfNeeded as jest.MockedFunction; + +jest.mock('@hooks/useThemeStyles', () => ({ + // eslint-disable-next-line @typescript-eslint/naming-convention + __esModule: true, + default: () => + new Proxy( + {}, + { + get: () => ({}), + }, + ), +})); + +jest.mock('@hooks/useLocalize', () => ({ + // eslint-disable-next-line @typescript-eslint/naming-convention + __esModule: true, + default: () => ({ + translate: (key: string) => key, + }), +})); + +jest.mock('@components/FullScreenLoaderContext', () => ({ + useFullScreenLoaderActions: jest.fn(), +})); + +jest.mock('@libs/validateAttachmentFile', () => jest.fn()); +jest.mock('@libs/fileDownload/heicConverter', () => jest.fn()); + +jest.mock('@libs/fileDownload/FileUtils', () => { + const actual = jest.requireActual('@libs/fileDownload/FileUtils'); + + return { + ...actual, + getFileValidationErrorText: jest.fn((_translate: unknown, fileError: {error?: string} | undefined | null) => ({ + title: fileError?.error ?? 'error.title', + reason: fileError?.error ? `reason:${fileError.error}` : 'reason:unknown', + })), + hasHeicOrHeifExtension: jest.fn((file: FileObject) => !!(file.name?.toLowerCase().endsWith('.heic') ?? file.name?.toLowerCase().endsWith('.heif'))), + splitExtensionFromFileName: jest.fn((fileName: string) => { + const splitFileName = fileName.split('.'); + return {fileExtension: splitFileName.at(-1) ?? ''}; + }), + resizeImageIfNeeded: jest.fn(async (file: FileObject) => file), + }; +}); + +jest.mock('@components/Text', () => { + // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-unsafe-assignment + const {Text: RNText} = require('react-native'); + function MockText({children}: {children: React.ReactNode}) { + return {children}; + } + MockText.displayName = 'Text'; + return MockText; +}); + +jest.mock('@components/TextLink', () => { + // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-unsafe-assignment + const {Text: RNText} = require('react-native'); + function MockTextLink({children, href}: {children: React.ReactNode; href: string}) { + return ( + + {children} + + ); + } + MockTextLink.displayName = 'TextLink'; + return MockTextLink; +}); + +jest.mock('@components/ConfirmModal', () => { + // eslint-disable-next-line @typescript-eslint/no-require-imports + const mockReact = require('react') as {useEffect: (effect: () => void, deps: unknown[]) => void}; + // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-unsafe-assignment + const {Text: RNText, View: RNView} = require('react-native'); + function MockConfirmModal(props: ConfirmModalProps) { + mockReact.useEffect(() => { + mockCaptureConfirmModalProps(props); + }, [props]); + + if (!props.isVisible) { + return null; + } + + return ( + + {props.title} + {props.prompt} + + confirm + + + cancel + + + ); + } + MockConfirmModal.displayName = 'ConfirmModal'; + return MockConfirmModal; +}); + +jest.mock('@components/PDFThumbnail', () => { + // eslint-disable-next-line @typescript-eslint/no-require-imports + const mockReact = require('react') as {useEffect: (effect: () => void, deps: unknown[]) => void}; + // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-unsafe-assignment + const {View: RNView} = require('react-native'); + function MockPDFThumbnail({onLoadSuccess, onPassword, onLoadError}: {onLoadSuccess: () => void; onPassword: () => void; onLoadError: () => void}) { + mockReact.useEffect(() => { + if (mockPDFValidationMode === 'success') { + onLoadSuccess(); + return; + } + + if (mockPDFValidationMode === 'password') { + onPassword(); + return; + } + + onLoadError(); + }, [onLoadError, onLoadSuccess, onPassword]); + + return ; + } + + MockPDFThumbnail.displayName = 'PDFThumbnail'; + return MockPDFThumbnail; +}); + +function HookHarness({onFilesValidated, onReady}: {onFilesValidated: (files: FileObject[], items: DataTransferItem[]) => void; onReady: (validateFiles: ValidateFiles) => void}) { + const {validateFiles, ErrorModal, PDFValidationComponent} = useFilesValidation(onFilesValidated); + + React.useEffect(() => { + onReady(validateFiles); + }, [onReady, validateFiles]); + + return ( + + {ErrorModal} + {PDFValidationComponent} + + ); +} + +HookHarness.displayName = 'HookHarness'; + +function createFile(overrides?: Partial): FileObject { + return { + name: 'test.jpg', + uri: `file://${Math.random().toString(16).slice(2)}.jpg`, + size: 1024, + ...overrides, + }; +} + +function getHarness(onFilesValidated: (files: FileObject[], items: DataTransferItem[]) => void) { + let validateFilesRef: ValidateFiles | undefined; + render( + { + validateFilesRef = validateFiles; + }} + />, + ); + + return { + validateFiles(files: FileObject[], items?: DataTransferItem[], validationOptions?: {isValidatingReceipts?: boolean}) { + validateFilesRef?.(files, items, validationOptions); + }, + }; +} + +describe('useFilesValidation', () => { + beforeEach(() => { + jest.clearAllMocks(); + mockPDFValidationMode = 'success'; + jest.spyOn(Log, 'warn').mockImplementation((...args: Parameters) => { + mockWarn(...args); + }); + + jest.mocked(FullScreenLoaderContext.useFullScreenLoaderActions).mockReturnValue({ + setIsLoaderVisible: mockSetIsLoaderVisible, + }); + + jest.spyOn(InteractionManager, 'runAfterInteractions').mockImplementation((task?: unknown) => { + if (typeof task === 'function') { + (task as () => void)(); + } + + return { + then: jest.fn().mockResolvedValue(undefined), + done: jest.fn(), + cancel: jest.fn(), + } as unknown as ReturnType; + }); + }); + + afterEach(() => { + jest.restoreAllMocks(); + }); + + it('calls onFilesValidated for valid non-pdf files and keeps original order', async () => { + const onFilesValidated = jest.fn(); + const harnessRef = getHarness(onFilesValidated); + const firstFile = createFile({name: 'z.png', uri: 'file://z.png'}); + const secondFile = createFile({name: 'a.png', uri: 'file://a.png'}); + + mockValidateAttachmentFile.mockResolvedValueOnce({isValid: true, file: firstFile}).mockResolvedValueOnce({isValid: true, file: secondFile}); + + await act(async () => { + harnessRef.validateFiles([firstFile, secondFile], [] as DataTransferItem[]); + }); + + await waitFor(() => { + expect(onFilesValidated).toHaveBeenCalledWith([firstFile, secondFile], []); + }); + }); + + it('converts heic and resizes when validating receipts', async () => { + const onFilesValidated = jest.fn(); + const harnessRef = getHarness(onFilesValidated); + + const heicFile = createFile({name: 'receipt.heic', uri: 'file://receipt.heic', size: 4000}); + const convertedFile = createFile({name: 'receipt.jpg', uri: 'file://converted.jpg', size: CONST.API_ATTACHMENT_VALIDATIONS.RECEIPT_MAX_SIZE + 10}); + const resizedFile = createFile({name: 'receipt-resized.jpg', uri: 'file://resized.jpg', size: CONST.API_ATTACHMENT_VALIDATIONS.RECEIPT_MAX_SIZE - 1}); + + const heicInvalidResult: ValidateAttachmentResult = { + isValid: false, + error: CONST.FILE_VALIDATION_ERRORS.HEIC_OR_HEIF_IMAGE, + }; + + mockValidateAttachmentFile.mockResolvedValueOnce(heicInvalidResult); + mockConvertHeicImage.mockImplementation((_file, callbacks) => { + callbacks?.onSuccess?.(convertedFile); + }); + mockResizeImageIfNeeded.mockResolvedValueOnce(resizedFile); + + await act(async () => { + harnessRef.validateFiles([heicFile], undefined, {isValidatingReceipts: true}); + }); + + await waitFor(() => { + expect(onFilesValidated).toHaveBeenCalledWith([resizedFile], []); + }); + + expect(mockSetIsLoaderVisible).toHaveBeenNthCalledWith(1, true); + expect(mockSetIsLoaderVisible).toHaveBeenLastCalledWith(false); + }); + + it('handles pdf thumbnail callbacks for password-protected PDFs in receipts mode', async () => { + const onFilesValidated = jest.fn(); + const harnessRef = getHarness(onFilesValidated); + + const pdfFile = createFile({name: 'receipt.pdf', uri: 'file://receipt.pdf'}); + mockValidateAttachmentFile.mockResolvedValueOnce({isValid: true, file: pdfFile}); + mockPDFValidationMode = 'password'; + + await act(async () => { + harnessRef.validateFiles([pdfFile], undefined, {isValidatingReceipts: true}); + }); + + await waitFor(() => expect(mockValidateAttachmentFile).toHaveBeenCalledTimes(1)); + expect(onFilesValidated).not.toHaveBeenCalled(); + }); + + it('warns and skips duplicate validation calls when already validating', async () => { + const onFilesValidated = jest.fn(); + const harnessRef = getHarness(onFilesValidated); + const firstFile = createFile({name: 'first.jpg'}); + const secondFile = createFile({name: 'second.jpg'}); + + let resolveFirstValidation: (() => void) | undefined; + const pendingValidation = new Promise((resolve) => { + resolveFirstValidation = resolve; + }); + mockValidateAttachmentFile.mockImplementation(async () => { + await pendingValidation; + return {isValid: true, file: firstFile}; + }); + + act(() => { + harnessRef.validateFiles([firstFile]); + }); + + act(() => { + harnessRef.validateFiles([secondFile]); + }); + + expect(mockWarn).toHaveBeenCalledWith('Files are already being validated. Please wait for the current validation to complete before calling `validateFiles` again.'); + + await act(async () => { + resolveFirstValidation?.(); + }); + }); +});