@webex/plugin-meetings 3.0.0-beta.251 → 3.0.0-beta.253

package/src/meeting-info/index.ts

@@ -71,20 +71,37 @@ export default class MeetingInfo {
    * @memberof MeetingInfo
    */
   private requestFetchInfo(options: any) {
-    const {meetingId} = options;
-    if (meetingId) {
+    const {meetingId, sendCAevents} = options;
+    if (meetingId && sendCAevents) {
       this.webex.internal.newMetrics.submitInternalEvent({
         name: 'internal.client.meetinginfo.request',
       });
+      this.webex.internal.newMetrics.submitClientEvent({
+        name: 'client.meetinginfo.request',
+        options: {
+          meetingId,
+        },
+      });
     }
 
     return this.meetingInfoRequest
       .fetchMeetingInfo(options)
       .then((info) => {
-        if (meetingId) {
+        if (meetingId && sendCAevents) {
           this.webex.internal.newMetrics.submitInternalEvent({
             name: 'internal.client.meetinginfo.response',
           });
+          this.webex.internal.newMetrics.submitClientEvent({
+            name: 'client.meetinginfo.response',
+            payload: {
+              identifiers: {
+                meetingLookupUrl: info?.url,
+              },
+            },
+            options: {
+              meetingId,
+            },
+          });
         }
         if (info && info.body) {
           this.setMeetingInfo(info.body.sipMeetingUri || info.body.meetingLink, info.body);
@@ -96,21 +113,23 @@ export default class MeetingInfo {
         LoggerProxy.logger.error(
           `Meeting-info:index#requestFetchInfo -->  ${error} fetch meetingInfo`
         );
-        this.webex.internal.newMetrics.submitInternalEvent({
-          name: 'internal.client.meetinginfo.response',
-        });
-        this.webex.internal.newMetrics.submitClientEvent({
-          name: 'client.meetinginfo.response',
-          payload: {
-            identifiers: {
-              meetingLookupUrl: error?.url,
+        if (meetingId && sendCAevents) {
+          this.webex.internal.newMetrics.submitInternalEvent({
+            name: 'internal.client.meetinginfo.response',
+          });
+          this.webex.internal.newMetrics.submitClientEvent({
+            name: 'client.meetinginfo.response',
+            payload: {
+              identifiers: {
+                meetingLookupUrl: error?.url,
+              },
+            },
+            options: {
+              meetingId,
+              rawError: error,
             },
-          },
-          options: {
-            meetingId,
-            rawError: error,
-          },
-        });
+          });
+        }
 
         return Promise.reject(error);
       });
@@ -137,6 +156,12 @@ export default class MeetingInfo {
    * Fetches meeting info from the server
    * @param {String} destination one of many different types of destinations to look up info for
    * @param {String} [type] to match up with the destination value
+   * @param {String} [password] meeting password
+   * @param {Object} [captchaInfo] captcha code and id
+   * @param {String} [installedOrgID]
+   * @param {String} [locusId]
+   * @param {Object} [extraParams]
+   * @param {Boolean} [options] meeting Id and whether Call Analyzer events should be sent
    * @returns {Promise} returns a meeting info object
    * @public
    * @memberof MeetingInfo
@@ -157,7 +182,7 @@ export default class MeetingInfo {
     locusId = null,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     extraParams: object = {},
-    options: {meetingId?: string} = {}
+    options: {meetingId?: string; sendCAevents?: boolean} = {}
   ) {
     if (type === _PERSONAL_ROOM_ && !destination) {
       destination = this.webex.internal.device.userId;
@@ -166,13 +191,13 @@ export default class MeetingInfo {
     return this.fetchInfoOptions(MeetingInfoUtil.extractDestination(destination, type), type).then(
       (infoOptions) =>
         // fetch meeting info
-        this.requestFetchInfo({...infoOptions, meetingId: options.meetingId}).catch((error) => {
+        this.requestFetchInfo({...infoOptions, ...options}).catch((error) => {
           // if it failed the first time as meeting link
           if (infoOptions.type === _MEETING_LINK_) {
             // convert the meeting link to sip URI and retry
             return this.requestFetchInfo({
               ...this.fetchInfoOptions(MeetingInfoUtil.convertLinkToSip(destination), _SIP_URI_),
-              meetingId: options.meetingId,
+              ...options,
             });
           }
 

package/src/meeting-info/meeting-info-v2.ts

@@ -279,9 +279,9 @@ export default class MeetingInfoV2 {
     installedOrgID = null,
     locusId = null,
     extraParams: object = {},
-    options: {meetingId?: string} = {}
+    options: {meetingId?: string; sendCAevents?: boolean} = {}
   ) {
-    const {meetingId} = options;
+    const {meetingId, sendCAevents} = options;
 
     const destinationType = await MeetingInfoUtil.getDestinationType({
       destination,
@@ -336,29 +336,49 @@ export default class MeetingInfoV2 {
       requestOptions.resource = 'meetingInfo';
     }
 
-    if (meetingId) {
+    if (meetingId && sendCAevents) {
       this.webex.internal.newMetrics.submitInternalEvent({
         name: 'internal.client.meetinginfo.request',
       });
+
+      this.webex.internal.newMetrics.submitClientEvent({
+        name: 'client.meetinginfo.request',
+        options: {
+          meetingId,
+        },
+      });
     }
 
     return this.webex
       .request(requestOptions)
       .then((response) => {
-        if (meetingId) {
+        if (meetingId && sendCAevents) {
           this.webex.internal.newMetrics.submitInternalEvent({
             name: 'internal.client.meetinginfo.response',
           });
+
+          this.webex.internal.newMetrics.submitClientEvent({
+            name: 'client.meetinginfo.response',
+            payload: {
+              identifiers: {
+                meetingLookupUrl: response?.url,
+              },
+            },
+            options: {
+              meetingId,
+            },
+          });
         }
         Metrics.sendBehavioralMetric(BEHAVIORAL_METRICS.FETCH_MEETING_INFO_V1_SUCCESS);
 
         return response;
       })
       .catch((err) => {
-        if (meetingId) {
+        if (meetingId && sendCAevents) {
           this.webex.internal.newMetrics.submitInternalEvent({
             name: 'internal.client.meetinginfo.response',
           });
+
           this.webex.internal.newMetrics.submitClientEvent({
             name: 'client.meetinginfo.response',
             payload: {

package/src/meetings/index.ts

@@ -1219,12 +1219,19 @@ export default class Meetings extends WebexPlugin {
 
       if (enableUnifiedMeetings && !isMeetingActive && useRandomDelayForInfo && waitingTime > 0) {
         meeting.fetchMeetingInfoTimeoutId = setTimeout(
-          () => meeting.fetchMeetingInfo({extraParams: infoExtraParams}),
+          () =>
+            meeting.fetchMeetingInfo({
+              extraParams: infoExtraParams,
+              sendCAevents: !!correlationId, // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
+            }),
           waitingTime
         );
         meeting.parseMeetingInfo(undefined, destination);
       } else {
-        await meeting.fetchMeetingInfo({extraParams: infoExtraParams});
+        await meeting.fetchMeetingInfo({
+          extraParams: infoExtraParams,
+          sendCAevents: !!correlationId, // if client sends correlation id as argument of public create(), then it means that this meeting creation is part of a pre-join intent from user
+        });
       }
     } catch (err) {
       if (

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

@@ -856,75 +856,8 @@ describe('plugin-meetings', () => {
             sinon.assert.called(setCorrelationIdSpy);
             assert.equal(meeting.correlationId, '123');
           });
-
-          it('should send Meeting Info CA events if meetingInfo is not empty', async () => {
-            meeting.meetingInfo = {info: 'info', meetingLookupUrl: 'url'};
-
-            const join = meeting.join();
-
-            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
-              name: 'client.call.initiated',
-              payload: {trigger: 'user-interaction', isRoapCallEnabled: true},
-              options: {meetingId: meeting.id},
-            });
-
-            assert.exists(join.then);
-            const result = await join;
-
-            assert.calledOnce(MeetingUtil.joinMeeting);
-            assert.calledOnce(meeting.setLocus);
-            assert.equal(result, joinMeetingResult);
-
-            assert.calledThrice(webex.internal.newMetrics.submitClientEvent);
-
-            assert.deepEqual(webex.internal.newMetrics.submitClientEvent.getCall(0).args[0], {
-              name: 'client.call.initiated',
-              payload: {
-                trigger: 'user-interaction',
-                isRoapCallEnabled: true,
-              },
-              options: {meetingId: meeting.id},
-            });
-
-            assert.deepEqual(webex.internal.newMetrics.submitClientEvent.getCall(1).args[0], {
-              name: 'client.meetinginfo.request',
-              options: {meetingId: meeting.id},
-            });
-            assert.deepEqual(webex.internal.newMetrics.submitClientEvent.getCall(2).args[0], {
-              name: 'client.meetinginfo.response',
-              payload: {
-                identifiers: {meetingLookupUrl: 'url'},
-              },
-              options: {meetingId: meeting.id},
-            });
-          });
-
-          it('should not send Meeting Info CA events if meetingInfo is empty', async () => {
-            meeting.meetingInfo = {};
-
-            const join = meeting.join();
-
-            assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
-              name: 'client.call.initiated',
-              payload: {trigger: 'user-interaction', isRoapCallEnabled: true},
-              options: {meetingId: meeting.id},
-            });
-
-            assert.exists(join.then);
-            const result = await join;
-
-            assert.calledOnce(MeetingUtil.joinMeeting);
-            assert.calledOnce(meeting.setLocus);
-            assert.equal(result, joinMeetingResult);
-
-            assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
-
-            assert.equal(
-              webex.internal.newMetrics.submitClientEvent.getCall(0).args[0].name,
-              'client.call.initiated'
-            );
-          });
         });
+
         describe('failure', () => {
           beforeEach(() => {
             sandbox.stub(MeetingUtil, 'joinMeeting').returns(Promise.reject());
@@ -3153,7 +3086,7 @@ describe('plugin-meetings', () => {
         beforeEach(() => {
           meeting.locusId = 'locus-id';
           meeting.id = 'meeting-id';
-          FAKE_OPTIONS = {meetingId: meeting.id};
+          FAKE_OPTIONS = {meetingId: meeting.id, sendCAevents: true};
         });
 
         it('calls meetingInfoProvider with all the right parameters and parses the result', async () => {
@@ -3173,6 +3106,7 @@ describe('plugin-meetings', () => {
             password: FAKE_PASSWORD,
             captchaCode: FAKE_CAPTCHA_CODE,
             extraParams: FAKE_EXTRA_PARAMS,
+            sendCAevents: true,
           });
 
           assert.calledWith(
@@ -3224,7 +3158,7 @@ describe('plugin-meetings', () => {
           const clock = sinon.useFakeTimers();
           const clearTimeoutSpy = sinon.spy(clock, 'clearTimeout');
 
-          await meeting.fetchMeetingInfo({});
+          await meeting.fetchMeetingInfo({sendCAevents: false});
 
           // clear timer
           assert.calledWith(clearTimeoutSpy, FAKE_TIMEOUT_FETCHMEETINGINFO_ID);
@@ -3241,7 +3175,7 @@ describe('plugin-meetings', () => {
             undefined,
             meeting.locusId,
             {},
-            {meetingId: meeting.id}
+            {meetingId: meeting.id, sendCAevents: false}
           );
 
           // parseMeeting info
@@ -3320,7 +3254,7 @@ describe('plugin-meetings', () => {
               .throws(new MeetingInfoV2PasswordError(403004, FAKE_MEETING_INFO)),
           };
 
-          await assert.isRejected(meeting.fetchMeetingInfo({}), PasswordError);
+          await assert.isRejected(meeting.fetchMeetingInfo({sendCAevents: true}), PasswordError);
 
           assert.calledWith(
             meeting.attrs.meetingInfoProvider.fetchMeetingInfo,
@@ -3331,7 +3265,7 @@ describe('plugin-meetings', () => {
             undefined,
             'locus-id',
             {},
-            {meetingId: meeting.id}
+            {meetingId: meeting.id, sendCAevents: true}
           );
 
           assert.deepEqual(meeting.meetingInfo, FAKE_MEETING_INFO);
@@ -3353,7 +3287,7 @@ describe('plugin-meetings', () => {
               .throws(new MeetingInfoV2PolicyError(123456, FAKE_MEETING_INFO, 'a message')),
           };
 
-          await assert.isRejected(meeting.fetchMeetingInfo({}), PermissionError);
+          await assert.isRejected(meeting.fetchMeetingInfo({sendCAevents: true}), PermissionError);
 
           assert.calledWith(
             meeting.attrs.meetingInfoProvider.fetchMeetingInfo,
@@ -3364,7 +3298,7 @@ describe('plugin-meetings', () => {
             undefined,
             'locus-id',
             {},
-            {meetingId: meeting.id}
+            {meetingId: meeting.id, sendCAevents: true}
           );
 
           assert.deepEqual(meeting.meetingInfo, FAKE_MEETING_INFO);
@@ -3385,6 +3319,7 @@ describe('plugin-meetings', () => {
           await assert.isRejected(
             meeting.fetchMeetingInfo({
               password: 'aaa',
+              sendCAevents: true
             }),
             CaptchaError
           );
@@ -3398,7 +3333,7 @@ describe('plugin-meetings', () => {
             undefined,
             'locus-id',
             {},
-            {meetingId: meeting.id}
+            {meetingId: meeting.id, sendCAevents: true}
           );
 
           assert.deepEqual(meeting.meetingInfo, {});
@@ -3430,6 +3365,7 @@ describe('plugin-meetings', () => {
             meeting.fetchMeetingInfo({
               password: 'aaa',
               captchaCode: 'bbb',
+              sendCAevents: true,
             }),
             CaptchaError
           );
@@ -3443,7 +3379,7 @@ describe('plugin-meetings', () => {
             undefined,
             'locus-id',
             {},
-            {meetingId: meeting.id}
+            {meetingId: meeting.id, sendCAevents: true}
           );
 
           assert.deepEqual(meeting.meetingInfo, {});
@@ -3465,6 +3401,7 @@ describe('plugin-meetings', () => {
 
           await meeting.fetchMeetingInfo({
             password: 'aaa',
+            sendCAevents: true,
           });
 
           assert.calledWith(
@@ -3476,7 +3413,7 @@ describe('plugin-meetings', () => {
             undefined,
             'locus-id',
             {},
-            {meetingId: meeting.id}
+            {meetingId: meeting.id, sendCAevents: true}
           );
 
           assert.deepEqual(meeting.meetingInfo, {
@@ -3516,6 +3453,7 @@ describe('plugin-meetings', () => {
             meeting.fetchMeetingInfo({
               password: 'aaa',
               captchaCode: 'bbb',
+              sendCAevents: true,
             })
           );
 
@@ -3528,7 +3466,7 @@ describe('plugin-meetings', () => {
             undefined,
             'locus-id',
             {},
-            {meetingId: meeting.id}
+            {meetingId: meeting.id, sendCAevents: true}
           );
 
           assert.deepEqual(meeting.meetingInfo, FAKE_MEETING_INFO);
@@ -3622,6 +3560,7 @@ describe('plugin-meetings', () => {
           assert.calledWith(meeting.fetchMeetingInfo, {
             password: 'password',
             captchaCode: 'captcha id',
+            sendCAevents: false,
           });
         });
         it('handles PasswordError returned by fetchMeetingInfo', async () => {