@webex/plugin-meetings 3.8.0-next.46 → 3.8.0-next.48

package/src/meeting/index.ts

@@ -5856,16 +5856,7 @@ export default class Meeting extends StatelessWebexPlugin {
           this
         );
 
-        const proxyError = new Proxy(error, {
-          // eslint-disable-next-line require-jsdoc
-          get(target, prop) {
-            if (prop === 'handledBySdk') {
-              return true;
-            }
-
-            return Reflect.get(target, prop);
-          },
-        });
+        const proxyError = MeetingUtil.markErrorAsHandledBySdk(error);
 
         joinFailed(proxyError);
 
@@ -6254,10 +6245,10 @@ export default class Meeting extends StatelessWebexPlugin {
   /**
    * Handles ROAP_FAILURE event from the webrtc media connection
    *
-   * @param {Error} error
+   * @param {Error} roapError
    * @returns {void}
    */
-  handleRoapFailure = (error) => {
+  handleRoapFailure = (roapError) => {
     // eslint-disable-next-line @typescript-eslint/no-shadow
     const sendBehavioralMetric = (metricName, error, correlationId) => {
       const data = {
@@ -6273,6 +6264,8 @@ export default class Meeting extends StatelessWebexPlugin {
       Metrics.sendBehavioralMetric(metricName, data, metadata);
     };
 
+    const error = MeetingUtil.markErrorAsHandledBySdk(roapError);
+
     if (error instanceof Errors.SdpOfferCreationError) {
       sendBehavioralMetric(BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE, error, this.correlationId);
 
@@ -6311,7 +6304,7 @@ export default class Meeting extends StatelessWebexPlugin {
         clearTimeout(this.sdpResponseTimer);
         this.sdpResponseTimer = undefined;
 
-        this.deferSDPAnswer.reject();
+        this.deferSDPAnswer.reject(error);
       }
     } else if (error instanceof Errors.SdpError) {
       // this covers also the case of Errors.IceGatheringError which extends Errors.SdpError
@@ -6466,7 +6459,9 @@ export default class Meeting extends StatelessWebexPlugin {
               {
                 logText: `${LOG_HEADER} Roap Offer`,
               }
-            ).catch((error) => {
+            ).catch((originalError) => {
+              const error = MeetingUtil.markErrorAsHandledBySdk(originalError);
+
               const multistreamNotSupported = error instanceof MultistreamNotSupportedError;
 
               // @ts-ignore
@@ -7114,7 +7109,28 @@ export default class Meeting extends StatelessWebexPlugin {
     } catch (error) {
       const {iceConnected} = error;
 
+      let handledBySdk = false;
+
       if (!this.hasMediaConnectionConnectedAtLeastOnce) {
+        const caError =
+          // @ts-ignore
+          this.webex.internal.newMetrics.callDiagnosticMetrics.getErrorPayloadForClientErrorCode({
+            clientErrorCode: CallDiagnosticUtils.generateClientErrorCodeForIceFailure({
+              signalingState:
+                this.mediaProperties.webrtcMediaConnection?.multistreamConnection?.pc?.pc
+                  ?.signalingState ||
+                this.mediaProperties.webrtcMediaConnection?.mediaConnection?.pc?.signalingState ||
+                'unknown',
+              iceConnected,
+              turnServerUsed: this.turnServerUsed,
+              unreachable:
+                // @ts-ignore
+                await this.webex.meetings.reachability
+                  .isWebexMediaBackendUnreachable()
+                  .catch(() => false),
+            }),
+          });
+
         // Only send CA event for join flow if we haven't successfully connected media yet
         // @ts-ignore
         this.webex.internal.newMetrics.submitClientEvent({
@@ -7122,37 +7138,25 @@ export default class Meeting extends StatelessWebexPlugin {
           payload: {
             canProceed: !this.turnServerUsed, // If we haven't done turn tls retry yet we will proceed with join attempt
             icePhase: this.addMediaData.icePhaseCallback(),
-            errors: [
-              // @ts-ignore
-              this.webex.internal.newMetrics.callDiagnosticMetrics.getErrorPayloadForClientErrorCode(
-                {
-                  clientErrorCode: CallDiagnosticUtils.generateClientErrorCodeForIceFailure({
-                    signalingState:
-                      this.mediaProperties.webrtcMediaConnection?.multistreamConnection?.pc?.pc
-                        ?.signalingState ||
-                      this.mediaProperties.webrtcMediaConnection?.mediaConnection?.pc
-                        ?.signalingState ||
-                      'unknown',
-                    iceConnected,
-                    turnServerUsed: this.turnServerUsed,
-                    unreachable:
-                      // @ts-ignore
-                      await this.webex.meetings.reachability
-                        .isWebexMediaBackendUnreachable()
-                        .catch(() => false),
-                  }),
-                }
-              ),
-            ],
+            errors: [caError],
           },
           options: {
             meetingId: this.id,
           },
         });
+
+        handledBySdk = true;
       }
-      throw new Error(
+
+      let timedOutError = new Error(
         `Timed out waiting for media connection to be connected, correlationId=${this.correlationId}`
       );
+
+      if (handledBySdk) {
+        timedOutError = MeetingUtil.markErrorAsHandledBySdk(timedOutError);
+      }
+
+      throw timedOutError;
     }
   }
 
@@ -7213,6 +7217,11 @@ export default class Meeting extends StatelessWebexPlugin {
           ROAP_OFFER_ANSWER_EXCHANGE_TIMEOUT / 1000
         } seconds`
       );
+
+      const timeoutError = new Error('Timeout waiting for SDP answer');
+
+      const timeoutErrorProxy = MeetingUtil.markErrorAsHandledBySdk(timeoutError);
+
       // @ts-ignore
       this.webex.internal.newMetrics.submitClientEvent({
         name: 'client.media-engine.remote-sdp-received',
@@ -7225,7 +7234,7 @@ export default class Meeting extends StatelessWebexPlugin {
             }),
           ],
         },
-        options: {meetingId: this.id, rawError: new Error('Timeout waiting for SDP answer')},
+        options: {meetingId: this.id, rawError: timeoutErrorProxy},
       });
 
       deferSDPAnswer.reject(new Error('Timed out waiting for REMOTE SDP ANSWER'));
@@ -7333,7 +7342,14 @@ export default class Meeting extends StatelessWebexPlugin {
         error
       );
 
-      throw new AddMediaFailed();
+      let addMediaFailedError = new AddMediaFailed();
+
+      // @ts-ignore - handledBySdk is added by a proxy
+      if (error.handledBySdk) {
+        addMediaFailedError = MeetingUtil.markErrorAsHandledBySdk(addMediaFailedError);
+      }
+
+      throw addMediaFailedError;
     }
   }
 

package/src/meeting/locusMediaRequest.ts

@@ -6,6 +6,7 @@ import {WebexPlugin} from '@webex/webex-core';
 import {MEDIA, HTTP_VERBS, ROAP} from '../constants';
 import LoggerProxy from '../common/logs/logger-proxy';
 import {ClientMediaPreferences} from '../reachability/reachability.types';
+import MeetingUtil from './util';
 
 export type MediaRequestType = 'RoapMessage' | 'LocalMute';
 export type RequestResult = any;
@@ -263,7 +264,9 @@ export class LocusMediaRequest extends WebexPlugin {
 
         return result;
       })
-      .catch((e) => {
+      .catch((error) => {
+        let e = error;
+
         if (
           isRequestAffectingConfluenceState(request) &&
           this.confluenceState === 'creation in progress'
@@ -272,6 +275,8 @@ export class LocusMediaRequest extends WebexPlugin {
         }
 
         if (request.type === 'RoapMessage') {
+          e = MeetingUtil.markErrorAsHandledBySdk(e);
+
           // @ts-ignore
           this.webex.internal.newMetrics.submitClientEvent({
             name: 'client.locus.media.response',

package/src/meeting/util.ts

@@ -812,6 +812,24 @@ const MeetingUtil = {
       },
     ];
   },
+
+  /**
+   * Creates a proxy object to mark an error as handled by the SDK.
+   * @param {Error} error original error
+   * @returns {Proxy} proxy object with handledBySdk property
+   */
+  markErrorAsHandledBySdk: (error) => {
+    return new Proxy(error, {
+      // eslint-disable-next-line require-jsdoc
+      get(target, prop) {
+        if (prop === 'handledBySdk') {
+          return true;
+        }
+
+        return Reflect.get(target, prop);
+      },
+    });
+  },
 };
 
 export default MeetingUtil;

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

@@ -1011,13 +1011,19 @@ describe('plugin-meetings', () => {
             .stub()
             .returns(fakeClientError);
 
-          // call joinWithMedia() - it should fail
-          await assert.isRejected(
-            meeting.joinWithMedia({
+          const promise = meeting.joinWithMedia({
               joinOptions,
               mediaOptions,
             })
-          );
+
+          // call joinWithMedia() - it should fail
+          await assert.isRejected(promise);
+
+          const rejectedError = await promise.catch((error) => error);
+
+          // Since the SDK has sent the CA events, we need to mark this error as handled
+          // so the client doesn't try and send CA events again
+          assert.isTrue(rejectedError.handledBySdk);
 
           // check the right CA events have been sent:
           // calls at index 0 and 2 to submitClientEvent are for "client.media.capabilities" which we don't care about in this test
@@ -8810,14 +8816,21 @@ describe('plugin-meetings', () => {
             clock.restore();
           });
 
-          const checkMetricSent = (event, error) => {
+          const checkMetricSent = (event, error, expectedErrorCode) => {
             assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
-            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+            assert.deepEqual(webex.internal.newMetrics.submitClientEvent.getCall(0).args[0], {
               name: event,
               payload: {
                 canProceed: false,
               },
-              options: {rawError: error, meetingId: meeting.id},
+              options: {
+                rawError: {
+                  ...(error.cause ? {cause: {name: error.cause.name}} : {cause: undefined}),
+                  code: expectedErrorCode,
+                  name: error.name,
+                },
+                meetingId: meeting.id,
+              },
             });
           };
 
@@ -8851,7 +8864,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[MediaConnectionEventNames.ROAP_FAILURE](fakeError);
 
-            checkMetricSent('client.media-engine.local-sdp-generated', fakeError);
+            checkMetricSent('client.media-engine.local-sdp-generated', fakeError, 30005);
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE,
               Errors.ErrorCode.SdpOfferCreationError,
@@ -8868,7 +8881,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[MediaConnectionEventNames.ROAP_FAILURE](fakeError);
 
-            checkMetricSent('client.media-engine.remote-sdp-received', fakeError);
+            checkMetricSent('client.media-engine.remote-sdp-received', fakeError, 30006);
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE,
               Errors.ErrorCode.SdpOfferHandlingError,
@@ -8892,7 +8905,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[MediaConnectionEventNames.ROAP_FAILURE](fakeError);
 
-            checkMetricSent('client.media-engine.remote-sdp-received', fakeError);
+            checkMetricSent('client.media-engine.remote-sdp-received', fakeError, 30004);
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE,
               Errors.ErrorCode.SdpAnswerHandlingError,
@@ -8900,6 +8913,7 @@ describe('plugin-meetings', () => {
               fakeRootCauseName
             );
             assert.calledOnce(meeting.deferSDPAnswer.reject);
+            assert.isTrue(meeting.deferSDPAnswer.reject.getCall(0).args[0].handledBySdk);
             assert.calledOnce(clearTimeoutSpy);
           });
 
@@ -8909,7 +8923,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[MediaConnectionEventNames.ROAP_FAILURE](fakeError);
 
-            checkMetricSent('client.media-engine.local-sdp-generated', fakeError);
+            checkMetricSent('client.media-engine.local-sdp-generated', fakeError, 30002);
             // expectedMetadataType is the error name in this case
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.INVALID_ICE_CANDIDATE,
@@ -8927,7 +8941,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[MediaConnectionEventNames.ROAP_FAILURE](fakeError);
 
-            checkMetricSent('client.media-engine.local-sdp-generated', fakeError);
+            checkMetricSent('client.media-engine.local-sdp-generated', fakeError, 30003);
             // expectedMetadataType is the error name in this case
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.INVALID_ICE_CANDIDATE,
@@ -9121,7 +9135,7 @@ describe('plugin-meetings', () => {
             assert.calledOnceWithExactly(getErrorPayloadForClientErrorCodeStub, {
               clientErrorCode: expectedErrorCode,
             });
-            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+            assert.deepEqual(webex.internal.newMetrics.submitClientEvent.getCall(0).args[0], {
               name: 'client.media-engine.remote-sdp-received',
               payload: {
                 canProceed,
@@ -9129,9 +9143,18 @@ describe('plugin-meetings', () => {
               },
               options: {
                 meetingId: meeting.id,
-                rawError: fakeError,
+                rawError: fakeError instanceof MultistreamNotSupportedError ? {
+                  code: fakeError.code,
+                  name: fakeError.name,
+                  sdkMessage: fakeError.sdkMessage,
+                  error: fakeError.error,
+                } : {},
               },
             });
+            const actualError = webex.internal.newMetrics.submitClientEvent.getCall(0).args[0].options.rawError;
+
+            assert.isTrue(actualError.handledBySdk);
+            assert.equal(actualError.message, fakeError.message);
           };
 
           it('handles OFFER message correctly when request fails', async () => {

package/test/unit/spec/meeting/locusMediaRequest.ts

@@ -185,7 +185,12 @@ describe('LocusMediaRequest.send()', () => {
 
   it('sends correct metric event when roap message fails', async () => {
     webexRequestStub.rejects({code: 300, message: 'fake error'});
-    await assert.isRejected(sendRoapMessage('OFFER'));
+
+    const promise = sendRoapMessage('OFFER');
+    await assert.isRejected(promise);
+
+    const error = await promise.catch((err) => err);
+    assert.isTrue(error.handledBySdk);
 
     assert.calledWith(mockWebex.internal.newMetrics.submitClientEvent, {
       name: 'client.locus.media.response',

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

@@ -1185,6 +1185,14 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('markErrorAsHandledBySdk', () => {
+      it('should set the error as handled', () => {
+        const error = MeetingUtil.markErrorAsHandledBySdk(new Error('Test error'));
+
+        assert.isTrue(error.handledBySdk);
+      })
+    });
+
     describe('getChangeMeetingFloorErrorPayload', () => {
       [
         {