|
| 1 | +import type { Clerk } from '@clerk/shared/types'; |
| 2 | +import { act, render, screen } from '@testing-library/react'; |
| 3 | +import React from 'react'; |
| 4 | +import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from 'vitest'; |
| 5 | + |
| 6 | +import { PathRouter, Route, Switch, useRouter } from '..'; |
| 7 | + |
| 8 | +const mockNavigate = vi.fn(); |
| 9 | + |
| 10 | +vi.mock('@clerk/shared/react', () => { |
| 11 | + return { |
| 12 | + useClerk: () => { |
| 13 | + return { |
| 14 | + navigate: (to: string) => { |
| 15 | + mockNavigate(to); |
| 16 | + if (to) { |
| 17 | + // @ts-ignore |
| 18 | + window.location = new URL(to, window.location.origin); |
| 19 | + } |
| 20 | + return Promise.resolve(); |
| 21 | + }, |
| 22 | + } as Clerk; |
| 23 | + }, |
| 24 | + }; |
| 25 | +}); |
| 26 | + |
| 27 | +/** |
| 28 | + * Renders router.currentPath so tests can assert against it. |
| 29 | + */ |
| 30 | +const CurrentPath = () => { |
| 31 | + const router = useRouter(); |
| 32 | + return <div data-testid='current-path'>{router.currentPath}</div>; |
| 33 | +}; |
| 34 | + |
| 35 | +const oldWindowLocation = window.location; |
| 36 | + |
| 37 | +const setWindowLocation = (url: string) => { |
| 38 | + // @ts-ignore |
| 39 | + window.location = new URL(url); |
| 40 | +}; |
| 41 | + |
| 42 | +describe('BaseRouter basePath guard', () => { |
| 43 | + beforeAll(() => { |
| 44 | + // @ts-ignore |
| 45 | + delete window.location; |
| 46 | + }); |
| 47 | + |
| 48 | + afterAll(() => { |
| 49 | + window.location = oldWindowLocation; |
| 50 | + }); |
| 51 | + |
| 52 | + afterEach(() => { |
| 53 | + vi.clearAllMocks(); |
| 54 | + }); |
| 55 | + |
| 56 | + describe('does not update state for out-of-basePath navigations', () => { |
| 57 | + it('keeps currentPath when window.location changes outside basePath and refresh is called', () => { |
| 58 | + setWindowLocation('https://www.example.com/sign-in'); |
| 59 | + |
| 60 | + const RefreshTrigger = () => { |
| 61 | + const router = useRouter(); |
| 62 | + return ( |
| 63 | + <button |
| 64 | + data-testid='refresh' |
| 65 | + onClick={() => router.refresh()} |
| 66 | + > |
| 67 | + Refresh |
| 68 | + </button> |
| 69 | + ); |
| 70 | + }; |
| 71 | + |
| 72 | + render( |
| 73 | + <PathRouter basePath='/sign-in'> |
| 74 | + <Route index> |
| 75 | + <CurrentPath /> |
| 76 | + <RefreshTrigger /> |
| 77 | + </Route> |
| 78 | + </PathRouter>, |
| 79 | + ); |
| 80 | + |
| 81 | + // Verify initial state |
| 82 | + expect(screen.getByTestId('current-path').textContent).toBe('/sign-in'); |
| 83 | + |
| 84 | + // Simulate URL changing outside basePath (e.g. framework navigation) |
| 85 | + setWindowLocation('https://www.example.com/'); |
| 86 | + |
| 87 | + // Call refresh — this should bail out because '/' doesn't start with '/sign-in' |
| 88 | + act(() => { |
| 89 | + screen.getByTestId('refresh').click(); |
| 90 | + }); |
| 91 | + |
| 92 | + // currentPath should still be /sign-in, not / |
| 93 | + expect(screen.getByTestId('current-path').textContent).toBe('/sign-in'); |
| 94 | + }); |
| 95 | + |
| 96 | + it('does not trigger catch-all route when URL changes outside basePath', () => { |
| 97 | + setWindowLocation('https://www.example.com/sign-in'); |
| 98 | + |
| 99 | + const redirectFn = vi.fn(); |
| 100 | + |
| 101 | + const CatchAll = () => { |
| 102 | + React.useEffect(() => { |
| 103 | + redirectFn(); |
| 104 | + }, []); |
| 105 | + return <div data-testid='catch-all'>Redirecting...</div>; |
| 106 | + }; |
| 107 | + |
| 108 | + const RefreshTrigger = () => { |
| 109 | + const router = useRouter(); |
| 110 | + return ( |
| 111 | + <button |
| 112 | + data-testid='refresh' |
| 113 | + onClick={() => router.refresh()} |
| 114 | + > |
| 115 | + Refresh |
| 116 | + </button> |
| 117 | + ); |
| 118 | + }; |
| 119 | + |
| 120 | + render( |
| 121 | + <PathRouter basePath='/sign-in'> |
| 122 | + <Switch> |
| 123 | + <Route index> |
| 124 | + <CurrentPath /> |
| 125 | + <RefreshTrigger /> |
| 126 | + </Route> |
| 127 | + <Route> |
| 128 | + <CatchAll /> |
| 129 | + </Route> |
| 130 | + </Switch> |
| 131 | + </PathRouter>, |
| 132 | + ); |
| 133 | + |
| 134 | + // Verify initial render — index route should match |
| 135 | + expect(screen.getByTestId('current-path').textContent).toBe('/sign-in'); |
| 136 | + expect(screen.queryByTestId('catch-all')).toBeNull(); |
| 137 | + expect(redirectFn).not.toHaveBeenCalled(); |
| 138 | + |
| 139 | + // Simulate URL changing outside basePath |
| 140 | + setWindowLocation('https://www.example.com/'); |
| 141 | + |
| 142 | + // Call refresh — should be guarded by basePath check |
| 143 | + act(() => { |
| 144 | + screen.getByTestId('refresh').click(); |
| 145 | + }); |
| 146 | + |
| 147 | + // The catch-all should NOT have rendered |
| 148 | + expect(screen.queryByTestId('catch-all')).toBeNull(); |
| 149 | + expect(redirectFn).not.toHaveBeenCalled(); |
| 150 | + // Index route should still be visible |
| 151 | + expect(screen.getByTestId('current-path').textContent).toBe('/sign-in'); |
| 152 | + }); |
| 153 | + }); |
| 154 | + |
| 155 | + describe('still updates state for within-basePath navigations', () => { |
| 156 | + it('updates currentPath when URL changes within basePath', () => { |
| 157 | + setWindowLocation('https://www.example.com/sign-in'); |
| 158 | + |
| 159 | + const RefreshTrigger = () => { |
| 160 | + const router = useRouter(); |
| 161 | + return ( |
| 162 | + <button |
| 163 | + data-testid='refresh' |
| 164 | + onClick={() => router.refresh()} |
| 165 | + > |
| 166 | + Refresh |
| 167 | + </button> |
| 168 | + ); |
| 169 | + }; |
| 170 | + |
| 171 | + render( |
| 172 | + <PathRouter basePath='/sign-in'> |
| 173 | + <Route path='factor-one'> |
| 174 | + <div data-testid='factor-one'>Factor One</div> |
| 175 | + </Route> |
| 176 | + <Route index> |
| 177 | + <CurrentPath /> |
| 178 | + <RefreshTrigger /> |
| 179 | + </Route> |
| 180 | + </PathRouter>, |
| 181 | + ); |
| 182 | + |
| 183 | + // Verify initial state |
| 184 | + expect(screen.getByTestId('current-path').textContent).toBe('/sign-in'); |
| 185 | + |
| 186 | + // Simulate URL changing within basePath |
| 187 | + setWindowLocation('https://www.example.com/sign-in/factor-one'); |
| 188 | + |
| 189 | + // Call refresh — this should update because '/sign-in/factor-one' starts with '/sign-in' |
| 190 | + act(() => { |
| 191 | + screen.getByTestId('refresh').click(); |
| 192 | + }); |
| 193 | + |
| 194 | + // currentPath should have updated |
| 195 | + expect(screen.getByTestId('factor-one')).toBeInTheDocument(); |
| 196 | + }); |
| 197 | + }); |
| 198 | +}); |
0 commit comments