|
| 1 | +import { renderHook, act } from '@testing-library/react'; |
| 2 | +import { useDebouncedSearch } from '../useDebouncedSearch'; |
| 3 | + |
| 4 | +describe('useDebouncedSearch', () => { |
| 5 | + beforeEach(() => { |
| 6 | + jest.useFakeTimers(); |
| 7 | + }); |
| 8 | + |
| 9 | + afterEach(() => { |
| 10 | + jest.useRealTimers(); |
| 11 | + }); |
| 12 | + |
| 13 | + it('starts with an empty query and no results', () => { |
| 14 | + const searchFn = jest.fn().mockResolvedValue(['a']); |
| 15 | + const { result } = renderHook(() => |
| 16 | + useDebouncedSearch({ searchFn, delay: 300 }), |
| 17 | + ); |
| 18 | + |
| 19 | + expect(result.current.query).toBe(''); |
| 20 | + expect(result.current.results).toBeUndefined(); |
| 21 | + expect(result.current.isLoading).toBe(false); |
| 22 | + expect(result.current.error).toBeNull(); |
| 23 | + }); |
| 24 | + |
| 25 | + it('does not fire the search until the debounce window elapses', () => { |
| 26 | + const searchFn = jest.fn().mockResolvedValue(['a']); |
| 27 | + const { result } = renderHook(() => |
| 28 | + useDebouncedSearch({ searchFn, delay: 300 }), |
| 29 | + ); |
| 30 | + |
| 31 | + act(() => { |
| 32 | + result.current.setQuery('hello'); |
| 33 | + }); |
| 34 | + |
| 35 | + expect(searchFn).not.toHaveBeenCalled(); |
| 36 | + |
| 37 | + act(() => { |
| 38 | + jest.advanceTimersByTime(300); |
| 39 | + }); |
| 40 | + |
| 41 | + expect(searchFn).toHaveBeenCalledTimes(1); |
| 42 | + expect(searchFn).toHaveBeenCalledWith('hello', expect.any(AbortSignal)); |
| 43 | + }); |
| 44 | + |
| 45 | + it('collapses rapid input into a single search with the latest query', () => { |
| 46 | + const searchFn = jest.fn().mockResolvedValue(['a']); |
| 47 | + const { result } = renderHook(() => |
| 48 | + useDebouncedSearch({ searchFn, delay: 300 }), |
| 49 | + ); |
| 50 | + |
| 51 | + act(() => { |
| 52 | + result.current.setQuery('h'); |
| 53 | + jest.advanceTimersByTime(100); |
| 54 | + result.current.setQuery('he'); |
| 55 | + jest.advanceTimersByTime(100); |
| 56 | + result.current.setQuery('hel'); |
| 57 | + jest.advanceTimersByTime(100); |
| 58 | + result.current.setQuery('hello'); |
| 59 | + jest.advanceTimersByTime(300); |
| 60 | + }); |
| 61 | + |
| 62 | + expect(searchFn).toHaveBeenCalledTimes(1); |
| 63 | + expect(searchFn).toHaveBeenCalledWith('hello', expect.any(AbortSignal)); |
| 64 | + }); |
| 65 | + |
| 66 | + it('sets results once the async search resolves', async () => { |
| 67 | + const searchFn = jest.fn().mockResolvedValue(['result-1']); |
| 68 | + const { result } = renderHook(() => |
| 69 | + useDebouncedSearch({ searchFn, delay: 300 }), |
| 70 | + ); |
| 71 | + |
| 72 | + act(() => { |
| 73 | + result.current.setQuery('hello'); |
| 74 | + }); |
| 75 | + |
| 76 | + await act(async () => { |
| 77 | + jest.advanceTimersByTime(300); |
| 78 | + await Promise.resolve(); |
| 79 | + await Promise.resolve(); |
| 80 | + }); |
| 81 | + |
| 82 | + expect(result.current.results).toEqual(['result-1']); |
| 83 | + expect(result.current.isLoading).toBe(false); |
| 84 | + }); |
| 85 | + |
| 86 | + it('surfaces errors from the search function', async () => { |
| 87 | + const searchFn = jest.fn().mockRejectedValue(new Error('Network error')); |
| 88 | + const { result } = renderHook(() => |
| 89 | + useDebouncedSearch({ searchFn, delay: 300 }), |
| 90 | + ); |
| 91 | + |
| 92 | + act(() => { |
| 93 | + result.current.setQuery('hello'); |
| 94 | + }); |
| 95 | + |
| 96 | + await act(async () => { |
| 97 | + jest.advanceTimersByTime(300); |
| 98 | + await Promise.resolve(); |
| 99 | + await Promise.resolve(); |
| 100 | + }); |
| 101 | + |
| 102 | + expect(result.current.error).toEqual(new Error('Network error')); |
| 103 | + expect(result.current.isLoading).toBe(false); |
| 104 | + }); |
| 105 | + |
| 106 | + it('respects minLength and does not search short queries', () => { |
| 107 | + const searchFn = jest.fn().mockResolvedValue(['a']); |
| 108 | + const { result } = renderHook(() => |
| 109 | + useDebouncedSearch({ searchFn, delay: 300, minLength: 3, initialResults: ['init'] }), |
| 110 | + ); |
| 111 | + |
| 112 | + act(() => { |
| 113 | + result.current.setQuery('hi'); |
| 114 | + jest.advanceTimersByTime(300); |
| 115 | + }); |
| 116 | + |
| 117 | + expect(searchFn).not.toHaveBeenCalled(); |
| 118 | + expect(result.current.results).toEqual(['init']); |
| 119 | + expect(result.current.isLoading).toBe(false); |
| 120 | + }); |
| 121 | + |
| 122 | + it('clear resets query, results and error', () => { |
| 123 | + const searchFn = jest.fn().mockResolvedValue(['a']); |
| 124 | + const { result } = renderHook(() => |
| 125 | + useDebouncedSearch({ searchFn, delay: 300, initialResults: ['init'] }), |
| 126 | + ); |
| 127 | + |
| 128 | + act(() => { |
| 129 | + result.current.setQuery('hello'); |
| 130 | + result.current.clear(); |
| 131 | + }); |
| 132 | + |
| 133 | + expect(result.current.query).toBe(''); |
| 134 | + expect(result.current.results).toEqual(['init']); |
| 135 | + expect(result.current.error).toBeNull(); |
| 136 | + }); |
| 137 | + |
| 138 | + it('cleans up pending timers on unmount', () => { |
| 139 | + const searchFn = jest.fn().mockResolvedValue(['a']); |
| 140 | + const { result, unmount } = renderHook(() => |
| 141 | + useDebouncedSearch({ searchFn, delay: 300 }), |
| 142 | + ); |
| 143 | + |
| 144 | + act(() => { |
| 145 | + result.current.setQuery('hello'); |
| 146 | + }); |
| 147 | + |
| 148 | + unmount(); |
| 149 | + |
| 150 | + act(() => { |
| 151 | + jest.advanceTimersByTime(300); |
| 152 | + }); |
| 153 | + |
| 154 | + // The pending search must not fire after unmount. |
| 155 | + expect(searchFn).not.toHaveBeenCalled(); |
| 156 | + }); |
| 157 | +}); |
0 commit comments