|
| 1 | +import { act, cleanup, render, waitFor } from '@testing-library/react'; |
| 2 | +import React from 'react'; |
| 3 | +import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; |
| 4 | + |
| 5 | +import { useAwaitableRefresh } from '../useAwaitableRefresh'; |
| 6 | + |
| 7 | +const mockRefresh = vi.fn(); |
| 8 | + |
| 9 | +vi.mock('next/navigation', () => ({ |
| 10 | + useRouter: () => ({ refresh: mockRefresh }), |
| 11 | +})); |
| 12 | + |
| 13 | +let currentRefresh: (() => Promise<void>) | undefined; |
| 14 | + |
| 15 | +const Harness = () => { |
| 16 | + currentRefresh = useAwaitableRefresh(); |
| 17 | + return null; |
| 18 | +}; |
| 19 | + |
| 20 | +const refresh = () => { |
| 21 | + if (!currentRefresh) { |
| 22 | + throw new Error('refresh function is not initialized'); |
| 23 | + } |
| 24 | + return currentRefresh(); |
| 25 | +}; |
| 26 | + |
| 27 | +describe('useAwaitableRefresh', () => { |
| 28 | + beforeEach(() => { |
| 29 | + currentRefresh = undefined; |
| 30 | + window.__clerk_internal_refresh = undefined; |
| 31 | + vi.clearAllMocks(); |
| 32 | + }); |
| 33 | + |
| 34 | + afterEach(() => { |
| 35 | + cleanup(); |
| 36 | + }); |
| 37 | + |
| 38 | + it('dispatches router.refresh once transitions settle and resolves the promise', async () => { |
| 39 | + render(<Harness />); |
| 40 | + |
| 41 | + let promise!: Promise<void>; |
| 42 | + act(() => { |
| 43 | + promise = refresh(); |
| 44 | + }); |
| 45 | + |
| 46 | + await waitFor(() => { |
| 47 | + expect(mockRefresh).toHaveBeenCalledTimes(1); |
| 48 | + }); |
| 49 | + |
| 50 | + await expect(promise).resolves.toBeUndefined(); |
| 51 | + }); |
| 52 | + |
| 53 | + it('coalesces concurrent refresh calls into a single router.refresh', async () => { |
| 54 | + render(<Harness />); |
| 55 | + |
| 56 | + let firstPromise!: Promise<void>; |
| 57 | + let secondPromise!: Promise<void>; |
| 58 | + |
| 59 | + act(() => { |
| 60 | + firstPromise = refresh(); |
| 61 | + secondPromise = refresh(); |
| 62 | + }); |
| 63 | + |
| 64 | + await expect(Promise.all([firstPromise, secondPromise])).resolves.toEqual([undefined, undefined]); |
| 65 | + expect(mockRefresh).toHaveBeenCalledTimes(1); |
| 66 | + }); |
| 67 | + |
| 68 | + it('does not call router.refresh when nothing was requested', async () => { |
| 69 | + render(<Harness />); |
| 70 | + |
| 71 | + // Give the isPending effect a chance to run on mount |
| 72 | + await act(async () => { |
| 73 | + await Promise.resolve(); |
| 74 | + }); |
| 75 | + |
| 76 | + expect(mockRefresh).not.toHaveBeenCalled(); |
| 77 | + }); |
| 78 | + |
| 79 | + it('refreshes and resolves a stale buffer left by a previous instance on mount', async () => { |
| 80 | + let resolved = false; |
| 81 | + window.__clerk_internal_refresh = { |
| 82 | + promisesBuffer: [ |
| 83 | + () => { |
| 84 | + resolved = true; |
| 85 | + }, |
| 86 | + ], |
| 87 | + }; |
| 88 | + |
| 89 | + render(<Harness />); |
| 90 | + |
| 91 | + await waitFor(() => { |
| 92 | + expect(mockRefresh).toHaveBeenCalledTimes(1); |
| 93 | + expect(resolved).toBe(true); |
| 94 | + }); |
| 95 | + }); |
| 96 | + |
| 97 | + it('resolves pending promises on unmount', () => { |
| 98 | + const { unmount } = render(<Harness />); |
| 99 | + |
| 100 | + let resolved = false; |
| 101 | + window.__clerk_internal_refresh!.promisesBuffer = [ |
| 102 | + () => { |
| 103 | + resolved = true; |
| 104 | + }, |
| 105 | + ]; |
| 106 | + |
| 107 | + unmount(); |
| 108 | + |
| 109 | + expect(resolved).toBe(true); |
| 110 | + }); |
| 111 | + |
| 112 | + it('allows a fresh refresh after a previous flush', async () => { |
| 113 | + render(<Harness />); |
| 114 | + |
| 115 | + let firstPromise!: Promise<void>; |
| 116 | + act(() => { |
| 117 | + firstPromise = refresh(); |
| 118 | + }); |
| 119 | + await expect(firstPromise).resolves.toBeUndefined(); |
| 120 | + |
| 121 | + let secondPromise!: Promise<void>; |
| 122 | + act(() => { |
| 123 | + secondPromise = refresh(); |
| 124 | + }); |
| 125 | + await expect(secondPromise).resolves.toBeUndefined(); |
| 126 | + |
| 127 | + expect(mockRefresh).toHaveBeenCalledTimes(2); |
| 128 | + }); |
| 129 | +}); |
0 commit comments