@wazo/sdk 0.37.22 → 0.37.26

package/lib/web-rtc-client.js

@@ -735,10 +735,6 @@ const getSrflxOrRelay = (candidates          )           =>
   candidates
     .filter(candidate => candidate && (candidate.type === 'srflx' || candidate.type === 'relay'));
 
-const areCandidateValid = (candidates          )          =>
-  getSrflxOrRelay(candidates)
-    .length > 0;
-
 const getVideoDirection = (sdp        )          => {
   const parsedSdp = sdpParser__default['default'].parse(sdp);
   const videoMedia = parsedSdp.media.find(media => media.type === 'video');
@@ -791,8 +787,6 @@ const fixSdp = (sdp        , candidates          , forcePort          = true)
 /* global RTCSessionDescriptionInit, navigator */
 
 const wazoLogger = IssueReporter$1 ? IssueReporter$1.loggerFor('webrtc-sdh') : console;
-const MAX_WAIT_FOR_ICE_TRIES = 20;
-const WAIT_FOR_ICE_TIMEOUT = 500;
 
 // Customized mediaStreamFactory allowing to send screensharing stream directory when upgrading
 const wazoMediaStreamFactory = (constraints        )                       => {
@@ -982,38 +976,6 @@ class WazoSessionDescriptionHandler extends sessionDescriptionHandler.SessionDes
     this._peerConnection = undefined;
   }
 
-  async _waitForValidGatheredIce()         {
-    let tries = 0;
-
-    while (!areCandidateValid(this.gatheredCandidates) && tries < MAX_WAIT_FOR_ICE_TRIES) {
-      wazoLogger.trace('SessionDescriptionHandler._waitForValidGatheredIce, waiting for ice', {
-        tries,
-        max: MAX_WAIT_FOR_ICE_TRIES,
-      });
-
-      tries++;
-
-      // eslint-disable-next-line no-await-in-loop
-      await new Promise(resolve => setTimeout(resolve, WAIT_FOR_ICE_TIMEOUT));
-    }
-
-    if (tries >= MAX_WAIT_FOR_ICE_TRIES) {
-      const errorMsg = 'No valid candidates found, can\'t answer the call';
-      const error = new Error(errorMsg);
-      wazoLogger.error(errorMsg, { tries, max: MAX_WAIT_FOR_ICE_TRIES });
-
-      // Emit an error, because sip.js catches the exception and switch to status Terminated.
-      this.eventEmitter.emit('error', error);
-
-      wazoLogger.error('No valid candidates found', { tries, candidates: JSON.stringify(this.gatheredCandidates) });
-    }
-
-    // eslint-disable-next-line
-    wazoLogger.trace('Found valid candidates', { tries, candidates: JSON.stringify(this.gatheredCandidates) });
-
-    return this.getLocalSessionDescription();
-  }
-
   // Overridden to send `inactive` in conference
   updateDirection(options                                   , isConference          = false,
     audioOnly          = false)                {
@@ -2123,6 +2085,9 @@ class Contact {
   }
 
   static parseMany(response                  )                 {
+    if (!response || !response.results) {
+      return [];
+    }
     return response.results.map(r => Contact.parse(r, response.column_types));
   }
 
@@ -2493,7 +2458,7 @@ class Contact {
       this[key] = old[key] || this[key];
     });
 
-    if (old.lineState && !this.lineState) {
+    if (old.lineState) {
       this.lineState = old.lineState;
     }
 
@@ -3200,8 +3165,9 @@ class ExternalApp {
                              
                
                
-                 
+                
                       
+                        
  
 
 class Meeting {
@@ -3212,9 +3178,10 @@ class Meeting {
                
                
                
-                 
+                    
                       
                             
+                     
 
   static parse(plain                         )          {
     return new Meeting({
@@ -3224,12 +3191,16 @@ class Meeting {
       ownerUuids: plain.owner_uuids,
       port: plain.port,
       uuid: plain.uuid,
-      number: plain.number,
+      extension: plain.exten,
       persistent: plain.persistent,
+      creationTime: moment__default['default'](plain.creation_time).toDate(),
     });
   }
 
   static parseMany(items                           )                 {
+    if (!items) {
+      return [];
+    }
     return items.map(plain => Meeting.parse(plain));
   }
 
@@ -3244,8 +3215,9 @@ class Meeting {
     ownerUuids,
     port,
     uri,
-    number,
+    extension,
     persistent,
+    creationTime,
   }         = {}) {
     this.guestSipAuthorization = guestSipAuthorization;
     this.uri = uri;
@@ -3253,8 +3225,9 @@ class Meeting {
     this.ownerUuids = ownerUuids;
     this.port = port;
     this.uuid = uuid;
-    this.number = number;
+    this.extension = extension;
     this.persistent = persistent;
+    this.creationTime = creationTime;
 
     // Useful to compare instead of instanceof with minified code
     this.type = 'Meeting';
@@ -3432,6 +3405,10 @@ class ChatMessage {
                 
 
   static parseMany(plain                         )                     {
+    if (!plain || !plain.items) {
+      return [];
+    }
+
     return plain.items.map(item => ChatMessage.parse(item));
   }
 
@@ -3541,6 +3518,9 @@ class Voicemail {
   }
 
   static parseMany(plain          )                   {
+    if (!plain) {
+      return [];
+    }
     const plainUnread = plain.folders.filter(folder => folder.type === 'new')[0].messages;
     const plainRead = plain.folders.filter(folder => folder.type === 'old')[0].messages;
 
@@ -3650,6 +3630,9 @@ class Call {
                      
 
   static parseMany(plain                     )              {
+    if (!plain) {
+      return [];
+    }
     return plain.map((plainCall              ) => Call.parse(plainCall));
   }
 
@@ -3822,6 +3805,9 @@ class Recording {
                
 
   static parseMany(recordings                      = [])              {
+    if (!recordings) {
+      return [];
+    }
     return recordings.map(item => Recording.parse(item));
   }
 
@@ -3923,6 +3909,10 @@ class CallLog {
   }
 
   static parseMany(plain          )                 {
+    if (!plain || !plain.items) {
+      return [];
+    }
+
     return plain.items.map(item => CallLog.parse(item));
   }
 
@@ -4495,6 +4485,9 @@ class ChatRoom {
                          
 
   static parseMany(plain                  )                  {
+    if (!plain || !plain.items) {
+      return [];
+    }
     return plain.items.map(item => ChatRoom.parse(item));
   }
 
@@ -5726,7 +5719,7 @@ class WebRTCClient extends Emitter {
   }
 
   call(number        , enableVideo          , audioOnly          = false, conference          = false)          {
-    logger.info('sdk webrtc creating call', { number, enableVideo, audioOnly });
+    logger.info('sdk webrtc creating call', { number, enableVideo, audioOnly, conference });
     const inviterOptions         = {
       sessionDescriptionHandlerOptionsReInvite: {
         conference,
@@ -6802,6 +6795,7 @@ class WebRTCClient extends Emitter {
     const screenSharing = constraints && 'screen' in constraints ? constraints.screen : false;
     const isDesktop = constraints && 'desktop' in constraints ? constraints.desktop : false;
     const withAudio = constraints && 'audio' in constraints ? constraints.audio : true;
+    const mandatoryVideo = constraints && typeof constraints.video === 'object' ? constraints.video.mandatory : {};
 
     logger.info('Retrieving media a configuration', { enableVideo, screenSharing, isDesktop, withAudio, constraints });
 
@@ -6809,7 +6803,8 @@ class WebRTCClient extends Emitter {
       constraints: {
         // Exact constraint are not supported with `getDisplayMedia` and we must have a video=false in desktop screenshare
         audio: screenSharing ? !isDesktop : (withAudio ? this._getAudioConstraints() : false),
-        video: screenSharing ? (isDesktop ? ({ mandatory: { chromeMediaSource: 'desktop' } }) : { cursor: 'always' })
+        video: screenSharing ? (isDesktop
+          ? ({ mandatory: { chromeMediaSource: 'desktop', ...(mandatoryVideo || {}) } }) : { cursor: 'always' })
           : this._getVideoConstraints(enableVideo),
         screen: screenSharing,
         desktop: isDesktop,
@@ -7144,12 +7139,14 @@ class WebRTCClient extends Emitter {
 
     session.sessionDescriptionHandler.remoteMediaStream.onaddtrack = onTrack;
 
-    pc.oniceconnectionstatechange = () => {
-      logger.info('on ice connection state changed', { state: pc.iceConnectionState });
-      if (pc.iceConnectionState === 'disconnected') {
-        this.eventEmitter.emit(ON_DISCONNECTED);
-      }
-    };
+    if (pc) {
+      pc.oniceconnectionstatechange = () => {
+        logger.info('on ice connection state changed', { state: pc.iceConnectionState });
+        if (pc.iceConnectionState === 'disconnected') {
+          this.eventEmitter.emit(ON_DISCONNECTED);
+        }
+      };
+    }
 
     if (withEvent) {
       this.eventEmitter.emit(ACCEPTED, session, sessionDialog);
@@ -7359,13 +7356,17 @@ class WebRTCClient extends Emitter {
     const nbStats = this.sessionNetworkStats[sessionId].length;
     const lastNetworkStats = this.sessionNetworkStats[sessionId][nbStats - 1];
     const lastAudioSent = lastNetworkStats ? lastNetworkStats.audioBytesSent : 0;
+    const lastAudioContentSent = lastNetworkStats ? lastNetworkStats.audioContentSent : 0;
     const lastVideoSent = lastNetworkStats ? lastNetworkStats.videoBytesSent : 0;
     const lastAudioReceived = lastNetworkStats ? lastNetworkStats.audioBytesReceived : 0;
+    const lastAudioContentReceived = lastNetworkStats ? lastNetworkStats.audioContentReceived : 0;
     const lastVideoReceived = lastNetworkStats ? lastNetworkStats.videoBytesReceived : 0;
     const lastTransportSent = lastNetworkStats ? lastNetworkStats.transportSent : 0;
     const lastTransportReceived = lastNetworkStats ? lastNetworkStats.transportReceived : 0;
-    let audioBytesSent = 0;
-    let audioBytesReceived = 0;
+    let audioBytesSent = 0; // content + header
+    let audioBytesReceived = 0; // content + header
+    let audioContentSent = 0; // useful to detect blank call
+    let audioContentReceived = 0;
     let videoBytesSent = 0;
     let videoBytesReceived = 0;
     let transportSent = 0;
@@ -7374,25 +7375,27 @@ class WebRTCClient extends Emitter {
 
     stats.forEach(report => {
       if (report.type === 'outbound-rtp' && report.kind === 'audio') {
-        audioBytesSent += report.bytesSent + report.headerBytesSent;
+        audioBytesSent += Number(report.bytesSent) + Number(report.headerBytesSent);
+        audioContentSent += Number(report.bytesSent);
       }
       if (report.type === 'remote-outbound-rtp' && report.kind === 'audio') {
-        audioBytesSent += report.bytesSent;
+        audioBytesSent += Number(report.bytesSent);
       }
       if (report.type === 'outbound-rtp' && report.kind === 'video') {
-        videoBytesSent += report.bytesSent + report.headerBytesSent;
+        videoBytesSent += Number(report.bytesSent) + Number(report.headerBytesSent);
       }
       if (report.type === 'inbound-rtp' && report.kind === 'audio') {
-        packetsLost += report.packetsLost;
-        networkStats.packetsReceived = report.packetsReceived;
-        audioBytesReceived += report.bytesReceived + report.headerBytesReceived;
+        packetsLost += Number(report.packetsLost);
+        networkStats.packetsReceived = Number(report.packetsReceived);
+        audioBytesReceived += Number(report.bytesReceived) + Number(report.headerBytesReceived);
+        audioContentReceived += Number(report.bytesReceived);
       }
       if (report.type === 'inbound-rtp' && report.kind === 'video') {
-        videoBytesReceived += report.bytesReceived + report.headerBytesReceived;
+        videoBytesReceived += Number(report.bytesReceived) + Number(report.headerBytesReceived);
       }
       if (report.type === 'outbound-rtp' && report.kind === 'video') {
         if ('framesPerSecond' in report) {
-          networkStats.framesPerSecond = report.framesPerSecond;
+          networkStats.framesPerSecond = Number(report.framesPerSecond);
         }
         if ('framerateMean' in report) {
           // framerateMean is only available in FF
@@ -7400,24 +7403,31 @@ class WebRTCClient extends Emitter {
         }
       }
       if (report.type === 'remote-inbound-rtp' && report.kind === 'audio') {
-        packetsLost += report.packetsLost;
-        networkStats.roundTripTime = report.roundTripTime;
-        networkStats.jitter = report.jitter;
+        packetsLost += Number(report.packetsLost);
+        networkStats.roundTripTime = Number(report.roundTripTime);
+        networkStats.jitter = Number(report.jitter);
       }
       if (report.type === 'remote-inbound-rtp' && report.kind === 'video') {
-        packetsLost += report.packetsLost;
+        packetsLost += Number(report.packetsLost);
       }
       if (report.type === 'transport') {
-        transportSent += report.bytesSent;
-        transportReceived += report.bytesReceived;
+        transportSent += Number(report.bytesSent);
+        transportReceived += Number(report.bytesReceived);
       }
     });
 
     networkStats.packetsLost = packetsLost;
+
     networkStats.totalAudioBytesSent = audioBytesSent;
     networkStats.audioBytesSent = audioBytesSent - lastAudioSent;
     networkStats.totalAudioBytesReceived = audioBytesReceived - lastAudioReceived;
     networkStats.audioBytesReceived = audioBytesReceived;
+
+    networkStats.totalAudioContentSent = audioContentSent;
+    networkStats.audioContentSent = audioContentSent - lastAudioContentSent;
+    networkStats.totalAudioBytesReceived = audioContentReceived - lastAudioContentReceived;
+    networkStats.audioContentReceived = audioContentReceived;
+
     networkStats.totalVideoBytesSent = videoBytesSent;
     networkStats.videoBytesSent = videoBytesSent - lastVideoSent;
     networkStats.totalVideoBytesReceived = videoBytesReceived;

package/package.json

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

package/src/domain/Call.js

@@ -61,6 +61,9 @@ export default class Call {
   recording: boolean;
 
   static parseMany(plain: Array<CallResponse>): Array<Call> {
+    if (!plain) {
+      return [];
+    }
     return plain.map((plainCall: CallResponse) => Call.parse(plainCall));
   }
 

package/src/domain/CallLog.js

@@ -84,6 +84,10 @@ export default class CallLog {
   }
 
   static parseMany(plain: Response): Array<CallLog> {
+    if (!plain || !plain.items) {
+      return [];
+    }
+
     return plain.items.map(item => CallLog.parse(item));
   }
 

package/src/domain/ChatMessage.js

@@ -42,6 +42,10 @@ export default class ChatMessage {
   read: boolean;
 
   static parseMany(plain: ChatMessageListResponse): Array<ChatMessage> {
+    if (!plain || !plain.items) {
+      return [];
+    }
+
     return plain.items.map(item => ChatMessage.parse(item));
   }
 

package/src/domain/ChatRoom.js

@@ -22,6 +22,9 @@ export default class ChatRoom {
   users: Array<ChatUser>;
 
   static parseMany(plain: RootListResponse): Array<ChatRoom> {
+    if (!plain || !plain.items) {
+      return [];
+    }
     return plain.items.map(item => ChatRoom.parse(item));
   }
 

package/src/domain/Contact.js

@@ -281,6 +281,9 @@ export default class Contact {
   }
 
   static parseMany(response: ContactsResponse): Array<Contact> {
+    if (!response || !response.results) {
+      return [];
+    }
     return response.results.map(r => Contact.parse(r, response.column_types));
   }
 
@@ -651,7 +654,7 @@ export default class Contact {
       this[key] = old[key] || this[key];
     });
 
-    if (old.lineState && !this.lineState) {
+    if (old.lineState) {
       this.lineState = old.lineState;
     }
 

package/src/domain/Meeting.js

@@ -1,4 +1,6 @@
 // @flow
+import moment from 'moment';
+
 import newFrom from '../utils/new-from';
 
 export type MeetingCreationResponse = {
@@ -8,8 +10,9 @@ export type MeetingCreationResponse = {
   owner_uuids: Array<string>,
   port: string,
   uuid: string,
-  number: string,
+  exten: string,
   persistent: boolean,
+  creation_time: string,
 }
 
 export default class Meeting {
@@ -20,9 +23,10 @@ export default class Meeting {
   uuid: string;
   name: string;
   port: string;
-  number: string;
+  extension: string;
   persistent: boolean;
   ownerUuids: Array<string>;
+  creationTime: Date;
 
   static parse(plain: MeetingCreationResponse): Meeting {
     return new Meeting({
@@ -32,12 +36,16 @@ export default class Meeting {
       ownerUuids: plain.owner_uuids,
       port: plain.port,
       uuid: plain.uuid,
-      number: plain.number,
+      extension: plain.exten,
       persistent: plain.persistent,
+      creationTime: moment(plain.creation_time).toDate(),
     });
   }
 
   static parseMany(items: MeetingCreationResponse[]): Array<Meeting> {
+    if (!items) {
+      return [];
+    }
     return items.map(plain => Meeting.parse(plain));
   }
 
@@ -52,8 +60,9 @@ export default class Meeting {
     ownerUuids,
     port,
     uri,
-    number,
+    extension,
     persistent,
+    creationTime,
   }: Object = {}) {
     this.guestSipAuthorization = guestSipAuthorization;
     this.uri = uri;
@@ -61,8 +70,9 @@ export default class Meeting {
     this.ownerUuids = ownerUuids;
     this.port = port;
     this.uuid = uuid;
-    this.number = number;
+    this.extension = extension;
     this.persistent = persistent;
+    this.creationTime = creationTime;
 
     // Useful to compare instead of instanceof with minified code
     this.type = 'Meeting';

package/src/domain/Phone/CTIPhone.js

@@ -280,6 +280,10 @@ export default class CTIPhone extends Emitter implements Phone {
     return false;
   }
 
+  hasAVideoTrack(): boolean {
+    return false;
+  }
+
   getLocalStreamForCall(): ?MediaStream {
     return null;
   }

package/src/domain/Phone/Phone.js

@@ -80,6 +80,8 @@ export interface Phone {
 
   hasVideo(callSession: CallSession): boolean;
 
+  hasAVideoTrack(callSession: CallSession): boolean;
+
   isWebRTC(): boolean;
 
   getUserAgent(): string;

package/src/domain/Phone/WebRTCPhone.js

@@ -203,6 +203,7 @@ export default class WebRTCPhone extends Emitter implements Phone {
       constraints,
       audioOnly,
       conference,
+      iceRestart,
     });
 
     if (!sipSession) {
@@ -306,6 +307,11 @@ export default class WebRTCPhone extends Emitter implements Phone {
 
     this.client.downgradeToAudio(sipSession);
 
+    if (callSession) {
+      callSession.cameraEnabled = false;
+      this._updateCallSession(callSession);
+    }
+
     if (withMessage) {
       this._sendReinviteMessage(callSession, false);
     }
@@ -333,6 +339,11 @@ export default class WebRTCPhone extends Emitter implements Phone {
 
     const newStream = await this.client.upgradeToVideo(sipSession, constraints, isConference);
 
+    if (callSession) {
+      callSession.cameraEnabled = true;
+      this._updateCallSession(callSession);
+    }
+
     // If no stream is returned, it means we have to reinvite
     if (!newStream) {
       return true;
@@ -571,18 +582,20 @@ export default class WebRTCPhone extends Emitter implements Phone {
       screenTrack,
     });
 
-    screenTrack.onended = () => {
-      logger.info('WebRTC phone - on screenshare ended', {
-        hadVideo,
-        id: this.getSipSessionId(sipSession),
-        screenTrack,
-      });
-
-      this.eventEmitter.emit(
-        ON_SHARE_SCREEN_ENDING,
-        this._createCallSession(sipSession, callSession),
-      );
-    };
+    if (screenTrack) {
+      screenTrack.onended = () => {
+        logger.info('WebRTC phone - on screenshare ended', {
+          hadVideo,
+          id: this.getSipSessionId(sipSession),
+          screenTrack,
+        });
+
+        this.eventEmitter.emit(
+          ON_SHARE_SCREEN_ENDING,
+          this._createCallSession(sipSession, callSession),
+        );
+      };
+    }
 
     this.currentScreenShare = {
       stream: screenStream,
@@ -602,7 +615,7 @@ export default class WebRTCPhone extends Emitter implements Phone {
   }
 
   _onCallAccepted(sipSession: Session, cameraEnabled: boolean): CallSession {
-    logger.info('WebRTC phone -  on call accepted', { sipId: sipSession.id, cameraEnabled });
+    logger.info('WebRTC phone - on call accepted', { sipId: sipSession.id, cameraEnabled });
 
     const callSession = this._createAcceptedCallSession(sipSession, cameraEnabled);
     this.currentSipSession = sipSession;
@@ -1114,7 +1127,7 @@ export default class WebRTCPhone extends Emitter implements Phone {
   // @TODO: line is not used here
   async makeCall(number: string, line: any, cameraEnabled?: boolean,
     audioOnly: boolean = false, conference: boolean = false): Promise<?CallSession> {
-    logger.info('make WebRTC call', { number, lineId: line ? line.id : null, cameraEnabled });
+    logger.info('make WebRTC call', { number, lineId: line ? line.id : null, cameraEnabled, audioOnly, conference });
     if (!number) {
       return Promise.resolve(null);
     }
@@ -1475,9 +1488,13 @@ export default class WebRTCPhone extends Emitter implements Phone {
       if (this.shouldSendReinvite && this.currentSipSession
         && this.currentSipSession.state === SessionState.Established) {
         this.shouldSendReinvite = false;
+        const pc = this.currentSipSession.sessionDescriptionHandler.peerConnection;
+        const isConference = pc ? pc.sfu : false;
+        const hasVideo = this.currentCallSession && this.currentCallSession.cameraEnabled;
+
         try {
           // Send reinvite with iceRestart
-          this.sendReinvite(this.currentCallSession, null, false, false, true);
+          this.sendReinvite(this.currentCallSession, null, isConference, !hasVideo, true);
         } catch (e) {
           logger.error('WebRTC reinvite after register, error', { message: e.message, stack: e.stack });
         }
@@ -1561,6 +1578,15 @@ export default class WebRTCPhone extends Emitter implements Phone {
     return this.client.getSipSessionId(sipSession);
   }
 
+  _updateCallSession(callSession: CallSession) {
+    const sipSession = this.findSipSession(callSession);
+    const sipSessionId = sipSession ? this.getSipSessionId(sipSession) : null;
+
+    if (sipSessionId) {
+      this.callSessions[sipSessionId] = callSession;
+    }
+  }
+
   _onMessage(message: Message) {
     if (!message || message.method !== 'MESSAGE') {
       return;

package/src/domain/Recording.js

@@ -25,6 +25,9 @@ export default class Recording {
   uuid: string;
 
   static parseMany(recordings: RecordingResponse[] = []): Recording[] {
+    if (!recordings) {
+      return [];
+    }
     return recordings.map(item => Recording.parse(item));
   }
 

package/src/domain/Voicemail.js

@@ -61,6 +61,9 @@ export default class Voicemail {
   }
 
   static parseMany(plain: Response): Array<Voicemail> {
+    if (!plain) {
+      return [];
+    }
     const plainUnread = plain.folders.filter(folder => folder.type === 'new')[0].messages;
     const plainRead = plain.folders.filter(folder => folder.type === 'old')[0].messages;