@webex/plugin-meetings 1.145.0 → 1.147.0

package/src/media/index.js

@@ -71,13 +71,23 @@ Media.setLocalTrack = (enabled, track) => {
  * @param {string} meetingProperties.remoteQualityLevel LOW|MEDIUM|HIGH
  * @returns {Promise}
  */
-Media.reconnectMedia = (peerConnection, {meetingId, remoteQualityLevel, enableRtx}) => {
+Media.reconnectMedia = (peerConnection, {
+  meetingId,
+  remoteQualityLevel,
+  enableRtx,
+  enableExtmap
+}) => {
   if (peerConnection.connectionState === PEER_CONNECTION_STATE.CLOSED ||
     peerConnection.connectionState === PEER_CONNECTION_STATE.FAILED) {
     return Promise.reject(new ReconnectionError('Reinitiate peerconnection'));
   }
 
-  return PeerConnectionManager.createOffer(peerConnection, {meetingId, remoteQualityLevel, enableRtx});
+  return PeerConnectionManager.createOffer(peerConnection, {
+    meetingId,
+    remoteQualityLevel,
+    enableRtx,
+    enableExtmap
+  });
 };
 
 /**
@@ -165,9 +175,18 @@ Media.checkTracks = (trackType, track, receiveTracks) => {
  * @param {string} meetingProperties.remoteQualityLevel LOW|MEDIUM|HIGH
  * @returns {Array} [peerConnection, ]
  */
-Media.attachMedia = (mediaProperties, {meetingId, remoteQualityLevel, enableRtx}) => {
+Media.attachMedia = (mediaProperties, {
+  meetingId,
+  remoteQualityLevel,
+  enableRtx,
+  enableExtmap
+}) => {
   const {
-    mediaDirection, audioTrack, videoTrack, shareTrack, peerConnection
+    mediaDirection,
+    audioTrack,
+    videoTrack,
+    shareTrack,
+    peerConnection
   } = mediaProperties;
 
   let result = null;
@@ -188,7 +207,12 @@ Media.attachMedia = (mediaProperties, {meetingId, remoteQualityLevel, enableRtx}
     LoggerProxy.logger.info(`Media:index#attachMedia --> onnegotiationneeded#PeerConnection: ${event}`);
   };
 
-  return PeerConnectionManager.createOffer(peerConnection, {meetingId, remoteQualityLevel, enableRtx});
+  return PeerConnectionManager.createOffer(peerConnection, {
+    meetingId,
+    remoteQualityLevel,
+    enableRtx,
+    enableExtmap
+  });
 };
 
 /**
@@ -199,9 +223,18 @@ Media.attachMedia = (mediaProperties, {meetingId, remoteQualityLevel, enableRtx}
  * @param {string} meetingProperties.remoteQualityLevel LOW|MEDIUM|HIGH
  * @returns {Promise}
  */
-Media.updateMedia = (mediaProperties, {meetingId, remoteQualityLevel, enableRtx}) => {
+Media.updateMedia = (mediaProperties, {
+  meetingId,
+  remoteQualityLevel,
+  enableRtx,
+  enableExtmap
+}) => {
   const {
-    mediaDirection, audioTrack, videoTrack, shareTrack, peerConnection
+    mediaDirection,
+    audioTrack,
+    videoTrack,
+    shareTrack,
+    peerConnection
   } = mediaProperties;
 
   // update audio transceiver
@@ -231,7 +264,12 @@ Media.updateMedia = (mediaProperties, {meetingId, remoteQualityLevel, enableRtx}
     LoggerProxy.logger.info(`Media:index#updateMedia --> onnegotiationneeded#PeerConnection: ${event}`);
   };
 
-  return PeerConnectionManager.createOffer(peerConnection, {meetingId, remoteQualityLevel, enableRtx});
+  return PeerConnectionManager.createOffer(peerConnection, {
+    meetingId,
+    remoteQualityLevel,
+    enableRtx,
+    enableExtmap
+  });
 };
 
 /**
@@ -269,10 +307,20 @@ Media.setTrackOnTransceiver = (transceiver, options) => {
  * @param {Object} options see #Media.setTrackOnTransceiver
  * @returns {Promise}
  */
-Media.updateTransceiver = ({meetingId, remoteQualityLevel, enableRtx}, peerConnection, transceiver, options) => {
+Media.updateTransceiver = ({
+  meetingId,
+  remoteQualityLevel,
+  enableRtx,
+  enableExtmap
+}, peerConnection, transceiver, options) => {
   Media.setTrackOnTransceiver(transceiver, options);
 
-  return PeerConnectionManager.createOffer(peerConnection, {meetingId, remoteQualityLevel, enableRtx});
+  return PeerConnectionManager.createOffer(peerConnection, {
+    meetingId,
+    remoteQualityLevel,
+    enableRtx,
+    enableExtmap
+  });
 };
 
 /**

package/src/meeting/index.js

@@ -1742,6 +1742,7 @@ export default class Meeting extends StatelessWebexPlugin {
    * @param {Object} invitee
    * @param {String} invitee.emailAddress
    * @param {String} invitee.email
+   * @param {String} invitee.phoneNumber
    * @param {Boolean} [alertIfActive]
    * @returns {Promise} see #members.addMember
    * @public
@@ -1751,6 +1752,18 @@ export default class Meeting extends StatelessWebexPlugin {
     return this.members.addMember(invitee, alertIfActive);
   }
 
+  /**
+   * Cancel an outgoing phone call invitation made during a meeting
+   * @param {Object} invitee
+   * @param {String} invitee.phoneNumber
+   * @returns {Promise} see #members.cancelPhoneInvite
+   * @public
+   * @memberof Meeting
+   */
+  cancelPhoneInvite(invitee) {
+    return this.members.cancelPhoneInvite(invitee);
+  }
+
   /**
    * Admit the guest(s) to the call once they are waiting
    * @param {Array} memberIds
@@ -3663,7 +3676,8 @@ export default class Meeting extends StatelessWebexPlugin {
       .then(() => Media.attachMedia(this.mediaProperties, {
         meetingId: this.id,
         remoteQualityLevel: this.mediaProperties.remoteQualityLevel,
-        enableRtx: this.config.enableRtx
+        enableRtx: this.config.enableRtx,
+        enableExtmap: this.config.enableExtmap
       })
         .then((peerConnection) => this.getDevices().then((devices) => {
           MeetingUtil.handleDeviceLogging(devices);
@@ -3937,7 +3951,8 @@ export default class Meeting extends StatelessWebexPlugin {
       .then(() => Media.updateMedia(this.mediaProperties, {
         meetingId: this.id,
         remoteQualityLevel: this.mediaProperties.remoteQualityLevel,
-        enableRtx: this.config.enableRtx
+        enableRtx: this.config.enableRtx,
+        enableExtmap: this.config.enableExtmap
       })
         .then((peerConnection) => {
           LoggerProxy.logger.info(`${LOG_HEADER} PeerConnection received from updateMedia, ${peerConnection}`);

package/src/meeting/util.js

@@ -302,7 +302,8 @@ MeetingUtil.updateTransceiver = (options, meetingOptions) => {
     return Media.updateTransceiver({
       meetingId: meetingOptions.meeting.id,
       remoteQualityLevel: meetingOptions.mediaProperties.remoteQualityLevel,
-      enableRtx: meetingOptions.meeting.config.enableRtx
+      enableRtx: meetingOptions.meeting.config.enableRtx,
+      enableExtmap: meetingOptions.meeting.config.enableExtmap
     }, peerConnection, transceiver,
     {
       track,

package/src/members/index.js

@@ -594,6 +594,27 @@ export default class Members extends StatelessWebexPlugin {
     return this.membersRequest.addMembers(options);
   }
 
+  /**
+   * Cancels an outgoing PSTN call to the associated meeting
+   * @param {String} invitee
+   * @returns {Promise}
+   * @memberof Members
+   */
+  cancelPhoneInvite(invitee) {
+    if (!this.locusUrl) {
+      return Promise.reject(new ParameterError('The associated locus url for this meeting object must be defined.'));
+    }
+    if (MembersUtil.isInvalidInvitee(invitee)) {
+      return Promise.reject(
+        new ParameterError('The invitee must be defined with a valid phoneNumber property.')
+      );
+    }
+    const options = MembersUtil.cancelPhoneInviteOptions(invitee, this.locusUrl);
+
+
+    return this.membersRequest.cancelPhoneInvite(options);
+  }
+
   /**
    * Admits waiting members (invited guests to meeting)
    * @param {Array} memberIds
@@ -668,4 +689,39 @@ export default class Members extends StatelessWebexPlugin {
 
     return this.membersRequest.transferHostToMember(options);
   }
+
+
+  /**
+   * Sends DTMF tones for the PSTN member of a meeting
+   * @param {String} tones a string of one or more DTMF tones to send
+   * @param {String} memberId member id
+   * @returns {Promise}
+   * @public
+   * @memberof Members
+   */
+  sendDialPadKey(tones = '', memberId = '') {
+    if (!tones && tones !== 0) {
+      return Promise.reject(new ParameterError('DMTF tones must be passed in'));
+    }
+
+    const member = this.membersCollection.get(memberId);
+
+    if (!member) {
+      return Promise.reject(new ParameterError('there is no member associated with that Id'));
+    }
+
+    const {locusUrl} = this;
+
+    const deviceArray = member.participant.devices;
+    const device = deviceArray.find(({deviceType}) => deviceType === 'SIP');
+    const url = device?.url;
+
+    if (locusUrl && url) {
+      const options = MembersUtil.genderateSendDTMFOptions(url, tones, memberId, locusUrl);
+
+      return this.membersRequest.sendDialPadKey(options);
+    }
+
+    return Promise.reject(new Error('Members:index#sendDialPadKey --> cannot send DTMF, meeting does not have a connection to the "locus" call control service.'));
+  }
 }

package/src/members/request.js

@@ -73,4 +73,39 @@ export default class MembersRequest extends StatelessWebexPlugin {
 
     return this.request(requestParams);
   }
+
+  /**
+   * Sends a request to the DTMF endpoint to send tones
+   * @param {Object} options
+   * @param {String} options.locusUrl
+   * @param {String} options.url device url SIP user
+   * @param {String} options.tones a string of one or more DTMF tones to send
+   * @param {String} options.memberId ID of PSTN user
+   * @returns {Promise}
+   */
+  sendDialPadKey(options) {
+    if (!options || !options.locusUrl || !options.memberId || !options.url || !options.tones && options.tones !== 0) {
+      throw new ParameterError('memberId must be defined, the associated locus url, the device url and DTMF tones for this meeting object must be defined.');
+    }
+
+    const requestParams = MembersUtil.generateSendDTMFRequestParams(options);
+
+    return this.request(requestParams);
+  }
+
+  /**
+   * @param {Object} options with format of {invitee: string, locusUrl: string}
+   * @returns {Promise}
+   * @throws {Error} if the options are not valid and complete, must have invitee with emailAddress OR email AND locusUrl
+   * @memberof MembersRequest
+   */
+  cancelPhoneInvite(options) {
+    if (!(options?.invitee?.phoneNumber || options?.locusUrl)) {
+      throw new ParameterError('invitee must be passed and the associated locus url for this meeting object must be defined.');
+    }
+
+    const requestParams = MembersUtil.generateCancelInviteRequestParams(options);
+
+    return this.request(requestParams);
+  }
 }

package/src/members/util.js

@@ -1,3 +1,5 @@
+import uuid from 'uuid';
+
 import {
   HTTP_VERBS,
   CONTROLS,
@@ -5,7 +7,9 @@ import {
   LEAVE,
   PARTICIPANT,
   VALID_EMAIL_ADDRESS,
-  DIALER_REGEX
+  DIALER_REGEX,
+  SEND_DTMF_ENDPOINT,
+  _REMOVE_
 } from '../constants';
 
 const MembersUtil = {};
@@ -156,4 +160,57 @@ MembersUtil.getTransferHostToMemberRequestParams = (options) => {
   };
 };
 
+MembersUtil.genderateSendDTMFOptions = (url, tones, memberId, locusUrl) => ({
+  url,
+  tones,
+  memberId,
+  locusUrl
+});
+
+MembersUtil.generateSendDTMFRequestParams = ({
+  url, tones, memberId, locusUrl
+}) => {
+  const body = {
+    device: {
+      url
+    },
+    memberId,
+    dtmf: {
+      correlationId: uuid.v4(),
+      tones,
+      direction: 'transmit'
+    }
+  };
+  const uri = `${locusUrl}/${PARTICIPANT}/${memberId}/${SEND_DTMF_ENDPOINT}`;
+
+  return {
+    method: HTTP_VERBS.POST,
+    uri,
+    body
+  };
+};
+
+MembersUtil.cancelPhoneInviteOptions = (invitee, locusUrl) => ({
+  invitee,
+  locusUrl
+});
+
+MembersUtil.generateCancelInviteRequestParams = (options) => {
+  const body = {
+    actionType: _REMOVE_,
+    invitees: [
+      {
+        address: options.invitee.phoneNumber
+      }
+    ]
+  };
+  const requestParams = {
+    method: HTTP_VERBS.PUT,
+    uri: options.locusUrl,
+    body
+  };
+
+  return requestParams;
+};
+
 export default MembersUtil;

package/src/metrics/index.js

@@ -175,7 +175,6 @@ class Metrics {
       eventId: uuid.v4(),
       version: 1,
       origin: {
-        buildType: 'prod',
         name: 'endpoint',
         networkType: 'unknown',
         userAgent: this.userAgentToString(),
@@ -264,7 +263,6 @@ class Metrics {
       origin: {
         audioSetupDelay,
         videoSetupDelay,
-        buildType: 'prod',
         name: 'endpoint',
         networkType: options.networkType || UNKNOWN,
         userAgent: this.userAgentToString(),

package/src/peer-connection-manager/index.js

@@ -186,7 +186,6 @@ pc.iceCandidate = (peerConnection, {remoteQualityLevel}) =>
     const timeout = setTimeout(() => {
       peerConnection.sdp = limitBandwidth(peerConnection.localDescription.sdp);
       peerConnection.sdp = setMaxFs(peerConnection.sdp, remoteQualityLevel);
-      peerConnection.sdp = peerConnection.sdp.replace(/\na=extmap.*/g, '');
 
       if (isSdpInvalid(peerConnection.sdp)) {
         setTimeout(() => {
@@ -214,7 +213,6 @@ pc.iceCandidate = (peerConnection, {remoteQualityLevel}) =>
       if (!evt.candidate && !peerConnection.sdp) {
         peerConnection.sdp = limitBandwidth(peerConnection.localDescription.sdp);
         peerConnection.sdp = setMaxFs(peerConnection.sdp, remoteQualityLevel);
-        peerConnection.sdp = peerConnection.sdp.replace(/\na=extmap.*/g, '');
 
         if (evt.candidate === null && !isSdpInvalid(peerConnection.sdp)) {
           clearTimeout(timeout);
@@ -292,9 +290,7 @@ pc.addStream = (peerConnection, stream) => {
  */
 pc.setRemoteSessionDetails = (peerConnection, typeStr, remoteSdp, meetingId) => {
   LoggerProxy.logger.log(`PeerConnectionManager:index#setRemoteSessionDetails --> Setting the remote description type: ${typeStr}State: ${peerConnection.signalingState}`);
-  let sdp = remoteSdp;
-
-  sdp = sdp.replace(/\na=extmap.*/g, '');
+  const sdp = remoteSdp;
 
   // making sure that the remoteDescription is only set when there is a answer for offer
   // or there is a offer from the server
@@ -363,9 +359,15 @@ pc.setRemoteSessionDetails = (peerConnection, typeStr, remoteSdp, meetingId) =>
  * @param {string} meetingProperties.meetingId
  * @param {string} meetingProperties.remoteQualityLevel LOW|MEDIUM|HIGH
  * @param {string} meetingProperties.enableRtx
+ * @param {string} meetingProperties.enableExtmap
  * @returns {RTCPeerConnection}
  */
-pc.createOffer = (peerConnection, {meetingId, remoteQualityLevel, enableRtx}) => {
+pc.createOffer = (peerConnection, {
+  meetingId,
+  remoteQualityLevel,
+  enableRtx,
+  enableExtmap
+}) => {
   LoggerProxy.logger.log('PeerConnectionManager:index#createOffer --> creating a new offer');
 
   return peerConnection
@@ -389,7 +391,11 @@ pc.createOffer = (peerConnection, {meetingId, remoteQualityLevel, enableRtx}) =>
       if (!checkH264Support(peerConnection.sdp)) {
         throw new MediaError('openH264 is downloading please Wait. Upload logs if not working on second try');
       }
-      peerConnection.sdp = peerConnection.sdp.replace(/\na=extmap.*/g, '');
+
+      if (!enableExtmap) {
+        peerConnection.sdp = peerConnection.sdp.replace(/\na=extmap.*/g, '');
+      }
+
       pc.setContentSlides(peerConnection);
 
       Metrics.postEvent({
@@ -512,8 +518,6 @@ pc.createAnswer = (params, {meetingId, remoteQualityLevel}) => {
         throw new MediaError('openH264 is downloading please Wait. Upload logs if not working on second try');
       }
 
-      peerConnection.sdp = peerConnection.sdp.replace(/\na=extmap.*/g, '');
-
       return peerConnection;
     })
     .catch((error) => {

package/src/reconnection-manager/index.js

@@ -459,7 +459,8 @@ export default class ReconnectionManager {
     return Media.attachMedia(this.meeting.mediaProperties, {
       meetingId: this.meeting.id,
       remoteQualityLevel: this.meeting.mediaProperties.remoteQualityLevel,
-      enableRtx: this.meeting.config.enableRtx
+      enableRtx: this.meeting.config.enableRtx,
+      enableExtmap: this.meeting.config.enableExtmap
     })
       .then((peerConnection) => this.meeting.setRemoteStream(peerConnection))
       .then(() => {

package/src/roap/handler.js

@@ -192,8 +192,10 @@ export default class RoapHandler extends StatelessWebexPlugin {
   handleAction(session, action, meeting, correlationId) {
     let signal;
 
+
     switch (action.type) {
       case ROAP.RECEIVE_ROAP_MSG:
+        LoggerProxy.logger.log(`Roap:handler#handleAction --> RECEIVE_ROAP_MSG event captured, reciving a roap message : ${JSON.stringify(action)}`);
         if (compareWithLastRoapMessage(this.lastRoapMessage, action)) {
           LoggerProxy.logger.warn(`Roap:handler#handleAction --> duplicate roap offer from server: ${action.msg.seq}`);
         }
@@ -204,18 +206,15 @@ export default class RoapHandler extends StatelessWebexPlugin {
         }
         break;
       case ROAP.SEND_ROAP_MSG:
+        LoggerProxy.logger.log(`Roap:handler#handleAction --> SEND_ROAP_MSG event captured, sending roap message ${JSON.stringify(action)}`);
+
         action.local = true;
         this.execute(signal, session, action, meeting, ROAP.TX_);
         break;
       case ROAP.SEND_ROAP_MSG_SUCCESS:
-        // This means we got and answer and waiting for 200 ok for /participants
-        if (RoapCollection.getSessionSequence(correlationId, action.seq).ANSWER) {
-          signal = ROAP.ROAP_SIGNAL.RX_ANSWER;
-          // NOTE: When server send back an answer via mercury the
-          // remote SDP is already saved sent and ok message is sent back
-          // We dont have to indicate the roapHandler about the RX_ANSWER via SEND_ROAP_MSG_SUCCESS
-          // RoapHandler.transition(signal, session, meeting);
-        }
+        // NOTE: When server send back an answer via mercury the
+        // remote SDP is already saved sent and ok message is sent back
+        // We dont have to indicate the roapHandler about the RX_ANSWER via SEND_ROAP_MSG_SUCCESS
         break;
       case ROAP.RECEIVE_CALL_LEAVE:
         RoapCollection.deleteSession(correlationId);

package/src/roap/index.js

@@ -174,6 +174,12 @@ export default class Roap extends StatelessWebexPlugin {
       seq: options.seq
     };
 
+    this.roapHandler.submit({
+      type: ROAP.SEND_ROAP_MSG,
+      msg: roapMessage,
+      correlationId: options.correlationId
+    });
+
     return this.roapRequest
       .sendRoap({
         roapMessage,
@@ -186,10 +192,11 @@ export default class Roap extends StatelessWebexPlugin {
       })
       .then(() => {
         meeting.setRoapSeq(options.seq);
+
         this.roapHandler.submit({
-          type: ROAP.SEND_ROAP_MSG,
-          msg: roapMessage,
-          correlationId: options.correlationId
+          type: ROAP.SEND_ROAP_MSG_SUCCESS,
+          seq: roapMessage.seq,
+          correlationId: meeting.correlationId
         });
       });
   }

package/src/roap/state.js

@@ -25,6 +25,8 @@ const shouldStep = (roap, meeting) => {
 };
 
 const handleTransition = (value, signal, meeting) => {
+  LoggerProxy.logger.log(`Roap:state#handleTransition --> current ${value} to ${signal}`);
+
   switch (value) {
     case ROAP.ROAP_STATE.INIT:
       if (signal === ROAP.ROAP_SIGNAL.RX_OFFER) {

package/test/unit/spec/meeting/index.js

@@ -186,6 +186,22 @@ describe('plugin-meetings', () => {
           assert.calledWith(meeting.members.addMember, uuid1, false);
         });
       });
+      describe('#cancelPhoneInvite', () => {
+        it('should have #invite', () => {
+          assert.exists(meeting.cancelPhoneInvite);
+        });
+        beforeEach(() => {
+          meeting.members.cancelPhoneInvite = sinon.stub().returns(Promise.resolve(test1));
+        });
+        it('should proxy members #cancelPhoneInvite and return a promise', async () => {
+          const cancel = meeting.cancelPhoneInvite(uuid1);
+
+          assert.exists(cancel.then);
+          await cancel;
+          assert.calledOnce(meeting.members.cancelPhoneInvite);
+          assert.calledWith(meeting.members.cancelPhoneInvite, uuid1);
+        });
+      });
       describe('#admit', () => {
         it('should have #admit', () => {
           assert.exists(meeting.admit);