scandit-datacapture-frameworks-id 8.4.1 → 8.5.0

package/test/IdCaptureListenerSubscription.test.ts

@@ -0,0 +1,96 @@
+import { describe, it, expect, jest, beforeEach } from '@jest/globals';
+import { IdCapture, PrivateIdCapture } from '../src/idcapture/IdCapture';
+import { IdCaptureListener } from '../src/idcapture/IdCaptureListener';
+
+/**
+ * Regression tests for SDC-32399.
+ *
+ * `IdCapture.addListener` must subscribe to native events when it adds the FIRST
+ * listener — regardless of whether the listener is added before or after the mode
+ * is wired into the DataCaptureContext via `setMode`.
+ *
+ * The original bug pushed the listener onto the array BEFORE checking
+ * `listeners.length === 0`, so the guard was never true and `subscribeListener`
+ * was never called from `addListener`. With the awaited "setMode-before-addListener"
+ * order the listener controller's `initialize()` also ran with zero listeners, so
+ * nothing ever subscribed and `didCaptureId`/`didRejectId` were silently dropped
+ * (reproduced on Android RN New Architecture).
+ *
+ * These tests bypass the constructor (which needs FactoryMaker proxy bindings) and
+ * exercise the real `addListener`/`removeListener` logic against a stubbed listener
+ * controller, which is exactly where the ordering bug lived.
+ */
+describe('IdCapture listener subscription (SDC-32399)', () => {
+  let subscribeListener: jest.Mock<() => Promise<void>>;
+  let unsubscribeListener: jest.Mock<() => Promise<void>>;
+  let idCapture: PrivateIdCapture;
+
+  const makeListener = (): IdCaptureListener => ({
+    didCaptureId: jest.fn(),
+    didRejectId: jest.fn(),
+  });
+
+  beforeEach(() => {
+    subscribeListener = jest.fn(() => Promise.resolve());
+    unsubscribeListener = jest.fn(() => Promise.resolve());
+
+    // Bypass the constructor's FactoryMaker/proxy dependencies; we only need the
+    // listener bookkeeping fields that addListener/removeListener touch.
+    idCapture = Object.create(IdCapture.prototype) as PrivateIdCapture;
+    (idCapture as any).listeners = [];
+    (idCapture as any)._hasListeners = false;
+    // Simulates the controller created lazily when `_context` is set (i.e. setMode).
+    (idCapture as any).listenerController = { subscribeListener, unsubscribeListener };
+  });
+
+  it('subscribes when the first listener is added after the context is set (setMode → addListener)', async () => {
+    // given a context-attached mode with the controller already created but no listeners yet
+    // when the first listener is added
+    await (idCapture as any).addListener(makeListener());
+
+    // then native events must be subscribed exactly once
+    expect(subscribeListener).toHaveBeenCalledTimes(1);
+    expect((idCapture as any).listeners).toHaveLength(1);
+  });
+
+  it('subscribes only once when several listeners are added', async () => {
+    await (idCapture as any).addListener(makeListener());
+    await (idCapture as any).addListener(makeListener());
+    await (idCapture as any).addListener(makeListener());
+
+    expect(subscribeListener).toHaveBeenCalledTimes(1);
+    expect((idCapture as any).listeners).toHaveLength(3);
+  });
+
+  it('does not re-subscribe when the same listener is added twice', async () => {
+    const listener = makeListener();
+    await (idCapture as any).addListener(listener);
+    await (idCapture as any).addListener(listener);
+
+    expect(subscribeListener).toHaveBeenCalledTimes(1);
+    expect((idCapture as any).listeners).toHaveLength(1);
+  });
+
+  it('is a no-op subscribe when no controller exists yet (addListener → setMode)', async () => {
+    // given a listener added before the context exists (controller still null)
+    (idCapture as any).listenerController = null;
+
+    // when the first listener is added, the optional-chained subscribe is skipped...
+    await (idCapture as any).addListener(makeListener());
+
+    // ...and the listener is still tracked so the controller's initialize() can
+    // subscribe once the context is set.
+    expect((idCapture as any).listeners).toHaveLength(1);
+    expect((idCapture as any)._hasListeners).toBe(true);
+  });
+
+  it('unsubscribes when the last listener is removed', async () => {
+    const listener = makeListener();
+    await (idCapture as any).addListener(listener);
+    await (idCapture as any).removeListener(listener);
+
+    expect(unsubscribeListener).toHaveBeenCalledTimes(1);
+    expect((idCapture as any).listeners).toHaveLength(0);
+    expect((idCapture as any)._hasListeners).toBe(false);
+  });
+});