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

package/src/meeting/index.ts

@@ -1600,6 +1600,10 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     this.#isoLocalClientMeetingJoinTime = undefined;
 
+    // We clear the error cache of CA events on every new meeting instance
+    // @ts-ignore - Fix type
+    this.webex.internal.newMetrics.callDiagnosticMetrics.clearErrorCache();
+
     /**
      * IP Address of the remote media server
      * @instance
@@ -5866,13 +5870,11 @@ export default class Meeting extends StatelessWebexPlugin {
           this
         );
 
-        const proxyError = MeetingUtil.markErrorAsHandledBySdk(error);
-
-        joinFailed(proxyError);
+        joinFailed(error);
 
         this.deferJoin = undefined;
 
-        return Promise.reject(proxyError);
+        return Promise.reject(error);
       })
       .then((join) => {
         // @ts-ignore - config coming from registerPlugin
@@ -6255,10 +6257,10 @@ export default class Meeting extends StatelessWebexPlugin {
   /**
    * Handles ROAP_FAILURE event from the webrtc media connection
    *
-   * @param {Error} roapError
+   * @param {Error} error
    * @returns {void}
    */
-  handleRoapFailure = (roapError) => {
+  handleRoapFailure = (error) => {
     // eslint-disable-next-line @typescript-eslint/no-shadow
     const sendBehavioralMetric = (metricName, error, correlationId) => {
       const data = {
@@ -6274,8 +6276,6 @@ 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);
 
@@ -6314,7 +6314,7 @@ export default class Meeting extends StatelessWebexPlugin {
         clearTimeout(this.sdpResponseTimer);
         this.sdpResponseTimer = undefined;
 
-        this.deferSDPAnswer.reject(error);
+        this.deferSDPAnswer.reject();
       }
     } else if (error instanceof Errors.SdpError) {
       // this covers also the case of Errors.IceGatheringError which extends Errors.SdpError
@@ -6478,9 +6478,7 @@ export default class Meeting extends StatelessWebexPlugin {
               {
                 logText: `${LOG_HEADER} Roap Offer`,
               }
-            ).catch((originalError) => {
-              const error = MeetingUtil.markErrorAsHandledBySdk(originalError);
-
+            ).catch((error) => {
               const multistreamNotSupported = error instanceof MultistreamNotSupportedError;
 
               // @ts-ignore
@@ -7128,28 +7126,7 @@ 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({
@@ -7157,25 +7134,37 @@ 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: [caError],
+            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),
+                  }),
+                }
+              ),
+            ],
           },
           options: {
             meetingId: this.id,
           },
         });
-
-        handledBySdk = true;
       }
-
-      let timedOutError = new Error(
+      throw new Error(
         `Timed out waiting for media connection to be connected, correlationId=${this.correlationId}`
       );
-
-      if (handledBySdk) {
-        timedOutError = MeetingUtil.markErrorAsHandledBySdk(timedOutError);
-      }
-
-      throw timedOutError;
     }
   }
 
@@ -7236,11 +7225,6 @@ 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',
@@ -7253,7 +7237,7 @@ export default class Meeting extends StatelessWebexPlugin {
             }),
           ],
         },
-        options: {meetingId: this.id, rawError: timeoutErrorProxy},
+        options: {meetingId: this.id, rawError: new Error('Timeout waiting for SDP answer')},
       });
 
       deferSDPAnswer.reject(new Error('Timed out waiting for REMOTE SDP ANSWER'));
@@ -7361,14 +7345,7 @@ export default class Meeting extends StatelessWebexPlugin {
         error
       );
 
-      let addMediaFailedError = new AddMediaFailed();
-
-      // @ts-ignore - handledBySdk is added by a proxy
-      if (error.handledBySdk) {
-        addMediaFailedError = MeetingUtil.markErrorAsHandledBySdk(addMediaFailedError);
-      }
-
-      throw addMediaFailedError;
+      throw new AddMediaFailed();
     }
   }
 

package/src/meeting/locusMediaRequest.ts

@@ -6,7 +6,6 @@ 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;
@@ -264,9 +263,7 @@ export class LocusMediaRequest extends WebexPlugin {
 
         return result;
       })
-      .catch((error) => {
-        let e = error;
-
+      .catch((e) => {
         if (
           isRequestAffectingConfluenceState(request) &&
           this.confluenceState === 'creation in progress'
@@ -275,8 +272,6 @@ 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,24 +812,6 @@ 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

@@ -243,6 +243,7 @@ describe('plugin-meetings', () => {
       },
     });
 
+    webex.internal.newMetrics.callDiagnosticMetrics.clearErrorCache = sinon.stub();
     webex.internal.support.submitLogs = sinon.stub().returns(Promise.resolve());
     webex.internal.services = {get: sinon.stub().returns('locus-url')};
     webex.credentials.getOrgId = sinon.stub().returns('fake-org-id');
@@ -1012,19 +1013,13 @@ describe('plugin-meetings', () => {
             .stub()
             .returns(fakeClientError);
 
-          const promise = meeting.joinWithMedia({
+          // call joinWithMedia() - it should fail
+          await assert.isRejected(
+            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
@@ -1816,7 +1811,6 @@ describe('plugin-meetings', () => {
                 await meeting.join();
                 joinSucceeded = true;
               } catch (e) {
-                assert.isTrue(e.handledBySdk)
                 assert.instanceOf(e, IntentToJoinError);
               }
               assert.isFalse(joinSucceeded);
@@ -1869,20 +1863,7 @@ describe('plugin-meetings', () => {
             });
           });
           it('should try to join the meeting and return promise reject', async () => {
-            await meeting.join().catch((e) => {
-              assert.isTrue(e.handledBySdk);
-              assert.calledOnce(MeetingUtil.joinMeeting);
-            });
-          });
-
-          it('should try to join the meeting and return deferred promise reject', async () => {
-
-            // call first
-            meeting.join();
-
-            // call 2nd time will get the deferred promise
-            await meeting.join().catch((e) => {
-              assert.isTrue(e.handledBySdk);
+            await meeting.join().catch(() => {
               assert.calledOnce(MeetingUtil.joinMeeting);
             });
           });
@@ -8832,21 +8813,14 @@ describe('plugin-meetings', () => {
             clock.restore();
           });
 
-          const checkMetricSent = (event, error, expectedErrorCode) => {
+          const checkMetricSent = (event, error) => {
             assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
-            assert.deepEqual(webex.internal.newMetrics.submitClientEvent.getCall(0).args[0], {
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
               name: event,
               payload: {
                 canProceed: false,
               },
-              options: {
-                rawError: {
-                  ...(error.cause ? {cause: {name: error.cause.name}} : {cause: undefined}),
-                  code: expectedErrorCode,
-                  name: error.name,
-                },
-                meetingId: meeting.id,
-              },
+              options: {rawError: error, meetingId: meeting.id},
             });
           };
 
@@ -8880,7 +8854,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[MediaConnectionEventNames.ROAP_FAILURE](fakeError);
 
-            checkMetricSent('client.media-engine.local-sdp-generated', fakeError, 30005);
+            checkMetricSent('client.media-engine.local-sdp-generated', fakeError);
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE,
               Errors.ErrorCode.SdpOfferCreationError,
@@ -8897,7 +8871,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[MediaConnectionEventNames.ROAP_FAILURE](fakeError);
 
-            checkMetricSent('client.media-engine.remote-sdp-received', fakeError, 30006);
+            checkMetricSent('client.media-engine.remote-sdp-received', fakeError);
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE,
               Errors.ErrorCode.SdpOfferHandlingError,
@@ -8921,7 +8895,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[MediaConnectionEventNames.ROAP_FAILURE](fakeError);
 
-            checkMetricSent('client.media-engine.remote-sdp-received', fakeError, 30004);
+            checkMetricSent('client.media-engine.remote-sdp-received', fakeError);
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE,
               Errors.ErrorCode.SdpAnswerHandlingError,
@@ -8929,7 +8903,6 @@ describe('plugin-meetings', () => {
               fakeRootCauseName
             );
             assert.calledOnce(meeting.deferSDPAnswer.reject);
-            assert.isTrue(meeting.deferSDPAnswer.reject.getCall(0).args[0].handledBySdk);
             assert.calledOnce(clearTimeoutSpy);
           });
 
@@ -8939,7 +8912,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[MediaConnectionEventNames.ROAP_FAILURE](fakeError);
 
-            checkMetricSent('client.media-engine.local-sdp-generated', fakeError, 30002);
+            checkMetricSent('client.media-engine.local-sdp-generated', fakeError);
             // expectedMetadataType is the error name in this case
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.INVALID_ICE_CANDIDATE,
@@ -8957,7 +8930,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[MediaConnectionEventNames.ROAP_FAILURE](fakeError);
 
-            checkMetricSent('client.media-engine.local-sdp-generated', fakeError, 30003);
+            checkMetricSent('client.media-engine.local-sdp-generated', fakeError);
             // expectedMetadataType is the error name in this case
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.INVALID_ICE_CANDIDATE,
@@ -9151,7 +9124,7 @@ describe('plugin-meetings', () => {
             assert.calledOnceWithExactly(getErrorPayloadForClientErrorCodeStub, {
               clientErrorCode: expectedErrorCode,
             });
-            assert.deepEqual(webex.internal.newMetrics.submitClientEvent.getCall(0).args[0], {
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
               name: 'client.media-engine.remote-sdp-received',
               payload: {
                 canProceed,
@@ -9159,18 +9132,9 @@ describe('plugin-meetings', () => {
               },
               options: {
                 meetingId: meeting.id,
-                rawError: fakeError instanceof MultistreamNotSupportedError ? {
-                  code: fakeError.code,
-                  name: fakeError.name,
-                  sdkMessage: fakeError.sdkMessage,
-                  error: fakeError.error,
-                } : {},
+                rawError: fakeError,
               },
             });
-            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,12 +185,7 @@ describe('LocusMediaRequest.send()', () => {
 
   it('sends correct metric event when roap message fails', async () => {
     webexRequestStub.rejects({code: 300, message: 'fake error'});
-
-    const promise = sendRoapMessage('OFFER');
-    await assert.isRejected(promise);
-
-    const error = await promise.catch((err) => err);
-    assert.isTrue(error.handledBySdk);
+    await assert.isRejected(sendRoapMessage('OFFER'));
 
     assert.calledWith(mockWebex.internal.newMetrics.submitClientEvent, {
       name: 'client.locus.media.response',

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

@@ -1185,14 +1185,6 @@ 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', () => {
       [
         {

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

@@ -182,6 +182,15 @@ describe('plugin-meetings', () => {
         metrics: {
           submitClientMetrics: sinon.stub().returns(Promise.resolve()),
         },
+        newMetrics: {
+          submitClientEvent: sinon.stub(),
+          callDiagnosticLatencies: {
+            measureLatency: sinon.stub().returns(Promise.resolve()),
+          },
+          callDiagnosticMetrics: {
+            clearErrorCache: sinon.stub(),
+          },
+        },
       });
       webex.emit('ready');
     });