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

package/dist/browser/honeybadger.js

@@ -2,7 +2,7 @@
     typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
     typeof define === 'function' && define.amd ? define(factory) :
     (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.Honeybadger = factory());
-}(this, (function () { 'use strict';
+})(this, (function () { 'use strict';
 
     /*! *****************************************************************************
     Copyright (c) Microsoft Corporation.
@@ -215,7 +215,8 @@
     function makeBacktrace(stack, shift) {
         if (shift === void 0) { shift = 0; }
         try {
-            var backtrace = parse(stack).map(function (line) {
+            var backtrace = parse(stack)
+                .map(function (line) {
                 return {
                     file: line.file,
                     method: line.methodName,
@@ -231,17 +232,39 @@
             return [];
         }
     }
+    function getSourceForBacktrace(backtrace, getSourceFileHandler, cb) {
+        if (!getSourceFileHandler || !backtrace || !backtrace.length) {
+            cb([]);
+            return;
+        }
+        var result = [];
+        var getSourceFromFile = function (index) {
+            if (index === void 0) { index = 0; }
+            if (!backtrace.length) {
+                return cb(result);
+            }
+            var trace = backtrace.splice(0)[index];
+            getSourceFileHandler(trace.file, (function (fileContent) {
+                result[index] = getSourceCodeSnippet(fileContent, trace.number);
+                getSourceFromFile(index + 1);
+            }));
+        };
+        getSourceFromFile();
+    }
     function runBeforeNotifyHandlers(notice, handlers) {
+        var result = true;
         for (var i = 0, len = handlers.length; i < len; i++) {
             var handler = handlers[i];
             if (handler(notice) === false) {
-                return false;
+                result = false;
             }
         }
-        return true;
+        return result;
     }
     function runAfterNotifyHandlers(notice, handlers, error) {
-        if (error === void 0) { error = undefined; }
+        if (notice && notice.afterNotify) {
+            handlers.unshift(notice.afterNotify);
+        }
         for (var i = 0, len = handlers.length; i < len; i++) {
             handlers[i](error, notice);
         }
@@ -329,8 +352,13 @@
                 for (var _i = 0; _i < arguments.length; _i++) {
                     args[_i] = arguments[_i];
                 }
-                if (method === 'debug' && !client.config.debug) {
-                    return;
+                if (method === 'debug') {
+                    if (!client.config.debug) {
+                        return;
+                    }
+                    // Log at default level so that you don't need to also enable verbose
+                    // logging in Chrome.
+                    method = 'log';
                 }
                 args.unshift('[Honeybadger]');
                 (_a = client.config.logger)[method].apply(_a, args);
@@ -394,7 +422,7 @@
     function endpoint(config, path) {
         var endpoint = config.endpoint.trim().replace(/\/$/, '');
         path = path.trim().replace(/(^\/|\/$)/g, '');
-        return endpoint + "/" + path;
+        return "".concat(endpoint, "/").concat(path);
     }
     function generateStackTrace() {
         try {
@@ -453,7 +481,9 @@
                 return newObj;
             }
             if (is('Array', obj)) {
-                return obj.map(function (v) { return filter(v); });
+                return obj.map(function (v) {
+                    return filter(v);
+                });
             }
             if (is('Function', obj)) {
                 return '[FUNC]';
@@ -489,7 +519,7 @@
         query.split(/[&]\s?/).forEach(function (pair) {
             var _a = pair.split('=', 2), key = _a[0], value = _a[1];
             if (filterMatch(key, filters)) {
-                result = result.replace(key + "=" + value, key + "=[FILTERED]");
+                result = result.replace("".concat(key, "=").concat(value), "".concat(key, "=[FILTERED]"));
             }
         });
         return result;
@@ -503,11 +533,30 @@
         });
         return formattedVars;
     }
+    function getSourceCodeSnippet(fileData, lineNumber, sourceRadius) {
+        if (sourceRadius === void 0) { sourceRadius = 2; }
+        if (!fileData) {
+            return null;
+        }
+        var lines = fileData.split('\n');
+        // add one empty line because array index starts from 0, but error line number is counted from 1
+        lines.unshift('');
+        var start = lineNumber - sourceRadius;
+        var end = lineNumber + sourceRadius;
+        var result = {};
+        for (var i = start; i <= end; i++) {
+            var line = lines[i];
+            if (typeof line === 'string') {
+                result[i] = line;
+            }
+        }
+        return result;
+    }
 
     var notifier = {
         name: 'honeybadger-js',
         url: 'https://github.com/honeybadger-io/honeybadger-js',
-        version: '3.2.4'
+        version: '4.0.0-beta.0'
     };
     // Split at commas
     var TAG_SEPARATOR = /,/;
@@ -530,7 +579,7 @@
             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'], disabled: false, debug: false, tags: null, enableUncaught: true, enableUnhandledRejection: true, afterUncaught: function () { return true; }, filters: ['creditcard', 'password'], __plugins: [] }, opts);
+            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);
             this.logger = logger(this);
         }
         Client.prototype.factory = function (_opts) {
@@ -580,22 +629,106 @@
             this.__breadcrumbs = [];
             return this;
         };
-        Client.prototype.notify = function (notice, name, extra) {
+        Client.prototype.notify = function (noticeable, name, extra) {
+            var _this = this;
             if (name === void 0) { name = undefined; }
             if (extra === void 0) { extra = undefined; }
-            if (!this.config.apiKey) {
-                this.logger.warn('Unable to send error report: no API key has been configured');
-                return false;
+            var preConditionError = null;
+            var notice = this.makeNotice(noticeable, name, extra);
+            if (!notice) {
+                this.logger.debug('failed to build error report');
+                preConditionError = new Error('failed to build error report');
             }
-            if (this.config.disabled) {
-                this.logger.warn('Deprecation warning: instead of `disabled: true`, use `reportData: false` to explicitly disable Honeybadger reporting. (Dropping notice: honeybadger.js is disabled)');
-                return false;
+            if (!preConditionError && this.config.reportData === false) {
+                this.logger.debug('skipping error report: honeybadger.js is disabled', notice);
+                preConditionError = new Error('honeybadger.js is disabled');
+            }
+            if (!preConditionError && this.__developmentMode()) {
+                this.logger.log('honeybadger.js is in development mode; the following error report will be sent in production.', notice);
+                preConditionError = new Error('honeybadger.js is in development mode');
+            }
+            if (!preConditionError && !this.config.apiKey) {
+                this.logger.warn('could not send error report: no API key has been configured', notice);
+                preConditionError = new Error('missing API key');
             }
-            if (!this.__reportData()) {
-                this.logger.debug('Dropping notice: honeybadger.js is in development mode');
+            var beforeNotifyResult = runBeforeNotifyHandlers(notice, this.__beforeNotifyHandlers);
+            if (!preConditionError && !beforeNotifyResult) {
+                this.logger.debug('skipping error report: beforeNotify handlers returned false', notice);
+                preConditionError = new Error('beforeNotify handlers returned false');
+            }
+            if (preConditionError) {
+                runAfterNotifyHandlers(notice, this.__afterNotifyHandlers, preConditionError);
                 return false;
             }
-            notice = makeNotice(notice);
+            this.addBreadcrumb('Honeybadger Notice', {
+                category: 'notice',
+                metadata: {
+                    message: notice.message,
+                    name: notice.name,
+                    stack: notice.stack
+                }
+            });
+            notice.__breadcrumbs = this.config.breadcrumbsEnabled ? this.__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;
+            getSourceForBacktrace(sourceCodeData, this.__getSourceFileHandler, function (sourcePerTrace) {
+                sourcePerTrace.forEach(function (source, index) {
+                    notice.backtrace[index].source = source;
+                });
+                _this.__send(notice);
+            });
+            return true;
+        };
+        /**
+         * An async version of {@link notify} that resolves only after the notice has been reported to Honeybadger.
+         * Implemented using the {@link afterNotify} hook.
+         * Rejects if for any reason the report failed to be reported.
+         * Useful in serverless environments (AWS Lambda).
+         */
+        Client.prototype.notifyAsync = function (noticeable, name, extra) {
+            var _this = this;
+            if (name === void 0) { name = undefined; }
+            if (extra === void 0) { extra = undefined; }
+            return new Promise(function (resolve, reject) {
+                var applyAfterNotify = function (partialNotice) {
+                    var originalAfterNotify = partialNotice.afterNotify;
+                    partialNotice.afterNotify = function (err) {
+                        originalAfterNotify === null || originalAfterNotify === void 0 ? void 0 : originalAfterNotify.call(_this, err);
+                        if (err) {
+                            return reject(err);
+                        }
+                        resolve();
+                    };
+                };
+                // We have to respect any afterNotify hooks that come from the arguments
+                var objectToOverride;
+                if (noticeable.afterNotify) {
+                    objectToOverride = noticeable;
+                }
+                else if (name && name.afterNotify) {
+                    objectToOverride = name;
+                }
+                else if (extra && extra.afterNotify) {
+                    objectToOverride = extra;
+                }
+                else if (name && typeof name === 'object') {
+                    objectToOverride = name;
+                }
+                else if (extra) {
+                    objectToOverride = extra;
+                }
+                else {
+                    objectToOverride = name = {};
+                }
+                applyAfterNotify(objectToOverride);
+                _this.notify(noticeable, name, extra);
+            });
+        };
+        Client.prototype.makeNotice = function (noticeable, name, extra) {
+            if (name === void 0) { name = undefined; }
+            if (extra === void 0) { extra = undefined; }
+            var notice = makeNotice(noticeable);
             if (name && !(typeof name === 'object')) {
                 var n = String(name);
                 name = { name: n };
@@ -607,7 +740,7 @@
                 notice = mergeNotice(notice, extra);
             }
             if (objectIsEmpty(notice)) {
-                return false;
+                return null;
             }
             var noticeTags = this.__constructTags(notice.tags);
             var contextTags = this.__constructTags(this.__context["tags"]);
@@ -631,19 +764,7 @@
                 backtraceShift = 2;
             }
             notice.backtrace = makeBacktrace(notice.stack, backtraceShift);
-            if (!runBeforeNotifyHandlers(notice, this.__beforeNotifyHandlers)) {
-                return false;
-            }
-            this.addBreadcrumb('Honeybadger Notice', {
-                category: 'notice',
-                metadata: {
-                    message: notice.message,
-                    name: notice.name,
-                    stack: notice.stack
-                }
-            });
-            notice.__breadcrumbs = this.config.breadcrumbsEnabled ? this.__breadcrumbs.slice() : [];
-            return this.__send(notice);
+            return notice;
         };
         Client.prototype.addBreadcrumb = function (message, opts) {
             if (!this.config.breadcrumbsEnabled) {
@@ -666,11 +787,11 @@
             return this;
         };
         /** @internal */
-        Client.prototype.__reportData = function () {
-            if (this.config.reportData !== null) {
-                return this.config.reportData;
+        Client.prototype.__developmentMode = function () {
+            if (this.config.reportData === true) {
+                return false;
             }
-            return !(this.config.environment && this.config.developmentEnvironments.includes(this.config.environment));
+            return (this.config.environment && this.config.developmentEnvironments.includes(this.config.environment));
         };
         /** @internal */
         Client.prototype.__send = function (_notice) {
@@ -739,23 +860,23 @@
             return '';
         }
         if (element.id) {
-            name += "#" + element.id;
+            name += "#".concat(element.id);
         }
         var stringClassNames = element.getAttribute('class');
         if (stringClassNames) {
             stringClassNames.split(/\s+/).forEach(function (className) {
-                name += "." + className;
+                name += ".".concat(className);
             });
         }
         ['alt', 'name', 'title', 'type'].forEach(function (attrName) {
             var attr = element.getAttribute(attrName);
             if (attr) {
-                name += "[" + attrName + "=\"" + attr + "\"]";
+                name += "[".concat(attrName, "=\"").concat(attr, "\"]");
             }
         });
         var siblings = getSiblings(element);
         if (siblings.length > 1) {
-            name += ":nth-child(" + (Array.prototype.indexOf.call(siblings, element) + 1) + ")";
+            name += ":nth-child(".concat(Array.prototype.indexOf.call(siblings, element) + 1, ")");
         }
         return name;
     }
@@ -764,7 +885,7 @@
         if (element.parentNode && element.parentNode.tagName) {
             var parentName = stringSelectorOfElement(element.parentNode);
             if (parentName.length > 0) {
-                return parentName + " > " + name;
+                return "".concat(parentName, " > ").concat(name);
             }
         }
         return name;
@@ -824,7 +945,7 @@
             return parsed.pathname;
         }
         // x-domain
-        return parsed.protocol + "://" + parsed.host + parsed.pathname;
+        return "".concat(parsed.protocol, "://").concat(parsed.host).concat(parsed.pathname);
     }
     function decodeCookie(string) {
         var result = {};
@@ -912,12 +1033,12 @@
                             ignoreOnError -= 1;
                             return;
                         }
-                        if (!client.config.enableUncaught) {
-                            return;
-                        }
+                        // See https://developer.mozilla.org/en/docs/Web/API/GlobalEventHandlers/onerror#Notes
                         if (line === 0 && /Script error\.?/.test(msg)) {
-                            // See https://developer.mozilla.org/en/docs/Web/API/GlobalEventHandlers/onerror#Notes
-                            client.logger.info('Ignoring cross-domain script error: enable CORS to track these types of errors', arguments);
+                            if (client.config.enableUncaught) {
+                                // Log only if the user wants to report uncaught errors
+                                client.logger.warn('Ignoring cross-domain script error: enable CORS to track these types of errors', arguments);
+                            }
                             return;
                         }
                         var notice = makeNotice(err);
@@ -931,7 +1052,7 @@
                             // Simulate v8 stack
                             notice.stack = [notice.message, '\n    at ? (', url || 'unknown', ':', line || 0, ':', col || 0, ')'].join('');
                         }
-                        client.addBreadcrumb((notice.name === 'window.onerror' || !notice.name) ? 'window.onerror' : "window.onerror: " + notice.name, {
+                        client.addBreadcrumb((notice.name === 'window.onerror' || !notice.name) ? 'window.onerror' : "window.onerror: ".concat(notice.name), {
                             category: 'error',
                             metadata: {
                                 name: notice.name,
@@ -939,7 +1060,9 @@
                                 stack: notice.stack
                             }
                         });
-                        client.notify(notice);
+                        if (client.config.enableUncaught) {
+                            client.notify(notice);
+                        }
                     };
                     return function (msg, url, line, col, err) {
                         onerror(msg, url, line, col, err);
@@ -977,14 +1100,14 @@
                             // const lineNumber = reason.lineNumber || 0
                             var fileName = 'unknown';
                             var lineNumber = 0;
-                            var stackFallback = reason.message + "\n    at ? (" + fileName + ":" + lineNumber + ")";
+                            var stackFallback = "".concat(reason.message, "\n    at ? (").concat(fileName, ":").concat(lineNumber, ")");
                             var stack = reason.stack || stackFallback;
                             var err = {
                                 name: reason.name,
-                                message: "UnhandledPromiseRejectionWarning: " + reason,
+                                message: "UnhandledPromiseRejectionWarning: ".concat(reason),
                                 stack: stack
                             };
-                            client.addBreadcrumb("window.onunhandledrejection: " + err.name, {
+                            client.addBreadcrumb("window.onunhandledrejection: ".concat(err.name), {
                                 category: 'error',
                                 metadata: err
                             });
@@ -994,7 +1117,7 @@
                         var message = typeof reason === 'string' ? reason : ((_a = JSON.stringify(reason)) !== null && _a !== void 0 ? _a : 'Unspecified reason');
                         client.notify({
                             name: 'window.onunhandledrejection',
-                            message: "UnhandledPromiseRejectionWarning: " + message
+                            message: "UnhandledPromiseRejectionWarning: ".concat(message)
                         });
                     }
                     return function (promiseRejectionEvent) {
@@ -1103,7 +1226,7 @@
                             var xhr = this;
                             var url = arguments[1];
                             var method = typeof arguments[0] === 'string' ? arguments[0].toUpperCase() : arguments[0];
-                            var message = method + " " + localURLPathname(url);
+                            var message = "".concat(method, " ").concat(localURLPathname(url));
                             this.__hb_xhr = {
                                 type: 'xhr',
                                 method: method,
@@ -1188,7 +1311,7 @@
                             if (typeof method === 'string') {
                                 method = method.toUpperCase();
                             }
-                            var message = method + " " + localURLPathname(url);
+                            var message = "".concat(method, " ").concat(localURLPathname(url));
                             var metadata = {
                                 type: 'fetch',
                                 method: method,
@@ -1301,7 +1424,7 @@
                     var prototype = _window[prop] && _window[prop].prototype;
                     if (prototype && Object.prototype.hasOwnProperty.call(prototype, 'addEventListener')) {
                         instrument(prototype, 'addEventListener', function (original) {
-                            var wrapOpts = { component: prop + ".prototype.addEventListener" };
+                            var wrapOpts = { component: "".concat(prop, ".prototype.addEventListener") };
                             // See https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
                             return function (type, listener, useCapture, wantsUntrusted) {
                                 try {
@@ -1392,10 +1515,6 @@
             var _this = this;
             this.__incrementErrorsCount();
             var payload = this.__buildPayload(notice);
-            var handlers = Array.prototype.slice.call(this.__afterNotifyHandlers);
-            if (notice.afterNotify) {
-                handlers.unshift(notice.afterNotify);
-            }
             try {
                 var x_1 = new XMLHttpRequest();
                 x_1.open('POST', endpoint(this.config, '/v1/notices/js'), this.config.async);
@@ -1405,21 +1524,20 @@
                 x_1.send(JSON.stringify(sanitize(payload, this.config.maxObjectDepth)));
                 x_1.onload = function () {
                     if (x_1.status !== 201) {
-                        runAfterNotifyHandlers(notice, handlers, new Error("Bad HTTP response: " + x_1.status));
-                        _this.logger.debug("Unable to send error report: " + x_1.status + ": " + x_1.statusText, x_1, notice);
+                        runAfterNotifyHandlers(notice, _this.__afterNotifyHandlers, new Error("Bad HTTP response: ".concat(x_1.status)));
+                        _this.logger.debug("Unable to send error report: ".concat(x_1.status, ": ").concat(x_1.statusText), x_1, notice);
                         return;
                     }
                     runAfterNotifyHandlers(merge(notice, {
                         id: JSON.parse(x_1.response).id
-                    }), handlers);
+                    }), _this.__afterNotifyHandlers);
                     _this.logger.debug('Error report sent', notice);
                 };
             }
             catch (err) {
-                runAfterNotifyHandlers(notice, handlers, err);
+                runAfterNotifyHandlers(notice, this.__afterNotifyHandlers, err);
                 this.logger.error('Unable to send error report: error while initializing request', err, notice);
             }
-            return true;
         };
         /**
          * wrap always returns the same function so that callbacks can be removed via
@@ -1443,14 +1561,7 @@
                     // eslint-disable-next-line @typescript-eslint/no-this-alias
                     var client_1 = this;
                     func.___hb = function () {
-                        var onErrorEnabled = client_1.config.enableUncaught;
-                        // Catch if:
-                        //   1. We explicitly want to catch (i.e. if the error could be
-                        //      caught before reaching window.onerror)
-                        //   2. The browser provides less information via the window.onerror
-                        //      handler
-                        //   3. The window.onerror handler is unavailable
-                        if (opts.catch || preferCatch || !onErrorEnabled) {
+                        if (preferCatch) {
                             try {
                                 // eslint-disable-next-line prefer-rest-params
                                 return func.apply(this, arguments);
@@ -1461,7 +1572,7 @@
                                 }
                                 client_1.__lastWrapErr = err;
                                 ignoreNextOnError();
-                                client_1.addBreadcrumb(opts.component ? opts.component + ": " + err.name : err.name, {
+                                client_1.addBreadcrumb(opts.component ? "".concat(opts.component, ": ").concat(err.name) : err.name, {
                                     category: 'error',
                                     metadata: {
                                         message: err.message,
@@ -1469,7 +1580,9 @@
                                         stack: err.stack
                                     }
                                 });
-                                client_1.notify(err);
+                                if (client_1.config.enableUncaught) {
+                                    client_1.notify(err);
+                                }
                                 throw (err);
                             }
                         }
@@ -1508,5 +1621,5 @@
 
     return browser;
 
-})));
+}));
 //# sourceMappingURL=honeybadger.js.map