@honeybadger-io/js 6.16.6 → 6.17.0

package/dist/server/honeybadger.js

@@ -271,7 +271,7 @@ var require$$0$1 = /*@__PURE__*/getAugmentedNamespace(stackTraceParser_esm);
 	    }
 	};
 	Object.defineProperty(exports, "__esModule", { value: true });
-	exports.logDeprecatedMethod = exports.globalThisOrWindow = exports.isBrowserConfig = exports.clone = exports.formatCGIData = exports.filterBreadcrumbs = exports.filterUrl = exports.filter = exports.generateStackTrace = exports.endpoint = exports.instrumentConsole = exports.instrument = exports.isErrorObject = exports.makeNotice = exports.logger = exports.sanitize = exports.shallowClone = exports.runAfterNotifyHandlers = exports.shouldSampleEvent = exports.resolveInsights = exports.runBeforeEventHandlers = exports.runBeforeNotifyHandlers = exports.getSourceForBacktrace = exports.getCauses = exports.calculateBacktraceShift = exports.DEFAULT_BACKTRACE_SHIFT = exports.makeBacktrace = exports.objectIsExtensible = exports.objectIsEmpty = exports.mergeNotice = exports.merge = void 0;
+	exports.logDeprecatedMethod = exports.globalThisOrWindow = exports.isBrowserConfig = exports.clone = exports.formatCGIData = exports.filterBreadcrumbs = exports.filterUrl = exports.filter = exports.generateStackTrace = exports.endpoint = exports.instrumentConsole = exports.instrument = exports.isErrorObject = exports.makeNotice = exports.logger = exports.sanitize = exports.shallowClone = exports.runAfterNotifyHandlers = exports.shouldSampleEvent = exports.resolveInsights = exports.runBeforeBreadcrumbHandlers = exports.runBeforeEventHandlers = exports.runBeforeNotifyHandlers = exports.getSourceForBacktrace = exports.getCauses = exports.calculateBacktraceShift = exports.DEFAULT_BACKTRACE_SHIFT = exports.makeBacktrace = exports.objectIsExtensible = exports.objectIsEmpty = exports.mergeNotice = exports.merge = void 0;
 	/* eslint-disable prefer-rest-params */
 	var stackTraceParser = __importStar(require$$0$1);
 	function merge(obj1, obj2) {
@@ -484,6 +484,25 @@ var require$$0$1 = /*@__PURE__*/getAugmentedNamespace(stackTraceParser_esm);
 	    });
 	}
 	exports.runBeforeEventHandlers = runBeforeEventHandlers;
+	function runBeforeBreadcrumbHandlers(breadcrumb, handlers, logger) {
+	    for (var i = 0, len = handlers.length; i < len; i++) {
+	        var result = void 0;
+	        try {
+	            result = handlers[i](breadcrumb);
+	        }
+	        catch (err) {
+	            // Breadcrumbs are recorded inside instrumented fetch/XHR/DOM callbacks,
+	            // so a buggy handler must not throw into the host app. Log and treat as no-op.
+	            logger === null || logger === void 0 ? void 0 : logger.error('beforeBreadcrumb handler threw; continuing', err);
+	            continue;
+	        }
+	        if (result === false) {
+	            return false;
+	        }
+	    }
+	    return true;
+	}
+	exports.runBeforeBreadcrumbHandlers = runBeforeBreadcrumbHandlers;
 	function resolveInsights(config) {
 	    var _a, _b;
 	    var insights = config.insights;
@@ -1549,12 +1568,14 @@ var Client = /** @class */ (function () {
         this.__store = null;
         this.__beforeNotifyHandlers = [];
         this.__beforeEventHandlers = [];
+        this.__beforeBreadcrumbHandlers = [];
+        this.__runningBeforeBreadcrumbHandlers = false;
         this.__afterNotifyHandlers = [];
         this.__pendingEvents = new Set();
         this.__notifier = {
             name: '@honeybadger-io/core',
             url: 'https://github.com/honeybadger-io/honeybadger-js/tree/master/packages/core',
-            version: '6.16.6'
+            version: '6.17.0'
         };
         this.config = __assign$1(__assign$1({}, defaults_1.CONFIG), opts);
         this.__initStore();
@@ -1621,6 +1642,10 @@ var Client = /** @class */ (function () {
         this.__beforeEventHandlers.push(handler);
         return this;
     };
+    Client.prototype.beforeBreadcrumb = function (handler) {
+        this.__beforeBreadcrumbHandlers.push(handler);
+        return this;
+    };
     Client.prototype.afterNotify = function (handler) {
         this.__afterNotifyHandlers.push(handler);
         return this;
@@ -1826,12 +1851,29 @@ var Client = /** @class */ (function () {
         var metadata = (0, util_1$5.shallowClone)(opts.metadata);
         var category = opts.category || 'custom';
         var timestamp = new Date().toISOString();
-        this.__store.addBreadcrumb({
+        var breadcrumb = {
             category: category,
             message: message,
             metadata: metadata,
             timestamp: timestamp
-        });
+        };
+        // A handler that logs, or the error we log when a handler throws, goes
+        // through instrumented console methods and lands back here. Skipping the
+        // handlers for those breadcrumbs keeps that from recursing.
+        if (!this.__runningBeforeBreadcrumbHandlers) {
+            this.__runningBeforeBreadcrumbHandlers = true;
+            var keep = void 0;
+            try {
+                keep = (0, util_1$5.runBeforeBreadcrumbHandlers)(breadcrumb, this.__beforeBreadcrumbHandlers, this.logger);
+            }
+            finally {
+                this.__runningBeforeBreadcrumbHandlers = false;
+            }
+            if (!keep) {
+                return this;
+            }
+        }
+        this.__store.addBreadcrumb(breadcrumb);
         return this;
     };
     /**
@@ -4170,7 +4212,7 @@ var globalSingleton = {};
 	var NOTIFIER = {
 	    name: '@honeybadger-io/js',
 	    url: 'https://github.com/honeybadger-io/honeybadger-js/tree/master/packages/js',
-	    version: '6.16.6'
+	    version: '6.17.0'
 	};
 	var userAgent = function () {
 	    return "Honeybadger JS Server Client ".concat(NOTIFIER.version, ", ").concat(os_1.default.version(), "; ").concat(os_1.default.platform());