Skip to content

Commit 6bafd32

Browse files
committed
Keep pending prefetches from blocking navigation, closes #832.
1 parent d7ec659 commit 6bafd32

5 files changed

Lines changed: 116 additions & 1 deletion

File tree

‎docs/reference/api/pages.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ Combine strategies with an array such as `['visible', 'hover']`. The first one t
4848

4949
Only same-origin GET links prefetch. `Link` skips prefetching when Chromium reports data saver or a 2G connection. Calling `router.prefetch()` explicitly still loads the page.
5050

51+
Navigation reuses completed prefetches. If a prefetch is still loading, navigation makes its own request so the page can render before deferred props finish.
52+
5153
Set `cacheFor` in milliseconds or as a duration such as `'5m'`. To show cached data while refreshing it in the background, use a pair such as `['30s', '5m']`: the page stays fresh for 30 seconds and can be reused for up to 5 minutes.
5254

5355
Each adapter plugin's `prefetch` option sets app-wide values:

‎packages/void/src/pages/navigation-engine.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -739,7 +739,9 @@ export async function createPageNavigationEngine(
739739
}
740740
const cacheEntry = method === 'GET' ? _prefetchCache.get(fetchUrl, method) : null;
741741

742-
if (cacheEntry) {
742+
// Prefetch JSON waits for every deferred prop. An unfinished prefetch must
743+
// not hold up the streamed shell from an ordinary navigation request.
744+
if (cacheEntry && !cacheEntry.pending) {
743745
const cachedPageData = await cacheEntry.response;
744746
_prefetchCache.consume(fetchUrl, method);
745747
if (cachedPageData === null) {

‎packages/void/src/pages/prefetch.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ export type CacheEntry = {
7272
url: string;
7373
method: string;
7474
response: Promise<unknown>;
75+
pending: boolean;
7576
staleAt: number;
7677
expiresAt: number;
7778
singleUse: boolean;
@@ -123,11 +124,18 @@ export class PrefetchCache {
123124
url,
124125
method,
125126
response,
127+
pending: true,
126128
staleAt: now + ttl.stale,
127129
expiresAt: now + ttl.expires,
128130
singleUse,
129131
timer: null,
130132
};
133+
void response.then(
134+
() => {
135+
entry.pending = false;
136+
},
137+
() => {},
138+
);
131139

132140
if (!singleUse && ttl.expires > 0) {
133141
entry.timer = setTimeout(() => this.entries.delete(k), ttl.expires);

‎packages/void/test/unit/pages-client.test.ts‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -924,6 +924,75 @@ describe('createVoidRouter', () => {
924924
expect(fetchMock).toHaveBeenCalledTimes(1);
925925
});
926926

927+
it('streams navigation without waiting for an unfinished prefetch', async () => {
928+
stubClientGlobals();
929+
const prefetched = controlledPromise<Response>();
930+
const applyUpdate = vi.fn();
931+
const resolveDeferred = vi.fn((_ref, value) => value);
932+
const encoder = new TextEncoder();
933+
let stream!: ReadableStreamDefaultController<Uint8Array>;
934+
const pageData = {
935+
component: 'users',
936+
props: { title: 'Users' },
937+
deferredKeys: { stats: 'stats' },
938+
};
939+
vi.stubGlobal(
940+
'fetch',
941+
vi.fn((_url, init: RequestInit) => {
942+
if (new Headers(init.headers).get('Purpose') === 'prefetch') {
943+
return prefetched.promise;
944+
}
945+
return Promise.resolve(
946+
new Response(
947+
new ReadableStream({
948+
start(controller) {
949+
stream = controller;
950+
controller.enqueue(encoder.encode(serializePageData(pageData) + '\n'));
951+
},
952+
}),
953+
{ headers: { 'X-VoidPages': 'true', 'Content-Type': 'application/x-ndjson' } },
954+
),
955+
);
956+
}),
957+
);
958+
const { router } = await createTestRouter({
959+
components: { home: loadComponent, users: loadComponent },
960+
matchRoute: () => 'users',
961+
adapter: {
962+
applyUpdate,
963+
resolveDeferred,
964+
createDeferred: () => ({ loading: true }),
965+
isLoading: () => true,
966+
},
967+
});
968+
const prefetch = router.prefetch('/users');
969+
const visit = router.visit('/users');
970+
try {
971+
await vi.waitFor(
972+
() =>
973+
expect(applyUpdate.mock.calls[0]?.[0]).toEqual(
974+
expect.objectContaining({
975+
props: { title: 'Users', stats: { loading: true } },
976+
}),
977+
),
978+
{ timeout: 500 },
979+
);
980+
stream.enqueue(
981+
encoder.encode(serializePageData({ __deferred: 'stats', data: { count: 42 } }) + '\n'),
982+
);
983+
await vi.waitFor(() =>
984+
expect(resolveDeferred).toHaveBeenCalledWith({ loading: true }, { count: 42 }),
985+
);
986+
} finally {
987+
stream?.close();
988+
prefetched.resolve(
989+
pageJson({ ...pageData, props: { title: 'Users', stats: { count: 42 } } }),
990+
);
991+
await Promise.all([prefetch, visit]);
992+
router.flushAll();
993+
}
994+
});
995+
927996
it.each(['replace', 'mutate'])(
928997
'keeps prefetched deferred data intact with %s adapters',
929998
async (mode) => {

‎test/pages-client-contract.ts‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,40 @@ export function registerSharedClientTests({
108108
BASE = getBase();
109109
});
110110

111+
it('navigates to a deferred page while its prefetch is still pending', async () => {
112+
const page = await newPage();
113+
let release!: () => void;
114+
const pending = new Promise<void>((resolve) => {
115+
release = resolve;
116+
});
117+
try {
118+
await page.route('**/deferred', async (route) => {
119+
const response = await route.fetch();
120+
if (route.request().headers()['purpose'] === 'prefetch') {
121+
await pending;
122+
}
123+
await route.fulfill({ response });
124+
});
125+
await page.goto(BASE + '/');
126+
await waitForHydration(page);
127+
await page.evaluate(() => {
128+
(window as TestWindow).__SPA_MARKER = true;
129+
});
130+
const prefetch = page.waitForRequest(
131+
(request) =>
132+
request.url() === BASE + '/deferred' && request.headers()['purpose'] === 'prefetch',
133+
);
134+
await page.hover('a[href="/deferred"]');
135+
await prefetch;
136+
await page.click('a[href="/deferred"]');
137+
await page.getByRole('heading', { name: 'Deferred Page', exact: true }).waitFor();
138+
expect(await page.evaluate(() => (window as TestWindow).__SPA_MARKER)).toBe(true);
139+
} finally {
140+
release();
141+
await page.context().close();
142+
}
143+
});
144+
111145
it.each(['Redirect to anchor', 'Submit to anchor'])(
112146
'preserves redirect hashes and scrolls to the target through %s',
113147
async (button) => {

0 commit comments

Comments
 (0)