@wazo/sdk 0.39.13 → 0.39.15

package/lib/web-rtc-client.js

@@ -180,8 +180,12 @@ class WebRTCClient extends Emitter_1.default {
         this.audio = media.audio;
     }
     createUserAgent(uaConfigOverrides) {
+        var _a;
         const uaOptions = this._createUaOptions(uaConfigOverrides);
-        logger.info('sdk webrtc, creating UA', { uaOptions, clientId: this.clientId });
+        logger.info('sdk webrtc, creating UA', {
+            uaOptions: Object.assign(Object.assign({}, uaOptions), { authorizationPassword: `${(_a = uaOptions === null || uaOptions === void 0 ? void 0 : uaOptions.authorizationPassword) === null || _a === void 0 ? void 0 : _a.slice(0, 5)}xxxx` }),
+            clientId: this.clientId,
+        });
         uaOptions.delegate = {
             onConnect: this.onConnect.bind(this),
             onDisconnect: this.onDisconnect.bind(this),
@@ -319,7 +323,7 @@ class WebRTCClient extends Emitter_1.default {
             };
             return this._connectIfNeeded().then(() => {
                 // Avoid race condition with the close method called just before register and setting userAgent to null
-                // during the resolution of the primise.
+                // during the resolution of the promise.
                 if (!this.userAgent) {
                     logger.info('sdk webrtc recreating User Agent after connection');
                     this.userAgent = this.createUserAgent(this.uaConfigOverrides);
@@ -1559,6 +1563,22 @@ class WebRTCClient extends Emitter_1.default {
         this.eventEmitter.emit(TRANSPORT_ERROR);
         this.attemptReconnection();
     }
+    enableLogger(logConnector) {
+        var _a;
+        if (!this.userAgent) {
+            return;
+        }
+        if ((_a = this.userAgent) === null || _a === void 0 ? void 0 : _a.transport) {
+            // @ts-ignore
+            this.userAgent.transport.configuration.traceSip = true;
+        }
+        // @ts-ignore
+        this.userAgent.loggerFactory.builtinEnabled = true;
+        // @ts-ignore
+        this.userAgent.loggerFactory.level = 3; // debug
+        // @ts-ignore
+        this.userAgent.loggerFactory.connector = logConnector;
+    }
     _onHeartbeat(message) {
         const body = message && typeof message === 'object' ? message.data : message;
         if (body && body.indexOf('200 OK') !== -1) {

package/lib/websocket-client.js

@@ -19,6 +19,7 @@ const reconnecting_websocket_1 = __importDefault(require("reconnecting-websocket
 const Emitter_1 = __importDefault(require("./utils/Emitter"));
 const IssueReporter_1 = __importDefault(require("./service/IssueReporter"));
 const Heartbeat_1 = __importDefault(require("./utils/Heartbeat"));
+const string_1 = require("./utils/string");
 exports.SOCKET_EVENTS = {
     ON_OPEN: 'onopen',
     ON_MESSAGE: 'onmessage',
@@ -136,7 +137,7 @@ class WebSocketClient extends Emitter_1.default {
     connect() {
         logger.info('connect method started', {
             host: this.host,
-            token: this.token,
+            token: (0, string_1.obfuscateToken)(this.token),
         });
         this.socket = new reconnecting_websocket_1.default(this._getUrl.bind(this), [], this.options);
         if (this.options.binaryType) {
@@ -185,7 +186,7 @@ class WebSocketClient extends Emitter_1.default {
                 code: event.code,
                 readyState: event.target.readyState,
                 host: this.host,
-                token: this.token,
+                token: (0, string_1.obfuscateToken)(this.token),
             });
             this.initialized = false;
             this.eventEmitter.emit(exports.SOCKET_EVENTS.ON_CLOSE, event);
@@ -211,7 +212,7 @@ class WebSocketClient extends Emitter_1.default {
         logger.info('Wazo WS close', {
             socket: !!this.socket,
             host: this.host,
-            token: this.token,
+            token: (0, string_1.obfuscateToken)(this.token),
         });
         if (!this.socket) {
             return;
@@ -228,7 +229,7 @@ class WebSocketClient extends Emitter_1.default {
         this.token = token;
         logger.info('Wazo WS updating token', {
             url: this._getUrl(),
-            token,
+            token: (0, string_1.obfuscateToken)(token),
             socket: !!this.socket,
         });
         if (this.socket) {
@@ -252,7 +253,7 @@ class WebSocketClient extends Emitter_1.default {
     startHeartbeat() {
         logger.info('Wazo WS start heartbeat', {
             host: this.host,
-            token: this.token,
+            token: (0, string_1.obfuscateToken)(this.token),
         });
         if (!this.socket) {
             this.heartbeat.stop();
@@ -265,7 +266,7 @@ class WebSocketClient extends Emitter_1.default {
     stopHeartbeat() {
         logger.info('Wazo WS stop heartbeat', {
             host: this.host,
-            token: this.token,
+            token: (0, string_1.obfuscateToken)(this.token),
         });
         this.heartbeat.stop();
     }
@@ -298,7 +299,7 @@ class WebSocketClient extends Emitter_1.default {
             reason,
             socket: !!this.socket,
             host: this.host,
-            token: this.token,
+            token: (0, string_1.obfuscateToken)(this.token),
         });
         if (!this.socket) {
             return;
@@ -358,7 +359,7 @@ class WebSocketClient extends Emitter_1.default {
             url += `&userUuid=${this.session.uuid}`;
         }
         logger.info('Wazo WS url computed to reconnect', {
-            url,
+            url: url.replace(this.token, (0, string_1.obfuscateToken)(this.token)),
         });
         return url;
     }
@@ -372,7 +373,7 @@ class WebSocketClient extends Emitter_1.default {
         return __awaiter(this, void 0, void 0, function* () {
             logger.log('heartbeat timed out', {
                 host: this.host,
-                token: this.token,
+                token: (0, string_1.obfuscateToken)(this.token),
             });
             this.close();
             this.eventEmitter.emit(exports.SOCKET_EVENTS.ON_CLOSE, new Error('Websocket ping failure.'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wazo/sdk",
-  "version": "0.39.13",
+  "version": "0.39.15",
   "description": "Wazo's JavaScript Software Development Kit.",
   "main": "dist/wazo-sdk.js",
   "author": "Wazo (http://wazo.io)",

package/src/api/amid.ts

@@ -8,9 +8,18 @@ export interface AmiD {
 export default ((client: ApiRequester, baseUrl: string): AmiD => ({
   action: (action: string, args: Record<string, any> = {}): Promise<string> => client.post(`${baseUrl}/action/${action}`, args),
   getAors: async (endpoint: string) => {
-    const rawEvents = await client.post(`${baseUrl}/action/PJSIPShowEndpoint`, {
-      Endpoint: endpoint,
-    }) || [];
-    return rawEvents.filter((event: Record<string, any>) => event.Event === 'ContactStatusDetail');
+    try {
+      const rawEvents = await client.post(`${baseUrl}/action/PJSIPShowEndpoint`, {
+        Endpoint: endpoint,
+      }) || [];
+
+      if (!rawEvents) {
+        return [];
+      }
+
+      return rawEvents.filter((event: Record<string, any>) => event.Event === 'ContactStatusDetail');
+    } catch {
+      return [];
+    }
   },
 }));

package/src/api-client.ts

@@ -11,6 +11,7 @@ import webhookdMethods, { WebhookD } from './api/webhookd';
 import amidMethods, { AmiD } from './api/amid';
 import ApiRequester from './utils/api-requester';
 import IssueReporter from './service/IssueReporter';
+import { obfuscateToken } from './utils/string';
 
 type ConstructorParams = {
   server: string;
@@ -132,7 +133,7 @@ export default class ApiClient {
 
   async refreshTokenCallback(): Promise<string | null> {
     logger.info('refresh token callback called', {
-      refreshToken: this.refreshToken,
+      refreshToken: obfuscateToken(this.refreshToken),
       refreshBackend: this.refreshBackend,
       refreshTenantId: this.refreshTenantId,
       refreshDomainName: this.refreshDomainName,
@@ -151,7 +152,7 @@ export default class ApiClient {
       }
 
       logger.info('token refreshed', {
-        token: session.token,
+        token: obfuscateToken(session.token),
       });
 
       if (this.onRefreshToken) {

package/src/domain/Phone/WebRTCPhone.ts

@@ -594,6 +594,15 @@ export default class WebRTCPhone extends Emitter implements Phone {
 
     const callSession = this._createAcceptedCallSession(sipSession, cameraEnabled);
 
+    if (this.currentSipSession && !this.isCurrentCallSipSession(callSession)) {
+      logger.info('WebRTC phone - on call accepted with another ongoing call, holding it', {
+        sipId: sipSession.id,
+        cameraEnabled,
+      });
+
+      this.holdSipSession(this.currentSipSession, this.currentCallSession, true);
+    }
+
     this.currentSipSession = sipSession;
     this.currentCallSession = callSession;
     this.eventEmitter.emit(ON_TERMINATE_SOUND, callSession, 'call accepted');

package/src/service/IssueReporter.ts

@@ -4,6 +4,7 @@
 import moment from 'moment';
 import { realFetch } from '../utils/api-requester';
 import isMobile from '../utils/isMobile';
+import { obfuscateToken } from '../utils/string';
 
 const TRACE = 'trace';
 const DEBUG = 'debug';
@@ -133,6 +134,15 @@ class IssueReporter {
     return str.replace(/"/g, "'").replace(/\\/g, '');
   }
 
+  obfuscateHeaderToken(headers: object): object {
+    const newHeaders: object = { ...headers };
+    if ('X-Auth-Token' in newHeaders) {
+      newHeaders['X-Auth-Token'] = obfuscateToken(newHeaders['X-Auth-Token'] as string);
+    }
+
+    return newHeaders;
+  }
+
   log(level: string, ...args: any) {
     if (!this.enabled) {
       return;
@@ -229,7 +239,7 @@ class IssueReporter {
       status,
       body: this.removeSlashes(JSON.stringify(options.body)),
       method: options.method,
-      headers: options.headers,
+      headers: this.obfuscateHeaderToken(options.headers),
       duration,
     });
   }

package/src/simple/Auth.ts

@@ -18,6 +18,7 @@ import getApiClient, {
 import IssueReporter from '../service/IssueReporter';
 import Wazo from './index';
 import SipLine from '../domain/SipLine';
+import { obfuscateToken } from '../utils/string';
 
 export class InvalidSubscription extends Error {}
 export class InvalidAuthorization extends Error {}
@@ -115,9 +116,8 @@ class Auth implements IAuth {
     setApiClientId(this.clientId);
     setRefreshExpiration(this.expiration);
     setOnRefreshToken((token: string, session: Session) => {
-      logger.info('on refresh token done', {
-        token,
-      });
+      logger.info('on refresh token done', { token: obfuscateToken(token) });
+
       setApiToken(token);
       Wazo.Websocket.updateToken(token);
 

package/src/simple/Phone.ts

@@ -290,22 +290,7 @@ class Phone extends Emitter implements IPhone {
       options.log.builtinEnabled = false;
       options.log.logLevel = 'debug';
 
-      options.log.connector = (level: any, className: string, label: any, content: string) => {
-        const protocolIndex = content && content.indexOf ? protocolDebugMessages.findIndex(prefix => content.indexOf(prefix) !== -1) : -1;
-
-        if (className === 'sip.Transport' && protocolIndex !== -1) {
-          const direction = protocolIndex === 0 ? 'receiving' : 'sending';
-          const message = content.replace(`${protocolDebugMessages[protocolIndex]}\n\n`, '').replace('\r\n', '\n');
-          protocolLogger.trace(message, {
-            className,
-            direction,
-          });
-        } else {
-          sipLogger.trace(content, {
-            className,
-          });
-        }
-      };
+      options.log.connector = this._logConnector;
     }
 
     this.client = new WazoWebRTCClient({
@@ -609,6 +594,10 @@ class Phone extends Emitter implements IPhone {
     }
   }
 
+  enableLogger(): void {
+    this.client.enableLogger(this._logConnector);
+  }
+
   _transferEvents() {
     this.unbind();
     [...clientEvents, ...transportEvents].forEach(event => {
@@ -623,6 +612,22 @@ class Phone extends Emitter implements IPhone {
     });
   }
 
+  _logConnector(level: any, className: string, label: any, content: string): void {
+    const protocolIndex = content && content.indexOf ? protocolDebugMessages.findIndex(prefix => content.indexOf(prefix) !== -1) : -1;
+
+    if (className === 'sip.Transport' && protocolIndex !== -1) {
+      const direction = protocolIndex === 0 ? 'receiving' : 'sending';
+      const message = content.replace(`${protocolDebugMessages[protocolIndex]}\n\n`, '').replace('\r\n', '\n');
+      protocolLogger.trace(message, {
+        className,
+        direction,
+      });
+    } else {
+      sipLogger.trace(content, {
+        className,
+      });
+    }
+  }
 }
 
 if (!global.wazoTelephonyInstance) {

package/src/simple/Websocket.ts

@@ -2,6 +2,7 @@ import type Session from '../domain/Session';
 import WazoWebSocketClient, * as WebSocketClient from '../websocket-client';
 import Emitter, { IEmitter } from '../utils/Emitter';
 import IssueReporter from '../service/IssueReporter';
+import { obfuscateToken } from '../utils/string';
 
 const {
   SOCKET_EVENTS,
@@ -59,7 +60,7 @@ class Websocket extends Emitter implements IWebsocket {
   open(host: string, session: Session) {
     logger.info('open simple WebSocket', {
       host,
-      token: session.token,
+      token: obfuscateToken(session.token),
     });
     this.ws = new WazoWebSocketClient({
       host,

package/src/utils/__tests__/string.test.ts

@@ -1,4 +1,4 @@
-import { camelToUnderscore } from '../string';
+import { camelToUnderscore, obfuscateToken } from '../string';
 
 describe('string utils', () => {
   describe('camelToUnderscore', () => {
@@ -22,4 +22,34 @@ describe('string utils', () => {
       expect(camelToUnderscore('L123')).toEqual('l123');
     });
   });
+
+  describe('obfuscateToken', () => {
+    it('should return null when token is null', () => {
+      const result = obfuscateToken(null);
+      expect(result).toBeNull();
+    });
+
+    it('should return undefined when token is undefined', () => {
+      const result = obfuscateToken(undefined);
+      expect(result).toBeUndefined();
+    });
+
+    it('should obfuscate the token by replacing characters after the first part with "xxxxxx"', () => {
+      const token = '12345-67890-abcdef';
+      const result = obfuscateToken(token);
+      expect(result).toBe('12345-xxxxxx-xxxxxx');
+    });
+
+    it('should handle tokens with a single part', () => {
+      const token = 'singlepart';
+      const result = obfuscateToken(token);
+      expect(result).toBe('singlepart');
+    });
+
+    it('should handle tokens with two parts', () => {
+      const token = 'part1-part2';
+      const result = obfuscateToken(token);
+      expect(result).toBe('part1-xxxxxx');
+    });
+  });
 });

package/src/utils/string.ts

@@ -5,3 +5,11 @@ export const camelToUnderscore = (key: string): string => {
 
   return key.charAt(0).toLowerCase() + key.substring(1).replace(/([A-Z])/g, '_$1').toLowerCase();
 };
+
+export const obfuscateToken = (token: string | null | undefined) => {
+  if (!token) {
+    return token;
+  }
+
+  return token.split('-').map((part, index) => (index === 0 ? part : 'xxxxxx')).join('-');
+};

package/src/web-rtc-client.ts

@@ -253,7 +253,11 @@ export default class WebRTCClient extends Emitter {
   createUserAgent(uaConfigOverrides?: UserAgentConfigOverrides): UserAgent {
     const uaOptions = this._createUaOptions(uaConfigOverrides);
 
-    logger.info('sdk webrtc, creating UA', { uaOptions, clientId: this.clientId });
+    logger.info('sdk webrtc, creating UA', {
+      uaOptions: { ...uaOptions, authorizationPassword: `${uaOptions?.authorizationPassword?.slice(0, 5)}xxxx` },
+      clientId: this.clientId,
+    });
+
     uaOptions.delegate = {
       onConnect: this.onConnect.bind(this),
       onDisconnect: this.onDisconnect.bind(this),
@@ -412,7 +416,7 @@ export default class WebRTCClient extends Emitter {
 
     return this._connectIfNeeded().then(() => {
       // Avoid race condition with the close method called just before register and setting userAgent to null
-      // during the resolution of the primise.
+      // during the resolution of the promise.
       if (!this.userAgent) {
         logger.info('sdk webrtc recreating User Agent after connection');
         this.userAgent = this.createUserAgent(this.uaConfigOverrides);
@@ -1874,6 +1878,24 @@ export default class WebRTCClient extends Emitter {
     this.attemptReconnection();
   }
 
+  enableLogger(logConnector: (level: any, className: string, label: any, content: string) => void): void {
+    if (!this.userAgent) {
+      return;
+    }
+
+    if (this.userAgent?.transport) {
+      // @ts-ignore
+      this.userAgent.transport.configuration.traceSip = true;
+    }
+
+    // @ts-ignore
+    this.userAgent.loggerFactory.builtinEnabled = true;
+    // @ts-ignore
+    this.userAgent.loggerFactory.level = 3; // debug
+    // @ts-ignore
+    this.userAgent.loggerFactory.connector = logConnector;
+  }
+
   _onHeartbeat(message: string | Record<string, any>): void {
     const body = message && typeof message === 'object' ? message.data : message;
 

package/src/websocket-client.ts

@@ -6,6 +6,7 @@ import Emitter from './utils/Emitter';
 import type { WebSocketMessage } from './types/WebSocketMessage';
 import IssueReporter from './service/IssueReporter';
 import Heartbeat from './utils/Heartbeat';
+import { obfuscateToken } from './utils/string';
 
 export const SOCKET_EVENTS = {
   ON_OPEN: 'onopen',
@@ -177,7 +178,7 @@ class WebSocketClient extends Emitter {
   connect() {
     logger.info('connect method started', {
       host: this.host,
-      token: this.token,
+      token: obfuscateToken(this.token),
     });
     this.socket = new ReconnectingWebSocket(this._getUrl.bind(this), [], this.options);
 
@@ -234,7 +235,7 @@ class WebSocketClient extends Emitter {
         code: event.code,
         readyState: event.target.readyState,
         host: this.host,
-        token: this.token,
+        token: obfuscateToken(this.token),
       });
       this.initialized = false;
       this.eventEmitter.emit(SOCKET_EVENTS.ON_CLOSE, event);
@@ -265,7 +266,7 @@ class WebSocketClient extends Emitter {
     logger.info('Wazo WS close', {
       socket: !!this.socket,
       host: this.host,
-      token: this.token,
+      token: obfuscateToken(this.token),
     });
 
     if (!this.socket) {
@@ -286,7 +287,7 @@ class WebSocketClient extends Emitter {
     this.token = token;
     logger.info('Wazo WS updating token', {
       url: this._getUrl(),
-      token,
+      token: obfuscateToken(token),
       socket: !!this.socket,
     });
 
@@ -312,7 +313,7 @@ class WebSocketClient extends Emitter {
   startHeartbeat() {
     logger.info('Wazo WS start heartbeat', {
       host: this.host,
-      token: this.token,
+      token: obfuscateToken(this.token),
     });
 
     if (!this.socket) {
@@ -328,7 +329,7 @@ class WebSocketClient extends Emitter {
   stopHeartbeat() {
     logger.info('Wazo WS stop heartbeat', {
       host: this.host,
-      token: this.token,
+      token: obfuscateToken(this.token),
     });
     this.heartbeat.stop();
   }
@@ -366,7 +367,7 @@ class WebSocketClient extends Emitter {
       reason,
       socket: !!this.socket,
       host: this.host,
-      token: this.token,
+      token: obfuscateToken(this.token),
     });
 
     if (!this.socket) {
@@ -439,7 +440,7 @@ class WebSocketClient extends Emitter {
     }
 
     logger.info('Wazo WS url computed to reconnect', {
-      url,
+      url: url.replace(this.token!, obfuscateToken(this.token) as string),
     });
     return url;
   }
@@ -454,7 +455,7 @@ class WebSocketClient extends Emitter {
   async _onHeartbeatTimeout() {
     logger.log('heartbeat timed out', {
       host: this.host,
-      token: this.token,
+      token: obfuscateToken(this.token),
     });
     this.close();
     this.eventEmitter.emit(SOCKET_EVENTS.ON_CLOSE, new Error('Websocket ping failure.'));