Merge pull request #444 from smartdevicelink/bugfix/image-not-sent-nonpersistent-file

Include version check for checking file upload status

Author: crokita

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

@@ -33,6 +33,7 @@
 import { ListFiles } from './../../rpc/messages/ListFiles.js';
 import { DeleteFile } from './../../rpc/messages/DeleteFile.js';
 import { _SubManagerBase } from '../_SubManagerBase.js';
+import { Version } from './../../util/Version.js';
 
 class _FileManagerBase extends _SubManagerBase {
     /**
@@ -217,18 +218,33 @@ class _FileManagerBase extends _SubManagerBase {
      * @returns {Boolean} - Whether file has been uploaded to core (true) or not (false)
      */
     hasUploadedFile (sdlFile) {
+        // this method's logic is more related to the iOS library than the Java library
+        // https://github.com/smartdevicelink/sdl_ios/issues/827 - Older versions of Core had a bug where list files would cache incorrectly.
+        const rpcMsgVersion = this._lifecycleManager.getSdlMsgVersion();
+        const rpcVersion = new Version()
+            .setMajor(rpcMsgVersion.getMajorVersion())
+            .setMinor(rpcMsgVersion.getMinorVersion())
+            .setPatch(rpcMsgVersion.getPatchVersion());
+
         const filename = sdlFile.getName();
         const isPersistent = sdlFile.isPersistent();
         const remoteFiles = this._remoteFiles;
         const ephemeralFiles = this._uploadedEphemeralFileNames;
         const isInRemoteFiles = remoteFiles.indexOf(filename) !== -1;
         const isInEphemeralFiles = ephemeralFiles.indexOf(filename) !== -1;
 
-        if (isPersistent) {
-            return isInRemoteFiles;
-        } else { // if it is not persistent it must be listed in both remote and ephemeral files.
-            return isInRemoteFiles && isInEphemeralFiles;
+        if (new Version(4, 4, 0).isNewerThan(rpcVersion) === 1) {
+            if (isPersistent) {
+                return isInRemoteFiles;
+            } else { // if it is not persistent it must be listed in both remote and ephemeral files.
+                return isInRemoteFiles && isInEphemeralFiles;
+            }
+        } else if (isInRemoteFiles) {
+            // If not connected to a system where the bug presents itself, we can trust the `remoteFileNames`
+            return true;
         }
+
+        return false;
     }
 
 

tests/managers/file/FileManagerTests.js

@@ -259,6 +259,40 @@ module.exports = function (appClient) {
             sdlManager.removeRpcListener(SDL.rpc.enums.FunctionID.ListFiles, expectSuccess);
         });
 
+        it('testNonPersistentFilesOnOlderVersions', async function () {
+            const stub = sinon.stub(lifecycleManager, 'getSdlMsgVersion')
+                .callsFake(() => {
+                    return new SDL.rpc.structs.SdlMsgVersion()
+                        .setMajorVersion(4)
+                        .setMinorVersion(3);
+                });
+
+            fileManager._remoteFiles.splice(0, fileManager._remoteFiles.length);
+            fileManager._uploadedEphemeralFileNames.splice(0, fileManager._uploadedEphemeralFileNames.length);
+            fileManager._remoteFiles.push(validFile.getName());
+            const hasUploadedResult = fileManager.hasUploadedFile(validFile);
+            stub.restore();
+
+            Validator.assertTrue(!hasUploadedResult);
+        });
+
+        it('testNonPersistentFilesOnNewerVersions', async function () {
+            const stub = sinon.stub(lifecycleManager, 'getSdlMsgVersion')
+                .callsFake(() => {
+                    return new SDL.rpc.structs.SdlMsgVersion()
+                        .setMajorVersion(5)
+                        .setMinorVersion(0);
+                });
+
+            fileManager._remoteFiles.splice(0, fileManager._remoteFiles.length);
+            fileManager._uploadedEphemeralFileNames.splice(0, fileManager._uploadedEphemeralFileNames.length);
+            fileManager._remoteFiles.push(validFile.getName());
+            const hasUploadedResult = fileManager.hasUploadedFile(validFile);
+            stub.restore();
+
+            Validator.assertTrue(hasUploadedResult);
+        });
+
         it('testInvalidSdlFileInput', async function () {
             const expectSuccess = function (response) {
                 Validator.assertTrue(response.getSuccess());