[SDL-0293] Enable OEM exclusive apps support

lib/js/src/manager/SdlManagerListener.js

@@ -141,13 +141,11 @@ class SdlManagerListener {
     /**
      * Safely attempts to invoke the OnVehicleTypeReceived event callback function.
      * @param {VehicleType} vehicleType - the type of vehicle that this session is currently active on.
-     * @param {String} systemSoftwareVersion - software version of the system.
-     * @param {String} systemHardwareVersion - hardware version of the system.
      * @returns {Boolean} Return true if this session should continue, false if the session should end
      */
-    onVehicleTypeReceived (vehicleType, systemSoftwareVersion, systemHardwareVersion) {
+    onVehicleTypeReceived (vehicleType) {
         if (typeof this._onVehicleTypeReceived === 'function') {
-            return !!this._onVehicleTypeReceived(vehicleType, systemSoftwareVersion, systemHardwareVersion);
+            return !!this._onVehicleTypeReceived(vehicleType);
         }
         return true;
     }

lib/js/src/manager/_SdlManagerBase.js

@@ -39,7 +39,7 @@ class _SdlManagerBase {
      * @class
      * @private
      * @param {AppConfig} appConfig - An instance of AppConfig describing the application's metadata and desired transport
-     * @param {ManagerListener} managerListener - An instance of ManagerListener to be used to listen for manager events
+     * @param {SdlManagerListener} managerListener - An instance of ManagerListener to be used to listen for manager events
      */
     constructor (appConfig = null, managerListener = null) {
         this._state = -1;

lib/js/src/manager/lifecycle/_LifecycleManager.js

@@ -421,13 +421,11 @@ class _LifecycleManager {
     /**
      * Safely attempts to invoke the onVehicleTypeReceived event.
      * @param {VehicleType} vehicleType - the type of vehicle that this session is currently active on.
-     * @param {String} systemSoftwareVersion - software version of the system.
-     * @param {String} systemHardwareVersion - hardware version of the system.
      * @returns {Boolean} Return true if this session should continue, false if the session should end
      */
-    onVehicleTypeReceived (vehicleType, systemSoftwareVersion, systemHardwareVersion) {
+    onVehicleTypeReceived (vehicleType) {
         if (typeof this._onVehicleTypeReceived === 'function') {
-            return !!this._onVehicleTypeReceived(vehicleType, systemSoftwareVersion, systemHardwareVersion);
+            return !!this._onVehicleTypeReceived(vehicleType);
         }
         return true;
     }
@@ -510,11 +508,12 @@ class _LifecycleManager {
             this._cleanProxy();
         }
 
-        if (this._rpcSpecVersion.isNewerThan(new Version(7, 0, 0)) === 1) {
+        // to avoid double firing the onVehicleTypeReceived event
+        // try to define vehicleType and fire onVehicleTypeReceived here
+        // only if that was not received from SdlSession before
+        if (!this._sdlSession.didReceiveVehicleType()) {
             const vehicleType = registerAppInterfaceResponse.getVehicleType();
-            const systemSoftwareVersion = registerAppInterfaceResponse.getSystemSoftwareVersion();
-            const systemHardwareVersion = registerAppInterfaceResponse.getSystemHardwareVersion();
-            if (!this.onVehicleTypeReceived(vehicleType, systemSoftwareVersion, systemHardwareVersion)) {
+            if (!this.onVehicleTypeReceived(vehicleType)) {
                 console.warn('(RAI) Disconnecting from head unit, the vehicle is not supported');
                 this.sendRpcResolve(new UnregisterAppInterface());
                 this._cleanProxy();

lib/js/src/protocol/_SdlProtocolBase.js

@@ -38,14 +38,14 @@ import { _FrameType } from './enums/_FrameType.js';
 import { _MessageFrameAssembler } from './_MessageFrameAssembler.js';
 import { _SdlPacket } from './_SdlPacket.js';
 import { _ControlFrameTags } from './enums/_ControlFrameTags.js';
-import { _BitConverter } from './../util/_BitConverter.js';
+import { _BitConverter } from '../util/_BitConverter.js';
 
 import { _SdlPacketFactory } from './_SdlPacketFactory.js';
-import { RpcCreator } from './../rpc/RpcCreator.js';
+import { RpcCreator } from '../rpc/RpcCreator.js';
 import { ImageResolution } from '../rpc/structs/ImageResolution.js';
 import { VideoStreamingFormat } from '../rpc/structs/VideoStreamingFormat.js';
 
-import { VehicleType } from './../rpc/structs/VehicleType.js';
+import { VehicleType } from '../rpc/structs/VehicleType.js';
 
 /**
  * Base implementation of sdl protocol.
@@ -272,32 +272,29 @@ class _SdlProtocolBase {
 
     /**
      * Gets the Vehicle details received in StartService ACK protocol message
-     * @returns {Number} - A new numeric message ID.
+     * @returns {VehicleType|null} - A RPC VehicleType struct received from the packet if exists null otherwise.
      */
     _getVehicleType(sdlPacket) {
         const make = sdlPacket.getTag(_ControlFrameTags.RPC.StartServiceACK.VEHICLE_MAKE);
-        if (!make) {
-            return null;
-        }
         const model = sdlPacket.getTag(_ControlFrameTags.RPC.StartServiceACK.VEHICLE_MODEL);
         const modelYear = sdlPacket.getTag(_ControlFrameTags.RPC.StartServiceACK.VEHICLE_MODEL_YEAR);
         const trim = sdlPacket.getTag(_ControlFrameTags.RPC.StartServiceACK.VEHICLE_TRIM);
 
-        const vehicleType = new VehicleType({
+        // TODO: awaiting 0293 revisions to process those fields
+        const systemHardwareVersion = sdlPacket.getTag(_ControlFrameTags.RPC.StartServiceACK.VEHICLE_SYSTEM_HARDWARE_VERSION);
+        const systemSoftwareVersion = sdlPacket.getTag(_ControlFrameTags.RPC.StartServiceACK.VEHICLE_SYSTEM_SOFTWARE_VERSION);
+
+        // if no any VehicleType tags in the packet just return null
+        if (!make && !model && !modelYear && !trim) {
+            return null;
+        }
+
+        return new VehicleType({
             make,
             model,
             modelYear,
             trim,
         });
-
-        const systemHardwareVersion = sdlPacket.getTag(_ControlFrameTags.RPC.StartServiceACK.VEHICLE_SYSTEM_HARDWARE_VERSION);
-        const systemSoftwareVersion = sdlPacket.getTag(_ControlFrameTags.RPC.StartServiceACK.VEHICLE_SYSTEM_SOFTWARE_VERSION);
-
-        return {
-            vehicleType,
-            systemHardwareVersion,
-            systemSoftwareVersion,
-        }
     }
 
     /**
@@ -438,15 +435,15 @@ class _SdlProtocolBase {
         const version = sdlPacket.getVersion();
         const serviceType = sdlPacket.getServiceType();
         if (version >= 5) {
-            const vehicleTypeFromPacket = this._getVehicleType(sdlPacket);
+            // check if vehicleType data exists then fire onVehicleTypeReceived protocol listener event
+            const vehicleType = this._getVehicleType(sdlPacket);
             if (
-              vehicleTypeFromPacket
+              vehicleType
               && this._sdlProtocolListener !== null
               && typeof this._sdlProtocolListener.onVehicleTypeReceived === 'function'
             ) {
-                const {vehicleType, systemSoftwareVersion, systemHardwareVersion } = vehicleTypeFromPacket;
-                if (!this._sdlProtocolListener.onVehicleTypeReceived(vehicleType, systemSoftwareVersion, systemHardwareVersion)) {
-                    console.warn('Disconnecting from head unit, the vehicle is not supported (ACK)');
+                if (!this._sdlProtocolListener.onVehicleTypeReceived(vehicleType)) {
+                    console.warn('(ACK) Disconnecting from head unit, the vehicle is not supported');
                     this.endService(serviceType, sdlPacket.getSessionID());
                     if (serviceType === _ServiceType.RPC && this._transportManager !== null) {
                         this._transportManager.stop();

lib/js/src/protocol/_SdlProtocolListener.js

@@ -203,13 +203,11 @@ class _SdlProtocolListener {
     /**
      * Safely attempts to invoke the onVehicleTypeReceived event.
      * @param {VehicleType} vehicleType - the type of vehicle that this session is currently active on.
-     * @param {String} systemSoftwareVersion - software version of the system.
-     * @param {String} systemHardwareVersion - hardware version of the system.
      * @returns {Boolean} Return true if this session should continue, false if the session should end
      */
-    onVehicleTypeReceived (vehicleType, systemSoftwareVersion, systemHardwareVersion) {
+    onVehicleTypeReceived (vehicleType) {
         if (typeof this._onVehicleTypeReceived === 'function') {
-            return !!this._onVehicleTypeReceived(vehicleType, systemSoftwareVersion, systemHardwareVersion);
+            return !!this._onVehicleTypeReceived(vehicleType);
         }
         return true;
     }

lib/js/src/rpc/messages/RegisterAppInterfaceResponse.js

@@ -1,6 +1,6 @@
 /* eslint-disable camelcase */
 /*
-* Copyright (c) 2021, SmartDeviceLink Consortium, Inc.
+* Copyright (c) 2020, SmartDeviceLink Consortium, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
@@ -431,26 +431,6 @@ class RegisterAppInterfaceResponse extends RpcResponse {
         return this.getParameter(RegisterAppInterfaceResponse.KEY_SYSTEM_SOFTWARE_VERSION);
     }
 
-    /**
-     * Set the SystemHardwareVersion
-     * @since SmartDeviceLink 7.1.0
-     * @param {String} version - The hardware version of the system - The desired SystemHardwareVersion.
-     * {'string_min_length': 1, 'string_max_length': 500}
-     * @returns {RegisterAppInterfaceResponse} - The class instance for method chaining.
-     */
-    setSystemHardwareVersion (version) {
-        this.setParameter(RegisterAppInterfaceResponse.KEY_SYSTEM_HARDWARE_VERSION, version);
-        return this;
-    }
-
-    /**
-     * Get the SystemHardwareVersion
-     * @returns {String} - the KEY_SYSTEM_HARDWARE_VERSION value
-     */
-    getSystemHardwareVersion () {
-        return this.getParameter(RegisterAppInterfaceResponse.KEY_SYSTEM_HARDWARE_VERSION);
-    }
-
     /**
      * Set the IconResumed
      * @since SmartDeviceLink 5.0.0
@@ -489,7 +469,6 @@ RegisterAppInterfaceResponse.KEY_SUPPORTED_DIAG_MODES = 'supportedDiagModes';
 RegisterAppInterfaceResponse.KEY_HMI_CAPABILITIES = 'hmiCapabilities';
 RegisterAppInterfaceResponse.KEY_SDL_VERSION = 'sdlVersion';
 RegisterAppInterfaceResponse.KEY_SYSTEM_SOFTWARE_VERSION = 'systemSoftwareVersion';
-RegisterAppInterfaceResponse.KEY_SYSTEM_HARDWARE_VERSION = 'systemHardwareVersion';
 RegisterAppInterfaceResponse.KEY_ICON_RESUMED = 'iconResumed';
 
 export { RegisterAppInterfaceResponse };

lib/js/src/session/_SdlSession.js

@@ -61,6 +61,7 @@ class _SdlSession {
         this._sdlProtocolListener = this._setupSdlProtocolListener();
 
         this._sdlProtocol = new _SdlProtocol(baseTransportConfig, this._sdlProtocolListener);
+        this._didReceiveVehicleType = false;
     }
 
     /**
@@ -169,16 +170,24 @@ class _SdlSession {
         this._sdlSessionListener.onAuthTokenReceived(authToken, this._sessionId);
     }
 
+    /**
+     * A way to determine if VehicleType already received
+     * @returns {Boolean} Return true if received
+     */
+    didReceiveVehicleType() {
+        return this._didReceiveVehicleType;
+    }
+
     /**
      * A way to determine if this SDL session should continue to be active while
      * connected to the determined vehicle type.
      * @param {VehicleType} vehicleType - the type of vehicle that this session is currently active on.
-     * @param {String} systemSoftwareVersion - software version of the system.
-     * @param {String} systemHardwareVersion - hardware version of the system.
      * @returns {Boolean} Return true if this session should continue, false if the session should end
      */
-    onVehicleTypeReceived (vehicleType, systemSoftwareVersion, systemHardwareVersion) {
-        return this._sdlSessionListener.onVehicleTypeReceived(vehicleType, systemSoftwareVersion, systemHardwareVersion);
+    onVehicleTypeReceived (vehicleType) {
+        // set the flag as this event fires only once if VehicleType was received
+        this._didReceiveVehicleType = true;
+        return this._sdlSessionListener.onVehicleTypeReceived(vehicleType);
     }
 
     /** **********************************************************************************************************************************************************************

lib/js/src/session/_SdlSessionListener.js

@@ -173,13 +173,11 @@ class _SdlSessionListener {
     /**
      * Safely attempts to invoke the onVehicleTypeReceived event.
      * @param {VehicleType} vehicleType - the type of vehicle that this session is currently active on.
-     * @param {String} systemSoftwareVersion - software version of the system.
-     * @param {String} systemHardwareVersion - hardware version of the system.
      * @returns {Boolean} Return true if this session should continue, false if the session should end
      */
-    onVehicleTypeReceived (vehicleType, systemSoftwareVersion, systemHardwareVersion) {
+    onVehicleTypeReceived (vehicleType) {
         if (typeof this._onVehicleTypeReceived === 'function') {
-            return !!this._onVehicleTypeReceived(vehicleType, systemSoftwareVersion, systemHardwareVersion);
+            return !!this._onVehicleTypeReceived(vehicleType);
         }
         return true;
     }

tests/managers/lifecycle/LifecycleManagerTests.js

@@ -52,5 +52,21 @@ module.exports = function (appClient) {
             Validator.assertNotNullUndefined(version.getPatchVersion());
             done();
         });
+        it('testOnVehicleTypeReceived', function (done) {
+            const mockVehicleType = {};
+            const defaultResult = true;
+            let actualResult = sdlManager.getFileManager()._lifecycleManager.onVehicleTypeReceived(mockVehicleType);
+            Validator.assertEquals(actualResult, defaultResult);
+
+            const testResult = false;
+            const testListener = function (vehicleType) {
+                return testResult;
+            };
+            sdlManager.getFileManager()._lifecycleManager.setOnVehicleTypeReceived(testListener);
+            actualResult = sdlManager.getFileManager()._lifecycleManager.onVehicleTypeReceived(mockVehicleType);
+            Validator.assertEquals(actualResult, testResult);
+
+            done();
+        });
     });
 };

tests/node/rpc/messages/RegisterAppInterfaceResponseTests.js

@@ -32,7 +32,6 @@ describe('RegisterAppInterfaceResponseTests', function () {
             // TODO sdlVersion https://github.com/smartdevicelink/rpc_spec/blob/version/6_0_0/MOBILE_API.xml#L4663 unused?
             msg.setSystemSoftwareVersion(Test.GENERAL_STRING);
             msg.setIconResumed(Test.GENERAL_BOOLEAN);
-            msg.setSystemHardwareVersion(Test.GENERAL_STRING);
 
             return msg;
         };
@@ -58,7 +57,6 @@ describe('RegisterAppInterfaceResponseTests', function () {
             expectedParameters[RegisterAppInterfaceResponse.KEY_HMI_CAPABILITIES] = Test.GENERAL_HMICAPABILITIES.getParameters();
             expectedParameters[RegisterAppInterfaceResponse.KEY_SYSTEM_SOFTWARE_VERSION] = Test.GENERAL_STRING;
             expectedParameters[RegisterAppInterfaceResponse.KEY_ICON_RESUMED] = Test.GENERAL_BOOLEAN;
-            expectedParameters[RegisterAppInterfaceResponse.KEY_SYSTEM_HARDWARE_VERSION] = Test.GENERAL_STRING;
 
             return expectedParameters;
         };
@@ -96,7 +94,6 @@ describe('RegisterAppInterfaceResponseTests', function () {
         const testHmiCapabilities =  msg.getHmiCapabilities();
         const testSystemSoftwareVersion =  msg.getSystemSoftwareVersion();
         const testIconResumed =  msg.getIconResumed();
-        const testSystemHardwareVersion =  msg.getSystemHardwareVersion();
 
         // Valid Tests
         Validator.validateSdlMsgVersion(Test.GENERAL_SDLMSGVERSION, testMsgVersion);
@@ -117,7 +114,6 @@ describe('RegisterAppInterfaceResponseTests', function () {
         Validator.validateHMICapabilities(Test.GENERAL_HMICAPABILITIES, testHmiCapabilities);
         Validator.assertEquals(Test.GENERAL_STRING, testSystemSoftwareVersion);
         Validator.assertEquals(Test.GENERAL_BOOLEAN, testIconResumed);
-        Validator.assertEquals(Test.GENERAL_STRING, testSystemHardwareVersion);
 
         // Invalid/Null Tests
         msg = new RegisterAppInterfaceResponse();
@@ -145,9 +141,8 @@ describe('RegisterAppInterfaceResponseTests', function () {
         Validator.assertNullOrUndefined(msg.getHmiCapabilities());
         Validator.assertNullOrUndefined(msg.getSystemSoftwareVersion());
         Validator.assertNullOrUndefined(msg.getIconResumed());
-        Validator.assertNullOrUndefined(msg.getSystemHardwareVersion());
 
 
         done();
     });
-});
+});