Skip to content
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 55 additions & 22 deletions src/hooks/useFilesValidation.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,41 @@ import {
validateAttachment,
validateImageForCorruption,
} from '@libs/fileDownload/FileUtils';
import type {ValidateAttachmentOptions} from '@libs/fileDownload/FileUtils';
import convertHeicImage from '@libs/fileDownload/heicConverter';
import Log from '@libs/Log';
import CONST from '@src/CONST';
import type {FileObject} from '@src/types/utils/Attachment';
import useLocalize from './useLocalize';
import useThemeStyles from './useThemeStyles';

const DEFAULT_IS_VALIDATING_RECEIPTS = true;

type ErrorObject = {
error: ValueOf<typeof CONST.FILE_VALIDATION_ERRORS>;
fileExtension?: string;
};

type ValidationOptions = {
isValidatingReceipts?: boolean;
};

const sortFilesByOriginalOrder = (files: FileObject[], orderMap: Map<string, number>) => {
return files.sort((a, b) => (orderMap.get(a.uri ?? '') ?? 0) - (orderMap.get(b.uri ?? '') ?? 0));
};

function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTransferItems: DataTransferItem[]) => void, isValidatingReceipts = true) {
function useFilesValidation(onFilesValidated: (files: FileObject[], dataTransferItems: DataTransferItem[]) => void) {
const styles = useThemeStyles();
const {translate} = useLocalize();

const [isValidatingFiles, setIsValidatingFiles] = useState(false);
const [isValidatingReceipts, setIsValidatingReceipts] = useState<boolean>();
const [isValidatingMultipleFiles, setIsValidatingMultipleFiles] = useState(false);

const [isErrorModalVisible, setIsErrorModalVisible] = useState(false);
const [fileError, setFileError] = useState<ValueOf<typeof CONST.FILE_VALIDATION_ERRORS> | null>(null);
const [pdfFilesToRender, setPdfFilesToRender] = useState<FileObject[]>([]);
const [validFilesToUpload, setValidFilesToUpload] = useState([] as FileObject[]);
const [isValidatingMultipleFiles, setIsValidatingMultipleFiles] = useState(false);
const [invalidFileExtension, setInvalidFileExtension] = useState('');
const [errorQueue, setErrorQueue] = useState<ErrorObject[]>([]);
const [currentErrorIndex, setCurrentErrorIndex] = useState(0);
Expand Down Expand Up @@ -71,11 +83,13 @@ function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTr
}, []);

const resetValidationState = useCallback(() => {
setIsValidatingFiles(false);
setIsValidatingReceipts(undefined);
setIsValidatingMultipleFiles(false);
setIsErrorModalVisible(false);
setPdfFilesToRender([]);
setIsLoaderVisible(false);
setValidFilesToUpload([]);
setIsValidatingMultipleFiles(false);
setFileError(null);
setInvalidFileExtension('');
setErrorQueue([]);
Expand All @@ -101,7 +115,7 @@ function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTr
setIsErrorModalVisible(true);
};

const isValidFile = (originalFile: FileObject, item: DataTransferItem | undefined, isCheckingMultipleFiles?: boolean) => {
const isValidFile = (originalFile: FileObject, item: DataTransferItem | undefined, validationOptions: ValidateAttachmentOptions) => {
if (item && item.kind === 'file' && 'webkitGetAsEntry' in item) {
const entry = item.webkitGetAsEntry();

Expand All @@ -114,7 +128,7 @@ function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTr
return normalizeFileObject(originalFile)
.then((normalizedFile) =>
validateImageForCorruption(normalizedFile).then(() => {
const error = validateAttachment(normalizedFile, isCheckingMultipleFiles, isValidatingReceipts);
const error = validateAttachment(normalizedFile, validationOptions);
if (error) {
const errorData = {
error,
Expand Down Expand Up @@ -170,12 +184,12 @@ function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTr
}
} else if (validFiles.current.length > 0) {
const sortedFiles = sortFilesByOriginalOrder(validFiles.current, originalFileOrder.current);
proceedWithFilesAction(sortedFiles, dataTransferItemList.current);
onFilesValidated(sortedFiles, dataTransferItemList.current);
resetValidationState();
}
}, [deduplicateErrors, pdfFilesToRender.length, proceedWithFilesAction, resetValidationState]);
}, [deduplicateErrors, pdfFilesToRender.length, onFilesValidated, resetValidationState]);

const validateAndResizeFiles = (files: FileObject[], items: DataTransferItem[]) => {
const validateAndResizeFiles = (files: FileObject[], items: DataTransferItem[], validationOptions?: ValidationOptions) => {
// Early return for empty files
if (files.length === 0) {
return;
Expand All @@ -188,7 +202,13 @@ function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTr
originalFileOrder.current.set(file.uri ?? '', index);
});

Promise.all(files.map((file, index) => isValidFile(file, items.at(index), files.length > 1).then((isValid) => (isValid ? file : null))))
Promise.all(
files.map((file, index) =>
isValidFile(file, items.at(index), {isValidatingMultipleFiles: files.length > 1, isValidatingReceipts: validationOptions?.isValidatingReceipts ?? isValidatingReceipts}).then(
(isValid) => (isValid ? file : null),
),
),
)
.then((validationResults) => {
const filteredResults = validationResults.filter((result): result is FileObject => result !== null);
const pdfsToLoad = filteredResults.filter((file) => Str.isPDF(file.name ?? ''));
Expand Down Expand Up @@ -258,14 +278,27 @@ function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTr
}
} else if (processedFiles.length > 0) {
const sortedFiles = sortFilesByOriginalOrder(processedFiles, originalFileOrder.current);
proceedWithFilesAction(sortedFiles, dataTransferItemList.current);
onFilesValidated(sortedFiles, dataTransferItemList.current);
resetValidationState();
}
}
});
};

const validateFiles = (files: FileObject[], items?: DataTransferItem[]) => {
const validateFiles = (files: FileObject[], items?: DataTransferItem[], validationOptions?: ValidationOptions) => {
if (isValidatingFiles) {
Log.warn('Files are already being validated. Please wait for the current validation to complete before calling `validateFiles` again.');
return;
}

setIsValidatingFiles(true);

const validationOptionsWithDefaults = {
...validationOptions,
isValidatingReceipts: validationOptions?.isValidatingReceipts ?? DEFAULT_IS_VALIDATING_RECEIPTS,
};
setIsValidatingReceipts(validationOptionsWithDefaults.isValidatingReceipts);

if (files.length > 1) {
setIsValidatingMultipleFiles(true);
}
Expand All @@ -276,11 +309,11 @@ function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTr
}
setErrorAndOpenModal(CONST.FILE_VALIDATION_ERRORS.MAX_FILE_LIMIT_EXCEEDED);
} else {
validateAndResizeFiles(files, items ?? []);
validateAndResizeFiles(files, items ?? [], validationOptionsWithDefaults);
}
};

const onConfirm = () => {
const onConfirmError = () => {
if (fileError === CONST.FILE_VALIDATION_ERRORS.MAX_FILE_LIMIT_EXCEEDED) {
setIsErrorModalVisible(false);
validateAndResizeFiles(filesToValidate.current, dataTransferItemList.current);
Expand All @@ -304,18 +337,18 @@ function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTr
const sortedFiles = sortFilesByOriginalOrder(validFilesToUpload, originalFileOrder.current);
// If we're validating attachments we need to use InteractionManager to ensure
// the error modal is dismissed before opening the attachment modal
if (!isValidatingReceipts && fileError) {
if (isValidatingReceipts === false && fileError) {
setIsErrorModalVisible(false);
// eslint-disable-next-line @typescript-eslint/no-deprecated
InteractionManager.runAfterInteractions(() => {
if (sortedFiles.length !== 0) {
proceedWithFilesAction(sortedFiles, dataTransferItemList.current);
onFilesValidated(sortedFiles, dataTransferItemList.current);
}
resetValidationState();
});
} else {
if (sortedFiles.length !== 0) {
proceedWithFilesAction(sortedFiles, dataTransferItemList.current);
onFilesValidated(sortedFiles, dataTransferItemList.current);
}
hideModalAndReset();
}
Expand All @@ -334,7 +367,7 @@ function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTr
}}
onPassword={() => {
validatedPDFs.current.push(file);
if (isValidatingReceipts) {
if (isValidatingReceipts === true) {
collectedErrors.current.push({error: CONST.FILE_VALIDATION_ERRORS.PROTECTED_FILE});
} else {
validFiles.current.push(file);
Expand All @@ -350,11 +383,11 @@ function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTr
))
: undefined;

const getModalPrompt = useCallback(() => {
const getModalPrompt = () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you remove the useCallback here?

Copy link
Contributor Author

@chrispader chrispader Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the file can be successfully compiled with React Compiler and therefore we can remove manual memoization like in other callbacks.

Now on a second look, there are still some usages of useCallback, which can be removed. Are we good with allowing React Compiler to do it's thing in this hook? @mountiny

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok that makes sense. Thanks! @adamgrzybowski @kacper-mikolajczak Seems like we will need to tweak the AI reviewer to acknoledge this though I am not sure how easy it will be so the reviewer knows if the file is compilable with the react compiler

if (!fileError) {
return '';
}
const prompt = getFileValidationErrorText(fileError, {fileType: invalidFileExtension}, isValidatingReceipts).reason;
const prompt = getFileValidationErrorText(fileError, {fileType: invalidFileExtension}, isValidatingReceipts === true).reason;
if (fileError === CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE_MULTIPLE || fileError === CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE) {
return (
<Text>
Expand All @@ -364,12 +397,12 @@ function useFilesValidation(proceedWithFilesAction: (files: FileObject[], dataTr
);
}
return prompt;
}, [fileError, invalidFileExtension, isValidatingReceipts, translate]);
};

const ErrorModal = (
<ConfirmModal
title={getFileValidationErrorText(fileError, {fileType: invalidFileExtension}, isValidatingReceipts).title}
onConfirm={onConfirm}
title={getFileValidationErrorText(fileError, {fileType: invalidFileExtension}, isValidatingReceipts === true).title}
onConfirm={onConfirmError}
onCancel={hideModalAndReset}
isVisible={isErrorModalVisible}
prompt={getModalPrompt()}
Expand Down
20 changes: 14 additions & 6 deletions src/libs/fileDownload/FileUtils.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/* eslint-disable @typescript-eslint/no-deprecated */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't need this now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the catch!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@parasharrajat Actually we do need this, my bad. I don't see that usages of translateLocal we're removed from this file

import {Str} from 'expensify-common';
import {Alert, Linking, Platform} from 'react-native';
import type {ReactNativeBlobUtilReadStream} from 'react-native-blob-util';
Expand Down Expand Up @@ -549,18 +550,23 @@ const normalizeFileObject = (file: FileObject): Promise<FileObject> => {
});
};

const validateAttachment = (file: FileObject, isCheckingMultipleFiles?: boolean, isValidatingReceipt?: boolean) => {
const maxFileSize = isValidatingReceipt ? CONST.API_ATTACHMENT_VALIDATIONS.RECEIPT_MAX_SIZE : CONST.API_ATTACHMENT_VALIDATIONS.MAX_SIZE;
type ValidateAttachmentOptions = {
isValidatingReceipts?: boolean;
isValidatingMultipleFiles?: boolean;
};

const validateAttachment = (file: FileObject, validationOptions?: ValidateAttachmentOptions) => {
const maxFileSize = validationOptions?.isValidatingReceipts ? CONST.API_ATTACHMENT_VALIDATIONS.RECEIPT_MAX_SIZE : CONST.API_ATTACHMENT_VALIDATIONS.MAX_SIZE;

if (isValidatingReceipt && !isValidReceiptExtension(file)) {
return isCheckingMultipleFiles ? CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE_MULTIPLE : CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE;
if (validationOptions?.isValidatingReceipts && !isValidReceiptExtension(file)) {
return validationOptions?.isValidatingMultipleFiles ? CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE_MULTIPLE : CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE;
}

if (!Str.isImage(file.name ?? '') && !hasHeicOrHeifExtension(file) && (file?.size ?? 0) > maxFileSize) {
return isCheckingMultipleFiles ? CONST.FILE_VALIDATION_ERRORS.FILE_TOO_LARGE_MULTIPLE : CONST.FILE_VALIDATION_ERRORS.FILE_TOO_LARGE;
return validationOptions?.isValidatingMultipleFiles ? CONST.FILE_VALIDATION_ERRORS.FILE_TOO_LARGE_MULTIPLE : CONST.FILE_VALIDATION_ERRORS.FILE_TOO_LARGE;
}

if (isValidatingReceipt && (file?.size ?? 0) < CONST.API_ATTACHMENT_VALIDATIONS.MIN_SIZE) {
if (validationOptions?.isValidatingReceipts && (file?.size ?? 0) < CONST.API_ATTACHMENT_VALIDATIONS.MIN_SIZE) {
return CONST.FILE_VALIDATION_ERRORS.FILE_TOO_SMALL;
}

Expand Down Expand Up @@ -777,3 +783,5 @@ export {
cleanFileObject,
cleanFileObjectName,
};

export type {ValidateAttachmentOptions};
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ function useAttachmentUploadValidation({
);
};

const {validateFiles, PDFValidationComponent, ErrorModal} = useFilesValidation(onFilesValidated, false);
const {validateFiles, PDFValidationComponent, ErrorModal} = useFilesValidation(onFilesValidated);

const validateAttachments = useCallback(
({dragEvent, files}: {dragEvent?: DragEvent; files?: FileObject | FileObject[]}) => {
Expand Down Expand Up @@ -161,7 +161,7 @@ function useAttachmentUploadValidation({
const filteredItems = dataTransferItems && validIndices.length > 0 ? validIndices.map((index) => dataTransferItems.at(index) ?? ({} as DataTransferItem)) : undefined;

attachmentUploadType.current = 'attachment';
validateFiles(fileObjects, filteredItems);
validateFiles(fileObjects, filteredItems, {isValidatingReceipts: false});
},
[isAttachmentPreviewActive, validateFiles],
);
Expand All @@ -187,7 +187,7 @@ function useAttachmentUploadValidation({
}

attachmentUploadType.current = 'receipt';
validateFiles(files, items);
validateFiles(files, items, {isValidatingReceipts: true});
},
[policy, shouldAddOrReplaceReceipt, transactionID, validateFiles],
);
Expand Down
14 changes: 7 additions & 7 deletions tests/unit/FileUtilsTest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ describe('FileUtils', () => {
describe('validateAttachment', () => {
it('should not return FILE_TOO_SMALL when validating small attachment', () => {
const file = createMockFile('file.csv', CONST.API_ATTACHMENT_VALIDATIONS.MIN_SIZE - 1);
const error = FileUtils.validateAttachment(file, false, false);
const error = FileUtils.validateAttachment(file, {isValidatingMultipleFiles: false, isValidatingReceipts: false});
expect(error).not.toBe(CONST.FILE_VALIDATION_ERRORS.FILE_TOO_SMALL);
});

it('should return FILE_TOO_SMALL when validating small receipt', () => {
const file = createMockFile('receipt.jpg', CONST.API_ATTACHMENT_VALIDATIONS.MIN_SIZE - 1);
const error = FileUtils.validateAttachment(file, false, true);
const error = FileUtils.validateAttachment(file, {isValidatingMultipleFiles: false, isValidatingReceipts: true});
expect(error).toBe(CONST.FILE_VALIDATION_ERRORS.FILE_TOO_SMALL);
});

Expand All @@ -65,31 +65,31 @@ describe('FileUtils', () => {

it('should return FILE_TOO_LARGE_MULTIPLE when checking multiple files', () => {
const file = createMockFile('file.pdf', CONST.API_ATTACHMENT_VALIDATIONS.MAX_SIZE + 1);
const error = FileUtils.validateAttachment(file, true);
const error = FileUtils.validateAttachment(file, {isValidatingMultipleFiles: true, isValidatingReceipts: false});
expect(error).toBe(CONST.FILE_VALIDATION_ERRORS.FILE_TOO_LARGE_MULTIPLE);
});

it('should return WRONG_FILE_TYPE for invalid receipt extension', () => {
const file = createMockFile('receipt.exe', CONST.API_ATTACHMENT_VALIDATIONS.RECEIPT_MAX_SIZE - 1);
const error = FileUtils.validateAttachment(file, false, true);
const error = FileUtils.validateAttachment(file, {isValidatingMultipleFiles: false, isValidatingReceipts: true});
expect(error).toBe(CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE);
});

it('should prioritize WRONG_FILE_TYPE over FILE_TOO_LARGE for receipts', () => {
const file = createMockFile('receipt.exe', CONST.API_ATTACHMENT_VALIDATIONS.RECEIPT_MAX_SIZE + 10);
const error = FileUtils.validateAttachment(file, false, true);
const error = FileUtils.validateAttachment(file, {isValidatingMultipleFiles: false, isValidatingReceipts: true});
expect(error).toBe(CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE);
});

it('should return WRONG_FILE_TYPE_MULTIPLE when checking multiple invalid receipt files', () => {
const file = createMockFile('receipt.exe', CONST.API_ATTACHMENT_VALIDATIONS.RECEIPT_MAX_SIZE + 10);
const error = FileUtils.validateAttachment(file, true, true);
const error = FileUtils.validateAttachment(file, {isValidatingMultipleFiles: true, isValidatingReceipts: true});
expect(error).toBe(CONST.FILE_VALIDATION_ERRORS.WRONG_FILE_TYPE_MULTIPLE);
});

it('should return empty string for valid image receipt', () => {
const file = createMockFile('receipt.jpg', CONST.API_ATTACHMENT_VALIDATIONS.RECEIPT_MAX_SIZE - 1);
const error = FileUtils.validateAttachment(file, false, true);
const error = FileUtils.validateAttachment(file, {isValidatingMultipleFiles: false, isValidatingReceipts: true});
expect(error).toBe('');
});
});
Expand Down
Loading