refactor(core): UserManager abstraction added

Author: Reversean

packages/core/package.json

@@ -17,7 +17,9 @@
     }
   },
   "scripts": {
-    "build": "vite build"
+    "build": "vite build",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
   },
   "repository": {
     "type": "git",
@@ -34,7 +36,9 @@
   },
   "homepage": "https://github.com/codex-team/hawk.javascript#readme",
   "devDependencies": {
+    "@vitest/coverage-v8": "^4.0.18",
     "vite": "^7.3.1",
-    "vite-plugin-dts": "^4.2.4"
+    "vite-plugin-dts": "^4.2.4",
+    "vitest": "^4.0.18"
   }
 }

packages/core/src/index.ts

@@ -0,0 +1,3 @@
+export type { HawkStorage } from './types/storage';
+export type { UserManager } from './types/user-manager';
+export { StorageUserManager } from './types/storage-user-manager';

packages/core/src/types/storage-user-manager.ts

@@ -0,0 +1,46 @@
+import { AffectedUser } from "@hawk.so/types";
+import { HawkStorage } from "./storage";
+import { UserManager } from "./user-manager";
+
+/**
+ * Storage key used to persist the user identifier.
+ */
+const HAWK_USER_STORAGE_KEY = 'hawk-user-id';
+
+/**
+ * {@link UserManager} implementation that persists the affected user
+ * via an injected {@link HawkStorage} backend.
+ */
+export class StorageUserManager implements UserManager {
+
+  /**
+   * Underlying storage used to read and write the user identifier.
+   */
+  private readonly storage: HawkStorage;
+
+  /**
+   * @param storage - Storage backend to use for persistence.
+   */
+  constructor(storage: HawkStorage) {
+    this.storage = storage;
+  }
+
+  getUser(): AffectedUser | null {
+    const storedId = this.storage.getItem(HAWK_USER_STORAGE_KEY);
+    if (storedId) {
+      return {
+        id: storedId,
+      };
+    }
+
+    return null;
+  }
+
+  setUser(user: AffectedUser): void {
+    this.storage.setItem(HAWK_USER_STORAGE_KEY, user.id);
+  }
+
+  clear(): void {
+    this.storage.removeItem(HAWK_USER_STORAGE_KEY)
+  }
+}

packages/core/src/types/storage.ts

@@ -0,0 +1,27 @@
+/**
+ * Abstract key–value storage contract used by Hawk internals
+ * (e.g. {@link StorageUserManager}) to persist data across sessions.
+ */
+export interface HawkStorage {
+  /**
+   * Returns the value associated with the given key, or `null` if none exists.
+   *
+   * @param key - Storage key to look up.
+   */
+  getItem(key: string): string | null
+
+  /**
+   * Persists a value under the given key.
+   *
+   * @param key - Storage key.
+   * @param value - Value to store.
+   */
+  setItem(key: string, value: string): void
+
+  /**
+   * Removes the entry for the given key.
+   *
+   * @param key - Storage key to remove.
+   */
+  removeItem(key: string): void
+}

packages/core/src/types/user-manager.ts

@@ -0,0 +1,26 @@
+import { AffectedUser } from "@hawk.so/types";
+
+/**
+ * Contract for user identity managers.
+ *
+ * Implementations are responsible for persisting and retrieving the
+ * {@link AffectedUser} that is attached to every error report sent by the catcher.
+ */
+export interface UserManager {
+  /**
+   * Returns the current affected user, or `null` if none has been set.
+   */
+  getUser(): AffectedUser | null
+
+  /**
+   * Replaces the stored user with the provided one.
+   *
+   * @param user - The affected user to persist.
+   */
+  setUser(user: AffectedUser): void
+
+  /**
+   * Removes any previously stored user data.
+   */
+  clear(): void
+}

packages/core/tests/storage-user-manager.test.ts

@@ -0,0 +1,54 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { StorageUserManager } from '../src';
+import type { HawkStorage } from '../src';
+
+class InMemoryStorage implements HawkStorage {
+  private data = new Map<string, string>();
+
+  public getItem(key: string): string | null {
+    return this.data.get(key) ?? null;
+  }
+
+  public setItem(key: string, value: string): void {
+    this.data.set(key, value);
+  }
+
+  public removeItem(key: string): void {
+    this.data.delete(key);
+  }
+}
+
+describe('StorageUserManager', () => {
+  let storage: InMemoryStorage;
+  let manager: StorageUserManager;
+
+  beforeEach(() => {
+    storage = new InMemoryStorage();
+    manager = new StorageUserManager(storage);
+  });
+
+  it('should return null when storage is empty', () => {
+    expect(manager.getUser()).toBeNull();
+  });
+
+  it('should return user when ID exists in storage', () => {
+    storage.setItem('hawk-user-id', 'test-user-123');
+
+    expect(manager.getUser()).toEqual({id: 'test-user-123'});
+  });
+
+  it('should persist user ID via setUser()', () => {
+    manager.setUser({id: 'user-abc'});
+
+    expect(storage.getItem('hawk-user-id')).toBe('user-abc');
+    expect(manager.getUser()).toEqual({id: 'user-abc'});
+  });
+
+  it('should remove user ID via clear()', () => {
+    manager.setUser({id: 'user-to-clear'});
+    manager.clear();
+
+    expect(manager.getUser()).toBeNull();
+    expect(storage.getItem('hawk-user-id')).toBeNull();
+  });
+});

packages/core/tsconfig.test.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": null,
+    "declaration": false,
+    "types": ["vitest/globals"]
+  },
+  "include": [
+    "src/**/*",
+    "tests/**/*",
+    "vitest.config.ts"
+  ]
+}

packages/core/vitest.config.ts

@@ -0,0 +1,15 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    include: ['tests/**/*.test.ts'],
+    typecheck: {
+      tsconfig: './tsconfig.test.json',
+    },
+    coverage: {
+      provider: 'v8',
+      include: ['src/**/*.ts'],
+    },
+  },
+});

packages/javascript/package.json

@@ -39,6 +39,7 @@
   },
   "homepage": "https://github.com/codex-team/hawk.javascript#readme",
   "dependencies": {
+    "@hawk.so/core": "workspace:^",
     "error-stack-parser": "^2.1.4"
   },
   "devDependencies": {

packages/javascript/src/catcher.ts

@@ -4,7 +4,6 @@ import log from './utils/log';
 import StackParser from './modules/stackParser';
 import type { CatcherMessage, HawkInitialSettings, BreadcrumbsAPI, Transport } from './types';
 import { VueIntegration } from './integrations/vue';
-import { id } from './utils/id';
 import type {
   AffectedUser,
   EventContext,
@@ -19,6 +18,9 @@ import { isErrorProcessed, markErrorAsProcessed } from './utils/event';
 import { ConsoleCatcher } from './addons/consoleCatcher';
 import { BreadcrumbManager } from './addons/breadcrumbs';
 import { validateUser, validateContext, isValidEventPayload } from './utils/validation';
+import { StorageUserManager, UserManager } from "@hawk.so/core";
+import { HawkLocalStorage } from "./modules/local-storage";
+import { id } from './utils/id';
 
 /**
  * Allow to use global VERSION, that will be overwritten by Webpack
@@ -62,11 +64,6 @@ export default class Catcher {
    */
   private readonly release: string | undefined;
 
-  /**
-   * Current authenticated user
-   */
-  private user: AffectedUser;
-
   /**
    * Any additional data passed by user for sending with all messages
    */
@@ -111,6 +108,11 @@ export default class Catcher {
    */
   private readonly breadcrumbManager: BreadcrumbManager | null;
 
+  /**
+   * Current authenticated user manager instance
+   */
+  private readonly userManager: UserManager = new StorageUserManager(new HawkLocalStorage());
+
   /**
    * Catcher constructor
    *
@@ -126,7 +128,9 @@ export default class Catcher {
     this.token = settings.token;
     this.debug = settings.debug || false;
     this.release = settings.release !== undefined ? String(settings.release) : undefined;
-    this.setUser(settings.user || Catcher.getGeneratedUser());
+    if (settings.user) {
+      this.setUser(settings.user);
+    }
     this.setContext(settings.context || undefined);
     this.beforeSend = settings.beforeSend;
     this.disableVueErrorHandler =
@@ -189,27 +193,6 @@ export default class Catcher {
     }
   }
 
-  /**
-   * Generates user if no one provided via HawkCatcher settings
-   * After generating, stores user for feature requests
-   */
-  private static getGeneratedUser(): AffectedUser {
-    let userId: string;
-    const LOCAL_STORAGE_KEY = 'hawk-user-id';
-    const storedId = localStorage.getItem(LOCAL_STORAGE_KEY);
-
-    if (storedId) {
-      userId = storedId;
-    } else {
-      userId = id();
-      localStorage.setItem(LOCAL_STORAGE_KEY, userId);
-    }
-
-    return {
-      id: userId,
-    };
-  }
-
   /**
    * Send test event from client
    */
@@ -272,14 +255,14 @@ export default class Catcher {
       return;
     }
 
-    this.user = user;
+    this.userManager.setUser(user);
   }
 
   /**
-   * Clear current user information (revert to generated user)
+   * Clear current user information
    */
   public clearUser(): void {
-    this.user = Catcher.getGeneratedUser();
+    this.userManager.clear()
   }
 
   /**
@@ -533,7 +516,7 @@ export default class Catcher {
   private getIntegrationId(): string {
     try {
       const decodedIntegrationToken: DecodedIntegrationToken = JSON.parse(atob(this.token));
-      const { integrationId } = decodedIntegrationToken;
+      const {integrationId} = decodedIntegrationToken;
 
       if (!integrationId || integrationId === '') {
         throw new Error();
@@ -565,10 +548,16 @@ export default class Catcher {
   }
 
   /**
-   * Current authenticated user
+   * Returns the current user, creating and persisting a new one if none exists.
    */
-  private getUser(): HawkJavaScriptEvent['user'] {
-    return this.user || null;
+  private getUser(): AffectedUser {
+    const user = this.userManager.getUser();
+    if (user) {
+      return user;
+    }
+    const newUser: AffectedUser = { id: id() };
+    this.userManager.setUser(newUser);
+    return newUser;
   }
 
   /**