Skip to content

Preserve hydrate property on client loaders during instrumentation #14674

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.

Sign up for GitHub

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

Merged
brophdawg11 merged 1 commit into from
Dec 19, 2025
+61 −1
Merged

Preserve hydrate property on client loaders during instrumentation #14674

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/young-geese-pay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-router": patch
---

Preserve `clientLoader.hydrate=true` when using `<HydratedRouter unstable_instrumentations>`
53 changes: 52 additions & 1 deletion packages/react-router/__tests__/router/instrumentation-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { createMemoryRouter } from "../../lib/components";
import { createMemoryHistory } from "../../lib/router/history";
import type { StaticHandlerContext } from "../../lib/router/router";
import { createStaticHandler } from "../../lib/router/router";
import { createRouter, createStaticHandler } from "../../lib/router/router";
import {
ErrorResponseImpl,
data,
Expand Down Expand Up @@ -112,6 +113,56 @@ describe("instrumentation", () => {
});
});

it("preserves hydrate=true on client side loaders", async () => {
let dfd = createDeferred();
let spy = jest.fn();
function loader() {
dfd.resolve();
return "INDEX*";
}
loader.hydrate = true;
let router = createRouter({
history: createMemoryHistory(),
routes: [
{
id: "index",
index: true,
loader,
},
],
hydrationData: {
loaderData: {
index: "INDEX",
},
},
unstable_instrumentations: [
{
route(route) {
route.instrument({
async loader(loader) {
spy("start");
await loader();
spy("end");
},
});
},
},
],
});

expect(router.state.initialized).toBe(false);
expect(router.state.loaderData).toEqual({ index: "INDEX" });

router.initialize();
await dfd.promise;
await tick();

expect(router.state.initialized).toBe(true);
expect(router.state.loaderData).toEqual({ index: "INDEX*" });
expect(spy).toHaveBeenCalledWith("start");
expect(spy).toHaveBeenCalledWith("end");
});

it("allows instrumentation of actions", async () => {
let spy = jest.fn();
let t = setup({
Expand Down
4 changes: 4 additions & 0 deletions packages/react-router/lib/router/instrumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import type {
FormEncType,
HTMLFormMethod,
LazyRouteObject,
LoaderFunction,
LoaderFunctionArgs,
MaybePromise,
MiddlewareFunction,
Expand Down Expand Up @@ -218,6 +219,9 @@ export function getRouteInstrumentationUpdates(
getHandlerInfo(args[0] as LoaderFunctionArgs | ActionFunctionArgs),
);
if (instrumented) {
if (key === "loader" && original.hydrate === true) {
(instrumented as LoaderFunction).hydrate = true;
}
// @ts-expect-error
instrumented[UninstrumentedSymbol] = original;
updates[key] = instrumented;
Expand Down