@webex/plugin-meetings 3.1.0-next.5 → 3.1.0-next.7

package/dist/types/media/properties.d.ts

@@ -84,10 +84,34 @@ export default class MediaProperties {
      * @returns {Promise<void>}
      */
     waitForMediaConnectionConnected(): Promise<void>;
+    /**
+     * Returns ICE transport information:
+     * - selectedCandidatePairChanges - number of times the selected candidate pair was changed, it should be at least 1 for successful connections
+     *  it will be -1 if browser doesn't supply this information
+     * - numTransports - number of transports (should be 1 if we're using bundle)
+     *
+     * @param {Array<any>} allStatsReports array of RTC stats reports
+     * @returns {Object}
+     */
+    private getTransportInfo;
     /**
      * Returns the type of a connection that has been established
+     * It should be 'UDP' | 'TCP' | 'TURN-TLS' | 'TURN-TCP' | 'TURN-UDP' | 'unknown'
+     *
+     * If connection was not established, it returns 'unknown'
+     *
+     * @param {Array<any>} allStatsReports array of RTC stats reports
+     * @returns {string}
+     */
+    private getConnectionType;
+    /**
+     * Returns information about current webrtc media connection
      *
-     * @returns {Promise<'UDP' | 'TCP' | 'TURN-TLS' | 'TURN-TCP' | 'TURN-UDP' | 'unknown'>}
+     * @returns {Promise<Object>}
      */
-    getCurrentConnectionType(): Promise<string>;
+    getCurrentConnectionInfo(): Promise<{
+        connectionType: string;
+        selectedCandidatePairChanges: number;
+        numTransports: number;
+    }>;
 }

package/dist/types/meeting/index.d.ts

@@ -454,6 +454,7 @@ export default class Meeting extends StatelessWebexPlugin {
     private deferSDPAnswer?;
     private sdpResponseTimer?;
     private hasMediaConnectionConnectedAtLeastOnce;
+    private joinWithMediaRetryInfo?;
     /**
      * @param {Object} attrs
      * @param {Object} options
@@ -1078,10 +1079,7 @@ export default class Meeting extends StatelessWebexPlugin {
     joinWithMedia(options?: {
         joinOptions?: any;
         mediaOptions?: AddMediaOptions;
-    }): Promise<{
-        join: any;
-        media: void;
-    }>;
+    }): any;
     /**
      * Initiates the reconnection of the media in the meeting
      *

package/dist/webinar/index.js

@@ -62,7 +62,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
   updateCanManageWebcast: function updateCanManageWebcast(canManageWebcast) {
     this.set('canManageWebcast', canManageWebcast);
   },
-  version: "3.1.0-next.5"
+  version: "3.1.0-next.7"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -43,7 +43,7 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/plugin-meetings": "3.1.0-next.5",
+    "@webex/plugin-meetings": "3.1.0-next.7",
     "@webex/plugin-rooms": "3.0.0-next.16",
     "@webex/test-helper-chai": "3.0.0-next.14",
     "@webex/test-helper-mocha": "3.0.0-next.14",
@@ -70,7 +70,7 @@
     "@webex/internal-plugin-metrics": "3.0.0-next.14",
     "@webex/internal-plugin-support": "3.0.0-next.16",
     "@webex/internal-plugin-user": "3.0.0-next.14",
-    "@webex/internal-plugin-voicea": "3.1.0-next.5",
+    "@webex/internal-plugin-voicea": "3.1.0-next.7",
     "@webex/media-helpers": "3.0.1-next.17",
     "@webex/plugin-people": "3.0.0-next.16",
     "@webex/plugin-rooms": "3.0.0-next.16",
@@ -91,5 +91,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.1.0-next.5"
+  "version": "3.1.0-next.7"
 }

package/src/media/properties.ts

@@ -1,3 +1,4 @@
+/* eslint-disable class-methods-use-this */
 import {
   LocalCameraStream,
   LocalMicrophoneStream,
@@ -182,25 +183,45 @@ export default class MediaProperties {
   }
 
   /**
-   * Returns the type of a connection that has been established
+   * Returns ICE transport information:
+   * - selectedCandidatePairChanges - number of times the selected candidate pair was changed, it should be at least 1 for successful connections
+   *  it will be -1 if browser doesn't supply this information
+   * - numTransports - number of transports (should be 1 if we're using bundle)
    *
-   * @returns {Promise<'UDP' | 'TCP' | 'TURN-TLS' | 'TURN-TCP' | 'TURN-UDP' | 'unknown'>}
+   * @param {Array<any>} allStatsReports array of RTC stats reports
+   * @returns {Object}
    */
-  async getCurrentConnectionType() {
-    // we can only get the connection type after ICE connection has been established
-    await this.waitForMediaConnectionConnected();
-
-    const allStatsReports = [];
+  private getTransportInfo(allStatsReports: any[]): {
+    selectedCandidatePairChanges: number;
+    numTransports: number;
+  } {
+    const transports = allStatsReports.filter((report) => report.type === 'transport');
 
-    try {
-      const statsResult = await this.webrtcMediaConnection.getStats();
-      statsResult.forEach((report) => allStatsReports.push(report));
-    } catch (error) {
+    if (transports.length > 1) {
       LoggerProxy.logger.warn(
-        `Media:properties#getCurrentConnectionType --> getStats() failed: ${error}`
+        `Media:properties#getSelectedCandidatePairChanges --> found more than 1 transport: ${transports.length}`
       );
     }
 
+    return {
+      selectedCandidatePairChanges:
+        transports.length > 0 && transports[0].selectedCandidatePairChanges !== undefined
+          ? transports[0].selectedCandidatePairChanges
+          : -1,
+      numTransports: transports.length,
+    };
+  }
+
+  /**
+   * Returns the type of a connection that has been established
+   * It should be 'UDP' | 'TCP' | 'TURN-TLS' | 'TURN-TCP' | 'TURN-UDP' | 'unknown'
+   *
+   * If connection was not established, it returns 'unknown'
+   *
+   * @param {Array<any>} allStatsReports array of RTC stats reports
+   * @returns {string}
+   */
+  private getConnectionType(allStatsReports: any[]) {
     const successfulCandidatePairs = allStatsReports.filter(
       (report) => report.type === 'candidate-pair' && report.state?.toLowerCase() === 'succeeded'
     );
@@ -215,7 +236,7 @@ export default class MediaProperties {
 
       if (localCandidate === undefined) {
         LoggerProxy.logger.warn(
-          `Media:properties#getCurrentConnectionType --> failed to find local candidate "${pair.localCandidateId}" in getStats() results`
+          `Media:properties#getConnectionType --> failed to find local candidate "${pair.localCandidateId}" in getStats() results`
         );
 
         return false;
@@ -235,7 +256,7 @@ export default class MediaProperties {
         return true;
       }
       LoggerProxy.logger.warn(
-        `Media:properties#getCurrentConnectionType --> missing localCandidate.protocol, candidateType=${localCandidate.candidateType}`
+        `Media:properties#getConnectionType --> missing localCandidate.protocol, candidateType=${localCandidate.candidateType}`
       );
 
       return false;
@@ -247,7 +268,7 @@ export default class MediaProperties {
         .map((report) => report.state);
 
       LoggerProxy.logger.warn(
-        `Media:properties#getCurrentConnectionType --> all candidate pair states: ${JSON.stringify(
+        `Media:properties#getConnectionType --> all candidate pair states: ${JSON.stringify(
           candidatePairStates
         )}`
       );
@@ -255,4 +276,35 @@ export default class MediaProperties {
 
     return foundConnectionType;
   }
+
+  /**
+   * Returns information about current webrtc media connection
+   *
+   * @returns {Promise<Object>}
+   */
+  async getCurrentConnectionInfo(): Promise<{
+    connectionType: string;
+    selectedCandidatePairChanges: number;
+    numTransports: number;
+  }> {
+    const allStatsReports = [];
+
+    try {
+      const statsResult = await this.webrtcMediaConnection.getStats();
+      statsResult.forEach((report) => allStatsReports.push(report));
+    } catch (error) {
+      LoggerProxy.logger.warn(
+        `Media:properties#getCurrentConnectionInfo --> getStats() failed: ${error}`
+      );
+    }
+
+    const connectionType = this.getConnectionType(allStatsReports);
+    const {selectedCandidatePairChanges, numTransports} = this.getTransportInfo(allStatsReports);
+
+    return {
+      connectionType,
+      selectedCandidatePairChanges,
+      numTransports,
+    };
+  }
 }

package/src/meeting/index.ts

@@ -678,6 +678,7 @@ export default class Meeting extends StatelessWebexPlugin {
   private deferSDPAnswer?: Defer; // used for waiting for a response
   private sdpResponseTimer?: ReturnType<typeof setTimeout>;
   private hasMediaConnectionConnectedAtLeastOnce: boolean;
+  private joinWithMediaRetryInfo?: {isRetry: boolean; prevJoinResponse?: any};
 
   /**
    * @param {Object} attrs
@@ -1459,6 +1460,15 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     this.hasMediaConnectionConnectedAtLeastOnce = false;
+
+    /**
+     * Information needed for a retry of a call to joinWithMedia
+     * @instance
+     * @type {{isRetry: boolean; prevJoinResponse?: any}}
+     * @private
+     * @memberof Meeting
+     */
+    this.joinWithMediaRetryInfo = {isRetry: false, prevJoinResponse: undefined};
   }
 
   /**
@@ -4527,6 +4537,7 @@ export default class Meeting extends StatelessWebexPlugin {
     } = {}
   ) {
     const {mediaOptions, joinOptions = {}} = options;
+    const {isRetry, prevJoinResponse} = this.joinWithMediaRetryInfo;
 
     if (!mediaOptions?.allowMediaInLobby) {
       return Promise.reject(
@@ -4538,6 +4549,7 @@ export default class Meeting extends StatelessWebexPlugin {
     LoggerProxy.logger.info('Meeting:index#joinWithMedia called');
 
     let joined = false;
+    let joinResponse = prevJoinResponse;
 
     try {
       let turnServerInfo;
@@ -4550,7 +4562,14 @@ export default class Meeting extends StatelessWebexPlugin {
       ({turnDiscoverySkippedReason} = turnDiscoveryRequest);
       joinOptions.roapMessage = turnDiscoveryRequest.roapMessage;
 
-      const joinResponse = await this.join(joinOptions);
+      if (!joinResponse) {
+        LoggerProxy.logger.info(
+          'Meeting:index#joinWithMedia ---> calling join with joinOptions, ',
+          joinOptions
+        );
+
+        joinResponse = await this.join(joinOptions);
+      }
 
       joined = true;
 
@@ -4568,6 +4587,8 @@ export default class Meeting extends StatelessWebexPlugin {
 
       const mediaResponse = await this.addMedia(mediaOptions, turnServerInfo);
 
+      this.joinWithMediaRetryInfo = {isRetry: false, prevJoinResponse: undefined};
+
       return {
         join: joinResponse,
         media: mediaResponse,
@@ -4579,7 +4600,7 @@ export default class Meeting extends StatelessWebexPlugin {
 
       this.roap.abortTurnDiscovery();
 
-      if (joined) {
+      if (joined && isRetry) {
         try {
           await this.leave({resourceId: joinOptions?.resourceId, reason: 'joinWithMedia failure'});
         } catch (e) {
@@ -4596,12 +4617,23 @@ export default class Meeting extends StatelessWebexPlugin {
           reason: error.message,
           stack: error.stack,
           leaveErrorReason: leaveError?.message,
+          isRetry,
         },
         {
           type: error.name,
         }
       );
 
+      if (!isRetry) {
+        LoggerProxy.logger.warn('Meeting:index#joinWithMedia --> retrying call to joinWithMedia');
+        this.joinWithMediaRetryInfo.isRetry = true;
+        this.joinWithMediaRetryInfo.prevJoinResponse = joinResponse;
+
+        return this.joinWithMedia(options);
+      }
+
+      this.joinWithMediaRetryInfo = {isRetry: false, prevJoinResponse: undefined};
+
       throw error;
     }
   }
@@ -6780,7 +6812,8 @@ export default class Meeting extends StatelessWebexPlugin {
         await this.enqueueScreenShareFloorRequest();
       }
 
-      const connectionType = await this.mediaProperties.getCurrentConnectionType();
+      const {connectionType, selectedCandidatePairChanges, numTransports} =
+        await this.mediaProperties.getCurrentConnectionInfo();
       // @ts-ignore
       const reachabilityStats = await this.webex.meetings.reachability.getReachabilityMetrics();
 
@@ -6788,8 +6821,11 @@ export default class Meeting extends StatelessWebexPlugin {
         correlation_id: this.correlationId,
         locus_id: this.locusUrl.split('/').pop(),
         connectionType,
+        selectedCandidatePairChanges,
+        numTransports,
         isMultistream: this.isMultistream,
         retriedWithTurnServer: this.retriedWithTurnServer,
+        isJoinWithMediaRetry: this.joinWithMediaRetryInfo.isRetry,
         ...reachabilityStats,
       });
       // @ts-ignore
@@ -6811,16 +6847,22 @@ export default class Meeting extends StatelessWebexPlugin {
       // @ts-ignore
       const reachabilityMetrics = await this.webex.meetings.reachability.getReachabilityMetrics();
 
+      const {selectedCandidatePairChanges, numTransports} =
+        await this.mediaProperties.getCurrentConnectionInfo();
+
       Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADD_MEDIA_FAILURE, {
         correlation_id: this.correlationId,
         locus_id: this.locusUrl.split('/').pop(),
         reason: error.message,
         stack: error.stack,
         code: error.code,
+        selectedCandidatePairChanges,
+        numTransports,
         turnDiscoverySkippedReason: this.turnDiscoverySkippedReason,
         turnServerUsed: this.turnServerUsed,
         retriedWithTurnServer: this.retriedWithTurnServer,
         isMultistream: this.isMultistream,
+        isJoinWithMediaRetry: this.joinWithMediaRetryInfo.isRetry,
         signalingState:
           this.mediaProperties.webrtcMediaConnection?.multistreamConnection?.pc?.pc
             ?.signalingState ||