@wazo/sdk 0.38.4 → 0.38.7

package/lib/web-rtc-client.js

@@ -789,6 +789,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;
@@ -887,6 +905,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();
+        }
       }
     };
 
@@ -910,7 +936,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);
@@ -3610,6 +3639,7 @@ const RECORD_STATE_ACTIVE = 'active';
                            
                  
                      
+                     
                    
                         
                    
@@ -3620,6 +3650,7 @@ const RECORD_STATE_ACTIVE = 'active';
 
                       
              
+                    
                     
                     
                      
@@ -3648,6 +3679,7 @@ class Call {
                           
                   
                     
+                   
                   
                  
                  
@@ -3672,6 +3704,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,
@@ -3695,6 +3728,7 @@ class Call {
     calleeNumber,
     dialedExtension,
     isCaller,
+    isVideo,
     lineId,
     muted,
     onHold,
@@ -3718,6 +3752,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';
@@ -6420,11 +6455,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/package.json

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

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

@@ -43,3 +43,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();
+  });
+});

package/src/domain/Call.js

@@ -15,6 +15,7 @@ type CallResponse = {
   dialed_extension: string,
   status: string,
   is_caller: boolean,
+  is_video?: boolean,
   line_id: ?number,
   creation_time: string,
   on_hold: boolean,
@@ -27,6 +28,7 @@ type CallArguments = {
   id: string,
   sipCallId: string,
   isCaller: boolean,
+  isVideo?: boolean,
   callerName: string,
   callerNumber: string,
   calleeName: string,
@@ -53,6 +55,7 @@ export default class Call {
   dialedExtension: string;
   lineId: ?number;
   isCaller: boolean;
+  isVideo: boolean;
   onHold: boolean;
   muted: boolean;
   status: string;
@@ -77,6 +80,7 @@ export default 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,
@@ -100,6 +104,7 @@ export default class Call {
     calleeNumber,
     dialedExtension,
     isCaller,
+    isVideo,
     lineId,
     muted,
     onHold,
@@ -123,6 +128,7 @@ export default 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/src/domain/CallSession.js

@@ -390,7 +390,7 @@ export default 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?

package/src/domain/Phone/WebRTCPhone.js

@@ -668,10 +668,10 @@ export default class WebRTCPhone extends Emitter implements Phone {
     this.audioRingVolume = volume;
   }
 
-  changeAudioInputDevice(id: string) {
+  changeAudioInputDevice(id: string, force: ?boolean) {
     logger.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: ?string) {

package/src/domain/__tests__/Line.test.js

@@ -11,7 +11,7 @@ describe('Line domain', () => {
         username: 'ipcor1pj',
         links: [
           {
-            href: 'https://stack.dev.wazo.io/api/confd/1.1/endpoints/sip/19',
+            href: 'https://stack.example.com/api/confd/1.1/endpoints/sip/19',
             rel: 'endpoint_sip',
           },
         ],
@@ -25,7 +25,7 @@ describe('Line domain', () => {
           context: 'default',
           links: [
             {
-              href: 'https://stack.dev.wazo.io/api/confd/1.1/extensions/59',
+              href: 'https://stack.example.com/api/confd/1.1/extensions/59',
               rel: 'extensions',
             },
           ],
@@ -33,7 +33,7 @@ describe('Line domain', () => {
       ],
       links: [
         {
-          href: 'https://stack.dev.wazo.io/api/confd/1.1/lines/8',
+          href: 'https://stack.example.com/api/confd/1.1/lines/8',
           rel: 'lines',
         },
       ],
@@ -51,7 +51,7 @@ describe('Line domain', () => {
             context: 'default',
             links: [
               {
-                href: 'https://stack.dev.wazo.io/api/confd/1.1/extensions/59',
+                href: 'https://stack.example.com/api/confd/1.1/extensions/59',
                 rel: 'extensions',
               },
             ],
@@ -61,7 +61,7 @@ describe('Line domain', () => {
           id: 19,
           links: [
             {
-              href: 'https://stack.dev.wazo.io/api/confd/1.1/endpoints/sip/19',
+              href: 'https://stack.example.com/api/confd/1.1/endpoints/sip/19',
               rel: 'endpoint_sip',
             },
           ],

package/src/lib/WazoSessionDescriptionHandler.js

@@ -12,7 +12,7 @@ import { SessionDescriptionHandler }
 import { SessionDescriptionHandlerOptions }
   from 'sip.js/lib/platform/web/session-description-handler/session-description-handler-options';
 import IssueReporter from '../service/IssueReporter';
-import { fixSdp, parseCandidate } from '../utils/sdp';
+import { addIcesInAllBundles, fixSdp, parseCandidate } from '../utils/sdp';
 
 const wazoLogger = IssueReporter ? IssueReporter.loggerFor('webrtc-sdh') : console;
 
@@ -110,6 +110,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();
+        }
       }
     };
 
@@ -133,7 +141,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);

package/src/simple/Softphone.js

@@ -120,8 +120,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: Object = { server };

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

@@ -9,7 +9,7 @@ import {
   fixSdp,
   fixBundle,
   toggleVideoDirection,
-  hasAnActiveVideo,
+  hasAnActiveVideo, addIcesInAllBundles,
 } from '../sdp';
 
 const goodSdp = `
@@ -174,4 +174,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/src/utils/sdp.js

@@ -120,3 +120,21 @@ export const fixSdp = (sdp: string, candidates: Object[], forcePort: boolean = t
 
   return fixed;
 };
+
+export const addIcesInAllBundles = (sdp: string) => {
+  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);
+};

package/src/web-rtc-client.js

@@ -1070,11 +1070,11 @@ export default class WebRTCClient extends Emitter {
     });
   }
 
-  changeAudioInputDevice(id: string, session: ?Inviter) {
+  changeAudioInputDevice(id: string, session: ?Inviter, force: ?boolean) {
     const currentId = this.getAudioDeviceId();
     logger.info('setting audio input device', { id, currentId, session: !!session });
 
-    if (id === currentId) {
+    if (!force && id === currentId) {
       return null;
     }