@webex/plugin-meetings 1.146.1 → 1.149.0

package/src/meeting/request.js

@@ -20,6 +20,7 @@ import {
   MEDIA,
   PARTICIPANT,
   PROVISIONAL_TYPE_DIAL_IN,
+  PROVISIONAL_TYPE_DIAL_OUT,
   SEND_DTMF_ENDPOINT,
   _SLIDES_
 } from '../constants';
@@ -182,6 +183,48 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     });
   }
 
+  /**
+   * Make a network request to add a dial out device
+   * @param {Object} options
+   * @param {String} options.correlationId
+   * @param {String} options.localUrl url for the meeting
+   * @param {String} options.dialOutUrl identifier for the to-be provisioned device
+   * @param {String} options.phoneNumber phone number to dial out to
+   * @param {String} options.clientUrl identifier for the web device
+   * @returns {Promise}
+   * @private
+   */
+  dialOut({
+    locusUrl, dialOutUrl, phoneNumber, clientUrl, correlationId
+  }) {
+    LoggerProxy.logger.info(
+      'Meeting:request#dialOut --> Provisioning a dial out device',
+      correlationId
+    );
+    const uri = `${locusUrl}/${PARTICIPANT}`;
+
+    const body = {
+      device: {
+        deviceType: deviceType.PROVISIONAL,
+        provisionalType: PROVISIONAL_TYPE_DIAL_OUT,
+        url: dialOutUrl,
+        dialoutAddress: phoneNumber,
+        clientUrl
+      },
+      correlationId
+    };
+
+    return this.request({
+      method: HTTP_VERBS.POST,
+      uri,
+      body
+    }).catch((err) => {
+      LoggerProxy.logger.error(`Meeting:request#dialOut --> Error provisioning a dial out device, error ${err}`);
+
+      throw err;
+    });
+  }
+
   /**
    * Syns the missed delta event
    * @param {Object} options
@@ -241,21 +284,20 @@ export default class MeetingRequest extends StatelessWebexPlugin {
   }
 
   /**
-   * Make a network request to make a provisioned pstn device leave the meeting
+   * Make a network request to make a provisioned phone leave the meeting
    * @param {Object} options
    * @param {String} options.locusUrl
-   * @param {String} options.selfId
-   * @param {String} options.deviceUrl
-   * @param {String} options.resourceId,
+   * @param {String} options.phoneUrl
    * @param {String} options.correlationId
+   * @param {String} options.selfId
    * @returns {Promise}
    * @private
    */
-  leavePstn({
-    locusUrl, dialInUrl, correlationId, selfId
+  disconnectPhoneAudio({
+    locusUrl, phoneUrl, correlationId, selfId
   }) {
     LoggerProxy.logger.info(
-      `Meeting:request#leavePstn --> request device ${dialInUrl} to leaving`,
+      `Meeting:request#disconnectPhoneAudio --> request phone ${phoneUrl} to leave`,
       correlationId
     );
     const uri = `${locusUrl}/${PARTICIPANT}/${selfId}/${LEAVE}`;
@@ -263,7 +305,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     const body = {
       device: {
         deviceType: deviceType.PROVISIONAL,
-        url: dialInUrl
+        url: phoneUrl
       },
       correlationId
     };
@@ -273,7 +315,9 @@ export default class MeetingRequest extends StatelessWebexPlugin {
       uri,
       body
     }).catch((err) => {
-      LoggerProxy.logger.error(`Meeting:request#leavePstn --> Error when requesting pstn device ${dialInUrl} to leave, error ${err}`);
+      LoggerProxy.logger.error(
+        `Meeting:request#disconnectPhoneAudio --> Error when requesting phone ${phoneUrl} to leave, error ${err}`
+      );
 
       throw err;
     });

package/src/meeting/util.js

@@ -72,13 +72,7 @@ MeetingUtil.hasOwner = (info) => info && info.owner;
 
 MeetingUtil.isOwnerSelf = (owner, selfId) => owner === selfId;
 
-MeetingUtil.isPinOrGuest = (err) => {
-  if (err && err.body && err.body.errorCode === INTENT_TO_JOIN) {
-    return true;
-  }
-
-  return false;
-};
+MeetingUtil.isPinOrGuest = (err) => err?.body?.errorCode && INTENT_TO_JOIN.includes(err.body.errorCode);
 
 MeetingUtil.joinMeeting = (meeting, options) => {
   if (!meeting) {
@@ -140,7 +134,7 @@ MeetingUtil.cleanUp = (meeting) => {
     .then(() => meeting.roap.stop(meeting.correlationId, meeting.roapSeq));
 };
 
-MeetingUtil.leavePstn = (meeting, dialInUrl) => {
+MeetingUtil.disconnectPhoneAudio = (meeting, phoneUrl) => {
   if (meeting.meetingState === FULL_STATE.INACTIVE) {
     return Promise.reject(new MeetingNotActiveError());
   }
@@ -149,11 +143,11 @@ MeetingUtil.leavePstn = (meeting, dialInUrl) => {
     locusUrl: meeting.locusUrl,
     selfId: meeting.selfId,
     correlationId: meeting.correlationId,
-    dialInUrl
+    phoneUrl
   };
 
   return meeting.meetingRequest
-    .leavePstn(options)
+    .disconnectPhoneAudio(options)
     .then((response) => {
       if (response?.body?.locus) {
         meeting.locusInfo.onFullLocus(response.body.locus);
@@ -161,7 +155,7 @@ MeetingUtil.leavePstn = (meeting, dialInUrl) => {
     })
     .catch((err) => {
       LoggerProxy.logger.error(
-        `Meeting:util#leavePstn --> An error occured while trying to leave pstn with an id of ${
+        `Meeting:util#disconnectPhoneAudio --> An error occured while disconnecting phone audio in meeting ${
           meeting.id
         }, error: ${err}`
       );
@@ -263,14 +257,6 @@ MeetingUtil.joinMeetingOptions = (meeting, options = {}) => {
     .catch((err) => {
       // joining a claimed PMR that is not my own, scenario B
       if (MeetingUtil.isPinOrGuest(err)) {
-        if (MeetingUtil.hasOwner(meeting.meetingInfo)) {
-          return MeetingUtil.joinMeeting(meeting, options).then((response) => {
-            meeting.setLocus(response);
-
-            return Promise.resolve();
-          });
-        }
-
         Metrics.postEvent({
           event: eventType.PIN_PROMPT,
           meeting
@@ -302,7 +288,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/metrics/index.js

@@ -51,11 +51,15 @@ const triggerTimers = ({event, meeting, data}) => {
     case eventType.LOCUS_JOIN_RESPONSE:
       meeting.setStartSetupDelay(mediaType.AUDIO);
       meeting.setStartSetupDelay(mediaType.VIDEO);
+      meeting.setStartSendingMediaDelay(mediaType.AUDIO);
+      meeting.setStartSendingMediaDelay(mediaType.VIDEO);
       break;
     case eventType.RECEIVING_MEDIA_START:
       meeting.setEndSetupDelay(data.mediaType);
       break;
-
+    case eventType.SENDING_MEDIA_START:
+      meeting.setEndSendingMediaDelay(data.mediaType);
+      break;
     default:
       break;
   }

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/test/unit/spec/meeting/index.js

@@ -1902,7 +1902,9 @@ describe('plugin-meetings', () => {
 
       describe('#usePhoneAudio', () => {
         beforeEach(() => {
-          meeting.meetingRequest.dialIn = sinon.stub().returns(Promise.resolve());
+          meeting.meetingRequest.dialIn = sinon.stub().returns(Promise.resolve({body: {locus: 'testData'}}));
+          meeting.meetingRequest.dialOut = sinon.stub().returns(Promise.resolve({body: {locus: 'testData'}}));
+          meeting.locusInfo.onFullLocus = sinon.stub().returns(Promise.resolve());
         });
 
         it('with no parameters triggers dial-in, delegating request to meetingRequest correctly', async () => {
@@ -1915,8 +1917,11 @@ describe('plugin-meetings', () => {
             locusUrl: meeting.locusUrl,
             clientUrl: meeting.deviceUrl
           });
+          assert.calledWith(meeting.locusInfo.onFullLocus, 'testData');
+          assert.notCalled(meeting.meetingRequest.dialOut);
 
           meeting.meetingRequest.dialIn.resetHistory();
+          meeting.locusInfo.onFullLocus.resetHistory();
 
           // try again. the dial in urls should match
           await meeting.usePhoneAudio();
@@ -1927,6 +1932,65 @@ describe('plugin-meetings', () => {
             locusUrl: meeting.locusUrl,
             clientUrl: meeting.deviceUrl
           });
+          assert.calledWith(meeting.locusInfo.onFullLocus, 'testData');
+          assert.notCalled(meeting.meetingRequest.dialOut);
+        });
+
+        it('given a phone number, triggers dial-out, delegating request to meetingRequest correctly', async () => {
+          const phoneNumber = '+442088241000';
+
+          await meeting.usePhoneAudio(phoneNumber);
+          const DIAL_OUT_URL = meeting.dialOutUrl;
+
+          assert.calledWith(meeting.meetingRequest.dialOut, {
+            correlationId: meeting.correlationId,
+            dialOutUrl: DIAL_OUT_URL,
+            locusUrl: meeting.locusUrl,
+            clientUrl: meeting.deviceUrl,
+            phoneNumber
+          });
+          assert.calledWith(meeting.locusInfo.onFullLocus, 'testData');
+          assert.notCalled(meeting.meetingRequest.dialIn);
+
+          meeting.meetingRequest.dialOut.resetHistory();
+          meeting.locusInfo.onFullLocus.resetHistory();
+
+          // try again. the dial out urls should match
+          await meeting.usePhoneAudio(phoneNumber);
+
+          assert.calledWith(meeting.meetingRequest.dialOut, {
+            correlationId: meeting.correlationId,
+            dialOutUrl: DIAL_OUT_URL,
+            locusUrl: meeting.locusUrl,
+            clientUrl: meeting.deviceUrl,
+            phoneNumber
+          });
+          assert.calledWith(meeting.locusInfo.onFullLocus, 'testData');
+          assert.notCalled(meeting.meetingRequest.dialIn);
+        });
+
+        it('rejects if the request failed (dial in)', () => {
+          const error = 'something bad happened';
+
+          meeting.meetingRequest.dialIn = sinon.stub().returns(Promise.reject(error));
+
+          return meeting.usePhoneAudio().then(() => Promise.reject(new Error('Promise resolved when it should have rejected'))).catch((e) => {
+            assert.equal(e, error);
+
+            return Promise.resolve();
+          });
+        });
+
+        it('rejects if the request failed (dial out)', async () => {
+          const error = 'something bad happened';
+
+          meeting.meetingRequest.dialOut = sinon.stub().returns(Promise.reject(error));
+
+          return meeting.usePhoneAudio('+441234567890').then(() => Promise.reject(new Error('Promise resolved when it should have rejected'))).catch((e) => {
+            assert.equal(e, error);
+
+            return Promise.resolve();
+          });
         });
       });
 

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

@@ -152,23 +152,48 @@ describe('plugin-meetings', () => {
         assert.equal(requestParams.body.device.clientUrl, 'clientUrl');
       });
 
-      it('sends leave pstn request', async () => {
+      it('sends dial out pstn request', async () => {
+        const locusUrl = 'locusUrl';
+        const clientUrl = 'clientUrl';
+        const correlationId = 'random-uuid';
+        const dialOutUrl = 'url';
+        const phoneNumber = '+442088241000';
+
+        await meetingsRequest.dialOut({
+          locusUrl,
+          clientUrl,
+          correlationId,
+          dialOutUrl,
+          phoneNumber
+        });
+        const requestParams = meetingsRequest.request.getCall(0).args[0];
+
+        assert.equal(requestParams.method, 'POST');
+        assert.equal(requestParams.uri, `${locusUrl}/participant`);
+        assert.equal(requestParams.body.device.url, dialOutUrl);
+        assert.equal(requestParams.body.device.deviceType, 'PROVISIONAL');
+        assert.equal(requestParams.body.device.provisionalType, 'DIAL_OUT');
+        assert.equal(requestParams.body.device.clientUrl, 'clientUrl');
+        assert.equal(requestParams.body.device.dialoutAddress, phoneNumber);
+      });
+
+      it('sends disconnect phone audio request', async () => {
         const locusUrl = 'locusUrl';
         const selfId = 'selfId';
         const correlationId = 'random-uuid';
-        const dialInUrl = 'url';
+        const phoneUrl = 'url';
 
-        await meetingsRequest.leavePstn({
+        await meetingsRequest.disconnectPhoneAudio({
           locusUrl,
           selfId,
           correlationId,
-          dialInUrl
+          phoneUrl
         });
         const requestParams = meetingsRequest.request.getCall(0).args[0];
 
         assert.equal(requestParams.method, 'PUT');
         assert.equal(requestParams.uri, `${locusUrl}/participant/${selfId}/leave`);
-        assert.equal(requestParams.body.device.url, dialInUrl);
+        assert.equal(requestParams.body.device.url, phoneUrl);
         assert.equal(requestParams.body.device.deviceType, 'PROVISIONAL');
       });
     });