@webex/plugin-meetings 3.0.0-beta.13 → 3.0.0-beta.131

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

@@ -10,7 +10,6 @@ import {assert} from '@webex/test-helper-chai';
 
 import metrics from '@webex/plugin-meetings/src/metrics';
 
-
 /**
  * Meeting can only run in a browser, so we can only send metrics for
  * browser usage.
@@ -23,7 +22,7 @@ browserOnly(describe)('Meeting metrics', () => {
     clientRegion: 'US-WEST',
     countryCode: 'US',
     regionCode: 'US-WEST',
-    timezone: 'America/Los_Angeles'
+    timezone: 'America/Los_Angeles',
   };
 
   beforeEach(() => {
@@ -31,16 +30,16 @@ browserOnly(describe)('Meeting metrics', () => {
     mockSubmitMetric = sandbox.stub();
     webex = new MockWebex({
       children: {
-        metrics: Metrics
-      }
+        metrics: Metrics,
+      },
     });
 
     webex.version = '1.2.3';
     webex.credentials.getOrgId = sinon.fake.returns('7890');
     webex.credentials.config = {
       _values: {
-        clientId: 'mock-client-id'
-      }
+        clientId: 'mock-client-id',
+      },
     };
     webex.config.metrics.type = ['behavioral'];
     webex.internal.metrics.submitClientMetrics = mockSubmitMetric;
@@ -55,7 +54,7 @@ browserOnly(describe)('Meeting metrics', () => {
     it('should create payload with masked IPv4', () => {
       geoHintInfo.clientAddress = '128.0.0.1';
       webex.meetings = {
-        geoHintInfo
+        geoHintInfo,
       };
       metrics.initialSetup({}, webex);
       const payload = metrics.initPayload('myMetric', {}, {clientType: 'TEAMS_CLIENT'});
@@ -71,7 +70,7 @@ browserOnly(describe)('Meeting metrics', () => {
     it('should create payload with masked IPv6', () => {
       geoHintInfo.clientAddress = '2001:0db8:0000:08d3:0000:0000:0070:0000';
       webex.meetings = {
-        geoHintInfo
+        geoHintInfo,
       };
       metrics.initialSetup({}, webex);
       const payload = metrics.initPayload('myIPv6Metric', {}, {clientType: 'TEAMS_CLIENT'});
@@ -98,19 +97,113 @@ browserOnly(describe)('Meeting metrics', () => {
 
       metrics.sendBehavioralMetric('myMetric', fields, metricTags);
 
-      assert.calledWithMatch(
-        mockSubmitMetric,
-        'myMetric',
-        {
-          type: ['behavioral'],
-          fields: {
-            value: 567
-          },
-          tags: {
-            test: true
-          }
-        }
+      assert.calledWithMatch(mockSubmitMetric, 'myMetric', {
+        type: ['behavioral'],
+        fields: {
+          value: 567,
+        },
+        tags: {
+          test: true,
+        },
+      });
+    });
+  });
+
+  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,
+      });
     });
   });
 });