Merge pull request #547 from smartdevicelink/release/1.7.0

JavaScript Suite Release 1.7.0

Author: crokita

README.md

@@ -60,6 +60,8 @@ The transport related source code for Node.js can use Node specific libraries ne
 NodeJS, npm, and Python3 are required:
 
 ```js
+git submodule init
+git submodule update
 npm install
 npm run build
 ```

examples/js/hello-sdl/readme.md

@@ -1,8 +1,8 @@
 ## SDL JavaScript App Startup Instructions
 1) Place the vanilla JS SDL.min.js file into this directory
-1) Request a [Manticore instance](https://smartdevicelink.com/resources/manticore/)
-1) Open two terminal sessions and `cd` both of them into `./examples/js/hello-sdl`
-1) In one terminal session, run `java -jar proxy.jar m.sdl.tools [PORT]`, where `[PORT]` is the one given to you by Manticore
-1) In the other terminal session, run `npm install` then `npm start`.
-1) Your browser should automatically open and the test app should appear on your Manticore UI.
-1) Click on the app in Manticore and observe the series of `Show` RPCs performed. Logs can be seen in your browser's JavaScript console.
+2) Request a [Manticore instance](https://smartdevicelink.com/resources/manticore/).  
+3) Open the file `./examples/js/hello-sdl/index.html` in any text editor and change the transport config's URL and port value to what Manticore's "WS URL" says.
+4) Open a terminal session and `cd` into `./examples/js/hello-sdl`
+5) In the terminal session, run `npm install` then `npm start`.
+6) Your browser should automatically open and the test app should appear on your Manticore UI.
+7) Click on the app in Manticore and observe the series of `Show` RPCs performed. Logs can be seen in your browser's JavaScript console.

examples/node/hello-sdl/AppClient.js

@@ -115,7 +115,7 @@ class AppClient {
         this._managersReady = true;
         this._checkReadyState();
         const screenManager = this._sdlManager.getScreenManager();
-
+        
         // add menus
         const menuListener = new SDL.manager.screen.menu.MenuSelectionListener()
             .setOnTriggered(triggerSource => {

lib/js/src/manager/screen/_SoftButtonManagerBase.js

@@ -60,6 +60,12 @@ class _SoftButtonManagerBase extends _SubManagerBase {
         this._currentMainField1 = null;
         this._currentHmiLevel = null;
         this._batchUpdates = false; // whether to wait on sending the updates
+        let displayCapabilities = null;
+        if (lifecycleManager.getSystemCapabilityManager() !== null) {
+            displayCapabilities = lifecycleManager.getSystemCapabilityManager().getDisplayCapabilities();
+        }
+        this._isDynamicGraphicSupported = (displayCapabilities !== null && displayCapabilities.getGraphicSupported() !== null) ? displayCapabilities.getGraphicSupported() : true;
+
         this._updateListener = () => {
             this._transitionSoftButton();
         };
@@ -137,7 +143,7 @@ class _SoftButtonManagerBase extends _SubManagerBase {
 
             // Auto-send an updated Show if we have new capabilities
             if (this._softButtonObjects.length !== 0 && this._softButtonCapabilities !== null && this._softButtonCapabilities !== undefined && !this._softButtonCapabilitiesEquals(oldSoftButtonCapabilities, this._softButtonCapabilities)) {
-                const operation = new _SoftButtonReplaceOperation(this._lifecycleManager, this._fileManager, this._softButtonCapabilities, this._softButtonObjects, this.getCurrentMainField1());
+                const operation = new _SoftButtonReplaceOperation(this._lifecycleManager, this._fileManager, this._softButtonCapabilities, this._softButtonObjects, this.getCurrentMainField1(), this._isDynamicGraphicSupported);
                 this._addTask(operation);
             }
         };
@@ -243,7 +249,7 @@ class _SoftButtonManagerBase extends _SubManagerBase {
         this._softButtonObjects = softButtonObjects;
 
         // We only need to pass the first softButtonCapabilities in the array due to the fact that all soft button capabilities are the same (i.e. there is no way to assign a softButtonCapabilities to a specific soft button).
-        const operation = new _SoftButtonReplaceOperation(this._lifecycleManager, this._fileManager, this._softButtonCapabilities, this._softButtonObjects, this.getCurrentMainField1());
+        const operation = new _SoftButtonReplaceOperation(this._lifecycleManager, this._fileManager, this._softButtonCapabilities, this._softButtonObjects, this.getCurrentMainField1(), this._isDynamicGraphicSupported);
 
         if (this._batchUpdates) {
             this._batchQueue.splice(0, this._batchQueue.length); // clear out the array

lib/js/src/manager/screen/_SoftButtonReplaceOperation.js

@@ -34,6 +34,7 @@ import { _Task } from '../_Task';
 import { Show } from '../../rpc/messages/Show.js';
 import { SoftButton } from '../../rpc/structs/SoftButton.js';
 import { SoftButtonType } from '../../rpc/enums/SoftButtonType.js';
+import { ImageType } from '../../rpc/enums/ImageType.js';
 
 class _SoftButtonReplaceOperation extends _Task {
     /**
@@ -45,14 +46,16 @@ class _SoftButtonReplaceOperation extends _Task {
      * @param {SoftButtonCapabilities} softButtonCapabilities - The soft button capabilities
      * @param {SoftButtonObject[]} softButtonObjects - A list of soft button objects
      * @param {String} currentMainField1 - The main field value text shown on the head unit
+     * @param {Boolean} isDynamicGraphicSupported - Whether dynamic graphics are supported
      */
-    constructor (lifecycleManager, fileManager = null, softButtonCapabilities = null, softButtonObjects = null, currentMainField1 = null) {
-        super('SoftButtonTransitionOperation');
+    constructor (lifecycleManager, fileManager = null, softButtonCapabilities = null, softButtonObjects = null, currentMainField1 = null, isDynamicGraphicSupported) {
+        super('SoftButtonReplaceOperation');
         this._lifecycleManager = lifecycleManager;
         this._fileManager = fileManager;
         this._softButtonCapabilities = softButtonCapabilities;
         this._softButtonObjects = softButtonObjects;
         this._currentMainField1 = currentMainField1;
+        this._isDynamicGraphicSupported = isDynamicGraphicSupported;
     }
 
     /**
@@ -77,11 +80,17 @@ class _SoftButtonReplaceOperation extends _Task {
         // Check the state of our images
         if (!this._supportsSoftButtonImages()) {
             // We don't support images at all
-            console.warn('SoftButtonTransitionOperation - Soft button images are not supported. Attempting to send text-only soft buttons. If any button does not contain text, no buttons will be sent.');
+            console.warn('SoftButtonReplaceOperation - Soft button images are not supported. Attempting to send text-only soft buttons. If any button does not contain text, no buttons will be sent.');
             // Send text buttons if all the soft buttons have text
             const success = await this._sendCurrentStateTextOnlySoftButtons();
             if (!success) {
-                console.error('SoftButtonTransitionOperation - Head unit does not support images and some of the soft buttons do not have text, so none of the buttons will be sent.');
+                console.error('SoftButtonReplaceOperation - Head unit does not support images and some of the soft buttons do not have text, so none of the buttons will be sent.');
+            }
+        } else if (!this._supportsDynamicSoftButtonImages()) {
+            console.info('SoftButtonReplaceOperation - Soft button images are not supported. Attempting to send text and static image only soft buttons. If any button does not contain text and/or a static image, no buttons will be sent.');
+            const success = await this._sendCurrentStateStaticImageOnlySoftButtons();
+            if (!success) {
+                console.error('SoftButtonReplaceOperation - Buttons will not be sent because the module does not support dynamic images and some of the buttons do not have text or static images.');
             }
         } else if (this._currentStateHasImages() && !this._allCurrentStateImagesAreUploaded()) {
             // If there are images that aren't uploaded
@@ -116,13 +125,13 @@ class _SoftButtonReplaceOperation extends _Task {
             return false;
         }
 
-        console.log('SoftButtonTransitionOperation - Preparing to send text-only soft buttons');
+        console.log('SoftButtonReplaceOperation - Preparing to send text-only soft buttons');
         const textButtons = [];
 
         for (const softButtonObject of this._softButtonObjects) {
             const softButton = softButtonObject.getCurrentStateSoftButton();
             if (softButton.getText() === null || softButton.getText() === undefined) {
-                console.warn('SoftButtonTransitionOperation - Attempted to create text buttons, but some buttons don\'t support text, so no text-only soft buttons will be sent');
+                console.warn('SoftButtonReplaceOperation - Attempted to create text buttons, but some buttons don\'t support text, so no text-only soft buttons will be sent');
                 return false;
             }
             // We should create a new softButtonObject rather than modifying the original one
@@ -137,7 +146,7 @@ class _SoftButtonReplaceOperation extends _Task {
         }
 
         if (this._lifecycleManager === null) {
-            console.error('SoftButtonTransitionOperation: LifecycleManager is null');
+            console.error('SoftButtonReplaceOperation: LifecycleManager is null');
             return false;
         }
 
@@ -147,9 +156,62 @@ class _SoftButtonReplaceOperation extends _Task {
 
         const response = await this._lifecycleManager.sendRpcResolve(show);
         if (response.getSuccess()) {
-            console.log('SoftButtonTransitionOperation - Finished sending text only soft buttons');
+            console.log('SoftButtonReplaceOperation - Finished sending text only soft buttons');
         } else {
-            console.warn('SoftButtonTransitionOperation - Failed to update soft buttons with text buttons');
+            console.warn('SoftButtonReplaceOperation - Failed to update soft buttons with text buttons');
+        }
+        return response.getSuccess();
+    }
+
+    /**
+     * Send soft buttons for the current state that only contain text and static images only, if possible.
+     * @private
+     * @returns {Promise} - Resolves to whether the operation is successful
+     */
+    async _sendCurrentStateStaticImageOnlySoftButtons () {
+        if (this.getState() === _Task.CANCELED) {
+            return false;
+        }
+
+        console.log('SoftButtonReplaceOperation - Preparing to send text and static image only soft buttons.');
+        const textButtons = [];
+
+        for (const softButtonObject of this._softButtonObjects) {
+            const softButton = softButtonObject.getCurrentStateSoftButton();
+            if (softButton.getText() === null && softButton.getImage() !== null && softButton.getImage().getImageType() === ImageType.DYNAMIC) {
+                console.warn('SoftButtonReplaceOperation - Attempted to create text and static image only buttons, but some buttons don\'t support text and have dynamic images, so no soft buttons will be sent.');
+                return false;
+            }
+
+            if (softButton.getImage() !== null && softButton.getImage().getImageType() === ImageType.DYNAMIC) {
+                // We should create a new softButtonObject rather than modifying the original one
+                const textAndStaticImageOnlySoftButton = new SoftButton()
+                    .setType(SoftButtonType.SBT_TEXT)
+                    .setText(softButton.getText())
+                    .setImage(softButton.getImage())
+                    .setIsHighlighted(softButton.getIsHighlighted())
+                    .setSoftButtonID(softButton.getSoftButtonID())
+                    .setSystemAction(softButton.getSystemAction());
+                textButtons.push(textAndStaticImageOnlySoftButton);
+            } else {
+                textButtons.push(softButton);
+            }
+        }
+
+        if (this._lifecycleManager === null) {
+            console.error('SoftButtonReplaceOperation: LifecycleManager is null');
+            return false;
+        }
+
+        const show = new Show()
+            .setMainField1(this._currentMainField1)
+            .setSoftButtons(textButtons);
+
+        const response = await this._lifecycleManager.sendRpcResolve(show);
+        if (response.getSuccess()) {
+            console.log('SoftButtonReplaceOperation - Finished sending text and static image only soft buttons.');
+        } else {
+            console.warn('SoftButtonReplaceOperation - Failed to update soft buttons with text and static image only buttons.');
         }
         return response.getSuccess();
     }
@@ -163,15 +225,15 @@ class _SoftButtonReplaceOperation extends _Task {
         if (this.getState() === _Task.CANCELED) {
             return false;
         }
-        console.log('SoftButtonTransitionOperation - Preparing to send full soft buttons');
+        console.log('SoftButtonReplaceOperation - Preparing to send full soft buttons');
         const softButtons = [];
 
         for (const softButtonObject of this._softButtonObjects) {
             softButtons.push(softButtonObject.getCurrentStateSoftButton());
         }
 
         if (this._lifecycleManager === null) {
-            console.error('SoftButtonTransitionOperation: LifecycleManager is null');
+            console.error('SoftButtonReplaceOperation: LifecycleManager is null');
             return false;
         }
 
@@ -181,9 +243,9 @@ class _SoftButtonReplaceOperation extends _Task {
 
         const response = await this._lifecycleManager.sendRpcResolve(show);
         if (response.getSuccess()) {
-            console.log('SoftButtonTransitionOperation - Finished sending full soft buttons');
+            console.log('SoftButtonReplaceOperation - Finished sending full soft buttons');
         } else {
-            console.warn('SoftButtonTransitionOperation - Failed to update soft buttons');
+            console.warn('SoftButtonReplaceOperation - Failed to update soft buttons');
         }
         return response.getSuccess();
     }
@@ -207,20 +269,25 @@ class _SoftButtonReplaceOperation extends _Task {
         }
 
         if (initialStatesToBeUploaded.length === 0) {
-            console.log('SoftButtonTransitionOperation: No initial state artworks to upload');
+            console.log('SoftButtonReplaceOperation: No initial state artworks to upload');
+            return false;
+        }
+
+        if (!this._supportsDynamicSoftButtonImages()) {
+            console.log('Head unit does not support dynamic images, skipping upload.');
             return false;
         }
 
-        console.log('SoftButtonTransitionOperation: Uploading soft button initial artworks');
+        console.log('SoftButtonReplaceOperation: Uploading soft button initial artworks');
         if (this._fileManager === null) {
             return false;
         }
 
         const successes = await this._fileManager.uploadArtworks(initialStatesToBeUploaded);
         if (successes.includes(false)) {
-            console.error('SoftButtonTransitionOperation: Error uploading soft button artworks');
+            console.error('SoftButtonReplaceOperation: Error uploading soft button artworks');
         } else {
-            console.log('SoftButtonTransitionOperation: Soft button initial state artworks uploaded');
+            console.log('SoftButtonReplaceOperation: Soft button initial state artworks uploaded');
         }
 
         return true;
@@ -246,25 +313,34 @@ class _SoftButtonReplaceOperation extends _Task {
         }
 
         if (otherStatesToBeUploaded.length === 0) {
-            console.log('SoftButtonTransitionOperation: No other state artworks to upload');
+            console.log('SoftButtonReplaceOperation: No other state artworks to upload');
             return false;
         }
 
-        console.log('SoftButtonTransitionOperation: Uploading soft button other state artworks');
+        console.log('SoftButtonReplaceOperation: Uploading soft button other state artworks');
         if (this._fileManager === null) {
             return false;
         }
 
         const successes = await this._fileManager.uploadArtworks(otherStatesToBeUploaded);
         if (successes.includes(false)) {
-            console.error('SoftButtonTransitionOperation: Error uploading soft button artworks');
+            console.error('SoftButtonReplaceOperation: Error uploading soft button artworks');
         } else {
-            console.log('SoftButtonTransitionOperation: Soft button other state artworks uploaded');
+            console.log('SoftButtonReplaceOperation: Soft button other state artworks uploaded');
         }
 
         return true;
     }
 
+    /**
+     * Checks if dynamic soft button images are supported
+     * @private
+     * @returns {Boolean} - Whether dynamic soft button images are supported
+     */
+    _supportsDynamicSoftButtonImages () {
+        return this._softButtonCapabilities !== null && this._isDynamicGraphicSupported && this._softButtonCapabilities.getImageSupported();
+    }
+
     /**
      * Checks if soft button images are supported
      * @private

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "sdl_javascript_suite",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "The official JavaScript SDK for SmartDeviceLink.",
   "main": "/lib/js/dist/SDL.js",
   "engines": {

package.json

@@ -11,6 +11,7 @@ module.exports = function (appClient) {
 
         const screenManager = appClient._sdlManager.getScreenManager();
         const sbm = screenManager._softButtonManager;
+        sbm._isDynamicGraphicSupported = true;
         let fileManagerUploadArtworksListenerCalledCounter = 0;
         let internalInterfaceSendRpcListenerCalledCounter = 0;
         const softButtonObject1Id = 1000;
@@ -233,6 +234,26 @@ module.exports = function (appClient) {
             Validator.assertEquals(softButtonState1, softButtonState2);
         });
 
+        it('testSoftButtonManagerGraphicNotSupported', function () {
+            sbm._isDynamicGraphicSupported = false;
+            fileManagerUploadArtworksListenerCalledCounter = 0;
+            internalInterfaceSendRpcListenerCalledCounter = 0;
+            const softButtonObjects = [softButtonObject1, softButtonObject2];
+            sbm.setSoftButtonObjects(softButtonObjects);
+            Validator.assertEquals(0, fileManagerUploadArtworksListenerCalledCounter);
+        });
+
+        it('testSoftButtonManagerDynamicImageNotSupportedNoText', function () {
+            sbm._isDynamicGraphicSupported = false;
+            fileManagerUploadArtworksListenerCalledCounter = 0;
+            internalInterfaceSendRpcListenerCalledCounter = 0;
+
+            const softButtonState = new SDL.manager.screen.utils.SoftButtonState('testState', null, new SDL.manager.file.filetypes.SdlArtwork('image', SDL.rpc.enums.FileType.GRAPHIC_PNG, '1', true));
+            const softButtonObject = new SDL.manager.screen.utils.SoftButtonObject('obj1', softButtonState, softButtonState.getName());
+            sbm.setSoftButtonObjects([softButtonObject]);
+            Validator.assertEquals(0, fileManagerUploadArtworksListenerCalledCounter);
+        });
+
         /**
          * Pauses execution
          * @param {Number} timeout - How long in milliseconds to pause