refactor(core): Extract shared modules and utilities

- fetchTimer function moved to @hawk.so/core
- StackParser moved to @hawk.so/core
- Transport moved to @hawk.so/core
- event utility functions moved to @hawk.so/core
- selector utility functions moved to @hawk.so/core
- EventRejectedError moved to @hawk.so/core
- suppress error-logs by StackParser in tests

Author: Reversean

packages/javascript/src/errors.ts packages/core/src/errors.tspackages/javascript/src/errors.ts renamed to packages/core/src/errors.ts

@@ -5,3 +5,9 @@ export type { Logger, LogType } from './logger/logger';
 export { isLoggerSet, setLogger, resetLogger, log } from './logger/logger';
 export { isPlainObject, validateUser, validateContext, isValidEventPayload, isValidBreadcrumb } from './utils/validation';
 export { Sanitizer } from './modules/sanitizer';
+export type { SanitizerTypeHandler } from './modules/sanitizer';
+export { StackParser } from './modules/stack-parser';
+export { buildElementSelector } from './utils/selector';
+export type { Transport } from './transports/transport';
+export { EventRejectedError } from './errors';
+export { isErrorProcessed, markErrorAsProcessed } from './utils/event';

packages/core/src/index.ts

@@ -1,4 +1,4 @@
-import { log } from '@hawk.so/core';
+import { log } from '../logger/logger';
 
 /**
  * Sends AJAX request and wait for some time.

…ges/javascript/src/modules/fetchTimer.ts packages/core/src/modules/fetch-timer.tspackages/javascript/src/modules/fetchTimer.ts renamed to packages/core/src/modules/fetch-timer.ts packages/javascript/src/modules/fetchTimer.ts renamed to packages/core/src/modules/fetch-timer.ts

@@ -1,12 +1,12 @@
 import type { StackFrame } from 'error-stack-parser';
 import ErrorStackParser from 'error-stack-parser';
 import type { BacktraceFrame, SourceCodeLine } from '@hawk.so/types';
-import fetchTimer from './fetchTimer';
+import fetchTimer from './fetch-timer';
 
 /**
  * This module prepares parsed backtrace
  */
-export default class StackParser {
+export class StackParser {
   /**
    * Prevents loading one file several times
    * name -> content
@@ -48,7 +48,7 @@ export default class StackParser {
     try {
       if (!frame.fileName) {
         return null;
-      };
+      }
 
       if (!this.isValidUrl(frame.fileName)) {
         return null;
@@ -118,9 +118,9 @@ export default class StackParser {
   /**
    * Downloads source file
    *
-   * @param {string} fileName - name of file to download
+   * @param fileName - name of file to download
    */
-  private async loadSourceFile(fileName): Promise<string | null> {
+  private async loadSourceFile(fileName: string): Promise<string | null> {
     if (this.sourceFilesCache[fileName] !== undefined) {
       return this.sourceFilesCache[fileName];
     }

…es/javascript/src/modules/stackParser.ts packages/core/src/modules/stack-parser.tspackages/javascript/src/modules/stackParser.ts renamed to packages/core/src/modules/stack-parser.ts packages/javascript/src/modules/stackParser.ts renamed to packages/core/src/modules/stack-parser.ts

@@ -0,0 +1,8 @@
+import type { CatcherMessage, CatcherMessageType } from '@hawk.so/types';
+
+/**
+ * Transport interface — anything that can send a CatcherMessage
+ */
+export interface Transport<T extends CatcherMessageType> {
+  send(message: CatcherMessage<T>): Promise<void>;
+}

packages/core/src/transports/transport.ts

@@ -1,12 +1,12 @@
-import { log } from '@hawk.so/core';
+import { log } from '../logger/logger';
 
 /**
  * Symbol to mark error as processed by Hawk
  */
 const errorSentShadowProperty = Symbol('__hawk_processed__');
 
 /**
- * Check if the error has alrady been sent to Hawk.
+ * Check if the error has already been sent to Hawk.
  *
  * Motivation:
  * Some integrations may catch errors on their own side and then normally re-throw them down.
@@ -20,7 +20,7 @@ export function isErrorProcessed(error: unknown): boolean {
     return false;
   }
 
-  return error[errorSentShadowProperty] === true;
+  return (error as Record<symbol, unknown>)[errorSentShadowProperty] === true;
 }
 
 /**
@@ -35,7 +35,7 @@ export function markErrorAsProcessed(error: unknown): void {
     }
 
     Object.defineProperty(error, errorSentShadowProperty, {
-      enumerable: false, // Prevent from beight collected by Hawk
+      enumerable: false,  // Prevent from being collected by Hawk
       value: true,
       writable: true,
       configurable: true,

packages/javascript/src/utils/event.ts packages/core/src/utils/event.tspackages/javascript/src/utils/event.ts renamed to packages/core/src/utils/event.ts

@@ -1,4 +1,5 @@
 import { describe, expect, it } from 'vitest';
+<<<<<<<< HEAD:packages/core/tests/modules/sanitizer.test.ts
 import { Sanitizer } from '../../src';
 
 describe('Sanitizer', () => {
@@ -87,32 +88,30 @@ describe('Sanitizer', () => {
 
     it('should format a class (not constructed) as "<class Name>"', () => {
       class Foo {}
+========
+import { Sanitizer } from '@hawk.so/core';
+import '../../src/modules/element-sanitizer';
 
-      expect(Sanitizer.sanitize(Foo)).toBe('<class Foo>');
-    });
-
-    it('should format a class instance as "<instance of Name>"', () => {
-      class Foo {}
+describe('Browser Sanitizer handlers', () => {
+  describe('Element handler', () => {
+    it('should format an empty HTML element as its outer HTML', () => {
+      const el = document.createElement('div');
+      const result = Sanitizer.sanitize(el);
 
-      expect(Sanitizer.sanitize(new Foo())).toBe('<instance of Foo>');
+      expect(typeof result).toBe('string');
+      expect(result).toMatch(/^<div/);
     });
 
-    it('should replace circular references with placeholder', () => {
-      const obj: any = { a: 1 };
+    it('should replace inner HTML content with ellipsis', () => {
+      const el = document.createElement('div');
+>>>>>>>> 8070fac (refactor(core): Extract shared modules and utilities):packages/javascript/tests/modules/sanitizer.test.ts
 
-      obj.self = obj;
+      el.innerHTML = '<span>some long content</span>';
 
-      const result = Sanitizer.sanitize(obj);
-
-      expect(result.self).toBe('<circular>');
-    });
+      const result = Sanitizer.sanitize(el);
 
-    it.each([
-      { label: 'number', value: 42 },
-      { label: 'boolean', value: true },
-      { label: 'null', value: null },
-    ])('should pass through $label primitives unchanged', ({ value }) => {
-      expect(Sanitizer.sanitize(value)).toBe(value);
+      expect(result).toContain('…');
+      expect(result).not.toContain('some long content');
     });
   });
 });

packages/javascript/src/utils/selector.ts packages/core/src/utils/selector.tspackages/javascript/src/utils/selector.ts renamed to packages/core/src/utils/selector.ts

@@ -2,8 +2,7 @@
  * @file Breadcrumbs module - captures chronological trail of events before an error
  */
 import type { Breadcrumb, BreadcrumbLevel, BreadcrumbType, Json, JsonNode } from '@hawk.so/types';
-import { isValidBreadcrumb, log, Sanitizer } from '@hawk.so/core';
-import { buildElementSelector } from '../utils/selector';
+import { buildElementSelector, isValidBreadcrumb, log, Sanitizer } from '@hawk.so/core';
 
 /**
  * Default maximum number of breadcrumbs to store

packages/core/tests/modules/sanitizer.test.ts

@@ -1,6 +1,5 @@
 import './modules/element-sanitizer';
 import Socket from './modules/socket';
-import StackParser from './modules/stackParser';
 import type { BreadcrumbsAPI, CatcherMessage, HawkInitialSettings, HawkJavaScriptEvent, Transport } from './types';
 import { VueIntegration } from './integrations/vue';
 import type {
@@ -12,24 +11,26 @@ import type {
   Json,
   VueIntegrationAddons
 } from '@hawk.so/types';
-import type { JavaScriptCatcherIntegrations } from './types/integrations';
-import { EventRejectedError } from './errors';
-import { isErrorProcessed, markErrorAsProcessed } from './utils/event';
-import { BrowserRandomGenerator } from './utils/random';
+import type { JavaScriptCatcherIntegrations } from '@/types';
 import { ConsoleCatcher } from './addons/consoleCatcher';
 import { BreadcrumbManager } from './addons/breadcrumbs';
 import {
+  EventRejectedError,
   HawkUserManager,
+  isErrorProcessed,
   isLoggerSet,
   isValidEventPayload,
   log,
+  markErrorAsProcessed,
   Sanitizer,
   setLogger,
+  StackParser,
   validateContext,
   validateUser
 } from '@hawk.so/core';
 import { HawkLocalStorage } from './storages/hawk-local-storage';
 import { createBrowserLogger } from './logger/logger';
+import { BrowserRandomGenerator } from './utils/random';
 
 /**
  * Allow to use global VERSION, that will be overwritten by Webpack
@@ -63,7 +64,7 @@ export default class Catcher {
   /**
    * Catcher Type
    */
-  private readonly type: string = 'errors/javascript';
+  private readonly type = 'errors/javascript' as const;
 
   /**
    * User project's Integration Token
@@ -516,7 +517,7 @@ export default class Catcher {
      * and reject() provided with text reason instead of Error()
      */
     if (notAnError) {
-      return null;
+      return undefined;
     }
 
     return (error as Error).name;
@@ -526,7 +527,7 @@ export default class Catcher {
    * Release version
    */
   private getRelease(): HawkJavaScriptEvent['release'] {
-    return this.release !== undefined ? String(this.release) : null;
+    return this.release !== undefined ? String(this.release) : undefined;
   }
 
   /**
@@ -579,7 +580,7 @@ export default class Catcher {
   private getBreadcrumbsForEvent(): HawkJavaScriptEvent['breadcrumbs'] {
     const breadcrumbs = this.breadcrumbManager?.getBreadcrumbs();
 
-    return breadcrumbs && breadcrumbs.length > 0 ? breadcrumbs : null;
+    return breadcrumbs && breadcrumbs.length > 0 ? breadcrumbs : undefined;
   }
 
   /**
@@ -619,15 +620,15 @@ export default class Catcher {
      * and reject() provided with text reason instead of Error()
      */
     if (notAnError) {
-      return null;
+      return undefined;
     }
 
     try {
       return await this.stackParser.parse(error as Error);
     } catch (e) {
       log('Can not parse stack:', 'warn', e);
 
-      return null;
+      return undefined;
     }
   }
 
@@ -694,6 +695,6 @@ export default class Catcher {
    * @param integrationAddons - extra addons
    */
   private appendIntegrationAddons(errorFormatted: CatcherMessage, integrationAddons: JavaScriptCatcherIntegrations): void {
-    Object.assign(errorFormatted.payload.addons, integrationAddons);
+    Object.assign(errorFormatted.payload.addons!, integrationAddons);
   }
 }