Skip to content

Commit 121fe64

Browse files
authored
fix(router): align pending presentation across Solid and Vue (#8097)
fix(router): align pending presentation across frameworks
1 parent 425bab3 commit 121fe64

14 files changed

Lines changed: 2443 additions & 11 deletions

‎packages/router-core/src/load-client.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2159,7 +2159,7 @@ export async function loadClientRoute(
21592159
// matches must wait for lazy routes to place the final boundary.
21602160
if (
21612161
resolvedPrefix ||
2162-
(!resolvedLocation && !matches.some((match) => match._notFound))
2162+
(!router._committed.length && !matches.some((match) => match._notFound))
21632163
) {
21642164
offerPending(router, tx)
21652165
}

‎packages/router-core/tests/public-client-loading-contract.test.ts‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,76 @@ describe('public client loading contracts', () => {
5555
})
5656
})
5757

58+
test('a successor retains committed UI until its pending context is ready', async () => {
59+
const initialPublished = createControlledPromise<void>()
60+
const initialRenderAck = createControlledPromise<boolean>()
61+
const successorStarted = createControlledPromise<void>()
62+
const successorLoader = createControlledPromise<string>()
63+
const rootRoute = new BaseRootRoute({})
64+
const initialRoute = new BaseRoute({
65+
getParentRoute: () => rootRoute,
66+
path: '/',
67+
})
68+
const successorRoute = new BaseRoute({
69+
getParentRoute: () => rootRoute,
70+
path: '/successor',
71+
context: () => ({ destinationContext: 'ready' }),
72+
pendingMs: 0,
73+
pendingMinMs: 0,
74+
pendingComponent: () => null,
75+
loader: () => {
76+
successorStarted.resolve()
77+
return successorLoader
78+
},
79+
})
80+
const router = createTestRouter({
81+
routeTree: rootRoute.addChildren([initialRoute, successorRoute]),
82+
history: createMemoryHistory({ initialEntries: ['/'] }),
83+
})
84+
const startTransition = router.startTransition
85+
let waitForInitialRender = true
86+
router.startTransition = (fn, expected) => {
87+
fn()
88+
if (
89+
waitForInitialRender &&
90+
expected?.at(-1)?.routeId === initialRoute.id &&
91+
expected.at(-1)?.status === 'success'
92+
) {
93+
waitForInitialRender = false
94+
initialPublished.resolve()
95+
return initialRenderAck
96+
}
97+
return Promise.resolve(true)
98+
}
99+
100+
const initialLoad = router.load()
101+
let navigation: Promise<void> | undefined
102+
try {
103+
await initialPublished
104+
expect(router._committed.at(-1)?.routeId).toBe(initialRoute.id)
105+
expect(router.state.resolvedLocation).toBeUndefined()
106+
expect(initialRenderAck.status).toBe('pending')
107+
108+
navigation = router.navigate({ to: '/successor' })
109+
await successorStarted
110+
111+
expect(router.state.matches.at(-1)).toMatchObject({
112+
routeId: successorRoute.id,
113+
status: 'pending',
114+
context: { destinationContext: 'ready' },
115+
})
116+
117+
successorLoader.resolve('successor data')
118+
initialRenderAck.resolve(true)
119+
await Promise.all([initialLoad, navigation])
120+
} finally {
121+
successorLoader.resolve('successor data')
122+
initialRenderAck.resolve(true)
123+
await Promise.allSettled([initialLoad, navigation])
124+
router.startTransition = startTransition
125+
}
126+
})
127+
58128
test('a rejected pending publication restores the committed lane', async () => {
59129
const loaderStarted = createControlledPromise<void>()
60130
const loaderGate = createControlledPromise<string>()

‎packages/solid-router/src/Transitioner.tsx‎

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ import * as Solid from 'solid-js'
22
import { getLocationChangeInfo, trimPathRight } from '@tanstack/router-core'
33
import { isServer } from '@tanstack/router-core/isServer'
44
import { useRouter } from './useRouter'
5-
import type { AnyRouteMatch } from '@tanstack/router-core'
65

76
function getResolvedLocation(router: ReturnType<typeof useRouter>) {
87
const resolvedLocation = router.stores.resolvedLocation.get()
@@ -22,13 +21,44 @@ export function Transitioner() {
2221
return null
2322
}
2423

25-
let transitionOwner: Array<AnyRouteMatch> | undefined
26-
router.startTransition = async (fn, expected) => {
27-
transitionOwner = expected
28-
await Solid.startTransition(fn)
29-
return transitionOwner === expected
24+
let settleCurrent: ((rendered: boolean) => void) | undefined
25+
router.startTransition = (fn) => {
26+
settleCurrent?.(false)
27+
28+
return new Promise((resolve, reject) => {
29+
const settle = (rendered: boolean) => {
30+
if (settleCurrent !== settle) {
31+
return
32+
}
33+
settleCurrent = undefined
34+
resolve(rendered)
35+
}
36+
const fail = (cause: unknown) => {
37+
if (settleCurrent !== settle) {
38+
return
39+
}
40+
settleCurrent = undefined
41+
reject(cause)
42+
}
43+
settleCurrent = settle
44+
45+
void Solid.startTransition(() => {
46+
// A newer publication may supersede this deferred callback.
47+
if (settleCurrent === settle) {
48+
try {
49+
fn()
50+
} catch (cause) {
51+
fail(cause)
52+
}
53+
}
54+
}).then(() => settle(true), fail)
55+
})
3056
}
3157

58+
Solid.onCleanup(() => {
59+
settleCurrent?.(false)
60+
})
61+
3262
// Subscribe to location changes
3363
// and try to load the new location
3464
Solid.onMount(() => {
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
import { cleanup, render, screen } from '@solidjs/testing-library'
2+
import { afterEach, describe, expect, test, vi } from 'vitest'
3+
import { hydrate } from '@tanstack/router-core/ssr/client'
4+
import { dehydrateSsrMatchId } from '../../router-core/src/ssr/ssr-match-id'
5+
import {
6+
RouterProvider,
7+
createMemoryHistory,
8+
createRootRoute,
9+
createRouter,
10+
} from '../src'
11+
import type { AnyRouteMatch } from '@tanstack/router-core'
12+
import type { TsrSsrGlobal } from '@tanstack/router-core/ssr/client'
13+
14+
function bootstrap(
15+
matches: Array<{
16+
match: AnyRouteMatch
17+
status: AnyRouteMatch['status']
18+
ssr: AnyRouteMatch['ssr']
19+
data?: unknown
20+
error?: unknown
21+
notFound?: boolean
22+
}>,
23+
): void {
24+
window.$_TSR = {
25+
router: {
26+
manifest: undefined,
27+
matches: matches.map(({ match, status, ssr, data, error, notFound }) => ({
28+
i: dehydrateSsrMatchId(match.id),
29+
l: data,
30+
e: error,
31+
s: status,
32+
ssr,
33+
u: Date.now(),
34+
...(notFound ? { g: true } : {}),
35+
})),
36+
},
37+
h: vi.fn(),
38+
e: vi.fn(),
39+
c: vi.fn(),
40+
p: vi.fn(),
41+
buffer: [],
42+
} as TsrSsrGlobal
43+
}
44+
45+
afterEach(() => {
46+
cleanup()
47+
vi.useRealTimers()
48+
delete window.$_TSR
49+
})
50+
51+
describe('hydration terminal lane', () => {
52+
test('keeps a hydrated pending fallback through its minimum before a terminal result', async () => {
53+
const rootRoute = createRootRoute({
54+
pendingMs: 0,
55+
pendingMinMs: 100,
56+
pendingComponent: () => <div role="status">Missing page pending</div>,
57+
notFoundComponent: () => <div>Missing page</div>,
58+
})
59+
const router = createRouter({
60+
history: createMemoryHistory({ initialEntries: ['/missing'] }),
61+
routeTree: rootRoute,
62+
})
63+
const matches = router.matchRoutes(router.state.location)
64+
expect(matches[0]?._notFound).toBe(true)
65+
bootstrap([
66+
{
67+
match: matches[0]!,
68+
status: 'pending',
69+
ssr: false,
70+
notFound: true,
71+
},
72+
])
73+
74+
await hydrate(router)
75+
vi.useFakeTimers()
76+
vi.setSystemTime(0)
77+
render(() => <RouterProvider router={router} />)
78+
expect(screen.getByRole('status')).toHaveTextContent('Missing page pending')
79+
80+
await vi.advanceTimersByTimeAsync(99)
81+
expect(screen.getByRole('status')).toHaveTextContent('Missing page pending')
82+
expect(screen.queryByText('Missing page')).not.toBeInTheDocument()
83+
84+
await vi.advanceTimersByTimeAsync(5)
85+
expect(screen.getByText('Missing page')).toBeInTheDocument()
86+
})
87+
})
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
import { cleanup, render, screen } from '@solidjs/testing-library'
2+
import { afterEach, expect, test, vi } from 'vitest'
3+
import { createControlledPromise } from '@tanstack/router-core'
4+
import {
5+
Outlet,
6+
RouterProvider,
7+
createLazyRoute,
8+
createMemoryHistory,
9+
createRootRoute,
10+
createRoute,
11+
createRouter,
12+
} from '../src'
13+
14+
afterEach(() => {
15+
cleanup()
16+
vi.useRealTimers()
17+
})
18+
19+
test('a lazy pending component does not restart an acknowledged minimum', async () => {
20+
const loader = createControlledPromise<void>()
21+
const lazyPageOptions = createLazyRoute('/page')({
22+
pendingComponent: () => <p role="status">Loading lazy page</p>,
23+
component: () => <h1>Page</h1>,
24+
})
25+
const lazyOptions = createControlledPromise<typeof lazyPageOptions>()
26+
const rootRoute = createRootRoute({ component: () => <Outlet /> })
27+
const indexRoute = createRoute({
28+
getParentRoute: () => rootRoute,
29+
path: '/',
30+
component: () => <h1>Index page</h1>,
31+
})
32+
const pageRoute = createRoute({
33+
getParentRoute: () => rootRoute,
34+
path: '/page',
35+
loader: () => loader,
36+
}).lazy(() => lazyOptions)
37+
const router = createRouter({
38+
routeTree: rootRoute.addChildren([indexRoute, pageRoute]),
39+
history: createMemoryHistory({ initialEntries: ['/'] }),
40+
defaultPendingMs: 0,
41+
defaultPendingMinMs: 100,
42+
defaultPendingComponent: () => <p role="status">Loading default</p>,
43+
})
44+
45+
render(() => <RouterProvider router={router} />)
46+
expect(
47+
await screen.findByRole('heading', { name: 'Index page' }),
48+
).toBeInTheDocument()
49+
vi.useFakeTimers()
50+
vi.setSystemTime(0)
51+
52+
const navigation = router.navigate({ to: '/page' })
53+
let settled = false
54+
void navigation.then(() => {
55+
settled = true
56+
})
57+
try {
58+
await vi.advanceTimersByTimeAsync(0)
59+
expect(screen.getByRole('status')).toHaveTextContent('Loading default')
60+
61+
await vi.advanceTimersByTimeAsync(25)
62+
lazyOptions.resolve(lazyPageOptions)
63+
loader.resolve()
64+
await vi.advanceTimersByTimeAsync(0)
65+
expect(screen.getByRole('status')).toHaveTextContent('Loading lazy page')
66+
67+
await vi.advanceTimersByTimeAsync(74)
68+
expect(screen.getByRole('status')).toHaveTextContent('Loading lazy page')
69+
70+
await vi.advanceTimersByTimeAsync(5)
71+
await Promise.resolve()
72+
expect(settled).toBe(true)
73+
await navigation
74+
expect(screen.getByRole('heading', { name: 'Page' })).toBeInTheDocument()
75+
expect(Date.now()).toBeLessThan(125)
76+
} finally {
77+
lazyOptions.resolve(lazyPageOptions)
78+
loader.resolve()
79+
await vi.advanceTimersByTimeAsync(1_000)
80+
await navigation
81+
}
82+
})

0 commit comments

Comments
 (0)