Alignment and bug fixes

lib/js/src/manager/screen/menu/_MenuReplaceOperation.js

@@ -35,7 +35,6 @@ import { _DynamicMenuUpdateAlgorithm } from './_DynamicMenuUpdateAlgorithm';
 import { _MenuReplaceUtilities } from './_MenuReplaceUtilities';
 import { _MenuCellState } from './enums/_MenuCellState';
 import { _ManagerUtility } from '../../_ManagerUtility.js';
-import { ImageFieldName } from '../../../rpc/enums/ImageFieldName.js';
 import { TextFieldName } from '../../../rpc/enums/TextFieldName.js';
 import { _MenuManagerBase } from './_MenuManagerBase';
 

lib/js/src/manager/screen/menu/_MenuReplaceUtilities.js

@@ -157,19 +157,37 @@ class _MenuReplaceUtilities {
      * @returns {Boolean} - Whether the capability is supported
      */
     static windowCapabilitySupportsPrimaryImage (lifecycleManager = null, windowCapability, cell) {
+        let supportsImage;
         if (cell.isSubMenuCell() && lifecycleManager !== null && lifecycleManager.getSdlMsgVersion() !== null) {
-            const headUnitRpcVersion = new Version(lifecycleManager.getSdlMsgVersion());
-            const minRpcVersion = new Version(5, 0, 0);
-            const maxRpcVersion = new Version(7, 1, 0);
-            // If RPC version is >= 5.0 && < 7.1
-            if (headUnitRpcVersion.isNewerThan(minRpcVersion) === 0 || headUnitRpcVersion.isBetween(minRpcVersion, maxRpcVersion) === 1) {
-                return true;
+            if (_MenuReplaceUtilities.isRpcVersionBetween5And7(lifecycleManager) && _ManagerUtility.hasImageFieldOfName(windowCapability, ImageFieldName.cmdIcon)) {
+                supportsImage = true;
             } else {
-                return _ManagerUtility.hasImageFieldOfName(windowCapability, ImageFieldName.subMenuIcon);
+                supportsImage = _ManagerUtility.hasImageFieldOfName(windowCapability, ImageFieldName.subMenuIcon);
             }
         } else {
-            return _ManagerUtility.hasImageFieldOfName(windowCapability, ImageFieldName.cmdIcon);
+            supportsImage = _ManagerUtility.hasImageFieldOfName(windowCapability, ImageFieldName.cmdIcon);
+        }
+        return supportsImage;
+    }
+
+    /**
+     * Checks whether the version is between 5.0.0 and 7.0.0
+     * @param {_LifecycleManager} lifecycleManager - A _LifecycleManager instance
+     * @returns {Boolean} - Whether the version is within bounds
+     */
+    static isRpcVersionBetween5And7 (lifecycleManager = null) {
+        if (lifecycleManager === null) {
+            return false;
         }
+        const headUnitRpcVersion = new Version()
+            .setMajor(lifecycleManager.getSdlMsgVersion().getMajorVersion())
+            .setMinor(lifecycleManager.getSdlMsgVersion().getMinorVersion())
+            .setPatch(lifecycleManager.getSdlMsgVersion().getPatchVersion());
+
+        const minRpcVersion = new Version(5, 0, 0);
+        const maxRpcVersion = new Version(7, 0, 0);
+        // If RPC version is >= 5.0 && < 7.0
+        return (headUnitRpcVersion.isNewerThan(minRpcVersion) === 0 || headUnitRpcVersion.isBetween(minRpcVersion, maxRpcVersion) === 1);
     }
 
     /**

tests/managers/screen/menu/MenuManagerTests.js

@@ -114,7 +114,7 @@ module.exports = function (appClient) {
             Validator.assertEquals(mm._dynamicMenuUpdatesMode, SDL.manager.screen.menu.enums.DynamicMenuUpdatesMode.FORCE_OFF);
             // when we only send one command to update, we should only be returned one add command
             const newArray = [mainCell1, mainCell4];
-            Validator.assertEquals(SDL.manager.screen.menu._MenuReplaceUtilities.allCommandsForCells(newArray, mm._fileManager, mm._windowCapability, SDL.rpc.enums.MenuLayout.LIST).length, 4);
+            Validator.assertEquals(SDL.manager.screen.menu._MenuReplaceUtilities.allCommandsForCells(sdlManager._lifecycleManager, newArray, mm._fileManager, mm._windowCapability, SDL.rpc.enums.MenuLayout.LIST).length, 4);
             mm._currentHmiLevel = SDL.rpc.enums.HMILevel.HMI_FULL;
             mm._setMenuCells(newArray);
 

tests/managers/screen/menu/MenuReplaceUtilitiesTests.js

@@ -145,47 +145,98 @@ module.exports = function (appClient) {
             Validator.assertEquals(1, actualMenuCellList[4].getSubCells()[1].getSubCells().length);
         });
 
+
+        it('testAddMenuRequestWithCommandId', async function () {
+            let windowCapability;
+            let menuCell;
+            let lcm;
+            const windowCapFn = SDL.manager.screen.menu._MenuReplaceUtilities.windowCapabilitySupportsPrimaryImage;
+
+            // Test cases
+            const tests = [
+                { capOne: false, capTwo: true,  isSub: true,  version: createSdlMsgVersion(4, 9, 0), assert: true },
+                { capOne: false, capTwo: false, isSub: true,  version: createSdlMsgVersion(4, 9, 0), assert: false },
+                { capOne: false, capTwo: false, isSub: true,  version: createSdlMsgVersion(5, 0, 0), assert: false },
+                { capOne: true,  capTwo: false, isSub: true,  version: createSdlMsgVersion(5, 0, 0), assert: true },
+                { capOne: false, capTwo: false, isSub: true,  version: createSdlMsgVersion(6, 0, 0), assert: false },
+                { capOne: true,  capTwo: false, isSub: true,  version: createSdlMsgVersion(6, 0, 0), assert: true },
+                { capOne: false, capTwo: false, isSub: true,  version: createSdlMsgVersion(7, 0, 0), assert: false },
+                { capOne: false, capTwo: false, isSub: true,  version: createSdlMsgVersion(7, 1, 0), assert: false },
+                { capOne: false, capTwo: false, isSub: true,  version: createSdlMsgVersion(8, 0, 0), assert: false },
+                { capOne: false, capTwo: true,  isSub: true,  version: createSdlMsgVersion(8, 0, 0), assert: true },
+                { capOne: false, capTwo: false, isSub: false, version: createSdlMsgVersion(8, 0, 0), assert: false },
+                { capOne: true,  capTwo: false, isSub: false, version: createSdlMsgVersion(8, 0, 0), assert: true },
+            ];
+
+            tests.forEach(test => {
+                windowCapability = createWindowCapability(test.capOne, test.capTwo);
+                menuCell = createMockMenuCell(test.isSub);
+                lcm = createMockLifecycleManager(test.version);
+                Validator.assertEquals(windowCapFn(lcm, windowCapability, menuCell), test.assert);
+            });
+        });
+
         it('testShouldCellIncludeImage', async function () {
             let menuCell;
             let windowCapability;
             let fileManager;
+            let lcm;
             const shouldCellIncludePrimaryImageFromCell = SDL.manager.screen.menu._MenuReplaceUtilities.shouldCellIncludePrimaryImageFromCell;
 
             // Case 1
             menuCell = new SDL.manager.screen.menu.MenuCell(Test.GENERAL_STRING)
                 .setIcon(Test.GENERAL_ARTWORK);
             windowCapability = createWindowCapability(true, true);
             fileManager = createMockFileManager(true);
-            Validator.assertTrue(shouldCellIncludePrimaryImageFromCell(menuCell, fileManager, windowCapability));
+            lcm = createMockLifecycleManager(createSdlMsgVersion(8, 0, 0));
+            Validator.assertTrue(shouldCellIncludePrimaryImageFromCell(lcm, menuCell, fileManager, windowCapability));
 
             // Case 2 - Image are not supported
             menuCell = new SDL.manager.screen.menu.MenuCell(Test.GENERAL_STRING)
                 .setIcon(Test.GENERAL_ARTWORK);
             windowCapability = createWindowCapability(false, false);
             fileManager = createMockFileManager(true);
-            Validator.assertTrue(!shouldCellIncludePrimaryImageFromCell(menuCell, fileManager, windowCapability));
+            lcm = createMockLifecycleManager(createSdlMsgVersion(8, 0, 0));
+            Validator.assertTrue(!shouldCellIncludePrimaryImageFromCell(lcm, menuCell, fileManager, windowCapability));
 
             // Case 3 - Artwork is null
             menuCell = new SDL.manager.screen.menu.MenuCell(Test.GENERAL_STRING);
             windowCapability = createWindowCapability(true, true);
             fileManager = createMockFileManager(true);
-            Validator.assertTrue(!shouldCellIncludePrimaryImageFromCell(menuCell, fileManager, windowCapability));
+            lcm = createMockLifecycleManager(createSdlMsgVersion(8, 0, 0));
+            Validator.assertTrue(!shouldCellIncludePrimaryImageFromCell(lcm, menuCell, fileManager, windowCapability));
 
             // Case 4 - Artwork has not been uploaded
             menuCell = new SDL.manager.screen.menu.MenuCell(Test.GENERAL_STRING)
                 .setIcon(Test.GENERAL_ARTWORK);
             windowCapability = createWindowCapability(true, true);
             fileManager = createMockFileManager(false);
-            Validator.assertTrue(!shouldCellIncludePrimaryImageFromCell(menuCell, fileManager, windowCapability));
+            lcm = createMockLifecycleManager(createSdlMsgVersion(8, 0, 0));
+            Validator.assertTrue(!shouldCellIncludePrimaryImageFromCell(lcm, menuCell, fileManager, windowCapability));
 
             // Case 5 - Artwork is static icon
             menuCell = new SDL.manager.screen.menu.MenuCell(Test.GENERAL_STRING)
                 .setIcon(Test.GENERAL_ARTWORK_STATIC);
             windowCapability = createWindowCapability(true, true);
             fileManager = createMockFileManager(false);
-            Validator.assertTrue(shouldCellIncludePrimaryImageFromCell(menuCell, fileManager, windowCapability));
+            lcm = createMockLifecycleManager(createSdlMsgVersion(8, 0, 0));
+            Validator.assertTrue(shouldCellIncludePrimaryImageFromCell(lcm, menuCell, fileManager, windowCapability));
         });
 
+        /**
+         * Constructs an SdlMsgVersion object
+         * @param {number} major - The major version
+         * @param {number} minor - The minor version
+         * @param {number} patch - The patch version
+         * @returns {SdlMsgVersion} - A SdlMsgVersion object
+         */
+        function createSdlMsgVersion (major, minor, patch) {
+            return new SDL.rpc.structs.SdlMsgVersion()
+                .setMajorVersion(major)
+                .setMinorVersion(minor)
+                .setPatchVersion(patch);
+        }
+
         /**
          * Makes a fake file manager object with hasUploadedFile returning a specific boolean
          * @param {boolean} hasUploadedFile - The boolean to return when hasUploadedFile is invoked
@@ -197,6 +248,28 @@ module.exports = function (appClient) {
             };
         }
 
+        /**
+         * Makes a fake lifecycle manager object with getSdlMsgVersion defined
+         * @param {SdlMsgVersion} version - The version to return when invoked
+         * @returns {Object} - A basic object with getSdlMsgVersion implemented
+         */
+        function createMockLifecycleManager (version) {
+            return {
+                getSdlMsgVersion: () => version,
+            };
+        }
+
+        /**
+         * Makes a fake MenuCell object with isSubMenuCell defined
+         * @param {boolean} isSubMenu - The boolean to return when isSubMenuCell is invoked
+         * @returns {Object} - A basic object with isSubMenuCell implemented
+         */
+        function createMockMenuCell (isSubMenu) {
+            return {
+                isSubMenuCell: () => isSubMenu,
+            };
+        }
+
         /**
          * Makes a copy of the menu cell without sub cells
          * @param {MenuCell} menuCell - The menu cell to clone