@webex/plugin-meetings 3.0.0-beta.162 → 3.0.0-beta.164

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

@@ -60,9 +60,7 @@ import ControlsOptionsUtil from '@webex/plugin-meetings/src/controls-options-man
 import LoggerProxy from '@webex/plugin-meetings/src/common/logs/logger-proxy';
 import LoggerConfig from '@webex/plugin-meetings/src/common/logs/logger-config';
 import TriggerProxy from '@webex/plugin-meetings/src/common/events/trigger-proxy';
-import BrowserDetection from '@webex/plugin-meetings/src/common/browser-detection';
 import Metrics from '@webex/plugin-meetings/src/metrics';
-import {trigger, eventType} from '@webex/plugin-meetings/src/metrics/config';
 import BEHAVIORAL_METRICS from '@webex/plugin-meetings/src/metrics/constants';
 import {MediaRequestManager} from '@webex/plugin-meetings/src/multistream/mediaRequestManager';
 import * as ReceiveSlotManagerModule from '@webex/plugin-meetings/src/multistream/receiveSlotManager';
@@ -94,8 +92,6 @@ import {
 } from '../../../../src/meeting-info/meeting-info-v2';
 import {ANNOTATION_POLICY} from "../../../../src/annotation/constants";
 
-const {getBrowserName, getOSVersion} = BrowserDetection();
-
 // Non-stubbed function
 const {getDisplayMedia} = Media;
 
@@ -220,6 +216,7 @@ describe('plugin-meetings', () => {
     });
 
     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');
     webex.internal.metrics.submitClientMetrics = sinon.stub().returns(Promise.resolve());
     webex.meetings.uploadLogs = sinon.stub().returns(Promise.resolve());
@@ -228,8 +225,7 @@ describe('plugin-meetings', () => {
     meetingRequestSpy = sinon.spy(MeetingRequestImport, 'default');
 
     TriggerProxy.trigger = sinon.stub().returns(true);
-    Metrics.postEvent = sinon.stub();
-    Metrics.initialSetup(null, webex);
+    Metrics.initialSetup(webex);
     MediaUtil.createMediaStream = sinon.stub().callsFake((tracks) => {
       return {
         getTracks: () => tracks,
@@ -641,9 +637,10 @@ describe('plugin-meetings', () => {
           it('should join the meeting and return promise', async () => {
             const join = meeting.join();
 
-            assert.calledWithMatch(Metrics.postEvent, {
-              event: eventType.CALL_INITIATED,
-              data: {trigger: trigger.USER_INTERACTION, isRoapCallEnabled: true},
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.call.initiated',
+              payload: {trigger: 'user-interaction', isRoapCallEnabled: true},
+              options: {meetingId: meeting.id},
             });
 
             assert.exists(join.then);
@@ -691,9 +688,10 @@ describe('plugin-meetings', () => {
 
             const join = meeting.join();
 
-            assert.calledWithMatch(Metrics.postEvent, {
-              event: eventType.CALL_INITIATED,
-              data: {trigger: trigger.USER_INTERACTION, isRoapCallEnabled: true},
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.call.initiated',
+              payload: {trigger: 'user-interaction', isRoapCallEnabled: true},
+              options: {meetingId: meeting.id},
             });
 
             assert.exists(join.then);
@@ -703,24 +701,27 @@ describe('plugin-meetings', () => {
             assert.calledOnce(meeting.setLocus);
             assert.equal(result, joinMeetingResult);
 
-            assert.calledThrice(Metrics.postEvent)
+            assert.calledThrice(webex.internal.newMetrics.submitClientEvent);
 
-            assert.deepEqual(Metrics.postEvent.getCall(0).args[0].event, 'client.call.initiated');
-            assert.deepEqual(Metrics.postEvent.getCall(0).args[0].data, {
-              isRoapCallEnabled: true,
-              trigger: 'user-interaction',
+            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(
-              Metrics.postEvent.getCall(1).args[0].event,
-              'client.meetinginfo.request'
-            );
-            assert.deepEqual(Metrics.postEvent.getCall(1).args[0].data, undefined);
-            assert.deepEqual(
-              Metrics.postEvent.getCall(2).args[0].event,
-              'client.meetinginfo.response'
-            );
-            assert.deepEqual(Metrics.postEvent.getCall(2).args[0].data, {
-              meetingLookupUrl: 'url',
+
+            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},
             });
           });
 
@@ -729,9 +730,10 @@ describe('plugin-meetings', () => {
 
             const join = meeting.join();
 
-            assert.calledWithMatch(Metrics.postEvent, {
-              event: eventType.CALL_INITIATED,
-              data: {trigger: trigger.USER_INTERACTION, isRoapCallEnabled: true},
+            assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.call.initiated',
+              payload: {trigger: 'user-interaction', isRoapCallEnabled: true},
+              options: {meetingId: meeting.id},
             });
 
             assert.exists(join.then);
@@ -741,9 +743,9 @@ describe('plugin-meetings', () => {
             assert.calledOnce(meeting.setLocus);
             assert.equal(result, joinMeetingResult);
 
-            assert.calledOnce(Metrics.postEvent)
+            assert.calledOnce(webex.internal.newMetrics.submitClientEvent)
 
-            assert.equal(Metrics.postEvent.getCall(0).args[0].event, 'client.call.initiated');
+            assert.equal(webex.internal.newMetrics.submitClientEvent.getCall(0).args[0].name, 'client.call.initiated');
           });
         });
         describe('failure', () => {
@@ -790,7 +792,13 @@ describe('plugin-meetings', () => {
 
           it('should post error event if failed', async () => {
             await meeting.join().catch(() => {
-              assert.calledWithMatch(Metrics.postEvent, {event: eventType.LOCUS_JOIN_RESPONSE});
+              assert.deepEqual(webex.internal.newMetrics.submitClientEvent.getCall(1).args[0].name, 'client.locus.join.response');
+              assert.match(webex.internal.newMetrics.submitClientEvent.getCall(1).args[0].options.rawError, {
+                code: 2,
+                error: null,
+                joinOptions: {},
+                sdkMessage: 'There was an issue joining the meeting, meeting could be in a bad state.'
+              });
             });
           });
           it('should fail if password is required', async () => {
@@ -1190,6 +1198,7 @@ describe('plugin-meetings', () => {
         });
 
         it('should reject if waitForMediaConnectionConnected() rejects', async () => {
+          webex.internal.newMetrics.callDiagnosticMetrics.getErrorPayloadForClientErrorCode = sinon.stub().returns({});
           meeting.meetingState = 'ACTIVE';
           meeting.mediaProperties.waitForMediaConnectionConnected.rejects(new Error('fake error'));
 
@@ -1203,6 +1212,20 @@ describe('plugin-meetings', () => {
               errorThrown = true;
             });
 
+          assert.calledTwice(webex.internal.newMetrics.submitClientEvent);
+
+          assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+            name: 'client.ice.end',
+            payload: {
+              canProceed: false,
+              icePhase: 'JOIN_MEETING_FINAL',
+              errors: [{}],
+            },
+            options: {                   
+              meetingId: meeting.id,
+            },
+          });
+
           assert.isTrue(errorThrown);
         });
 
@@ -1219,6 +1242,14 @@ describe('plugin-meetings', () => {
             connectionType: 'udp',
             isMultistream: false
           });
+
+          assert.called(webex.internal.newMetrics.submitClientEvent);
+          assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+            name: 'client.media-engine.ready',
+            options: {
+              meetingId: meeting.id,
+            },
+          });
         });
 
         describe('handles StatsAnalyzer events', () => {
@@ -1263,9 +1294,12 @@ describe('plugin-meetings', () => {
                 type: 'audio',
               }
             );
-            assert.calledWithMatch(Metrics.postEvent, {
-              event: eventType.SENDING_MEDIA_START,
-              data: {mediaType: 'audio'},
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media.tx.start',
+              payload: {mediaType: 'audio'},
+              options: {
+                meetingId: meeting.id,
+              },
             });
           });
 
@@ -1276,9 +1310,12 @@ describe('plugin-meetings', () => {
               {type: 'video'}
             );
 
-            assert.calledWithMatch(Metrics.postEvent, {
-              event: eventType.SENDING_MEDIA_STOP,
-              data: {mediaType: 'video'},
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media.tx.stop',
+              payload: {mediaType:'video'},
+              options: {
+                meetingId: meeting.id,
+              },
             });
           });
 
@@ -1301,9 +1338,12 @@ describe('plugin-meetings', () => {
                 type: 'video',
               }
             );
-            assert.calledWithMatch(Metrics.postEvent, {
-              event: eventType.RECEIVING_MEDIA_START,
-              data: {mediaType: 'video'},
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media.rx.start',
+              payload: {mediaType: 'video'},
+              options: {
+                meetingId: meeting.id,
+              },
             });
           });
 
@@ -1314,13 +1354,16 @@ describe('plugin-meetings', () => {
               {type: 'audio'}
             );
 
-            assert.calledWithMatch(Metrics.postEvent, {
-              event: eventType.RECEIVING_MEDIA_STOP,
-              data: {mediaType: 'audio'},
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media.rx.stop',
+              payload: {mediaType: 'audio'},
+              options: {
+                meetingId: meeting.id,
+              },
             });
           });
 
-          it('MEDIA_QUALITY triggers the right metrics', async () => {
+          it('calls submitMQE correctly', async () => {
             const fakeData = {intervalMetadata: {bla: 'bla'}};
 
             statsAnalyzerStub.emit(
@@ -1329,9 +1372,15 @@ describe('plugin-meetings', () => {
               {data: fakeData, networkType: 'wifi'}
             );
 
-            assert.calledWithMatch(Metrics.postEvent, {
-              event: eventType.MEDIA_QUALITY,
-              data: {intervalData: fakeData, networkType: 'wifi'},
+            assert.calledWithMatch(webex.internal.newMetrics.submitMQE, {
+              name: 'client.mediaquality.event',
+              options: {
+                meetingId: meeting.id,
+                networkType: 'wifi',
+              },
+              payload: {
+                intervals: [fakeData]
+              }
             });
           });
         });
@@ -1438,8 +1487,6 @@ describe('plugin-meetings', () => {
 
           StaticConfig.set({bandwidth: {audio: 1234, video: 5678, startBitrate: 9876}});
 
-          Metrics.postEvent = sinon.stub();
-
           // setup things that are expected to be the same across all the tests and are actually irrelevant for these tests
           expectedDebugId = `MC-${meeting.id.substring(0, 4)}`;
           expectedMediaConnectionConfig = {
@@ -2113,6 +2160,15 @@ describe('plugin-meetings', () => {
           assert.calledOnce(meeting.unsetRemoteTracks);
           assert.calledOnce(meeting.unsetPeerConnections);
         });
+
+        it('should reset call diagnostic latencies correctly', async () => {
+          const leave = meeting.leave();
+
+          assert.exists(leave.then);
+          await leave;
+          assert.calledWith(webex.internal.newMetrics.submitInternalEvent, {name: 'internal.reset.join.latencies'});
+        });
+
         describe('after audio/video is defined', () => {
           let handleClientRequest;
 
@@ -3263,9 +3319,14 @@ describe('plugin-meetings', () => {
           assert.exists(meeting.postMetrics);
         });
 
-        it('should trigger `postMetrics`', async () => {
-          await meeting.postMetrics(eventType.LEAVE);
-          assert.calledWithMatch(Metrics.postEvent, {event: eventType.LEAVE});
+        it('should trigger `submitClientEvent`', async () => {
+          await meeting.postMetrics('client.call.leave');
+          console.log({s: webex.internal.newMetrics.submitClientEvent.getCall(0).args[0]})
+          assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+            name: 'client.call.leave',
+            options: {meetingId: meeting.id},
+          });
+
         });
       });
 
@@ -3352,11 +3413,11 @@ describe('plugin-meetings', () => {
           }
         });
 
-        it('should postEvent on moveTo ', async () => {
+        it('should submitClientEvent on moveTo ', async () => {
           await meeting.moveTo('resourceId');
-          assert.calledWithMatch(Metrics.postEvent, {
-            event: eventType.MEDIA_CAPABILITIES,
-            data: {
+          assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+            name: 'client.media.capabilities',
+            payload: {
               mediaCapabilities: {
                 rx: {
                   audio: false,
@@ -3374,8 +3435,12 @@ describe('plugin-meetings', () => {
                 },
               },
             },
+            options: {meetingId: meeting.id},
+          });
+          assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+            name: 'client.call.move-media',
+            options: {meetingId: meeting.id}
           });
-          assert.calledWithMatch(Metrics.postEvent, {event: eventType.MOVE_MEDIA});
         });
 
         it('should call `MeetingUtil.joinMeetingOptions` with resourceId', async () => {
@@ -3485,10 +3550,13 @@ describe('plugin-meetings', () => {
           }
         });
 
-        it('should postEvent on moveFrom ', async () => {
+        it('should submitClientEvent on moveFrom ', async () => {
           await meeting.moveFrom('resourceId');
 
-          assert.calledWithMatch(Metrics.postEvent, {event: eventType.MOVE_MEDIA});
+          assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+            name: 'client.call.move-media',
+            options: {meetingId: meeting.id},
+          });
         });
 
         it('should call `MeetingUtil.joinMeetingOptions` with resourceId', async () => {
@@ -3999,6 +4067,29 @@ describe('plugin-meetings', () => {
           });
         });
 
+        describe('submitClientEvent on connectionFailed', () => {
+          it('sends client.ice.end when connectionFailed on CONNECTION_STATE_CHANGED event', () => {
+            webex.internal.newMetrics.callDiagnosticMetrics.getErrorPayloadForClientErrorCode = sinon.stub().returns({})
+            meeting.setupMediaConnectionListeners();
+            eventListeners[Event.CONNECTION_STATE_CHANGED]({
+              state: 'Failed',
+            });
+            assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
+
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.ice.end',
+              payload: {
+                canProceed: false,
+                icePhase: 'IN_MEETING',
+                errors: [{}],
+              },
+              options: {                   
+                meetingId: meeting.id,
+              },
+            });
+          });
+        });
+
         describe('should send correct metrics for ROAP_FAILURE event', () => {
           const fakeErrorMessage = 'test error';
           const fakeRootCauseName = 'root cause name';
@@ -4008,12 +4099,14 @@ describe('plugin-meetings', () => {
             meeting.setupMediaConnectionListeners();
           });
 
-          const checkMetricSent = (event) => {
-            assert.calledOnce(Metrics.postEvent);
-            assert.calledWithMatch(Metrics.postEvent, {
-              event,
-              meetingId: meeting.id,
-              data: {canProceed: false},
+          const checkMetricSent = (event, error) => {
+            assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+              name: event,
+              payload: {
+                canProceed: false,
+              },
+              options: {showToUser: true, rawError: error, meetingId: meeting.id},
             });
           };
 
@@ -4047,7 +4140,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[Event.ROAP_FAILURE](fakeError);
 
-            checkMetricSent(eventType.LOCAL_SDP_GENERATED);
+            checkMetricSent('client.media-engine.local-sdp-generated', fakeError);
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE,
               Errors.ErrorCode.SdpOfferCreationError,
@@ -4064,7 +4157,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[Event.ROAP_FAILURE](fakeError);
 
-            checkMetricSent(eventType.REMOTE_SDP_RECEIVED);
+            checkMetricSent('client.media-engine.remote-sdp-received', fakeError);
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE,
               Errors.ErrorCode.SdpOfferHandlingError,
@@ -4081,7 +4174,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[Event.ROAP_FAILURE](fakeError);
 
-            checkMetricSent(eventType.REMOTE_SDP_RECEIVED);
+            checkMetricSent('client.media-engine.remote-sdp-received', fakeError);
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE,
               Errors.ErrorCode.SdpAnswerHandlingError,
@@ -4096,7 +4189,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[Event.ROAP_FAILURE](fakeError);
 
-            checkMetricSent(eventType.LOCAL_SDP_GENERATED);
+            checkMetricSent('client.media-engine.local-sdp-generated', fakeError);
             // expectedMetadataType is the error name in this case
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.INVALID_ICE_CANDIDATE,
@@ -4114,7 +4207,7 @@ describe('plugin-meetings', () => {
 
             eventListeners[Event.ROAP_FAILURE](fakeError);
 
-            checkMetricSent(eventType.LOCAL_SDP_GENERATED);
+            checkMetricSent('client.media-engine.local-sdp-generated', fakeError);
             // expectedMetadataType is the error name in this case
             checkBehavioralMetricSent(
               BEHAVIORAL_METRICS.INVALID_ICE_CANDIDATE,
@@ -4147,10 +4240,10 @@ describe('plugin-meetings', () => {
               roapMessage: {messageType: 'OK', seq: 1},
             });
 
-            assert.calledOnce(Metrics.postEvent);
-            assert.calledWithMatch(Metrics.postEvent, {
-              event: eventType.REMOTE_SDP_RECEIVED,
-              meetingId: meeting.id,
+            assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media-engine.remote-sdp-received',
+              options: {meetingId: meeting.id},
             });
 
             assert.calledOnce(sendRoapOKStub);
@@ -4171,10 +4264,10 @@ describe('plugin-meetings', () => {
               },
             });
 
-            assert.calledOnce(Metrics.postEvent);
-            assert.calledWithMatch(Metrics.postEvent, {
-              event: eventType.LOCAL_SDP_GENERATED,
-              meetingId: meeting.id,
+            assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media-engine.local-sdp-generated',
+              options: {meetingId: meeting.id},
             });
 
             assert.calledOnce(sendRoapMediaRequestStub);
@@ -4197,10 +4290,10 @@ describe('plugin-meetings', () => {
               },
             });
 
-            assert.calledOnce(Metrics.postEvent);
-            assert.calledWithMatch(Metrics.postEvent, {
-              event: eventType.REMOTE_SDP_RECEIVED,
-              meetingId: meeting.id,
+            assert.calledOnce(webex.internal.newMetrics.submitClientEvent);
+            assert.calledWithMatch(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media-engine.remote-sdp-received',
+              options: {meetingId: meeting.id},
             });
 
             assert.calledOnce(sendRoapAnswerStub);
@@ -6796,66 +6889,6 @@ describe('plugin-meetings', () => {
           await testEmit(false);
         });
       });
-
-      describe('getAnalyzerMetricsPrePayload', () => {
-        it('should have #getAnalyzerMetricsPrePayload', () => {
-          assert.exists(meeting.getAnalyzerMetricsPrePayload);
-        });
-
-        beforeEach(() => {
-          meeting.meetingRequest.getAnalyzerMetricsPrePayload = sinon
-            .stub()
-            .returns(Promise.resolve());
-          meeting.webex.internal = {services: {get: sinon.stub().returns('Locus URL')}};
-          meeting.correlationId = 'correlation-id';
-        });
-
-        it('it should include meetingLookupUrl if provided', () => {
-          const res = meeting.getAnalyzerMetricsPrePayload({
-            meetingLookupUrl: 'https://service-url.com',
-            event: 'client.meetinginfo.response',
-          });
-
-          assert.deepEqual(res.event,  {
-            canProceed: true,
-            eventData: {
-              webClientDomain: '',
-            },
-            identifiers: {
-              correlationId: 'correlation-id',
-              deviceId: uuid3,
-              locusUrl: 'Locus URL',
-              meetingLookupUrl: 'https://service-url.com',
-              orgId: undefined,
-              userId: uuid1,
-            },
-            name: 'client.meetinginfo.response',
-          });
-
-          assert.deepEqual(res.origin, {
-            channel: undefined,
-            loginType: undefined,
-            userType: undefined,
-            clientInfo: {
-              browser: '',
-              browserVersion: '',
-              clientType: undefined,
-              clientVersion: 'webex-js-sdk/undefined',
-              localNetworkPrefix: null,
-              os: 'other',
-              osVersion: getOSVersion() || 'unknown',
-              subClientType: undefined,
-            },
-            name: 'endpoint',
-            networkType: 'unknown',
-            userAgent: 'webex-js-sdk/test-undefined client=undefined; (os=linux/5)',
-          });
-
-          assert.deepEqual(res.senderCountryCode, undefined);
-          assert.deepEqual(res.version, 1);
-
-        });
-      });
     });
   });
 });