@webex/plugin-meetings 2.60.1-next.7 → 2.60.1-next.8

package/src/meetings/index.ts

@@ -584,7 +584,7 @@ export default class Meetings extends WebexPlugin {
 
     // @ts-ignore
     this.webex.internal.mercury.on(ONLINE, () => {
-      this.syncMeetings();
+      this.syncMeetings({keepOnlyLocusMeetings: false});
     });
 
     // @ts-ignore
@@ -699,6 +699,24 @@ export default class Meetings extends WebexPlugin {
     }
   }
 
+  /**
+   * API to toggle TCP reachability, needs to be called before webex.meetings.register()
+   * @param {Boolean} newValue
+   * @private
+   * @memberof Meetings
+   * @returns {undefined}
+   */
+  private _toggleTcpReachability(newValue: boolean) {
+    if (typeof newValue !== 'boolean') {
+      return;
+    }
+    // @ts-ignore
+    if (this.config.experimental.enableTcpReachability !== newValue) {
+      // @ts-ignore
+      this.config.experimental.enableTcpReachability = newValue;
+    }
+  }
+
   /**
    * Explicitly sets up the meetings plugin by registering
    * the device, connecting to mercury, and listening for locus events.
@@ -1026,6 +1044,9 @@ export default class Meetings extends WebexPlugin {
 
   /**
    * Create a meeting or return an existing meeting.
+   *
+   * When meeting info passed it should be complete, e.g.: fetched after password or captcha provided
+   *
    * @param {string} destination - sipURL, phonenumber, or locus object}
    * @param {string} [type] - the optional specified type, such as locusId
    * @param {Boolean} useRandomDelayForInfo - whether a random delay should be added to fetching meeting info
@@ -1033,6 +1054,8 @@ export default class Meetings extends WebexPlugin {
    * @param {string} correlationId - the optional specified correlationId (callStateForMetrics.correlationId can be provided instead)
    * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
    * @param {CallStateForMetrics} callStateForMetrics - information about call state for metrics
+   * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
+   * @param {String} [meetingLookupUrl] - meeting info prefetch url
    * @returns {Promise<Meeting>} A new Meeting.
    * @public
    * @memberof Meetings
@@ -1044,7 +1067,9 @@ export default class Meetings extends WebexPlugin {
     infoExtraParams = {},
     correlationId: string = undefined,
     failOnMissingMeetingInfo = false,
-    callStateForMetrics: CallStateForMetrics = undefined
+    callStateForMetrics: CallStateForMetrics = undefined,
+    meetingInfo = undefined,
+    meetingLookupUrl = undefined
   ) {
     // TODO: type should be from a dictionary
 
@@ -1103,7 +1128,9 @@ export default class Meetings extends WebexPlugin {
               useRandomDelayForInfo,
               infoExtraParams,
               callStateForMetrics,
-              failOnMissingMeetingInfo
+              failOnMissingMeetingInfo,
+              meetingInfo,
+              meetingLookupUrl
             ).then((createdMeeting: any) => {
               // If the meeting was successfully created.
               if (createdMeeting && createdMeeting.on) {
@@ -1158,12 +1185,18 @@ export default class Meetings extends WebexPlugin {
   }
 
   /**
+   * Create meeting
+   *
+   * When meeting info passed it should be complete, e.g.: fetched after password or captcha provided
+   *
    * @param {String} destination see create()
    * @param {String} type see create()
    * @param {Boolean} useRandomDelayForInfo whether a random delay should be added to fetching meeting info
    * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
    * @param {CallStateForMetrics} callStateForMetrics - information about call state for metrics
    * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
+   * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
+   * @param {String} [meetingLookupUrl] - meeting info prefetch url
    * @returns {Promise} a new meeting instance complete with meeting info and destination
    * @private
    * @memberof Meetings
@@ -1174,7 +1207,9 @@ export default class Meetings extends WebexPlugin {
     useRandomDelayForInfo = false,
     infoExtraParams = {},
     callStateForMetrics: CallStateForMetrics = undefined,
-    failOnMissingMeetingInfo = false
+    failOnMissingMeetingInfo = false,
+    meetingInfo = undefined,
+    meetingLookupUrl = undefined
   ) {
     const meeting = new Meeting(
       {
@@ -1220,22 +1255,26 @@ export default class Meetings extends WebexPlugin {
       const isMeetingActive = !!destination.fullState?.active;
       // @ts-ignore
       const {enableUnifiedMeetings} = this.config.experimental;
-
-      if (enableUnifiedMeetings && !isMeetingActive && useRandomDelayForInfo && waitingTime > 0) {
+      const meetingInfoOptions = {
+        extraParams: infoExtraParams,
+        sendCAevents: !!callStateForMetrics?.correlationId, // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
+      };
+
+      if (meetingInfo) {
+        meeting.injectMeetingInfo(meetingInfo, meetingInfoOptions, meetingLookupUrl);
+      } else if (
+        enableUnifiedMeetings &&
+        !isMeetingActive &&
+        useRandomDelayForInfo &&
+        waitingTime > 0
+      ) {
         meeting.fetchMeetingInfoTimeoutId = setTimeout(
-          () =>
-            meeting.fetchMeetingInfo({
-              extraParams: infoExtraParams,
-              sendCAevents: !!callStateForMetrics?.correlationId, // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
-            }),
+          () => meeting.fetchMeetingInfo(meetingInfoOptions),
           waitingTime
         );
         meeting.parseMeetingInfo(undefined, destination);
       } else {
-        await meeting.fetchMeetingInfo({
-          extraParams: infoExtraParams,
-          sendCAevents: !!callStateForMetrics?.correlationId, // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
-        });
+        await meeting.fetchMeetingInfo(meetingInfoOptions);
       }
     } catch (err) {
       if (
@@ -1346,11 +1385,12 @@ export default class Meetings extends WebexPlugin {
 
   /**
    * syncs all the meeting from server
-   * @returns {undefined}
+   * @param {boolean} keepOnlyLocusMeetings - whether the sync should keep only locus meetings or any other meeting in meetingCollection
+   * @returns {Promise<void>}
    * @public
    * @memberof Meetings
    */
-  public syncMeetings() {
+  public syncMeetings({keepOnlyLocusMeetings = true} = {}): Promise<void> {
     return this.request
       .getActiveMeetings()
       .then((locusArray) => {
@@ -1374,7 +1414,8 @@ export default class Meetings extends WebexPlugin {
           // (they had a locusUrl previously but are no longer active) in the sync
           for (const meeting of Object.values(meetingsCollection)) {
             // @ts-ignore
-            if (meeting.locusUrl && !activeLocusUrl.includes(meeting.locusUrl)) {
+            const {locusUrl} = meeting;
+            if ((keepOnlyLocusMeetings || locusUrl) && !activeLocusUrl.includes(locusUrl)) {
               // destroy function also uploads logs
               // @ts-ignore
               this.destroy(meeting, MEETING_REMOVED_REASON.NO_MEETINGS_TO_SYNC);

package/src/reachability/index.ts

@@ -341,18 +341,21 @@ export default class Reachability {
       return Promise.resolve(results);
     }
 
-    // @ts-ignore
-    const includeTcpReachability = this.webex.config.meetings.experimental.enableTcpReachability;
-
     LoggerProxy.logger.log(
       `Reachability:index#performReachabilityChecks --> doing UDP${
-        includeTcpReachability ? ' and TCP' : ''
+        // @ts-ignore
+        this.webex.config.meetings.experimental.enableTcpReachability ? ' and TCP' : ''
       } reachability checks`
     );
 
     const clusterReachabilityChecks = Object.keys(clusterList).map((key) => {
       const cluster = clusterList[key];
 
+      // Linus doesn't support TCP reachability checks on video mesh nodes
+      const includeTcpReachability =
+        // @ts-ignore
+        this.webex.config.meetings.experimental.enableTcpReachability && !cluster.isVideoMesh;
+
       if (!includeTcpReachability) {
         cluster.tcp = [];
       }

package/src/reconnection-manager/index.ts

@@ -442,7 +442,7 @@ export default class ReconnectionManager {
         LoggerProxy.logger.info(
           'ReconnectionManager:index#executeReconnection --> Updating meeting data from server.'
         );
-        await this.webex.meetings.syncMeetings();
+        await this.webex.meetings.syncMeetings({keepOnlyLocusMeetings: false});
       } catch (syncError) {
         LoggerProxy.logger.info(
           'ReconnectionManager:index#executeReconnection --> Unable to sync meetings, reconnecting.',

package/src/roap/index.ts

@@ -187,7 +187,7 @@ export default class Roap extends StatelessWebexPlugin {
    * @memberof Roap
    */
   sendRoapMediaRequest(options: any) {
-    const {meeting, seq, sdp, reconnect, tieBreaker} = options;
+    const {meeting, seq, sdp, tieBreaker} = options;
     const roapMessage = {
       messageType: ROAP.ROAP_TYPES.OFFER,
       sdps: [sdp],
@@ -197,64 +197,62 @@ export default class Roap extends StatelessWebexPlugin {
       headers: ['includeAnswerInHttpResponse', 'noOkInTransaction'],
     };
 
-    // When reconnecting, it's important that the first roap message being sent out has empty media id.
-    // Normally this is the roap offer, but when TURN discovery is enabled,
-    // then this is the TURN discovery request message
-    return this.turnDiscovery.isSkipped(meeting).then((isTurnDiscoverySkipped) => {
-      const sendEmptyMediaId = reconnect && isTurnDiscoverySkipped;
+    // The only time we want to send an empty media id is when we are reconnecting, because this way we tell Locus
+    // that it needs to create a new confluence, but when reconnecting we always send TURN_DISCOVERY_REQUEST first,
+    // so we don't need to ever send an empty media id here
+    const sendEmptyMediaId = false;
 
-      return this.roapRequest
-        .sendRoap({
-          roapMessage,
-          locusSelfUrl: meeting.selfUrl,
-          mediaId: sendEmptyMediaId ? '' : meeting.mediaId,
-          meetingId: meeting.id,
-          preferTranscoding: !meeting.isMultistream,
-          locusMediaRequest: meeting.locusMediaRequest,
-          ipVersion: MeetingUtil.getIpVersion(meeting.webex),
-        })
-        .then(({locus, mediaConnections}) => {
-          if (mediaConnections) {
-            meeting.updateMediaConnections(mediaConnections);
-          }
+    return this.roapRequest
+      .sendRoap({
+        roapMessage,
+        locusSelfUrl: meeting.selfUrl,
+        mediaId: sendEmptyMediaId ? '' : meeting.mediaId,
+        meetingId: meeting.id,
+        preferTranscoding: !meeting.isMultistream,
+        locusMediaRequest: meeting.locusMediaRequest,
+        ipVersion: MeetingUtil.getIpVersion(meeting.webex),
+      })
+      .then(({locus, mediaConnections}) => {
+        if (mediaConnections) {
+          meeting.updateMediaConnections(mediaConnections);
+        }
 
-          let roapAnswer;
+        let roapAnswer;
 
-          if (mediaConnections?.[0]?.remoteSdp) {
-            const remoteSdp = JSON.parse(mediaConnections[0].remoteSdp);
+        if (mediaConnections?.[0]?.remoteSdp) {
+          const remoteSdp = JSON.parse(mediaConnections[0].remoteSdp);
 
-            if (remoteSdp.roapMessage) {
-              const {
-                seq: answerSeq,
-                messageType,
-                sdps,
-                errorType,
-                errorCause,
-                headers,
-              } = remoteSdp.roapMessage;
+          if (remoteSdp.roapMessage) {
+            const {
+              seq: answerSeq,
+              messageType,
+              sdps,
+              errorType,
+              errorCause,
+              headers,
+            } = remoteSdp.roapMessage;
 
-              roapAnswer = {
-                seq: answerSeq,
-                messageType,
-                sdp: sdps[0],
-                errorType,
-                errorCause,
-                headers,
-              };
-            }
+            roapAnswer = {
+              seq: answerSeq,
+              messageType,
+              sdp: sdps[0],
+              errorType,
+              errorCause,
+              headers,
+            };
           }
+        }
 
-          if (!roapAnswer) {
-            Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ROAP_HTTP_RESPONSE_MISSING, {
-              correlationId: meeting.correlationId,
-              messageType: 'ANSWER',
-              isMultistream: meeting.isMultistream,
-            });
-          }
+        if (!roapAnswer) {
+          Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ROAP_HTTP_RESPONSE_MISSING, {
+            correlationId: meeting.correlationId,
+            messageType: 'ANSWER',
+            isMultistream: meeting.isMultistream,
+          });
+        }
 
-          return {locus, roapAnswer};
-        });
-    });
+        return {locus, roapAnswer};
+      });
   }
 
   /**

package/src/statsAnalyzer/index.ts

@@ -7,7 +7,7 @@ import EventsScope from '../common/events/events-scope';
 import {
   DEFAULT_GET_STATS_FILTER,
   STATS,
-  MQA_INTEVAL,
+  MQA_INTERVAL,
   NETWORK_TYPE,
   MEDIA_DEVICES,
   _UNKNOWN_,
@@ -299,7 +299,7 @@ export class StatsAnalyzer extends EventsScope {
         this.sendMqaData();
         this.mqaInterval = setInterval(() => {
           this.sendMqaData();
-        }, MQA_INTEVAL);
+        }, MQA_INTERVAL);
       });
     }
 

package/src/statsAnalyzer/mqaUtil.ts

@@ -29,13 +29,14 @@ export const getAudioReceiverMqa = ({audioReceiver, statsResults, lastMqaDataSen
   // add rtpPacket info inside common as also for call analyzer
   audioReceiver.common.rtpPackets =
     statsResults[mediaType][sendrecvType].totalPacketsReceived - lastPacketsReceived || 0;
+  audioReceiver.streams[0].common.rtpPackets = audioReceiver.common.rtpPackets;
+
   // Hop by hop are numbers and not percentage so we compare on what we sent the last min
   // collect the packets received for the last min
-  audioReceiver.streams[0].common.rtpPackets = audioReceiver.common.rtpPackets;
-  audioReceiver.common.mediaHopByHopLost =
-    statsResults[mediaType][sendrecvType].totalPacketsLost - lastPacketsLost || 0;
-  audioReceiver.common.rtpHopByHopLost =
+  const totalPacketsLost =
     statsResults[mediaType][sendrecvType].totalPacketsLost - lastPacketsLost || 0;
+  audioReceiver.common.mediaHopByHopLost = totalPacketsLost;
+  audioReceiver.common.rtpHopByHopLost = totalPacketsLost;
 
   audioReceiver.streams[0].common.maxRtpJitter =
     // @ts-ignore
@@ -49,6 +50,7 @@ export const getAudioReceiverMqa = ({audioReceiver, statsResults, lastMqaDataSen
     statsResults[mediaType][sendrecvType].fecPacketsReceived -
     lastFecPacketsReceived -
     (statsResults[mediaType][sendrecvType].fecPacketsDiscarded - lastFecPacketsDiscarded);
+  audioReceiver.common.fecPackets = fecRecovered || 0;
 
   audioReceiver.streams[0].common.rtpEndToEndLost =
     statsResults[mediaType][sendrecvType].totalPacketsLost - lastPacketsLost - fecRecovered || 0;
@@ -105,7 +107,7 @@ export const getAudioSenderMqa = ({audioSender, statsResults, lastMqaDataSent, m
     statsResults[mediaType][sendrecvType].totalPacketsLostOnReceiver - lastPacketsLost;
 
   audioSender.common.remoteLossRate =
-    totalpacketsLostForaMin > 0
+    audioSender.common.rtpPackets > 0
       ? (totalpacketsLostForaMin * 100) / audioSender.common.rtpPackets
       : 0; // This is the packets sent with in last min || 0;
 
@@ -156,16 +158,15 @@ export const getVideoReceiverMqa = ({videoReceiver, statsResults, lastMqaDataSen
     statsResults[mediaType][sendrecvType].totalPacketsReceived - lastPacketsReceived || 0;
   videoReceiver.streams[0].common.rtpPackets = videoReceiver.common.rtpPackets;
 
-  const totalPacketLoss =
-    statsResults[mediaType][sendrecvType].totalPacketsLost - lastPacketsLost || 0;
-
-  // Hope by hop are numbers and not percentage so we compare on what we sent the last min
+  // Hop by hop are numbers and not percentage so we compare on what we sent the last min
   // this is including packet lost
-  videoReceiver.common.mediaHopByHopLost = totalPacketLoss;
-  videoReceiver.common.rtpHopByHopLost = totalPacketLoss;
+  const totalPacketsLost =
+    statsResults[mediaType][sendrecvType].totalPacketsLost - lastPacketsLost || 0;
+  videoReceiver.common.mediaHopByHopLost = totalPacketsLost;
+  videoReceiver.common.rtpHopByHopLost = totalPacketsLost;
 
   // End to end packetloss is after recovery
-  videoReceiver.streams[0].common.rtpEndToEndLost = totalPacketLoss;
+  videoReceiver.streams[0].common.rtpEndToEndLost = totalPacketsLost;
 
   // calculate this values
 
@@ -249,8 +250,8 @@ export const getVideoSenderMqa = ({videoSender, statsResults, lastMqaDataSent, m
     statsResults[mediaType][sendrecvType].totalPacketsLostOnReceiver - lastPacketsLost;
 
   videoSender.common.remoteLossRate =
-    totalpacketsLostForaMin > 0
-      ? (totalpacketsLostForaMin * 100) / (videoSender.common.rtpPackets + totalpacketsLostForaMin)
+    videoSender.common.rtpPackets > 0
+      ? (totalpacketsLostForaMin * 100) / videoSender.common.rtpPackets
       : 0; // This is the packets sent with in last min || 0;
 
   videoSender.common.maxRoundTripTime =

package/test/unit/spec/locus-info/index.js

@@ -2058,7 +2058,7 @@ describe('plugin-meetings', () => {
     });
 
     describe('#getTheLocusToUpdate', () => {
-      it('return the cache locus if return to main session', () => {
+      it('return the cache locus if return to main session and do not clear main session cache', () => {
         locusInfo.mainSessionLocusCache = {url: 'url'};
         locusInfo.controls = {
           breakout: {
@@ -2074,9 +2074,13 @@ describe('plugin-meetings', () => {
         };
 
         assert.deepEqual(locusInfo.getTheLocusToUpdate(newLocus), {url: 'url'});
+
+        locusInfo.clearMainSessionLocusCache = sinon.stub();
+        locusInfo.getTheLocusToUpdate(newLocus);
+        assert.notCalled(locusInfo.clearMainSessionLocusCache)
       });
 
-      it('return the new locus if return to main session but no cache', () => {
+      it('return the new locus if return to main session but no cache and do not clear main session cache', () => {
         locusInfo.mainSessionLocusCache = null;
         locusInfo.controls = {
           breakout: {
@@ -2092,10 +2096,22 @@ describe('plugin-meetings', () => {
         };
 
         assert.deepEqual(locusInfo.getTheLocusToUpdate(newLocus), newLocus);
+
+        locusInfo.clearMainSessionLocusCache = sinon.stub();
+        locusInfo.getTheLocusToUpdate(newLocus);
+        assert.notCalled(locusInfo.clearMainSessionLocusCache)
       });
 
-      it('return the new locus if not return to main session', () => {
-        locusInfo.mainSessionLocusCache = {url: 'url'};
+      it('return the new locus if not return to main session and clear main session cache', () => {
+        locusInfo.mainSessionLocusCache = {
+          controls: {
+            breakout: {
+              sessionType: 'MAIN',
+            },
+          },
+          self: {removed: true}
+        };
+        locusInfo.fullState = {state: 'ACTIVE'}
         locusInfo.controls = {
           breakout: {
             sessionType: 'MAIN',
@@ -2109,7 +2125,39 @@ describe('plugin-meetings', () => {
           },
         };
 
-        assert.deepEqual(locusInfo.getTheLocusToUpdate(newLocus), newLocus);
+        locusInfo.clearMainSessionLocusCache = sinon.stub();
+        const result = locusInfo.getTheLocusToUpdate(newLocus);
+        assert.calledOnce(locusInfo.clearMainSessionLocusCache)
+
+        assert.deepEqual(result, newLocus);
+      });
+
+      it('do not clear main session cache when "mainSessionLocusCache?.self?.removed" is not true', () => {
+        locusInfo.mainSessionLocusCache = {
+          controls: {
+            breakout: {
+              sessionType: 'MAIN',
+            },
+          },
+          self: {removed: undefined}
+        };
+        locusInfo.fullState = {state: 'ACTIVE'}
+        locusInfo.controls = {
+          breakout: {
+            sessionType: 'MAIN',
+          },
+        };
+        const newLocus = {
+          controls: {
+            breakout: {
+              sessionType: 'BREAKOUT',
+            },
+          },
+        };
+
+        locusInfo.clearMainSessionLocusCache = sinon.stub();
+        locusInfo.getTheLocusToUpdate(newLocus);
+        assert.notCalled(locusInfo.clearMainSessionLocusCache)
       });
     });