@webex/internal-plugin-metrics 3.12.0-next.54 → 3.12.0-next.56

package/test/unit/spec/call-diagnostic/call-diagnostic-metrics.ts

@@ -81,12 +81,20 @@ describe('internal-plugin-metrics', () => {
       emailInput: 'test@test.com',
     };
 
+    const fakeMeeting6 = {
+      ...fakeMeeting,
+      id: '6',
+      correlationId: 'correlationId6',
+      callStateForMetrics: {meetingJoinPhase: 'in-meeting'},
+    };
+
     const fakeMeetings = {
       1: fakeMeeting,
       2: fakeMeeting2,
       3: fakeMeeting3,
       4: fakeMeeting4,
       5: fakeMeeting5,
+      6: fakeMeeting6,
     };
 
     let webex;
@@ -715,6 +723,63 @@ describe('internal-plugin-metrics', () => {
         });
       });
 
+      it('should build identifiers correctly with a meeting that has meetingInfo with locusClusterUrl', () => {
+        const res = cd.getIdentifiers({
+          mediaConnections: [
+            {mediaAgentAlias: 'mediaAgentAlias', mediaAgentGroupId: 'mediaAgentGroupId'},
+          ],
+          meeting: {
+            ...fakeMeeting,
+            meetingInfo: {
+              ...fakeMeeting.meetingInfo,
+              locusClusterUrl: 'locus-k.wbx2.com',
+            },
+          },
+        });
+
+        assert.deepEqual(res, {
+          correlationId: 'correlationId',
+          deviceId: 'deviceUrl',
+          locusCluster: 'locus-k.wbx2.com',
+          locusId: 'url',
+          locusSessionId: 'locusSessionId',
+          locusStartTime: 'lastActive',
+          locusUrl: 'locus/url',
+          mediaAgentAlias: 'mediaAgentAlias',
+          mediaAgentGroupId: 'mediaAgentGroupId',
+          orgId: 'orgId',
+          userId: 'userId',
+        });
+      });
+
+      it('should build identifiers correctly given locusCluster', () => {
+        const res = cd.getIdentifiers({
+          correlationId: 'correlationId',
+          locusCluster: 'locus-k.wbx2.com',
+        });
+
+        assert.deepEqual(res, {
+          correlationId: 'correlationId',
+          deviceId: 'deviceUrl',
+          locusCluster: 'locus-k.wbx2.com',
+          locusUrl: 'locus-url',
+          orgId: 'orgId',
+          userId: 'userId',
+        });
+      });
+
+      it('should prefer meetingInfo locusClusterUrl over the locusCluster option', () => {
+        const res = cd.getIdentifiers({
+          meeting: {
+            ...fakeMeeting,
+            meetingInfo: {...fakeMeeting.meetingInfo, locusClusterUrl: 'locus-k.wbx2.com'},
+          },
+          locusCluster: 'locus-a.wbx2.com',
+        });
+
+        assert.equal(res.locusCluster, 'locus-k.wbx2.com');
+      });
+
       it('should build identifiers correctly with a meeting that has sessionCorrelationId', () => {
         const res = cd.getIdentifiers({
           mediaConnections: [
@@ -1113,6 +1178,7 @@ describe('internal-plugin-metrics', () => {
           webexConferenceIdStr: undefined,
           sessionCorrelationId: undefined,
           globalMeetingId: undefined,
+          locusCluster: undefined,
         });
         assert.notCalled(generateClientEventErrorPayloadSpy);
         assert.calledWith(
@@ -1267,6 +1333,7 @@ describe('internal-plugin-metrics', () => {
           webexConferenceIdStr: undefined,
           sessionCorrelationId: undefined,
           globalMeetingId: undefined,
+          locusCluster: undefined,
         });
         assert.notCalled(generateClientEventErrorPayloadSpy);
         assert.calledWith(
@@ -1421,6 +1488,7 @@ describe('internal-plugin-metrics', () => {
           webexConferenceIdStr: undefined,
           globalMeetingId: undefined,
           sessionCorrelationId: undefined,
+          locusCluster: undefined,
         });
         assert.notCalled(generateClientEventErrorPayloadSpy);
         assert.calledWith(
@@ -1577,6 +1645,7 @@ describe('internal-plugin-metrics', () => {
           webexConferenceIdStr: undefined,
           globalMeetingId: undefined,
           sessionCorrelationId: undefined,
+          locusCluster: undefined,
         });
         assert.notCalled(generateClientEventErrorPayloadSpy);
         assert.calledWith(
@@ -1733,6 +1802,7 @@ describe('internal-plugin-metrics', () => {
           webexConferenceIdStr: undefined,
           globalMeetingId: undefined,
           sessionCorrelationId: undefined,
+          locusCluster: undefined,
         });
         assert.notCalled(generateClientEventErrorPayloadSpy);
         assert.calledWith(
@@ -1951,6 +2021,7 @@ describe('internal-plugin-metrics', () => {
           globalMeetingId: 'globalMeetingId1',
           sessionCorrelationId: 'sessionCorrelationId1',
           preLoginId: undefined,
+          locusCluster: undefined,
         });
 
         assert.notCalled(generateClientEventErrorPayloadSpy);
@@ -1978,6 +2049,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isAutomatedUser: false,
             userActivation: undefined,
+            meetingJoinPhase: 'pre-join',
           },
           options
         );
@@ -2004,6 +2076,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isAutomatedUser: false,
             userActivation: undefined,
+            meetingJoinPhase: 'pre-join',
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2055,6 +2128,7 @@ describe('internal-plugin-metrics', () => {
           globalMeetingId: 'globalMeetingId1',
           preLoginId: 'myPreLoginId',
           sessionCorrelationId: 'sessionCorrelationId1',
+          locusCluster: undefined,
         });
 
         assert.notCalled(generateClientEventErrorPayloadSpy);
@@ -2082,6 +2156,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isAutomatedUser: false,
             userActivation: undefined,
+            meetingJoinPhase: 'pre-join',
           },
           options
         );
@@ -2113,12 +2188,43 @@ describe('internal-plugin-metrics', () => {
               webClientPreload: undefined,
               isAutomatedUser: false,
               userActivation: undefined,
+              meetingJoinPhase: 'pre-join',
             },
           },
           options.preLoginId
         );
       });
 
+      it('should add locusCluster from options to a pre-meeting client event', () => {
+        const prepareDiagnosticEventSpy = sinon.spy(cd, 'prepareDiagnosticEvent');
+        sinon.stub(cd, 'getOrigin').returns({origin: 'fake-origin'});
+
+        cd.submitClientEvent({
+          name: 'client.meetinginfo.response',
+          options: {correlationId: 'correlationId', locusCluster: 'locus-k.wbx2.com'},
+        });
+
+        assert.equal(
+          prepareDiagnosticEventSpy.firstCall.args[0].identifiers.locusCluster,
+          'locus-k.wbx2.com'
+        );
+      });
+
+      it('should add locusCluster from options to an in-meeting client event when the meeting has none', () => {
+        const prepareDiagnosticEventSpy = sinon.spy(cd, 'prepareDiagnosticEvent');
+        sinon.stub(cd, 'getOrigin').returns({origin: 'fake-origin'});
+
+        cd.submitClientEvent({
+          name: 'client.interstitial-window.launched',
+          options: {meetingId: fakeMeeting.id, locusCluster: 'locus-k.wbx2.com'},
+        });
+
+        assert.equal(
+          prepareDiagnosticEventSpy.firstCall.args[0].identifiers.locusCluster,
+          'locus-k.wbx2.com'
+        );
+      });
+
       it('should submit client event successfully with emailInput and userNameInput as options', () => {
         cd.device.userId = undefined;
 
@@ -2150,6 +2256,7 @@ describe('internal-plugin-metrics', () => {
           globalMeetingId: 'globalMeetingId1',
           preLoginId: 'myPreLoginId',
           sessionCorrelationId: 'sessionCorrelationId1',
+          locusCluster: undefined,
         });
 
         assert.notCalled(generateClientEventErrorPayloadSpy);
@@ -2179,6 +2286,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isAutomatedUser: false,
             userActivation: undefined,
+            meetingJoinPhase: 'pre-join',
           },
           options
         );
@@ -2212,6 +2320,7 @@ describe('internal-plugin-metrics', () => {
               webClientPreload: undefined,
               isAutomatedUser: false,
               userActivation: undefined,
+              meetingJoinPhase: 'pre-join',
             },
           },
           options.preLoginId
@@ -2379,6 +2488,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: true,
             isAutomatedUser: false,
             userActivation: undefined,
+            meetingJoinPhase: 'pre-join',
           },
           options
         );
@@ -2405,6 +2515,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: true,
             isAutomatedUser: false,
             userActivation: undefined,
+            meetingJoinPhase: 'pre-join',
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2855,6 +2966,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isAutomatedUser: false,
             userActivation: undefined,
+            meetingJoinPhase: 'pre-join',
           },
           eventId: 'my-fake-id',
           origin: {
@@ -2933,6 +3045,7 @@ describe('internal-plugin-metrics', () => {
             webClientPreload: undefined,
             isAutomatedUser: false,
             userActivation: undefined,
+            meetingJoinPhase: 'pre-join',
           },
           eventId: 'my-fake-id',
           origin: {
@@ -4535,6 +4648,18 @@ describe('internal-plugin-metrics', () => {
     });
 
     describe('#buildClientEventFetchRequestOptions', () => {
+      it('should add the locusCluster option to a pre-meeting event', async () => {
+        const fetchOptions = await cd.buildClientEventFetchRequestOptions({
+          name: 'client.interstitial-window.launched',
+          options: {correlationId: 'correlationId', locusCluster: 'locus-k.wbx2.com'},
+        });
+
+        assert.equal(
+          fetchOptions.body.metrics[0].eventPayload.event.identifiers.locusCluster,
+          'locus-k.wbx2.com'
+        );
+      });
+
       [undefined, 'myPreLoginId'].forEach((preLoginId) => {
         it('returns expected options without preLoginId', async () => {
           const options = {
@@ -4735,6 +4860,56 @@ describe('internal-plugin-metrics', () => {
         );
       });
 
+      it('includes expected meetingJoinPhase from meeting callStateForMetrics when in-meeting', async () => {
+        // meetingId means in-meeting
+        const options = {
+          meetingId: fakeMeeting6.id,
+        };
+
+        const fetchOptions = await cd.buildClientEventFetchRequestOptions({
+          name: 'client.exit.app',
+          payload: {trigger: 'user-interaction', canProceed: false},
+          options,
+        });
+
+        assert.equal(fetchOptions.body.metrics[0].eventPayload.event.meetingJoinPhase, 'in-meeting');
+      });
+
+      it('prioritizes meetingJoinPhase from options over meeting callStateForMetrics', async () => {
+        // meetingId means in-meeting
+        const options = {
+          meetingId: fakeMeeting6.id,
+          meetingJoinPhase: 'join',
+        };
+
+        const fetchOptions = await cd.buildClientEventFetchRequestOptions({
+          name: 'client.exit.app',
+          payload: {trigger: 'user-interaction', canProceed: false},
+          options,
+        });
+
+        assert.equal(
+          fetchOptions.body.metrics[0].eventPayload.event.meetingJoinPhase,
+          options.meetingJoinPhase
+        );
+      });
+
+      it('defaults meetingJoinPhase to pre-join during prejoin when not provided in options', async () => {
+        // correlationId and no meeting id means prejoin
+        const options = {
+          correlationId: 'myCorrelationId',
+          preLoginId: 'myPreLoginId',
+        };
+
+        const fetchOptions = await cd.buildClientEventFetchRequestOptions({
+          name: 'client.exit.app',
+          payload: {trigger: 'user-interaction', canProceed: false},
+          options,
+        });
+
+        assert.equal(fetchOptions.body.metrics[0].eventPayload.event.meetingJoinPhase, 'pre-join');
+      });
+
       it('builds request options before webex is ready (no meetings plugin or internal metrics config)', async () => {
         // before webex.ready the meetings plugin and internal metrics config are not available
         webex.meetings = undefined;