Fix case where file can have multiple upload/delete tasks created for it

Author: renonick87

lib/js/src/manager/file/_DeleteFileOperation.js

@@ -40,12 +40,14 @@ class _DeleteFileOperation extends _Task {
      * @class
      * @param {_LifecycleManager} lifecycleManager - An instance of _LifecycleManager.
      * @param {String} fileName - Name of the file to be deleted.
+     * @param {String[]} remoteFileNames - A list of file names uploaded to the system
      * @param {Function} completionListener - Listener called when the operation has completed.
      */
-    constructor (lifecycleManager, fileName, completionListener) {
+    constructor (lifecycleManager, fileName, remoteFileNames = [], completionListener) {
         super('DeleteFilesOperation');
         this._lifecycleManager = lifecycleManager;
         this._fileName = fileName;
+        this._remoteFileNames = remoteFileNames;
         this._completionListener = completionListener;
     }
 
@@ -66,6 +68,13 @@ class _DeleteFileOperation extends _Task {
         if (this.getState() === _Task.CANCELED) {
             return;
         }
+
+        if (!this._remoteFileNames.includes(this._fileName)) {
+            const errorMessage = 'File to delete is no longer on the head unit, aborting the operation';
+            console.log(errorMessage);
+            this._completionListener(false, null, null, errorMessage);
+            return this.onFinished();
+        }
         await this._deleteFile();
     }
 
@@ -96,6 +105,10 @@ class _DeleteFileOperation extends _Task {
     getName () {
         return `${super.getName()} - ${this.getId()}`;
     }
+
+    setRemoteFiles (remoteFiles) {
+        this._remoteFileNames = remoteFiles;
+    }
 }
 
 export { _DeleteFileOperation };

lib/js/src/manager/file/_FileManagerBase.js

@@ -146,11 +146,12 @@ class _FileManagerBase extends _SubManagerBase {
             return;
         }
 
-        const operation = new _DeleteFileOperation(this._lifecycleManager, fileName, (success, bytesAvailable, fileNames, errorMessage) => {
+        const operation = new _DeleteFileOperation(this._lifecycleManager, fileName, this._remoteFiles, (success, bytesAvailable, fileNames, errorMessage) => {
             if (success) {
                 this._bytesAvailable = bytesAvailable;
                 this._remoteFiles = _ArrayTools.arrayRemove(this._remoteFiles, fileName);
                 this._uploadedEphemeralFileNames = _ArrayTools.arrayRemove(this._uploadedEphemeralFileNames, fileName);
+                this._updatePendingOperationsWithNewRemoteFiles();
             }
             listener(success, bytesAvailable, fileNames, errorMessage);
         });
@@ -170,6 +171,8 @@ class _FileManagerBase extends _SubManagerBase {
                 this._deleteRemoteFileWithNamePrivate(fileName, (success, bytesAvailable, fileNames, errorMessage) => {
                     if (!success) {
                         failedDeletes.set(fileName, errorMessage);
+                    } else {
+                        this._bytesAvailable = bytesAvailable;
                     }
                     resolve();
                 });
@@ -240,15 +243,6 @@ class _FileManagerBase extends _SubManagerBase {
             file.setOverwrite(true);
         }
 
-        if (!file.getOverwrite() && this._remoteFiles.includes(file.getName())) {
-            const errorMessage = 'Cannot overwrite remote file. The remote file system already has a file of this name, and the file manager is set to not automatically overwrite files.';
-            console.log(`FileManagerBase: ${errorMessage}`);
-            if (typeof listener === 'function') {
-                listener(false, this._bytesAvailable, null, errorMessage);
-            }
-            return;
-        }
-
         this._sdlUploadFilePrivate(file, listener);
     }
 
@@ -264,8 +258,11 @@ class _FileManagerBase extends _SubManagerBase {
             if (success) {
                 this._bytesAvailable = bytesAvailable;
                 this._remoteFiles.push(fileName);
-                this._uploadedEphemeralFileNames.push(fileName);
-            } else {
+                if (!file.isPersistent()) {
+                    this._uploadedEphemeralFileNames.push(fileName);
+                }
+                this._updatePendingOperationsWithNewRemoteFiles();
+            } else if (errorMessage !== 'File is already on the head unit, aborting upload operation') {
                 this._incrementFailedUploadCountForFileName(fileName, this._failedFileUploadsCount);
 
                 const maxUploadCount = (file instanceof SdlArtwork) ? this._maxArtworkUploadAttempts : this._maxFileUploadAttempts;
@@ -281,7 +278,7 @@ class _FileManagerBase extends _SubManagerBase {
             }
         });
 
-        const operation = new _UploadFileOperation(this._lifecycleManager, this, fileWrapper);
+        const operation = new _UploadFileOperation(this._lifecycleManager, this, fileWrapper, this._remoteFiles);
         this._addTask(operation);
     }
 
@@ -419,6 +416,17 @@ class _FileManagerBase extends _SubManagerBase {
         }
         return false;
     }
+
+    _updatePendingOperationsWithNewRemoteFiles () {
+        for (const op of this._getTasks()) {
+            if (op.getState() === _Task.IN_PROGRESS || op.getState() === _Task.CANCELED) {
+                continue;
+            }
+            if (op instanceof _UploadFileOperation || op instanceof _DeleteFileOperation) {
+                op.setRemoteFiles(this._remoteFiles);
+            }
+        }
+    }
 }
 
 const SPACE_AVAILABLE_MAX_VALUE = _FileManagerBase.SPACE_AVAILABLE_MAX_VALUE = 2000000000;

lib/js/src/manager/file/_UploadFileOperation.js

@@ -12,12 +12,14 @@ class _UploadFileOperation extends _Task {
      * @param {_LifecycleManager} lifecycleManager - An instance of _LifecycleManager.
      * @param {FileManager} fileManager - An instance of FileManager.
      * @param {_SdlFileWrapper} fileWrapper - An instance of _SdlFileWrapper.
+     * @param {String[]} remoteFileNames - A list of file names uploaded to the system.
      */
-    constructor (lifecycleManager = null, fileManager = null, fileWrapper = null) {
+    constructor (lifecycleManager = null, fileManager = null, fileWrapper = null, remoteFileNames = []) {
         super('UploadFileOperation');
         this._lifecycleManager = lifecycleManager;
         this._fileManager = fileManager;
         this._fileWrapper = fileWrapper;
+        this._remoteFileNames = remoteFileNames;
     }
 
     /**
@@ -38,6 +40,13 @@ class _UploadFileOperation extends _Task {
             return;
         }
 
+        if (!this._fileWrapper.getFile().getOverwrite() && this._remoteFileNames.includes(this._fileWrapper.getFile().getName())) {
+            const errorMessage = 'File is already on the head unit, aborting upload operation';
+            console.log(errorMessage);
+            this._fileWrapper.getCompletionListener(false, null, null, errorMessage);
+            return this.onFinished();
+        }
+
         let mtuSize = 0;
         if (this._lifecycleManager !== null) {
             mtuSize = this._lifecycleManager.getMtu(_ServiceType.RPC);
@@ -56,25 +65,16 @@ class _UploadFileOperation extends _Task {
         let bytesAvailable = _FileManagerBase.SPACE_AVAILABLE_MAX_VALUE;
         let highestCorrelationId = -1;
 
-        if (this.getState() === _Task.CANCELED) {
-            const errorMessage = 'The file upload transaction was canceled before it could be completed.';
-            completionListener(false, bytesAvailable, null, errorMessage);
-            this.onFinished();
-            return;
-        }
-
         if (file === null) {
             const errorMessage = 'The file manager was unable to send the file. This could be because the file does not exist at the specified file path or that passed data is invalid.';
             completionListener(false, bytesAvailable, null, errorMessage);
-            this.onFinished();
-            return;
+            return this.onFinished();
         }
 
         if (file.getName() === null || file.getName() === undefined) {
             const errorMessage = 'You must specify a file name in the SdlFile';
             completionListener(false, bytesAvailable, null, errorMessage);
-            this.onFinished();
-            return;
+            return this.onFinished();
         }
 
         let data;
@@ -84,16 +84,14 @@ class _UploadFileOperation extends _Task {
             if (data === null) {
                 const errorMessage = 'File at path was empty';
                 completionListener(false, bytesAvailable, null, errorMessage);
-                this.onFinished();
-                return;
+                return this.onFinished();
             }
         } else if (file.getFileData() !== null && file.getFileData() !== undefined) {
             data = file.getFileData();
         } else {
             const errorMessage = 'The SdlFile to upload does not specify its file data.';
             completionListener(false, bytesAvailable, null, errorMessage);
-            this.onFinished();
-            return;
+            return this.onFinished();
         }
         const fileSize = data.length;
 
@@ -251,6 +249,10 @@ class _UploadFileOperation extends _Task {
         const maxJSONSize = this._getMaxJSONSize(file, fileSize);
         return mtuSize - (frameHeaderSize + binaryHeaderSize + maxJSONSize);
     }
+
+    setRemoteFiles (remoteFiles) {
+        this._remoteFileNames = remoteFiles;
+    }
 }
 
 export { _UploadFileOperation };

tests/managers/file/FileManagerTests.js

@@ -95,7 +95,7 @@ module.exports = function (appClient) {
         async function checkForUploadFailure (fileManager, sdlFile) {
             const operation = new SDL.manager.file._UploadFileOperation(sdlManager._lifecycleManager, sdlManager.getFileManager(), new SDL.manager.file._SdlFileWrapper(sdlFile, (success, bytesAvailable, fileNames, errorMessage) => {
                 Validator.assertTrue(!success);
-            }));
+            }), sdlManager._fileManager.getRemoteFileNames());
             await operation.onExecute();
         }
 
@@ -121,37 +121,6 @@ module.exports = function (appClient) {
             });
         }
 
-        let failEveryOtherRequest = true;
-        /**
-         * Handle multiple PutFile RPCs, succeeding in one and failing in the next.
-         * @returns {Promise} - A promise.
-         */
-        function onMultiplePutFileSuccess () {
-            const response = new SDL.rpc.messages.PutFileResponse({
-                functionName: SDL.rpc.enums.FunctionID.PutFiles,
-            })
-                .setSpaceAvailable(Test.GENERAL_INT);
-            if (failEveryOtherRequest) {
-                failEveryOtherRequest = !failEveryOtherRequest;
-                response.setSuccess(true);
-                // _handleRpc triggers the listener
-                sdlManager._lifecycleManager._handleRpc(response);
-
-                return new Promise((resolve, reject) => {
-                    resolve(response);
-                });
-            } else {
-                failEveryOtherRequest = !failEveryOtherRequest;
-                response.setSuccess(false);
-                // _handleRpc triggers the listener
-                sdlManager._lifecycleManager._handleRpc(response);
-
-                return new Promise((resolve, reject) => {
-                    resolve(response);
-                });
-            }
-        }
-
         /**
          * Handle DeleteFile success.
          * @returns {Promise} - A promise.
@@ -411,12 +380,11 @@ module.exports = function (appClient) {
 
             Validator.assertNull(await fileManager.deleteRemoteFilesWithNames([uploadedFileNames[0], uploadedFileNames[1]]));
             await new Promise (innerResolve => {
-                const deleteOperation = new SDL.manager.file._DeleteFileOperation(sdlManager._lifecycleManager, uploadedFileNames[2], (success, bytesAvailable, fileNames, errorMessage) => {
+                const deleteOperation = new SDL.manager.file._DeleteFileOperation(sdlManager._lifecycleManager, uploadedFileNames[2], [uploadedFileNames[2]], (success, bytesAvailable, fileNames, errorMessage) => {
                     Validator.assertTrue(success);
                     Validator.assertNull(errorMessage);
                     innerResolve();
                 });
-                // await deleteOperation.onExecute();
                 fileManager._addTask(deleteOperation);
             });
 
@@ -426,70 +394,6 @@ module.exports = function (appClient) {
             stub.restore();
         });
 
-        it('testMultipleFileUploadPartialFailure', async function () {
-            let firstFile = true;
-            const expectSuccessThenFail = function (response) {
-                if (firstFile) {
-                    Validator.assertTrue(response.getSuccess());
-                } else {
-                    Validator.assertTrue(!response.getSuccess());
-                }
-                firstFile = !firstFile;
-            };
-            const expectSuccess = function (response) {
-                Validator.assertTrue(response.getSuccess());
-            };
-
-            sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.ListFiles, expectSuccess);
-            sdlManager.addRpcListener(SDL.rpc.enums.FunctionID.PutFile, expectSuccessThenFail);
-
-            const stub = sinon.stub(lifecycleManager, 'sendRpcResolve');
-            stub.withArgs(sinon.match.instanceOf(SDL.rpc.messages.ListFiles))
-                .callsFake(onListFilesSuccess);
-            stub.withArgs(sinon.match.instanceOf(SDL.rpc.messages.PutFile))
-                .callsFake(onMultiplePutFileSuccess);
-
-            await new Promise (resolve => {
-                const listOperation = new SDL.manager.file._ListFilesOperation(sdlManager._lifecycleManager, (success, bytesAvailable, fileNames, errorMessage) => {
-                    resolve();
-                });
-                listOperation.onExecute();
-            });
-
-            const baseFileName = 'file';
-            let fileNum = 0;
-            const filesToUpload = [];
-            let sdlFile = new SDL.manager.file.filetypes.SdlFile();
-            sdlFile.setName(baseFileName + fileNum++);
-            sdlFile.setFilePath('./test_icon_1.png');
-            filesToUpload.push(sdlFile);
-
-            sdlFile = new SDL.manager.file.filetypes.SdlFile();
-            sdlFile.setName(baseFileName + fileNum++);
-            sdlFile.setFileData(new Array(50));
-            sdlFile.setPersistent(true);
-            sdlFile.setType(SDL.rpc.enums.FileType.BINARY);
-            filesToUpload.push(sdlFile);
-            let uploadedFileNames = fileManager.getRemoteFileNames();
-
-            await fileManager.uploadFiles(filesToUpload[0]);
-            await new Promise (resolve => {
-                // this task will run after the previous
-                const uploadOperation = new SDL.manager.file._UploadFileOperation(sdlManager._lifecycleManager, sdlManager._fileManager, new SDL.manager.file._SdlFileWrapper(filesToUpload[1], (success, bytesAvailable, fileNames, errorMessage) => {
-                    resolve();
-                }));
-                sdlManager._fileManager._addTask(uploadOperation);
-            });
-            stub.restore();
-
-            uploadedFileNames = fileManager.getRemoteFileNames();
-            Validator.assertTrue(!uploadedFileNames.includes(filesToUpload[0].getName()));
-            Validator.assertTrue(uploadedFileNames.includes(filesToUpload[1].getName()));
-
-            sdlManager.removeRpcListener(SDL.rpc.enums.FunctionID.PutFile, expectSuccessThenFail);
-            sdlManager.removeRpcListener(SDL.rpc.enums.FunctionID.ListFiles, expectSuccess);
-        });
-
         it('testMultipleArtworkUploadSuccess', async function () {
             const expectSuccess = function (response) {
                 Validator.assertTrue(response.getSuccess());
@@ -531,7 +435,7 @@ module.exports = function (appClient) {
                     Validator.assertTrue(success);
                     sdlManager._fileManager._remoteFiles.push(artworkToUpload[1].getName());
                     resolve();
-                }));
+                }), sdlManager._fileManager.getRemoteFileNames());
                 sdlManager._fileManager._addTask(uploadOperation);
             });
             stub.restore();