@webex/contact-center 3.10.0-next.32 → 3.10.0-next.34

package/dist/services/core/websocket/WebSocketManager.js

@@ -41,7 +41,15 @@ class WebSocketManager extends _events.default {
   }
   async initWebSocket(options) {
     const connectionConfig = options.body;
-    await this.register(connectionConfig);
+    try {
+      await this.register(connectionConfig);
+    } catch (error) {
+      _loggerProxy.default.error(`[WebSocketStatus] | Error in registering Websocket ${error}`, {
+        module: _constants3.WEB_SOCKET_MANAGER_FILE,
+        method: _constants2.METHODS.INIT_WEB_SOCKET
+      });
+      throw error;
+    }
     return new Promise((resolve, reject) => {
       this.welcomePromiseResolve = resolve;
       this.connect().catch(error => {
@@ -83,6 +91,7 @@ class WebSocketManager extends _events.default {
         module: _constants3.WEB_SOCKET_MANAGER_FILE,
         method: _constants2.METHODS.REGISTER
       });
+      throw e;
     }
   }
   async connect() {

package/dist/services/core/websocket/WebSocketManager.js.map

@@ -1 +1 @@
-{"version":3,"names":["_events","_interopRequireDefault","require","_types","_constants","_types2","_loggerProxy","_keepalive","_constants2","_constants3","e","__esModule","default","WebSocketManager","EventEmitter","url","welcomePromiseResolve","constructor","options","webex","shouldReconnect","websocket","isSocketClosed","isWelcomeReceived","forceCloseWebSocketOnTimeout","isConnectionLost","workerScriptBlob","Blob","workerScript","type","keepaliveWorker","Worker","URL","createObjectURL","initWebSocket","connectionConfig","body","register","Promise","resolve","reject","connect","catch","error","LoggerProxy","module","WEB_SOCKET_MANAGER_FILE","method","METHODS","INIT_WEB_SOCKET","close","reason","postMessage","log","CLOSE","handleConnectionLost","event","subscribeResponse","request","service","WCC_API_GATEWAY","resource","SUBSCRIBE_API","HTTP_METHODS","POST","webSocketUrl","REGISTER","undefined","CONNECT","WebSocket","onopen","send","JSON","stringify","keepalive","onmessage","keepAliveEvent","data","intervalDuration","KEEPALIVE_WORKER_INTERVAL","closeSocketTimeout","CLOSE_SOCKET_TIMEOUT","onerror","onclose","webSocketOnCloseHandler","emit","eventData","parse","CC_EVENTS","WELCOME","issueReason","onlineStatus","navigator","onLine","WEB_SOCKET_ON_CLOSE_HANDLER","exports"],"sources":["WebSocketManager.ts"],"sourcesContent":["import EventEmitter from 'events';\nimport {WebexSDK, SubscribeRequest, HTTP_METHODS} from '../../../types';\nimport {SUBSCRIBE_API, WCC_API_GATEWAY} from '../../constants';\nimport {ConnectionLostDetails} from './types';\nimport {CC_EVENTS, SubscribeResponse, WelcomeResponse} from '../../config/types';\nimport LoggerProxy from '../../../logger-proxy';\nimport workerScript from './keepalive.worker';\nimport {KEEPALIVE_WORKER_INTERVAL, CLOSE_SOCKET_TIMEOUT, METHODS} from '../constants';\nimport {WEB_SOCKET_MANAGER_FILE} from '../../../constants';\n\n/**\n * WebSocketManager handles the WebSocket connection for Contact Center operations.\n * It manages the connection lifecycle, including registration, reconnection, and message handling.\n * It also utilizes a Web Worker to manage keepalive messages and socket closure.\n * @ignore\n */\nexport class WebSocketManager extends EventEmitter {\n  private websocket: WebSocket;\n  shouldReconnect: boolean;\n  isSocketClosed: boolean;\n  private isWelcomeReceived: boolean;\n  private url: string | null = null;\n  private forceCloseWebSocketOnTimeout: boolean;\n  private isConnectionLost: boolean;\n  private webex: WebexSDK;\n  private welcomePromiseResolve:\n    | ((value: WelcomeResponse | PromiseLike<WelcomeResponse>) => void)\n    | null = null;\n\n  private keepaliveWorker: Worker;\n\n  constructor(options: {webex: WebexSDK}) {\n    super();\n    const {webex} = options;\n    this.webex = webex;\n    this.shouldReconnect = true;\n    this.websocket = {} as WebSocket;\n    this.isSocketClosed = false;\n    this.isWelcomeReceived = false;\n    this.forceCloseWebSocketOnTimeout = false;\n    this.isConnectionLost = false;\n\n    const workerScriptBlob = new Blob([workerScript], {type: 'application/javascript'});\n    this.keepaliveWorker = new Worker(URL.createObjectURL(workerScriptBlob));\n  }\n\n  async initWebSocket(options: {body: SubscribeRequest}): Promise<WelcomeResponse> {\n    const connectionConfig = options.body;\n    await this.register(connectionConfig);\n\n    return new Promise((resolve, reject) => {\n      this.welcomePromiseResolve = resolve;\n      this.connect().catch((error) => {\n        LoggerProxy.error(`[WebSocketStatus] | Error in connecting Websocket ${error}`, {\n          module: WEB_SOCKET_MANAGER_FILE,\n          method: METHODS.INIT_WEB_SOCKET,\n        });\n        reject(error);\n      });\n    });\n  }\n\n  close(shouldReconnect: boolean, reason = 'Unknown') {\n    if (!this.isSocketClosed && this.shouldReconnect) {\n      this.shouldReconnect = shouldReconnect;\n      this.websocket.close();\n      this.keepaliveWorker.postMessage({type: 'terminate'});\n      LoggerProxy.log(\n        `[WebSocketStatus] | event=webSocketClose | WebSocket connection closed manually REASON: ${reason}`,\n        {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.CLOSE}\n      );\n    }\n  }\n\n  handleConnectionLost(event: ConnectionLostDetails) {\n    this.isConnectionLost = event.isConnectionLost;\n  }\n\n  private async register(connectionConfig: SubscribeRequest) {\n    try {\n      const subscribeResponse: SubscribeResponse = await this.webex.request({\n        service: WCC_API_GATEWAY,\n        resource: SUBSCRIBE_API,\n        method: HTTP_METHODS.POST,\n        body: connectionConfig,\n      });\n      this.url = subscribeResponse.body.webSocketUrl;\n    } catch (e) {\n      LoggerProxy.error(\n        `Register API Failed, Request to RoutingNotifs websocket registration API failed ${e}`,\n        {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.REGISTER}\n      );\n    }\n  }\n\n  private async connect() {\n    if (!this.url) {\n      return undefined;\n    }\n    LoggerProxy.log(\n      `[WebSocketStatus] | event=webSocketConnecting | Connecting to WebSocket: ${this.url}`,\n      {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.CONNECT}\n    );\n    this.websocket = new WebSocket(this.url);\n\n    return new Promise((resolve, reject) => {\n      this.websocket.onopen = () => {\n        this.isSocketClosed = false;\n        this.shouldReconnect = true;\n\n        this.websocket.send(JSON.stringify({keepalive: 'true'}));\n        this.keepaliveWorker.onmessage = (keepAliveEvent: {data: any}) => {\n          if (keepAliveEvent?.data?.type === 'keepalive') {\n            this.websocket.send(JSON.stringify({keepalive: 'true'}));\n          }\n\n          if (keepAliveEvent?.data?.type === 'closeSocket' && this.isConnectionLost) {\n            this.forceCloseWebSocketOnTimeout = true;\n            this.close(true, 'WebSocket did not auto close within 16 secs');\n            LoggerProxy.error(\n              '[webSocketTimeout] | event=webSocketTimeout | WebSocket connection closed forcefully',\n              {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.CONNECT}\n            );\n          }\n        };\n\n        this.keepaliveWorker.postMessage({\n          type: 'start',\n          intervalDuration: KEEPALIVE_WORKER_INTERVAL, // Keepalive interval\n          isSocketClosed: this.isSocketClosed,\n          closeSocketTimeout: CLOSE_SOCKET_TIMEOUT, // Close socket timeout\n        });\n      };\n\n      this.websocket.onerror = (event: any) => {\n        LoggerProxy.error(\n          `[WebSocketStatus] | event=socketConnectionFailed | WebSocket connection failed ${event}`,\n          {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.CONNECT}\n        );\n        reject();\n      };\n\n      this.websocket.onclose = async (event: any) => {\n        this.webSocketOnCloseHandler(event);\n      };\n\n      this.websocket.onmessage = (e: MessageEvent) => {\n        this.emit('message', e.data);\n        const eventData = JSON.parse(e.data);\n\n        if (eventData.type === CC_EVENTS.WELCOME) {\n          this.isWelcomeReceived = true;\n          if (this.welcomePromiseResolve) {\n            this.welcomePromiseResolve(eventData.data as WelcomeResponse);\n            this.welcomePromiseResolve = null;\n          }\n        }\n\n        if (eventData.type === 'AGENT_MULTI_LOGIN') {\n          this.close(false, 'multiLogin');\n          LoggerProxy.error(\n            '[WebSocketStatus] | event=agentMultiLogin | WebSocket connection closed by agent multiLogin',\n            {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.CONNECT}\n          );\n        }\n      };\n    });\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  private async webSocketOnCloseHandler(event: any) {\n    this.isSocketClosed = true;\n    this.keepaliveWorker.postMessage({type: 'terminate'});\n    if (this.shouldReconnect) {\n      this.emit('socketClose');\n      let issueReason;\n      if (this.forceCloseWebSocketOnTimeout) {\n        issueReason = 'WebSocket auto close timed out. Forcefully closed websocket.';\n      } else {\n        const onlineStatus = navigator.onLine;\n        issueReason = !onlineStatus\n          ? 'network issue'\n          : 'missing keepalive from either desktop or notif service';\n      }\n      LoggerProxy.error(\n        `[WebSocketStatus] | event=webSocketClose | WebSocket connection closed REASON: ${issueReason}`,\n        {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.WEB_SOCKET_ON_CLOSE_HANDLER}\n      );\n      this.forceCloseWebSocketOnTimeout = false;\n    }\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AACA,IAAAE,UAAA,GAAAF,OAAA;AAEA,IAAAG,OAAA,GAAAH,OAAA;AACA,IAAAI,YAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,UAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,WAAA,GAAAN,OAAA;AACA,IAAAO,WAAA,GAAAP,OAAA;AAA2D,SAAAD,uBAAAS,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE3D;AACA;AACA;AACA;AACA;AACA;AACO,MAAMG,gBAAgB,SAASC,eAAY,CAAC;EAKzCC,GAAG,GAAkB,IAAI;EAIzBC,qBAAqB,GAElB,IAAI;EAIfC,WAAWA,CAACC,OAA0B,EAAE;IACtC,KAAK,CAAC,CAAC;IACP,MAAM;MAACC;IAAK,CAAC,GAAGD,OAAO;IACvB,IAAI,CAACC,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACC,eAAe,GAAG,IAAI;IAC3B,IAAI,CAACC,SAAS,GAAG,CAAC,CAAc;IAChC,IAAI,CAACC,cAAc,GAAG,KAAK;IAC3B,IAAI,CAACC,iBAAiB,GAAG,KAAK;IAC9B,IAAI,CAACC,4BAA4B,GAAG,KAAK;IACzC,IAAI,CAACC,gBAAgB,GAAG,KAAK;IAE7B,MAAMC,gBAAgB,GAAG,IAAIC,IAAI,CAAC,CAACC,kBAAY,CAAC,EAAE;MAACC,IAAI,EAAE;IAAwB,CAAC,CAAC;IACnF,IAAI,CAACC,eAAe,GAAG,IAAIC,MAAM,CAACC,GAAG,CAACC,eAAe,CAACP,gBAAgB,CAAC,CAAC;EAC1E;EAEA,MAAMQ,aAAaA,CAAChB,OAAiC,EAA4B;IAC/E,MAAMiB,gBAAgB,GAAGjB,OAAO,CAACkB,IAAI;IACrC,MAAM,IAAI,CAACC,QAAQ,CAACF,gBAAgB,CAAC;IAErC,OAAO,IAAIG,OAAO,CAAC,CAACC,OAAO,EAAEC,MAAM,KAAK;MACtC,IAAI,CAACxB,qBAAqB,GAAGuB,OAAO;MACpC,IAAI,CAACE,OAAO,CAAC,CAAC,CAACC,KAAK,CAAEC,KAAK,IAAK;QAC9BC,oBAAW,CAACD,KAAK,CAAC,qDAAqDA,KAAK,EAAE,EAAE;UAC9EE,MAAM,EAAEC,mCAAuB;UAC/BC,MAAM,EAAEC,mBAAO,CAACC;QAClB,CAAC,CAAC;QACFT,MAAM,CAACG,KAAK,CAAC;MACf,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ;EAEAO,KAAKA,CAAC9B,eAAwB,EAAE+B,MAAM,GAAG,SAAS,EAAE;IAClD,IAAI,CAAC,IAAI,CAAC7B,cAAc,IAAI,IAAI,CAACF,eAAe,EAAE;MAChD,IAAI,CAACA,eAAe,GAAGA,eAAe;MACtC,IAAI,CAACC,SAAS,CAAC6B,KAAK,CAAC,CAAC;MACtB,IAAI,CAACpB,eAAe,CAACsB,WAAW,CAAC;QAACvB,IAAI,EAAE;MAAW,CAAC,CAAC;MACrDe,oBAAW,CAACS,GAAG,CACb,2FAA2FF,MAAM,EAAE,EACnG;QAACN,MAAM,EAAEC,mCAAuB;QAAEC,MAAM,EAAEC,mBAAO,CAACM;MAAK,CACzD,CAAC;IACH;EACF;EAEAC,oBAAoBA,CAACC,KAA4B,EAAE;IACjD,IAAI,CAAC/B,gBAAgB,GAAG+B,KAAK,CAAC/B,gBAAgB;EAChD;EAEA,MAAcY,QAAQA,CAACF,gBAAkC,EAAE;IACzD,IAAI;MACF,MAAMsB,iBAAoC,GAAG,MAAM,IAAI,CAACtC,KAAK,CAACuC,OAAO,CAAC;QACpEC,OAAO,EAAEC,0BAAe;QACxBC,QAAQ,EAAEC,wBAAa;QACvBf,MAAM,EAAEgB,mBAAY,CAACC,IAAI;QACzB5B,IAAI,EAAED;MACR,CAAC,CAAC;MACF,IAAI,CAACpB,GAAG,GAAG0C,iBAAiB,CAACrB,IAAI,CAAC6B,YAAY;IAChD,CAAC,CAAC,OAAOvD,CAAC,EAAE;MACVkC,oBAAW,CAACD,KAAK,CACf,mFAAmFjC,CAAC,EAAE,EACtF;QAACmC,MAAM,EAAEC,mCAAuB;QAAEC,MAAM,EAAEC,mBAAO,CAACkB;MAAQ,CAC5D,CAAC;IACH;EACF;EAEA,MAAczB,OAAOA,CAAA,EAAG;IACtB,IAAI,CAAC,IAAI,CAAC1B,GAAG,EAAE;MACb,OAAOoD,SAAS;IAClB;IACAvB,oBAAW,CAACS,GAAG,CACb,4EAA4E,IAAI,CAACtC,GAAG,EAAE,EACtF;MAAC8B,MAAM,EAAEC,mCAAuB;MAAEC,MAAM,EAAEC,mBAAO,CAACoB;IAAO,CAC3D,CAAC;IACD,IAAI,CAAC/C,SAAS,GAAG,IAAIgD,SAAS,CAAC,IAAI,CAACtD,GAAG,CAAC;IAExC,OAAO,IAAIuB,OAAO,CAAC,CAACC,OAAO,EAAEC,MAAM,KAAK;MACtC,IAAI,CAACnB,SAAS,CAACiD,MAAM,GAAG,MAAM;QAC5B,IAAI,CAAChD,cAAc,GAAG,KAAK;QAC3B,IAAI,CAACF,eAAe,GAAG,IAAI;QAE3B,IAAI,CAACC,SAAS,CAACkD,IAAI,CAACC,IAAI,CAACC,SAAS,CAAC;UAACC,SAAS,EAAE;QAAM,CAAC,CAAC,CAAC;QACxD,IAAI,CAAC5C,eAAe,CAAC6C,SAAS,GAAIC,cAA2B,IAAK;UAChE,IAAIA,cAAc,EAAEC,IAAI,EAAEhD,IAAI,KAAK,WAAW,EAAE;YAC9C,IAAI,CAACR,SAAS,CAACkD,IAAI,CAACC,IAAI,CAACC,SAAS,CAAC;cAACC,SAAS,EAAE;YAAM,CAAC,CAAC,CAAC;UAC1D;UAEA,IAAIE,cAAc,EAAEC,IAAI,EAAEhD,IAAI,KAAK,aAAa,IAAI,IAAI,CAACJ,gBAAgB,EAAE;YACzE,IAAI,CAACD,4BAA4B,GAAG,IAAI;YACxC,IAAI,CAAC0B,KAAK,CAAC,IAAI,EAAE,6CAA6C,CAAC;YAC/DN,oBAAW,CAACD,KAAK,CACf,sFAAsF,EACtF;cAACE,MAAM,EAAEC,mCAAuB;cAAEC,MAAM,EAAEC,mBAAO,CAACoB;YAAO,CAC3D,CAAC;UACH;QACF,CAAC;QAED,IAAI,CAACtC,eAAe,CAACsB,WAAW,CAAC;UAC/BvB,IAAI,EAAE,OAAO;UACbiD,gBAAgB,EAAEC,qCAAyB;UAAE;UAC7CzD,cAAc,EAAE,IAAI,CAACA,cAAc;UACnC0D,kBAAkB,EAAEC,gCAAoB,CAAE;QAC5C,CAAC,CAAC;MACJ,CAAC;MAED,IAAI,CAAC5D,SAAS,CAAC6D,OAAO,GAAI1B,KAAU,IAAK;QACvCZ,oBAAW,CAACD,KAAK,CACf,kFAAkFa,KAAK,EAAE,EACzF;UAACX,MAAM,EAAEC,mCAAuB;UAAEC,MAAM,EAAEC,mBAAO,CAACoB;QAAO,CAC3D,CAAC;QACD5B,MAAM,CAAC,CAAC;MACV,CAAC;MAED,IAAI,CAACnB,SAAS,CAAC8D,OAAO,GAAG,MAAO3B,KAAU,IAAK;QAC7C,IAAI,CAAC4B,uBAAuB,CAAC5B,KAAK,CAAC;MACrC,CAAC;MAED,IAAI,CAACnC,SAAS,CAACsD,SAAS,GAAIjE,CAAe,IAAK;QAC9C,IAAI,CAAC2E,IAAI,CAAC,SAAS,EAAE3E,CAAC,CAACmE,IAAI,CAAC;QAC5B,MAAMS,SAAS,GAAGd,IAAI,CAACe,KAAK,CAAC7E,CAAC,CAACmE,IAAI,CAAC;QAEpC,IAAIS,SAAS,CAACzD,IAAI,KAAK2D,iBAAS,CAACC,OAAO,EAAE;UACxC,IAAI,CAAClE,iBAAiB,GAAG,IAAI;UAC7B,IAAI,IAAI,CAACP,qBAAqB,EAAE;YAC9B,IAAI,CAACA,qBAAqB,CAACsE,SAAS,CAACT,IAAuB,CAAC;YAC7D,IAAI,CAAC7D,qBAAqB,GAAG,IAAI;UACnC;QACF;QAEA,IAAIsE,SAAS,CAACzD,IAAI,KAAK,mBAAmB,EAAE;UAC1C,IAAI,CAACqB,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC;UAC/BN,oBAAW,CAACD,KAAK,CACf,6FAA6F,EAC7F;YAACE,MAAM,EAAEC,mCAAuB;YAAEC,MAAM,EAAEC,mBAAO,CAACoB;UAAO,CAC3D,CAAC;QACH;MACF,CAAC;IACH,CAAC,CAAC;EACJ;;EAEA;EACA,MAAcgB,uBAAuBA,CAAC5B,KAAU,EAAE;IAChD,IAAI,CAAClC,cAAc,GAAG,IAAI;IAC1B,IAAI,CAACQ,eAAe,CAACsB,WAAW,CAAC;MAACvB,IAAI,EAAE;IAAW,CAAC,CAAC;IACrD,IAAI,IAAI,CAACT,eAAe,EAAE;MACxB,IAAI,CAACiE,IAAI,CAAC,aAAa,CAAC;MACxB,IAAIK,WAAW;MACf,IAAI,IAAI,CAAClE,4BAA4B,EAAE;QACrCkE,WAAW,GAAG,8DAA8D;MAC9E,CAAC,MAAM;QACL,MAAMC,YAAY,GAAGC,SAAS,CAACC,MAAM;QACrCH,WAAW,GAAG,CAACC,YAAY,GACvB,eAAe,GACf,wDAAwD;MAC9D;MACA/C,oBAAW,CAACD,KAAK,CACf,kFAAkF+C,WAAW,EAAE,EAC/F;QAAC7C,MAAM,EAAEC,mCAAuB;QAAEC,MAAM,EAAEC,mBAAO,CAAC8C;MAA2B,CAC/E,CAAC;MACD,IAAI,CAACtE,4BAA4B,GAAG,KAAK;IAC3C;EACF;AACF;AAACuE,OAAA,CAAAlF,gBAAA,GAAAA,gBAAA","ignoreList":[]}
+{"version":3,"names":["_events","_interopRequireDefault","require","_types","_constants","_types2","_loggerProxy","_keepalive","_constants2","_constants3","e","__esModule","default","WebSocketManager","EventEmitter","url","welcomePromiseResolve","constructor","options","webex","shouldReconnect","websocket","isSocketClosed","isWelcomeReceived","forceCloseWebSocketOnTimeout","isConnectionLost","workerScriptBlob","Blob","workerScript","type","keepaliveWorker","Worker","URL","createObjectURL","initWebSocket","connectionConfig","body","register","error","LoggerProxy","module","WEB_SOCKET_MANAGER_FILE","method","METHODS","INIT_WEB_SOCKET","Promise","resolve","reject","connect","catch","close","reason","postMessage","log","CLOSE","handleConnectionLost","event","subscribeResponse","request","service","WCC_API_GATEWAY","resource","SUBSCRIBE_API","HTTP_METHODS","POST","webSocketUrl","REGISTER","undefined","CONNECT","WebSocket","onopen","send","JSON","stringify","keepalive","onmessage","keepAliveEvent","data","intervalDuration","KEEPALIVE_WORKER_INTERVAL","closeSocketTimeout","CLOSE_SOCKET_TIMEOUT","onerror","onclose","webSocketOnCloseHandler","emit","eventData","parse","CC_EVENTS","WELCOME","issueReason","onlineStatus","navigator","onLine","WEB_SOCKET_ON_CLOSE_HANDLER","exports"],"sources":["WebSocketManager.ts"],"sourcesContent":["import EventEmitter from 'events';\nimport {WebexSDK, SubscribeRequest, HTTP_METHODS} from '../../../types';\nimport {SUBSCRIBE_API, WCC_API_GATEWAY} from '../../constants';\nimport {ConnectionLostDetails} from './types';\nimport {CC_EVENTS, SubscribeResponse, WelcomeResponse} from '../../config/types';\nimport LoggerProxy from '../../../logger-proxy';\nimport workerScript from './keepalive.worker';\nimport {KEEPALIVE_WORKER_INTERVAL, CLOSE_SOCKET_TIMEOUT, METHODS} from '../constants';\nimport {WEB_SOCKET_MANAGER_FILE} from '../../../constants';\n\n/**\n * WebSocketManager handles the WebSocket connection for Contact Center operations.\n * It manages the connection lifecycle, including registration, reconnection, and message handling.\n * It also utilizes a Web Worker to manage keepalive messages and socket closure.\n * @ignore\n */\nexport class WebSocketManager extends EventEmitter {\n  private websocket: WebSocket;\n  shouldReconnect: boolean;\n  isSocketClosed: boolean;\n  private isWelcomeReceived: boolean;\n  private url: string | null = null;\n  private forceCloseWebSocketOnTimeout: boolean;\n  private isConnectionLost: boolean;\n  private webex: WebexSDK;\n  private welcomePromiseResolve:\n    | ((value: WelcomeResponse | PromiseLike<WelcomeResponse>) => void)\n    | null = null;\n\n  private keepaliveWorker: Worker;\n\n  constructor(options: {webex: WebexSDK}) {\n    super();\n    const {webex} = options;\n    this.webex = webex;\n    this.shouldReconnect = true;\n    this.websocket = {} as WebSocket;\n    this.isSocketClosed = false;\n    this.isWelcomeReceived = false;\n    this.forceCloseWebSocketOnTimeout = false;\n    this.isConnectionLost = false;\n\n    const workerScriptBlob = new Blob([workerScript], {type: 'application/javascript'});\n    this.keepaliveWorker = new Worker(URL.createObjectURL(workerScriptBlob));\n  }\n\n  async initWebSocket(options: {body: SubscribeRequest}): Promise<WelcomeResponse> {\n    const connectionConfig = options.body;\n    try {\n      await this.register(connectionConfig);\n    } catch (error) {\n      LoggerProxy.error(`[WebSocketStatus] | Error in registering Websocket ${error}`, {\n        module: WEB_SOCKET_MANAGER_FILE,\n        method: METHODS.INIT_WEB_SOCKET,\n      });\n      throw error;\n    }\n\n    return new Promise((resolve, reject) => {\n      this.welcomePromiseResolve = resolve;\n      this.connect().catch((error) => {\n        LoggerProxy.error(`[WebSocketStatus] | Error in connecting Websocket ${error}`, {\n          module: WEB_SOCKET_MANAGER_FILE,\n          method: METHODS.INIT_WEB_SOCKET,\n        });\n        reject(error);\n      });\n    });\n  }\n\n  close(shouldReconnect: boolean, reason = 'Unknown') {\n    if (!this.isSocketClosed && this.shouldReconnect) {\n      this.shouldReconnect = shouldReconnect;\n      this.websocket.close();\n      this.keepaliveWorker.postMessage({type: 'terminate'});\n      LoggerProxy.log(\n        `[WebSocketStatus] | event=webSocketClose | WebSocket connection closed manually REASON: ${reason}`,\n        {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.CLOSE}\n      );\n    }\n  }\n\n  handleConnectionLost(event: ConnectionLostDetails) {\n    this.isConnectionLost = event.isConnectionLost;\n  }\n\n  private async register(connectionConfig: SubscribeRequest) {\n    try {\n      const subscribeResponse: SubscribeResponse = await this.webex.request({\n        service: WCC_API_GATEWAY,\n        resource: SUBSCRIBE_API,\n        method: HTTP_METHODS.POST,\n        body: connectionConfig,\n      });\n      this.url = subscribeResponse.body.webSocketUrl;\n    } catch (e) {\n      LoggerProxy.error(\n        `Register API Failed, Request to RoutingNotifs websocket registration API failed ${e}`,\n        {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.REGISTER}\n      );\n      throw e;\n    }\n  }\n\n  private async connect() {\n    if (!this.url) {\n      return undefined;\n    }\n    LoggerProxy.log(\n      `[WebSocketStatus] | event=webSocketConnecting | Connecting to WebSocket: ${this.url}`,\n      {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.CONNECT}\n    );\n    this.websocket = new WebSocket(this.url);\n\n    return new Promise((resolve, reject) => {\n      this.websocket.onopen = () => {\n        this.isSocketClosed = false;\n        this.shouldReconnect = true;\n\n        this.websocket.send(JSON.stringify({keepalive: 'true'}));\n        this.keepaliveWorker.onmessage = (keepAliveEvent: {data: any}) => {\n          if (keepAliveEvent?.data?.type === 'keepalive') {\n            this.websocket.send(JSON.stringify({keepalive: 'true'}));\n          }\n\n          if (keepAliveEvent?.data?.type === 'closeSocket' && this.isConnectionLost) {\n            this.forceCloseWebSocketOnTimeout = true;\n            this.close(true, 'WebSocket did not auto close within 16 secs');\n            LoggerProxy.error(\n              '[webSocketTimeout] | event=webSocketTimeout | WebSocket connection closed forcefully',\n              {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.CONNECT}\n            );\n          }\n        };\n\n        this.keepaliveWorker.postMessage({\n          type: 'start',\n          intervalDuration: KEEPALIVE_WORKER_INTERVAL, // Keepalive interval\n          isSocketClosed: this.isSocketClosed,\n          closeSocketTimeout: CLOSE_SOCKET_TIMEOUT, // Close socket timeout\n        });\n      };\n\n      this.websocket.onerror = (event: any) => {\n        LoggerProxy.error(\n          `[WebSocketStatus] | event=socketConnectionFailed | WebSocket connection failed ${event}`,\n          {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.CONNECT}\n        );\n        reject();\n      };\n\n      this.websocket.onclose = async (event: any) => {\n        this.webSocketOnCloseHandler(event);\n      };\n\n      this.websocket.onmessage = (e: MessageEvent) => {\n        this.emit('message', e.data);\n        const eventData = JSON.parse(e.data);\n\n        if (eventData.type === CC_EVENTS.WELCOME) {\n          this.isWelcomeReceived = true;\n          if (this.welcomePromiseResolve) {\n            this.welcomePromiseResolve(eventData.data as WelcomeResponse);\n            this.welcomePromiseResolve = null;\n          }\n        }\n\n        if (eventData.type === 'AGENT_MULTI_LOGIN') {\n          this.close(false, 'multiLogin');\n          LoggerProxy.error(\n            '[WebSocketStatus] | event=agentMultiLogin | WebSocket connection closed by agent multiLogin',\n            {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.CONNECT}\n          );\n        }\n      };\n    });\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  private async webSocketOnCloseHandler(event: any) {\n    this.isSocketClosed = true;\n    this.keepaliveWorker.postMessage({type: 'terminate'});\n    if (this.shouldReconnect) {\n      this.emit('socketClose');\n      let issueReason;\n      if (this.forceCloseWebSocketOnTimeout) {\n        issueReason = 'WebSocket auto close timed out. Forcefully closed websocket.';\n      } else {\n        const onlineStatus = navigator.onLine;\n        issueReason = !onlineStatus\n          ? 'network issue'\n          : 'missing keepalive from either desktop or notif service';\n      }\n      LoggerProxy.error(\n        `[WebSocketStatus] | event=webSocketClose | WebSocket connection closed REASON: ${issueReason}`,\n        {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.WEB_SOCKET_ON_CLOSE_HANDLER}\n      );\n      this.forceCloseWebSocketOnTimeout = false;\n    }\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AACA,IAAAE,UAAA,GAAAF,OAAA;AAEA,IAAAG,OAAA,GAAAH,OAAA;AACA,IAAAI,YAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,UAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,WAAA,GAAAN,OAAA;AACA,IAAAO,WAAA,GAAAP,OAAA;AAA2D,SAAAD,uBAAAS,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE3D;AACA;AACA;AACA;AACA;AACA;AACO,MAAMG,gBAAgB,SAASC,eAAY,CAAC;EAKzCC,GAAG,GAAkB,IAAI;EAIzBC,qBAAqB,GAElB,IAAI;EAIfC,WAAWA,CAACC,OAA0B,EAAE;IACtC,KAAK,CAAC,CAAC;IACP,MAAM;MAACC;IAAK,CAAC,GAAGD,OAAO;IACvB,IAAI,CAACC,KAAK,GAAGA,KAAK;IAClB,IAAI,CAACC,eAAe,GAAG,IAAI;IAC3B,IAAI,CAACC,SAAS,GAAG,CAAC,CAAc;IAChC,IAAI,CAACC,cAAc,GAAG,KAAK;IAC3B,IAAI,CAACC,iBAAiB,GAAG,KAAK;IAC9B,IAAI,CAACC,4BAA4B,GAAG,KAAK;IACzC,IAAI,CAACC,gBAAgB,GAAG,KAAK;IAE7B,MAAMC,gBAAgB,GAAG,IAAIC,IAAI,CAAC,CAACC,kBAAY,CAAC,EAAE;MAACC,IAAI,EAAE;IAAwB,CAAC,CAAC;IACnF,IAAI,CAACC,eAAe,GAAG,IAAIC,MAAM,CAACC,GAAG,CAACC,eAAe,CAACP,gBAAgB,CAAC,CAAC;EAC1E;EAEA,MAAMQ,aAAaA,CAAChB,OAAiC,EAA4B;IAC/E,MAAMiB,gBAAgB,GAAGjB,OAAO,CAACkB,IAAI;IACrC,IAAI;MACF,MAAM,IAAI,CAACC,QAAQ,CAACF,gBAAgB,CAAC;IACvC,CAAC,CAAC,OAAOG,KAAK,EAAE;MACdC,oBAAW,CAACD,KAAK,CAAC,sDAAsDA,KAAK,EAAE,EAAE;QAC/EE,MAAM,EAAEC,mCAAuB;QAC/BC,MAAM,EAAEC,mBAAO,CAACC;MAClB,CAAC,CAAC;MACF,MAAMN,KAAK;IACb;IAEA,OAAO,IAAIO,OAAO,CAAC,CAACC,OAAO,EAAEC,MAAM,KAAK;MACtC,IAAI,CAAC/B,qBAAqB,GAAG8B,OAAO;MACpC,IAAI,CAACE,OAAO,CAAC,CAAC,CAACC,KAAK,CAAEX,KAAK,IAAK;QAC9BC,oBAAW,CAACD,KAAK,CAAC,qDAAqDA,KAAK,EAAE,EAAE;UAC9EE,MAAM,EAAEC,mCAAuB;UAC/BC,MAAM,EAAEC,mBAAO,CAACC;QAClB,CAAC,CAAC;QACFG,MAAM,CAACT,KAAK,CAAC;MACf,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ;EAEAY,KAAKA,CAAC9B,eAAwB,EAAE+B,MAAM,GAAG,SAAS,EAAE;IAClD,IAAI,CAAC,IAAI,CAAC7B,cAAc,IAAI,IAAI,CAACF,eAAe,EAAE;MAChD,IAAI,CAACA,eAAe,GAAGA,eAAe;MACtC,IAAI,CAACC,SAAS,CAAC6B,KAAK,CAAC,CAAC;MACtB,IAAI,CAACpB,eAAe,CAACsB,WAAW,CAAC;QAACvB,IAAI,EAAE;MAAW,CAAC,CAAC;MACrDU,oBAAW,CAACc,GAAG,CACb,2FAA2FF,MAAM,EAAE,EACnG;QAACX,MAAM,EAAEC,mCAAuB;QAAEC,MAAM,EAAEC,mBAAO,CAACW;MAAK,CACzD,CAAC;IACH;EACF;EAEAC,oBAAoBA,CAACC,KAA4B,EAAE;IACjD,IAAI,CAAC/B,gBAAgB,GAAG+B,KAAK,CAAC/B,gBAAgB;EAChD;EAEA,MAAcY,QAAQA,CAACF,gBAAkC,EAAE;IACzD,IAAI;MACF,MAAMsB,iBAAoC,GAAG,MAAM,IAAI,CAACtC,KAAK,CAACuC,OAAO,CAAC;QACpEC,OAAO,EAAEC,0BAAe;QACxBC,QAAQ,EAAEC,wBAAa;QACvBpB,MAAM,EAAEqB,mBAAY,CAACC,IAAI;QACzB5B,IAAI,EAAED;MACR,CAAC,CAAC;MACF,IAAI,CAACpB,GAAG,GAAG0C,iBAAiB,CAACrB,IAAI,CAAC6B,YAAY;IAChD,CAAC,CAAC,OAAOvD,CAAC,EAAE;MACV6B,oBAAW,CAACD,KAAK,CACf,mFAAmF5B,CAAC,EAAE,EACtF;QAAC8B,MAAM,EAAEC,mCAAuB;QAAEC,MAAM,EAAEC,mBAAO,CAACuB;MAAQ,CAC5D,CAAC;MACD,MAAMxD,CAAC;IACT;EACF;EAEA,MAAcsC,OAAOA,CAAA,EAAG;IACtB,IAAI,CAAC,IAAI,CAACjC,GAAG,EAAE;MACb,OAAOoD,SAAS;IAClB;IACA5B,oBAAW,CAACc,GAAG,CACb,4EAA4E,IAAI,CAACtC,GAAG,EAAE,EACtF;MAACyB,MAAM,EAAEC,mCAAuB;MAAEC,MAAM,EAAEC,mBAAO,CAACyB;IAAO,CAC3D,CAAC;IACD,IAAI,CAAC/C,SAAS,GAAG,IAAIgD,SAAS,CAAC,IAAI,CAACtD,GAAG,CAAC;IAExC,OAAO,IAAI8B,OAAO,CAAC,CAACC,OAAO,EAAEC,MAAM,KAAK;MACtC,IAAI,CAAC1B,SAAS,CAACiD,MAAM,GAAG,MAAM;QAC5B,IAAI,CAAChD,cAAc,GAAG,KAAK;QAC3B,IAAI,CAACF,eAAe,GAAG,IAAI;QAE3B,IAAI,CAACC,SAAS,CAACkD,IAAI,CAACC,IAAI,CAACC,SAAS,CAAC;UAACC,SAAS,EAAE;QAAM,CAAC,CAAC,CAAC;QACxD,IAAI,CAAC5C,eAAe,CAAC6C,SAAS,GAAIC,cAA2B,IAAK;UAChE,IAAIA,cAAc,EAAEC,IAAI,EAAEhD,IAAI,KAAK,WAAW,EAAE;YAC9C,IAAI,CAACR,SAAS,CAACkD,IAAI,CAACC,IAAI,CAACC,SAAS,CAAC;cAACC,SAAS,EAAE;YAAM,CAAC,CAAC,CAAC;UAC1D;UAEA,IAAIE,cAAc,EAAEC,IAAI,EAAEhD,IAAI,KAAK,aAAa,IAAI,IAAI,CAACJ,gBAAgB,EAAE;YACzE,IAAI,CAACD,4BAA4B,GAAG,IAAI;YACxC,IAAI,CAAC0B,KAAK,CAAC,IAAI,EAAE,6CAA6C,CAAC;YAC/DX,oBAAW,CAACD,KAAK,CACf,sFAAsF,EACtF;cAACE,MAAM,EAAEC,mCAAuB;cAAEC,MAAM,EAAEC,mBAAO,CAACyB;YAAO,CAC3D,CAAC;UACH;QACF,CAAC;QAED,IAAI,CAACtC,eAAe,CAACsB,WAAW,CAAC;UAC/BvB,IAAI,EAAE,OAAO;UACbiD,gBAAgB,EAAEC,qCAAyB;UAAE;UAC7CzD,cAAc,EAAE,IAAI,CAACA,cAAc;UACnC0D,kBAAkB,EAAEC,gCAAoB,CAAE;QAC5C,CAAC,CAAC;MACJ,CAAC;MAED,IAAI,CAAC5D,SAAS,CAAC6D,OAAO,GAAI1B,KAAU,IAAK;QACvCjB,oBAAW,CAACD,KAAK,CACf,kFAAkFkB,KAAK,EAAE,EACzF;UAAChB,MAAM,EAAEC,mCAAuB;UAAEC,MAAM,EAAEC,mBAAO,CAACyB;QAAO,CAC3D,CAAC;QACDrB,MAAM,CAAC,CAAC;MACV,CAAC;MAED,IAAI,CAAC1B,SAAS,CAAC8D,OAAO,GAAG,MAAO3B,KAAU,IAAK;QAC7C,IAAI,CAAC4B,uBAAuB,CAAC5B,KAAK,CAAC;MACrC,CAAC;MAED,IAAI,CAACnC,SAAS,CAACsD,SAAS,GAAIjE,CAAe,IAAK;QAC9C,IAAI,CAAC2E,IAAI,CAAC,SAAS,EAAE3E,CAAC,CAACmE,IAAI,CAAC;QAC5B,MAAMS,SAAS,GAAGd,IAAI,CAACe,KAAK,CAAC7E,CAAC,CAACmE,IAAI,CAAC;QAEpC,IAAIS,SAAS,CAACzD,IAAI,KAAK2D,iBAAS,CAACC,OAAO,EAAE;UACxC,IAAI,CAAClE,iBAAiB,GAAG,IAAI;UAC7B,IAAI,IAAI,CAACP,qBAAqB,EAAE;YAC9B,IAAI,CAACA,qBAAqB,CAACsE,SAAS,CAACT,IAAuB,CAAC;YAC7D,IAAI,CAAC7D,qBAAqB,GAAG,IAAI;UACnC;QACF;QAEA,IAAIsE,SAAS,CAACzD,IAAI,KAAK,mBAAmB,EAAE;UAC1C,IAAI,CAACqB,KAAK,CAAC,KAAK,EAAE,YAAY,CAAC;UAC/BX,oBAAW,CAACD,KAAK,CACf,6FAA6F,EAC7F;YAACE,MAAM,EAAEC,mCAAuB;YAAEC,MAAM,EAAEC,mBAAO,CAACyB;UAAO,CAC3D,CAAC;QACH;MACF,CAAC;IACH,CAAC,CAAC;EACJ;;EAEA;EACA,MAAcgB,uBAAuBA,CAAC5B,KAAU,EAAE;IAChD,IAAI,CAAClC,cAAc,GAAG,IAAI;IAC1B,IAAI,CAACQ,eAAe,CAACsB,WAAW,CAAC;MAACvB,IAAI,EAAE;IAAW,CAAC,CAAC;IACrD,IAAI,IAAI,CAACT,eAAe,EAAE;MACxB,IAAI,CAACiE,IAAI,CAAC,aAAa,CAAC;MACxB,IAAIK,WAAW;MACf,IAAI,IAAI,CAAClE,4BAA4B,EAAE;QACrCkE,WAAW,GAAG,8DAA8D;MAC9E,CAAC,MAAM;QACL,MAAMC,YAAY,GAAGC,SAAS,CAACC,MAAM;QACrCH,WAAW,GAAG,CAACC,YAAY,GACvB,eAAe,GACf,wDAAwD;MAC9D;MACApD,oBAAW,CAACD,KAAK,CACf,kFAAkFoD,WAAW,EAAE,EAC/F;QAAClD,MAAM,EAAEC,mCAAuB;QAAEC,MAAM,EAAEC,mBAAO,CAACmD;MAA2B,CAC/E,CAAC;MACD,IAAI,CAACtE,4BAA4B,GAAG,KAAK;IAC3C;EACF;AACF;AAACuE,OAAA,CAAAlF,gBAAA,GAAAA,gBAAA","ignoreList":[]}

package/dist/webex.js

@@ -29,7 +29,7 @@ if (!global.Buffer) {
  */
 const Webex = _webexCore.default.extend({
   webex: true,
-  version: `3.10.0-next.32`
+  version: `3.10.0-next.34`
 });
 
 /**

package/package.json

@@ -45,13 +45,13 @@
   },
   "dependencies": {
     "@types/platform": "1.3.4",
-    "@webex/calling": "3.10.0-next.25",
-    "@webex/internal-plugin-mercury": "3.10.0-next.12",
-    "@webex/internal-plugin-metrics": "3.10.0-next.12",
-    "@webex/internal-plugin-support": "3.10.0-next.12",
-    "@webex/plugin-authorization": "3.10.0-next.12",
-    "@webex/plugin-logger": "3.10.0-next.12",
-    "@webex/webex-core": "3.10.0-next.12",
+    "@webex/calling": "3.10.0-next.26",
+    "@webex/internal-plugin-mercury": "3.10.0-next.13",
+    "@webex/internal-plugin-metrics": "3.10.0-next.13",
+    "@webex/internal-plugin-support": "3.10.0-next.13",
+    "@webex/plugin-authorization": "3.10.0-next.13",
+    "@webex/plugin-logger": "3.10.0-next.13",
+    "@webex/webex-core": "3.10.0-next.13",
     "jest-html-reporters": "3.0.11",
     "lodash": "^4.17.21"
   },
@@ -80,5 +80,5 @@
     "typedoc": "^0.25.0",
     "typescript": "4.9.5"
   },
-  "version": "3.10.0-next.32"
+  "version": "3.10.0-next.34"
 }

package/src/services/core/websocket/WebSocketManager.ts

@@ -46,7 +46,15 @@ export class WebSocketManager extends EventEmitter {
 
   async initWebSocket(options: {body: SubscribeRequest}): Promise<WelcomeResponse> {
     const connectionConfig = options.body;
-    await this.register(connectionConfig);
+    try {
+      await this.register(connectionConfig);
+    } catch (error) {
+      LoggerProxy.error(`[WebSocketStatus] | Error in registering Websocket ${error}`, {
+        module: WEB_SOCKET_MANAGER_FILE,
+        method: METHODS.INIT_WEB_SOCKET,
+      });
+      throw error;
+    }
 
     return new Promise((resolve, reject) => {
       this.welcomePromiseResolve = resolve;
@@ -90,6 +98,7 @@ export class WebSocketManager extends EventEmitter {
         `Register API Failed, Request to RoutingNotifs websocket registration API failed ${e}`,
         {module: WEB_SOCKET_MANAGER_FILE, method: METHODS.REGISTER}
       );
+      throw e;
     }
   }
 

package/test/unit/spec/services/core/websocket/WebSocketManager.ts

@@ -126,6 +126,26 @@ describe('WebSocketManager', () => {
     });
   });
 
+  it('should log error and throw when register API fails in initWebSocket', async () => {
+    const error = new Error('Register API failed');
+
+    (mockWebex.request as jest.Mock).mockRejectedValueOnce(error);
+
+    await expect(
+      webSocketManager.initWebSocket({ body: fakeSubscribeRequest })
+    ).rejects.toThrow(error);
+
+    expect(LoggerProxy.error).toHaveBeenCalledWith(
+      `Register API Failed, Request to RoutingNotifs websocket registration API failed ${error}`,
+      { module: WEB_SOCKET_MANAGER_FILE, method: 'register' }
+    );
+
+    expect(LoggerProxy.error).toHaveBeenCalledWith(
+      `[WebSocketStatus] | Error in registering Websocket ${error}`,
+      { module: WEB_SOCKET_MANAGER_FILE, method: 'initWebSocket' }
+    );
+  });
+
   it('should close WebSocket connection', async () => {
     const subscribeResponse = {
       body: {