From 196fd7860e22c9949dbb99a0473cba23efc2c6ac Mon Sep 17 00:00:00 2001 From: Sheraff Date: Tue, 19 Aug 2025 15:38:14 +0200 Subject: [PATCH 1/3] fix(router-core): await beforeLoad before rendering, even if preloaded --- packages/react-router/tests/loaders.test.tsx | 69 ++++++++++++++++++++ 1 file changed, 69 insertions(+) diff --git a/packages/react-router/tests/loaders.test.tsx b/packages/react-router/tests/loaders.test.tsx index 7eccb96a13..4995acba2a 100644 --- a/packages/react-router/tests/loaders.test.tsx +++ b/packages/react-router/tests/loaders.test.tsx @@ -729,3 +729,72 @@ test('clears pendingTimeout when match resolves', async () => { expect(nestedPendingComponentOnMountMock).not.toHaveBeenCalled() expect(fooPendingComponentOnMountMock).not.toHaveBeenCalled() }) + + +test.only('reproducer #4998 - beforeLoad is awaited before rendering', async () => { + const beforeLoad = vi.fn() + const select = vi.fn() + let resolved = 0 + const rootRoute = createRootRoute() + const indexRoute = createRoute({ + getParentRoute: () => rootRoute, + path: '/', + component: () => To foo, + }) + const fooRoute = createRoute({ + getParentRoute: () => rootRoute, + path: '/foo', + beforeLoad: async (...args) => { + beforeLoad(...args) + await new Promise((resolve) => setTimeout(resolve, 20)) + resolved += 1 + return { foo: 'bar' } + }, + component: () => { + fooRoute.useRouteContext({ select }) + return

Foo index page

+ }, + pendingComponent: () => 'loading', + }) + const routeTree = rootRoute.addChildren([ + indexRoute, + fooRoute + ]) + const router = createRouter({ + routeTree, + history, + defaultPreload: 'intent', + defaultPendingMs: 0, + }) + + render() + const linkToFoo = await screen.findByText('To foo') + + fireEvent.focus(linkToFoo) + await sleep(100) + + expect(resolved).toBe(1) + + expect(beforeLoad).toHaveBeenCalledTimes(1) + expect(beforeLoad).toHaveBeenNthCalledWith(1, expect.objectContaining({ + cause: 'preload', + preload: true, + })) + + expect(select).not.toHaveBeenCalled() + + fireEvent.click(linkToFoo) + await screen.findByText('Foo index page') + + expect(resolved).toBe(2) + + expect(beforeLoad).toHaveBeenCalledTimes(2) + expect(beforeLoad).toHaveBeenNthCalledWith(2, expect.objectContaining({ + cause: 'enter', + preload: false, + })) + + expect(select).toHaveBeenNthCalledWith(1, expect.objectContaining({ + foo: 'bar', + })) +}) \ No newline at end of file From eeae542a1dfaf6629fa7329821688c7210afd33f Mon Sep 17 00:00:00 2001 From: Sheraff Date: Tue, 19 Aug 2025 15:54:15 +0200 Subject: [PATCH 2/3] add code comment --- packages/react-router/tests/loaders.test.tsx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/packages/react-router/tests/loaders.test.tsx b/packages/react-router/tests/loaders.test.tsx index 4995acba2a..ab50f7a604 100644 --- a/packages/react-router/tests/loaders.test.tsx +++ b/packages/react-router/tests/loaders.test.tsx @@ -786,8 +786,6 @@ test.only('reproducer #4998 - beforeLoad is awaited before rendering', async () fireEvent.click(linkToFoo) await screen.findByText('Foo index page') - expect(resolved).toBe(2) - expect(beforeLoad).toHaveBeenCalledTimes(2) expect(beforeLoad).toHaveBeenNthCalledWith(2, expect.objectContaining({ cause: 'enter', @@ -797,4 +795,10 @@ test.only('reproducer #4998 - beforeLoad is awaited before rendering', async () expect(select).toHaveBeenNthCalledWith(1, expect.objectContaining({ foo: 'bar', })) + + // I'm not 100% sure this should be 2 here, + // maybe we can re-use the cached beforeLoad from preload in some cases + // but since we assert a 2nd beforeLoad call above, + // then we should have awaited its resolution too + expect(resolved).toBe(2) }) \ No newline at end of file From c109c029267aeae2fd8571fdd0c71edf95d94ec3 Mon Sep 17 00:00:00 2001 From: Sheraff Date: Tue, 19 Aug 2025 15:58:40 +0200 Subject: [PATCH 3/3] remove .only on new test --- packages/react-router/tests/loaders.test.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/react-router/tests/loaders.test.tsx b/packages/react-router/tests/loaders.test.tsx index ab50f7a604..8f6c63b89b 100644 --- a/packages/react-router/tests/loaders.test.tsx +++ b/packages/react-router/tests/loaders.test.tsx @@ -731,7 +731,7 @@ test('clears pendingTimeout when match resolves', async () => { }) -test.only('reproducer #4998 - beforeLoad is awaited before rendering', async () => { +test('reproducer #4998 - beforeLoad is awaited before rendering', async () => { const beforeLoad = vi.fn() const select = vi.fn() let resolved = 0