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

package/README.md

@@ -14,7 +14,8 @@ For comprehensive documentation and support, [check out our documentation site](
 
 ## Changelog
 
-See https://github.com/honeybadger-io/honeybadger-js/blob/master/CHANGELOG.md
+[Conventional Commits](https://www.conventionalcommits.org/) are enforced with a git hook ([husky](https://typicode.github.io/husky) + [commitlint](https://commitlint.js.org/)) in order to automate changelog generation.
+[CHANGELOG.md](CHANGELOG.md) is updated when a new version is released (npm run release) with [shipjs](https://community.algolia.com/shipjs/reference/all-config.html#updatechangelog).
 
 ## Contributing
 

package/dist/browser/honeybadger.d.ts

@@ -1,15 +1,12 @@
 import Client from './types/core/client';
-import { Config } from './types/core/types';
-interface BrowserConfig extends Config {
-    async: boolean;
-    maxErrors: number;
-}
+import { BrowserConfig } from './types/core/types';
 declare class Honeybadger extends Client {
     config: BrowserConfig;
     constructor(opts?: Partial<BrowserConfig>);
     configure(opts?: Partial<BrowserConfig>): Client;
     resetMaxErrors(): number;
     factory(opts?: Partial<BrowserConfig>): Honeybadger;
+    checkIn(_id: string): Promise<void>;
 }
 declare const _default: Honeybadger;
 export default _default;

package/dist/browser/honeybadger.js

@@ -44,7 +44,45 @@
             return t;
         };
         return __assign.apply(this, arguments);
-    };
+    };
+
+    function __awaiter(thisArg, _arguments, P, generator) {
+        function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+        return new (P || (P = Promise))(function (resolve, reject) {
+            function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+            function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+            function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+            step((generator = generator.apply(thisArg, _arguments || [])).next());
+        });
+    }
+
+    function __generator(thisArg, body) {
+        var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+        return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+        function verb(n) { return function (v) { return step([n, v]); }; }
+        function step(op) {
+            if (f) throw new TypeError("Generator is already executing.");
+            while (_) try {
+                if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+                if (y = 0, t) op = [op[0] & 2, t.value];
+                switch (op[0]) {
+                    case 0: case 1: t = op; break;
+                    case 4: _.label++; return { value: op[1], done: false };
+                    case 5: _.label++; y = op[1]; op = [0]; continue;
+                    case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                    default:
+                        if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                        if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                        if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                        if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                        if (t[2]) _.ops.pop();
+                        _.trys.pop(); continue;
+                }
+                op = body.call(thisArg, _);
+            } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+            if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+        }
+    }
 
     var UNKNOWN_FUNCTION = '<unknown>';
     /**
@@ -232,24 +270,31 @@
             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 getSourceForBacktrace(backtrace, getSourceFileHandler) {
+        return __awaiter(this, void 0, void 0, function () {
+            var result, index, trace, fileContent;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        result = [];
+                        if (!getSourceFileHandler || !backtrace || !backtrace.length) {
+                            return [2 /*return*/, result];
+                        }
+                        index = 0;
+                        _a.label = 1;
+                    case 1:
+                        if (!backtrace.length) return [3 /*break*/, 3];
+                        trace = backtrace.splice(0)[index];
+                        return [4 /*yield*/, getSourceFileHandler(trace.file)];
+                    case 2:
+                        fileContent = _a.sent();
+                        result[index] = getSourceCodeSnippet(fileContent, trace.number);
+                        index++;
+                        return [3 /*break*/, 1];
+                    case 3: return [2 /*return*/, result];
+                }
+            });
+        });
     }
     function runBeforeNotifyHandlers(notice, handlers) {
         var result = true;
@@ -434,8 +479,8 @@
             //   User-Agent: Mozilla/5.0 (Linux; Android 10; SAMSUNG SM-G960F) AppleWebKit/537.36 (KHTML, like Gecko) SamsungBrowser/12.1 Chrome/79.0.3945.136 Mobile Safari/537.36
         }
     }
-    function endpoint(config, path) {
-        var endpoint = config.endpoint.trim().replace(/\/$/, '');
+    function endpoint(base, path) {
+        var endpoint = base.trim().replace(/\/$/, '');
         path = path.trim().replace(/(^\/|\/$)/g, '');
         return "".concat(endpoint, "/").concat(path);
     }
@@ -567,6 +612,9 @@
         }
         return result;
     }
+    function isBrowserConfig(config) {
+        return config.async !== undefined;
+    }
 
     var GlobalStore = /** @class */ (function () {
         function GlobalStore(store) {
@@ -589,14 +637,14 @@
     var notifier = {
         name: 'honeybadger-js',
         url: 'https://github.com/honeybadger-io/honeybadger-js',
-        version: '4.0.0-beta.3'
+        version: '4.0.0'
     };
     // 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) {
+        function Client(opts, transport) {
             if (opts === void 0) { opts = {}; }
             this.__pluginsExecuted = false;
             this.__store = null;
@@ -606,11 +654,9 @@
             // 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.__transport = transport;
             this.logger = logger(this);
         }
-        Client.prototype.factory = function (_opts) {
-            throw (new Error('Must implement __factory in subclass'));
-        };
         Client.prototype.getVersion = function () {
             return notifier.version;
         };
@@ -684,6 +730,9 @@
                 this.logger.warn('could not send error report: no API key has been configured', notice);
                 preConditionError = new Error('missing API key');
             }
+            // we need to have the source file data before the beforeNotifyHandlers,
+            // in case they modify them
+            var sourceCodeData = notice && notice.backtrace ? notice.backtrace.map(function (trace) { return shallowClone(trace); }) : null;
             var beforeNotifyResult = runBeforeNotifyHandlers(notice, this.__beforeNotifyHandlers);
             if (!preConditionError && !beforeNotifyResult) {
                 this.logger.debug('skipping error report: beforeNotify handlers returned false', notice);
@@ -703,14 +752,41 @@
             });
             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 ? notice.backtrace.map(function (trace) { return shallowClone(trace); }) : null;
-            getSourceForBacktrace(sourceCodeData, this.__getSourceFileHandler, function (sourcePerTrace) {
+            getSourceForBacktrace(sourceCodeData, this.__getSourceFileHandler)
+                .then(function (sourcePerTrace) {
                 sourcePerTrace.forEach(function (source, index) {
                     notice.backtrace[index].source = source;
                 });
-                _this.__send(notice);
+                var payload = _this.__buildPayload(notice);
+                _this.__transport
+                    .send({
+                    headers: {
+                        'X-API-Key': _this.config.apiKey,
+                        'Content-Type': 'application/json',
+                        'Accept': 'text/json, application/json'
+                    },
+                    method: 'POST',
+                    endpoint: endpoint(_this.config.endpoint, '/v1/notices/js'),
+                    maxObjectDepth: _this.config.maxObjectDepth,
+                    logger: _this.logger,
+                    async: isBrowserConfig(_this.config) ? _this.config.async : undefined,
+                }, payload)
+                    .then(function (res) {
+                    if (res.statusCode !== 201) {
+                        runAfterNotifyHandlers(notice, _this.__afterNotifyHandlers, new Error("Bad HTTP response: ".concat(res.statusCode)));
+                        _this.logger.warn("Error report failed: unknown response from server. code=".concat(res.statusCode));
+                        return;
+                    }
+                    var uuid = JSON.parse(res.body).id;
+                    runAfterNotifyHandlers(merge(notice, {
+                        id: uuid
+                    }), _this.__afterNotifyHandlers);
+                    _this.logger.info("Error report sent \u26A1 https://app.honeybadger.io/notice/".concat(uuid));
+                })
+                    .catch(function (err) {
+                    _this.logger.error('Error report failed: an unknown error occurred.', "message=".concat(err.message));
+                    runAfterNotifyHandlers(notice, _this.__afterNotifyHandlers, err);
+                });
             });
             return true;
         };
@@ -778,7 +854,7 @@
             }
             var context = this.__getStoreContentsOrDefault().context;
             var noticeTags = this.__constructTags(notice.tags);
-            var contextTags = this.__constructTags(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);
@@ -830,9 +906,6 @@
             }
             return (this.config.environment && this.config.developmentEnvironments.includes(this.config.environment));
         };
-        Client.prototype.__send = function (_notice) {
-            throw (new Error('Must implement send in subclass'));
-        };
         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);
@@ -1494,11 +1567,37 @@
         };
     }
 
+    var BrowserTransport = /** @class */ (function () {
+        function BrowserTransport() {
+        }
+        BrowserTransport.prototype.send = function (options, payload) {
+            return new Promise(function (resolve, reject) {
+                try {
+                    var x_1 = new XMLHttpRequest();
+                    x_1.open(options.method, options.endpoint, options.async);
+                    if (Object.keys(options.headers || []).length) {
+                        for (var i in options.headers) {
+                            if (typeof options.headers[i] !== 'undefined') {
+                                x_1.setRequestHeader(i, String(options.headers[i]));
+                            }
+                        }
+                    }
+                    x_1.send(payload ? JSON.stringify(sanitize(payload, options.maxObjectDepth)) : undefined);
+                    x_1.onload = function () { return resolve({ statusCode: x_1.status, body: x_1.response }); };
+                }
+                catch (err) {
+                    reject(err);
+                }
+            });
+        };
+        return BrowserTransport;
+    }());
+
     var Honeybadger = /** @class */ (function (_super) {
         __extends(Honeybadger, _super);
         function Honeybadger(opts) {
             if (opts === void 0) { opts = {}; }
-            var _this = _super.call(this, __assign({ async: true, maxErrors: null, projectRoot: window.location.protocol + '//' + window.location.host }, opts)) || this;
+            var _this = _super.call(this, __assign({ async: true, maxErrors: null, projectRoot: window.location.protocol + '//' + window.location.host }, opts), new BrowserTransport()) || this;
             /** @internal */
             _this.__errorsSent = 0;
             /** @internal */
@@ -1513,6 +1612,7 @@
                     if (!notice.url) {
                         notice.url = document.URL;
                     }
+                    _this.__incrementErrorsCount();
                     return true;
                 }
             ];
@@ -1528,6 +1628,9 @@
         Honeybadger.prototype.factory = function (opts) {
             return new Honeybadger(opts);
         };
+        Honeybadger.prototype.checkIn = function (_id) {
+            throw new Error('Honeybadger.checkIn() is not supported on the browser');
+        };
         /** @internal */
         Honeybadger.prototype.__buildPayload = function (notice) {
             var cgiData = {
@@ -1553,36 +1656,6 @@
             payload.request.cgi_data = merge(cgiData, payload.request.cgi_data);
             return payload;
         };
-        /** @internal */
-        Honeybadger.prototype.__send = function (notice) {
-            var _this = this;
-            this.__incrementErrorsCount();
-            var payload = this.__buildPayload(notice);
-            try {
-                var x_1 = new XMLHttpRequest();
-                x_1.open('POST', endpoint(this.config, '/v1/notices/js'), this.config.async);
-                x_1.setRequestHeader('X-API-Key', this.config.apiKey);
-                x_1.setRequestHeader('Content-Type', 'application/json');
-                x_1.setRequestHeader('Accept', 'text/json, application/json');
-                x_1.send(JSON.stringify(sanitize(payload, this.config.maxObjectDepth)));
-                x_1.onload = function () {
-                    if (x_1.status !== 201) {
-                        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;
-                    }
-                    var uuid = JSON.parse(x_1.response).id;
-                    runAfterNotifyHandlers(merge(notice, {
-                        id: uuid
-                    }), _this.__afterNotifyHandlers);
-                    _this.logger.debug("Error report sent \u26A1 https://app.honeybadger.io/notice/".concat(uuid));
-                };
-            }
-            catch (err) {
-                runAfterNotifyHandlers(notice, this.__afterNotifyHandlers, err);
-                this.logger.error('Unable to send error report: error while initializing request', err, notice);
-            }
-        };
         /**
          * wrap always returns the same function so that callbacks can be removed via
          * removeEventListener.