Merge branch '20029-collection-batch-file-operations' into main. Closes #20029 and...
authorStephen Smith <stephen@curii.com>
Fri, 17 Mar 2023 14:31:09 +0000 (10:31 -0400)
committerStephen Smith <stephen@curii.com>
Fri, 17 Mar 2023 14:31:09 +0000 (10:31 -0400)
Arvados-DCO-1.1-Signed-off-by: Stephen Smith <stephen@curii.com>

src/services/collection-service/collection-service.test.ts
src/services/collection-service/collection-service.ts
src/store/collection-panel/collection-panel-files/collection-panel-files-actions.ts

index 4be17213cdeb6e161cf58d867c020e65d92ba8ca..304cbfd3110d056fa57f12cd0c455b1d53ffee6c 100644 (file)
@@ -7,7 +7,7 @@ import MockAdapter from 'axios-mock-adapter';
 import { snakeCase } from 'lodash';
 import { CollectionResource, defaultCollectionSelectedFields } from 'models/collection';
 import { AuthService } from '../auth-service/auth-service';
-import { CollectionService } from './collection-service';
+import { CollectionService, emptyCollectionPdh } from './collection-service';
 
 describe('collection-service', () => {
     let collectionService: CollectionService;
@@ -23,10 +23,12 @@ describe('collection-service', () => {
         webdavClient = {
             delete: jest.fn(),
             upload: jest.fn(),
+            mkdir: jest.fn(),
         } as any;
         authService = {} as AuthService;
         actions = {
             progressFn: jest.fn(),
+            errorFn: jest.fn(),
         } as any;
         collectionService = new CollectionService(serverApi, webdavClient, authService, actions);
         collectionService.update = jest.fn();
@@ -127,42 +129,327 @@ describe('collection-service', () => {
     describe('deleteFiles', () => {
         it('should remove no files', async () => {
             // given
+            serverApi.put = jest.fn(() => Promise.resolve({ data: {} }));
             const filePaths: string[] = [];
-            const collectionUUID = '';
+            const collectionUUID = 'zzzzz-tpzed-5o5tg0l9a57gxxx';
 
             // when
             await collectionService.deleteFiles(collectionUUID, filePaths);
 
             // then
-            expect(webdavClient.delete).not.toHaveBeenCalled();
+            expect(serverApi.put).toHaveBeenCalledTimes(1);
+            expect(serverApi.put).toHaveBeenCalledWith(
+                `/collections/${collectionUUID}`, {
+                    collection: {
+                        preserve_version: true
+                    },
+                    replace_files: {},
+                }
+            );
         });
 
         it('should remove only root files', async () => {
             // given
+            serverApi.put = jest.fn(() => Promise.resolve({ data: {} }));
             const filePaths: string[] = ['/root/1', '/root/1/100', '/root/1/100/test.txt', '/root/2', '/root/2/200', '/root/3/300/test.txt'];
-            const collectionUUID = '';
+            const collectionUUID = 'zzzzz-tpzed-5o5tg0l9a57gxxx';
 
             // when
             await collectionService.deleteFiles(collectionUUID, filePaths);
 
             // then
-            expect(webdavClient.delete).toHaveBeenCalledTimes(3);
-            expect(webdavClient.delete).toHaveBeenCalledWith("c=/root/3/300/test.txt");
-            expect(webdavClient.delete).toHaveBeenCalledWith("c=/root/2");
-            expect(webdavClient.delete).toHaveBeenCalledWith("c=/root/1");
+            expect(serverApi.put).toHaveBeenCalledTimes(1);
+            expect(serverApi.put).toHaveBeenCalledWith(
+                `/collections/${collectionUUID}`, {
+                    collection: {
+                        preserve_version: true
+                    },
+                    replace_files: {
+                        '/root/3/300/test.txt': '',
+                        '/root/2': '',
+                        '/root/1': '',
+                    },
+                }
+            );
         });
 
-        it('should remove files with uuid prefix', async () => {
+        it('should batch remove files', async () => {
+            serverApi.put = jest.fn(() => Promise.resolve({ data: {} }));
             // given
-            const filePaths: string[] = ['/root/1'];
-            const collectionUUID = 'zzzzz-tpzed-5o5tg0l9a57gxxx';
+            const filePaths: string[] = ['/root/1', '/secondFile', 'barefile.txt'];
+            const collectionUUID = 'zzzzz-4zz18-5o5tg0l9a57gxxx';
 
             // when
             await collectionService.deleteFiles(collectionUUID, filePaths);
 
             // then
-            expect(webdavClient.delete).toHaveBeenCalledTimes(1);
-            expect(webdavClient.delete).toHaveBeenCalledWith("c=zzzzz-tpzed-5o5tg0l9a57gxxx/root/1");
+            expect(serverApi.put).toHaveBeenCalledTimes(1);
+            expect(serverApi.put).toHaveBeenCalledWith(
+                `/collections/${collectionUUID}`, {
+                    collection: {
+                        preserve_version: true
+                    },
+                    replace_files: {
+                        '/root/1': '',
+                        '/secondFile': '',
+                        '/barefile.txt': '',
+                    },
+                }
+            );
+        });
+    });
+
+    describe('renameFile', () => {
+        it('should rename file', async () => {
+            serverApi.put = jest.fn(() => Promise.resolve({ data: {} }));
+            const collectionUuid = 'zzzzz-4zz18-ywq0rvhwwhkjnfq';
+            const collectionPdh = '8cd9ce1dfa21c635b620b1bfee7aaa08+180';
+            const oldPath = '/old/path';
+            const newPath = '/new/filename';
+
+            await collectionService.renameFile(collectionUuid, collectionPdh, oldPath, newPath);
+
+            expect(serverApi.put).toHaveBeenCalledTimes(1);
+            expect(serverApi.put).toHaveBeenCalledWith(
+                `/collections/${collectionUuid}`, {
+                    collection: {
+                        preserve_version: true
+                    },
+                    replace_files: {
+                        [newPath]: `${collectionPdh}${oldPath}`,
+                        [oldPath]: '',
+                    },
+                }
+            );
         });
     });
+
+    describe('copyFiles', () => {
+        it('should batch copy files', async () => {
+            serverApi.put = jest.fn(() => Promise.resolve({ data: {} }));
+            const filePaths: string[] = ['/root/1', '/secondFile', 'barefile.txt'];
+            const sourcePdh = '8cd9ce1dfa21c635b620b1bfee7aaa08+180';
+
+            const destinationUuid = 'zzzzz-4zz18-ywq0rvhwwhkjnfq';
+            const destinationPath = '/destinationPath';
+
+            // when
+            await collectionService.copyFiles(sourcePdh, filePaths, destinationUuid, destinationPath);
+
+            // then
+            expect(serverApi.put).toHaveBeenCalledTimes(1);
+            expect(serverApi.put).toHaveBeenCalledWith(
+                `/collections/${destinationUuid}`, {
+                    collection: {
+                        preserve_version: true
+                    },
+                    replace_files: {
+                        [`${destinationPath}/1`]: `${sourcePdh}/root/1`,
+                        [`${destinationPath}/secondFile`]: `${sourcePdh}/secondFile`,
+                        [`${destinationPath}/barefile.txt`]: `${sourcePdh}/barefile.txt`,
+                    },
+                }
+            );
+        });
+
+        it('should copy files from rooth', async () => {
+            // Test copying from root paths
+            serverApi.put = jest.fn(() => Promise.resolve({ data: {} }));
+            const filePaths: string[] = ['/'];
+            const sourcePdh = '8cd9ce1dfa21c635b620b1bfee7aaa08+180';
+
+            const destinationUuid = 'zzzzz-4zz18-ywq0rvhwwhkjnfq';
+            const destinationPath = '/destinationPath';
+
+            await collectionService.copyFiles(sourcePdh, filePaths, destinationUuid, destinationPath);
+
+            expect(serverApi.put).toHaveBeenCalledTimes(1);
+            expect(serverApi.put).toHaveBeenCalledWith(
+                `/collections/${destinationUuid}`, {
+                    collection: {
+                        preserve_version: true
+                    },
+                    replace_files: {
+                        [`${destinationPath}`]: `${sourcePdh}/`,
+                    },
+                }
+            );
+        });
+
+        it('should copy files to root path', async () => {
+            // Test copying to root paths
+            serverApi.put = jest.fn(() => Promise.resolve({ data: {} }));
+            const filePaths: string[] = ['/'];
+            const sourcePdh = '8cd9ce1dfa21c635b620b1bfee7aaa08+180';
+
+            const destinationUuid = 'zzzzz-4zz18-ywq0rvhwwhkjnfq';
+            const destinationPath = '/';
+
+            await collectionService.copyFiles(sourcePdh, filePaths, destinationUuid, destinationPath);
+
+            expect(serverApi.put).toHaveBeenCalledTimes(1);
+            expect(serverApi.put).toHaveBeenCalledWith(
+                `/collections/${destinationUuid}`, {
+                    collection: {
+                        preserve_version: true
+                    },
+                    replace_files: {
+                        "/": `${sourcePdh}/`,
+                    },
+                }
+            );
+        });
+    });
+
+    describe('moveFiles', () => {
+        it('should batch move files', async () => {
+            serverApi.put = jest.fn(() => Promise.resolve({ data: {} }));
+            // given
+            const filePaths: string[] = ['/rootFile', '/secondFile', '/subpath/subfile', 'barefile.txt'];
+            const srcCollectionUUID = 'zzzzz-4zz18-5o5tg0l9a57gxxx';
+            const srcCollectionPdh = '8cd9ce1dfa21c635b620b1bfee7aaa08+180';
+
+            const destinationUuid = 'zzzzz-4zz18-ywq0rvhwwhkjnfq';
+            const destinationPath = '/destinationPath';
+
+            // when
+            await collectionService.moveFiles(srcCollectionUUID, srcCollectionPdh, filePaths, destinationUuid, destinationPath);
+
+            // then
+            expect(serverApi.put).toHaveBeenCalledTimes(2);
+            // Verify copy
+            expect(serverApi.put).toHaveBeenCalledWith(
+                `/collections/${destinationUuid}`, {
+                    collection: {
+                        preserve_version: true
+                    },
+                    replace_files: {
+                        [`${destinationPath}/rootFile`]: `${srcCollectionPdh}/rootFile`,
+                        [`${destinationPath}/secondFile`]: `${srcCollectionPdh}/secondFile`,
+                        [`${destinationPath}/subfile`]: `${srcCollectionPdh}/subpath/subfile`,
+                        [`${destinationPath}/barefile.txt`]: `${srcCollectionPdh}/barefile.txt`,
+                    },
+                }
+            );
+            // Verify delete
+            expect(serverApi.put).toHaveBeenCalledWith(
+                `/collections/${srcCollectionUUID}`, {
+                    collection: {
+                        preserve_version: true
+                    },
+                    replace_files: {
+                        "/rootFile": "",
+                        "/secondFile": "",
+                        "/subpath/subfile": "",
+                        "/barefile.txt": "",
+                    },
+                }
+            );
+        });
+
+        it('should batch move files within collection', async () => {
+            serverApi.put = jest.fn(() => Promise.resolve({ data: {} }));
+            // given
+            const filePaths: string[] = ['/one', '/two', '/subpath/subfile', 'barefile.txt'];
+            const srcCollectionUUID = 'zzzzz-4zz18-5o5tg0l9a57gxxx';
+            const srcCollectionPdh = '8cd9ce1dfa21c635b620b1bfee7aaa08+180';
+
+            const destinationPath = '/destinationPath';
+
+            // when
+            await collectionService.moveFiles(srcCollectionUUID, srcCollectionPdh, filePaths, srcCollectionUUID, destinationPath);
+
+            // then
+            expect(serverApi.put).toHaveBeenCalledTimes(1);
+            // Verify copy
+            expect(serverApi.put).toHaveBeenCalledWith(
+                `/collections/${srcCollectionUUID}`, {
+                    collection: {
+                        preserve_version: true
+                    },
+                    replace_files: {
+                        [`${destinationPath}/one`]: `${srcCollectionPdh}/one`,
+                        ['/one']: '',
+                        [`${destinationPath}/two`]: `${srcCollectionPdh}/two`,
+                        ['/two']: '',
+                        [`${destinationPath}/subfile`]: `${srcCollectionPdh}/subpath/subfile`,
+                        ['/subpath/subfile']: '',
+                        [`${destinationPath}/barefile.txt`]: `${srcCollectionPdh}/barefile.txt`,
+                        ['/barefile.txt']: '',
+                    },
+                }
+            );
+        });
+
+        it('should abort batch move when copy fails', async () => {
+            // Simulate failure to copy
+            serverApi.put = jest.fn(() => Promise.reject({
+                data: {},
+                response: {
+                    "errors": ["error getting snapshot of \"rootFile\" from \"8cd9ce1dfa21c635b620b1bfee7aaa08+180\": file does not exist"]
+                }
+            }));
+            // given
+            const filePaths: string[] = ['/rootFile', '/secondFile', '/subpath/subfile', 'barefile.txt'];
+            const srcCollectionUUID = 'zzzzz-4zz18-5o5tg0l9a57gxxx';
+            const srcCollectionPdh = '8cd9ce1dfa21c635b620b1bfee7aaa08+180';
+
+            const destinationUuid = 'zzzzz-4zz18-ywq0rvhwwhkjnfq';
+            const destinationPath = '/destinationPath';
+
+            // when
+            try {
+                await collectionService.moveFiles(srcCollectionUUID, srcCollectionPdh, filePaths, destinationUuid, destinationPath);
+            } catch {}
+
+            // then
+            expect(serverApi.put).toHaveBeenCalledTimes(1);
+            // Verify copy
+            expect(serverApi.put).toHaveBeenCalledWith(
+                `/collections/${destinationUuid}`, {
+                    collection: {
+                        preserve_version: true
+                    },
+                    replace_files: {
+                        [`${destinationPath}/rootFile`]: `${srcCollectionPdh}/rootFile`,
+                        [`${destinationPath}/secondFile`]: `${srcCollectionPdh}/secondFile`,
+                        [`${destinationPath}/subfile`]: `${srcCollectionPdh}/subpath/subfile`,
+                        [`${destinationPath}/barefile.txt`]: `${srcCollectionPdh}/barefile.txt`,
+                    },
+                }
+            );
+        });
+    });
+
+    describe('createDirectory', () => {
+        it('creates empty directory', async () => {
+            // given
+            const directoryNames = [
+                {in: 'newDir', out: 'newDir'},
+                {in: '/fooDir', out: 'fooDir'},
+                {in: '/anotherPath/', out: 'anotherPath'},
+                {in: 'trailingSlash/', out: 'trailingSlash'},
+            ];
+            const collectionUuid = 'zzzzz-tpzed-5o5tg0l9a57gxxx';
+
+            for (var i = 0; i < directoryNames.length; i++) {
+                serverApi.put = jest.fn(() => Promise.resolve({ data: {} }));
+                // when
+                await collectionService.createDirectory(collectionUuid, directoryNames[i].in);
+                // then
+                expect(serverApi.put).toHaveBeenCalledTimes(1);
+                expect(serverApi.put).toHaveBeenCalledWith(
+                    `/collections/${collectionUuid}`, {
+                        collection: {
+                            preserve_version: true
+                        },
+                        replace_files: {
+                            ["/" + directoryNames[i].out]: emptyCollectionPdh,
+                        },
+                    }
+                );
+            }
+        });
+    });
+
 });
index 1a03d8da3a1f536108b3707239714ec1eea73785..74cf75956f7cec87a36abb8f0fdcaee5b7e0883e 100644 (file)
@@ -10,11 +10,13 @@ import { AuthService } from "../auth-service/auth-service";
 import { extractFilesData } from "./collection-service-files-response";
 import { TrashableResourceService } from "services/common-service/trashable-resource-service";
 import { ApiActions } from "services/api/api-actions";
-import { customEncodeURI } from "common/url";
 import { Session } from "models/session";
+import { CommonService } from "services/common-service/common-service";
 
 export type UploadProgress = (fileId: number, loaded: number, total: number, currentTime: number) => void;
 
+export const emptyCollectionPdh = 'd41d8cd98f00b204e9800998ecf8427e+0';
+
 export class CollectionService extends TrashableResourceService<CollectionResource> {
     constructor(serverApi: AxiosInstance, private webdavClient: WebDAV, private authService: AuthService, actions: ApiActions) {
         super(serverApi, "collections", actions, [
@@ -52,27 +54,34 @@ export class CollectionService extends TrashableResourceService<CollectionResour
         return Promise.reject();
     }
 
-    async deleteFiles(collectionUuid: string, filePaths: string[]) {
-        const sortedUniquePaths = Array.from(new Set(filePaths))
-            .sort((a, b) => a.length - b.length)
-            .reduce((acc, currentPath) => {
-                const parentPathFound = acc.find((parentPath) => currentPath.indexOf(`${parentPath}/`) > -1);
-
-                if (!parentPathFound) {
-                    return [...acc, currentPath];
-                }
-
-                return acc;
-            }, []);
-
-        for (const path of sortedUniquePaths) {
-            if (path.indexOf(collectionUuid) === -1) {
-                await this.webdavClient.delete(`c=${collectionUuid}${path}`);
+    private combineFilePath(parts: string[]) {
+        return parts.reduce((path, part) => {
+            // Trim leading and trailing slashes
+            const trimmedPart = part.split('/').filter(Boolean).join('/');
+            if (trimmedPart.length) {
+                const separator = path.endsWith('/') ? '' : '/';
+                return `${path}${separator}${trimmedPart}`;
             } else {
-                await this.webdavClient.delete(`c=${path}`);
+                return path;
             }
-        }
-        await this.update(collectionUuid, { preserveVersion: true });
+        }, "/");
+    }
+
+    private replaceFiles(collectionUuid: string, fileMap: {}, showErrors?: boolean) {
+        const payload = {
+            collection: {
+                preserve_version: true
+            },
+            replace_files: fileMap
+        };
+
+        return CommonService.defaultResponse(
+            this.serverApi
+                .put<CollectionResource>(`/${this.resourceType}/${collectionUuid}`, payload),
+            this.actions,
+            true, // mapKeys
+            showErrors
+        );
     }
 
     async uploadFiles(collectionUuid: string, files: File[], onProgress?: UploadProgress, targetLocation: string = '') {
@@ -84,12 +93,11 @@ export class CollectionService extends TrashableResourceService<CollectionResour
         await this.update(collectionUuid, { preserveVersion: true });
     }
 
-    async moveFile(collectionUuid: string, oldPath: string, newPath: string) {
-        await this.webdavClient.move(
-            `c=${collectionUuid}${oldPath}`,
-            `c=${collectionUuid}/${customEncodeURI(newPath)}`
-        );
-        await this.update(collectionUuid, { preserveVersion: true });
+    async renameFile(collectionUuid: string, collectionPdh: string, oldPath: string, newPath: string) {
+        return this.replaceFiles(collectionUuid, {
+            [this.combineFilePath([newPath])]: `${collectionPdh}${this.combineFilePath([oldPath])}`,
+            [this.combineFilePath([oldPath])]: '',
+        });
     }
 
     extendFileURL = (file: CollectionDirectory | CollectionFile) => {
@@ -123,4 +131,66 @@ export class CollectionService extends TrashableResourceService<CollectionResour
         };
         return this.webdavClient.upload(fileURL, [file], requestConfig);
     }
+
+    deleteFiles(collectionUuid: string, files: string[], showErrors?: boolean) {
+        const optimizedFiles = files
+            .sort((a, b) => a.length - b.length)
+            .reduce((acc, currentPath) => {
+                const parentPathFound = acc.find((parentPath) => currentPath.indexOf(`${parentPath}/`) > -1);
+
+                if (!parentPathFound) {
+                    return [...acc, currentPath];
+                }
+
+                return acc;
+            }, []);
+
+        const fileMap = optimizedFiles.reduce((obj, filePath) => {
+            return {
+                ...obj,
+                [this.combineFilePath([filePath])]: ''
+            }
+        }, {})
+
+        return this.replaceFiles(collectionUuid, fileMap, showErrors);
+    }
+
+    copyFiles(sourcePdh: string, files: string[], destinationCollectionUuid: string, destinationPath: string, showErrors?: boolean) {
+        const fileMap = files.reduce((obj, sourceFile) => {
+            const sourceFileName = sourceFile.split('/').filter(Boolean).slice(-1).join("");
+            return {
+                ...obj,
+                [this.combineFilePath([destinationPath, sourceFileName])]: `${sourcePdh}${this.combineFilePath([sourceFile])}`
+            };
+        }, {});
+
+        return this.replaceFiles(destinationCollectionUuid, fileMap, showErrors);
+    }
+
+    moveFiles(sourceUuid: string, sourcePdh: string, files: string[], destinationCollectionUuid: string, destinationPath: string, showErrors?: boolean) {
+        if (sourceUuid === destinationCollectionUuid) {
+            const fileMap = files.reduce((obj, sourceFile) => {
+                const sourceFileName = sourceFile.split('/').filter(Boolean).slice(-1).join("");
+                return {
+                    ...obj,
+                    [this.combineFilePath([destinationPath, sourceFileName])]: `${sourcePdh}${this.combineFilePath([sourceFile])}`,
+                    [this.combineFilePath([sourceFile])]: '',
+                };
+            }, {});
+
+            return this.replaceFiles(sourceUuid, fileMap, showErrors)
+        } else {
+            return this.copyFiles(sourcePdh, files, destinationCollectionUuid, destinationPath, showErrors)
+                .then(() => {
+                    return this.deleteFiles(sourceUuid, files, showErrors);
+                });
+        }
+    }
+
+    createDirectory(collectionUuid: string, path: string, showErrors?: boolean) {
+        const fileMap = {[this.combineFilePath([path])]: emptyCollectionPdh};
+
+        return this.replaceFiles(collectionUuid, fileMap, showErrors);
+    }
+
 }
index 8c5e5b5a67df1f345ccd0ef645b7ec2e25e858c0..547f1534d111d6bc7d99b716b8891b7dff5d8359 100644 (file)
@@ -65,10 +65,11 @@ export const removeCollectionsSelectedFiles = () =>
 
 export const FILE_REMOVE_DIALOG = 'fileRemoveDialog';
 
-export const openFileRemoveDialog = (filePath: string) =>
+export const openFileRemoveDialog = (fileUuid: string) =>
     (dispatch: Dispatch, getState: () => RootState) => {
-        const file = getNodeValue(filePath)(getState().collectionPanelFiles);
+        const file = getNodeValue(fileUuid)(getState().collectionPanelFiles);
         if (file) {
+            const filePath = getFileFullPath(file);
             const isDirectory = file.type === CollectionFileType.DIRECTORY;
             const title = isDirectory
                 ? 'Removing directory'
@@ -129,7 +130,7 @@ export const renameFile = (newFullPath: string) =>
                 dispatch(startSubmit(RENAME_FILE_DIALOG));
                 const oldPath = getFileFullPath(file);
                 const newPath = newFullPath;
-                services.collectionService.moveFile(currentCollection.uuid, oldPath, newPath).then(() => {
+                services.collectionService.renameFile(currentCollection.uuid, currentCollection.portableDataHash, oldPath, newPath).then(() => {
                     dispatch(dialogActions.CLOSE_DIALOG({ id: RENAME_FILE_DIALOG }));
                     dispatch(snackbarActions.OPEN_SNACKBAR({ message: 'File name changed.', hideDuration: 2000 }));
                 }).catch(e => {