feat: error reporting plugin

packages/analytics-js-common/src/constants/metrics.ts

@@ -1,3 +1,3 @@
-const METRIC_PAYLOAD_VERSION = '1';
+const METRICS_PAYLOAD_VERSION = '1';
 
-export { METRIC_PAYLOAD_VERSION };
+export { METRICS_PAYLOAD_VERSION };

packages/analytics-js-common/src/types/ApplicationState.ts

@@ -114,22 +114,22 @@ export type PluginsState = {
   totalPluginsToLoad: Signal<number>;
 };
 
-export type BreadCrumbMetaData = {
+export type BreadcrumbMetaData = {
   [index: string]: any;
 };
 export type BreadcrumbType = 'error' | 'manual';
-export type BreadCrumb = {
+export type Breadcrumb = {
   type: BreadcrumbType;
   name: string;
   timestamp: Date;
-  metaData: BreadCrumbMetaData;
+  metaData: BreadcrumbMetaData;
 };
 
 export type ReportingState = {
   isErrorReportingEnabled: Signal<boolean>;
   isMetricsReportingEnabled: Signal<boolean>;
   isErrorReportingPluginLoaded: Signal<boolean>;
-  breadCrumbs: Signal<BreadCrumb[]>;
+  breadcrumbs: Signal<Breadcrumb[]>;
 };
 
 export type SessionState = {

packages/analytics-js-common/src/types/ErrorHandler.ts

@@ -37,3 +37,9 @@
   error: SDKError;
   errorState: ErrorState;
 };
+
+export enum ErrorType {
+  HANDLEDEXCEPTION = 'handledException',
+  UNHANDLEDEXCEPTION = 'unhandledException',
+  UNHANDLEDREJECTION = 'unhandledPromiseRejection',
+}

packages/analytics-js-common/src/types/Metrics.ts

@@ -1,4 +1,4 @@
-import type { BreadCrumb } from './ApplicationState';
+import type { Breadcrumb } from './ApplicationState';
 
 export type MetricServicePayload = {
   version: string;
@@ -40,7 +40,7 @@ export type ErrorEventType = {
     url: string;
     clientIp: string;
   };
-  breadcrumbs: BreadCrumb[] | [];
+  breadcrumbs: Breadcrumb[] | [];
   context: string;
   metaData: {
     [index: string]: any;

packages/analytics-js-plugins/.size-limit.js

@@ -11,6 +11,6 @@ module.exports = [
   {
     name: 'Remote Module Federated Plugins - CDN',
     path: 'dist/cdn/modern/plugins/rsa-plugins-*.js',
-    limit: '8.5 KiB',
+    limit: '7.5 KiB',
   },
 ];

packages/analytics-js-plugins/__tests__/errorReporting/index.test.ts

@@ -13,7 +13,7 @@ describe('Plugin - ErrorReporting', () => {
     },
     reporting: {
       isErrorReportingPluginLoaded: signal(false),
-      breadCrumbs: signal([]),
+      breadcrumbs: signal([]),
     },
     context: {
       locale: signal('en-GB'),
@@ -36,7 +36,7 @@ describe('Plugin - ErrorReporting', () => {
     ErrorReporting().initialize(state);
     expect(state.plugins.loadedPlugins.value.includes('ErrorReporting')).toBe(true);
     expect(state.reporting.isErrorReportingPluginLoaded.value).toBe(true);
-    expect(state.reporting.breadCrumbs.value[0].name).toBe('Error Reporting Plugin Loaded');
+    expect(state.reporting.breadcrumbs.value[0].name).toBe('Error Reporting Plugin Loaded');
   });
 
   it('should invoke the error reporting provider plugin on notify', () => {
@@ -66,9 +66,9 @@ describe('Plugin - ErrorReporting', () => {
   });
 
   it('should add a new breadcrumb', () => {
-    const breadcrumbLength = state.reporting.breadCrumbs.value.length;
+    const breadcrumbLength = state.reporting.breadcrumbs.value.length;
     ErrorReporting().errorReporting.breadcrumb('dummy breadcrumb', state);
 
-    expect(state.reporting.breadCrumbs.value.length).toBe(breadcrumbLength + 1);
+    expect(state.reporting.breadcrumbs.value.length).toBe(breadcrumbLength + 1);
   });
 });

packages/analytics-js-plugins/__tests__/errorReporting/utils.test.ts

@@ -7,9 +7,9 @@ import {
   isRudderSDKError,
   getAppStateForMetadata,
   getErrorContext,
-  createNewBreadCrumb,
-  getURLWithoutSearchParam,
-  enhanceErrorEvent,
+  createNewBreadcrumb,
+  getURLWithoutQueryString,
+  getBugsnagErrorEvent,
   getErrorDeliveryPayload,
 } from '../../src/errorReporting/utils';
 
@@ -18,10 +18,10 @@ jest.mock('@rudderstack/analytics-js-common/utilities/uuId', () => ({
 }));
 
 describe('Error Reporting utilities', () => {
-  describe('createNewBreadCrumb', () => {
+  describe('createNewBreadcrumb', () => {
     it('should create and return a breadcrumb ', () => {
       const msg = 'sample message';
-      const breadcrumb = createNewBreadCrumb(msg);
+      const breadcrumb = createNewBreadcrumb(msg);
 
       expect(breadcrumb).toStrictEqual({
         metaData: {},
@@ -32,10 +32,10 @@ describe('Error Reporting utilities', () => {
     });
   });
 
-  describe('getURLWithoutSearchParam', () => {
+  describe('getURLWithoutQueryString', () => {
     it('should return url without query param ', () => {
       (window as any).location.href = 'http://www.test-host.com?key1=1234&key2=true';
-      const urlWithoutSearchParam = getURLWithoutSearchParam();
+      const urlWithoutSearchParam = getURLWithoutQueryString();
       expect(urlWithoutSearchParam).toEqual('http://www.test-host.com/');
     });
   });
@@ -283,7 +283,7 @@ describe('Error Reporting utilities', () => {
     });
   });
 
-  describe('enhanceErrorEvent', () => {
+  describe('getBugsnagErrorEvent', () => {
     it('should return enhanced error event payload', () => {
       const newError = new Error();
       const normalizedError = Object.create(newError, {
@@ -309,12 +309,12 @@ describe('Error Reporting utilities', () => {
           writeKey: signal('sample-write-key'),
         },
         reporting: {
-          breadCrumbs: signal([]),
+          breadcrumbs: signal([]),
         },
         source: signal({ id: 'sample_source_id' }),
       };
       (window as any).RudderSnippetVersion = 'sample_snippet_version';
-      const enhancedError = enhanceErrorEvent(errorPayload, errorState, appState);
+      const enhancedError = getBugsnagErrorEvent(errorPayload, errorState, appState);
       console.log(JSON.stringify(enhancedError));
       const expectedOutcome = {
         notifier: {
@@ -363,11 +363,11 @@ describe('Error Reporting utilities', () => {
             breadcrumbs: [],
             context: 'ReferenceError: testUndefinedFn is not defined',
             metaData: {
-              SDK: {
+              sdk: {
                 name: 'JS',
                 installType: '__MODULE_TYPE__',
               },
-              STATE: {
+              state: {
                 context: {
                   userAgent: 'sample user agent',
                   locale: 'en-GB',
@@ -379,13 +379,13 @@ describe('Error Reporting utilities', () => {
                   writeKey: 'sample-write-key',
                 },
                 reporting: {
-                  breadCrumbs: [],
+                  breadcrumbs: [],
                 },
                 source: {
                   id: 'sample_source_id',
                 },
               },
-              SOURCE: {
+              source: {
                 id: 'sample_source_id',
                 snippetVersion: 'sample_snippet_version',
               },
@@ -457,11 +457,11 @@ describe('Error Reporting utilities', () => {
             breadcrumbs: [],
             context: 'ReferenceError: testUndefinedFn is not defined',
             metaData: {
-              SDK: {
+              sdk: {
                 name: 'JS',
                 installType: '__MODULE_TYPE__',
               },
-              STATE: {
+              state: {
                 context: {
                   userAgent: 'sample user agent',
                   locale: 'en-GB',
@@ -470,7 +470,7 @@ describe('Error Reporting utilities', () => {
                 lifecycle: {
                   writeKey: 'sample-write-key',
                 },
-                breadCrumbs: [],
+                breadcrumbs: [],
               },
             },
             user: {

packages/analytics-js-plugins/src/errorReporting/event/event.ts

@@ -3,7 +3,7 @@
 import ErrorStackParser from 'error-stack-parser';
 import type { Exception, Stackframe } from '@rudderstack/analytics-js-common/types/Metrics';
 import type { FrameType, IErrorFormat } from '../types';
-import { hasStack, isError } from '../utils';
+import { hasStack, isError } from './utils';
 
 const normaliseFunctionName = (name: string) =>
   /^global code$/i.test(name) ? 'global code' : name;
@@ -24,7 +24,7 @@
   // - non-error exception thrown from global code in FF
   // This adds one.
   if (f.lineNumber > -1 && !f.file && !f.method) {
     f.file = 'global code';
   }
   return f;
 };
@@ -47,7 +47,7 @@
         if (JSON.stringify(f) === '{}') return accum;
         return accum.concat(f);
       } catch (e) {
         return accum;
       }
     }, []),
   };
@@ -57,7 +57,7 @@
 
 const getStacktrace = (error: any, errorFramesToSkip: number) => {
   if (hasStack(error)) return ErrorStackParser.parse(error).slice(errorFramesToSkip);
   return [];
 };
 
 const hasNecessaryFields = (error: any) =>
@@ -76,11 +76,11 @@
   const createAndLogInputError = (reason: string) => {
     const verb = component === 'error cause' ? 'was' : 'received';
     if (logger) logger.warn(`${component} ${verb} a non-error: "${reason}"`);
     const err = new Error(
       `${component} ${verb} a non-error. See "${component}" tab for more detail.`,
     );
     err.name = 'InvalidError';
     return err;
   };
 
   // In some cases:
@@ -93,52 +93,52 @@
   // such.
   if (!tolerateNonErrors) {
     if (isError(maybeError)) {
       error = maybeError;
     } else {
       error = createAndLogInputError(typeof maybeError);
       internalFrames += 2;
     }
   } else {
     switch (typeof maybeError) {
       case 'string':
       case 'number':
       case 'boolean':
         error = new Error(String(maybeError));
         internalFrames += 1;
         break;
       case 'function':
         error = createAndLogInputError('function');
         internalFrames += 2;
         break;
       case 'object':
         if (maybeError !== null && isError(maybeError)) {
           error = maybeError;
         } else if (maybeError !== null && hasNecessaryFields(maybeError)) {
           error = new Error(maybeError.message || maybeError.errorMessage);
           error.name = maybeError.name || maybeError.errorClass;
           internalFrames += 1;
         } else {
           error = createAndLogInputError(maybeError === null ? 'null' : 'unsupported object');
           internalFrames += 2;
         }
         break;
       default:
         error = createAndLogInputError('nothing');
         internalFrames += 2;
     }
   }
 
   if (!hasStack(error)) {
     // in IE10/11 a new Error() doesn't have a stacktrace until you throw it, so try that here
     try {
       throw error;
     } catch (e) {
       if (hasStack(e)) {
         error = e;
         // if the error only got a stacktrace after we threw it here, we know it
         // will only have one extra internal frame from this function, regardless
         // of whether it went through createAndLogInputError() or not
         internalFrames = 1;
       }
     }
   }
@@ -178,7 +178,7 @@
       );
       event = new ErrorFormat(error.name, error.message, stacktrace);
     } catch (e) {
       event = new ErrorFormat(error.name, error.message, []);
     }
 
     return event;

packages/analytics-js-plugins/src/errorReporting/event/utils.ts

@@ -0,0 +1,18 @@
+const hasStack = (err: any) =>
+  !!err &&
+  (!!err.stack || !!err.stacktrace || !!err['opera#sourceloc']) &&
+  typeof (err.stack || err.stacktrace || err['opera#sourceloc']) === 'string' &&
+  err.stack !== `${err.name}: ${err.message}`;
+
+const isError = (value: any) => {
+  switch (Object.prototype.toString.call(value)) {
+    case '[object Error]':
+    case '[object Exception]':
+    case '[object DOMException]':
+      return true;
+    default:
+      return value instanceof Error;
+  }
+};
+
+export { hasStack, isError };

packages/analytics-js-plugins/src/errorReporting/index.ts

@@ -2,18 +2,18 @@
 /* eslint-disable no-param-reassign */
 import type {
   ApplicationState,
-  BreadCrumbMetaData,
+  BreadcrumbMetaData,
 } from '@rudderstack/analytics-js-common/types/ApplicationState';
 import type { ExtensionPlugin } from '@rudderstack/analytics-js-common/types/PluginEngine';
 import type { ILogger } from '@rudderstack/analytics-js-common/types/Logger';
 import type { PluginName } from '@rudderstack/analytics-js-common/types/PluginsManager';
 import type { ErrorState, SDKError } from '@rudderstack/analytics-js-common/types/ErrorHandler';
 import type { IHttpClient } from '@rudderstack/analytics-js-common/types/HttpClient';
 import {
-  createNewBreadCrumb,
+  createNewBreadcrumb,
   getConfigForPayloadCreation,
   isRudderSDKError,
-  enhanceErrorEvent,
+  getBugsnagErrorEvent,
   getErrorDeliveryPayload,
 } from './utils';
 import { REQUEST_TIMEOUT_MS } from './constants';
@@ -27,7 +27,7 @@
   initialize: (state: ApplicationState) => {
     state.plugins.loadedPlugins.value = [...state.plugins.loadedPlugins.value, pluginName];
     state.reporting.isErrorReportingPluginLoaded.value = true;
-    state.reporting.breadCrumbs.value = [createNewBreadCrumb('Error Reporting Plugin Loaded')];
+    state.reporting.breadcrumbs.value = [createNewBreadcrumb('Error Reporting Plugin Loaded')];
   },
   errorReporting: {
     notify: (
@@ -42,7 +42,7 @@
 
       // filter errors
       if (!isRudderSDKError(normalizedError)) {
         return;
       }
 
       // Generate the error payload
@@ -56,15 +56,15 @@
       );
 
       // enrich error payload
-      const enhancedError = enhanceErrorEvent(errorPayload, errorState, state);
+      const bugsnagPayload = getBugsnagErrorEvent(errorPayload, errorState, state);
 
       // send it to metrics service
       httpClient.getAsyncData({
         url: `https://sdk-metrics.rudderstack.com/sdkmetrics`,
         // url: `${state.lifecycle.dataPlaneUrl.value}/sdk-metrics`,
         options: {
           method: 'POST',
-          data: getErrorDeliveryPayload(enhancedError, state),
+          data: getErrorDeliveryPayload(bugsnagPayload, state),
           sendRawData: true,
         },
         isRawResponse: true,
@@ -74,13 +74,13 @@
         },
       });
     },
-    breadcrumb: (message: string, state: ApplicationState, metaData?: BreadCrumbMetaData): void => {
+    breadcrumb: (message: string, state: ApplicationState, metaData?: BreadcrumbMetaData): void => {
       if (!message) {
         return;
       }
-      state.reporting.breadCrumbs.value = [
-        ...state.reporting.breadCrumbs.value,
-        createNewBreadCrumb(message, metaData),
+      state.reporting.breadcrumbs.value = [
+        ...state.reporting.breadcrumbs.value,
+        createNewBreadcrumb(message, metaData),
       ];
     },
   },