@webex/plugin-meetings 3.8.0-next.54 → 3.8.0-next.56

package/dist/types/common/errors/webex-errors.d.ts

@@ -85,9 +85,15 @@ export { IceGatheringFailed };
  * @extends WebexMeetingsError
  * @property {number} code - 30203
  * @property {string} message - 'Failed to add media'
+ * @property {Error} [cause] - The underlying error that caused the failure
  */
 declare class AddMediaFailed extends WebexMeetingsError {
     static CODE: number;
-    constructor();
+    cause?: Error;
+    /**
+     * Creates a new AddMediaFailed error
+     * @param {Error} [cause] - The underlying error that caused the media addition to fail
+     */
+    constructor(cause?: Error);
 }
 export { AddMediaFailed };

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

@@ -1976,5 +1976,11 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {Promise<void>}
      */
     checkAndRefreshPermissionToken(threshold: number, reason: string): Promise<void>;
+    /**
+     * Gets the media reachability metrics
+     *
+     * @returns {Promise<MediaReachabilityMetrics>}
+     */
+    private getMediaReachabilityMetricFields;
 }
 export {};

package/dist/webinar/index.js

@@ -458,7 +458,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.8.0-next.54"
+  version: "3.8.0-next.56"
 });
 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.8.0-next.54",
+    "@webex/plugin-meetings": "3.8.0-next.56",
     "@webex/plugin-rooms": "3.8.0-next.21",
     "@webex/test-helper-chai": "3.8.0-next.17",
     "@webex/test-helper-mocha": "3.8.0-next.17",
@@ -71,7 +71,7 @@
     "@webex/internal-plugin-metrics": "3.8.0-next.17",
     "@webex/internal-plugin-support": "3.8.0-next.21",
     "@webex/internal-plugin-user": "3.8.0-next.17",
-    "@webex/internal-plugin-voicea": "3.8.0-next.54",
+    "@webex/internal-plugin-voicea": "3.8.0-next.56",
     "@webex/media-helpers": "3.8.0-next.19",
     "@webex/plugin-people": "3.8.0-next.19",
     "@webex/plugin-rooms": "3.8.0-next.21",
@@ -92,5 +92,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.8.0-next.54"
+  "version": "3.8.0-next.56"
 }

package/src/common/errors/webex-errors.ts

@@ -152,12 +152,19 @@ WebExMeetingsErrors[IceGatheringFailed.CODE] = IceGatheringFailed;
  * @extends WebexMeetingsError
  * @property {number} code - 30203
  * @property {string} message - 'Failed to add media'
+ * @property {Error} [cause] - The underlying error that caused the failure
  */
 class AddMediaFailed extends WebexMeetingsError {
   static CODE = 30203;
+  cause?: Error;
 
-  constructor() {
+  /**
+   * Creates a new AddMediaFailed error
+   * @param {Error} [cause] - The underlying error that caused the media addition to fail
+   */
+  constructor(cause?: Error) {
     super(AddMediaFailed.CODE, 'Failed to add media');
+    this.cause = cause;
   }
 }
 export {AddMediaFailed};

package/src/meeting/index.ts

@@ -164,6 +164,7 @@ import Member from '../member';
 import {BrbState, createBrbState} from './brbState';
 import MultistreamNotSupportedError from '../common/errors/multistream-not-supported-error';
 import JoinForbiddenError from '../common/errors/join-forbidden-error';
+import {ReachabilityMetrics} from '../reachability/reachability.types';
 
 // default callback so we don't call an undefined function, but in practice it should never be used
 const DEFAULT_ICE_PHASE_CALLBACK = () => 'JOIN_MEETING_FINAL';
@@ -262,6 +263,8 @@ type FetchMeetingInfoParams = {
   sendCAevents?: boolean;
 };
 
+type MediaReachabilityMetrics = ReachabilityMetrics & {isSubnetReachable: boolean};
+
 /**
  * MediaDirection
  * @typedef {Object} MediaDirection
@@ -7159,12 +7162,18 @@ export default class Meeting extends StatelessWebexPlugin {
           },
           options: {
             meetingId: this.id,
+            rawError: error,
           },
         });
       }
-      throw new Error(
+
+      const timedOutError = new Error(
         `Timed out waiting for media connection to be connected, correlationId=${this.correlationId}`
       );
+
+      timedOutError.cause = error;
+
+      throw timedOutError;
     }
   }
 
@@ -7225,6 +7234,9 @@ export default class Meeting extends StatelessWebexPlugin {
           ROAP_OFFER_ANSWER_EXCHANGE_TIMEOUT / 1000
         } seconds`
       );
+
+      const error = new Error('Timed out waiting for REMOTE SDP ANSWER');
+
       // @ts-ignore
       this.webex.internal.newMetrics.submitClientEvent({
         name: 'client.media-engine.remote-sdp-received',
@@ -7237,10 +7249,10 @@ export default class Meeting extends StatelessWebexPlugin {
             }),
           ],
         },
-        options: {meetingId: this.id, rawError: new Error('Timeout waiting for SDP answer')},
+        options: {meetingId: this.id, rawError: error},
       });
 
-      deferSDPAnswer.reject(new Error('Timed out waiting for REMOTE SDP ANSWER'));
+      deferSDPAnswer.reject(error);
     }, ROAP_OFFER_ANSWER_EXCHANGE_TIMEOUT);
 
     LoggerProxy.logger.info(`${LOG_HEADER} waiting for REMOTE SDP ANSWER...`);
@@ -7345,7 +7357,7 @@ export default class Meeting extends StatelessWebexPlugin {
         error
       );
 
-      throw new AddMediaFailed();
+      throw new AddMediaFailed(error);
     }
   }
 
@@ -7760,14 +7772,10 @@ export default class Meeting extends StatelessWebexPlugin {
 
       const {connectionType, selectedCandidatePairChanges, numTransports} =
         await this.mediaProperties.getCurrentConnectionInfo();
-      // @ts-ignore
-      const reachabilityStats = await this.webex.meetings.reachability.getReachabilityMetrics();
+
       const iceCandidateErrors = Object.fromEntries(this.iceCandidateErrors);
 
-      // @ts-ignore
-      const isSubnetReachable = this.webex.meetings.reachability.isSubnetReachable(
-        this.mediaServerIp
-      );
+      const reachabilityMetrics = await this.getMediaReachabilityMetricFields();
 
       Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADD_MEDIA_SUCCESS, {
         correlation_id: this.correlationId,
@@ -7778,8 +7786,7 @@ export default class Meeting extends StatelessWebexPlugin {
         isMultistream: this.isMultistream,
         retriedWithTurnServer: this.addMediaData.retriedWithTurnServer,
         isJoinWithMediaRetry: this.joinWithMediaRetryInfo.isRetry,
-        isSubnetReachable,
-        ...reachabilityStats,
+        ...reachabilityMetrics,
         ...iceCandidateErrors,
         iceCandidatesCount: this.iceCandidatesCount,
       });
@@ -7801,18 +7808,13 @@ export default class Meeting extends StatelessWebexPlugin {
       LoggerProxy.logger.error(`${LOG_HEADER} failed to establish media connection: `, error);
 
       // @ts-ignore
-      const reachabilityMetrics = await this.webex.meetings.reachability.getReachabilityMetrics();
+      const reachabilityMetrics = await this.getMediaReachabilityMetricFields();
 
       const {selectedCandidatePairChanges, numTransports} =
         await this.mediaProperties.getCurrentConnectionInfo();
 
       const iceCandidateErrors = Object.fromEntries(this.iceCandidateErrors);
 
-      // @ts-ignore
-      const isSubnetReachable = this.webex.meetings.reachability.isSubnetReachable(
-        this.mediaServerIp
-      );
-
       Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.ADD_MEDIA_FAILURE, {
         correlation_id: this.correlationId,
         locus_id: this.locusUrl.split('/').pop(),
@@ -7842,7 +7844,6 @@ export default class Meeting extends StatelessWebexPlugin {
           this.mediaProperties.webrtcMediaConnection?.mediaConnection?.pc?.iceConnectionState ||
           'unknown',
         ...reachabilityMetrics,
-        isSubnetReachable,
         ...iceCandidateErrors,
         iceCandidatesCount: this.iceCandidatesCount,
       });
@@ -9613,4 +9614,44 @@ export default class Meeting extends StatelessWebexPlugin {
 
     return Promise.resolve();
   }
+
+  /**
+   * Gets the media reachability metrics
+   *
+   * @returns {Promise<MediaReachabilityMetrics>}
+   */
+  private async getMediaReachabilityMetricFields(): Promise<MediaReachabilityMetrics> {
+    const reachabilityMetrics: ReachabilityMetrics =
+      // @ts-ignore
+      await this.webex.meetings.reachability.getReachabilityMetrics();
+
+    const successKeys: Array<keyof ReachabilityMetrics> = [
+      'reachability_public_udp_success',
+      'reachability_public_tcp_success',
+      'reachability_public_xtls_success',
+      'reachability_vmn_udp_success',
+      'reachability_vmn_tcp_success',
+      'reachability_vmn_xtls_success',
+    ];
+
+    const totalSuccessCases = successKeys.reduce((total, key) => {
+      const value = reachabilityMetrics[key];
+      if (typeof value === 'number') {
+        return total + value;
+      }
+
+      return total;
+    }, 0);
+
+    let isSubnetReachable = null;
+    if (totalSuccessCases > 0) {
+      // @ts-ignore
+      isSubnetReachable = this.webex.meetings.reachability.isSubnetReachable(this.mediaServerIp);
+    }
+
+    return {
+      ...reachabilityMetrics,
+      isSubnetReachable,
+    };
+  }
 }

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

@@ -2166,7 +2166,7 @@ describe('plugin-meetings', () => {
               someReachabilityMetric1: 'some value1',
               someReachabilityMetric2: 'some value2',
               selectedCandidatePairChanges: 2,
-              isSubnetReachable: false,
+              isSubnetReachable: null,
               numTransports: 1,
               iceCandidatesCount: 0,
             }
@@ -2213,7 +2213,7 @@ describe('plugin-meetings', () => {
               signalingState: 'unknown',
               connectionState: 'unknown',
               iceConnectionState: 'unknown',
-              isSubnetReachable: true,
+              isSubnetReachable: null,
             })
           );
 
@@ -2279,7 +2279,7 @@ describe('plugin-meetings', () => {
               selectedCandidatePairChanges: 2,
               numTransports: 1,
               iceCandidatesCount: 0,
-              isSubnetReachable: true,
+              isSubnetReachable: null,
             }
           );
         });
@@ -2337,7 +2337,7 @@ describe('plugin-meetings', () => {
               signalingState: 'have-local-offer',
               connectionState: 'connecting',
               iceConnectionState: 'checking',
-              isSubnetReachable: true,
+              isSubnetReachable: null,
             })
           );
 
@@ -2395,7 +2395,7 @@ describe('plugin-meetings', () => {
               signalingState: 'have-local-offer',
               connectionState: 'connecting',
               iceConnectionState: 'checking',
-              isSubnetReachable: true,
+              isSubnetReachable: null,
             })
           );
 
@@ -2731,7 +2731,7 @@ describe('plugin-meetings', () => {
               sinon.stub().returns(FAKE_ERROR));
           webex.meetings.reachability = {
             isWebexMediaBackendUnreachable: sinon.stub().resolves(false),
-            getReachabilityMetrics: sinon.stub().resolves(),
+            getReachabilityMetrics: sinon.stub().resolves({}),
             stopReachability: sinon.stub(),
             isSubnetReachable: sinon.stub().returns(true),
           };
@@ -2762,7 +2762,8 @@ describe('plugin-meetings', () => {
               turnDiscoverySkippedReason: undefined,
             });
           meeting.meetingState = 'ACTIVE';
-          meeting.mediaProperties.waitForMediaConnectionConnected.rejects({iceConnected: false});
+          const error = {iceConnected: false}
+          meeting.mediaProperties.waitForMediaConnectionConnected.rejects(error);
 
           const forceRtcMetricsSend = sinon.stub().resolves();
           const closeMediaConnectionStub = sinon.stub();
@@ -2780,6 +2781,7 @@ describe('plugin-meetings', () => {
             })
             .catch((err) => {
               errorThrown = err;
+              assert.instanceOf(err.cause, Error);
               assert.instanceOf(err, AddMediaFailed);
             });
 
@@ -2836,6 +2838,7 @@ describe('plugin-meetings', () => {
             },
             options: {
               meetingId: meeting.id,
+              rawError: error,
             },
           });
           assert.calledWith(webex.internal.newMetrics.submitClientEvent.thirdCall, {
@@ -2847,6 +2850,7 @@ describe('plugin-meetings', () => {
             },
             options: {
               meetingId: meeting.id,
+              rawError: error,
             },
           });
 
@@ -2913,7 +2917,7 @@ describe('plugin-meetings', () => {
               selectedCandidatePairChanges: 2,
               numTransports: 1,
               iceCandidatesCount: 0,
-              isSubnetReachable: true,
+              isSubnetReachable: null,
             },
           ]);
 
@@ -2975,10 +2979,13 @@ describe('plugin-meetings', () => {
               },
               turnDiscoverySkippedReason: undefined,
             });
+
+          const mediaConnectionError = new Error('fake error');
+
           meeting.mediaProperties.waitForMediaConnectionConnected = sinon
             .stub()
             .onFirstCall()
-            .rejects()
+            .rejects(mediaConnectionError)
             .onSecondCall()
             .resolves();
 
@@ -3047,6 +3054,7 @@ describe('plugin-meetings', () => {
             },
             options: {
               meetingId: meeting.id,
+              rawError: mediaConnectionError,
             },
           });
           assert.calledWith(webex.internal.newMetrics.submitClientEvent.thirdCall, {
@@ -3112,7 +3120,7 @@ describe('plugin-meetings', () => {
               retriedWithTurnServer: true,
               isJoinWithMediaRetry: false,
               iceCandidatesCount: 0,
-              isSubnetReachable: true,
+              isSubnetReachable: null,
             },
           ]);
           meeting.roap.doTurnDiscovery;
@@ -3269,7 +3277,7 @@ describe('plugin-meetings', () => {
               iceCandidatesCount: 3,
               '701_error': 3,
               '701_turn_host_lookup_received_error': 1,
-              isSubnetReachable: true,
+              isSubnetReachable: null,
             }
           );
 
@@ -3332,7 +3340,7 @@ describe('plugin-meetings', () => {
               iceConnectionState: 'unknown',
               selectedCandidatePairChanges: 2,
               numTransports: 1,
-              isSubnetReachable: true,
+              isSubnetReachable: null,
               iceCandidatesCount: 0,
             }
           );
@@ -3394,6 +3402,120 @@ describe('plugin-meetings', () => {
               numTransports: 1,
               '701_error': 2,
               '701_turn_host_lookup_received_error': 1,
+              isSubnetReachable: null,
+              iceCandidatesCount: 0,
+            }
+          );
+
+          assert.isOk(errorThrown);
+        });
+
+        it('should send valid isSubnetReachability if media connection success', async () => {
+          meeting.roap.doTurnDiscovery = sinon.stub().returns({
+            turnServerInfo: undefined,
+            turnDiscoverySkippedReason: undefined,
+          });
+          meeting.meetingState = 'ACTIVE';
+          meeting.mediaProperties.waitForMediaConnectionConnected.resolves();
+          meeting.webex.meetings.reachability = {
+            getReachabilityMetrics: sinon.stub().resolves({
+              reachability_public_udp_success: 5,
+            }),
+            stopReachability: sinon.stub(),
+            isSubnetReachable: sinon.stub().returns(false),
+          };
+
+          const forceRtcMetricsSend = sinon.stub().resolves();
+          const closeMediaConnectionStub = sinon.stub();
+          Media.createMediaConnection = sinon.stub().returns({
+            close: closeMediaConnectionStub,
+            forceRtcMetricsSend,
+            getConnectionState: sinon.stub().returns(ConnectionState.Connected),
+            initiateOffer: sinon.stub().resolves({}),
+            on: sinon.stub(),
+          });
+
+          await meeting
+            .addMedia({
+              mediaSettings: {},
+            });
+
+          assert.calledWith(
+            Metrics.sendBehavioralMetric,
+            BEHAVIORAL_METRICS.ADD_MEDIA_SUCCESS,
+            {
+              correlation_id: meeting.correlationId,
+              locus_id: meeting.locusUrl.split('/').pop(),
+              connectionType: 'udp',
+              selectedCandidatePairChanges: 2,
+              numTransports: 1,
+              isMultistream: false,
+              retriedWithTurnServer: false,
+              isJoinWithMediaRetry: false,
+              iceCandidatesCount: 0,
+              reachability_public_udp_success: 5,
+              isSubnetReachable: false,
+            }
+          );
+        });
+
+        it('should send valid isSubnetReachability if media connection fails', async () => {
+          let errorThrown = undefined;
+
+          meeting.roap.doTurnDiscovery = sinon.stub().returns({
+            turnServerInfo: undefined,
+            turnDiscoverySkippedReason: undefined,
+          });
+          meeting.meetingState = 'ACTIVE';
+          meeting.mediaProperties.waitForMediaConnectionConnected.rejects({iceConnected: false});
+          meeting.webex.meetings.reachability = {
+            getReachabilityMetrics: sinon.stub().resolves({
+              reachability_public_udp_success: 5,
+            }),
+            stopReachability: sinon.stub(),
+            isSubnetReachable: sinon.stub().returns(true),
+          };
+
+          const forceRtcMetricsSend = sinon.stub().resolves();
+          const closeMediaConnectionStub = sinon.stub();
+          Media.createMediaConnection = sinon.stub().returns({
+            close: closeMediaConnectionStub,
+            forceRtcMetricsSend,
+            getConnectionState: sinon.stub().returns(ConnectionState.Connected),
+            initiateOffer: sinon.stub().resolves({}),
+            on: sinon.stub(),
+          });
+
+          await meeting
+            .addMedia({
+              mediaSettings: {},
+            })
+            .catch((err) => {
+              errorThrown = err;
+              assert.instanceOf(err, AddMediaFailed);
+            });
+
+          // Check that the only metric sent is ADD_MEDIA_FAILURE
+          assert.calledOnceWithExactly(
+            Metrics.sendBehavioralMetric,
+            BEHAVIORAL_METRICS.ADD_MEDIA_FAILURE,
+            {
+              correlation_id: meeting.correlationId,
+              locus_id: meeting.locusUrl.split('/').pop(),
+              reason: errorThrown.message,
+              stack: errorThrown.stack,
+              code: errorThrown.code,
+              turnDiscoverySkippedReason: undefined,
+              turnServerUsed: true,
+              retriedWithTurnServer: false,
+              isMultistream: false,
+              isJoinWithMediaRetry: false,
+              signalingState: 'unknown',
+              connectionState: 'unknown',
+              iceConnectionState: 'unknown',
+              selectedCandidatePairChanges: 2,
+              numTransports: 1,
+              reachability_public_udp_success: 5,
               isSubnetReachable: true,
               iceCandidatesCount: 0,
             }
@@ -3957,6 +4079,9 @@ describe('plugin-meetings', () => {
                   },
                   options: {
                     meetingId: meeting.id,
+                    rawError: {
+                      iceConnected: false,
+                    }
                   },
                 },
               ]);