fix: review fixes

- MessageHint renamed to ErrorSnapshot
- minor code style and naming issues fixed

Author: Reversean

packages/core/src/index.ts

@@ -13,5 +13,5 @@ export { buildElementSelector } from './utils/selector';
 export { EventRejectedError } from './errors';
 export { isErrorProcessed, markErrorAsProcessed } from './utils/event';
 export type { BreadcrumbStore, BreadcrumbsAPI, BreadcrumbHint, BreadcrumbInput } from './breadcrumbs/breadcrumb-store';
-export type { MessageHint, MessageProcessor, ProcessingPayload } from './messages/message-processor';
-export { BreadcrumbsMessageProcessor } from './messages/breadcrumbs-message-processor';;
+export type { ErrorSnapshot, MessageProcessor, ProcessingPayload } from './messages/message-processor';
+export { BreadcrumbsMessageProcessor } from './messages/breadcrumbs-message-processor';

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

@@ -1,22 +1,22 @@
-import type { MessageHint, MessageProcessor, ProcessingPayload } from './message-processor';
+import type { ErrorSnapshot, MessageProcessor, ProcessingPayload } from './message-processor';
 
 /**
- * Attaches breadcrumbs snapshot from {@link hint} to payload.
+ * Attaches breadcrumbs to payload.
  */
 export class BreadcrumbsMessageProcessor implements MessageProcessor<'errors/javascript'> {
   /**
-   * Sets `payload.breadcrumbs` from hint snapshot if non-empty; skips otherwise.
+   * Sets `payload.breadcrumbs` from snapshot if non-empty; skips otherwise.
    *
    * @param payload - event message payload to enrich
-   * @param hint - hint carrying breadcrumbs snapshot captured at error time
+   * @param snapshot - snapshot carrying breadcrumbs captured at error time
    * @returns modified payload with breadcrumbs set, or original payload unchanged
    */
   public apply(
     payload: ProcessingPayload<'errors/javascript'>,
-    hint?: MessageHint
+    snapshot?: ErrorSnapshot
   ): ProcessingPayload<'errors/javascript'> | null {
-    if (hint?.breadcrumbs && hint.breadcrumbs.length > 0) {
-      payload.breadcrumbs = hint.breadcrumbs;
+    if (snapshot?.breadcrumbs && snapshot.breadcrumbs.length > 0) {
+      payload.breadcrumbs = snapshot.breadcrumbs;
     }
 
     return payload;

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

@@ -25,7 +25,7 @@ export type ProcessingPayload<T extends CatcherMessageType> =
  * Snapshot of event context captured synchronously at error time,
  * before any processing.
  */
-export interface MessageHint {
+export interface ErrorSnapshot {
   /**
    * Original caught error.
    */
@@ -47,11 +47,11 @@ export interface MessageProcessor<T extends CatcherMessageType = CatcherMessageT
    * Handles input message. May mutate or replace it.
    *
    * @param payload - processed event message payload with partially-built addons
-   * @param hint - additional context about original error
+   * @param snapshot - additional context with original error
    * @returns modified payload, or `null` to drop event
    */
   apply(
     payload: ProcessingPayload<T>,
-    hint?: MessageHint,
+    snapshot?: ErrorSnapshot,
   ): ProcessingPayload<T> | null
 }

packages/javascript/src/catcher.ts

@@ -405,12 +405,14 @@ export default class Catcher {
         markErrorAsProcessed(error);
       }
 
-      const hint = { error,
-        breadcrumbs: this.breadcrumbStore?.get() };
+      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, hint);
+        const result = processor.apply(processingPayload, snapshot);
 
         if (result === null) {
           return;
@@ -428,16 +430,16 @@ export default class Catcher {
         };
       }
 
-      const filtered = this.applyBeforeSendHook(payload);
+      const payloadPostBeforeSend = this.applyBeforeSendHook(payload);
 
-      if (filtered === null) {
+      if (payloadPostBeforeSend === null) {
         return;
       }
 
       this.sendMessage({
         token: this.token,
         catcherType: Catcher.type,
-        payload: filtered,
+        payload: payloadPostBeforeSend,
       } as CatcherMessage<typeof Catcher.type>);
     } catch (e) {
       log('Unable to send error. Seems like it is Hawk internal bug. Please, report it here: https://github.com/codex-team/hawk.javascript/issues/new', 'warn', e);

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

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

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

@@ -5,21 +5,21 @@ import { makePayload } from './message-processor.helpers';
 describe('BreadcrumbsMessageProcessor', () => {
   const processor = new BreadcrumbsMessageProcessor();
 
-  it('should attach breadcrumbs from hint to payload', () => {
+  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);
   });
 
-  it('should not set payload breadcrumbs when hint has empty array', () => {
+  it('should not set payload breadcrumbs when snapshot has empty array', () => {
     const result = processor.apply(makePayload(), { breadcrumbs: [] });
 
     expect(result?.breadcrumbs).toBeUndefined();
   });
 
-  it('should not set payload breadcrumbs when hint is absent', () => {
+  it('should not set payload breadcrumbs when snapshot is absent', () => {
     const result = processor.apply(makePayload());
 
     expect(result?.breadcrumbs).toBeUndefined();