@honeybadger-io/js 4.0.0-beta.2 → 4.0.0-beta.5

package/dist/server/honeybadger.js

@@ -570,7 +570,7 @@ var GlobalStore$1 = /** @class */ (function () {
 var notifier = {
     name: 'honeybadger-js',
     url: 'https://github.com/honeybadger-io/honeybadger-js',
-    version: '4.0.0-beta.2'
+    version: '4.0.0-beta.5'
 };
 // Split at commas and spaces
 var TAG_SEPARATOR = /,|\s+/;
@@ -682,7 +682,7 @@ var Client = /** @class */ (function () {
                 stack: notice.stack
             }
         });
-        var breadcrumbs = this.__getStoreOrDefaultObject().breadcrumbs;
+        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
@@ -757,7 +757,7 @@ var Client = /** @class */ (function () {
         if (objectIsEmpty(notice)) {
             return null;
         }
-        var context = this.__getStoreOrDefaultObject().context;
+        var context = this.__getStoreContentsOrDefault().context;
         var noticeTags = this.__constructTags(notice.tags);
         var contextTags = this.__constructTags(context["tags"]);
         var configTags = this.__constructTags(this.config.tags);
@@ -858,13 +858,13 @@ var Client = /** @class */ (function () {
     /**
      * 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.
+     * Returns *a copy* of the store contents.
      * @internal
      */
-    Client.prototype.__getStoreOrDefaultObject = function () {
-        var existingStore = this.__store.getStore();
-        var store = existingStore || {};
-        return __assign({ context: {}, breadcrumbs: [] }, store);
+    Client.prototype.__getStoreContentsOrDefault = function () {
+        var existingStoreContents = this.__store.getStore();
+        var storeContents = existingStoreContents || {};
+        return __assign({ context: {}, breadcrumbs: [] }, storeContents);
     };
     return Client;
 }());
@@ -1078,7 +1078,7 @@ function fullUrl(req) {
     });
 }
 function requestHandler(req, res, next) {
-    this.run(next, next);
+    this.withRequest(req, next, next);
 }
 function errorHandler(err, req, _res, next) {
     this.notify(err, {
@@ -1091,9 +1091,12 @@ function errorHandler(err, req, _res, next) {
             REQUEST_METHOD: req.method
         }
     });
-    return next(err);
+    if (next) {
+        return next(err);
+    }
 }
 
+var kHoneybadgerStore = Symbol.for("kHoneybadgerStore");
 var Honeybadger = /** @class */ (function (_super) {
     __extends(Honeybadger, _super);
     function Honeybadger(opts) {
@@ -1165,11 +1168,20 @@ var Honeybadger = /** @class */ (function (_super) {
             req.end();
         });
     };
+    // This method is intended for web frameworks.
+    // It allows us to track context for individual requests without leaking to other requests
+    // by doing two things:
+    // 1. Using AsyncLocalStorage so the context is tracked across async operations.
+    // 2. Attaching the store contents to the request object,
+    //   so, even if the store is destroyed, we can still recover the context for a given request
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    Honeybadger.prototype.run = function (handler, onError) {
+    Honeybadger.prototype.withRequest = function (request, handler, onError) {
         var _this = this;
-        var storeObject = this.__getStoreOrDefaultObject();
+        var storeObject = (request[kHoneybadgerStore] || this.__getStoreContentsOrDefault());
         this.__setStore(AsyncStore);
+        if (!request[kHoneybadgerStore]) {
+            request[kHoneybadgerStore] = storeObject;
+        }
         if (onError) {
             // ALS is fine for context-tracking, but `domain` allows us to catch errors
             // thrown asynchronously (timers, event emitters)

package/dist/server/types/core/client.d.ts

@@ -1,6 +1,6 @@
 import { Config, Logger, BeforeNotifyHandler, AfterNotifyHandler, Notice, Noticeable, HoneybadgerStore, BreadcrumbRecord } from './types';
 export default class Client {
-    private __pluginsExecuted;
+    protected __pluginsExecuted: boolean;
     protected __store: HoneybadgerStore<{
         context: Record<string, unknown>;
         breadcrumbs: BreadcrumbRecord[];

package/dist/server/types/core/types.d.ts

@@ -91,3 +91,7 @@ export interface CGIData {
     [x: string]: unknown;
 }
 export declare type HoneybadgerStore<T> = Pick<AsyncLocalStorage<T>, 'getStore' | 'run'>;
+export declare type DefaultStoreContents = {
+    context: Record<string, unknown>;
+    breadcrumbs: BreadcrumbRecord[];
+};

package/dist/server/types/server.d.ts

@@ -8,7 +8,7 @@ declare class Honeybadger extends Client {
     lambdaHandler: typeof lambdaHandler;
     constructor(opts?: Partial<Config>);
     factory(opts?: Partial<Config>): Honeybadger;
-    run<R>(handler: (...args: never[]) => R, onError?: (...args: any[]) => any): R | void;
+    withRequest<R>(request: Record<symbol, unknown>, handler: (...args: never[]) => R, onError?: (...args: any[]) => any): R | void;
 }
 declare const _default: Honeybadger;
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@honeybadger-io/js",
-  "version": "4.0.0-beta.2",
+  "version": "4.0.0-beta.5",
   "license": "MIT",
   "homepage": "https://github.com/honeybadger-io/honeybadger-js",
   "author": {
@@ -29,7 +29,7 @@
     "url": "https://github.com/honeybadger-io/honeybadger-js/issues"
   },
   "scripts": {
-    "prepare": "npm run build",
+    "prepare": "npm run build && husky install",
     "test": "concurrently \"npm:test:browser\" \"npm:test:server\"",
     "test:browser": "jest --env=jsdom --testPathPattern=\"test/unit/.*(?<![\\./]server)\\.test\\.(js|ts)\"",
     "test:server": "jest --env=node --testPathPattern=\"test/unit/.*(?<![\\./]browser)\\.test\\.(js|ts)\"",
@@ -45,6 +45,8 @@
     "stacktrace-parser": "^0.1.10"
   },
   "devDependencies": {
+    "@commitlint/cli": "^16.2.3",
+    "@commitlint/config-conventional": "^16.2.1",
     "@rollup/plugin-node-resolve": "^13.0.6",
     "@rollup/plugin-replace": "^4.0.0",
     "@rollup/plugin-typescript": "^8.3.0",
@@ -61,15 +63,16 @@
     "eslint-plugin-jest": "^26.0.0",
     "eslint-plugin-promise": "^6.0.0",
     "express": "^4.17.1",
+    "husky": "^7.0.4",
     "jest": "^27.4.4",
     "nock": "^13.2.1",
     "rollup": "^2.61.1",
     "rollup-plugin-uglify": "^6.0.2",
-    "shipjs": "0.24.3",
+    "shipjs": "0.24.4",
     "sinon": "^13.0.1",
     "supertest": "^6.1.6",
     "ts-jest": "^27.1.1",
-    "tsd": "^0.19.0",
+    "tsd": "^0.20.0",
     "tslib": "^2.3.1",
     "typescript": "^4.5.3"
   },