@reservamos/browser-analytics 1.1.8-alpha.1 → 1.2.0-alpha.0

package/src/services/fingerprint.test.ts

@@ -1,4 +1,5 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import trackingLifecycle from '@/services/trackingLifecycle';
 import fingerprintService, { getFingerprintForIdentify } from './fingerprint';
 
 const visitorData = {
@@ -396,3 +397,174 @@ describe('fingerprintService', () => {
     consoleError.mockRestore();
   });
 });
+
+describe('bounded fingerprint waiting', () => {
+  beforeEach(async () => {
+    vi.useFakeTimers();
+    localStorage.clear();
+    initMock.mockResolvedValue(undefined);
+    getVisitorDataMock.mockReset().mockResolvedValue(visitorData);
+    clientMock.mockImplementation(() => ({
+      init: initMock,
+      getVisitorData: getVisitorDataMock,
+    }));
+    await fingerprintService.initFingerprint('wait-key');
+  });
+  afterEach(() => {
+    vi.clearAllTimers();
+    vi.useRealTimers();
+    vi.restoreAllMocks();
+    localStorage.clear();
+  });
+
+  it('returns cache without a provider request', async () => {
+    localStorage.setItem(
+      'default_fingerprint_cache',
+      JSON.stringify({ fingerprint: 'cached', expiresAt: Date.now() + 1000 }),
+    );
+    await expect(fingerprintService.waitForFingerprintId()).resolves.toBe(
+      'cached',
+    );
+    expect(getVisitorDataMock).not.toHaveBeenCalled();
+  });
+  it('joins a fresh request already in flight and serves concurrent waiters', async () => {
+    let finish!: (value: typeof visitorData) => void;
+    getVisitorDataMock.mockReturnValue(
+      new Promise((resolve) => {
+        finish = resolve;
+      }),
+    );
+    const existing = fingerprintService.identifyVisitor(true);
+    const first = fingerprintService.waitForFingerprintId();
+    const second = fingerprintService.waitForFingerprintId();
+    finish(visitorData);
+    await expect(Promise.all([first, second])).resolves.toEqual([
+      'visitor-123',
+      'visitor-123',
+    ]);
+    await existing;
+    expect(getVisitorDataMock).toHaveBeenCalledTimes(1);
+    await vi.advanceTimersByTimeAsync(0);
+    expect(vi.getTimerCount()).toBe(0);
+  });
+  it('waits for an agent still loading, then identifies only once', async () => {
+    let finish!: () => void;
+    initMock.mockReturnValue(
+      new Promise<void>((resolve) => {
+        finish = resolve;
+      }),
+    );
+    const initialization = fingerprintService.initFingerprint('late-key');
+    const first = fingerprintService.waitForFingerprintId();
+    const second = fingerprintService.waitForFingerprintId();
+    expect(getVisitorDataMock).not.toHaveBeenCalled();
+    finish();
+    await initialization;
+    await expect(Promise.all([first, second])).resolves.toEqual([
+      'visitor-123',
+      'visitor-123',
+    ]);
+    expect(getVisitorDataMock).toHaveBeenCalledTimes(1);
+    expect(getVisitorDataMock).toHaveBeenCalledWith({}, false);
+    await vi.advanceTimersByTimeAsync(0);
+    expect(vi.getTimerCount()).toBe(0);
+  });
+  it('resolves null when the pending agent fails to load', async () => {
+    let fail!: (error: Error) => void;
+    initMock.mockReturnValue(
+      new Promise((_resolve, reject) => {
+        fail = reject;
+      }),
+    );
+    const initialization = fingerprintService.initFingerprint('blocked-key');
+    const pending = fingerprintService.waitForFingerprintId();
+    const rejected = expect(initialization).rejects.toThrow('blocked');
+    fail(new Error('blocked'));
+    await rejected;
+    await expect(pending).resolves.toBeNull();
+    expect(getVisitorDataMock).not.toHaveBeenCalled();
+  });
+  it.each([-1, Infinity, NaN])(
+    'resolves null for invalid budget %s',
+    async (budget) => {
+      await expect(
+        fingerprintService.waitForFingerprintId(budget),
+      ).resolves.toBeNull();
+      expect(getVisitorDataMock).not.toHaveBeenCalled();
+    },
+  );
+  it('keeps a late successful result after the caller times out without another lookup', async () => {
+    let finish!: (value: typeof visitorData) => void;
+    getVisitorDataMock.mockReturnValue(
+      new Promise((resolve) => {
+        finish = resolve;
+      }),
+    );
+    setPeoplePropertiesMock.mockClear();
+    const pending = fingerprintService.waitForFingerprintId(2000);
+    await vi.advanceTimersByTimeAsync(2000);
+    await expect(pending).resolves.toBeNull();
+    await vi.advanceTimersByTimeAsync(500);
+    finish(visitorData);
+    await vi.advanceTimersByTimeAsync(0);
+    expect(fingerprintService.getCachedFingerprint()).toBe('visitor-123');
+    expect(setPeoplePropertiesMock).toHaveBeenCalledWith({
+      'Visitor Found': true,
+    });
+    await expect(fingerprintService.waitForFingerprintId()).resolves.toBe(
+      'visitor-123',
+    );
+    expect(getVisitorDataMock).toHaveBeenCalledTimes(1);
+    expect(vi.getTimerCount()).toBe(0);
+  });
+  it('suppresses a timed-out request after its user lifecycle changes', async () => {
+    let finish!: (value: typeof visitorData) => void;
+    getVisitorDataMock.mockReturnValue(
+      new Promise((resolve) => {
+        finish = resolve;
+      }),
+    );
+    setPeoplePropertiesMock.mockClear();
+    const pending = fingerprintService.waitForFingerprintId(2000);
+    await vi.advanceTimersByTimeAsync(2000);
+    await expect(pending).resolves.toBeNull();
+    trackingLifecycle.identify('replacement-user-after-timeout');
+    finish(visitorData);
+    await vi.advanceTimersByTimeAsync(0);
+    expect(fingerprintService.getCachedFingerprint()).toBeNull();
+    expect(setPeoplePropertiesMock).not.toHaveBeenCalled();
+    expect(getVisitorDataMock).toHaveBeenCalledTimes(1);
+    expect(vi.getTimerCount()).toBe(0);
+  });
+  it('resolves null at its timeout and consumes late rejection', async () => {
+    let fail!: (error: Error) => void;
+    getVisitorDataMock.mockReturnValue(
+      new Promise((_resolve, reject) => {
+        fail = reject;
+      }),
+    );
+    const pending = fingerprintService.waitForFingerprintId(100);
+    await vi.advanceTimersByTimeAsync(100);
+    await expect(pending).resolves.toBeNull();
+    fail(new Error('offline'));
+    await vi.advanceTimersByTimeAsync(0);
+    await vi.advanceTimersByTimeAsync(0);
+    expect(vi.getTimerCount()).toBe(0);
+  });
+  it('cancels when initialization changes and ignores an old result', async () => {
+    let finish!: (value: typeof visitorData) => void;
+    getVisitorDataMock.mockReturnValue(
+      new Promise((resolve) => {
+        finish = resolve;
+      }),
+    );
+    const pending = fingerprintService.waitForFingerprintId();
+    await fingerprintService.initFingerprint('replacement');
+    await expect(pending).resolves.toBeNull();
+    finish(visitorData);
+    await vi.advanceTimersByTimeAsync(0);
+    expect(fingerprintService.getCachedFingerprint()).toBeNull();
+    await vi.advanceTimersByTimeAsync(0);
+    expect(vi.getTimerCount()).toBe(0);
+  });
+});

package/src/services/fingerprint.ts

@@ -30,7 +30,16 @@ const PROXY_QUERY_PARAM =
  */
 let fingerprintAgentReady = false;
 let initialization = 0;
+let startedInitialization = -1;
 const readinessSubscribers = new Set<() => void>();
+const waitingConsumers = new Set<() => void>();
+let pendingIdentification:
+  | {
+      promise: Promise<FingerprintIdentification>;
+      contexts: Set<IdentifyStageContext | undefined>;
+      isCurrent: () => boolean;
+    }
+  | undefined;
 
 /** Notifies deferred observations only when the actual provider agent has loaded. */
 function onReady(notify: () => void): () => void {
@@ -44,6 +53,8 @@ function onReady(notify: () => void): () => void {
 function invalidate(): void {
   initialization++;
   fingerprintAgentReady = false;
+  pendingIdentification = undefined;
+  waitingConsumers.forEach((cancel) => cancel());
 }
 
 /**
@@ -133,7 +144,8 @@ async function initFingerprint(
     customScriptEndpointArray.unshift(buildProxyUrl(proxyUrl));
   }
 
-  invalidate();
+  if (startedInitialization === initialization) invalidate();
+  startedInitialization = initialization;
   const attempt = initialization;
   window.fingerprintConfig = {};
   const client = new FpjsClient({
@@ -154,6 +166,7 @@ async function initFingerprint(
   } catch (error) {
     if (window.fpClient === client && attempt === initialization) {
       fingerprintAgentReady = false;
+      waitingConsumers.forEach((cancel) => cancel());
     }
     console.error('Error initializing identification service:', error);
     throw error;
@@ -214,6 +227,50 @@ async function identifyVisitor(
 async function requestIdentification(
   ignoreCache: boolean,
   context?: IdentifyStageContext,
+): Promise<FingerprintIdentification> {
+  if (!ignoreCache && pendingIdentification?.isCurrent()) {
+    for (const participant of pendingIdentification.contexts) {
+      if (participant && !participant.isActive())
+        pendingIdentification.contexts.delete(participant);
+    }
+    pendingIdentification.contexts.add(context);
+    return pendingIdentification.promise;
+  }
+  const contexts = new Set([context]);
+  const attempt = initialization;
+  const currentLifecycle = trackingLifecycle.capture();
+  const isCurrent = () => attempt === initialization && currentLifecycle();
+  const sharedContext: IdentifyStageContext = {
+    isActive: () =>
+      isCurrent() &&
+      [...contexts].some(
+        (participant) => !participant || participant.isActive(),
+      ),
+    report: (...args) => {
+      for (const participant of contexts) {
+        if (participant?.isActive()) participant.report(...args);
+      }
+    },
+  };
+  const request = {
+    contexts,
+    isCurrent,
+    promise: performIdentification(ignoreCache, sharedContext, () =>
+      contexts.has(undefined),
+    ),
+  };
+  pendingIdentification = request;
+  const clear = () => {
+    if (pendingIdentification === request) pendingIdentification = undefined;
+  };
+  void request.promise.then(clear, clear);
+  return request.promise;
+}
+
+async function performIdentification(
+  ignoreCache: boolean,
+  context: IdentifyStageContext,
+  hasUnscopedConsumer: () => boolean,
 ): Promise<FingerprintIdentification> {
   if (!isFingerprintReady()) {
     throw new Error('Identification service is not initialized.');
@@ -221,7 +278,7 @@ async function requestIdentification(
 
   try {
     const result = await window.fpClient.getVisitorData({}, ignoreCache);
-    if (!context || context.isActive()) {
+    if (context.isActive()) {
       try {
         setCachedFingerprint(result.visitorId);
       } catch {
@@ -233,8 +290,9 @@ async function requestIdentification(
             'Visitor Found': result.visitorFound,
           });
         } catch (error) {
-          if (context) context.report('fingerprint', 'failed');
-          else console.error('Error updating Mixpanel visitor profile:', error);
+          context.report('fingerprint', 'failed');
+          if (hasUnscopedConsumer())
+            console.error('Error updating Mixpanel visitor profile:', error);
         }
       }
     }
@@ -249,11 +307,53 @@ async function requestIdentification(
       cacheHit: result.cacheHit,
     };
   } catch (error) {
-    if (!context) console.error('Error retrieving fingerprint:', error);
+    if (hasUnscopedConsumer())
+      console.error('Error retrieving fingerprint:', error);
     throw error;
   }
 }
 
+/**
+ * Waits for cached or in-flight identity without forcing a fresh provider request.
+ * @param {number} timeoutMs - Maximum wait in milliseconds; defaults to 2000.
+ * @returns {Promise<string | null>} Visitor ID, or null when unavailable within the budget.
+ */
+function waitForFingerprintId(timeoutMs = 2000): Promise<string | null> {
+  if (!Number.isFinite(timeoutMs) || timeoutMs < 0 || timeoutMs > 2147483647)
+    return Promise.resolve(null);
+  const cached = getCachedFingerprint();
+  if (cached) return Promise.resolve(cached);
+  return new Promise((resolve) => {
+    let active = true;
+    let started = false;
+    const finish = (visitorId: string | null) => {
+      if (!active) return;
+      active = false;
+      clearTimeout(timer);
+      stopReady();
+      stopLifecycle();
+      waitingConsumers.delete(cancel);
+      resolve(visitorId);
+    };
+    const cancel = () => finish(null);
+    const start = () => {
+      if (!active || started || !isFingerprintReady()) return;
+      started = true;
+      const identity = getFingerprint(false, {
+        // Caller timeout ends waiting; the shared request still checks its lifecycle.
+        isActive: () => true,
+        report: () => undefined,
+      });
+      void identity.then((visitorId) => finish(visitorId || null), cancel);
+    };
+    const timer = setTimeout(cancel, timeoutMs);
+    const stopReady = onReady(start);
+    const stopLifecycle = trackingLifecycle.onChange(cancel);
+    waitingConsumers.add(cancel);
+    start();
+  });
+}
+
 /**
  * Checks if the Fingerprint agent finished loading and can identify visitors.
  * @returns {boolean} True only after `initFingerprint()` has successfully loaded the agent.
@@ -270,6 +370,7 @@ const fingerprintService = {
   onReady,
   invalidate,
   getCachedFingerprint,
+  waitForFingerprintId,
 };
 
 // One module-lifetime listener invalidates the old agent before Mixpanel signals readiness.

package/src/services/fingerprint.wait.integration.test.ts

@@ -0,0 +1,129 @@
+import { afterEach, beforeEach, expect, it, vi } from 'vitest';
+import identify from '@/events/identify';
+import init from '@/init';
+import fingerprintService from '@/services/fingerprint';
+import mixpanelService from '@/services/mixpanel';
+import trackingLifecycle from '@/services/trackingLifecycle';
+import { trackEvent } from '@/track';
+
+const mocks = vi.hoisted(() => ({ load: vi.fn(), get: vi.fn() }));
+const visitor = {
+  visitorId: 'shared-visitor',
+  requestId: 'request',
+  visitorFound: true,
+  confidence: { score: 1 },
+  cacheHit: false,
+};
+vi.mock('@fingerprintjs/fingerprintjs-pro-spa', () => ({
+  FingerprintJSPro: {
+    defaultEndpoint: 'https://fp.test',
+    defaultScriptUrlPattern: 'https://fp.test/agent',
+  },
+  FpjsClient: vi.fn(() => ({ init: mocks.load, getVisitorData: mocks.get })),
+}));
+vi.mock('@reservamos/js-api-client/core', () => ({
+  default: {
+    setConfig: vi.fn(),
+    profiles: { createAnonymousProfile: vi.fn().mockResolvedValue(undefined) },
+  },
+}));
+vi.mock('@/services/config', () => ({
+  default: {
+    setEnvironment: vi.fn(),
+    setAppName: vi.fn(),
+    getCoreAPIConfig: vi
+      .fn()
+      .mockReturnValue({ baseUrl: 'https://core.test', defaultHeaders: {} }),
+  },
+}));
+vi.mock('@/services/geolocation', () => ({
+  default: {
+    init: vi.fn().mockResolvedValue(undefined),
+    getCoordinates: vi.fn().mockReturnValue(null),
+    getGeolocationSource: vi.fn().mockReturnValue(null),
+  },
+}));
+vi.mock('@/services/mixpanel', () => ({
+  default: {
+    validateConfiguration: vi.fn(),
+    init: vi.fn(async () => {
+      trackingLifecycle.beginInitialization();
+    }),
+    isReady: vi.fn().mockReturnValue(true),
+    identify: vi.fn((user: string) => trackingLifecycle.identify(user)),
+    setPeopleProperties: vi.fn(),
+    attachProperty: vi.fn(),
+    getMixpanelDistinctId: vi.fn().mockReturnValue('user'),
+    track: vi.fn(),
+  },
+}));
+
+beforeEach(() => {
+  vi.useFakeTimers();
+  vi.clearAllMocks();
+  localStorage.clear();
+  mocks.load.mockResolvedValue(undefined);
+  mocks.get.mockResolvedValue(visitor);
+});
+afterEach(() => {
+  vi.clearAllTimers();
+  vi.useRealTimers();
+  localStorage.clear();
+});
+
+it('preserves a waiter registered by Tracker Ready during that same initialization', async () => {
+  let loaded!: () => void;
+  mocks.load.mockReturnValue(
+    new Promise<void>((resolve) => {
+      loaded = resolve;
+    }),
+  );
+  let waiting: Promise<string | null> | undefined;
+  let settled = false;
+  window.addEventListener(
+    'Tracker Ready',
+    () => {
+      waiting = fingerprintService.waitForFingerprintId(1000).then((value) => {
+        settled = true;
+        return value;
+      });
+    },
+    { once: true },
+  );
+  const initialization = init({
+    mixpanelToken: 'test',
+    identificationKey: 'test',
+  });
+  await vi.advanceTimersByTimeAsync(0);
+  expect(waiting).toBeDefined();
+  expect(settled).toBe(false);
+  loaded();
+  await initialization;
+  await expect(waiting).resolves.toBe('shared-visitor');
+  expect(mocks.get).toHaveBeenCalledTimes(1);
+});
+
+it('keeps cache and profile effects for a current Identify joining a superseded request', async () => {
+  await init({ mixpanelToken: 'test', identificationKey: 'test' });
+  let finish!: (value: typeof visitor) => void;
+  mocks.get.mockReturnValue(
+    new Promise((resolve) => {
+      finish = resolve;
+    }),
+  );
+  await identify('user', { email: 'test@example.com' });
+  await identify('user', { email: 'test@example.com' });
+  finish(visitor);
+  await vi.advanceTimersByTimeAsync(0);
+  expect(mocks.get).toHaveBeenCalledTimes(1);
+  expect(fingerprintService.getCachedFingerprint()).toBe('shared-visitor');
+  expect(mixpanelService.setPeopleProperties).toHaveBeenCalledWith({
+    'Visitor Found': true,
+  });
+  expect(mixpanelService.attachProperty).toHaveBeenCalledTimes(1);
+  await trackEvent('Cache Check', { step: 'after identify' });
+  expect(mixpanelService.track).toHaveBeenCalledWith(
+    'Cache Check',
+    expect.objectContaining({ 'User Fingerprint': 'shared-visitor' }),
+  );
+});