@webex/internal-plugin-metrics 3.0.0-beta.229 → 3.0.0-beta.230

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

@@ -3,17 +3,38 @@
  */
 
 import {assert} from '@webex/test-helper-chai';
-import {config} from '@webex/internal-plugin-metrics';
+import {config, Utils} from '@webex/internal-plugin-metrics';
 import MockWebex from '@webex/test-helper-mock-webex';
 import sinon from 'sinon';
+import FakeTimers from '@sinonjs/fake-timers';
 import {NewMetrics} from '@webex/internal-plugin-metrics';
+import { uniqueId } from 'lodash';
+
 const flushPromises = () => new Promise(setImmediate);
 
+function promiseTick(count) {
+  let promise = Promise.resolve();
+
+  while (count > 1) {
+    promise = promise.then(() => promiseTick(1));
+    count -= 1;
+  }
+
+  return promise;
+}
+
+
 describe('plugin-metrics', () => {
   describe('CallDiagnosticEventsBatcher', () => {
     let webex;
+    let clock;
+    let now;
+
 
     beforeEach(() => {
+      now = new Date();
+      clock = FakeTimers.install({now});
+
       //@ts-ignore
       webex = new MockWebex({
         children: {
@@ -31,16 +52,20 @@ describe('plugin-metrics', () => {
 
     afterEach(() => {
       sinon.restore();
+      clock.uninstall();
     });
 
     describe('#request()', () => {
       describe('when the request completes successfully', async () => {
         it('clears the queue', async () => {
-          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.interstitial-window.launched'}}
           );
           await flushPromises();
+          clock.tick(config.metrics.batcherWait);
+
+          await promise;
 
           //@ts-ignore
           assert.calledOnce(webex.request);
@@ -48,11 +73,14 @@ describe('plugin-metrics', () => {
         });
 
         it('doesnt include any joinTimes for other events', async () => {
-          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.alert.displayed'}}
           );
           await flushPromises();
+          clock.tick(config.metrics.batcherWait);
+
+          await promise;
 
           //@ts-ignore
           assert.calledOnce(webex.request);
@@ -65,11 +93,14 @@ describe('plugin-metrics', () => {
         it('appends the correct join times to the request for client.interstitial-window.launched', async () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
           webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitial = sinon.stub().returns(10);
-          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.interstitial-window.launched'}}
           );
           await flushPromises();
+          clock.tick(config.metrics.batcherWait);
+
+          await promise;
 
           //@ts-ignore
           assert.calledOnce(webex.request);
@@ -85,12 +116,14 @@ describe('plugin-metrics', () => {
 
         it('appends the correct join times to the request for client.call.initiated', async () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
-          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.call.initiated'}}
           );
           await flushPromises();
+          clock.tick(config.metrics.batcherWait);
 
+          await promise;
           //@ts-ignore
           assert.calledOnce(webex.request);
           assert.deepEqual(webex.request.getCalls()[0].args[0].body.metrics[0].eventPayload.event, {
@@ -110,11 +143,14 @@ describe('plugin-metrics', () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getClientJMT = sinon.stub().returns(5);
           webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitial = sinon.stub().returns(10);
           webex.internal.newMetrics.callDiagnosticLatencies.getCallInitJoinReq = sinon.stub().returns(10);
-          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.locus.join.response'}}
           );
           await flushPromises();
+          clock.tick(config.metrics.batcherWait);
+
+          await promise;
 
           //@ts-ignore
           assert.calledOnce(webex.request);
@@ -137,11 +173,14 @@ describe('plugin-metrics', () => {
 
         it('appends the correct join times to the request for client.ice.end', async () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
-          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.ice.end'}}
           );
           await flushPromises();
+          clock.tick(config.metrics.batcherWait);
+
+          await promise;
 
           //@ts-ignore
           assert.calledOnce(webex.request);
@@ -159,11 +198,14 @@ describe('plugin-metrics', () => {
 
         it('appends the correct join times to the request for client.media.rx.start', async () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
-          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.media.rx.start'}}
           );
           await flushPromises();
+          clock.tick(config.metrics.batcherWait);
+
+          await promise;
 
           //@ts-ignore
           assert.calledOnce(webex.request);
@@ -180,11 +222,14 @@ describe('plugin-metrics', () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
           webex.internal.newMetrics.callDiagnosticLatencies.getInterstitialToMediaOKJMT = sinon.stub().returns(10);
           webex.internal.newMetrics.callDiagnosticLatencies.getClickToInterstitial = sinon.stub().returns(10);
-          await webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.media-engine.ready'}}
           );
           await flushPromises();
+          clock.tick(config.metrics.batcherWait);
+
+          await promise;
 
           //@ts-ignore
           assert.calledOnce(webex.request);
@@ -202,11 +247,14 @@ describe('plugin-metrics', () => {
 
         it('appends the correct audio and video setup delays to the request for client.mediaquality.event', async () => {
           webex.internal.newMetrics.callDiagnosticLatencies.getDiffBetweenTimestamps = sinon.stub().returns(10);
-          await  webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.mediaquality.event'}}
           );
           await flushPromises();
+          clock.tick(config.metrics.batcherWait);
+
+          await promise;
 
           //@ts-ignore
           assert.calledOnce(webex.request);
@@ -225,11 +273,14 @@ describe('plugin-metrics', () => {
         });
 
         it('doesnt include audioSetup and videoSetup delays for other events', async () => {
-          await  webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics(
             //@ts-ignore
             {event: {name: 'client.alert.displayed'}}
           );
           await flushPromises();
+          clock.tick(config.metrics.batcherWait);
+
+          await promise;
 
           //@ts-ignore
           assert.calledOnce(webex.request);
@@ -238,6 +289,63 @@ describe('plugin-metrics', () => {
           assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
         })
       });
+
+      describe('when the request fails', () => {
+        it('does not clear the queue', async () => {
+          // avoid setting .sent timestamp
+          webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.prepareRequest =
+            (q) => Promise.resolve(q);
+
+          const err = new Error('error');
+          webex.request = sinon.stub().returns(Promise.reject(err));
+
+          webex.logger.error = sinon.stub();
+          webex.logger.log = sinon.stub();
+          sinon.stub(Utils, 'generateCommonErrorMetadata').returns('formattedError');
+
+          const promise = webex.internal.newMetrics.callDiagnosticMetrics.submitToCallDiagnostics({
+            event: 'my.event',
+          });
+
+          await flushPromises();
+          clock.tick(config.metrics.batcherWait);
+
+          let error;
+
+          // catch the expected error and store it
+          await promise.catch((e) => {
+            error = e;
+          });
+
+          const loggerLogCalls = webex.logger.log.getCalls();
+
+          assert.deepEqual(loggerLogCalls[0].args, [
+            'call-diagnostic-events -> ',
+            'CallDiagnosticMetrics: @submitToCallDiagnostics. Preparing to send the request',
+            `finalEvent: {"eventPayload":{"event":"my.event"},"type":["diagnostic-event"]}`,
+          ]);
+
+          // This is horrific, but stubbing lodash is proving difficult
+          const expectedBatchId = parseInt(uniqueId()) - 1;
+
+          assert.deepEqual(loggerLogCalls[1].args, [
+            'call-diagnostic-events -> ',
+            `CallDiagnosticEventsBatcher: @submitHttpRequest#call-diagnostic-metrics-batch-${expectedBatchId}. Sending the request:`,
+            `payload: [{"eventPayload":{"event":"my.event","origin":{"buildType":"test","networkType":"unknown"}},"type":["diagnostic-event"]}]`,
+          ]);
+
+          // check that promise was rejected with the original error of the webex.request
+          assert.deepEqual(err, error);
+
+          assert.calledOnceWithExactly(
+            webex.logger.error,
+            'call-diagnostic-events -> ',
+            `CallDiagnosticEventsBatcher: @submitHttpRequest#call-diagnostic-metrics-batch-${expectedBatchId}. Request failed:`,
+            `error: formattedError`
+          );
+          assert.lengthOf(webex.internal.newMetrics.callDiagnosticMetrics.callDiagnosticEventsBatcher.queue, 0);
+        });
+      });
     });
   });
 });

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

@@ -104,7 +104,7 @@ describe('internal-plugin-metrics', () => {
     });
 
     it('calculates getShowInterstitialTime correctly', () => {
-      cdl.saveTimestamp({key: 'internal.client.interstitial-window.launched', value: 10});
+      cdl.saveTimestamp({key: 'client.interstitial-window.start-launch', value: 10});
       cdl.saveTimestamp({key: 'internal.client.interstitial-window.click.joinbutton', value: 20});
       assert.deepEqual(cdl.getShowInterstitialTime(), 10);
     });

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

@@ -405,6 +405,28 @@ describe('internal-plugin-metrics', () => {
           senderCountryCode: 'UK',
           version: 1,
         });
+
+        const webexLoggerLogCalls = webex.logger.log.getCalls();
+        assert.deepEqual(webexLoggerLogCalls[0].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @submitClientEvent. Submit Client Event CA event.',
+          `name: client.alert.displayed`,
+          `payload: undefined`,
+          `options: ${JSON.stringify(options)}`,
+        ]);
+
+        assert.deepEqual(webexLoggerLogCalls[1].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @createClientEventObjectInMeeting. Creating in meeting event object.',
+          `name: client.alert.displayed`
+        ]);
+
+        assert.deepEqual(webexLoggerLogCalls[2].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @submitToCallDiagnostics. Preparing to send the request',
+          `finalEvent: {"eventPayload":{"eventId":"my-fake-id","version":1,"origin":{"origin":"fake-origin"},"originTime":{"triggered":"${now.toISOString()}","sent":"not_defined_yet"},"senderCountryCode":"UK","event":{"name":"client.alert.displayed","canProceed":true,"identifiers":{"correlationId":"correlationId","userId":"userId","deviceId":"deviceUrl","orgId":"orgId","locusUrl":"locus/url","locusId":"url","locusStartTime":"lastActive","mediaAgentAlias":"alias","mediaAgentGroupId":"1"},"eventData":{"webClientDomain":"whatever"},"userType":"host","loginType":"login-ci"}},"type":["diagnostic-event"]}`,
+        ]);
+
       });
 
       it('should submit client event successfully with correlationId', () => {
@@ -474,6 +496,30 @@ describe('internal-plugin-metrics', () => {
           senderCountryCode: 'UK',
           version: 1,
         });
+
+        const webexLoggerLogCalls = webex.logger.log.getCalls();
+
+        assert.deepEqual(webexLoggerLogCalls[0].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @submitClientEvent. Submit Client Event CA event.',
+          `name: client.alert.displayed`,
+          `payload: undefined`,
+          `options: ${JSON.stringify(options)}`,
+        ]);
+
+        assert.deepEqual(webexLoggerLogCalls[1].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @createClientEventObjectPreMeeting. Creating pre meeting event object.',
+          `name: client.alert.displayed`
+        ]);
+
+        assert.deepEqual(webexLoggerLogCalls[2].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @submitToCallDiagnostics. Preparing to send the request',
+          `finalEvent: {"eventPayload":{"eventId":"my-fake-id","version":1,"origin":{"origin":"fake-origin"},"originTime":{"triggered":"${now.toISOString()}","sent":"not_defined_yet"},"senderCountryCode":"UK","event":{"name":"client.alert.displayed","canProceed":true,"identifiers":{"correlationId":"correlationId","userId":"userId","deviceId":"deviceUrl","orgId":"orgId","locusUrl":"locus-url"},"eventData":{"webClientDomain":"whatever"},"loginType":"login-ci"}},"type":["diagnostic-event"]}`,
+        ]);
+
+
       });
 
       it('it should include errors if provided with meetingId', () => {
@@ -539,6 +585,41 @@ describe('internal-plugin-metrics', () => {
           senderCountryCode: 'UK',
           version: 1,
         });
+
+        const webexLoggerLogCalls = webex.logger.log.getCalls();
+        assert.deepEqual(webexLoggerLogCalls[0].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @submitClientEvent. Submit Client Event CA event.',
+          `name: client.alert.displayed`,
+          `payload: undefined`,
+          `options: ${JSON.stringify(options)}`,
+        ]);
+
+
+        assert.deepEqual(webexLoggerLogCalls[1].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @prepareClientEvent. Error detected, attempting to map and attach it to the event...',
+          `name: client.alert.displayed`,
+          `rawError: ${options.rawError}`
+        ]);
+
+        assert.deepEqual(webexLoggerLogCalls[2].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @prepareClientEvent. Generated errors:',
+          `generatedError: {"fatal":true,"shownToUser":false,"name":"other","category":"expected","errorCode":4029,"serviceErrorCode":2409005,"errorDescription":"StartRecordingFailed"}`
+        ])
+
+        assert.deepEqual(webexLoggerLogCalls[3].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @createClientEventObjectInMeeting. Creating in meeting event object.',
+          `name: client.alert.displayed`
+        ]);
+
+        assert.deepEqual(webexLoggerLogCalls[4].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @submitToCallDiagnostics. Preparing to send the request',
+          `finalEvent: {"eventPayload":{"eventId":"my-fake-id","version":1,"origin":{"origin":"fake-origin"},"originTime":{"triggered":"${now.toISOString()}","sent":"not_defined_yet"},"senderCountryCode":"UK","event":{"name":"client.alert.displayed","canProceed":true,"identifiers":{"correlationId":"correlationId","userId":"userId","deviceId":"deviceUrl","orgId":"orgId","locusUrl":"locus/url","locusId":"url","locusStartTime":"lastActive","mediaAgentAlias":"alias","mediaAgentGroupId":"1"},"errors":[{"fatal":true,"shownToUser":false,"name":"other","category":"expected","errorCode":4029,"serviceErrorCode":2409005,"errorDescription":"StartRecordingFailed"}],"eventData":{"webClientDomain":"whatever"},"userType":"host","loginType":"login-ci"}},"type":["diagnostic-event"]}`,
+        ]);
       });
 
       it('it should include errors if provided with correlationId', () => {
@@ -597,6 +678,42 @@ describe('internal-plugin-metrics', () => {
           senderCountryCode: 'UK',
           version: 1,
         });
+
+        const webexLoggerLogCalls = webex.logger.log.getCalls();
+
+        assert.deepEqual(webexLoggerLogCalls[0].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @submitClientEvent. Submit Client Event CA event.',
+          `name: client.alert.displayed`,
+          `payload: undefined`,
+          `options: ${JSON.stringify(options)}`,
+        ]);
+
+
+        assert.deepEqual(webexLoggerLogCalls[1].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @prepareClientEvent. Error detected, attempting to map and attach it to the event...',
+          `name: client.alert.displayed`,
+          `rawError: ${options.rawError}`
+        ]);
+
+        assert.deepEqual(webexLoggerLogCalls[2].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @prepareClientEvent. Generated errors:',
+          `generatedError: {"fatal":true,"shownToUser":false,"name":"other","category":"expected","errorCode":4029,"serviceErrorCode":2409005,"errorDescription":"StartRecordingFailed"}`
+        ])
+
+        assert.deepEqual(webexLoggerLogCalls[3].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @createClientEventObjectPreMeeting. Creating pre meeting event object.',
+          `name: client.alert.displayed`
+        ]);
+
+        assert.deepEqual(webexLoggerLogCalls[4].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @submitToCallDiagnostics. Preparing to send the request',
+          `finalEvent: {"eventPayload":{"eventId":"my-fake-id","version":1,"origin":{"origin":"fake-origin"},"originTime":{"triggered":"${now.toISOString()}","sent":"not_defined_yet"},"senderCountryCode":"UK","event":{"name":"client.alert.displayed","errors":[{"fatal":true,"shownToUser":false,"name":"other","category":"expected","errorCode":4029,"serviceErrorCode":2409005,"errorDescription":"StartRecordingFailed"}],"canProceed":true,"identifiers":{"correlationId":"correlationId","userId":"userId","deviceId":"deviceUrl","orgId":"orgId","locusUrl":"locus-url"},"eventData":{"webClientDomain":"whatever"},"loginType":"login-ci"}},"type":["diagnostic-event"]}`,
+        ]);
       });
 
       it('should include errors in payload if provided via payload', () => {
@@ -1097,6 +1214,23 @@ describe('internal-plugin-metrics', () => {
           resource: 'clientmetrics',
           service: 'metrics',
         });
+
+        const webexLoggerLogCalls = webex.logger.log.getCalls();
+
+        assert.deepEqual(webexLoggerLogCalls[0].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @buildClientEventFetchRequestOptions. Building request options object for fetch()...',
+          `name: client.exit.app`,
+          `payload: {"trigger":"user-interaction","canProceed":false}`,
+          `options: ${JSON.stringify(options)}`,
+        ]);
+
+        assert.deepEqual(webexLoggerLogCalls[1].args, [
+          'call-diagnostic-events -> ',
+          'CallDiagnosticMetrics: @createClientEventObjectInMeeting. Creating in meeting event object.',
+          `name: client.exit.app`
+        ]);
+
       });
     });
 

package/test/unit/spec/new-metrics.ts

@@ -2,6 +2,7 @@ import {assert} from '@webex/test-helper-chai';
 import {NewMetrics} from '@webex/internal-plugin-metrics';
 import MockWebex from '@webex/test-helper-mock-webex';
 import sinon from 'sinon';
+import {Utils} from '@webex/internal-plugin-metrics';
 
 describe('internal-plugin-metrics', () => {
   describe('new-metrics', () => {
@@ -18,7 +19,11 @@ describe('internal-plugin-metrics', () => {
             get: sinon.stub(),
           },
         },
-        request: sinon.stub().resolves({})
+        request: sinon.stub().resolves({}),
+        logger: {
+          log: sinon.stub(),
+          error: sinon.stub(),
+        }
       });
 
       webex.emit('ready');
@@ -34,6 +39,10 @@ describe('internal-plugin-metrics', () => {
       webex.setTimingsAndFetch = sinon.stub();
     });
 
+    afterEach(() => {
+      sinon.restore();
+    })
+
     it('submits Client Event successfully', () => {
       webex.internal.newMetrics.submitClientEvent({
         name: 'client.alert.displayed',
@@ -99,8 +108,9 @@ describe('internal-plugin-metrics', () => {
     });
 
     describe('#clientMetricsAliasUser', () => {
-      it('aliases the user correctly', () => {
-        webex.internal.newMetrics.clientMetricsAliasUser('my-id');
+      it('aliases the user correctly', async () => {
+        webex.request.resolves({response: 'abc'});
+        await webex.internal.newMetrics.clientMetricsAliasUser('my-id');
         assert.calledWith(webex.request, {
           method: 'POST',
           api: 'metrics',
@@ -109,12 +119,32 @@ describe('internal-plugin-metrics', () => {
           body: {},
           qs: { alias: true }
         });
-      })
+        assert.calledWith(
+          webex.logger.log,
+          'NewMetrics: @clientMetricsAliasUser. Request successful:',
+          'res: {"response":"abc"}'
+        );
+      });
+
+      it('handles failed request correctly', async () => {
+        webex.request.rejects(new Error("test error"));
+        sinon.stub(Utils, 'generateCommonErrorMetadata').returns('formattedError')
+        try {
+          await webex.internal.newMetrics.clientMetricsAliasUser({event: 'test'}, 'my-id');
+        } catch (err) {
+          assert.calledWith(
+            webex.logger.error,
+            'NewMetrics: @clientMetricsAliasUser. Request failed:',
+            `err: formattedError`
+          );
+        }
+      });
     });
 
     describe('#postPreLoginMetric', () => {
-      it('sends the request correctly', () => {
-        webex.internal.newMetrics.postPreLoginMetric({event: 'test'}, 'my-id');
+      it('sends the request correctly', async () => {
+        webex.request.resolves({response: 'abc'});
+        await webex.internal.newMetrics.postPreLoginMetric({event: 'test'}, 'my-id');
         assert.calledWith(webex.request, {
           method: 'POST',
           api: 'metrics',
@@ -122,7 +152,26 @@ describe('internal-plugin-metrics', () => {
           headers: { 'x-prelogin-userid': 'my-id', authorization: false },
           body: {event: 'test'},
         });
-      })
+        assert.calledWith(
+          webex.logger.log,
+          'NewMetrics: @postPreLoginMetric. Request successful:',
+          'res: {"response":"abc"}'
+        );
+      });
+
+      it('handles failed request correctly', async () => {
+        webex.request.rejects(new Error("test error"));
+        sinon.stub(Utils, 'generateCommonErrorMetadata').returns('formattedError')
+        try {
+          await webex.internal.newMetrics.postPreLoginMetric({event: 'test'}, 'my-id');
+        } catch (err) {
+          assert.calledWith(
+            webex.logger.error,
+            'NewMetrics: @postPreLoginMetric. Request failed:',
+            `err: formattedError`
+          );
+        }
+      });
     })
 
     describe('#buildClientEventFetchRequestOptions', () => {

package/test/unit/spec/utils.ts

@@ -0,0 +1,22 @@
+import {assert} from '@webex/test-helper-chai';
+import {Utils} from '@webex/internal-plugin-metrics';
+
+describe('internal-plugin-metrics', () => {
+  describe('generateCommonErrorMetadata', () => {
+    it('should return JSON stringified error object', () => {
+      const error = new Error('test error');
+      const result = Utils.generateCommonErrorMetadata(error);
+      assert.deepEqual(result, JSON.stringify({
+        message: 'test error',
+        name: 'Error',
+        stack: error.stack
+      }))
+    });
+
+    it('should return error if not instanceof Error', () => {
+      const error = 'test error';
+      const result = Utils.generateCommonErrorMetadata(error);
+     assert.deepEqual(result, 'test error')
+    });
+  });
+})