Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't run loaders below the boundary during partial hydration #11324

Merged
merged 1 commit into from Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/partial-hydration-bubbled-error.md
@@ -0,0 +1,5 @@
---
"@remix-run/router": patch
---

Fix a `future.v7_partialHydration` bug that would re-run loaders below the boundary on hydration if SSR loader errors bubbled to a parent boundary
59 changes: 58 additions & 1 deletion packages/router/__tests__/route-fallback-test.ts
Expand Up @@ -401,7 +401,7 @@ describe("future.v7_partialHydration", () => {
});
});

it("does not kick off initial data load if errors exist", async () => {
it("does not kick off initial data load if errors exist (parent error)", async () => {
let consoleWarnSpy = jest
.spyOn(console, "warn")
.mockImplementation(() => {});
Expand Down Expand Up @@ -457,5 +457,62 @@ describe("future.v7_partialHydration", () => {
router.dispose();
consoleWarnSpy.mockReset();
});

it("does not kick off initial data load if errors exist (bubbled child error)", async () => {
let consoleWarnSpy = jest
.spyOn(console, "warn")
.mockImplementation(() => {});
let parentDfd = createDeferred();
let parentSpy = jest.fn(() => parentDfd.promise);
let childDfd = createDeferred();
let childSpy = jest.fn(() => childDfd.promise);
let router = createRouter({
history: createMemoryHistory({ initialEntries: ["/child"] }),
routes: [
{
path: "/",
loader: parentSpy,
children: [
{
path: "child",
loader: childSpy,
},
],
},
],
future: {
v7_partialHydration: true,
},
hydrationData: {
errors: {
"0": "CHILD ERROR",
},
loaderData: {
"0": "PARENT DATA",
},
},
});
router.initialize();

expect(consoleWarnSpy).not.toHaveBeenCalled();
expect(parentSpy).not.toHaveBeenCalled();
expect(childSpy).not.toHaveBeenCalled();
expect(router.state).toMatchObject({
historyAction: "POP",
location: expect.objectContaining({ pathname: "/child" }),
matches: [{ route: { path: "/" } }, { route: { path: "child" } }],
initialized: true,
navigation: IDLE_NAVIGATION,
errors: {
"0": "CHILD ERROR",
},
loaderData: {
"0": "PARENT DATA",
},
});

router.dispose();
consoleWarnSpy.mockReset();
});
});
});
22 changes: 15 additions & 7 deletions packages/router/router.ts
Expand Up @@ -833,13 +833,21 @@ export function createRouter(init: RouterInit): Router {
// were marked for explicit hydration
let loaderData = init.hydrationData ? init.hydrationData.loaderData : null;
let errors = init.hydrationData ? init.hydrationData.errors : null;
initialized = initialMatches.every(
(m) =>
m.route.loader &&
m.route.loader.hydrate !== true &&
((loaderData && loaderData[m.route.id] !== undefined) ||
(errors && errors[m.route.id] !== undefined))
);
let isRouteInitialized = (m: AgnosticDataRouteMatch) =>
m.route.loader &&
m.route.loader.hydrate !== true &&
((loaderData && loaderData[m.route.id] !== undefined) ||
(errors && errors[m.route.id] !== undefined));

// If errors exist, don't consider routes below the boundary
if (errors) {
let idx = initialMatches.findIndex(
(m) => errors![m.route.id] !== undefined
);
initialized = initialMatches.slice(0, idx + 1).every(isRouteInitialized);
} else {
initialized = initialMatches.every(isRouteInitialized);
}
} else {
// Without partial hydration - we're initialized if we were provided any
// hydrationData - which is expected to be complete
Expand Down