#21 [LG 2022 Model] Error: socket hang up

README.md

@@ -37,6 +37,8 @@ package in your `package.json`)
 |`appium:debuggerPort`|[Optional; default `9998`] The port on the device exposed for remote Chromium debugging.|
 |`appium:chromedriverExecutable`|[Optional] Most LG TVs run a very old version of Chrome. Because this driver uses Chromedriver under the hood, you'll need to have a very old version of Chromedriver handy that works with the version of Chrome backing the apps on your TV. In our testing, we've found Chromedriver 2.36 to work with most TVs. You need to tell the driver where you've installed this version of Chromedriver using the `appium:chromedriverExecutable` capability, passing in an absolute path to the Chromedriver binary.|
 |`appium:websocketPort`|[Optional; default `3000`] The websocket port on the device exposed for remote control|
+|`appium:websocketPortSecure`|[Optional; default `3001`] The secure websocket port on the device exposed for remote control|
+|`appium:websocketSecure`|[Optional; default `false`] Flag that enables use of `websocketPortSecure` port, also starts WebSocket over https instead. **DISCLAMER** Enabling this flag, it is required to set environment variable `export NODE_TLS_REJECT_UNAUTHORIZED=0`, which can be a potential security risk.|
 |`appium:autoExtendDevMode`|[Optional; default `true`] Whether you want Appium to extend the dev mode timer on the device whenever a new session starts.|
 |`appium:appLaunchParams`|[Optional; default `{}`] A key/value object of app launch param to be passed to `ares-launch`|
 |`appium:appLaunchCooldown`|[Optional; default `3000`] How many ms to wait after triggering app launch to attempt to connect to it via Chromedriver.|

lib/constraints.js

@@ -26,6 +26,12 @@ export const CAP_CONSTRAINTS = Object.freeze(
     websocketPort: {
       isNumber: true,
     },
+    websocketPortSecure: {
+      isNumber: true,
+    },
+    websocketSecure: {
+      isBoolean: true,
+    },
     chromedriverExecutable: {
       isString: true,
       //presence: true
@@ -55,6 +61,8 @@ export const CAP_CONSTRAINTS = Object.freeze(
 export const DEFAULT_CAPS = Object.freeze(/** @type {const} */({
   'appium:debuggerPort': 9998,
   'appium:websocketPort': 3000,
+  'appium:websocketPortSecure': 3001,
+  'appium:websocketSecure': false,
   'appium:autoExtendDevMode': true,
   'appium:appLaunchCooldown': 3000,
   'appium:keyCooldown': 750,

lib/driver.js

@@ -96,6 +96,8 @@ export class WebOSDriver extends BaseDriver {
       appLaunchCooldown,
       remoteOnly,
       websocketPort,
+      websocketPortSecure,
+      websocketSecure,
       keyCooldown,
     } = caps;
 
@@ -138,6 +140,8 @@ export class WebOSDriver extends BaseDriver {
       valueBox: this.valueBox,
       deviceName,
       url: `ws://${deviceHost}:${websocketPort}`,
+      urlSecure: `wss://${deviceHost}:${websocketPortSecure}`,
+      websocketSecure,
       remoteKeyCooldown: keyCooldown,
     });
     log.info(`Connecting remote; address any prompts on screen now!`);

lib/remote/lg-socket-client.js

@@ -17,12 +17,18 @@ export class LGWSClient {
   /** @type {string} */
   #url;
 
+  /** @type {string} */
+  #urlSecure;
+
   /** @type {WebSocket|undefined} */
   #ws;
 
   /** @type {boolean} */
   #saveClientKey;
 
+  /** @type {boolean} */
+  #websocketSecure;
+
   #cmdNum = 0;
 
   /** @type {import('@appium/types').AppiumLogger} */
@@ -58,6 +64,8 @@ export class LGWSClient {
    */
   constructor({
     url,
+    urlSecure,
+    websocketSecure,
     valueBox,
     deviceName,
     log = logger.getLogger('LGWsClient'),
@@ -66,6 +74,8 @@ export class LGWSClient {
   }) {
     this.#valueBox = valueBox;
     this.#url = url;
+    this.#urlSecure = urlSecure;
+    this.#websocketSecure = websocketSecure;
     this.#log = log;
     this.#saveClientKey = saveClientKey;
     this.#remoteKeyCooldown = remoteKeyCooldown;
@@ -88,7 +98,11 @@ export class LGWSClient {
         ws.removeListener(WsEvent.OPEN, onOpen);
         rej(err);
       };
-      ws = new WebSocket(this.#url).once(WsEvent.OPEN, onOpen).once(WsEvent.ERROR, onError);
+      if (this.#websocketSecure) {
+        ws = new WebSocket(this.#urlSecure, {rejectUnauthorized: false}).once(WsEvent.OPEN, onOpen).once(WsEvent.ERROR, onError);
+      } else {
+        ws = new WebSocket(this.#url).once(WsEvent.OPEN, onOpen).once(WsEvent.ERROR, onError);
+      }
       this.#ws = ws;
     });
   }

lib/types.ts

@@ -74,6 +74,8 @@ export interface PressKeyOptions {
 export interface LGSocketClientOpts {
   deviceName: string;
   url: string;
+  urlSecure: string;
+  websocketSecure: boolean;
   valueBox: ValueBox;
   clientKey?: string;
   log?: AppiumLogger;