Skip to content

Commit 71a076d

Browse files
committed
fix(router-core): preserve pending UI across retained routes
1 parent f97188f commit 71a076d

8 files changed

Lines changed: 1132 additions & 96 deletions

‎packages/react-router/tests/hydration-terminal-lane.test.tsx‎

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { cleanup, render, screen } from '@testing-library/react'
1+
import { act, cleanup, render, screen } from '@testing-library/react'
22
import { afterEach, describe, expect, test, vi } from 'vitest'
33
import { hydrate } from '@tanstack/router-core/ssr/client'
44
import { dehydrateSsrMatchId } from '../../router-core/src/ssr/ssr-match-id'
@@ -20,18 +20,20 @@ function bootstrap(
2020
ssr: AnyRouteMatch['ssr']
2121
data?: unknown
2222
error?: unknown
23+
notFound?: boolean
2324
}>,
2425
): void {
2526
window.$_TSR = {
2627
router: {
2728
manifest: undefined,
28-
matches: matches.map(({ match, status, ssr, data, error }) => ({
29+
matches: matches.map(({ match, status, ssr, data, error, notFound }) => ({
2930
i: dehydrateSsrMatchId(match.id),
3031
l: data,
3132
e: error,
3233
s: status,
3334
ssr,
3435
u: Date.now(),
36+
...(notFound ? { g: true } : {}),
3537
})),
3638
},
3739
h: vi.fn(),
@@ -44,6 +46,7 @@ function bootstrap(
4446

4547
afterEach(() => {
4648
cleanup()
49+
vi.useRealTimers()
4750
delete window.$_TSR
4851
})
4952

@@ -95,4 +98,44 @@ describe('hydration terminal lane', () => {
9598
expect(parentLoader).not.toHaveBeenCalled()
9699
expect(childLoader).toHaveBeenCalledTimes(1)
97100
})
101+
102+
test('keeps a hydrated pending fallback through its minimum before a terminal result', async () => {
103+
const rootRoute = createRootRoute({
104+
pendingMs: 0,
105+
pendingMinMs: 100,
106+
pendingComponent: () => <div role="status">Missing page pending</div>,
107+
notFoundComponent: () => <div>Missing page</div>,
108+
})
109+
const router = createRouter({
110+
history: createMemoryHistory({ initialEntries: ['/missing'] }),
111+
routeTree: rootRoute,
112+
})
113+
const matches = router.matchRoutes(router.state.location)
114+
expect(matches[0]?._notFound).toBe(true)
115+
bootstrap([
116+
{
117+
match: matches[0]!,
118+
status: 'pending',
119+
ssr: false,
120+
notFound: true,
121+
},
122+
])
123+
124+
await hydrate(router)
125+
vi.useFakeTimers()
126+
vi.setSystemTime(0)
127+
render(<RouterProvider router={router} />)
128+
expect(screen.getByRole('status')).toHaveTextContent('Missing page pending')
129+
130+
await act(async () => {
131+
await vi.advanceTimersByTimeAsync(99)
132+
})
133+
expect(screen.getByRole('status')).toHaveTextContent('Missing page pending')
134+
expect(screen.queryByText('Missing page')).not.toBeInTheDocument()
135+
136+
await act(async () => {
137+
await vi.advanceTimersByTimeAsync(5)
138+
})
139+
expect(screen.getByText('Missing page')).toBeInTheDocument()
140+
})
98141
})

‎packages/react-router/tests/issue-4467-lazy-route-pending.test.tsx‎

Lines changed: 79 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ import {
1313
createRouter,
1414
} from '../src'
1515

16-
afterEach(cleanup)
16+
afterEach(() => {
17+
cleanup()
18+
vi.useRealTimers()
19+
})
1720

1821
// https://github.com/TanStack/router/issues/4467
1922
test('default pending component renders while lazy route options load', async () => {
@@ -142,3 +145,78 @@ test('a lazy pending component is offered while the eager loader is still pendin
142145

143146
expect(screen.getByRole('heading', { name: 'Page' })).toBeInTheDocument()
144147
})
148+
149+
test('a lazy pending component does not restart an acknowledged minimum', async () => {
150+
const loader = createControlledPromise<void>()
151+
const lazyPageOptions = createLazyRoute('/page')({
152+
pendingComponent: () => <p role="status">Loading lazy page</p>,
153+
component: () => <h1>Page</h1>,
154+
})
155+
const lazyOptions = createControlledPromise<typeof lazyPageOptions>()
156+
const rootRoute = createRootRoute({ component: Outlet })
157+
const indexRoute = createRoute({
158+
getParentRoute: () => rootRoute,
159+
path: '/',
160+
component: () => <h1>Index page</h1>,
161+
})
162+
const pageRoute = createRoute({
163+
getParentRoute: () => rootRoute,
164+
path: '/page',
165+
loader: () => loader,
166+
}).lazy(() => lazyOptions)
167+
const router = createRouter({
168+
routeTree: rootRoute.addChildren([indexRoute, pageRoute]),
169+
history: createMemoryHistory({ initialEntries: ['/'] }),
170+
defaultPendingMs: 0,
171+
defaultPendingMinMs: 100,
172+
defaultPendingComponent: () => <p role="status">Loading default</p>,
173+
})
174+
175+
render(<RouterProvider router={router} />)
176+
expect(
177+
await screen.findByRole('heading', { name: 'Index page' }),
178+
).toBeInTheDocument()
179+
vi.useFakeTimers()
180+
vi.setSystemTime(0)
181+
182+
const navigation = router.navigate({ to: '/page' })
183+
let settled = false
184+
void navigation.then(() => {
185+
settled = true
186+
})
187+
try {
188+
await act(async () => {
189+
await vi.advanceTimersByTimeAsync(0)
190+
})
191+
expect(screen.getByRole('status')).toHaveTextContent('Loading default')
192+
193+
await act(async () => {
194+
await vi.advanceTimersByTimeAsync(25)
195+
lazyOptions.resolve(lazyPageOptions)
196+
loader.resolve()
197+
await vi.advanceTimersByTimeAsync(0)
198+
})
199+
expect(screen.getByRole('status')).toHaveTextContent('Loading lazy page')
200+
201+
await act(async () => {
202+
await vi.advanceTimersByTimeAsync(74)
203+
})
204+
expect(screen.getByRole('status')).toHaveTextContent('Loading lazy page')
205+
206+
await act(async () => {
207+
await vi.advanceTimersByTimeAsync(5)
208+
await Promise.resolve()
209+
})
210+
expect(settled).toBe(true)
211+
await navigation
212+
expect(screen.getByRole('heading', { name: 'Page' })).toBeInTheDocument()
213+
expect(Date.now()).toBeLessThan(125)
214+
} finally {
215+
lazyOptions.resolve(lazyPageOptions)
216+
loader.resolve()
217+
await act(async () => {
218+
await vi.advanceTimersByTimeAsync(1_000)
219+
await navigation
220+
})
221+
}
222+
})

‎packages/react-router/tests/issue-7367-pending-min-redirect.test.tsx‎

Lines changed: 126 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import * as React from 'react'
2-
import { cleanup, render, screen } from '@testing-library/react'
2+
import { act, cleanup, render, screen } from '@testing-library/react'
3+
import { createControlledPromise } from '@tanstack/router-core'
34
import { afterEach, expect, test, vi } from 'vitest'
45

56
import {
@@ -16,6 +17,7 @@ import { sleep } from './utils'
1617
afterEach(() => {
1718
vi.restoreAllMocks()
1819
cleanup()
20+
vi.useRealTimers()
1921
})
2022

2123
// https://github.com/TanStack/router/issues/7367
@@ -76,3 +78,126 @@ test('immediate pending spinner (pendingMs: 0 + pendingMinMs) with root beforeLo
7678
expect(router.state.location.pathname).toBe('/welcome')
7779
expect(consoleError).not.toHaveBeenCalled()
7880
})
81+
82+
test('a compatible SPA redirect preserves the acknowledged pending minimum', async () => {
83+
vi.useFakeTimers()
84+
vi.setSystemTime(0)
85+
const redirectReady = createControlledPromise<void>()
86+
let shouldRedirect = true
87+
88+
const rootRoute = createRootRoute({
89+
component: Outlet,
90+
pendingMs: 0,
91+
pendingMinMs: 100,
92+
pendingComponent: () => <div data-testid="pending">loading</div>,
93+
beforeLoad: async () => {
94+
if (shouldRedirect) {
95+
shouldRedirect = false
96+
await redirectReady
97+
throw redirect({ to: '/welcome', replace: true })
98+
}
99+
},
100+
})
101+
const indexRoute = createRoute({
102+
getParentRoute: () => rootRoute,
103+
path: '/',
104+
component: () => <div>Index</div>,
105+
})
106+
const welcomeRoute = createRoute({
107+
getParentRoute: () => rootRoute,
108+
path: '/welcome',
109+
component: () => <div data-testid="welcome-page">Welcome</div>,
110+
})
111+
const router = createRouter({
112+
routeTree: rootRoute.addChildren([indexRoute, welcomeRoute]),
113+
history: createMemoryHistory({ initialEntries: ['/'] }),
114+
})
115+
116+
try {
117+
render(<RouterProvider router={router} />)
118+
await act(async () => {
119+
await vi.advanceTimersByTimeAsync(0)
120+
})
121+
expect(screen.getByTestId('pending')).toBeInTheDocument()
122+
123+
await act(async () => {
124+
await vi.advanceTimersByTimeAsync(25)
125+
redirectReady.resolve()
126+
await vi.advanceTimersByTimeAsync(74)
127+
})
128+
expect(screen.getByTestId('pending')).toBeInTheDocument()
129+
expect(screen.queryByTestId('welcome-page')).not.toBeInTheDocument()
130+
131+
await act(async () => {
132+
await vi.advanceTimersByTimeAsync(5)
133+
})
134+
expect(screen.getByTestId('welcome-page')).toBeInTheDocument()
135+
} finally {
136+
redirectReady.resolve()
137+
await act(async () => {
138+
await vi.advanceTimersByTimeAsync(1_000)
139+
})
140+
vi.useRealTimers()
141+
}
142+
})
143+
144+
test('an incompatible SPA redirect does not inherit the pending minimum', async () => {
145+
const redirectReady = createControlledPromise<void>()
146+
const rootRoute = createRootRoute({ component: Outlet })
147+
const indexRoute = createRoute({
148+
getParentRoute: () => rootRoute,
149+
path: '/',
150+
component: () => <div data-testid="index-page">Index</div>,
151+
})
152+
const sourceRoute = createRoute({
153+
getParentRoute: () => rootRoute,
154+
path: '/source',
155+
pendingMs: 0,
156+
pendingMinMs: 100,
157+
pendingComponent: () => <div data-testid="pending">loading</div>,
158+
beforeLoad: async () => {
159+
await redirectReady
160+
throw redirect({ to: '/welcome', replace: true })
161+
},
162+
})
163+
const welcomeRoute = createRoute({
164+
getParentRoute: () => rootRoute,
165+
path: '/welcome',
166+
component: () => <div data-testid="welcome-page">Welcome</div>,
167+
})
168+
const router = createRouter({
169+
routeTree: rootRoute.addChildren([indexRoute, sourceRoute, welcomeRoute]),
170+
history: createMemoryHistory({ initialEntries: ['/'] }),
171+
})
172+
173+
render(<RouterProvider router={router} />)
174+
expect(await screen.findByTestId('index-page')).toBeVisible()
175+
vi.useFakeTimers()
176+
vi.setSystemTime(0)
177+
178+
const navigation = router.navigate({ to: '/source' })
179+
try {
180+
await act(async () => {
181+
await vi.advanceTimersByTimeAsync(0)
182+
})
183+
expect(screen.getByTestId('pending')).toBeVisible()
184+
185+
await act(async () => {
186+
await vi.advanceTimersByTimeAsync(25)
187+
redirectReady.resolve()
188+
await vi.advanceTimersByTimeAsync(5)
189+
await navigation
190+
})
191+
192+
expect(Date.now()).toBeLessThan(100)
193+
expect(screen.getByTestId('welcome-page')).toBeVisible()
194+
expect(screen.queryByTestId('index-page')).not.toBeInTheDocument()
195+
expect(screen.queryByTestId('pending')).not.toBeInTheDocument()
196+
} finally {
197+
redirectReady.resolve()
198+
await act(async () => {
199+
await vi.advanceTimersByTimeAsync(1_000)
200+
await navigation
201+
})
202+
}
203+
})

0 commit comments

Comments
 (0)