@webex/internal-plugin-metrics 3.0.0-beta.319 → 3.0.0-beta.320

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

@@ -19,7 +19,7 @@ const userAgent = `webex-js-sdk/test-webex-version client=Cantina; (os=${getOSNa
   getOSVersion().split('.')[0]
 })`;
 
-describe('internal-plugin-metrics', () => {
+describe.only('internal-plugin-metrics', () => {
   describe('CallDiagnosticMetrics', () => {
     var now = new Date();
 
@@ -51,7 +51,7 @@ describe('internal-plugin-metrics', () => {
           },
           metrics: {
             submitClientMetrics: sinon.stub(),
-            config: {...CONFIG.metrics}
+            config: {...CONFIG.metrics},
           },
           newMetrics: {
             postPreLoginMetric: sinon.stub(),
@@ -67,7 +67,7 @@ describe('internal-plugin-metrics', () => {
             metrics: {
               clientType: 'TEAMS_CLIENT',
               subClientType: 'WEB_APP',
-              clientName: 'Cantina'
+              clientName: 'Cantina',
             },
           },
           meetingCollection: {
@@ -143,7 +143,12 @@ describe('internal-plugin-metrics', () => {
 
         //@ts-ignore
         const res = cd.getOrigin(
-          {subClientType: 'WEB_APP', clientType: 'TEAMS_CLIENT', newEnvironment: 'test-new-env', clientLaunchMethod: 'url-handler'},
+          {
+            subClientType: 'WEB_APP',
+            clientType: 'TEAMS_CLIENT',
+            newEnvironment: 'test-new-env',
+            clientLaunchMethod: 'url-handler',
+          },
           fakeMeeting.id
         );
 
@@ -172,7 +177,12 @@ describe('internal-plugin-metrics', () => {
 
         //@ts-ignore
         const res = cd.getOrigin(
-          {subClientType: 'WEB_APP', clientType: 'TEAMS_CLIENT', clientLaunchMethod: 'url-handler', environment: 'test-env'},
+          {
+            subClientType: 'WEB_APP',
+            clientType: 'TEAMS_CLIENT',
+            clientLaunchMethod: 'url-handler',
+            environment: 'test-env',
+          },
           fakeMeeting.id
         );
 
@@ -186,7 +196,7 @@ describe('internal-plugin-metrics', () => {
             os: getOSNameInternal(),
             osVersion: getOSVersion(),
             subClientType: 'WEB_APP',
-            clientLaunchMethod: 'url-handler'
+            clientLaunchMethod: 'url-handler',
           },
           environment: 'test-env',
           name: 'endpoint',
@@ -277,7 +287,14 @@ describe('internal-plugin-metrics', () => {
           ],
           webexConferenceIdStr: 'webexConferenceIdStr',
           globalMeetingId: 'globalMeetingId',
-          meeting: {...fakeMeeting, meetingInfo: {...fakeMeeting.meetingInfo, confID: 'webexConferenceIdStr1', meetingId: 'globalMeetingId1'}},
+          meeting: {
+            ...fakeMeeting,
+            meetingInfo: {
+              ...fakeMeeting.meetingInfo,
+              confID: 'webexConferenceIdStr1',
+              meetingId: 'globalMeetingId1',
+            },
+          },
         });
 
         assert.deepEqual(res, {
@@ -302,7 +319,14 @@ describe('internal-plugin-metrics', () => {
           ],
           webexConferenceIdStr: 'webexConferenceIdStr',
           globalMeetingId: 'globalMeetingId',
-          meeting: {...fakeMeeting, meetingInfo: {...fakeMeeting.meetingInfo, confIdStr: 'webexConferenceIdStr1', meetingId: 'globalMeetingId1'}},
+          meeting: {
+            ...fakeMeeting,
+            meetingInfo: {
+              ...fakeMeeting.meetingInfo,
+              confIdStr: 'webexConferenceIdStr1',
+              meetingId: 'globalMeetingId1',
+            },
+          },
         });
 
         assert.deepEqual(res, {
@@ -327,7 +351,15 @@ describe('internal-plugin-metrics', () => {
           ],
           webexConferenceIdStr: 'webexConferenceIdStr',
           globalMeetingId: 'globalMeetingId',
-          meeting: {...fakeMeeting, meetingInfo: {...fakeMeeting.meetingInfo, confIdStr: 'webexConferenceIdStr1', meetingId: 'globalMeetingId1', siteName: 'siteName1'}},
+          meeting: {
+            ...fakeMeeting,
+            meetingInfo: {
+              ...fakeMeeting.meetingInfo,
+              confIdStr: 'webexConferenceIdStr1',
+              meetingId: 'globalMeetingId1',
+              siteName: 'siteName1',
+            },
+          },
         });
 
         assert.deepEqual(res, {
@@ -360,7 +392,7 @@ describe('internal-plugin-metrics', () => {
           orgId: 'orgId',
           userId: 'userId',
         });
-      })
+      });
 
       it('should build identifiers correctly given globalMeetingId', () => {
         const res = cd.getIdentifiers({
@@ -412,13 +444,13 @@ describe('internal-plugin-metrics', () => {
         });
 
         assert.deepEqual(res, {
-          correlationId: "correlationId",
-          locusUrl: "locus-url",
+          correlationId: 'correlationId',
+          locusUrl: 'locus-url',
           deviceId: 'deviceUrl',
           orgId: 'orgId',
           userId: 'preLoginId',
         });
-      })
+      });
     });
 
     it('should prepare diagnostic event successfully', () => {
@@ -429,7 +461,11 @@ describe('internal-plugin-metrics', () => {
       const res = cd.prepareDiagnosticEvent(
         {
           canProceed: false,
-          identifiers: {correlationId: 'id', webexConferenceIdStr: 'webexConferenceIdStr1', globalMeetingId: 'globalMeetingId1'},
+          identifiers: {
+            correlationId: 'id',
+            webexConferenceIdStr: 'webexConferenceIdStr1',
+            globalMeetingId: 'globalMeetingId1',
+          },
           name: 'client.alert.displayed',
         },
         options
@@ -546,40 +582,43 @@ describe('internal-plugin-metrics', () => {
           senderCountryCode: 'UK',
           version: 1,
         });
-        assert.calledWith(validatorSpy, {type: 'ce', event: {
+        assert.calledWith(validatorSpy, {
+          type: 'ce',
           event: {
-            canProceed: true,
-            eventData: {
-              webClientDomain: 'whatever',
+            event: {
+              canProceed: true,
+              eventData: {
+                webClientDomain: 'whatever',
+              },
+              identifiers: {
+                correlationId: 'correlationId',
+                deviceId: 'deviceUrl',
+                locusId: 'url',
+                locusStartTime: 'lastActive',
+                locusUrl: 'locus/url',
+                mediaAgentAlias: 'alias',
+                mediaAgentGroupId: '1',
+                orgId: 'orgId',
+                userId: 'userId',
+              },
+              loginType: 'login-ci',
+              name: 'client.alert.displayed',
+              userType: 'host',
+              isConvergedArchitectureEnabled: undefined,
+              webexSubServiceType: undefined,
             },
-            identifiers: {
-              correlationId: 'correlationId',
-              deviceId: 'deviceUrl',
-              locusId: 'url',
-              locusStartTime: 'lastActive',
-              locusUrl: 'locus/url',
-              mediaAgentAlias: 'alias',
-              mediaAgentGroupId: '1',
-              orgId: 'orgId',
-              userId: 'userId',
+            eventId: 'my-fake-id',
+            origin: {
+              origin: 'fake-origin',
             },
-            loginType: 'login-ci',
-            name: 'client.alert.displayed',
-            userType: 'host',
-            isConvergedArchitectureEnabled: undefined,
-            webexSubServiceType: undefined,
-          },
-          eventId: 'my-fake-id',
-          origin: {
-            origin: 'fake-origin',
-          },
-          originTime: {
-            sent: 'not_defined_yet',
-            triggered: now.toISOString(),
+            originTime: {
+              sent: 'not_defined_yet',
+              triggered: now.toISOString(),
+            },
+            senderCountryCode: 'UK',
+            version: 1,
           },
-          senderCountryCode: 'UK',
-          version: 1,
-        }})
+        });
 
         const webexLoggerLogCalls = webex.logger.log.getCalls();
         assert.deepEqual(webexLoggerLogCalls[0].args, [
@@ -673,7 +712,6 @@ describe('internal-plugin-metrics', () => {
           'CallDiagnosticMetrics: @submitClientEvent. Submit Client Event CA event.',
           `name: client.alert.displayed`,
         ]);
-
       });
 
       it('should submit client event successfully with preLoginId', () => {
@@ -690,7 +728,7 @@ describe('internal-plugin-metrics', () => {
           correlationId: 'correlationId',
           webexConferenceIdStr: 'webexConferenceIdStr1',
           globalMeetingId: 'globalMeetingId1',
-          preLoginId: 'myPreLoginId'
+          preLoginId: 'myPreLoginId',
         };
 
         cd.submitClientEvent({
@@ -747,15 +785,15 @@ describe('internal-plugin-metrics', () => {
             name: 'client.alert.displayed',
           },
           eventId: 'my-fake-id',
-          origin: { buildType: 'test', networkType: 'unknown', origin: 'fake-origin' },
+          origin: {buildType: 'test', networkType: 'unknown', origin: 'fake-origin'},
           originTime: {
             triggered: now.toISOString(),
-            sent: now.toISOString()
+            sent: now.toISOString(),
           },
           senderCountryCode: 'UK',
           version: 1,
         });
-      })
+      });
 
       it('it should include errors if provided with meetingId', () => {
         sinon.stub(cd, 'getOrigin').returns({origin: 'fake-origin'});
@@ -806,6 +844,7 @@ describe('internal-plugin-metrics', () => {
                 shownToUser: false,
                 serviceErrorCode: 2409005,
                 errorCode: 4029,
+                rawErrorMessage: undefined,
               },
             ],
             loginType: 'login-ci',
@@ -831,14 +870,13 @@ describe('internal-plugin-metrics', () => {
           'call-diagnostic-events -> ',
           'CallDiagnosticMetrics: @submitClientEvent. Submit Client Event CA event.',
           `name: client.alert.displayed`,
-
         ]);
 
         assert.deepEqual(webexLoggerLogCalls[1].args, [
           'call-diagnostic-events -> ',
           'CallDiagnosticMetrics: @prepareClientEvent. Generated errors:',
-          `generatedError: {"fatal":true,"shownToUser":false,"name":"other","category":"expected","errorCode":4029,"serviceErrorCode":2409005,"errorDescription":"StartRecordingFailed"}`
-        ])
+          `generatedError: {"fatal":true,"shownToUser":false,"name":"other","category":"expected","errorCode":4029,"serviceErrorCode":2409005,"errorDescription":"StartRecordingFailed"}`,
+        ]);
       });
 
       it('it send the raw error message if meetingId provided', () => {
@@ -848,7 +886,7 @@ describe('internal-plugin-metrics', () => {
         const options = {
           meetingId: fakeMeeting.id,
           mediaConnections: [{mediaAgentAlias: 'alias', mediaAgentGroupId: '1'}],
-          rawError: new Error('bad times')
+          rawError: new Error('bad times'),
         };
 
         cd.submitClientEvent({
@@ -856,14 +894,13 @@ describe('internal-plugin-metrics', () => {
           options,
         });
 
-        console.log(submitToCallDiagnosticsSpy.getCalls()[0].args[0].event.errors)
+        console.log(submitToCallDiagnosticsSpy.getCalls()[0].args[0].event.errors);
 
         assert.calledWith(submitToCallDiagnosticsSpy, {
           event: {
             canProceed: true,
             eventData: {
               webClientDomain: 'whatever',
-              rawErrorMessage: 'bad times',
             },
             identifiers: {
               correlationId: 'correlationId',
@@ -885,6 +922,7 @@ describe('internal-plugin-metrics', () => {
                 errorCode: 9999,
                 serviceErrorCode: 9999,
                 errorDescription: 'UnknownError',
+                rawErrorMessage: 'bad times',
               },
             ],
             loginType: 'login-ci',
@@ -915,11 +953,11 @@ describe('internal-plugin-metrics', () => {
         assert.deepEqual(webexLoggerLogCalls[1].args, [
           'call-diagnostic-events -> ',
           'CallDiagnosticMetrics: @prepareClientEvent. Generated errors:',
-          `generatedError: {"fatal":true,"shownToUser":false,"name":"other","category":"other","errorCode":9999,"serviceErrorCode":9999,"errorDescription":"UnknownError"}`,
+          `generatedError: {"fatal":true,"shownToUser":false,"name":"other","category":"other","errorCode":9999,"serviceErrorCode":9999,"rawErrorMessage":"bad times","errorDescription":"UnknownError"}`,
         ]);
       });
 
-      it('it should include errors if provided with correlationId', () => {
+      it('it should send the raw error message if provided with correlationId', () => {
         sinon.stub(cd, 'getOrigin').returns({origin: 'fake-origin'});
         const submitToCallDiagnosticsSpy = sinon.spy(cd, 'submitToCallDiagnostics');
 
@@ -938,7 +976,6 @@ describe('internal-plugin-metrics', () => {
             canProceed: true,
             eventData: {
               webClientDomain: 'whatever',
-              rawErrorMessage: 'bad times',
             },
             identifiers: {
               correlationId: 'correlationId',
@@ -956,6 +993,7 @@ describe('internal-plugin-metrics', () => {
                 errorCode: 9999,
                 serviceErrorCode: 9999,
                 errorDescription: 'UnknownError',
+                rawErrorMessage: 'bad times',
               },
             ],
             loginType: 'login-ci',
@@ -981,16 +1019,14 @@ describe('internal-plugin-metrics', () => {
           `name: client.alert.displayed`,
         ]);
 
-
         assert.deepEqual(webexLoggerLogCalls[1].args, [
           'call-diagnostic-events -> ',
           'CallDiagnosticMetrics: @prepareClientEvent. Generated errors:',
-          `generatedError: {"fatal":true,"shownToUser":false,"name":"other","category":"other","errorCode":9999,"serviceErrorCode":9999,"errorDescription":"UnknownError"}`,
+          `generatedError: {"fatal":true,"shownToUser":false,"name":"other","category":"other","errorCode":9999,"serviceErrorCode":9999,"rawErrorMessage":"bad times","errorDescription":"UnknownError"}`,
         ]);
-
       });
 
-      it('it should send the raw error message if provided with correlationId', () => {
+      it('it should include errors if provided with correlationId', () => {
         sinon.stub(cd, 'getOrigin').returns({origin: 'fake-origin'});
         const submitToCallDiagnosticsSpy = sinon.spy(cd, 'submitToCallDiagnostics');
 
@@ -1030,6 +1066,7 @@ describe('internal-plugin-metrics', () => {
                 shownToUser: false,
                 serviceErrorCode: 2409005,
                 errorCode: 4029,
+                rawErrorMessage: undefined,
               },
             ],
             loginType: 'login-ci',
@@ -1060,7 +1097,6 @@ describe('internal-plugin-metrics', () => {
           'CallDiagnosticMetrics: @prepareClientEvent. Generated errors:',
           `generatedError: {"fatal":true,"shownToUser":false,"name":"other","category":"expected","errorCode":4029,"serviceErrorCode":2409005,"errorDescription":"StartRecordingFailed"}`,
         ]);
-
       });
 
       it('should include errors in payload if provided via payload', () => {
@@ -1246,37 +1282,40 @@ describe('internal-plugin-metrics', () => {
           options
         );
 
-        assert.calledWith(validatorSpy, {type: 'mqe', event: {
-          eventId: 'my-fake-id',
-          version: 1,
-          origin: {origin: 'fake-origin'},
-          originTime: {triggered: now.toISOString(), sent: 'not_defined_yet'},
-          senderCountryCode: 'UK',
+        assert.calledWith(validatorSpy, {
+          type: 'mqe',
           event: {
-            name: 'client.mediaquality.event',
-            canProceed: true,
-            identifiers: {
-              correlationId: 'correlationId',
-              webexConferenceIdStr: 'webexConferenceIdStr1',
-              globalMeetingId: 'globalMeetingId1',
-              userId: 'userId',
-              deviceId: 'deviceUrl',
-              orgId: 'orgId',
-              locusUrl: 'locus/url',
-              locusId: 'url',
-              locusStartTime: 'lastActive',
-            },
-            eventData: {webClientDomain: 'whatever'},
-            intervals: [{}],
-            sourceMetadata: {
-              applicationSoftwareType: 'webex-js-sdk',
-              applicationSoftwareVersion: 'webex-version',
-              mediaEngineSoftwareType: 'browser',
-              mediaEngineSoftwareVersion: getOSVersion(),
-              startTime: now.toISOString(),
+            eventId: 'my-fake-id',
+            version: 1,
+            origin: {origin: 'fake-origin'},
+            originTime: {triggered: now.toISOString(), sent: 'not_defined_yet'},
+            senderCountryCode: 'UK',
+            event: {
+              name: 'client.mediaquality.event',
+              canProceed: true,
+              identifiers: {
+                correlationId: 'correlationId',
+                webexConferenceIdStr: 'webexConferenceIdStr1',
+                globalMeetingId: 'globalMeetingId1',
+                userId: 'userId',
+                deviceId: 'deviceUrl',
+                orgId: 'orgId',
+                locusUrl: 'locus/url',
+                locusId: 'url',
+                locusStartTime: 'lastActive',
+              },
+              eventData: {webClientDomain: 'whatever'},
+              intervals: [{}],
+              sourceMetadata: {
+                applicationSoftwareType: 'webex-js-sdk',
+                applicationSoftwareVersion: 'webex-version',
+                mediaEngineSoftwareType: 'browser',
+                mediaEngineSoftwareVersion: getOSVersion(),
+                startTime: now.toISOString(),
+              },
             },
           },
-        }});
+        });
 
         assert.calledWith(submitToCallDiagnosticsSpy, {
           eventId: 'my-fake-id',
@@ -1359,6 +1398,25 @@ describe('internal-plugin-metrics', () => {
           shownToUser: false,
           errorCode: 4008,
           serviceErrorCode: 10000,
+          rawErrorMessage: undefined,
+        });
+      });
+
+      it('should include rawErrorMessage if provided', () => {
+        const res = cd.getErrorPayloadForClientErrorCode({
+          clientErrorCode: 4008,
+          serviceErrorCode: 10000,
+          rawErrorMessage: 'bad times',
+        });
+        assert.deepEqual(res, {
+          category: 'signaling',
+          errorDescription: 'NewLocusError',
+          fatal: true,
+          name: 'other',
+          shownToUser: false,
+          errorCode: 4008,
+          serviceErrorCode: 10000,
+          rawErrorMessage: 'bad times',
         });
       });
 
@@ -1375,8 +1433,9 @@ describe('internal-plugin-metrics', () => {
           shownToUser: false,
           errorCode: 4009,
           serviceErrorCode: undefined,
+          rawErrorMessage: undefined,
         });
-      })
+      });
 
       it('it should return undefined if trying to get payload for client error code that doesnt exist', () => {
         const res = cd.getErrorPayloadForClientErrorCode({
@@ -1396,6 +1455,7 @@ describe('internal-plugin-metrics', () => {
         shownToUser: false,
         errorCode: 4029,
         serviceErrorCode: 2409005,
+        rawErrorMessage: 'bad times',
       };
 
       const checkNameError = (payload: any, isExpectedToBeCalled: boolean) => {
@@ -1409,6 +1469,7 @@ describe('internal-plugin-metrics', () => {
           serviceErrorCode: undefined,
           errorCode: 4032,
           errorData: {errorName: payload.name},
+          rawErrorMessage: payload.message,
         };
 
         if (isExpectedToBeCalled) {
@@ -1419,11 +1480,11 @@ describe('internal-plugin-metrics', () => {
       };
 
       it('should generate media event error payload if rawError has a media error name', () => {
-        checkNameError({name: 'PermissionDeniedError'}, true);
+        checkNameError({name: 'PermissionDeniedError', message: 'bad times'}, true);
       });
 
       it('should not generate media event error payload if rawError has a name that is not recognized', () => {
-        checkNameError({name: 'SomeRandomError'}, false);
+        checkNameError({name: 'SomeRandomError', message: 'bad times'}, false);
       });
 
       const checkCodeError = (payload: any, expetedRes: any) => {
@@ -1431,19 +1492,25 @@ describe('internal-plugin-metrics', () => {
         assert.deepEqual(res, expetedRes);
       };
       it('should generate event error payload correctly', () => {
-        checkCodeError({body: {errorCode: 2409005}}, defaultExpectedRes);
+        checkCodeError({body: {errorCode: 2409005}, message: 'bad times'}, defaultExpectedRes);
       });
 
       it('should generate event error payload correctly if rawError has body.code', () => {
-        checkCodeError({body: {code: 2409005}}, defaultExpectedRes);
+        checkCodeError({body: {code: 2409005}, message: 'bad times'}, defaultExpectedRes);
       });
 
       it('should generate event error payload correctly if rawError has body.reason.reasonCode', () => {
-        checkCodeError({body: {reason: {reasonCode: 2409005}}}, defaultExpectedRes);
+        checkCodeError(
+          {body: {reason: {reasonCode: 2409005}}, message: 'bad times'},
+          defaultExpectedRes
+        );
       });
 
       it('should generate event error payload correctly if rawError has error.body.errorCode', () => {
-        checkCodeError({error: {body: {errorCode: 2409005}}}, defaultExpectedRes);
+        checkCodeError(
+          {error: {body: {errorCode: 2409005}}, message: 'bad times'},
+          defaultExpectedRes
+        );
       });
 
       const checkLocusError = (payload: any, isExpectedToBeCalled: boolean) => {
@@ -1456,6 +1523,7 @@ describe('internal-plugin-metrics', () => {
           shownToUser: false,
           serviceErrorCode: 2400000,
           errorCode: 4008,
+          rawErrorMessage: 'bad times',
         };
 
         if (isExpectedToBeCalled) {
@@ -1466,11 +1534,11 @@ describe('internal-plugin-metrics', () => {
       };
 
       it('should return default new locus event error payload correctly if locus error is recognized', () => {
-        checkLocusError({body: {errorCode: 2400000}}, true);
+        checkLocusError({body: {errorCode: 2400000}, message: 'bad times'}, true);
       });
 
       it('should not return default new locus event error payload correctly if locus is not recognized', () => {
-        checkLocusError({body: {errorCode: 1400000}}, false);
+        checkLocusError({body: {errorCode: 1400000}, message: 'bad times'}, false);
       });
 
       const checkMeetingInfoError = (payload: any, isExpectedToBeCalled: boolean) => {
@@ -1483,6 +1551,7 @@ describe('internal-plugin-metrics', () => {
           shownToUser: false,
           serviceErrorCode: undefined,
           errorCode: 4100,
+          rawErrorMessage: 'bad times',
         };
 
         if (isExpectedToBeCalled) {
@@ -1493,15 +1562,24 @@ describe('internal-plugin-metrics', () => {
       };
 
       it('should return default meeting info lookup error payload if data.meetingInfo was found on error body', () => {
-        checkMeetingInfoError({body: {data: {meetingInfo: 'something'}}}, true);
+        checkMeetingInfoError(
+          {body: {data: {meetingInfo: 'something'}}, message: 'bad times'},
+          true
+        );
       });
 
       it('should return default meeting info lookup error payload if body.url contains wbxappapi', () => {
-        checkMeetingInfoError({body: {url: '1234567-wbxappapiabcdefg'}}, true);
+        checkMeetingInfoError(
+          {body: {url: '1234567-wbxappapiabcdefg'}, message: 'bad times'},
+          true
+        );
       });
 
       it('should not return default meeting info lookup error payload if body.url does not contain wbxappapi and data.meetingInfo was not found on error body', () => {
-        checkMeetingInfoError({body: {data: '1234567-wbxappapiabcdefg'}}, false);
+        checkMeetingInfoError(
+          {body: {data: '1234567-wbxappapiabcdefg'}, message: 'bad times'},
+          false
+        );
       });
 
       it('should return NetworkError code for a NetworkOrCORSERror', () => {
@@ -1515,12 +1593,13 @@ describe('internal-plugin-metrics', () => {
         );
         assert.deepEqual(res, {
           category: 'network',
-          errorDescription: '{}\nundefined https://example.com\nWEBEX_TRACKING_ID: undefined\n',
+          errorDescription: 'NetworkError',
           fatal: true,
           name: 'other',
           shownToUser: false,
           serviceErrorCode: undefined,
           errorCode: 1026,
+          rawErrorMessage: '{}\nundefined https://example.com\nWEBEX_TRACKING_ID: undefined\n',
         });
       });
 
@@ -1534,20 +1613,19 @@ describe('internal-plugin-metrics', () => {
 
         error.payloadOverrides = {
           shownToUser: true,
-          category: 'expected'
+          category: 'expected',
         };
 
-        const res = cd.generateClientEventErrorPayload(
-          error
-        );
+        const res = cd.generateClientEventErrorPayload(error);
         assert.deepEqual(res, {
           category: 'expected',
-          errorDescription: '{}\nundefined https://example.com\nWEBEX_TRACKING_ID: undefined\n',
+          errorDescription: 'NetworkError',
           fatal: true,
           name: 'other',
           shownToUser: true,
           serviceErrorCode: undefined,
           errorCode: 1026,
+          rawErrorMessage: '{}\nundefined https://example.com\nWEBEX_TRACKING_ID: undefined\n',
         });
       });
 
@@ -1562,12 +1640,13 @@ describe('internal-plugin-metrics', () => {
         );
         assert.deepEqual(res, {
           category: 'network',
-          errorDescription: '{}\nundefined https://example.com\nWEBEX_TRACKING_ID: undefined\n',
+          errorDescription: 'AuthenticationFailed',
           fatal: true,
           name: 'other',
           shownToUser: false,
           serviceErrorCode: undefined,
           errorCode: 1010,
+          rawErrorMessage: '{}\nundefined https://example.com\nWEBEX_TRACKING_ID: undefined\n',
         });
       });
 
@@ -1581,25 +1660,24 @@ describe('internal-plugin-metrics', () => {
 
         error.payloadOverrides = {
           shownToUser: true,
-          category: 'expected'
+          category: 'expected',
         };
 
-        const res = cd.generateClientEventErrorPayload(
-          error
-        );
+        const res = cd.generateClientEventErrorPayload(error);
         assert.deepEqual(res, {
           category: 'expected',
-          errorDescription: '{}\nundefined https://example.com\nWEBEX_TRACKING_ID: undefined\n',
+          errorDescription: 'AuthenticationFailed',
           fatal: true,
           name: 'other',
           shownToUser: true,
           serviceErrorCode: undefined,
           errorCode: 1010,
+          rawErrorMessage: '{}\nundefined https://example.com\nWEBEX_TRACKING_ID: undefined\n',
         });
       });
 
       it('should return unknown error otherwise', () => {
-        const res = cd.generateClientEventErrorPayload({somethgin: 'new'});
+        const res = cd.generateClientEventErrorPayload({somethgin: 'new', message: 'bad times'});
         assert.deepEqual(res, {
           category: 'other',
           errorDescription: 'UnknownError',
@@ -1608,11 +1686,15 @@ describe('internal-plugin-metrics', () => {
           shownToUser: false,
           serviceErrorCode: 9999,
           errorCode: 9999,
+          rawErrorMessage: 'bad times',
         });
       });
 
       it('should generate event error payload correctly for locus error 2423012', () => {
-        const res = cd.generateClientEventErrorPayload({body: {errorCode: 2423012}});
+        const res = cd.generateClientEventErrorPayload({
+          body: {errorCode: 2423012},
+          message: 'bad times',
+        });
         assert.deepEqual(res, {
           category: 'expected',
           errorDescription: 'FraudDetection',
@@ -1621,10 +1703,14 @@ describe('internal-plugin-metrics', () => {
           shownToUser: true,
           serviceErrorCode: 2423012,
           errorCode: 12000,
+          rawErrorMessage: 'bad times',
         });
       });
       it('should generate event error payload correctly for locus error 2409062', () => {
-        const res = cd.generateClientEventErrorPayload({body: {errorCode: 2409062}});
+        const res = cd.generateClientEventErrorPayload({
+          body: {errorCode: 2409062},
+          message: 'bad times',
+        });
         assert.deepEqual(res, {
           category: 'expected',
           errorDescription: 'E2EENotSupported',
@@ -1633,12 +1719,15 @@ describe('internal-plugin-metrics', () => {
           shownToUser: true,
           serviceErrorCode: 2409062,
           errorCode: 12002,
+          rawErrorMessage: 'bad times',
         });
       });
 
-
       it('should generate event error payload correctly for locus error 2423021', () => {
-        const res = cd.generateClientEventErrorPayload({body: {errorCode: 2423021}});
+        const res = cd.generateClientEventErrorPayload({
+          body: {errorCode: 2423021},
+          message: 'bad times',
+        });
         assert.deepEqual(res, {
           category: 'expected',
           errorDescription: 'LocusLobbyFullCMR',
@@ -1647,6 +1736,7 @@ describe('internal-plugin-metrics', () => {
           shownToUser: true,
           serviceErrorCode: 2423021,
           errorCode: 12001,
+          rawErrorMessage: 'bad times',
         });
       });
     });
@@ -1664,37 +1754,36 @@ describe('internal-plugin-metrics', () => {
 
     describe('#getSubServiceType', () => {
       it('returns subServicetype as PMR when PMR meeting', () => {
-       fakeMeeting.meetingInfo ={
+        fakeMeeting.meetingInfo = {
           webexScheduled: false,
           pmr: true,
           enableEvent: false,
-        }
+        };
         assert.deepEqual(cd.getSubServiceType(fakeMeeting), 'PMR');
       });
 
       it('returns subServicetype as ScheduledMeeting when regular meeting', () => {
-        fakeMeeting.meetingInfo ={
-           webexScheduled: true,
-           pmr: false,
-           enableEvent: false,
-         }
-         assert.deepEqual(cd.getSubServiceType(fakeMeeting), 'ScheduledMeeting');
-       });
-
-       it('returns subServicetype as Webinar when meeting is Webinar', () => {
-        fakeMeeting.meetingInfo ={
-           webexScheduled: true,
-           pmr: false,
-           enableEvent: true,
-         }
-         assert.deepEqual(cd.getSubServiceType(fakeMeeting), 'Webinar');
-       });
-
-       it('returns subServicetype as undefined when correct parameters are not found', () => {
-        fakeMeeting.meetingInfo ={}
-         assert.deepEqual(cd.getSubServiceType(fakeMeeting), undefined);
-       });
+        fakeMeeting.meetingInfo = {
+          webexScheduled: true,
+          pmr: false,
+          enableEvent: false,
+        };
+        assert.deepEqual(cd.getSubServiceType(fakeMeeting), 'ScheduledMeeting');
+      });
+
+      it('returns subServicetype as Webinar when meeting is Webinar', () => {
+        fakeMeeting.meetingInfo = {
+          webexScheduled: true,
+          pmr: false,
+          enableEvent: true,
+        };
+        assert.deepEqual(cd.getSubServiceType(fakeMeeting), 'Webinar');
+      });
 
+      it('returns subServicetype as undefined when correct parameters are not found', () => {
+        fakeMeeting.meetingInfo = {};
+        assert.deepEqual(cd.getSubServiceType(fakeMeeting), undefined);
+      });
     });
 
     describe('#getIsConvergedArchitectureEnabled', () => {
@@ -1720,69 +1809,69 @@ describe('internal-plugin-metrics', () => {
         it('returns expected options without preLoginId', async () => {
           const options = {
             meetingId: fakeMeeting.id,
-            preLoginId
+            preLoginId,
           };
 
           const triggered = new Date();
           const fetchOptions = await cd.buildClientEventFetchRequestOptions({
             name: 'client.exit.app',
-            payload: { trigger: 'user-interaction', canProceed: false },
+            payload: {trigger: 'user-interaction', canProceed: false},
             options,
           });
 
           assert.deepEqual(fetchOptions.body, {
-              metrics: [
-                {
-                  eventPayload: {
-                    event: {
-                      canProceed: false,
-                      eventData: {
-                        webClientDomain: 'whatever',
-                      },
-                      identifiers: {
-                        correlationId: 'correlationId',
-                        deviceId: 'deviceUrl',
-                        locusId: 'url',
-                        locusStartTime: 'lastActive',
-                        locusUrl: 'locus/url',
-                        orgId: 'orgId',
-                        userId: 'userId',
-                      },
-                      loginType: 'login-ci',
-                      name: 'client.exit.app',
-                      trigger: 'user-interaction',
-                      userType: 'host',
-                      isConvergedArchitectureEnabled: undefined,
-                      webexSubServiceType: undefined,
+            metrics: [
+              {
+                eventPayload: {
+                  event: {
+                    canProceed: false,
+                    eventData: {
+                      webClientDomain: 'whatever',
                     },
-                    eventId: 'my-fake-id',
-                    origin: {
-                      buildType: 'test',
-                      clientInfo: {
-                        clientType: 'TEAMS_CLIENT',
-                        clientVersion: 'webex-js-sdk/webex-version',
-                        localNetworkPrefix:
-                          Utils.anonymizeIPAddress(webex.meetings.geoHintInfo?.clientAddress) ||
-                          undefined,
-                        os: getOSNameInternal() || 'unknown',
-                        osVersion: getOSVersion(),
-                        subClientType: 'WEB_APP',
-                      },
-                      environment: 'meeting_evn',
-                      name: 'endpoint',
-                      networkType: 'unknown',
-                      userAgent,
+                    identifiers: {
+                      correlationId: 'correlationId',
+                      deviceId: 'deviceUrl',
+                      locusId: 'url',
+                      locusStartTime: 'lastActive',
+                      locusUrl: 'locus/url',
+                      orgId: 'orgId',
+                      userId: 'userId',
                     },
-                    originTime: {
-                      sent: 'not_defined_yet',
-                      triggered: triggered.toISOString(),
+                    loginType: 'login-ci',
+                    name: 'client.exit.app',
+                    trigger: 'user-interaction',
+                    userType: 'host',
+                    isConvergedArchitectureEnabled: undefined,
+                    webexSubServiceType: undefined,
+                  },
+                  eventId: 'my-fake-id',
+                  origin: {
+                    buildType: 'test',
+                    clientInfo: {
+                      clientType: 'TEAMS_CLIENT',
+                      clientVersion: 'webex-js-sdk/webex-version',
+                      localNetworkPrefix:
+                        Utils.anonymizeIPAddress(webex.meetings.geoHintInfo?.clientAddress) ||
+                        undefined,
+                      os: getOSNameInternal() || 'unknown',
+                      osVersion: getOSVersion(),
+                      subClientType: 'WEB_APP',
                     },
-                    senderCountryCode: webex.meetings.geoHintInfo?.countryCode,
-                    version: 1,
+                    environment: 'meeting_evn',
+                    name: 'endpoint',
+                    networkType: 'unknown',
+                    userAgent,
                   },
-                  type: ['diagnostic-event'],
+                  originTime: {
+                    sent: 'not_defined_yet',
+                    triggered: triggered.toISOString(),
+                  },
+                  senderCountryCode: webex.meetings.geoHintInfo?.countryCode,
+                  version: 1,
                 },
-              ],
+                type: ['diagnostic-event'],
+              },
+            ],
           });
 
           const rest = omit(fetchOptions, 'body');
@@ -1797,8 +1886,8 @@ describe('internal-plugin-metrics', () => {
               headers: {
                 authorization: false,
                 'x-prelogin-userid': preLoginId,
-              }
-            })
+              },
+            });
           } else {
             assert.deepEqual(rest, {
               foo: 'bar',
@@ -1807,7 +1896,7 @@ describe('internal-plugin-metrics', () => {
               service: 'metrics',
               headers: {},
               waitForServiceTimeout: CONFIG.metrics.waitForServiceTimeout,
-            })
+            });
           }
 
           const webexLoggerLogCalls = webex.logger.log.getCalls();