@wazo/sdk 0.38.6 → 0.38.9

package/src/domain/MeetingAuthorization.js

@@ -0,0 +1,67 @@
+// @flow
+
+export type RawMeetingAuthorization = {
+  created_at: string,
+  meeting_uuid: string,
+  uuid: string,
+  guest_uuid: string,
+  guest_name: string,
+}
+
+export const PENDING = 'pending';
+export const ACCEPTED = 'accepted';
+export const REJECTED = 'rejected';
+export const POST_PROCESSING = 'post_processing';
+export const POST_PROCESSED_SUCCESS = 'post_processed_success';
+export const POST_PROCESSED_ERROR = 'post_processed_error';
+
+export default class MeetingAuthorization {
+  meetingUuid: string;
+  uuid: string;
+  userUuid: string;
+  userName: string;
+  status: string;
+
+  constructor({
+    meetingUuid,
+    uuid,
+    userUuid,
+    userName,
+  }: Object = {}) {
+    this.meetingUuid = meetingUuid;
+    this.uuid = uuid;
+    this.userUuid = userUuid;
+    this.userName = userName;
+  }
+
+  setStatus(status: string) {
+    this.status = status;
+  }
+
+  getStatus() {
+    return this.status;
+  }
+
+  static parse(plain: RawMeetingAuthorization) {
+    const {
+      meeting_uuid: meetingUuid,
+      uuid,
+      guest_uuid: userUuid,
+      guest_name: userName,
+    } = plain;
+
+    return new MeetingAuthorization({
+      meetingUuid,
+      uuid,
+      userUuid,
+      userName,
+    });
+  }
+
+  static parseMany(items: RawMeetingAuthorization[]): Array<MeetingAuthorization> {
+    if (!items) {
+      return [];
+    }
+    return items.map(MeetingAuthorization.parse);
+  }
+}

package/src/domain/Phone/WebRTCPhone.js

@@ -531,9 +531,7 @@ export default class WebRTCPhone extends Emitter implements Phone {
 
     try {
       if (this.currentScreenShare.stream) {
-        this.currentScreenShare.stream.getTracks()
-          .filter(track => track.kind === 'video')
-          .forEach(track => track.stop());
+        this.currentScreenShare.stream.getTracks().forEach(track => track.stop());
       }
 
       if (restoreLocalStream) {

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

@@ -1,9 +1,76 @@
 // @flow
 /* global btoa */
 
+import moment from 'moment';
 import Meeting from '../Meeting';
 
+const rawCreationTime = '2021-12-21T15:56:42.880Z';
+
 describe('Meeting domain', () => {
+  it('should retain its values when parsed', () => {
+    const args = {
+      guest_sip_authorization: 'some-guest-sip-authorization',
+      ingress_http_uri: 'some-uri',
+      name: 'some-name',
+      owner_uuids: ['some-owner-uuid'],
+      port: 'some-port',
+      uuid: 'some-uuid',
+      exten: 'some-exten',
+      persistent: true,
+      creation_time: rawCreationTime,
+      require_authorization: true,
+    };
+
+    const meeting = Meeting.parse(args);
+    const {
+      uri,
+      uuid,
+      name,
+      port,
+      extension,
+      persistent,
+      ownerUuids,
+      creationTime,
+      requireAuthorization,
+    } = meeting;
+
+    expect(uri).toEqual(args.ingress_http_uri);
+    expect(uuid).toEqual(args.uuid);
+    expect(name).toEqual(args.name);
+    expect(port).toEqual(args.port);
+    expect(extension).toEqual(args.exten);
+    expect(persistent).toEqual(args.persistent);
+    expect(ownerUuids).toEqual(args.owner_uuids);
+    expect(creationTime).toEqual(moment(rawCreationTime).toDate());
+    expect(requireAuthorization).toEqual(args.require_authorization);
+  });
+
+  it('should retain its values when instantiated', () => {
+    const keys = [
+      'uuid',
+      'name',
+      'guestSipAuthorization',
+      'ownerUuids',
+      'port',
+      'uri',
+      'extension',
+      'persistent',
+      'creationTime',
+      'requireAuthorization',
+    ];
+
+    const args = keys.reduce((acc, key) => {
+      acc[key] = `some-${key}`;
+      return acc;
+    }, {});
+
+    const meeting = new Meeting(args);
+
+    keys.forEach(key =>
+      // $FlowFixMe
+      expect(meeting[key]).toEqual(`some-${key}`));
+  });
+
   it('can return username and secret from an base64 encrypted string', () => {
     const USERNAME = 'username';
     const SECRET = 'secret';
@@ -18,6 +85,7 @@ describe('Meeting domain', () => {
       uuid: '',
       exten: '',
       persistent: false,
+      require_authorization: false,
     };
 
     const meeting = Meeting.parse(args);
@@ -30,7 +98,7 @@ describe('Meeting domain', () => {
 
   it('should return a date from a string', () => {
     const args = {
-      creation_time: '2021-12-21T15:56:42.880Z',
+      creation_time: rawCreationTime,
       guest_sip_authorization: '',
       ingress_http_uri: '',
       name: '',
@@ -39,6 +107,7 @@ describe('Meeting domain', () => {
       uuid: '',
       exten: '',
       persistent: false,
+      require_authorization: false,
     };
 
     const { creationTime } = Meeting.parse(args);

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

@@ -0,0 +1,58 @@
+import MeetingAuthorization from '../MeetingAuthorization';
+
+describe('MeetingAuthorization', () => {
+  describe('parse', () => {
+    it('should parse a raw input', () => {
+      const rawAuthorization = {
+        created_at: 'today',
+        meeting_uuid: 'meeting_uuid',
+        uuid: 'uuid',
+        guest_uuid: 'guest_uuid',
+        guest_name: 'guest_name',
+      };
+
+      const authorization = {
+        meetingUuid: rawAuthorization.meeting_uuid,
+        uuid: rawAuthorization.uuid,
+        userUuid: rawAuthorization.guest_uuid,
+        userName: rawAuthorization.guest_name,
+        status: undefined,
+      };
+
+      const response = MeetingAuthorization.parse(rawAuthorization);
+      expect(response).toEqual(authorization);
+    });
+  });
+
+  describe('parseMany', () => {
+    it('should parse multiple raw inputs', () => {
+      const rawAuthorizations = [
+        {
+          created_at: 'today1',
+          meeting_uuid: 'meeting_uuid1',
+          uuid: 'uuid1',
+          guest_uuid: 'guest_uuid1',
+          guest_name: 'guest_name1',
+        },
+        {
+          created_at: 'today2',
+          meeting_uuid: 'meeting_uuid2',
+          uuid: 'uuid2',
+          guest_uuid: 'guest_uuid2',
+          guest_name: 'guest_name2',
+        },
+      ];
+
+      const authorizations = rawAuthorizations.map(rawAuthorization => ({
+        meetingUuid: rawAuthorization.meeting_uuid,
+        uuid: rawAuthorization.uuid,
+        userUuid: rawAuthorization.guest_uuid,
+        userName: rawAuthorization.guest_name,
+        status: undefined,
+      }));
+
+      const response = MeetingAuthorization.parseMany(rawAuthorizations);
+      expect(response).toEqual(authorizations);
+    });
+  });
+});

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;
 
@@ -141,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/room/Participant.js

@@ -4,6 +4,7 @@ import IssueReporter from '../../service/IssueReporter';
 
 import Room, { SIGNAL_TYPE_PARTICIPANT_UPDATE } from './Room';
 import Contact from '../../domain/Contact';
+import getApiClient from '../../service/getApiClient';
 
 const logger = IssueReporter.loggerFor('room');
 
@@ -20,6 +21,7 @@ class Participant extends Emitter {
   videoMuted: boolean;
   screensharing: boolean;
   isOnHold: boolean;
+  banned: boolean;
   extra: Object;
 
   ON_UPDATED: string;
@@ -37,6 +39,7 @@ class Participant extends Emitter {
   ON_EXTRA_CHANGE: string;
   ON_HOLD: string;
   ON_RESUME: string;
+  ON_BAN: string;
 
   /**
    * @param room Room The room where the participant is
@@ -60,6 +63,7 @@ class Participant extends Emitter {
     this.screensharing = false;
     this.isOnHold = false;
     this.extra = extra;
+    this.banned = false;
 
     this.ON_UPDATED = 'participant/ON_UPDATED';
     this.ON_START_TALKING = 'participant/ON_START_TALKING';
@@ -76,6 +80,7 @@ class Participant extends Emitter {
     this.ON_EXTRA_CHANGE = 'participant/ON_EXTRA_CHANGE';
     this.ON_HOLD = 'participant/ON_HOLD';
     this.ON_RESUME = 'participant/ON_RESUME';
+    this.ON_BAN = 'participant/ON_BAN';
   }
 
   triggerEvent(name: string, ...args: any[]) {
@@ -116,6 +121,10 @@ class Participant extends Emitter {
         status.extra = this.extra;
         break;
       }
+      case this.ON_BAN: {
+        status.banned = true;
+        break;
+      }
       default:
         break;
     }
@@ -220,6 +229,11 @@ class Participant extends Emitter {
     this.triggerUpdate(this.ON_RESUME, broadcast);
   }
 
+  onBan(broadcast: boolean = true) {
+    this.banned = true;
+    this.triggerUpdate(this.ON_BAN, broadcast);
+  }
+
   getStatus() {
     return {
       callId: this.callId,
@@ -266,6 +280,10 @@ class Participant extends Emitter {
       }
     }
 
+    if (status.banned) {
+      this.onBan(false);
+    }
+
     // Poor man's object comparison
     if (typeof status.extra !== 'undefined' && JSON.stringify(this.extra) !== JSON.stringify(status.extra)) {
       this.extra = { ...this.extra, ...status.extra };
@@ -293,6 +311,28 @@ class Participant extends Emitter {
     this.streams = streams;
     this.videoStreams = streams;
   }
+
+  async ban(apiRequestDelay: ?number = null) {
+    const { meetingUuid } = this.room;
+    if (!meetingUuid) {
+      throw new Error('Attempting to ban a participant without a `meetingUuid`');
+    }
+
+    // this notifies all that someone is being banned
+    this.onBan(true);
+
+    // this allows to delay the actual ban, in order for the banned participant as well as others to react to the situation
+    if (apiRequestDelay) {
+      await this.delay(apiRequestDelay);
+    }
+
+    // proceed with the actual kick
+    return getApiClient().calld.banMeetingParticipant(meetingUuid, this.callId);
+  }
+
+  async delay(ms: number) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+  }
 }
 
 export default Participant;

package/src/simple/room/Room.js

@@ -143,7 +143,7 @@ class Room extends Emitter {
     logger.info('connecting to room', { extension, audioOnly, room: !!room });
 
     if (!room) {
-      await Wazo.Phone.connect();
+      await Wazo.Phone.connect({ media: constraints });
 
       const withCamera = constraints && !!constraints.video;
 
@@ -590,7 +590,7 @@ class Room extends Emitter {
         const participant: ?Participant = this._getParticipantFromCallId(status.callId);
 
         if (participant) {
-          // we're received, so no need to broadcast, hence the input false arg
+          // we're receiving, so no need to broadcast
           participant.updateStatus(status, false);
         }
         break;

package/src/simple/room/SipRoom.js

@@ -13,7 +13,7 @@ class SipRoom extends Room {
     logger.info('connecting to sip room', { extension, audioOnly, room: !!room });
 
     if (!room) {
-      await Wazo.Phone.connect();
+      await Wazo.Phone.connect({ media: constraints });
 
       const withCamera = constraints && !!constraints.video;
 

package/src/simple/room/__tests__/Participant.test.js

@@ -0,0 +1,81 @@
+// Using directly Wazo to avoid issues with require cycle
+import getApiClient from '../../../service/getApiClient';
+import Wazo from '../../index';
+import Room from '../Room';
+
+jest.mock('../../../service/getApiClient');
+
+describe('Participant', () => {
+  describe('ban', () => {
+    it('should throw an error when there is no meeting', async () => {
+      const room = new Room();
+      const participant = new Wazo.RemoteParticipant(room, {
+        call_id: 'id',
+        caller_id_name: 'Alice',
+        caller_id_number: 'number',
+      });
+
+      await expect(async () => participant.ban())
+        .rejects.toThrow('Attempting to ban a participant without a `meetingUuid`');
+    });
+
+    it('should call the api', async () => {
+      const number = '1234';
+      const meetingUuid = 'some-meeting-uuid';
+      const callId = 'some-call-id';
+      const room = new Room();
+      room.setMeetingUuid(meetingUuid);
+
+      const banMeetingParticipant = jest.fn();
+
+      getApiClient.mockImplementation(() => ({
+        calld: {
+          banMeetingParticipant,
+        },
+      }));
+
+      const participant = new Wazo.RemoteParticipant(room, {
+        call_id: callId,
+        caller_id_name: 'Alice',
+        caller_id_number: number,
+      });
+
+      participant.onBan = jest.fn();
+
+      await participant.ban();
+      expect(banMeetingParticipant).toHaveBeenCalledWith(meetingUuid, callId);
+      expect(participant.onBan).toHaveBeenCalledWith(true);
+    });
+
+    it('should call the api with a delay', async () => {
+      const number = '1234';
+      const meetingUuid = 'some-meeting-uuid';
+      const callId = 'some-call-id';
+      const someDelay = 2;
+      const room = new Room();
+      room.setMeetingUuid(meetingUuid);
+
+      const banMeetingParticipant = jest.fn();
+
+      getApiClient.mockImplementation(() => ({
+        calld: {
+          banMeetingParticipant,
+        },
+      }));
+
+      const participant = new Wazo.RemoteParticipant(room, {
+        call_id: callId,
+        caller_id_name: 'Alice',
+        caller_id_number: number,
+      });
+
+      participant.delay = jest.fn();
+      participant.onBan = jest.fn();
+
+      await participant.ban(someDelay);
+      expect(banMeetingParticipant).toHaveBeenCalledWith(meetingUuid, callId);
+      expect(participant.delay).toHaveBeenCalledWith(someDelay);
+      expect(participant.onBan).toHaveBeenCalledWith(true);
+    });
+  });
+});

package/src/types/WebSocketMessage.js

@@ -8,6 +8,7 @@ import type {
 import type { ChatMessageResponse } from '../domain/ChatMessage';
 import ChatRoom from '../domain/ChatRoom';
 import Meeting from '../domain/Meeting';
+import type MeetingAuthorization from '../domain/MeetingAuthorization';
 
 type WebSocketBaseMessage = {
   op: string,
@@ -189,6 +190,10 @@ type AgentPaused = WebSocketBaseMessage & { data: any, name: 'agent_paused' };
 type AgentUnpaused = WebSocketBaseMessage & { data: any, name: 'agent_unpaused' };
 
 type MeetingUserProgress = WebSocketBaseMessage & { data: Meeting, name: 'meeting_user_progress' };
+type MeetingAuthorizationPending = WebSocketBaseMessage & {
+  data: MeetingAuthorization,
+  name: 'meeting_authorization_pending'
+};
 
 export type WebSocketMessage =
   | CallCreated
@@ -223,4 +228,5 @@ export type WebSocketMessage =
   | AgentStatusUpdate
   | AgentPaused
   | AgentUnpaused
-  | MeetingUserProgress;
+  | MeetingUserProgress
+  | MeetingAuthorizationPending;

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

@@ -0,0 +1,35 @@
+// @flow
+import { convertKeysFromCamelToUnderscore } from '../object';
+
+describe('object utils', () => {
+  describe('convertKeysFromCamelToUnderscore', () => {
+    it('should throw an error when input is not an object', () => {
+      const msg = 'Input is not an object';
+      expect(() => convertKeysFromCamelToUnderscore(true)).toThrow(msg);
+      expect(() => convertKeysFromCamelToUnderscore(null)).toThrow(msg);
+      expect(() => convertKeysFromCamelToUnderscore(undefined)).toThrow(msg);
+      expect(() => convertKeysFromCamelToUnderscore([])).toThrow(msg);
+      expect(() => convertKeysFromCamelToUnderscore('some-string')).toThrow(msg);
+    });
+
+    it('should convert camel-cased keys to underscore', () => {
+      let value = Math.random();
+      expect(convertKeysFromCamelToUnderscore({ LoremIpsum: value })).toEqual({ lorem_ipsum: value });
+      value = Math.random();
+      expect(convertKeysFromCamelToUnderscore({ loremIpsum: value })).toEqual({ lorem_ipsum: value });
+      value = Math.random();
+      expect(convertKeysFromCamelToUnderscore({ 'lorem-ipsum': value })).toEqual({ 'lorem-ipsum': value });
+      value = Math.random();
+      expect(convertKeysFromCamelToUnderscore({ L123: value })).toEqual({ l123: value });
+    });
+
+    it('should handle multi-leveled object', () => {
+      const value = Math.random();
+      expect(convertKeysFromCamelToUnderscore({ LoremIpsum: { DoloreSit: { Amet: value }, regular: 'reg' } }))
+        .toEqual({ lorem_ipsum: { dolore_sit: { amet: value }, regular: 'reg' } });
+
+      expect(convertKeysFromCamelToUnderscore({ LoremIpsum: { DoloreSit: { Amet: [value] }, regular: ['something'] } }))
+        .toEqual({ lorem_ipsum: { dolore_sit: { amet: [value] }, regular: ['something'] } });
+    });
+  });
+});

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/__tests__/string.test.js

@@ -0,0 +1,23 @@
+import { camelToUnderscore } from '../string';
+
+describe('string utils', () => {
+  describe('camelToUnderscore', () => {
+    it('', () => {
+      expect(() => camelToUnderscore(null)).toThrow('Input is not a string');
+      expect(() => camelToUnderscore(undefined)).toThrow('Input is not a string');
+      expect(() => camelToUnderscore({})).toThrow('Input is not a string');
+      expect(() => camelToUnderscore([])).toThrow('Input is not a string');
+    });
+
+    it('should convert camel-cased string to underscore', () => {
+      expect(camelToUnderscore('loremIpsum')).toEqual('lorem_ipsum');
+      expect(camelToUnderscore('lorem-ipsum')).toEqual('lorem-ipsum');
+      expect(camelToUnderscore('')).toEqual('');
+    });
+
+    it('should not prefix string with an underscore', () => {
+      expect(camelToUnderscore('LoremIpsum')).toEqual('lorem_ipsum');
+      expect(camelToUnderscore('L123')).toEqual('l123');
+    });
+  });
+});

package/src/utils/object.js

@@ -0,0 +1,15 @@
+// @flow
+
+import { camelToUnderscore } from './string';
+
+export const convertKeysFromCamelToUnderscore = (args: Object) => {
+  if (!args || typeof args !== 'object' || Array.isArray(args)) {
+    throw new Error('Input is not an object');
+  }
+
+  return Object.keys(args).reduce((acc, key) => {
+    acc[camelToUnderscore(key)] = typeof args[key] === 'object' && !Array.isArray(args[key])
+      ? convertKeysFromCamelToUnderscore(args[key]) : args[key];
+    return acc;
+  }, {});
+};

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/utils/string.js

@@ -0,0 +1,8 @@
+// @flow
+
+export const camelToUnderscore = (key: string) => {
+  if (typeof key !== 'string') {
+    throw new Error('Input is not a string');
+  }
+  return key.charAt(0).toLowerCase() + key.substring(1).replace(/([A-Z])/g, '_$1').toLowerCase();
+};