Resolve merge conflicts

examples/node/hello-sdl/AppClient.js

@@ -0,0 +1,168 @@
+/*
+* Copyright (c) 2019, Livio, Inc.
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* Redistributions of source code must retain the above copyright notice, this
+* list of conditions and the following disclaimer.
+*
+* Redistributions in binary form must reproduce the above copyright notice,
+* this list of conditions and the following
+* disclaimer in the documentation and/or other materials provided with the
+* distribution.
+*
+* Neither the name of the Livio Inc. nor the names of its contributors
+* may be used to endorse or promote products derived from this software
+* without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+* POSSIBILITY OF SUCH DAMAGE.
+*/
+
+const fs = require('fs');
+const SDL = require('../../../lib/node/dist/index.js');
+const CONFIG = require('./config.js');
+
+class AppClient {
+    constructor (wsClient) {
+        this._appConfig = new SDL.manager.AppConfig()
+            .setAppId(CONFIG.appId)
+            .setAppName(CONFIG.appName)
+            .setIsMediaApp(false)
+            .setLanguageDesired(SDL.rpc.enums.Language.EN_US)
+            .setHmiDisplayLanguageDesired(SDL.rpc.enums.Language.EN_US)
+            .setAppTypes([
+                SDL.rpc.enums.AppHMIType.DEFAULT,
+            ])
+            .setTransportConfig(
+                new SDL.transport.WebSocketServerConfig(
+                    wsClient,
+                    CONFIG.connectionLostTimeout
+                )
+            );
+
+        const listener = new SDL.manager.lifecycle.LifecycleListener();
+        listener.setOnProxyConnected((manager) => {
+            this._onConnected();
+        });
+        listener.setOnProxyClosed((lifecycleManager, info, reason) => {});
+        listener.setOnServiceStarted((serviceType, sessionId, correlationId) => {});
+        listener.setOnServiceEnded((serviceType) => {});
+        listener.setOnError((lifecycleManager, info) => {});
+
+        this._manager = new SDL.manager.lifecycle.LifecycleManager(this._appConfig, listener);
+
+        const hmiFullListener = new SDL.rpc.RpcListener().setOnRpcMessage(this._onHmiStatusListener.bind(this));
+
+        this._manager.addRpcListener(SDL.rpc.enums.FunctionID.OnHMIStatus, hmiFullListener);
+    }
+
+    start () {
+        this._manager.start();
+    }
+
+    async _onConnected () {
+        // app starts in the NONE state
+        const fileBinary = await _fetchImageUnit8Array('./test_icon_1.png');
+        const fileName = `${this._appConfig.getAppId()}_icon.gif`;
+
+        const putFile = new SDL.rpc.messages.PutFile()
+            .setFileName(fileName)
+            .setFileType('GRAPHIC_PNG')
+            .setPersistentFile(true)
+            .setFileData(fileBinary);
+
+        await this._asyncSendRpc(putFile);
+
+        const setAppIcon = new SDL.rpc.messages.SetAppIcon()
+            .setFileName(fileName);
+
+        await this._asyncSendRpc(setAppIcon);
+    }
+
+    async _onHmiStatusListener (onHmiStatus) {
+        const hmiLevel = onHmiStatus.getHmiLevel();
+
+        // wait for the FULL state for more functionality
+        if (hmiLevel === SDL.rpc.enums.HMILevel.HMI_FULL) {
+            const show = new SDL.rpc.messages.Show();
+            show.setMainField1('Hello')
+                .setMainField2('こんにちは')
+                .setMainField3('你好');
+
+            await this._asyncSendRpc(show);
+
+            await this._sleep(2000);
+
+            const count = 3;
+            for (let i = 0; i < count; i++) {
+                const showCountdown = new SDL.rpc.messages.Show();
+                showCountdown.setMainField1(`Exiting in ${(count - i).toString()}`)
+                    .setMainField2('')
+                    .setMainField3('');
+
+                this._asyncSendRpc(showCountdown); // don't wait for a response
+
+                await this._sleep();
+            }
+
+            // tear down the app
+            await this._asyncSendRpc(new SDL.rpc.messages.UnregisterAppInterface());
+
+            this._manager.stop();
+        }
+    }
+
+    async _sleep (timeout = 1000) {
+        return new Promise((resolve) => {
+            setTimeout(resolve, timeout);
+        });
+    }
+
+    // TODO: this should go into some manager class
+    // abstracts out the work of sending the RPC and attaching listeners to wait for a response
+    _asyncSendRpc (request, timeout = 5000) {
+        return new Promise((resolve, reject) => {
+            const functionId = SDL.rpc.enums.FunctionID.valueForKey(request.getFunctionName()); // this is the number value
+            let correlationIdRequest;
+            let listener;
+
+            listener = new SDL.rpc.RpcListener().setOnRpcMessage(rpcMessage => {
+                const correlationIdResponse = rpcMessage.getCorrelationId();
+                // ensure the correlation ids match
+                if (correlationIdRequest === correlationIdResponse) {
+                    // remove the listener once the correct response is received
+                    this._manager.removeRpcListener(functionId, listener);
+                    resolve(rpcMessage);
+                }
+            });
+
+            this._manager.addRpcListener(functionId, listener);
+            this._manager.sendRpcMessage(request); // the request will get a correlation id after this method
+
+            correlationIdRequest = request.getCorrelationId();
+
+            setTimeout(() => {
+                reject(new Error(`Response timeout for ${request.getFunctionName()}`));
+            }, timeout); // timeout after so long of not getting a response
+        });
+    }
+}
+
+async function _fetchImageUnit8Array (path) {
+    const aryBuffer = fs.readFileSync(path, null);
+    return new Uint8Array(aryBuffer);
+}
+
+module.exports = AppClient;

examples/node/hello-sdl/config.js

@@ -34,4 +34,5 @@ module.exports = {
     appId: 'hello-node',
     appName: 'hello-node',
     port: process.env.APP_PORT || 3005,
+    connectionLostTimeout: !isNaN(parseInt(process.env.CONNECTION_LOST_TIMEOUT)) ? parseInt(process.env.CONNECTION_LOST_TIMEOUT) : 10000,
 };

examples/node/hello-sdl/index.js

@@ -33,135 +33,17 @@
 const fs = require('fs');
 const SDL = require('../../../lib/node/dist/index.js');
 const CONFIG = require('./config.js');
-
-class HelloSdl {
-    constructor () {
-        this._appConfig = new SDL.manager.AppConfig()
-            .setAppId(CONFIG.appId)
-            .setAppName(CONFIG.appName)
-            .setIsMediaApp(false)
-            .setLanguageDesired(SDL.rpc.enums.Language.EN_US)
-            .setHmiDisplayLanguageDesired(SDL.rpc.enums.Language.EN_US)
-            .setAppTypes([
-                SDL.rpc.enums.AppHMIType.DEFAULT,
-            ])
-            .setTransportConfig(new SDL.transport.WebSocketServerConfig(
-                CONFIG.port
-            ));
-
-        const listener = new SDL.manager.lifecycle.LifecycleListener();
-        listener.setOnProxyConnected((manager) => {
-            this._onConnected();
-        });
-        listener.setOnProxyClosed((lifecycleManager, info, reason) => {});
-        listener.setOnServiceStarted((serviceType, sessionId, correlationId) => {});
-        listener.setOnServiceEnded((serviceType) => {});
-        listener.setOnError((lifecycleManager, info) => {});
-
-        this._manager = new SDL.manager.lifecycle.LifecycleManager(this._appConfig, listener);
-
-        const hmiFullListener = new SDL.rpc.RpcListener().setOnRpcMessage(this._onHmiStatusListener.bind(this));
-
-        this._manager.addRpcListener(SDL.rpc.enums.FunctionID.OnHMIStatus, hmiFullListener);
-    }
-
-    start () {
-        this._manager.start();
-    }
-
-    async _onConnected () {
-        // app starts in the NONE state
-        const fileBinary = await _fetchImageUnit8Array('./test_icon_1.png');
-        const fileName = `${this._appConfig.getAppId()}_icon.gif`;
-
-        const putFile = new SDL.rpc.messages.PutFile()
-            .setFileName(fileName)
-            .setFileType('GRAPHIC_PNG')
-            .setPersistentFile(true)
-            .setFileData(fileBinary);
-
-        await this._asyncSendRpc(putFile);
-
-        const setAppIcon = new SDL.rpc.messages.SetAppIcon()
-            .setFileName(fileName);
-
-        await this._asyncSendRpc(setAppIcon);
-    }
-
-    async _onHmiStatusListener (onHmiStatus) {
-        const hmiLevel = onHmiStatus.getHmiLevel();
-
-        // wait for the FULL state for more functionality
-        if (hmiLevel === SDL.rpc.enums.HMILevel.HMI_FULL) {
-            const show = new SDL.rpc.messages.Show();
-            show.setMainField1('Hello')
-                .setMainField2('こんにちは')
-                .setMainField3('你好');
-
-            await this._asyncSendRpc(show);
-
-            await this._sleep(2000);
-
-            const count = 3;
-            for (let i = 0; i < count; i++) {
-                const showCountdown = new SDL.rpc.messages.Show();
-                showCountdown.setMainField1(`Exiting in ${(count - i).toString()}`)
-                    .setMainField2('')
-                    .setMainField3('');
-
-                this._asyncSendRpc(showCountdown); // don't wait for a response
-
-                await this._sleep();
-            }
-
-            // tear down the app
-            await this._asyncSendRpc(new SDL.rpc.messages.UnregisterAppInterface());
-
-            this._manager.stop();
-        }
-    }
-
-    async _sleep (timeout = 1000) {
-        return new Promise((resolve) => {
-            setTimeout(resolve, timeout);
-        });
-    }
-
-    // TODO: this should go into some manager class
-    // abstracts out the work of sending the RPC and attaching listeners to wait for a response
-    _asyncSendRpc (request, timeout = 5000) {
-        return new Promise((resolve, reject) => {
-            const functionId = SDL.rpc.enums.FunctionID.valueForKey(request.getFunctionName()); // this is the number value
-            let correlationIdRequest;
-            let listener;
-
-            listener = new SDL.rpc.RpcListener().setOnRpcMessage(rpcMessage => {
-                const correlationIdResponse = rpcMessage.getCorrelationId();
-                // ensure the correlation ids match
-                if (correlationIdRequest === correlationIdResponse) {
-                    // remove the listener once the correct response is received
-                    this._manager.removeRpcListener(functionId, listener);
-                    resolve(rpcMessage);
-                }
-            });
-
-            this._manager.addRpcListener(functionId, listener);
-            this._manager.sendRpcMessage(request); // the request will get a correlation id after this method
-
-            correlationIdRequest = request.getCorrelationId();
-
-            setTimeout(() => {
-                reject(new Error(`Response timeout for ${request.getFunctionName()}`));
-            }, timeout); // timeout after so long of not getting a response
-        });
-    }
-}
-
-async function _fetchImageUnit8Array (path) {
-    const aryBuffer = fs.readFileSync(path, null);
-    return new Uint8Array(aryBuffer);
-}
-
-console.log('start app');
-const app = new HelloSdl();
-app.start();
+const WS = require('ws');
+const AppClient = require('./AppClient.js');
+
+// create a WebSocket Server
+const appWebSocketServer = new WS.Server({
+    port: CONFIG.port,
+});
+console.log(`WebSocket Server listening on port ${CONFIG.port}`);
+
+// Event listener for incoming WebSocket connections
+appWebSocketServer.on('connection', (connection) => {
+    console.log('connection established');
+    new AppClient(connection).start();
+});

lib/js/src/protocol/MessageFrameDisassembler.js

@@ -81,7 +81,7 @@ class MessageFrameDisassembler {
       */
     static buildRPC (rpcRequest, sessionId, messageId, mtu, version, isEncrypted, cb) {
         const obj = new MessageFrameDisassembler(rpcRequest, sessionId, messageId, mtu, version, isEncrypted, cb);
-        obj.doRequest();
+        obj._doRequest();
         return obj;
     }
 
@@ -128,8 +128,9 @@ class MessageFrameDisassembler {
     /**
      * Start the RPC request and use callback to send
      * sdl packets of the appropriate size.
+     * @private
      */
-    doRequest () {
+    _doRequest () {
         const version = this._version;
         const frameInfo = 0;
         const frameType = FrameType.SINGLE;