@webex/plugin-meetings 1.150.1 → 1.151.0

package/src/meeting/index.js

@@ -51,6 +51,7 @@ import {
   MEETING_STATE_MACHINE,
   MEETING_STATE,
   MEETINGS,
+  METRICS_JOIN_TIMES_MAX_DURATION,
   METRICS_OPERATIONAL_MEASURES,
   MQA_STATS,
   NETWORK_STATUS,
@@ -1065,10 +1066,45 @@ export default class Meeting extends StatelessWebexPlugin {
         };
       }
 
+      const localSDPGenRemoteSDPRecv = this.getLocalSDPGenRemoteSDPRecvDelay();
+
+      if (localSDPGenRemoteSDPRecv) {
+        options.joinTimes = {
+          ...options.joinTimes,
+          localSDPGenRemoteSDPRecv
+        };
+      }
+
+      const callInitiateJoinReq = this.getCallInitiateJoinReq();
+
+      if (callInitiateJoinReq) {
+        options.joinTimes = {
+          ...options.joinTimes,
+          callInitiateJoinReq
+        };
+      }
+
+      const joinReqResp = this.getJoinReqResp();
+
+      if (joinReqResp) {
+        options.joinTimes = {
+          ...options.joinTimes,
+          joinReqResp
+        };
+      }
+
+      const getTotalJmt = this.getTotalJmt();
+
+      if (getTotalJmt) {
+        options.joinTimes = {
+          ...options.joinTimes,
+          getTotalJmt
+        };
+      }
+
       if (options.type === MQA_STATS.CA_TYPE) {
         payload = Metrics.initMediaPayload(options.event, identifiers, options);
       }
-
       else {
         payload = Metrics.initPayload(options.event, identifiers, options);
       }
@@ -3372,12 +3408,13 @@ export default class Meeting extends StatelessWebexPlugin {
       }
     }
 
-    return MeetingUtil.joinMeetingOptions(this, options).then((join) => {
-      this.meetingFiniteStateMachine.join();
-      LoggerProxy.logger.log('Meeting:index#join --> Success');
+    return MeetingUtil.joinMeetingOptions(this, options)
+      .then((join) => {
+        this.meetingFiniteStateMachine.join();
+        LoggerProxy.logger.log('Meeting:index#join --> Success');
 
-      return join;
-    })
+        return join;
+      })
       .then((join) => {
         joinSuccess(join);
         this.deferJoin = undefined;
@@ -3851,7 +3888,8 @@ export default class Meeting extends StatelessWebexPlugin {
         meetingId: this.id,
         remoteQualityLevel: this.mediaProperties.remoteQualityLevel,
         enableRtx: this.config.enableRtx,
-        enableExtmap: this.config.enableExtmap
+        enableExtmap: this.config.enableExtmap,
+        setStartLocalSDPGenRemoteSDPRecvDelay: this.setStartLocalSDPGenRemoteSDPRecvDelay.bind(this)
       })
         .then((peerConnection) => this.getDevices().then((devices) => {
           MeetingUtil.handleDeviceLogging(devices);
@@ -5238,9 +5276,9 @@ export default class Meeting extends StatelessWebexPlugin {
   }
 
   /**
- * @param {string} typeMedia 'audio' or 'video'
- * @returns {undefined}
- */
+   * @param {string} typeMedia 'audio' or 'video'
+   * @returns {undefined}
+   */
   setEndSendingMediaDelay(typeMedia) {
     this[`endSendingMediaDelay${typeMedia}`] = performance.now();
   }
@@ -5255,4 +5293,127 @@ export default class Meeting extends StatelessWebexPlugin {
 
     return (start && end) ? end - start : undefined;
   }
+
+  /**
+   *
+   * @returns {undefined}
+   */
+  setStartLocalSDPGenRemoteSDPRecvDelay() {
+    if (!this.startLocalSDPGenRemoteSDPRecvDelay) {
+      this.startLocalSDPGenRemoteSDPRecvDelay = performance.now();
+      this.endLocalSDPGenRemoteSDPRecvDelay = undefined;
+    }
+  }
+
+  /**
+   *
+   * @returns {undefined}
+   */
+  setEndLocalSDPGenRemoteSDPRecvDelay() {
+    if (!this.endLocalSDPGenRemoteSDPRecvDelay) {
+      this.endLocalSDPGenRemoteSDPRecvDelay = performance.now();
+    }
+  }
+
+  /**
+   *
+   * @returns {string} duration between local SDP generation and remote SDP reception
+   */
+  getLocalSDPGenRemoteSDPRecvDelay() {
+    const start = this.startLocalSDPGenRemoteSDPRecvDelay;
+    const end = this.endLocalSDPGenRemoteSDPRecvDelay;
+
+    if (start && end) {
+      const calculatedDelay = end - start;
+
+      return calculatedDelay > METRICS_JOIN_TIMES_MAX_DURATION ?
+        undefined :
+        calculatedDelay;
+    }
+
+    return undefined;
+  }
+
+  /**
+   *
+   * @returns {undefined}
+   */
+  setStartCallInitiateJoinReq() {
+    this.startCallInitiateJoinReq = performance.now();
+    this.endCallInitiateJoinReq = undefined;
+  }
+
+  /**
+   *
+   * @returns {undefined}
+   */
+  setEndCallInitiateJoinReq() {
+    this.endCallInitiateJoinReq = performance.now();
+  }
+
+  /**
+   *
+   * @returns {string} duration between call initiate and sending join request to locus
+   */
+  getCallInitiateJoinReq() {
+    const start = this.startCallInitiateJoinReq;
+    const end = this.endCallInitiateJoinReq;
+
+    if (start && end) {
+      const calculatedDelay = end - start;
+
+      return calculatedDelay > METRICS_JOIN_TIMES_MAX_DURATION ?
+        undefined :
+        calculatedDelay;
+    }
+
+    return undefined;
+  }
+
+  /**
+   *
+   * @returns {undefined}
+   */
+  setStartJoinReqResp() {
+    this.startJoinReqResp = performance.now();
+    this.endJoinReqResp = undefined;
+  }
+
+  /**
+   *
+   * @returns {undefined}
+   */
+  setEndJoinReqResp() {
+    this.endJoinReqResp = performance.now();
+  }
+
+  /**
+   *
+   * @returns {string} duration between sending locus join request and receiving join response
+   */
+  getJoinReqResp() {
+    const start = this.startJoinReqResp;
+    const end = this.endJoinReqResp;
+
+    if (start && end) {
+      const calculatedDelay = end - start;
+
+      return calculatedDelay > METRICS_JOIN_TIMES_MAX_DURATION ?
+        undefined :
+        calculatedDelay;
+    }
+
+    return undefined;
+  }
+
+  /**
+   *
+   * @returns {string} duration between call initiate and successful locus join (even if it is in lobby)
+   */
+  getTotalJmt() {
+    const start = this.startCallInitiateJoinReq;
+    const end = this.endJoinReqResp;
+
+    return (start && end) ? end - start : undefined;
+  }
 }

package/src/metrics/index.js

@@ -48,7 +48,15 @@ const getLocalNetworkPrefix = (localIp) => {
 
 const triggerTimers = ({event, meeting, data}) => {
   switch (event) {
+    case eventType.CALL_INITIATED:
+      meeting.setStartCallInitiateJoinReq();
+      break;
+    case eventType.LOCUS_JOIN_REQUEST:
+      meeting.setEndCallInitiateJoinReq();
+      meeting.setStartJoinReqResp();
+      break;
     case eventType.LOCUS_JOIN_RESPONSE:
+      meeting.setEndJoinReqResp();
       meeting.setStartSetupDelay(mediaType.AUDIO);
       meeting.setStartSetupDelay(mediaType.VIDEO);
       meeting.setStartSendingMediaDelay(mediaType.AUDIO);
@@ -60,6 +68,12 @@ const triggerTimers = ({event, meeting, data}) => {
     case eventType.SENDING_MEDIA_START:
       meeting.setEndSendingMediaDelay(data.mediaType);
       break;
+    case eventType.LOCAL_SDP_GENERATED:
+      meeting.setStartLocalSDPGenRemoteSDPRecvDelay();
+      break;
+    case eventType.REMOTE_SDP_RECEIVED:
+      meeting.setEndLocalSDPGenRemoteSDPRecvDelay();
+      break;
     default:
       break;
   }
@@ -144,6 +158,7 @@ class Metrics {
 
     if (!meeting && meetingId) {
       meeting = this.meetingCollection.get(meetingId);
+      options.meeting = meeting;
     }
 
     if (meeting) {
@@ -228,6 +243,9 @@ class Metrics {
       if (options.recoveredBy) {
         payload.event.recoveredBy = options.recoveredBy;
       }
+      if (options.joinTimes) {
+        payload.event.joinTimes = options.joinTimes;
+      }
     }
 
     return payload;
@@ -259,7 +277,7 @@ class Metrics {
    * @memberof Metrics
    */
   initMediaPayload(eventType, identifiers, options = {}) {
-    const {audioSetupDelay, videoSetupDelay} = options;
+    const {audioSetupDelay, videoSetupDelay, joinTimes} = options;
 
     const payload = {
       eventId: uuid.v4(),
@@ -290,7 +308,10 @@ class Metrics {
         canProceed: true,
         identifiers,
         intervals: [options.intervalData],
-        eventData: {webClientDomain: window.location.hostname},
+        joinTimes,
+        eventData: {
+          webClientDomain: window.location.hostname
+        },
         sourceMetadata: {
           applicationSoftwareType: CLIENT_NAME,
           applicationSoftwareVersion: this.webex.version,

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

@@ -288,7 +288,12 @@ pc.addStream = (peerConnection, stream) => {
  * @param {String} meetingId
  * @returns {undefined}
  */
-pc.setRemoteSessionDetails = (peerConnection, typeStr, remoteSdp, meetingId) => {
+pc.setRemoteSessionDetails = (
+  peerConnection,
+  typeStr,
+  remoteSdp,
+  meetingId,
+) => {
   LoggerProxy.logger.log(`PeerConnectionManager:index#setRemoteSessionDetails --> Setting the remote description type: ${typeStr}State: ${peerConnection.signalingState}`);
   const sdp = remoteSdp;
 
@@ -314,7 +319,7 @@ pc.setRemoteSessionDetails = (peerConnection, typeStr, remoteSdp, meetingId) =>
       })
     )
       .then(() => {
-        if (!peerConnection.remoteDescription) {
+        if (peerConnection.signalingState === SDP.STABLE) {
           Metrics.postEvent({
             event: eventType.REMOTE_SDP_RECEIVED,
             meetingId

package/test/integration/spec/journey.js

@@ -519,7 +519,10 @@ skipInNode(describe)('plugin-meetings', () => {
           .then((response) => {
             assert.equal(response[0].result.memberId, alice.meeting.selfId);
           }),
-        testUtils.waitForEvents([{scope: bob.meeting.members, event: 'members:update'}]),
+        testUtils.waitForEvents([{scope: bob.meeting.members, event: 'members:update'}])
+          .then((response) => {
+            console.log('SCREEN SHARE RESPONSE ', JSON.stringify(response, testUtils.getCircularReplacer()));
+          }),
         testUtils.waitForEvents([{scope: alice.meeting, event: 'media:ready'}])
           .then((response) => {
             console.log('MEDIA:READY event ', response[0].result);
@@ -549,7 +552,7 @@ skipInNode(describe)('plugin-meetings', () => {
           }),
         testUtils.waitForEvents([{scope: alice.meeting.members, event: 'members:update'}])
           .then((response) => {
-            console.log('SCREEN SHARE RESPONSE ', JSON.stringify(response));
+            console.log('SCREEN SHARE RESPONSE ', JSON.stringify(response, testUtils.getCircularReplacer()));
           }),
         testUtils.waitForEvents([{scope: bob.meeting, event: 'media:ready'}])
           .then((response) => {
@@ -601,7 +604,7 @@ skipInNode(describe)('plugin-meetings', () => {
           }),
         testUtils.waitForEvents([{scope: bob.meeting.members, event: 'members:update'}])
           .then((response) => {
-            console.log('WHITEBOARD SHARE RESPONSE ', JSON.stringify(response));
+            console.log('WHITEBOARD SHARE RESPONSE ', JSON.stringify(response, testUtils.getCircularReplacer()));
           })
       ])
         .then(() => {
@@ -624,7 +627,7 @@ skipInNode(describe)('plugin-meetings', () => {
           }),
         testUtils.waitForEvents([{scope: alice.meeting.members, event: 'members:update'}])
           .then((response) => {
-            console.log('WHITEBOARD SHARE RESPONSE ', JSON.stringify(response));
+            console.log('WHITEBOARD SHARE RESPONSE ', JSON.stringify(response, testUtils.getCircularReplacer()));
           })
       ])
         .then(() => {
@@ -660,7 +663,7 @@ skipInNode(describe)('plugin-meetings', () => {
           }),
         testUtils.waitForEvents([{scope: bob.meeting.members, event: 'members:update'}])
           .then((response) => {
-            console.log('WHITEBOARD SHARE RESPONSE ', JSON.stringify(response));
+            console.log('WHITEBOARD SHARE RESPONSE ', JSON.stringify(response, testUtils.getCircularReplacer()));
           })
       ])
         .then(() => {
@@ -679,7 +682,7 @@ skipInNode(describe)('plugin-meetings', () => {
           }),
         testUtils.waitForEvents([{scope: alice.meeting.members, event: 'members:update'}])
           .then((response) => {
-            console.log('SCREEN SHARE RESPONSE ', JSON.stringify(response));
+            console.log('SCREEN SHARE RESPONSE ', JSON.stringify(response, testUtils.getCircularReplacer()));
           }),
         testUtils.waitForEvents([{scope: bob.meeting, event: 'media:ready'}])
           .then((response) => {
@@ -715,7 +718,7 @@ skipInNode(describe)('plugin-meetings', () => {
           }),
         testUtils.waitForEvents([{scope: alice.meeting.members, event: 'members:update'}])
           .then((response) => {
-            console.log('WHITEBOARD SHARE RESPONSE ', JSON.stringify(response));
+            console.log('WHITEBOARD SHARE RESPONSE ', JSON.stringify(response, testUtils.getCircularReplacer()));
           })
       ])
         .then(() => {

package/test/utils/testUtils.js

@@ -236,6 +236,22 @@ const waitUntil = (waitTime) => new Promise((resolve) => {
 
 const flushPromises = () => new Promise(setImmediate);
 
+const getCircularReplacer = () => {
+  const seen = new WeakSet();
+
+  return (_, value) => {
+    if (typeof value === 'object' && value !== null) {
+      if (seen.has(value)) {
+        return;
+      }
+      seen.add(value);
+    }
+
+    // eslint-disable-next-line consistent-return
+    return value;
+  };
+};
+
 export default {
   waitForSpy,
   waitForStateChange,
@@ -246,6 +262,7 @@ export default {
   addMedia,
   waitUntil,
   delayedTest,
-  flushPromises
+  flushPromises,
+  getCircularReplacer
 };