Crash reporting metrics implementation with Bugsnag

analytics.js

@@ -19,6 +19,7 @@ import {
   getJSONTrimmed,
   generateUUID,
   handleError,
+  leaveBreadcrumb,
   getDefaultPageProperties,
   getUserProvidedConfigUrl,
   findAllEnabledDestinations,
@@ -28,12 +29,15 @@ import {
   getReferrer,
   getReferringDomain,
   commonNames,
+  get,
 } from "./utils/utils";
 import {
   CONFIG_URL,
   MAX_WAIT_FOR_INTEGRATION_LOAD,
   INTEGRATION_LOAD_CHECK_INTERVAL,
   POLYFILL_URL,
+  DEFAULT_ERROR_REPORT_PROVIDER,
+  ERROR_REPORT_PROVIDERS,
 } from "./utils/constants";
 import { integrations } from "./integrations";
 import RudderElementBuilder from "./utils/RudderElementBuilder";
@@ -44,6 +48,7 @@ import { addDomEventHandlers } from "./utils/autotrack.js";
 import ScriptLoader from "./integrations/ScriptLoader";
 import parseLinker from "./utils/linker";
 import CookieConsentFactory from "./cookieConsent/CookieConsentFactory";
+import * as BugsnagLib from "./metrics/error-report/Bugsnag";
 
 const queryDefaults = {
   trait: "ajs_trait_",
@@ -167,6 +172,31 @@ class Analytics {
       if (typeof response === "string") {
         response = JSON.parse(response);
       }
+
+      // Fetch Error reporting enable option from sourceConfig
+      const isErrorReportEnabled = get(
+        response.source.config,
+        "statsCollection.errorReports.enabled"
+      );
+
+      // Load Bugsnag only if it is enabled in the source config
+      if (isErrorReportEnabled === true) {
+        // Fetch the name of the Error reporter from sourceConfig
+        const provider = get(
+          response.source.config,
+          "statsCollection.errorReports.provider"
+        ) || DEFAULT_ERROR_REPORT_PROVIDER;
+        if (!ERROR_REPORT_PROVIDERS.includes(provider)) {
+          logger.error("Invalid error reporting provider value");
+        }
+
+        if (provider === "bugsnag") {
+          // Load Bugsnag client SDK
+          BugsnagLib.load();
+          BugsnagLib.init(response.source.id);
+        }
+      }
+
       if (
         response.source.useAutoTracking &&
         !this.autoTrackHandlersRegistered
@@ -194,15 +224,15 @@ class Analytics {
         this.clientIntegrations
       );
 
-      var cookieConsent;
+      let cookieConsent;
       // Call the cookie consent factory to initialize and return the type of cookie
       // consent being set. For now we only support OneTrust.
       try {
         cookieConsent = CookieConsentFactory.initialize(
           this.cookieConsentOptions
         );
       } catch (e) {
-        logger.error(e);
+        handleError(e);
       }
 
       // If cookie consent object is return we filter according to consents given by user
@@ -214,7 +244,7 @@ class Analytics {
             (cookieConsent && cookieConsent.isEnabled(intg.config)))
         );
       });
-
+      leaveBreadcrumb("Starting device-mode initialization");
       this.init(this.clientIntegrations);
     } catch (error) {
       handleError(error);
@@ -254,21 +284,17 @@ class Analytics {
     let intgInstance;
     intgArray.forEach((intg) => {
       try {
-        logger.debug(
-          "[Analytics] init :: trying to initialize integration name:: ",
-          intg.name
-        );
+        const msg = `[Analytics] init :: trying to initialize integration name:: ${intg.name}`;
+        logger.debug(msg);
+        leaveBreadcrumb(msg);
         const intgClass = integrations[intg.name];
         const destConfig = intg.config;
         intgInstance = new intgClass(destConfig, self);
         intgInstance.init();
         logger.debug("initializing destination: ", intg);
         this.isInitialized(intgInstance).then(this.replayEvents);
       } catch (e) {
-        logger.error(
-          "[Analytics] initialize integration (integration.init()) failed :: ",
-          intg.name
-        );
+        handleError(e);
         this.failedToBeLoadedIntegration.push(intgInstance);
       }
     });
@@ -289,6 +315,7 @@ class Analytics {
         " failed loaded count: ",
         object.failedToBeLoadedIntegration.length
       );
+      leaveBreadcrumb(`Started replaying buffered events`);
       // eslint-disable-next-line no-param-reassign
       object.clientIntegrationObjects = [];
       // eslint-disable-next-line no-param-reassign
@@ -412,6 +439,7 @@ class Analytics {
    * @memberof Analytics
    */
   page(category, name, properties, options, callback) {
+    leaveBreadcrumb(`Page event`);
     if (!this.loaded) return;
     if (typeof options === "function") (callback = options), (options = null);
     if (typeof properties === "function")
@@ -444,6 +472,7 @@ class Analytics {
    * @memberof Analytics
    */
   track(event, properties, options, callback) {
+    leaveBreadcrumb(`Track event`);
     if (!this.loaded) return;
     if (typeof options === "function") (callback = options), (options = null);
     if (typeof properties === "function")
@@ -462,6 +491,7 @@ class Analytics {
    * @memberof Analytics
    */
   identify(userId, traits, options, callback) {
+    leaveBreadcrumb(`Identify event`);
     if (!this.loaded) return;
     if (typeof options === "function") (callback = options), (options = null);
     if (typeof traits === "function")
@@ -480,6 +510,7 @@ class Analytics {
    * @param {*} callback
    */
   alias(to, from, options, callback) {
+    leaveBreadcrumb(`Alias event`);
     if (!this.loaded) return;
     if (typeof options === "function") (callback = options), (options = null);
     if (typeof from === "function")
@@ -507,6 +538,7 @@ class Analytics {
    * @param {*} callback
    */
   group(groupId, traits, options, callback) {
+    leaveBreadcrumb(`Group event`);
     if (!this.loaded) return;
     if (!arguments.length) return;
 
@@ -705,27 +737,27 @@ class Analytics {
       // Blacklist is choosen for filtering events
       case "blacklistedEvents":
         if (Array.isArray(blacklistedEvents)) {
-          return blacklistedEvents.find(
-            (eventObj) =>
-              eventObj.eventName.trim().toUpperCase() === formattedEventName
-          ) === undefined
-            ? false
-            : true;
-        } else {
-          return false;
+          return (
+            blacklistedEvents.find(
+              (eventObj) =>
+                eventObj.eventName.trim().toUpperCase() === formattedEventName
+            ) !== undefined
+          );
         }
+        return false;
+
       // Whitelist is choosen for filtering events
       case "whitelistedEvents":
         if (Array.isArray(whitelistedEvents)) {
-          return whitelistedEvents.find(
-            (eventObj) =>
-              eventObj.eventName.trim().toUpperCase() === formattedEventName
-          ) === undefined
-            ? true
-            : false;
-        } else {
-          return true;
+          return (
+            whitelistedEvents.find(
+              (eventObj) =>
+                eventObj.eventName.trim().toUpperCase() === formattedEventName
+            ) === undefined
+          );
         }
+        return true;
+
       default:
         return false;
     }
@@ -747,7 +779,7 @@ class Analytics {
 
       // assign page properties to context
       // rudderElement.message.context.page = getDefaultPageProperties();
-
+      leaveBreadcrumb("Started sending data to destinations");
       rudderElement.message.context.traits = {
         ...this.userTraits,
       };
@@ -792,11 +824,12 @@ class Analytics {
         );
 
       // try to first send to all integrations, if list populated from BE
-      try {
-        succesfulLoadedIntersectClientSuppliedIntegrations.forEach((obj) => {
+
+      succesfulLoadedIntersectClientSuppliedIntegrations.forEach((obj) => {
+        try {
           if (!obj.isFailed || !obj.isFailed()) {
             if (obj[type]) {
-              let sendEvent = !this.IsEventBlackListed(
+              const sendEvent = !this.IsEventBlackListed(
                 rudderElement.message.event,
                 obj.name
               );
@@ -808,10 +841,11 @@ class Analytics {
               }
             }
           }
-        });
-      } catch (err) {
-        handleError({ message: `[sendToNative]:${err}` });
-      }
+        } catch (err) {
+          err.message = `[sendToNative]:: [Destination: ${obj.name}]:: "${err.message}"`;
+          handleError(err);
+        }
+      });
 
       // config plane native enabled destinations, still not completely loaded
       // in the page, add the events to a queue and process later
@@ -927,6 +961,8 @@ class Analytics {
    * @memberof Analytics
    */
   reset(flag) {
+    leaveBreadcrumb(`reset API :: flag: ${flag}`);
+
     if (!this.loaded) return;
     if (flag) {
       this.anonymousId = "";
@@ -1012,11 +1048,9 @@ class Analytics {
       this.cookieConsentOptions = cloneDeep(options.cookieConsentManager);
     let configUrl = CONFIG_URL;
     if (!this.isValidWriteKey(writeKey) || !this.isValidServerUrl(serverUrl)) {
-      handleError({
-        message:
-          "[Analytics] load:: Unable to load due to wrong writeKey or serverUrl",
-      });
-      throw Error("failed to initialize");
+      throw Error(
+        "Unable to load the SDK due to invalid writeKey or serverUrl"
+      );
     }
 
     let storageOptions = {};
@@ -1104,7 +1138,7 @@ class Analytics {
     }
     if (options && options.getSourceConfig) {
       if (typeof options.getSourceConfig !== "function") {
-        handleError('option "getSourceConfig" must be a function');
+        handleError(new Error('option "getSourceConfig" must be a function'));
       } else {
         const res = options.getSourceConfig();
 

buildspec.prod.yaml

@@ -6,16 +6,15 @@ phases:
       nodejs: 12
   build:
     commands:
-      - ls
       - npm install --unsafe-perm
       - npm run prodTest && npm test
       - npm run buildProdBrowser
-      - sed 's|//# sourceMappingURL=rudder-analytics.min.js.map||' dist/rudder-analytics.min.js  > dist/prod.js
-      - mv dist/prod.js dist/rudder-analytics.min.js
-      - aws s3 cp dist/rudder-analytics.min.js s3://$S3_BUCKET_NAME/rudder-analytics.min.js --cache-control max-age=3600 --acl public-read
+      - sed -i -e 's|{{RS_BUGSNAG_API_KEY}}|'$RS_BUGSNAG_API_KEY'|' dist/rudder-analytics.min.js
       - aws s3 cp dist/rudder-analytics.min.js s3://$S3_BUCKET_NAME/v1/rudder-analytics.min.js --cache-control max-age=3600 --acl public-read
-      - aws cloudfront create-invalidation --distribution-id $CLOUDFRONT_DISTRIBUTION_ID --paths "/v1/rudder-analytics.min.js"
-      - aws cloudfront create-invalidation --distribution-id $CLOUDFRONT_DISTRIBUTION_ID --paths "/rudder-analytics.min.js"     
+      - aws s3 cp dist/rudder-analytics.min.js.map s3://$S3_BUCKET_NAME/v1/rudder-analytics.min.js.map --cache-control max-age=3600 --acl public-read
+      - aws s3 cp s3://$S3_BUCKET_NAME/v1/rudder-analytics.min.js s3://$S3_BUCKET_NAME/rudder-analytics.min.js --cache-control max-age=3600 --acl public-read
+      - aws s3 cp s3://$S3_BUCKET_NAME/v1/rudder-analytics.min.js.map s3://$S3_BUCKET_NAME/rudder-analytics.min.js.map --cache-control max-age=3600 --acl public-read
+      - aws cloudfront create-invalidation --distribution-id $CLOUDFRONT_DISTRIBUTION_ID --paths "/v1/rudder-analytics.min.js" "/v1/rudder-analytics.min.js.map" "/rudder-analytics.min.js" "/rudder-analytics.min.js.map"
 artifacts:
   files:
     - "**/*"

buildspec.staging.yaml

@@ -1,22 +1,20 @@
 version: 0.2
 
-
 phases:
   install:
     runtime-versions:
       nodejs: 12
   build:
     commands:
-      - ls
       - npm install --unsafe-perm
       - npm run prodTest && npm test
       - npm run buildProdBrowser
-      - sed 's|//# sourceMappingURL=rudder-analytics.min.js.map||' dist/rudder-analytics.min.js  > dist/prod.js
-      - mv dist/prod.js dist/rudder-analytics.min.js
-      - aws s3 cp dist/rudder-analytics.min.js s3://$S3_BUCKET_NAME/rudder-analytics-staging.min.js --cache-control max-age=3600 --acl public-read
+      - sed -i -e 's|rudder-analytics.min.js.map|rudder-analytics-staging.min.js.map|' -e 's|{{RS_BUGSNAG_API_KEY}}|'$RS_BUGSNAG_API_KEY'|' dist/rudder-analytics.min.js
       - aws s3 cp dist/rudder-analytics.min.js s3://$S3_BUCKET_NAME/v1/rudder-analytics-staging.min.js --cache-control max-age=3600 --acl public-read
-      - aws cloudfront create-invalidation --distribution-id $CLOUDFRONT_DISTRIBUTION_ID --paths "/v1/rudder-analytics-staging.min.js"
-      - aws cloudfront create-invalidation --distribution-id $CLOUDFRONT_DISTRIBUTION_ID --paths "/rudder-analytics-staging.min.js"     
+      - aws s3 cp dist/rudder-analytics.min.js.map s3://$S3_BUCKET_NAME/v1/rudder-analytics-staging.min.js.map --cache-control max-age=3600 --acl public-read
+      - aws s3 cp s3://$S3_BUCKET_NAME/v1/rudder-analytics-staging.min.js s3://$S3_BUCKET_NAME/rudder-analytics-staging.min.js --cache-control max-age=3600 --acl public-read
+      - aws s3 cp s3://$S3_BUCKET_NAME/v1/rudder-analytics-staging.min.js.map s3://$S3_BUCKET_NAME/rudder-analytics-staging.min.js.map --cache-control max-age=3600 --acl public-read
+      - aws cloudfront create-invalidation --distribution-id $CLOUDFRONT_DISTRIBUTION_ID --paths "/v1/rudder-analytics-staging.min.js" "/v1/rudder-analytics-staging.min.js.map" "/rudder-analytics-staging.min.js" "/rudder-analytics-staging.min.js.map"
 artifacts:
   files:
     - "**/*"

integrations/Amplitude/browser.js

@@ -2,6 +2,7 @@
 /* eslint-disable class-methods-use-this */
 import logger from "../../utils/logUtil";
 import { type } from "../../utils/utils";
+import { LOAD_ORIGIN } from "../ScriptLoader";
 import { NAME } from "./constants";
 
 class Amplitude {
@@ -63,6 +64,7 @@ class Amplitude {
           "sha384-girahbTbYZ9tT03PWWj0mEVgyxtZoyDF9KVZdL+R53PP5wCY0PiVUKq0jeRlMx9M";
         r.crossOrigin = "anonymous";
         r.async = true;
+        r.dataset.loader = LOAD_ORIGIN;
         r.src = "https://cdn.amplitude.com/libs/amplitude-7.2.1-min.gz.js";
         r.onload = function () {
           if (!e.amplitude.runQueuedFunctions) {

integrations/BingAds/browser.js

@@ -1,4 +1,5 @@
 import logger from "../../utils/logUtil";
+import { LOAD_ORIGIN } from "../ScriptLoader";
 import { NAME } from "./constants";
 
 class BingAds {
@@ -20,6 +21,7 @@ class BingAds {
         (n = d.createElement(t)),
         (n.src = r),
         (n.async = 1),
+        (n.dataset.loader = LOAD_ORIGIN),
         (n.onload = n.onreadystatechange =
           function () {
             let s = this.readyState;

integrations/Braze/browser.js

@@ -1,5 +1,6 @@
 /* eslint-disable class-methods-use-this */
 import logger from "../../utils/logUtil";
+import { LOAD_ORIGIN } from "../ScriptLoader";
 import { NAME } from "./constants";
 
 /*
@@ -88,6 +89,7 @@ class Braze {
       };
       (y = p.createElement(P)).type = "text/javascript";
       y.src = "https://js.appboycdn.com/web-sdk/2.4/appboy.min.js";
+      y.dataset.loader = LOAD_ORIGIN;
       y.async = 1;
       (b = p.getElementsByTagName(P)[0]).parentNode.insertBefore(y, b);
     })(window, document, "script");

integrations/Chartbeat/browser.js

@@ -6,6 +6,7 @@ import {
   INTEGRATION_LOAD_CHECK_INTERVAL,
 } from "../../utils/constants";
 import { NAME } from "./constants";
+import { LOAD_ORIGIN } from "../ScriptLoader";
 
 class Chartbeat {
   constructor(config, analytics) {
@@ -108,6 +109,7 @@ class Chartbeat {
         e.type = "text/javascript";
         e.async = true;
         e.src = `//static.chartbeat.com/js/${script}`;
+        e.dataset.loader = LOAD_ORIGIN;
         n.parentNode.insertBefore(e, n);
       }
       loadChartbeat();