@wazo/sdk 0.38.4 → 0.38.7

package/esm/simple/room/__tests__/RemoteParticipant.test.js

@@ -3071,6 +3071,7 @@ const RECORD_STATE_ACTIVE = 'active';
                            
                  
                      
+                     
                    
                         
                    
@@ -3081,6 +3082,7 @@ const RECORD_STATE_ACTIVE = 'active';
 
                       
              
+                    
                     
                     
                      
@@ -3109,6 +3111,7 @@ class Call {
                           
                   
                     
+                   
                   
                  
                  
@@ -3133,6 +3136,7 @@ class Call {
       calleeNumber: plain.peer_caller_id_number,
       dialedExtension: plain.dialed_extension,
       isCaller: plain.is_caller,
+      isVideo: plain.is_video,
       muted: plain.muted,
       onHold: plain.on_hold,
       status: plain.status,
@@ -3156,6 +3160,7 @@ class Call {
     calleeNumber,
     dialedExtension,
     isCaller,
+    isVideo,
     lineId,
     muted,
     onHold,
@@ -3179,6 +3184,7 @@ class Call {
     this.startingTime = startingTime;
     this.talkingToIds = talkingToIds || [];
     this.recording = recording;
+    this.isVideo = !!isVideo;
 
     // Useful to compare instead of instanceof with minified code
     this.type = 'Call';
@@ -3652,7 +3658,7 @@ class CallSession {
       ringing: call.isRinging(),
       answered: call.isUp(),
       answeredBySystem: call.isUp() && call.talkingToIds.length === 0,
-      cameraEnabled: false,
+      cameraEnabled: call.isVideo,
       dialedExtension: call.dialedExtension,
       call,
       conference: false, // @FIXME?
@@ -6198,6 +6204,24 @@ const fixSdp = (sdp        , candidates          , forcePort          = true)
   return fixed;
 };
 
+const addIcesInAllBundles = (sdp        ) => {
+  const parsedSdp = sdpParser.parse(sdp);
+
+  const mediaWithCandidate = parsedSdp.media.find(media => !!media.candidates);
+  if (!mediaWithCandidate) {
+    return sdp;
+  }
+
+  const { candidates } = mediaWithCandidate;
+
+  parsedSdp.media = parsedSdp.media.map(media => ({
+    ...media,
+    candidates: media.candidates || candidates,
+  }));
+
+  return sdpParser.write(parsedSdp);
+};
+
 /* global RTCSessionDescriptionInit, navigator */
 
 const wazoLogger = IssueReporter$1 ? IssueReporter$1.loggerFor('webrtc-sdh') : console;
@@ -6296,6 +6320,14 @@ class WazoSessionDescriptionHandler extends SessionDescriptionHandler {
       wazoLogger.trace('onicecandidate', event.candidate ? event.candidate.candidate : { done: true });
       if (event.candidate) {
         this.gatheredCandidates.push(parseCandidate$1(event.candidate.candidate));
+
+        // When receiving a `srflx` or a `relay` candidate, consider the negotiation done.
+        if (event.candidate.candidate.indexOf('srflx') !== -1 || event.candidate.candidate.indexOf('relay') !== -1) {
+          wazoLogger.info('A valid ice was found, triggering ice gathering complete callback.', {
+            ice: event.candidate.candidate,
+          });
+          this.iceGatheringComplete();
+        }
       }
     };
 
@@ -6319,7 +6351,10 @@ class WazoSessionDescriptionHandler extends SessionDescriptionHandler {
 
         // Check if we got ICEs
         if (sdp.indexOf('a=candidate') !== -1) {
-          return description;
+          return {
+            type: description.type,
+            sdp: addIcesInAllBundles(sdp),
+          };
         }
 
         wazoLogger.info('No ICE candidates found in SDP, fixing it with gathered ices', this.gatheredCandidates);
@@ -7779,11 +7814,11 @@ class WebRTCClient extends Emitter {
     });
   }
 
-  changeAudioInputDevice(id        , session          ) {
+  changeAudioInputDevice(id        , session          , force          ) {
     const currentId = this.getAudioDeviceId();
     logger$8.info('setting audio input device', { id, currentId, session: !!session });
 
-    if (id === currentId) {
+    if (!force && id === currentId) {
       return null;
     }
 
@@ -9579,10 +9614,10 @@ class WebRTCPhone extends Emitter                  {
     this.audioRingVolume = volume;
   }
 
-  changeAudioInputDevice(id        ) {
+  changeAudioInputDevice(id        , force          ) {
     logger$7.info('WebRTC phone - changeAudio input device', { deviceId: id });
 
-    return this.client.changeAudioInputDevice(id, this.currentSipSession);
+    return this.client.changeAudioInputDevice(id, this.currentSipSession, force);
   }
 
   changeVideoInputDevice(id         ) {
@@ -14091,8 +14126,7 @@ class Softphone {
     window.addEventListener('message', this._onMessage.bind(this), false);
 
     if (!server) {
-      // eslint-disable-next-line no-param-reassign
-      server = 'stack.dev.wazo.io';
+      throw new Error('`server` is not set');
     }
 
     const config         = { server };

package/esm/simple/utils.js

@@ -3071,6 +3071,7 @@ const RECORD_STATE_ACTIVE = 'active';
                            
                  
                      
+                     
                    
                         
                    
@@ -3081,6 +3082,7 @@ const RECORD_STATE_ACTIVE = 'active';
 
                       
              
+                    
                     
                     
                      
@@ -3109,6 +3111,7 @@ class Call {
                           
                   
                     
+                   
                   
                  
                  
@@ -3133,6 +3136,7 @@ class Call {
       calleeNumber: plain.peer_caller_id_number,
       dialedExtension: plain.dialed_extension,
       isCaller: plain.is_caller,
+      isVideo: plain.is_video,
       muted: plain.muted,
       onHold: plain.on_hold,
       status: plain.status,
@@ -3156,6 +3160,7 @@ class Call {
     calleeNumber,
     dialedExtension,
     isCaller,
+    isVideo,
     lineId,
     muted,
     onHold,
@@ -3179,6 +3184,7 @@ class Call {
     this.startingTime = startingTime;
     this.talkingToIds = talkingToIds || [];
     this.recording = recording;
+    this.isVideo = !!isVideo;
 
     // Useful to compare instead of instanceof with minified code
     this.type = 'Call';
@@ -3652,7 +3658,7 @@ class CallSession {
       ringing: call.isRinging(),
       answered: call.isUp(),
       answeredBySystem: call.isUp() && call.talkingToIds.length === 0,
-      cameraEnabled: false,
+      cameraEnabled: call.isVideo,
       dialedExtension: call.dialedExtension,
       call,
       conference: false, // @FIXME?
@@ -6198,6 +6204,24 @@ const fixSdp = (sdp        , candidates          , forcePort          = true)
   return fixed;
 };
 
+const addIcesInAllBundles = (sdp        ) => {
+  const parsedSdp = sdpParser.parse(sdp);
+
+  const mediaWithCandidate = parsedSdp.media.find(media => !!media.candidates);
+  if (!mediaWithCandidate) {
+    return sdp;
+  }
+
+  const { candidates } = mediaWithCandidate;
+
+  parsedSdp.media = parsedSdp.media.map(media => ({
+    ...media,
+    candidates: media.candidates || candidates,
+  }));
+
+  return sdpParser.write(parsedSdp);
+};
+
 /* global RTCSessionDescriptionInit, navigator */
 
 const wazoLogger = IssueReporter$1 ? IssueReporter$1.loggerFor('webrtc-sdh') : console;
@@ -6296,6 +6320,14 @@ class WazoSessionDescriptionHandler extends SessionDescriptionHandler {
       wazoLogger.trace('onicecandidate', event.candidate ? event.candidate.candidate : { done: true });
       if (event.candidate) {
         this.gatheredCandidates.push(parseCandidate$1(event.candidate.candidate));
+
+        // When receiving a `srflx` or a `relay` candidate, consider the negotiation done.
+        if (event.candidate.candidate.indexOf('srflx') !== -1 || event.candidate.candidate.indexOf('relay') !== -1) {
+          wazoLogger.info('A valid ice was found, triggering ice gathering complete callback.', {
+            ice: event.candidate.candidate,
+          });
+          this.iceGatheringComplete();
+        }
       }
     };
 
@@ -6319,7 +6351,10 @@ class WazoSessionDescriptionHandler extends SessionDescriptionHandler {
 
         // Check if we got ICEs
         if (sdp.indexOf('a=candidate') !== -1) {
-          return description;
+          return {
+            type: description.type,
+            sdp: addIcesInAllBundles(sdp),
+          };
         }
 
         wazoLogger.info('No ICE candidates found in SDP, fixing it with gathered ices', this.gatheredCandidates);
@@ -7779,11 +7814,11 @@ class WebRTCClient extends Emitter {
     });
   }
 
-  changeAudioInputDevice(id        , session          ) {
+  changeAudioInputDevice(id        , session          , force          ) {
     const currentId = this.getAudioDeviceId();
     logger$8.info('setting audio input device', { id, currentId, session: !!session });
 
-    if (id === currentId) {
+    if (!force && id === currentId) {
       return null;
     }
 
@@ -9579,10 +9614,10 @@ class WebRTCPhone extends Emitter                  {
     this.audioRingVolume = volume;
   }
 
-  changeAudioInputDevice(id        ) {
+  changeAudioInputDevice(id        , force          ) {
     logger$7.info('WebRTC phone - changeAudio input device', { deviceId: id });
 
-    return this.client.changeAudioInputDevice(id, this.currentSipSession);
+    return this.client.changeAudioInputDevice(id, this.currentSipSession, force);
   }
 
   changeVideoInputDevice(id         ) {
@@ -14075,8 +14110,7 @@ class Softphone {
     window.addEventListener('message', this._onMessage.bind(this), false);
 
     if (!server) {
-      // eslint-disable-next-line no-param-reassign
-      server = 'stack.dev.wazo.io';
+      throw new Error('`server` is not set');
     }
 
     const config         = { server };

package/esm/utils/__tests__/sdp.test.js

@@ -98,6 +98,24 @@ const fixSdp = (sdp        , candidates          , forcePort          = true)
   return fixed;
 };
 
+const addIcesInAllBundles = (sdp        ) => {
+  const parsedSdp = sdpParser.parse(sdp);
+
+  const mediaWithCandidate = parsedSdp.media.find(media => !!media.candidates);
+  if (!mediaWithCandidate) {
+    return sdp;
+  }
+
+  const { candidates } = mediaWithCandidate;
+
+  parsedSdp.media = parsedSdp.media.map(media => ({
+    ...media,
+    candidates: media.candidates || candidates,
+  }));
+
+  return sdpParser.write(parsedSdp);
+};
+
 /* eslint-disable max-len */
 
 const goodSdp = `
@@ -262,4 +280,36 @@ describe('SDP utils', () => {
       expect(hasAnActiveVideo(inactiveVideo)).toBeFalsy();
     });
   });
+
+  describe('Adding candidate in all bundles ', () => {
+    it('should add candidate everywhere', async () => {
+      const audioWithoutCandidate = `
+c=IN IP4 203.0.113.1
+m=audio 54400 RTP/SAVPF 0 96
+m=video 54400 RTP/SAVPF 0 96
+a=candidate:0 1 UDP 2113667327 203.0.113.1 54400 typ host
+a=candidate:3996450952 1 udp 41819903 14.72.21.2 65092 typ relay raddr 0.0.0.0 rport 0 generation 0 network-id 3 network-cost 10
+`;
+      const fixedAudioWithoutCandidate = sdpParser.parse(addIcesInAllBundles(audioWithoutCandidate));
+
+      expect(fixedAudioWithoutCandidate.media[0].candidates[0].type).toBe('host');
+      expect(fixedAudioWithoutCandidate.media[0].candidates[1].type).toBe('relay');
+      expect(fixedAudioWithoutCandidate.media[1].candidates[0].type).toBe('host');
+      expect(fixedAudioWithoutCandidate.media[1].candidates[1].type).toBe('relay');
+
+      // It should not add candidate if already present
+      const audioWithCandidate = `
+c=IN IP4 203.0.113.1
+m=audio 54400 RTP/SAVPF 0 96
+a=candidate:0 1 UDP 2113667327 203.0.113.1 54400 typ srflx
+
+m=video 54400 RTP/SAVPF 0 96
+a=candidate:0 1 UDP 2113667327 203.0.113.1 54400 typ host
+`;
+      const fixedAudioWithCandidate = sdpParser.parse(addIcesInAllBundles(audioWithCandidate));
+
+      expect(fixedAudioWithCandidate.media[0].candidates[0].type).toBe('srflx');
+      expect(fixedAudioWithCandidate.media[1].candidates[0].type).toBe('host');
+    });
+  });
 });

package/esm/utils/sdp.js

@@ -122,4 +122,22 @@ const fixSdp = (sdp        , candidates          , forcePort          = true)
   return fixed;
 };
 
-export { activateVideoModifier, areCandidateValid, deactivateVideoModifier, fixBundle, fixSdp, getCandidates, getVideoDirection, hasAnActiveVideo, isSdpValid, parseCandidate, toggleVideoDirection };
+const addIcesInAllBundles = (sdp        ) => {
+  const parsedSdp = sdpParser.parse(sdp);
+
+  const mediaWithCandidate = parsedSdp.media.find(media => !!media.candidates);
+  if (!mediaWithCandidate) {
+    return sdp;
+  }
+
+  const { candidates } = mediaWithCandidate;
+
+  parsedSdp.media = parsedSdp.media.map(media => ({
+    ...media,
+    candidates: media.candidates || candidates,
+  }));
+
+  return sdpParser.write(parsedSdp);
+};
+
+export { activateVideoModifier, addIcesInAllBundles, areCandidateValid, deactivateVideoModifier, fixBundle, fixSdp, getCandidates, getVideoDirection, hasAnActiveVideo, isSdpValid, parseCandidate, toggleVideoDirection };

package/esm/web-rtc-client.js

@@ -778,6 +778,24 @@ const fixSdp = (sdp        , candidates          , forcePort          = true)
   return fixed;
 };
 
+const addIcesInAllBundles = (sdp        ) => {
+  const parsedSdp = sdpParser.parse(sdp);
+
+  const mediaWithCandidate = parsedSdp.media.find(media => !!media.candidates);
+  if (!mediaWithCandidate) {
+    return sdp;
+  }
+
+  const { candidates } = mediaWithCandidate;
+
+  parsedSdp.media = parsedSdp.media.map(media => ({
+    ...media,
+    candidates: media.candidates || candidates,
+  }));
+
+  return sdpParser.write(parsedSdp);
+};
+
 /* global RTCSessionDescriptionInit, navigator */
 
 const wazoLogger = IssueReporter$1 ? IssueReporter$1.loggerFor('webrtc-sdh') : console;
@@ -876,6 +894,14 @@ class WazoSessionDescriptionHandler extends SessionDescriptionHandler {
       wazoLogger.trace('onicecandidate', event.candidate ? event.candidate.candidate : { done: true });
       if (event.candidate) {
         this.gatheredCandidates.push(parseCandidate(event.candidate.candidate));
+
+        // When receiving a `srflx` or a `relay` candidate, consider the negotiation done.
+        if (event.candidate.candidate.indexOf('srflx') !== -1 || event.candidate.candidate.indexOf('relay') !== -1) {
+          wazoLogger.info('A valid ice was found, triggering ice gathering complete callback.', {
+            ice: event.candidate.candidate,
+          });
+          this.iceGatheringComplete();
+        }
       }
     };
 
@@ -899,7 +925,10 @@ class WazoSessionDescriptionHandler extends SessionDescriptionHandler {
 
         // Check if we got ICEs
         if (sdp.indexOf('a=candidate') !== -1) {
-          return description;
+          return {
+            type: description.type,
+            sdp: addIcesInAllBundles(sdp),
+          };
         }
 
         wazoLogger.info('No ICE candidates found in SDP, fixing it with gathered ices', this.gatheredCandidates);
@@ -3599,6 +3628,7 @@ const RECORD_STATE_ACTIVE = 'active';
                            
                  
                      
+                     
                    
                         
                    
@@ -3609,6 +3639,7 @@ const RECORD_STATE_ACTIVE = 'active';
 
                       
              
+                    
                     
                     
                      
@@ -3637,6 +3668,7 @@ class Call {
                           
                   
                     
+                   
                   
                  
                  
@@ -3661,6 +3693,7 @@ class Call {
       calleeNumber: plain.peer_caller_id_number,
       dialedExtension: plain.dialed_extension,
       isCaller: plain.is_caller,
+      isVideo: plain.is_video,
       muted: plain.muted,
       onHold: plain.on_hold,
       status: plain.status,
@@ -3684,6 +3717,7 @@ class Call {
     calleeNumber,
     dialedExtension,
     isCaller,
+    isVideo,
     lineId,
     muted,
     onHold,
@@ -3707,6 +3741,7 @@ class Call {
     this.startingTime = startingTime;
     this.talkingToIds = talkingToIds || [];
     this.recording = recording;
+    this.isVideo = !!isVideo;
 
     // Useful to compare instead of instanceof with minified code
     this.type = 'Call';
@@ -6409,11 +6444,11 @@ class WebRTCClient extends Emitter {
     });
   }
 
-  changeAudioInputDevice(id        , session          ) {
+  changeAudioInputDevice(id        , session          , force          ) {
     const currentId = this.getAudioDeviceId();
     logger.info('setting audio input device', { id, currentId, session: !!session });
 
-    if (id === currentId) {
+    if (!force && id === currentId) {
       return null;
     }
 

package/lib/__tests__/api-client.test.js

@@ -3057,6 +3057,7 @@ const RECORD_STATE_ACTIVE = 'active';
                            
                  
                      
+                     
                    
                         
                    
@@ -3067,6 +3068,7 @@ const RECORD_STATE_ACTIVE = 'active';
 
                       
              
+                    
                     
                     
                      
@@ -3095,6 +3097,7 @@ class Call {
                           
                   
                     
+                   
                   
                  
                  
@@ -3119,6 +3122,7 @@ class Call {
       calleeNumber: plain.peer_caller_id_number,
       dialedExtension: plain.dialed_extension,
       isCaller: plain.is_caller,
+      isVideo: plain.is_video,
       muted: plain.muted,
       onHold: plain.on_hold,
       status: plain.status,
@@ -3142,6 +3146,7 @@ class Call {
     calleeNumber,
     dialedExtension,
     isCaller,
+    isVideo,
     lineId,
     muted,
     onHold,
@@ -3165,6 +3170,7 @@ class Call {
     this.startingTime = startingTime;
     this.talkingToIds = talkingToIds || [];
     this.recording = recording;
+    this.isVideo = !!isVideo;
 
     // Useful to compare instead of instanceof with minified code
     this.type = 'Call';

package/lib/__tests__/web-rtc-client.test.js

@@ -787,6 +787,24 @@ const fixSdp = (sdp        , candidates          , forcePort          = true)
   return fixed;
 };
 
+const addIcesInAllBundles = (sdp        ) => {
+  const parsedSdp = sdpParser__default['default'].parse(sdp);
+
+  const mediaWithCandidate = parsedSdp.media.find(media => !!media.candidates);
+  if (!mediaWithCandidate) {
+    return sdp;
+  }
+
+  const { candidates } = mediaWithCandidate;
+
+  parsedSdp.media = parsedSdp.media.map(media => ({
+    ...media,
+    candidates: media.candidates || candidates,
+  }));
+
+  return sdpParser__default['default'].write(parsedSdp);
+};
+
 /* global RTCSessionDescriptionInit, navigator */
 
 const wazoLogger = IssueReporter$1 ? IssueReporter$1.loggerFor('webrtc-sdh') : console;
@@ -885,6 +903,14 @@ class WazoSessionDescriptionHandler extends sessionDescriptionHandler.SessionDes
       wazoLogger.trace('onicecandidate', event.candidate ? event.candidate.candidate : { done: true });
       if (event.candidate) {
         this.gatheredCandidates.push(parseCandidate(event.candidate.candidate));
+
+        // When receiving a `srflx` or a `relay` candidate, consider the negotiation done.
+        if (event.candidate.candidate.indexOf('srflx') !== -1 || event.candidate.candidate.indexOf('relay') !== -1) {
+          wazoLogger.info('A valid ice was found, triggering ice gathering complete callback.', {
+            ice: event.candidate.candidate,
+          });
+          this.iceGatheringComplete();
+        }
       }
     };
 
@@ -908,7 +934,10 @@ class WazoSessionDescriptionHandler extends sessionDescriptionHandler.SessionDes
 
         // Check if we got ICEs
         if (sdp.indexOf('a=candidate') !== -1) {
-          return description;
+          return {
+            type: description.type,
+            sdp: addIcesInAllBundles(sdp),
+          };
         }
 
         wazoLogger.info('No ICE candidates found in SDP, fixing it with gathered ices', this.gatheredCandidates);
@@ -3608,6 +3637,7 @@ const RECORD_STATE_ACTIVE = 'active';
                            
                  
                      
+                     
                    
                         
                    
@@ -3618,6 +3648,7 @@ const RECORD_STATE_ACTIVE = 'active';
 
                       
              
+                    
                     
                     
                      
@@ -3646,6 +3677,7 @@ class Call {
                           
                   
                     
+                   
                   
                  
                  
@@ -3670,6 +3702,7 @@ class Call {
       calleeNumber: plain.peer_caller_id_number,
       dialedExtension: plain.dialed_extension,
       isCaller: plain.is_caller,
+      isVideo: plain.is_video,
       muted: plain.muted,
       onHold: plain.on_hold,
       status: plain.status,
@@ -3693,6 +3726,7 @@ class Call {
     calleeNumber,
     dialedExtension,
     isCaller,
+    isVideo,
     lineId,
     muted,
     onHold,
@@ -3716,6 +3750,7 @@ class Call {
     this.startingTime = startingTime;
     this.talkingToIds = talkingToIds || [];
     this.recording = recording;
+    this.isVideo = !!isVideo;
 
     // Useful to compare instead of instanceof with minified code
     this.type = 'Call';
@@ -6415,11 +6450,11 @@ class WebRTCClient extends Emitter {
     });
   }
 
-  changeAudioInputDevice(id        , session          ) {
+  changeAudioInputDevice(id        , session          , force          ) {
     const currentId = this.getAudioDeviceId();
     logger.info('setting audio input device', { id, currentId, session: !!session });
 
-    if (id === currentId) {
+    if (!force && id === currentId) {
       return null;
     }
 
@@ -7603,3 +7638,53 @@ describe('WebRTC client', () => {
     expect(client.isAudioMuted(oldKindUnmuted)).toBeFalsy();
   });
 });
+
+describe('changeAudioInputDevice', () => {
+  const defaultId = 'default';
+  const deviceId = 'device1';
+  const constraints = { audio: { deviceId: { exact: defaultId } }, video: null };
+
+  const session = {
+    sessionDescriptionHandler: {
+      peerConnection: {
+        getSenders: () => [{ track: { kind: 'audio', enabled: true } }],
+      },
+    },
+  };
+
+  const stream = {};
+  const getAudioTracksMock = jest.fn(() => []);
+  Object.defineProperty(stream, 'getAudioTracks', {
+    value: getAudioTracksMock,
+  });
+
+  const getUserMediaMock = jest.fn(async () => {
+    return new Promise(resolve => {
+      resolve(stream);
+    });
+  });
+
+  Object.defineProperty(global.navigator, 'mediaDevices', {
+    value: {
+      getUserMedia: getUserMediaMock,
+    },
+  });
+
+  it('should change the audio input track if the provided id is different', async () => {
+    client.setMediaConstraints(constraints);
+    expect(client.getAudioDeviceId()).toBe(defaultId);
+    expect(client.changeAudioInputDevice(deviceId, session)).toBeTruthy();
+  });
+
+  it('should NOT change the audio input track if the provided id is the same', async () => {
+    client.setMediaConstraints(constraints);
+    expect(client.getAudioDeviceId()).toBe(defaultId);
+    expect(client.changeAudioInputDevice(defaultId, session)).toBeFalsy();
+  });
+
+  it('should change the audio input track if the provided id is the same and force param is TRUE', async () => {
+    client.setMediaConstraints(constraints);
+    expect(client.getAudioDeviceId()).toBe(defaultId);
+    expect(client.changeAudioInputDevice(defaultId, session, true)).toBeTruthy();
+  });
+});