chore: onBatchStart provides all file info

Author: zombieJ

src/AjaxUploader.tsx

@@ -110,7 +110,7 @@ class AjaxUploader extends Component<UploadProps> {
       const { onBatchStart } = this.props;
       const enabledFiles = fileList.filter(file => file);
 
-      onBatchStart?.(enabledFiles.map(file => file.origin));
+      onBatchStart?.(fileList.map(({ origin, parsedFile }) => ({ file: origin, parsedFile })));
 
       enabledFiles.forEach(file => {
         this.post(file);
@@ -126,9 +126,19 @@ class AjaxUploader extends Component<UploadProps> {
 
     let transformedFile: BeforeUploadFileType | void = file;
     if (beforeUpload) {
-      transformedFile = await beforeUpload(file, fileList);
+      try {
+        transformedFile = await beforeUpload(file, fileList);
+      } catch (e) {
+        // Rejection will also trade as false
+        transformedFile = false;
+      }
       if (transformedFile === false) {
-        return null;
+        return {
+          origin: file,
+          parsedFile: null,
+          action: null,
+          data: null,
+        };
       }
     }
 

src/interface.tsx

@@ -18,7 +18,9 @@ export interface UploadProps
   headers?: UploadRequestHeader;
   accept?: string;
   multiple?: boolean;
-  onBatchStart?: (fileList: RcFile[]) => void;
+  onBatchStart?: (
+    fileList: { file: RcFile; parsedFile: Exclude<BeforeUploadFileType, boolean> }[],
+  ) => void;
   onStart?: (file: RcFile) => void;
   onError?: (error: Error, ret: object, file: RcFile) => void;
   onSuccess?: (response: object, file: RcFile, xhr: object) => void;

tests/uploader.spec.js

@@ -459,6 +459,13 @@ describe('uploader', () => {
         },
       },
     ];
+
+    const batchEventFiles = files.map(file =>
+      expect.objectContaining({
+        file,
+      }),
+    );
+
     const sleep = (timeout = 500) => new Promise(resolve => setTimeout(resolve, timeout));
 
     async function testWrapper(props) {
@@ -482,7 +489,7 @@ describe('uploader', () => {
 
     it('trigger without pending', async () => {
       const onBatchStart = await testWrapper();
-      expect(onBatchStart).toHaveBeenCalledWith(files);
+      expect(onBatchStart).toHaveBeenCalledWith(batchEventFiles);
     });
 
     it('trigger with beforeUpload delay', async () => {
@@ -497,7 +504,7 @@ describe('uploader', () => {
       const onBatchStart = await testWrapper({ beforeUpload });
 
       expect(beforeUpload).toHaveBeenCalledTimes(2);
-      expect(onBatchStart).toHaveBeenCalledWith(files);
+      expect(onBatchStart).toHaveBeenCalledWith(batchEventFiles);
     });
 
     it('beforeUpload but one is deny', async () => {
@@ -512,7 +519,14 @@ describe('uploader', () => {
       const onBatchStart = await testWrapper({ beforeUpload });
 
       expect(beforeUpload).toHaveBeenCalledTimes(2);
-      expect(onBatchStart).toHaveBeenCalledWith(files.filter(f => f.name !== 'light.png'));
+      expect(onBatchStart).toHaveBeenCalledWith(
+        files.map(file =>
+          expect.objectContaining({
+            file,
+            parsedFile: file.name === 'light.png' ? null : file,
+          }),
+        ),
+      );
     });
 
     it('action delay', async () => {
@@ -524,7 +538,7 @@ describe('uploader', () => {
       const onBatchStart = await testWrapper({ action });
 
       expect(action).toHaveBeenCalledTimes(2);
-      expect(onBatchStart).toHaveBeenCalledWith(files);
+      expect(onBatchStart).toHaveBeenCalledWith(batchEventFiles);
     });
 
     it('data delay', async () => {
@@ -536,7 +550,7 @@ describe('uploader', () => {
       const onBatchStart = await testWrapper({ data });
 
       expect(data).toHaveBeenCalledTimes(2);
-      expect(onBatchStart).toHaveBeenCalledWith(files);
+      expect(onBatchStart).toHaveBeenCalledWith(batchEventFiles);
     });
   });
 });