@honeybadger-io/js 4.0.0-beta.0 → 4.0.0-beta.3

package/dist/browser/honeybadger.js

@@ -263,7 +263,7 @@
     }
     function runAfterNotifyHandlers(notice, handlers, error) {
         if (notice && notice.afterNotify) {
-            handlers.unshift(notice.afterNotify);
+            notice.afterNotify(error, notice);
         }
         for (var i = 0, len = handlers.length; i < len; i++) {
             handlers[i](error, notice);
@@ -271,7 +271,7 @@
         return true;
     }
     // Returns a new object with properties from other object.
-    function newObject(obj) {
+    function shallowClone(obj) {
         if (typeof (obj) !== 'object' || obj === null) {
             return {};
         }
@@ -298,8 +298,14 @@
             return false;
         }
         function canSerialize(obj) {
-            // Functions are TMI and Symbols can't convert to strings.
-            if (/function|symbol/.test(typeof (obj))) {
+            var typeOfObj = typeof obj;
+            // Functions are TMI
+            if (/function/.test(typeOfObj)) {
+                // Let special toJSON method pass as it's used by JSON.stringify (#722)
+                return obj.name === 'toJSON';
+            }
+            // Symbols can't convert to strings.
+            if (/symbol/.test(typeOfObj)) {
                 return false;
             }
             if (obj === null) {
@@ -326,7 +332,7 @@
             }
             // Serialize inside arrays
             if (Array.isArray(obj)) {
-                return obj.map(function (o) { return serialize(o, depth + 1); });
+                return obj.map(function (o) { return safeSerialize(o, depth + 1); });
             }
             // Serialize inside objects
             if (typeof (obj) === 'object') {
@@ -334,7 +340,7 @@
                 for (var k in obj) {
                     var v = obj[k];
                     if (Object.prototype.hasOwnProperty.call(obj, k) && (k != null) && (v != null)) {
-                        ret[k] = serialize(v, depth + 1);
+                        ret[k] = safeSerialize(v, depth + 1);
                     }
                 }
                 return ret;
@@ -342,7 +348,16 @@
             // Return everything else untouched
             return obj;
         }
-        return serialize(obj);
+        function safeSerialize(obj, depth) {
+            if (depth === void 0) { depth = 0; }
+            try {
+                return serialize(obj, depth);
+            }
+            catch (e) {
+                return "[ERROR] ".concat(e);
+            }
+        }
+        return safeSerialize(obj);
     }
     function logger(client) {
         var log = function (method) {
@@ -381,12 +396,12 @@
         if (!thing) {
             notice = {};
         }
-        else if (Object.prototype.toString.call(thing) === '[object Error]') {
+        else if (thing instanceof Error || Object.prototype.toString.call(thing) === '[object Error]') {
             var e = thing;
             notice = merge(thing, { name: e.name, message: e.message, stack: e.stack });
         }
         else if (typeof thing === 'object') {
-            notice = newObject(thing);
+            notice = shallowClone(thing);
         }
         else {
             var m = String(thing);
@@ -553,33 +568,44 @@
         return result;
     }
 
+    var GlobalStore = /** @class */ (function () {
+        function GlobalStore(store) {
+            this.store = store;
+        }
+        GlobalStore.prototype.getStore = function () {
+            return this.store;
+        };
+        GlobalStore.prototype.run = function (store, callback) {
+            var args = [];
+            for (var _i = 2; _i < arguments.length; _i++) {
+                args[_i - 2] = arguments[_i];
+            }
+            this.store = store;
+            return callback.apply(void 0, args);
+        };
+        return GlobalStore;
+    }());
+
     var notifier = {
         name: 'honeybadger-js',
         url: 'https://github.com/honeybadger-io/honeybadger-js',
-        version: '4.0.0-beta.0'
+        version: '4.0.0-beta.3'
     };
-    // Split at commas
-    var TAG_SEPARATOR = /,/;
-    // Removes any non-word characters
-    var TAG_SANITIZER = /[^\w]/g;
-    // Checks for blank strings
-    var STRING_EMPTY = '';
+    // Split at commas and spaces
+    var TAG_SEPARATOR = /,|\s+/;
     // Checks for non-blank characters
     var NOT_BLANK = /\S/;
     var Client = /** @class */ (function () {
         function Client(opts) {
             if (opts === void 0) { opts = {}; }
-            /** @internal */
             this.__pluginsExecuted = false;
-            /** @internal */
-            this.__context = {};
-            /** @internal */
-            this.__breadcrumbs = [];
-            /** @internal */
+            this.__store = null;
             this.__beforeNotifyHandlers = [];
-            /** @internal */
             this.__afterNotifyHandlers = [];
             this.config = __assign({ apiKey: null, endpoint: 'https://api.honeybadger.io', environment: null, hostname: null, projectRoot: null, component: null, action: null, revision: null, reportData: null, breadcrumbsEnabled: true, maxBreadcrumbs: 40, maxObjectDepth: 8, logger: console, developmentEnvironments: ['dev', 'development', 'test'], debug: false, tags: null, enableUncaught: true, enableUnhandledRejection: true, afterUncaught: function () { return true; }, filters: ['creditcard', 'password'], __plugins: [] }, opts);
+            // First, we go with the global (shared) store.
+            // Webserver middleware can then switch to the AsyncStore for async context tracking.
+            this.__store = new GlobalStore({ context: {}, breadcrumbs: [] });
             this.logger = logger(this);
         }
         Client.prototype.factory = function (_opts) {
@@ -600,6 +626,10 @@
             }
             return this;
         };
+        /** @internal */
+        Client.prototype.__setStore = function (store) {
+            this.__store = store;
+        };
         Client.prototype.beforeNotify = function (handler) {
             this.__beforeNotifyHandlers.push(handler);
             return this;
@@ -610,23 +640,26 @@
         };
         Client.prototype.setContext = function (context) {
             if (typeof context === 'object') {
-                this.__context = merge(this.__context, context);
+                var store = this.__store.getStore();
+                store.context = merge(store.context, context);
             }
             return this;
         };
         Client.prototype.resetContext = function (context) {
             this.logger.warn('Deprecation warning: `Honeybadger.resetContext()` has been deprecated; please use `Honeybadger.clear()` instead.');
+            var store = this.__store.getStore();
             if (typeof context === 'object' && context !== null) {
-                this.__context = merge({}, context);
+                store.context = context;
             }
             else {
-                this.__context = {};
+                store.context = {};
             }
             return this;
         };
         Client.prototype.clear = function () {
-            this.__context = {};
-            this.__breadcrumbs = [];
+            var store = this.__store.getStore();
+            store.context = {};
+            store.breadcrumbs = [];
             return this;
         };
         Client.prototype.notify = function (noticeable, name, extra) {
@@ -668,10 +701,11 @@
                     stack: notice.stack
                 }
             });
-            notice.__breadcrumbs = this.config.breadcrumbsEnabled ? this.__breadcrumbs.slice() : [];
+            var breadcrumbs = this.__getStoreContentsOrDefault().breadcrumbs;
+            notice.__breadcrumbs = this.config.breadcrumbsEnabled ? breadcrumbs.slice() : [];
             // we need to have the source file data before the beforeNotifyHandlers,
             // in case they modify them
-            var sourceCodeData = notice ? notice.backtrace.slice() : null;
+            var sourceCodeData = notice && notice.backtrace ? notice.backtrace.map(function (trace) { return shallowClone(trace); }) : null;
             getSourceForBacktrace(sourceCodeData, this.__getSourceFileHandler, function (sourcePerTrace) {
                 sourcePerTrace.forEach(function (source, index) {
                     notice.backtrace[index].source = source;
@@ -742,15 +776,16 @@
             if (objectIsEmpty(notice)) {
                 return null;
             }
+            var context = this.__getStoreContentsOrDefault().context;
             var noticeTags = this.__constructTags(notice.tags);
-            var contextTags = this.__constructTags(this.__context["tags"]);
+            var contextTags = this.__constructTags(context["tags"]);
             var configTags = this.__constructTags(this.config.tags);
             // Turning into a Set will remove duplicates
             var tags = noticeTags.concat(contextTags).concat(configTags);
             var uniqueTags = tags.filter(function (item, index) { return tags.indexOf(item) === index; });
             notice = merge(notice, {
                 name: notice.name || 'Error',
-                context: merge(this.__context, notice.context),
+                context: merge(context, notice.context),
                 projectRoot: notice.projectRoot || this.config.projectRoot,
                 environment: notice.environment || this.config.environment,
                 component: notice.component || this.config.component,
@@ -771,33 +806,33 @@
                 return;
             }
             opts = opts || {};
-            var metadata = newObject(opts.metadata);
+            var metadata = shallowClone(opts.metadata);
             var category = opts.category || 'custom';
             var timestamp = new Date().toISOString();
-            this.__breadcrumbs.push({
+            var store = this.__store.getStore();
+            var breadcrumbs = store.breadcrumbs;
+            breadcrumbs.push({
                 category: category,
                 message: message,
                 metadata: metadata,
                 timestamp: timestamp
             });
             var limit = this.config.maxBreadcrumbs;
-            if (this.__breadcrumbs.length > limit) {
-                this.__breadcrumbs = this.__breadcrumbs.slice(this.__breadcrumbs.length - limit);
+            if (breadcrumbs.length > limit) {
+                breadcrumbs = breadcrumbs.slice(breadcrumbs.length - limit);
             }
+            store.breadcrumbs = breadcrumbs;
             return this;
         };
-        /** @internal */
         Client.prototype.__developmentMode = function () {
             if (this.config.reportData === true) {
                 return false;
             }
             return (this.config.environment && this.config.developmentEnvironments.includes(this.config.environment));
         };
-        /** @internal */
         Client.prototype.__send = function (_notice) {
             throw (new Error('Must implement send in subclass'));
         };
-        /** @internal */
         Client.prototype.__buildPayload = function (notice) {
             var headers = filter(notice.headers, this.config.filters) || {};
             var cgiData = filter(__assign(__assign({}, notice.cgiData), formatCGIData(headers, 'HTTP_')), this.config.filters);
@@ -833,14 +868,22 @@
                 details: notice.details || {}
             };
         };
-        /** @internal */
         Client.prototype.__constructTags = function (tags) {
             if (!tags) {
                 return [];
             }
-            return tags.toString().split(TAG_SEPARATOR).map(function (tag) {
-                return tag.replace(TAG_SANITIZER, STRING_EMPTY);
-            }).filter(function (tag) { return NOT_BLANK.test(tag); });
+            return tags.toString().split(TAG_SEPARATOR).filter(function (tag) { return NOT_BLANK.test(tag); });
+        };
+        /**
+         * For ALS, the store may be uninitialized (if .run()` has not been called).
+         * This provides an easy way to read the existing store object or fall back to a default.
+         * Returns *a copy* of the store contents.
+         * @internal
+         */
+        Client.prototype.__getStoreContentsOrDefault = function () {
+            var existingStoreContents = this.__store.getStore();
+            var storeContents = existingStoreContents || {};
+            return __assign({ context: {}, breadcrumbs: [] }, storeContents);
         };
         return Client;
     }());
@@ -1528,10 +1571,11 @@
                         _this.logger.debug("Unable to send error report: ".concat(x_1.status, ": ").concat(x_1.statusText), x_1, notice);
                         return;
                     }
+                    var uuid = JSON.parse(x_1.response).id;
                     runAfterNotifyHandlers(merge(notice, {
-                        id: JSON.parse(x_1.response).id
+                        id: uuid
                     }), _this.__afterNotifyHandlers);
-                    _this.logger.debug('Error report sent', notice);
+                    _this.logger.debug("Error report sent \u26A1 https://app.honeybadger.io/notice/".concat(uuid));
                 };
             }
             catch (err) {