@webex/plugin-meetings 3.0.0-beta.210 → 3.0.0-beta.211

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.210",
+  "version": "3.0.0-beta.211",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -32,12 +32,12 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.210",
-    "@webex/test-helper-chai": "3.0.0-beta.210",
-    "@webex/test-helper-mocha": "3.0.0-beta.210",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.210",
-    "@webex/test-helper-retry": "3.0.0-beta.210",
-    "@webex/test-helper-test-users": "3.0.0-beta.210",
+    "@webex/plugin-meetings": "3.0.0-beta.211",
+    "@webex/test-helper-chai": "3.0.0-beta.211",
+    "@webex/test-helper-mocha": "3.0.0-beta.211",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.211",
+    "@webex/test-helper-retry": "3.0.0-beta.211",
+    "@webex/test-helper-test-users": "3.0.0-beta.211",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -46,19 +46,19 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.210",
+    "@webex/common": "3.0.0-beta.211",
     "@webex/internal-media-core": "1.39.1",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.210",
-    "@webex/internal-plugin-device": "3.0.0-beta.210",
-    "@webex/internal-plugin-llm": "3.0.0-beta.210",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.210",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.210",
-    "@webex/internal-plugin-support": "3.0.0-beta.210",
-    "@webex/internal-plugin-user": "3.0.0-beta.210",
-    "@webex/media-helpers": "3.0.0-beta.210",
-    "@webex/plugin-people": "3.0.0-beta.210",
-    "@webex/plugin-rooms": "3.0.0-beta.210",
-    "@webex/webex-core": "3.0.0-beta.210",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.211",
+    "@webex/internal-plugin-device": "3.0.0-beta.211",
+    "@webex/internal-plugin-llm": "3.0.0-beta.211",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.211",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.211",
+    "@webex/internal-plugin-support": "3.0.0-beta.211",
+    "@webex/internal-plugin-user": "3.0.0-beta.211",
+    "@webex/media-helpers": "3.0.0-beta.211",
+    "@webex/plugin-people": "3.0.0-beta.211",
+    "@webex/plugin-rooms": "3.0.0-beta.211",
+    "@webex/webex-core": "3.0.0-beta.211",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/meeting/index.ts

@@ -5915,20 +5915,25 @@ export default class Meeting extends StatelessWebexPlugin {
     /// @ts-ignore
     this.webex.internal.newMetrics.submitInternalEvent({name: 'internal.reset.join.latencies'});
 
-    // @ts-ignore
-    this.webex.internal.newMetrics.submitClientEvent({
-      name: 'client.call.leave',
-      payload: {
-        trigger: 'user-interaction',
-        canProceed: false,
-        leaveReason,
-      },
-      options: {meetingId: this.id},
-    });
+    const submitLeaveMetric = (payload = {}) =>
+      // @ts-ignore
+      this.webex.internal.newMetrics.submitClientEvent({
+        name: 'client.call.leave',
+        payload: {
+          trigger: 'user-interaction',
+          canProceed: false,
+          leaveReason,
+          ...payload,
+        },
+        options: {meetingId: this.id},
+      });
     LoggerProxy.logger.log('Meeting:index#leave --> Leaving a meeting');
 
     return MeetingUtil.leaveMeeting(this, options)
       .then((leave) => {
+        // CA team recommends submitting this *after* locus /leave
+        submitLeaveMetric();
+
         this.meetingFiniteStateMachine.leave();
         this.clearMeetingData();
 
@@ -5964,6 +5969,20 @@ export default class Meeting extends StatelessWebexPlugin {
         return leave;
       })
       .catch((error) => {
+        // CA team recommends submitting this *after* locus /leave
+        submitLeaveMetric({
+          errors: [
+            {
+              fatal: false,
+              errorDescription: error.message,
+              category: 'signaling',
+              errorCode: 1000,
+              name: 'client.leave',
+              shownToUser: false,
+            },
+          ],
+        });
+
         this.meetingFiniteStateMachine.fail(error);
         LoggerProxy.logger.error('Meeting:index#leave --> Failed to leave ', error);
         // upload logs on leave irrespective of meeting delete

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

@@ -1779,7 +1779,12 @@ describe('plugin-meetings', () => {
               method: 'PUT',
               uri: `${meeting.selfUrl}/media`,
               body: {
-                device: {url: meeting.deviceUrl, deviceType: meeting.config.deviceType, regionCode: 'EU', countryCode: 'UK'},
+                device: {
+                  url: meeting.deviceUrl,
+                  deviceType: meeting.config.deviceType,
+                  regionCode: 'EU',
+                  countryCode: 'UK',
+                },
                 correlationId: meeting.correlationId,
                 localMedias: [
                   {
@@ -1800,7 +1805,12 @@ describe('plugin-meetings', () => {
               method: 'PUT',
               uri: `${meeting.selfUrl}/media`,
               body: {
-                device: {url: meeting.deviceUrl, deviceType: meeting.config.deviceType, regionCode: 'EU', countryCode: 'UK'},
+                device: {
+                  url: meeting.deviceUrl,
+                  deviceType: meeting.config.deviceType,
+                  regionCode: 'EU',
+                  countryCode: 'UK',
+                },
                 correlationId: meeting.correlationId,
                 localMedias: [
                   {
@@ -2342,6 +2352,7 @@ describe('plugin-meetings', () => {
           assert.calledOnce(meeting.meetingRequest.declineMeeting);
         });
       });
+
       describe('#leave', () => {
         let sandbox;
 
@@ -2474,6 +2485,62 @@ describe('plugin-meetings', () => {
             reason: MEETING_REMOVED_REASON.CLIENT_LEAVE_REQUEST,
           });
         });
+
+        it('should send client.call.leave after meetingRequest.leaveMeeting', async () => {
+          const leave = meeting.leave();
+
+          await leave;
+
+          assert.calledOnceWithExactly(webex.internal.newMetrics.submitClientEvent, {
+            name: 'client.call.leave',
+            payload: {
+              trigger: 'user-interaction',
+              canProceed: false,
+              leaveReason: 'CLIENT_LEAVE_REQUEST',
+            },
+            options: {meetingId: meeting.id},
+          });
+
+          assert(
+            webex.internal.newMetrics.submitClientEvent.calledAfter(
+              meeting.meetingRequest.leaveMeeting
+            )
+          );
+        });
+
+        it('should send client.call.leave after meetingRequest.leaveMeeting when erroring', async () => {
+          meeting.meetingRequest.leaveMeeting = sinon
+            .stub()
+            .returns(Promise.reject(new Error('forced')));
+
+          await assert.isRejected(meeting.leave());
+
+          assert.calledOnceWithExactly(webex.internal.newMetrics.submitClientEvent, {
+            name: 'client.call.leave',
+            payload: {
+              trigger: 'user-interaction',
+              canProceed: false,
+              leaveReason: 'CLIENT_LEAVE_REQUEST',
+              errors: [
+                {
+                  fatal: false,
+                  errorDescription: 'forced',
+                  category: 'signaling',
+                  errorCode: 1000,
+                  name: 'client.leave',
+                  shownToUser: false,
+                },
+              ],
+            },
+            options: {meetingId: meeting.id},
+          });
+
+          assert(
+            webex.internal.newMetrics.submitClientEvent.calledAfter(
+              meeting.meetingRequest.leaveMeeting
+            )
+          );
+        });
       });
       describe('#requestScreenShareFloor', () => {
         it('should have #requestScreenShareFloor', () => {
@@ -5253,16 +5320,16 @@ describe('plugin-meetings', () => {
 
           assert.calledThrice(TriggerProxy.trigger);
           assert.calledWith(
-              TriggerProxy.trigger,
-              sinon.match.instanceOf(Meeting),
-              {
-                file: 'meeting/index',
-                function: 'setUpLocusSelfListener',
-              },
-              EVENT_TRIGGERS.MEETING_LOCUS_URL_UPDATE,
-              {'locusUrl': 'newLocusUrl/12345'}
+            TriggerProxy.trigger,
+            sinon.match.instanceOf(Meeting),
+            {
+              file: 'meeting/index',
+              function: 'setUpLocusSelfListener',
+            },
+            EVENT_TRIGGERS.MEETING_LOCUS_URL_UPDATE,
+            {locusUrl: 'newLocusUrl/12345'}
           );
-          
+
           done();
         });
       });
@@ -6062,9 +6129,9 @@ describe('plugin-meetings', () => {
               meeting.userDisplayHints = requiredDisplayHints;
               meeting.selfUserPolicies = undefined;
 
-                if (requiredPolicies) {
-                  meeting.selfUserPolicies = {};
-                }
+              if (requiredPolicies) {
+                meeting.selfUserPolicies = {};
+              }
               meeting.meetingInfo = isUndefined(meetingInfo) ? {some: 'info'} : meetingInfo;
 
               meeting.updateMeetingActions();
@@ -6074,7 +6141,6 @@ describe('plugin-meetings', () => {
           }
         );
 
-
         forEach(
           [
             {