refactor(core): UserManager abstraction added

Author: Reversean

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,63 @@
+import { AffectedUser } from "@hawk.so/types";
+import { id } from "../utils/id";
+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;
+  }
+
+  /**
+   * Returns the stored user if one exists. Otherwise, generates a new identifier,
+   * saves it in storage under {@linkcode HAWK_USER_STORAGE_KEY}, and returns the new user.
+   */
+  getUser(): AffectedUser {
+    const storedId = this.storage.getItem(HAWK_USER_STORAGE_KEY);
+    if (storedId) {
+      return {
+        id: storedId,
+      };
+    }
+
+    const userId = id()
+    this.storage.setItem(HAWK_USER_STORAGE_KEY, userId);
+    return {
+      id: userId
+    };
+  }
+
+  /**
+   * Persists the given user's identifier in storage.
+   *
+   * @param user - The affected user to store.
+   */
+  setUser(user: AffectedUser): void {
+    this.storage.setItem(HAWK_USER_STORAGE_KEY, user.id);
+  }
+
+  /**
+   * Removes the stored user identifier from storage.
+   */
+  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, creating one if none exists yet.
+   */
+  getUser(): AffectedUser
+
+  /**
+   * 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/javascript/src/utils/id.ts packages/core/src/utils/id.tspackages/javascript/src/utils/id.ts renamed to packages/core/src/utils/id.ts

@@ -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/package.json

@@ -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,8 @@ 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";
 
 /**
  * Allow to use global VERSION, that will be overwritten by Webpack
@@ -62,11 +63,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 +107,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 +127,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 +192,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 +254,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 +515,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();
@@ -568,7 +550,7 @@ export default class Catcher {
    * Current authenticated user
    */
   private getUser(): HawkJavaScriptEvent['user'] {
-    return this.user || null;
+    return this.userManager.getUser();
   }
 
   /**
@@ -635,7 +617,7 @@ export default class Catcher {
    * @param {Error|string} error — caught error
    */
   private getAddons(error: Error | string): HawkJavaScriptEvent['addons'] {
-    const { innerWidth, innerHeight } = window;
+    const {innerWidth, innerHeight} = window;
     const userAgent = window.navigator.userAgent;
     const location = window.location.href;
     const getParams = this.getGetParams();

packages/javascript/src/catcher.ts

@@ -0,0 +1,21 @@
+import { HawkStorage } from "@hawk.so/core";
+
+/**
+ * {@link HawkStorage} implementation backed by the browser's {@linkcode localStorage}.
+ */
+export class HawkLocalStorage implements HawkStorage {
+  /** @inheritDoc */
+  public getItem(key: string): string | null {
+    return localStorage.getItem(key);
+  }
+
+  /** @inheritDoc */
+  public setItem(key: string, value: string): void {
+    localStorage.setItem(key, value);
+  }
+
+  /** @inheritDoc */
+  public removeItem(key: string): void {
+    localStorage.removeItem(key);
+  }
+}

packages/javascript/src/modules/local-storage.ts

@@ -26,6 +26,7 @@ export default defineConfig(() => {
         fileName: 'hawk',
       },
       rollupOptions: {
+        external: ['@hawk.so/core'],
         plugins: [
           license({
             thirdParty: {

packages/javascript/vite.config.ts

@@ -576,7 +576,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@hawk.so/core@workspace:packages/core":
+"@hawk.so/core@workspace:^, @hawk.so/core@workspace:packages/core":
   version: 0.0.0-use.local
   resolution: "@hawk.so/core@workspace:packages/core"
   dependencies:
@@ -589,6 +589,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@hawk.so/javascript@workspace:packages/javascript"
   dependencies:
+    "@hawk.so/core": "workspace:^"
     "@hawk.so/types": "npm:0.5.8"
     error-stack-parser: "npm:^2.1.4"
     jsdom: "npm:^28.0.0"