filemanager should not upload a single file multiple times, add tests for upload operation

Author: renonick87

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

@@ -252,16 +252,16 @@ class _FileManagerBase extends _SubManagerBase {
             if (success) {
                 this._bytesAvailable = bytesAvailable;
                 this._remoteFiles.push(fileName);
-                if (!file.isPersistent()) {
+                if (!fileClone.isPersistent()) {
                     this._uploadedEphemeralFileNames.push(fileName);
                 }
             } 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;
-                if (this._canFileBeUploadedAgain(file, maxUploadCount, this._failedFileUploadsCount)) {
-                    console.log(`FileManagerBase: Attempting to resend file with name ${file.getName()} after a failed upload attempt`);
-                    this._sdlUploadFilePrivate(file, listener);
+                const maxUploadCount = (fileClone instanceof SdlArtwork) ? this._maxArtworkUploadAttempts : this._maxFileUploadAttempts;
+                if (this._canFileBeUploadedAgain(fileClone, maxUploadCount, this._failedFileUploadsCount)) {
+                    console.log(`FileManagerBase: Attempting to resend file with name ${fileClone.getName()} after a failed upload attempt`);
+                    this._sdlUploadFilePrivate(fileClone, listener);
                     return;
                 }
             }

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

@@ -42,7 +42,7 @@ class _UploadFileOperation extends _Task {
         const file = this._fileWrapper.getFile();
         const msgVersion = this._lifecycleManager.getSdlMsgVersion();
         const rpcVersion = new Version(msgVersion.getMajorVersion(), msgVersion.getMinorVersion(), msgVersion.getPatchVersion());
-        if (!file.isPersistent() && !this.hasUploadedFile(file) && new Version(4, 4, 0).isNewerThan(rpcVersion) === 1) {
+        if (!file.isPersistent() && !this._fileManager.hasUploadedFile(file) && new Version(4, 4, 0).isNewerThan(rpcVersion) === 1) {
             file.setOverwrite(true);
         }
 

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();
         }
 
@@ -435,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();

tests/managers/file/UploadFileOperationTests.js

@@ -0,0 +1,66 @@
+const chai = require('chai');
+chai.use(require('chai-as-promised'));
+const SDL = require('../../config.js').node;
+
+// Mocking framework
+// Used to stub an RPC call so that it isn't actually sent to Core
+const sinon = require('sinon');
+
+const Validator = require('../../Validator');
+
+module.exports = function (appClient) {
+    const sdlManager = appClient._sdlManager;
+    const fileManager = sdlManager.getFileManager();
+    const uploadOverwriteFailure = 'File is already on the head unit, aborting upload operation';
+
+    describe('UploadFileOperationTests', function () {
+        describe('when the file is already on the head unit', function () {
+            describe('when not overwriting', function () {
+                it('should not send the upload RPCs and finish the operation', async function () {
+                    const stub = sinon.stub(fileManager, 'fileNeedsUpload')
+                        .callsFake((file) => false);
+                    const testFileName = 'TestSmallMemory';
+                    const testFileData = 'test1234';
+                    const testFile = new SDL.manager.file.filetypes.SdlFile(testFileName, SDL.rpc.enums.FileType.BINARY, testFileData, true);
+
+                    const testFileWrapper = new SDL.manager.file._SdlFileWrapper(testFile, (success, bytesAvailable, fileNames, errorMessage) => {
+                        Validator.assertTrue(!success);
+                        Validator.assertNull(bytesAvailable);
+                        Validator.assertNull(fileNames);
+                        Validator.assertNotNullUndefined(errorMessage);
+                        Validator.assertEquals(errorMessage, uploadOverwriteFailure);
+                    });
+                    const operation = new SDL.manager.file._UploadFileOperation(sdlManager._lifecycleManager, sdlManager.getFileManager(), testFileWrapper);
+                    await operation._start();
+                    stub.restore();
+
+                    Validator.assertEquals(operation.getState(), SDL.manager._Task.FINISHED);
+                });
+            });
+
+            describe('when overwriting', function () {
+                it('should send the upload RPCs', async function () {
+                    const stub = sinon.stub(fileManager, 'fileNeedsUpload')
+                        .callsFake((file) => false);
+                    const testFileName = 'TestSmallMemory';
+                    const testFileData = 'test1234';
+                    const testFile = new SDL.manager.file.filetypes.SdlFile(testFileName, SDL.rpc.enums.FileType.BINARY, testFileData, true)
+                        .setOverwrite(true);
+
+                    const testFileWrapper = new SDL.manager.file._SdlFileWrapper(testFile, (success, bytesAvailable, fileNames, errorMessage) => {
+                        Validator.assertTrue(!success);
+                        Validator.assertNull(bytesAvailable);
+                        Validator.assertNull(fileNames);
+                        Validator.assertNotNullUndefined(errorMessage);
+                        Validator.assertEquals(errorMessage, uploadOverwriteFailure);
+                    });
+                    const operation = new SDL.manager.file._UploadFileOperation(sdlManager._lifecycleManager, sdlManager.getFileManager(), testFileWrapper);
+                    await operation._start();
+                    stub.restore();
+
+                    Validator.assertNotEquals(operation.getState(), SDL.manager._Task.FINISHED);
+                });
+            });
+        });
+    });
+};