feat(cc-sdk): added-health-check-and-keep-alives #2
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| class Worker { | ||
| constructor(stringUrl) { | ||
| this.url = stringUrl; | ||
| this.onmessage = () => {}; | ||
| } | ||
|
|
||
| postMessage(msg) { | ||
| this.onmessage(msg); | ||
| } | ||
|
|
||
| terminate() {} | ||
| } | ||
|
|
||
| global.Worker = Worker; | ||
| global.URL.createObjectURL = jest.fn(() => 'blob:http://localhost:3000/12345'); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| import {WebexSDK, SubscribeRequest, HTTP_METHODS, WelcomeResponse} from '../../../types'; | ||
| import {SUBSCRIBE_API, WCC_API_GATEWAY} from '../../constants'; | ||
| import {SubscribeResponse} from '../../config/types'; | ||
| import LoggerProxy from '../../../logger-proxy'; | ||
| import workerScript from './keepalive.worker'; | ||
|
There was a problem hiding this comment. Note - |
||
| import {KEEPALIVE_WORKER_INTERVAL, CLOSE_SOCKET_TIMEOUT} from '../constants'; | ||
|
|
||
| export class WebSocketManager extends EventTarget { | ||
| private websocket: WebSocket; | ||
| shouldReconnect: boolean; | ||
| isSocketClosed: boolean; | ||
| private isWelcomeReceived: boolean; | ||
| private url: string | null = null; | ||
| private forceCloseWebSocketOnTimeout: boolean; | ||
| private isConnectionLost: boolean; | ||
| private webex: WebexSDK; | ||
| private welcomePromiseResolve: | ||
|
There was a problem hiding this comment. This was a needed change so that when we call the initWebSocket from the cc.ts, we are able to return a promise to resolve the initial registration. This differs from agentx which was calling it from the aqm-reqs and hence it could be handled via signals, however since we call it from cc.ts, I had to add this here for that. |
||
| | ((value: WelcomeResponse | PromiseLike<WelcomeResponse>) => void) | ||
| | null = null; | ||
|
|
||
| private keepaliveWorker: Worker; | ||
|
|
||
| constructor(options: {webex: WebexSDK}) { | ||
| super(); | ||
| const {webex} = options; | ||
| this.webex = webex; | ||
| this.shouldReconnect = true; | ||
| this.websocket = {} as WebSocket; | ||
| this.isSocketClosed = false; | ||
| this.isWelcomeReceived = false; | ||
| this.forceCloseWebSocketOnTimeout = false; | ||
| this.isConnectionLost = false; | ||
|
|
||
| const workerScriptBlob = new Blob([workerScript], {type: 'application/javascript'}); | ||
| this.keepaliveWorker = new Worker(URL.createObjectURL(workerScriptBlob)); | ||
| } | ||
|
|
||
| async initWebSocket(options: {body: SubscribeRequest}): Promise<WelcomeResponse> { | ||
| const connectionConfig = options.body; | ||
| await this.register(connectionConfig); | ||
|
|
||
| return new Promise((resolve, reject) => { | ||
|
There was a problem hiding this comment. Again as mentioned, this promise is for the registration flow, if the connect fails, we simply reject the promise, it works for both cases. |
||
| this.welcomePromiseResolve = resolve; | ||
| this.connect().catch((error) => { | ||
| LoggerProxy.logger.error(`[WebSocketStatus] | Error in connecting Websocket ${error}`); | ||
| reject(error); | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| close(shouldReconnect: boolean, reason = 'Unknown') { | ||
| if (!this.isSocketClosed && this.shouldReconnect) { | ||
| this.shouldReconnect = shouldReconnect; | ||
| this.websocket.close(); | ||
| this.keepaliveWorker.postMessage({type: 'terminate'}); | ||
| LoggerProxy.logger.error( | ||
| `[WebSocketStatus] | event=webSocketClose | WebSocket connection closed manually REASON: ${reason}` | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| private async register(connectionConfig: SubscribeRequest) { | ||
| try { | ||
| const subscribeResponse: SubscribeResponse = await this.webex.request({ | ||
| service: WCC_API_GATEWAY, | ||
| resource: SUBSCRIBE_API, | ||
| method: HTTP_METHODS.POST, | ||
| body: connectionConfig, | ||
| }); | ||
| this.url = subscribeResponse.body.webSocketUrl; | ||
| } catch (e) { | ||
| LoggerProxy.logger.error( | ||
| `Register API Failed, Request to RoutingNotifs websocket registration API failed ${e}` | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| private async connect() { | ||
| if (!this.url) { | ||
| return undefined; | ||
| } | ||
| LoggerProxy.logger.log( | ||
| `[WebSocketStatus] | event=webSocketConnecting | Connecting to WebSocket: ${this.url}` | ||
| ); | ||
| this.websocket = new WebSocket(this.url); | ||
|
|
||
| return new Promise((resolve, reject) => { | ||
| this.websocket.onopen = () => { | ||
| this.isSocketClosed = false; | ||
| this.shouldReconnect = true; | ||
|
|
||
| this.websocket.send(JSON.stringify({keepalive: 'true'})); | ||
| this.keepaliveWorker.onmessage = (keepAliveEvent: {data: any}) => { | ||
| if (keepAliveEvent?.data?.type === 'keepalive') { | ||
| this.websocket.send(JSON.stringify({keepalive: 'true'})); | ||
| } | ||
|
|
||
| if (keepAliveEvent?.data?.type === 'closeSocket' && this.isConnectionLost) { | ||
| this.forceCloseWebSocketOnTimeout = true; | ||
| this.close(true, 'WebSocket did not auto close within 16 secs'); | ||
| LoggerProxy.logger.error( | ||
| '[webSocketTimeout] | event=webSocketTimeout | WebSocket connection closed forcefully' | ||
| ); | ||
| } | ||
| }; | ||
|
|
||
| this.keepaliveWorker.postMessage({ | ||
| type: 'start', | ||
| intervalDuration: KEEPALIVE_WORKER_INTERVAL, // Keepalive interval | ||
| isSocketClosed: this.isSocketClosed, | ||
| closeSocketTimeout: CLOSE_SOCKET_TIMEOUT, // Close socket timeout | ||
| }); | ||
| }; | ||
|
|
||
| this.websocket.onerror = (event: any) => { | ||
| LoggerProxy.logger.error( | ||
| `[WebSocketStatus] | event=socketConnectionFailed | WebSocket connection failed ${event}` | ||
| ); | ||
| reject(); | ||
| }; | ||
|
|
||
| this.websocket.onclose = async (event: any) => { | ||
| this.webSocketOnCloseHandler(event); | ||
| }; | ||
|
|
||
| this.websocket.onmessage = (e: MessageEvent) => { | ||
| this.dispatchEvent(new CustomEvent('message', {detail: e.data})); | ||
|
There was a problem hiding this comment. As per discussion with Ravi, I have switched over to using events here as opposed to singals. I felt this was a more straight-forward solution. Now, I am not using custom event handlers here as it was working with events, however I would like someone to point out any edge cases or issues that might arise (most things are working including reconnect logic). |
||
| const eventData = JSON.parse(e.data); | ||
|
|
||
| if (eventData.type === 'Welcome') { | ||
| this.isWelcomeReceived = true; | ||
| if (this.welcomePromiseResolve) { | ||
| this.welcomePromiseResolve(eventData.data as WelcomeResponse); | ||
| this.welcomePromiseResolve = null; | ||
| } | ||
| } | ||
|
|
||
| if (eventData.type === 'AGENT_MULTI_LOGIN') { | ||
|
There was a problem hiding this comment. Again, all have been taken from agent desktop, so if we do not require this, we can remove them. There was a problem hiding this comment. It is okay to keep this as this whole copy-paste effort is keeping the WxCC Desktop use cases in mind |
||
| this.close(false, 'multiLogin'); | ||
| LoggerProxy.logger.error( | ||
| '[WebSocketStatus] | event=agentMultiLogin | WebSocket connection closed by agent multiLogin' | ||
| ); | ||
| } | ||
| }; | ||
| }); | ||
| } | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
| private async webSocketOnCloseHandler(event: any) { | ||
| this.isSocketClosed = true; | ||
| this.keepaliveWorker.postMessage({type: 'terminate'}); | ||
| if (this.shouldReconnect) { | ||
| this.dispatchEvent(new Event('socketClose')); | ||
| let issueReason; | ||
| if (this.forceCloseWebSocketOnTimeout) { | ||
| issueReason = 'WebSocket auto close timed out. Forcefully closed websocket.'; | ||
| } else { | ||
| const onlineStatus = navigator.onLine; | ||
| LoggerProxy.logger.info(`[WebSocketStatus] | desktop online status is ${onlineStatus}`); | ||
| issueReason = !onlineStatus | ||
| ? 'network issue' | ||
| : 'missing keepalive from either desktop or notif service'; | ||
| } | ||
| LoggerProxy.logger.error( | ||
| `[WebSocketStatus] | event=webSocketClose | WebSocket connection closed REASON: ${issueReason}` | ||
| ); | ||
| this.forceCloseWebSocketOnTimeout = false; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Created this so that we can mock the worker thread in tests. Kept it ouside so it can be reused.