@wazo/sdk 0.39.12 → 0.39.14

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.'));