refactor: init BreadcrumbStore in BrowserBreadcrumbsMessageProcessor

Author: Reversean

packages/core/src/index.ts

@@ -12,5 +12,4 @@ export { StackParser } from './modules/stack-parser';
 export { buildElementSelector } from './utils/selector';
 export { isErrorProcessed, markErrorAsProcessed } from './utils/event';
 export type { BreadcrumbStore, BreadcrumbsAPI, BreadcrumbHint, BreadcrumbInput } from './breadcrumbs/breadcrumb-store';
-export type { ErrorSnapshot, MessageProcessor, ProcessingPayload } from './messages/message-processor';
-export { BreadcrumbsMessageProcessor } from './messages/breadcrumbs-message-processor';
+export type { MessageProcessor, ProcessingPayload } from './messages/message-processor';

packages/core/src/messages/breadcrumbs-message-processor.ts

@@ -21,22 +21,6 @@ export type ProcessingPayload<T extends CatcherMessageType> =
     addons: Partial<ExtractAddons<T>>;
   };
 
-/**
- * Snapshot of event context captured synchronously at error time,
- * before any processing.
- */
-export interface ErrorSnapshot {
-  /**
-   * Original caught error.
-   */
-  error?: Error | string;
-
-  /**
-   * Breadcrumbs captured at error time.
-   */
-  breadcrumbs?: Breadcrumb[];
-}
-
 /**
  * Single step in message processing pipeline before message is sent.
  *
@@ -49,11 +33,11 @@ export interface MessageProcessor<T extends CatcherMessageType = CatcherMessageT
    * Dropped message won't be sent.
    *
    * @param payload - processed event message payload with partially-built addons
-   * @param snapshot - additional context with original error
+   * @param error - original error
    * @returns modified payload, or `null` to drop message
    */
   apply(
     payload: ProcessingPayload<T>,
-    snapshot?: ErrorSnapshot,
+    error?: Error | string,
   ): ProcessingPayload<T> | null
 }

packages/core/src/messages/message-processor.ts

@@ -15,7 +15,6 @@ import { ConsoleCatcher } from './addons/consoleCatcher';
 import { BrowserBreadcrumbStore } from './addons/breadcrumbs';
 import type { BreadcrumbStore, MessageProcessor, ProcessingPayload } from '@hawk.so/core';
 import {
-  BreadcrumbsMessageProcessor,
   HawkUserManager,
   isErrorProcessed,
   isLoggerSet,
@@ -34,6 +33,7 @@ import { BrowserRandomGenerator } from './utils/random';
 import { BrowserAddonMessageProcessor } from './messages/browser-addon-message-processor';
 import { ConsoleOutputAddonMessageProcessor } from './messages/console-output-addon-message-processor';
 import { DebugAddonMessageProcessor } from './messages/debug-addon-message-processor';
+import { BrowserBreadcrumbsMessageProcessor } from './messages/browser-breadcrumbs-message-processor';
 
 /**
  * Allow to use global VERSION, that will be overwritten by Webpack
@@ -126,7 +126,7 @@ export default class Catcher {
   /**
    * Breadcrumb store instance
    */
-  private readonly breadcrumbStore: BrowserBreadcrumbStore | null;
+  private readonly breadcrumbStore: BrowserBreadcrumbStore | null = null;
 
   /**
    * Manages currently authenticated user identity.
@@ -207,10 +207,7 @@ export default class Catcher {
      */
     if (settings.breadcrumbs !== false) {
       this.breadcrumbStore = BrowserBreadcrumbStore.getInstance();
-      this.breadcrumbStore.init(settings.breadcrumbs ?? {});
-      this.messageProcessors.push(new BreadcrumbsMessageProcessor());
-    } else {
-      this.breadcrumbStore = null;
+      this.messageProcessors.push(new BrowserBreadcrumbsMessageProcessor(settings.breadcrumbs ?? {}));
     }
 
     if (this.debug) {
@@ -409,14 +406,10 @@ export default class Catcher {
         markErrorAsProcessed(error);
       }
 
-      const snapshot = {
-        error,
-        breadcrumbs: this.breadcrumbStore?.get()
-      };
       let processingPayload = await this.buildBasePayload(error, context);
 
       for (const processor of this.messageProcessors) {
-        const result = processor.apply(processingPayload, snapshot);
+        const result = processor.apply(processingPayload, error);
 
         if (result === null) {
           return;

packages/javascript/src/catcher.ts

@@ -0,0 +1,30 @@
+import type { MessageProcessor, ProcessingPayload } from '@hawk.so/core';
+import { BreadcrumbsOptions, BrowserBreadcrumbStore } from '../addons/breadcrumbs';
+
+/**
+ * Attaches breadcrumbs to payload.
+ */
+export class BrowserBreadcrumbsMessageProcessor implements MessageProcessor<'errors/javascript'> {
+
+  constructor(options: BreadcrumbsOptions = {}) {
+    const breadcrumbStore = BrowserBreadcrumbStore.getInstance();
+    breadcrumbStore.init(options);
+  }
+
+  /**
+   * Sets `payload.breadcrumbs` from snapshot if non-empty; skips otherwise.
+   *
+   * @param payload - event message payload to enrich
+   * @returns modified payload with breadcrumbs set, or original payload unchanged
+   */
+  public apply(
+    payload: ProcessingPayload<'errors/javascript'>
+  ): ProcessingPayload<'errors/javascript'> | null {
+    const breadcrumbs = BrowserBreadcrumbStore.getInstance().get();
+    if (breadcrumbs.length > 0) {
+      payload.breadcrumbs = breadcrumbs;
+    }
+
+    return payload;
+  }
+}

packages/javascript/src/messages/browser-breadcrumbs-message-processor.ts

@@ -1,4 +1,4 @@
-import type { ErrorSnapshot, MessageProcessor, ProcessingPayload } from '@hawk.so/core';
+import type { MessageProcessor, ProcessingPayload } from '@hawk.so/core';
 
 /**
  * Appends `RAW_EVENT_DATA` to the event addons for debug purposes.
@@ -9,21 +9,21 @@ export class DebugAddonMessageProcessor implements MessageProcessor<'errors/java
    * Skips if snapshot error is missing or not Error instance.
    *
    * @param payload - event message payload to enrich
-   * @param snapshot - snapshot carrying original caught error
+   * @param error - original error
    * @returns modified payload with RAW_EVENT_DATA set, or original payload unchanged
    */
   public apply(
     payload: ProcessingPayload<'errors/javascript'>,
-    snapshot?: ErrorSnapshot
+    error?: Error | string,
   ): ProcessingPayload<'errors/javascript'> | null {
-    if (!(snapshot?.error instanceof Error)) {
+    if (!(error instanceof Error)) {
       return payload;
     }
 
     payload.addons.RAW_EVENT_DATA = {
-      name: snapshot.error.name,
-      message: snapshot.error.message,
-      stack: snapshot.error.stack ?? '',
+      name: error.name,
+      message: error.message,
+      stack: error.stack ?? '',
     };
 
     return payload;

packages/javascript/src/messages/debug-addon-message-processor.ts

@@ -11,7 +11,8 @@ describe('Catcher', () => {
   beforeEach(() => {
     localStorage.clear();
     mockParse.mockResolvedValue([]);
-    (BrowserBreadcrumbStore as any).instance?.destroy();
+    BrowserBreadcrumbStore.getInstance().clear();
+    // (BrowserBreadcrumbStore as any).instance?.destroy();
   });
 
   // ── Breadcrumbs trail ─────────────────────────────────────────────────────
@@ -21,7 +22,7 @@ describe('Catcher', () => {
   describe('breadcrumbs trail', () => {
     it('should include recorded breadcrumbs', async () => {
       const { sendSpy, transport } = createTransport();
-      const hawk = createCatcher(transport, { breadcrumbs: {} });
+      const hawk = createCatcher(transport, { breadcrumbs: { trackFetch: false } });
 
       hawk.breadcrumbs.add({ message: 'button clicked', timestamp: Date.now() });
       hawk.send(new Error('e'));
@@ -36,7 +37,7 @@ describe('Catcher', () => {
     it('should omit breadcrumbs when none have been recorded', async () => {
       const { sendSpy, transport } = createTransport();
 
-      createCatcher(transport, { breadcrumbs: {} }).send(new Error('e'));
+      createCatcher(transport, { breadcrumbs: { trackFetch: false } }).send(new Error('e'));
       await wait();
 
       expect(getLastPayload(sendSpy).breadcrumbs).toBeFalsy();
@@ -50,7 +51,7 @@ describe('Catcher', () => {
 
     it('should omit breadcrumbs cleared before payload was sent', async () => {
       const { sendSpy, transport } = createTransport();
-      const hawk = createCatcher(transport, { breadcrumbs: {} });
+      const hawk = createCatcher(transport, { breadcrumbs: { trackFetch: false } });
 
       hawk.breadcrumbs.add({ message: 'click', timestamp: Date.now() });
       hawk.breadcrumbs.clear();

packages/javascript/tests/catcher.breadcrumbs.test.ts

@@ -1,25 +1,26 @@
-import { describe, expect, it } from 'vitest';
-import { BreadcrumbsMessageProcessor } from '@hawk.so/core';
+import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { makePayload } from './message-processor.helpers';
+import { BrowserBreadcrumbsMessageProcessor } from '../../src/messages/browser-breadcrumbs-message-processor';
+import { BrowserBreadcrumbStore } from '../../src/addons/breadcrumbs';
 
 describe('BreadcrumbsMessageProcessor', () => {
-  const processor = new BreadcrumbsMessageProcessor();
+  const processor = new BrowserBreadcrumbsMessageProcessor();
 
-  it('should attach breadcrumbs from snapshot to payload', () => {
-    const breadcrumbs = [{ message: 'click', timestamp: 1 }];
-
-    const result = processor.apply(makePayload(), { breadcrumbs });
-
-    expect(result?.breadcrumbs).toEqual(breadcrumbs);
+  beforeEach(() => {
+    BrowserBreadcrumbStore.getInstance().clear()
   });
 
-  it('should not set payload breadcrumbs when snapshot has empty array', () => {
-    const result = processor.apply(makePayload(), { breadcrumbs: [] });
+  it('should attach breadcrumbs from snapshot to payload', () => {
+    const breadcrumbs = { message: 'click', timestamp: 1 };
+    BrowserBreadcrumbStore.getInstance().add(breadcrumbs)
 
-    expect(result?.breadcrumbs).toBeUndefined();
+    const result = processor.apply(makePayload());
+
+    expect(result?.breadcrumbs).toHaveLength(1)
+    expect(result?.breadcrumbs).toContainEqual(breadcrumbs);
   });
 
-  it('should not set payload breadcrumbs when snapshot is absent', () => {
+  it('should not set payload breadcrumbs when breadcrumb store is empty', () => {
     const result = processor.apply(makePayload());
 
     expect(result?.breadcrumbs).toBeUndefined();

packages/javascript/tests/messages/breadcrumbs-message-processor.test.ts

@@ -8,7 +8,7 @@ describe('DebugMessageProcessor', () => {
   it('should add RAW_EVENT_DATA when hint.error is an Error instance', () => {
     const error = new TypeError('boom');
 
-    const result = processor.apply(makePayload(), { error });
+    const result = processor.apply(makePayload(), error);
 
     expect(result?.addons?.RAW_EVENT_DATA).toMatchObject({
       name: 'TypeError',
@@ -18,7 +18,7 @@ describe('DebugMessageProcessor', () => {
   });
 
   it('should not add RAW_EVENT_DATA when hint.error is a string', () => {
-    const result = processor.apply(makePayload(), { error: 'string reason' });
+    const result = processor.apply(makePayload(), 'string reason');
 
     expect(result?.addons?.RAW_EVENT_DATA).toBeUndefined();
   });