FM-852: add setWorkerOfflineIfDisconnected param (#412)

Author: cancit

lib/Worker.js

@@ -145,7 +145,10 @@ class Worker extends EventEmitter {
          * @private
          * @type {EventBridgeSignaling}
          */
-        this._signaling = new deps.EventBridgeSignaling(this, { closeExistingSessions: options.closeExistingSessions });
+        this._signaling = new deps.EventBridgeSignaling(this, {
+            closeExistingSessions: options.closeExistingSessions,
+            setWorkerOfflineIfDisconnected: options.setWorkerOfflineIfDisconnected,
+        });
         /**
          * @private
          * @type {RetryUtil}
@@ -715,6 +718,7 @@ export default Worker;
  * @property {string} [connectActivitySid=''] - The {@link Activity} state of the Worker upon connect
  * @property {boolean} [closeExistingSessions=false] - - Whether other open sessions of this {@link Worker}
  *   should be terminated
+ * @property {boolean} [setWorkerOfflineIfDisconnected=true] - A boolean defining whether if {@link Worker} availability set as Offline when the connection is terminated
  * @property {string} [logLevel='error'] - The level of logging to enable
  *   ['error', 'warn', 'info', 'debug', 'trace', 'silent']
  * @property {string} [region] - the realm for connections (ex. "stage-us1")

lib/signaling/EventBridgeSignaling.js

@@ -16,6 +16,7 @@ const CLIENT_VERSION = packageJson.version;
 /**
  * @typedef {Object} EventBridgeSignal.Options
  * @property {boolean} [closeExistingSessions=false] - A boolean defining whether other open sessions of the {@link Worker} should be terminated
+ * @property {boolean} [setWorkerOfflineIfDisconnected=true] - A boolean defining whether if {@link Worker} availability set as Offline when the connection is terminated
  */
 
 /**
@@ -88,6 +89,10 @@ export default class EventBridgeSignaling extends EventEmitter {
          * @type {boolean}
          */
         this.closeExistingSessions = options.closeExistingSessions || false;
+         /**
+         * @type {boolean}
+         */
+        this.setWorkerOfflineIfDisconnected = options.setWorkerOfflineIfDisconnected;
         /**
          * @private
          * @type {import('../util/Configuration')}
@@ -181,7 +186,11 @@ export default class EventBridgeSignaling extends EventEmitter {
 
         this._log.debug('createWebSocket called');
 
-        const queryParam = `?${EB_URL_PARAMS.TOKEN}=${this._config.token}&${EB_URL_PARAMS.CLOSE_EXISTING_SESSIONS}=${this.closeExistingSessions}&${EB_URL_PARAMS.CLIENT_VERSION}=${CLIENT_VERSION}`;
+        let queryParam = `?${EB_URL_PARAMS.TOKEN}=${this._config.token}&${EB_URL_PARAMS.CLOSE_EXISTING_SESSIONS}=${this.closeExistingSessions}&${EB_URL_PARAMS.CLIENT_VERSION}=${CLIENT_VERSION}`;
+        if (typeof this.setWorkerOfflineIfDisconnected !== 'undefined') {
+            queryParam = queryParam.concat(`&${EB_URL_PARAMS.SET_WORKER_OFFLINE_IF_DISCONNECTED}=${this.setWorkerOfflineIfDisconnected}`);
+        }
+        this._log.debug('Websocket Connection URL', this._config.WS_SERVER + queryParam);
         this.webSocket = new WS(this._config.WS_SERVER + queryParam);
 
         this._log.debug('New websocket created');

lib/util/Constants.js

@@ -122,7 +122,8 @@ export const DEFAULT_HTTP_TIMEOUT = 15000;
 export const EB_URL_PARAMS = {
     TOKEN: 'token',
     CLOSE_EXISTING_SESSIONS: 'closeExistingSessions',
-    CLIENT_VERSION: 'clientVersion'
+    CLIENT_VERSION: 'clientVersion',
+    SET_WORKER_OFFLINE_IF_DISCONNECTED: 'setWorkerOfflineIfDisconnected'
 };
 
 // Define common set of Twilio errors

test/unit/spec/signaling/EventBridgeSignaling.js

@@ -49,6 +49,18 @@ describe('EventBridgeSignaling', () => {
       const signaling = new EventBridgeSignaling(worker);
       assert.isFalse(signaling.closeExistingSessions);
     });
+
+    it('should set setWorkerOfflineIfDisconnected option', () => {
+      const worker = new Worker(initialToken, WorkerConfig);
+      const options = {
+        setWorkerOfflineIfDisconnected: false
+      };
+
+      const signaling = new EventBridgeSignaling(worker, options);
+
+      assert.isFalse(signaling.setWorkerOfflineIfDisconnected);
+    });
+
   });
 
   describe('#updateToken(newToken)', () => {

types.d.ts

@@ -326,6 +326,7 @@ export interface ReservationParticipantOptions {
 export interface WorkerOptions {
     connectActivitySid?: string;
     closeExistingSessions?: boolean;
+    setWorkerOfflineIfDisconnected?: boolean
     logLevel?: "error" | "warn" | "info" | "debug" | "trace" | "silent";
     ebServer?: string;
     wsServer?: string;