@wazo/sdk 0.38.22 → 0.39.0-beta.1

package/src/{websocket-client.js → websocket-client.ts}

@@ -1,7 +1,5 @@
-// @flow
 /* eslint-disable no-underscore-dangle */
 import ReconnectingWebSocket from 'reconnecting-websocket';
-
 import Emitter from './utils/Emitter';
 import type { WebSocketMessage } from './types/WebSocketMessage';
 import IssueReporter from './service/IssueReporter';
@@ -15,19 +13,17 @@ export const SOCKET_EVENTS = {
   INITIALIZED: 'initialized',
   ON_AUTH_FAILED: 'on_auth_failed',
 };
-
 type Arguments = {
-  host: string,
-  token: string,
-  events: Array<string>,
-  version?: number,
+  host: string;
+  token: string;
+  events?: Array<string>;
+  version?: number;
   heartbeat?: {
-    delay: number,
-    timeout: number,
-    max: number,
-  },
+    delay: number;
+    timeout: number;
+    max: number;
+  };
 };
-
 export const AUTH_SESSION_EXPIRE_SOON = 'auth_session_expire_soon';
 export const FAVORITE_ADDED = 'favorite_added';
 export const FAVORITE_DELETED = 'favorite_deleted';
@@ -95,30 +91,34 @@ export const CONFERENCE_ADHOC_PARTICIPANT_LEFT = 'conference_adhoc_participant_l
 export const CONFERENCE_ADHOC_DELETED = 'conference_adhoc_deleted';
 export const MEETING_USER_PROGRESS = 'meeting_user_progress';
 export const MEETING_USER_GUEST_AUTHORIZATION_CREATED = 'meeting_user_guest_authorization_created';
-
-const BLACKLIST_EVENTS = [
-  CHAT_MESSAGE_SENT,
-  CHAT_MESSAGE_RECEIVED,
-  CHATD_USER_ROOM_MESSAGE_CREATED,
-  CHATD_USER_ROOM_CREATED,
-];
-
+const BLACKLIST_EVENTS = [CHAT_MESSAGE_SENT, CHAT_MESSAGE_RECEIVED, CHATD_USER_ROOM_MESSAGE_CREATED, CHATD_USER_ROOM_CREATED];
 export const HEARTBEAT_ENGINE_VERSION = '20.09';
 const logger = IssueReporter.loggerFor('wazo-ws');
 const messageLogger = IssueReporter.loggerFor('wazo-ws-message');
 
 class WebSocketClient extends Emitter {
   initialized: boolean;
-  host: ?string;
-  version: number;
-  token: ?string;
-  events: Array<string>;
-  options: Object;
-  socket: ?ReconnectingWebSocket;
-  _boundOnHeartbeat: Function;
+
+  host: string | null | undefined;
+
+  version: number | undefined;
+
+  token: string | null | undefined;
+
+  events: Array<string> | undefined;
+
+  options: Record<string, any>;
+
+  socket: ReconnectingWebSocket | null | undefined;
+
+  _boundOnHeartbeat: (...args: Array<any>) => any;
+
   heartbeat: Heartbeat;
-  onHeartBeatTimeout: Function;
-  heartbeatCb: Function;
+
+  onHeartBeatTimeout: (...args: Array<any>) => any;
+
+  heartbeatCb: (...args: Array<any>) => any;
+
   eventLists: string[];
 
   static eventLists: Array<string>;
@@ -132,35 +132,55 @@ class WebSocketClient extends Emitter {
    * @param heartbeat
    * @param options @see https://github.com/pladaria/reconnecting-websocket#available-options
    */
-  constructor({ host, token, version = 1, events = [], heartbeat = {} }: Arguments, options: Object = {}) {
+  constructor({
+    host,
+    token,
+    version,
+    events,
+    heartbeat,
+  }: Arguments, options: Record<string, any> = {
+    host,
+    token,
+    version: 1,
+    events: [],
+    heartbeat: {},
+  }) {
     super();
     this.initialized = false;
-
     this.socket = null;
     this.host = host;
     this.token = token;
     this.events = events;
     this.options = options;
     this.version = version;
-
     this._boundOnHeartbeat = this._onHeartbeat.bind(this);
-    const { delay, timeout, max } = heartbeat;
+    const {
+      delay,
+      timeout,
+      max,
+    }: any = heartbeat || {};
     this.heartbeat = new Heartbeat(delay, timeout, max);
     this.heartbeat.setSendHeartbeat(this.pingServer.bind(this));
     this.heartbeat.setOnHeartbeatTimeout(this._onHeartbeatTimeout.bind(this));
-
     this.eventLists = WebSocketClient.eventLists;
   }
 
   connect() {
-    logger.info('connect method started', { host: this.host, token: this.token });
+    logger.info('connect method started', {
+      host: this.host,
+      token: this.token,
+    });
     this.socket = new ReconnectingWebSocket(this._getUrl.bind(this), [], this.options);
+
     if (this.options.binaryType) {
       this.socket.binaryType = this.options.binaryType;
     }
 
     this.socket.onopen = () => {
-      logger.info('on Wazo WS open', { method: 'connect', host: this.host });
+      logger.info('on Wazo WS open', {
+        method: 'connect',
+        host: this.host,
+      });
       this.eventEmitter.emit(SOCKET_EVENTS.ON_OPEN);
     };
 
@@ -171,23 +191,28 @@ class WebSocketClient extends Emitter {
 
     this.socket.onmessage = (event: MessageEvent) => {
       this.eventEmitter.emit(SOCKET_EVENTS.ON_MESSAGE, event.data);
-
       const message = JSON.parse(typeof event.data === 'string' ? event.data : '{}');
-      let { name } = message;
+      let {
+        name,
+      } = message;
+
       if (message.data && message.data.name) {
         // eslint-disable-next-line
         name = message.data.name;
       }
 
       if (BLACKLIST_EVENTS.indexOf(name) === -1) {
-        // $FlowFixMe
-        messageLogger.trace(IssueReporter.removeSlashes(event.data), { method: 'onmessage' });
+        messageLogger.trace(IssueReporter.removeSlashes(event.data), {
+          method: 'onmessage',
+        });
       } else {
-        messageLogger.trace(`{"name": "${name}", "info": "content not shown"}`, { method: 'onmessage' });
+        messageLogger.trace(`{"name": "${name}", "info": "content not shown"}`, {
+          method: 'onmessage',
+        });
       }
 
       if (!this.initialized) {
-        this._handleInitMessage(message, this.socket);
+        this._handleInitMessage(message, this.socket as ReconnectingWebSocket);
       } else {
         this._handleMessage(message);
       }
@@ -209,19 +234,30 @@ class WebSocketClient extends Emitter {
         case 4002:
           this.eventEmitter.emit(SOCKET_EVENTS.ON_AUTH_FAILED);
           break;
+
         case 4003:
           break;
+
         default:
       }
     };
 
     this.socket.onerror = event => {
-      logger.info('Wazo WS error', { message: event.message, code: event.code, readyState: event.target.readyState });
+      logger.info('Wazo WS error', {
+        message: event.message,
+        // @ts-ignore
+        code: event.code,
+        readyState: event.target.readyState,
+      });
     };
   }
 
-  close(force: boolean = false): void {
-    logger.info('Wazo WS close', { socket: !!this.socket, host: this.host, token: this.token });
+  close(force = false): void {
+    logger.info('Wazo WS close', {
+      socket: !!this.socket,
+      host: this.host,
+      token: this.token,
+    });
 
     if (!this.socket) {
       return;
@@ -239,13 +275,21 @@ class WebSocketClient extends Emitter {
 
   updateToken(token: string) {
     this.token = token;
-    logger.info('Wazo WS updating token', { url: this._getUrl(), token, socket: !!this.socket });
+    logger.info('Wazo WS updating token', {
+      url: this._getUrl(),
+      token,
+      socket: !!this.socket,
+    });
 
     if (this.socket) {
       // If still connected, send the token to the WS
-      if (this.isConnected() && this.version >= 2) {
-        // $FlowFixMe
-        this.socket.send(JSON.stringify({ op: 'token', data: { token } }));
+      if (this.isConnected() && Number(this.version) >= 2) {
+        this.socket.send(JSON.stringify({
+          op: 'token',
+          data: {
+            token,
+          },
+        }));
       } else if (!this.isConnected()) {
         this.reconnect('token refreshed');
       }
@@ -257,7 +301,10 @@ class WebSocketClient extends Emitter {
   }
 
   startHeartbeat() {
-    logger.info('Wazo WS start heartbeat', { host: this.host, token: this.token });
+    logger.info('Wazo WS start heartbeat', {
+      host: this.host,
+      token: this.token,
+    });
 
     if (!this.socket) {
       this.heartbeat.stop();
@@ -266,21 +313,22 @@ class WebSocketClient extends Emitter {
 
     this.off('pong', this._boundOnHeartbeat);
     this.on('pong', this._boundOnHeartbeat);
-
     this.heartbeat.start();
   }
 
   stopHeartbeat() {
-    logger.info('Wazo WS stop heartbeat', { host: this.host, token: this.token });
-
+    logger.info('Wazo WS stop heartbeat', {
+      host: this.host,
+      token: this.token,
+    });
     this.heartbeat.stop();
   }
 
-  setOnHeartbeatTimeout(cb: Function) {
+  setOnHeartbeatTimeout(cb: (...args: Array<any>) => any) {
     this.onHeartBeatTimeout = cb;
   }
 
-  setOnHeartbeatCallback(cb: Function) {
+  setOnHeartbeatCallback(cb: (...args: Array<any>) => any) {
     this.heartbeatCb = cb;
   }
 
@@ -290,9 +338,13 @@ class WebSocketClient extends Emitter {
     }
 
     try {
-      this.socket.send(JSON.stringify({ op: 'ping', data: { payload: 'pong' } }));
-    } catch (_) {
-      // Nothing to do
+      this.socket.send(JSON.stringify({
+        op: 'ping',
+        data: {
+          payload: 'pong',
+        },
+      }));
+    } catch (_) { // Nothing to do
     }
   }
 
@@ -301,44 +353,59 @@ class WebSocketClient extends Emitter {
   }
 
   reconnect(reason: string) {
-    logger.info('Wazo WS reconnect', { reason, socket: !!this.socket, host: this.host, token: this.token });
+    logger.info('Wazo WS reconnect', {
+      reason,
+      socket: !!this.socket,
+      host: this.host,
+      token: this.token,
+    });
+
     if (!this.socket) {
       return;
     }
-    this.socket.reconnect(reason);
+
+    // @HEADS UP: first arg is `code`, second is `reason`; inputing arbitrary value for `code`
+    this.socket.reconnect(0, reason);
   }
 
   _handleInitMessage(message: WebSocketMessage, sock: ReconnectingWebSocket) {
     switch (message.op) {
       case 'init':
-        this.events.forEach(event => {
+        this.events?.forEach(event => {
           const op = {
             op: 'subscribe',
-            data: { event_name: event },
+            data: {
+              event_name: event,
+            },
           };
-
           sock.send(JSON.stringify(op));
         });
-
-        sock.send(JSON.stringify({ op: 'start' }));
+        sock.send(JSON.stringify({
+          op: 'start',
+        }));
         break;
+
       case 'subscribe':
         break;
+
       case 'start':
         this.initialized = true;
         this.eventEmitter.emit(SOCKET_EVENTS.INITIALIZED);
         break;
+
       default:
         this.eventEmitter.emit('message', message);
     }
   }
 
-  _handleMessage(message: Object) {
+  _handleMessage(message: Record<string, any>) {
     if (message.op === 'pong') {
       this.eventEmitter.emit('pong', message.data);
+
       if (this.heartbeatCb) {
         this.heartbeatCb();
       }
+
       return;
     }
 
@@ -347,7 +414,7 @@ class WebSocketClient extends Emitter {
       return;
     }
 
-    if (this.version >= 2 && message.op === 'event') {
+    if (Number(this.version) >= 2 && message.op === 'event') {
       this.eventEmitter.emit(message.data.name, message.data);
     }
   }
@@ -356,13 +423,15 @@ class WebSocketClient extends Emitter {
     if (!this.host || !this.token) {
       this.close();
     }
-    const url = `wss://${this.host || ''}/api/websocketd/?token=${this.token || ''}&version=${this.version}`;
-    logger.info('Wazo WS url computed to reconnect', { url });
 
+    const url = `wss://${this.host || ''}/api/websocketd/?token=${this.token || ''}&version=${this.version}`;
+    logger.info('Wazo WS url computed to reconnect', {
+      url,
+    });
     return url;
   }
 
-  _onHeartbeat(message: Object) {
+  _onHeartbeat(message: Record<string, any>) {
     if (message.payload === 'pong') {
       this.heartbeat.onHeartbeat();
       logger.log('on heartbeat received from Wazo WS');
@@ -370,8 +439,10 @@ class WebSocketClient extends Emitter {
   }
 
   async _onHeartbeatTimeout() {
-    logger.log('heartbeat timed out', { host: this.host, token: this.token });
-
+    logger.log('heartbeat timed out', {
+      host: this.host,
+      token: this.token,
+    });
     this.close();
     this.eventEmitter.emit(SOCKET_EVENTS.ON_CLOSE, new Error('Websocket ping failure.'));
 
@@ -379,77 +450,8 @@ class WebSocketClient extends Emitter {
       this.onHeartBeatTimeout();
     }
   }
-}
-
-// Can't use static
-WebSocketClient.eventLists = [
-  AUTH_SESSION_EXPIRE_SOON,
-  FAVORITE_ADDED,
-  FAVORITE_DELETED,
-  USER_STATUS_UPDATE,
-  CHAT_MESSAGE_SENT,
-  CHAT_MESSAGE_RECEIVED,
-  ENDPOINT_STATUS_UPDATE,
-  USERS_FORWARDS_BUSY_UPDATED,
-  USERS_FORWARDS_NOANSWER_UPDATED,
-  USERS_FORWARDS_UNCONDITIONAL_UPDATED,
-  USERS_SERVICES_DND_UPDATED,
-  USER_VOICEMAIL_MESSAGE_CREATED,
-  USER_VOICEMAIL_MESSAGE_UPDATED,
-  USER_VOICEMAIL_MESSAGE_DELETED,
-  CALL_LOG_USER_CREATED,
-  CALL_ANSWERED,
-  CALL_CREATED,
-  CALL_DTMF_CREATED,
-  CALL_ENDED,
-  CALL_UPDATED,
-  CALL_HELD,
-  CALL_RESUMED,
-  AUTH_USER_EXTERNAL_AUTH_ADDED,
-  AUTH_USER_EXTERNAL_AUTH_DELETED,
-  CHATD_PRESENCE_UPDATED,
-  CHATD_USER_ROOM_MESSAGE_CREATED,
-  CHATD_USER_ROOM_CREATED,
-  CONFERENCE_USER_PARTICIPANT_JOINED,
-  CONFERENCE_USER_PARTICIPANT_LEFT,
-  MEETING_USER_PARTICIPANT_JOINED,
-  MEETING_USER_PARTICIPANT_LEFT,
-  CONFERENCE_USER_PARTICIPANT_TALK_STARTED,
-  CONFERENCE_USER_PARTICIPANT_TALK_STOPPED,
-  SWITCHBOARD_QUEUED_CALLS_UPDATED,
-  SWITCHBOARD_QUEUED_CALL_ANSWERED,
-  SWITCHBOARD_HELD_CALLS_UPDATED,
-  SWITCHBOARD_HELD_CALL_ANSWERED,
-  FAX_OUTBOUND_USER_CREATED,
-  FAX_OUTBOUND_USER_SUCCEEDED,
-  FAX_OUTBOUND_USER_FAILED,
-  APPLICATION_CALL_DTMF_RECEIVED,
-  APPLICATION_CALL_ENTERED,
-  APPLICATION_CALL_INITIATED,
-  APPLICATION_CALL_DELETED,
-  APPLICATION_CALL_UPDATED,
-  APPLICATION_CALL_ANSWERED,
-  APPLICATION_PROGRESS_STARTED,
-  APPLICATION_PROGRESS_STOPPED,
-  APPLICATION_DESTINATION_NODE_CREATED,
-  APPLICATION_NODE_CREATED,
-  APPLICATION_NODE_DELETED,
-  APPLICATION_NODE_UPDATED,
-  APPLICATION_PLAYBACK_CREATED,
-  APPLICATION_PLAYBACK_DELETED,
-  APPLICATION_SNOOP_CREATED,
-  APPLICATION_SNOOP_DELETED,
-  APPLICATION_SNOOP_UPDATED,
-  APPLICATION_USER_OUTGOING_CALL_CREATED,
-  TRUNK_STATUS_UPDATED,
-  LINE_STATUS_UPDATED,
-  AGENT_STATUS_UPDATE,
-  AGENT_PAUSED,
-  AGENT_UNPAUSED,
-  CONFERENCE_ADHOC_PARTICIPANT_LEFT,
-  CONFERENCE_ADHOC_DELETED,
-  MEETING_USER_PROGRESS,
-  MEETING_USER_GUEST_AUTHORIZATION_CREATED,
-];
 
+} // Can't use static
+
+WebSocketClient.eventLists = [AUTH_SESSION_EXPIRE_SOON, FAVORITE_ADDED, FAVORITE_DELETED, USER_STATUS_UPDATE, CHAT_MESSAGE_SENT, CHAT_MESSAGE_RECEIVED, ENDPOINT_STATUS_UPDATE, USERS_FORWARDS_BUSY_UPDATED, USERS_FORWARDS_NOANSWER_UPDATED, USERS_FORWARDS_UNCONDITIONAL_UPDATED, USERS_SERVICES_DND_UPDATED, USER_VOICEMAIL_MESSAGE_CREATED, USER_VOICEMAIL_MESSAGE_UPDATED, USER_VOICEMAIL_MESSAGE_DELETED, CALL_LOG_USER_CREATED, CALL_ANSWERED, CALL_CREATED, CALL_DTMF_CREATED, CALL_ENDED, CALL_UPDATED, CALL_HELD, CALL_RESUMED, AUTH_USER_EXTERNAL_AUTH_ADDED, AUTH_USER_EXTERNAL_AUTH_DELETED, CHATD_PRESENCE_UPDATED, CHATD_USER_ROOM_MESSAGE_CREATED, CHATD_USER_ROOM_CREATED, CONFERENCE_USER_PARTICIPANT_JOINED, CONFERENCE_USER_PARTICIPANT_LEFT, MEETING_USER_PARTICIPANT_JOINED, MEETING_USER_PARTICIPANT_LEFT, CONFERENCE_USER_PARTICIPANT_TALK_STARTED, CONFERENCE_USER_PARTICIPANT_TALK_STOPPED, SWITCHBOARD_QUEUED_CALLS_UPDATED, SWITCHBOARD_QUEUED_CALL_ANSWERED, SWITCHBOARD_HELD_CALLS_UPDATED, SWITCHBOARD_HELD_CALL_ANSWERED, FAX_OUTBOUND_USER_CREATED, FAX_OUTBOUND_USER_SUCCEEDED, FAX_OUTBOUND_USER_FAILED, APPLICATION_CALL_DTMF_RECEIVED, APPLICATION_CALL_ENTERED, APPLICATION_CALL_INITIATED, APPLICATION_CALL_DELETED, APPLICATION_CALL_UPDATED, APPLICATION_CALL_ANSWERED, APPLICATION_PROGRESS_STARTED, APPLICATION_PROGRESS_STOPPED, APPLICATION_DESTINATION_NODE_CREATED, APPLICATION_NODE_CREATED, APPLICATION_NODE_DELETED, APPLICATION_NODE_UPDATED, APPLICATION_PLAYBACK_CREATED, APPLICATION_PLAYBACK_DELETED, APPLICATION_SNOOP_CREATED, APPLICATION_SNOOP_DELETED, APPLICATION_SNOOP_UPDATED, APPLICATION_USER_OUTGOING_CALL_CREATED, TRUNK_STATUS_UPDATED, LINE_STATUS_UPDATED, AGENT_STATUS_UPDATE, AGENT_PAUSED, AGENT_UNPAUSED, CONFERENCE_ADHOC_PARTICIPANT_LEFT, CONFERENCE_ADHOC_DELETED, MEETING_USER_PROGRESS, MEETING_USER_GUEST_AUTHORIZATION_CREATED];
 export default WebSocketClient;