@openmrs/esm-react-utils 9.0.2-pre.4055 → 9.0.2-pre.4060

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 53 files with swc (162.29ms)
+[0] Successfully compiled: 53 files with swc (127.85ms)
 [0] swc --strip-leading-paths src -d dist exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-react-utils",
-  "version": "9.0.2-pre.4055",
+  "version": "9.0.2-pre.4060",
   "license": "MPL-2.0",
   "description": "React utilities for OpenMRS.",
   "type": "module",
@@ -79,17 +79,17 @@
     "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "9.0.2-pre.4055",
-    "@openmrs/esm-config": "9.0.2-pre.4055",
-    "@openmrs/esm-context": "9.0.2-pre.4055",
-    "@openmrs/esm-emr-api": "9.0.2-pre.4055",
-    "@openmrs/esm-error-handling": "9.0.2-pre.4055",
-    "@openmrs/esm-extensions": "9.0.2-pre.4055",
-    "@openmrs/esm-feature-flags": "9.0.2-pre.4055",
-    "@openmrs/esm-globals": "9.0.2-pre.4055",
-    "@openmrs/esm-navigation": "9.0.2-pre.4055",
-    "@openmrs/esm-state": "9.0.2-pre.4055",
-    "@openmrs/esm-utils": "9.0.2-pre.4055",
+    "@openmrs/esm-api": "9.0.2-pre.4060",
+    "@openmrs/esm-config": "9.0.2-pre.4060",
+    "@openmrs/esm-context": "9.0.2-pre.4060",
+    "@openmrs/esm-emr-api": "9.0.2-pre.4060",
+    "@openmrs/esm-error-handling": "9.0.2-pre.4060",
+    "@openmrs/esm-extensions": "9.0.2-pre.4060",
+    "@openmrs/esm-feature-flags": "9.0.2-pre.4060",
+    "@openmrs/esm-globals": "9.0.2-pre.4060",
+    "@openmrs/esm-navigation": "9.0.2-pre.4060",
+    "@openmrs/esm-state": "9.0.2-pre.4060",
+    "@openmrs/esm-utils": "9.0.2-pre.4060",
     "@swc/cli": "^0.7.7",
     "@swc/core": "^1.11.29",
     "@vitest/coverage-v8": "^4.0.18",

package/src/useDebounce.test.tsx

@@ -0,0 +1,109 @@
+import { afterAll, afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { act, renderHook } from '@testing-library/react';
+import { useDebounce } from './useDebounce';
+
+describe('useDebounce', () => {
+  beforeEach(() => {
+    vi.useFakeTimers();
+  });
+
+  afterEach(() => {
+    vi.clearAllTimers();
+    vi.restoreAllMocks();
+  });
+
+  afterAll(() => {
+    vi.useRealTimers();
+  });
+
+  it('updates value after default delay', async () => {
+    const { result, rerender } = renderHook(
+      ({ value }) => useDebounce(value),
+      { initialProps: { value: 'initial' } },
+    );
+
+    rerender({ value: 'updated' });
+
+    expect(result.current).toBe('initial');
+
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(300);
+    });
+
+    expect(result.current).toBe('updated');
+  });
+
+  it('emits only final value on rapid updates', async () => {
+    const { result, rerender } = renderHook(
+      ({ value }) => useDebounce(value),
+      { initialProps: { value: 1 } },
+    );
+
+    rerender({ value: 2 });
+    rerender({ value: 3 });
+    rerender({ value: 4 });
+
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(300);
+    });
+
+    expect(result.current).toBe(4);
+  });
+
+  it('clears timeout on unmount', () => {
+    const clearTimeoutSpy = vi.spyOn(globalThis, 'clearTimeout');
+
+    const { rerender, unmount } = renderHook(
+      ({ value }) => useDebounce(value),
+      { initialProps: { value: 'start' } },
+    );
+
+    // Trigger a value change to schedule a pending timeout,
+    // so there is actually something to clean up on unmount
+    rerender({ value: 'changed' });
+
+    const callsBefore = clearTimeoutSpy.mock.calls.length;
+
+    unmount();
+
+    expect(clearTimeoutSpy.mock.calls.length).toBeGreaterThan(callsBefore);
+  });
+
+  it('preserves reference identity', async () => {
+    const updatedObj = { id: 1 };
+
+    const { result, rerender } = renderHook(
+      ({ value }) => useDebounce(value),
+      { initialProps: { value: { id: 0 } } },
+    );
+
+    rerender({ value: updatedObj });
+
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(300);
+    });
+
+    expect(result.current).toBe(updatedObj);
+  });
+
+  it('respects custom delay', async () => {
+    const { result, rerender } = renderHook(
+      ({ value }) => useDebounce(value, 500),
+      { initialProps: { value: 'initial' } },
+    );
+
+    rerender({ value: 'updated' });
+
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(300);
+    });
+
+    expect(result.current).toBe('initial');
+
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(200);
+    });
+
+    expect(result.current).toBe('updated');
+  });
+});