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

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

@@ -17,14 +17,6 @@ import metrics from '@webex/plugin-meetings/src/metrics';
 browserOnly(describe)('Meeting metrics', () => {
   let webex, mockSubmitMetric, sandbox;
 
-  const geoHintInfo = {
-    clientAddress: '2001:0db8:0000:08d3:0000:0000:0070:0000',
-    clientRegion: 'US-WEST',
-    countryCode: 'US',
-    regionCode: 'US-WEST',
-    timezone: 'America/Los_Angeles',
-  };
-
   beforeEach(() => {
     sandbox = sinon.createSandbox();
     mockSubmitMetric = sandbox.stub();
@@ -34,56 +26,15 @@ browserOnly(describe)('Meeting metrics', () => {
       },
     });
 
-    webex.version = '1.2.3';
-    webex.credentials.getOrgId = sinon.fake.returns('7890');
-    webex.credentials.config = {
-      _values: {
-        clientId: 'mock-client-id',
-      },
-    };
     webex.config.metrics.type = ['behavioral'];
     webex.internal.metrics.submitClientMetrics = mockSubmitMetric;
-    metrics.initialSetup({}, webex);
+    metrics.initialSetup(webex);
   });
 
   afterEach(() => {
     sandbox.restore();
   });
 
-  describe('initPayload / initMediaPayload', () => {
-    it('should create payload with masked IPv4', () => {
-      geoHintInfo.clientAddress = '128.0.0.1';
-      webex.meetings = {
-        geoHintInfo,
-      };
-      metrics.initialSetup({}, webex);
-      const payload = metrics.initPayload('myMetric', {}, {clientType: 'TEAMS_CLIENT'});
-
-      assert(payload.origin.clientInfo.localNetworkPrefix === '128.0.0.0');
-      assert(payload.event.name === 'myMetric');
-
-      const payload2 = metrics.initMediaPayload('myMetric', {}, {clientType: 'TEAMS_CLIENT'});
-
-      assert(payload2.origin.clientInfo.localNetworkPrefix === '128.0.0.0');
-    });
-
-    it('should create payload with masked IPv6', () => {
-      geoHintInfo.clientAddress = '2001:0db8:0000:08d3:0000:0000:0070:0000';
-      webex.meetings = {
-        geoHintInfo,
-      };
-      metrics.initialSetup({}, webex);
-      const payload = metrics.initPayload('myIPv6Metric', {}, {clientType: 'TEAMS_CLIENT'});
-
-      assert(payload.origin.clientInfo.localNetworkPrefix === '2001:db8:0:8d3::');
-      assert(payload.event.name === 'myIPv6Metric');
-
-      const payload2 = metrics.initMediaPayload('myIPv6Metric', {}, {clientType: 'TEAMS_CLIENT'});
-
-      assert(payload2.origin.clientInfo.localNetworkPrefix === '2001:db8:0:8d3::');
-    });
-  });
-
   describe('#sendBehavioralMetric', () => {
     it('sends client metric via Metrics plugin', () => {
       metrics.sendBehavioralMetric('myMetric');
@@ -108,102 +59,4 @@ browserOnly(describe)('Meeting metrics', () => {
       });
     });
   });
-
-  describe('parseWebexApiError', () => {
-    it('returns the correct error data for meeting lookup info error', () => {
-      const err = {
-        body: {
-          code: 58400,
-        },
-        statusCode: 400,
-      };
-      const res = metrics.parseWebexApiError(err, false);
-
-      assert.deepEqual(res, {
-        shownToUser: false,
-        category: 'signaling',
-        errorDescription: 'MeetingInfoLookupError',
-        errorCode: 4100,
-        fatal: true,
-        name: 'other',
-        serviceErrorCode: 58400,
-        errorData:  { error: { code: 58400 } },
-        httpCode: 400
-      });
-    });
-
-    it('returns the correct error data for access rights error error', () => {
-      const err = {
-        body: {
-          code: 403041,
-        },
-        statusCode: 400,
-      };
-      const res = metrics.parseWebexApiError(err, false);
-
-      assert.deepEqual(res, {
-        shownToUser: false,
-        "category": "expected",
-        "errorCode": 4005,
-        errorDescription: 'Moderator_Pin_Or_Guest_PIN_Required',
-        fatal: false,
-        name: 'other',
-        serviceErrorCode: 403041,
-        errorData: { error: { code: 403041 } },
-        httpCode: 400
-      });
-    });
-
-    it('returns default 4100 mapping for unknown error', () => {
-      const err = {
-        body: {
-          code: 123456,
-        },
-      };
-      const res = metrics.parseWebexApiError(err, false);
-
-      assert.deepEqual(res, {
-        shownToUser: false,
-        category: 'signaling',
-        errorDescription: 'MeetingInfoLookupError',
-        errorCode: 4100,
-        fatal: true,
-        name: 'other',
-        serviceErrorCode: 123456,
-        errorData:  { error: { code: 123456 } },
-      });
-    });
-  });
-
-  describe('#generateErrorPayload', () => {
-    it('generates the correct payload for a valid error code', () => {
-      const errorCode = 4008;
-      const shownToUser = true;
-      const name = 'errorName';
-      const errBody = 'some error body';
-      const err = {
-        body: errBody,
-        statusCode: 404,
-      };
-
-      const payload = metrics.generateErrorPayload(
-        errorCode,
-        shownToUser,
-        name,
-        err
-      );
-
-      assert.deepEqual(payload, {
-        shownToUser,
-        category: 'expected',
-        errorDescription: 'NewLocusError',
-        errorCode,
-        fatal: true,
-        name,
-        errorData: {error: errBody},
-        serviceErrorCode: undefined,
-        httpCode: 404,
-      });
-    });
-  });
 });

package/test/unit/spec/reconnection-manager/index.js

@@ -3,7 +3,6 @@ import chai from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import sinon from 'sinon';
 import ReconnectionManager from '@webex/plugin-meetings/src/reconnection-manager';
-import Metrics from '@webex/plugin-meetings/src/metrics';
 
 const {assert} = chai;
 
@@ -16,7 +15,6 @@ describe('plugin-meetings', () => {
     let fakeMeeting;
 
     beforeEach(() => {
-      Metrics.postEvent = sinon.stub();
       fakeMediaConnection = {
         initiateOffer: sinon.stub().resolves({}),
         reconnect: sinon.stub().resolves({}),
@@ -64,6 +62,11 @@ describe('plugin-meetings', () => {
             getMeetingByType: sinon.stub().returns(true),
             syncMeetings: sinon.stub().resolves({}),
           },
+          internal: {
+            newMetrics: {
+              submitClientEvent: sinon.stub()
+            }
+          }
         },
       };
     });
@@ -82,6 +85,23 @@ describe('plugin-meetings', () => {
           credential: 'fake_turn_password',
         },
       ]);
+
+      assert.calledWith(fakeMeeting.webex.internal.newMetrics.submitClientEvent, {
+        name: 'client.media.reconnecting',
+        options: {
+          meetingId: rm.meeting.id,
+        },
+      });
+
+      assert.calledWith(fakeMeeting.webex.internal.newMetrics.submitClientEvent, {
+        name: 'client.media.recovered',
+        payload: {
+          recoveredBy: 'new',
+        },
+        options: {
+          meetingId: rm.meeting.id,
+        },
+      });
     });
 
     it('does not clear previous requests and re-request media for non-multistream meetings', async () => {
@@ -107,6 +127,35 @@ describe('plugin-meetings', () => {
       assert.calledOnce(fakeMeeting.mediaRequestManagers.audio.commit);
       assert.calledOnce(fakeMeeting.mediaRequestManagers.video.commit);
     });
+
+
+    it('sends the correct client event when reconnection fails', async () => {
+      sinon.stub(ReconnectionManager.prototype, 'executeReconnection').rejects();
+      fakeMeeting.isMultistream = true;
+      const rm = new ReconnectionManager(fakeMeeting);
+
+      try {
+        await rm.reconnect();
+      } catch (err) {
+        assert.calledWith(fakeMeeting.webex.internal.newMetrics.submitClientEvent, {
+          name: 'client.call.aborted',
+          payload: {
+            errors: [
+              {
+                category: 'expected',
+                errorCode: 2008,
+                fatal: true,
+                name: 'media-engine',
+                shownToUser: false,
+              },
+            ],
+          },
+          options: {
+            meetingId: rm.meeting.id,
+          },
+        });
+      }
+    });
   });
 
   /**

package/test/unit/spec/roap/index.ts

@@ -1,6 +1,7 @@
 import {assert} from '@webex/test-helper-chai';
 import sinon from 'sinon';
 import TurnDiscovery from '@webex/plugin-meetings/src/roap/turnDiscovery';
+import MockWebex from '@webex/test-helper-mock-webex';
 
 import RoapRequest from '@webex/plugin-meetings/src/roap/request';
 import Roap from '@webex/plugin-meetings/src/roap/';
@@ -9,6 +10,8 @@ import Meeting from '@webex/plugin-meetings/src/meeting';
 describe('Roap', () => {
   describe('doTurnDiscovery', () => {
     it('calls this.turnDiscovery.doTurnDiscovery() and forwards all the arguments', async () => {
+      const webex = new MockWebex({});
+
       const RESULT = {something: 'some value'};
       const meeting = {id: 'some meeting id'} as Meeting;
 
@@ -16,7 +19,7 @@ describe('Roap', () => {
         .stub(TurnDiscovery.prototype, 'doTurnDiscovery')
         .resolves(RESULT);
 
-      const roap = new Roap({}, {parent: 'fake'});
+      const roap = new Roap({}, {parent: webex});
 
       // call with isReconnecting: true
       const result = await roap.doTurnDiscovery(meeting, true);
@@ -40,7 +43,10 @@ describe('Roap', () => {
     let sendRoapStub;
     let meeting;
 
+    let webex;
+
     beforeEach(() => {
+      webex = new MockWebex({});
       meeting = {
         id: 'some meeting id',
         correlationId: 'correlation id',
@@ -77,7 +83,7 @@ describe('Roap', () => {
       }reconnecting and TURN discovery is ${
         turnDiscoverySkipped ? 'skipped' : 'not skipped'
       }`, async () => {
-        const roap = new Roap({}, {parent: 'fake'});
+        const roap = new Roap({}, {parent: webex});
 
         sinon.stub(roap.turnDiscovery, 'isSkipped').resolves(turnDiscoverySkipped);
 

package/test/unit/spec/roap/request.ts

@@ -3,7 +3,6 @@ import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';
 import Meetings from '@webex/plugin-meetings';
 import RoapRequest from '@webex/plugin-meetings/src/roap/request';
-import Metrics from '@webex/plugin-meetings/src/metrics';
 import {REACHABILITY} from '@webex/plugin-meetings/src/constants';
 
 describe('plugin-meetings/roap', () => {
@@ -31,6 +30,9 @@ describe('plugin-meetings/roap', () => {
       device: {
         url: 'url',
       },
+      newMetrics: {
+        submitClientEvent: sinon.stub()
+      },
     };
 
     // @ts-ignore
@@ -51,8 +53,6 @@ describe('plugin-meetings/roap', () => {
       })
     );
 
-    Metrics.postEvent = sinon.stub().returns();
-
     await webex.boundedStorage.put(
       REACHABILITY.namespace,
       REACHABILITY.localStorageJoinCookie,
@@ -108,7 +108,7 @@ describe('plugin-meetings/roap', () => {
 
   describe('sendRoap', () => {
     it('includes joinCookie in the request correctly', async () => {
-      const locusMediaRequest = { send: sinon.stub().resolves({body: {locus: {}}})};
+      const locusMediaRequest = {send: sinon.stub().resolves({body: {locus: {}}})};
 
       await roapRequest.sendRoap({
         locusSelfUrl: locusUrl,
@@ -116,9 +116,24 @@ describe('plugin-meetings/roap', () => {
         roapMessage: {
           seq: 'seq',
         },
+        meetingId: 'meeting-id',
         locusMediaRequest,
       });
 
+      assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+        name: 'client.locus.media.request',
+        options: {
+          meetingId: 'meeting-id',
+        },
+      });
+
+      assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+        name: 'client.locus.media.response',
+        options: {
+          meetingId: 'meeting-id',
+        },
+      });
+
       const requestParams = locusMediaRequest.send.getCall(0).args[0];
       assert.deepEqual(requestParams, {
         type: 'RoapMessage',
@@ -130,9 +145,32 @@ describe('plugin-meetings/roap', () => {
         roapMessage: {
           seq: 'seq',
         },
-        reachability: {clusterId:{udp:"test"}},
+        reachability: {clusterId: {udp: 'test'}},
       });
     });
+
+    it('sends correct client event when fails', async () => {
+      const locusMediaRequest = {send: sinon.stub().rejects({code: 300, message: 'error'})};
+      try {
+        await roapRequest.sendRoap({
+          locusSelfUrl: locusUrl,
+          mediaId: 'mediaId',
+          roapMessage: {
+            seq: 'seq',
+          },
+          meetingId: 'meeting-id',
+          locusMediaRequest,
+        });
+      } catch (err) {
+        assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+          name: 'client.locus.media.response',
+          options: {
+            meetingId: 'meeting-id',
+            rawError: {code: 300, message: 'error'},
+          },
+        });
+      }
+    });
   });
 
   it('calls attachReachabilityData when sendRoap', async () => {