router: Getting "Target container is not a DOM element" when preloading long data via Tanstack Query
Which project does this relate to?
Start
Describe the bug
Hi,
hope it is not a duplicate. 😃
Facts
When using TanStack Query with preloading from Routes loader, TanStack Start stringify query response data and sends it together with HTML document. Just at the end of <head> section.
JavaScript bundle with React component tree and hydrating functionality is at the begining of <head> section.
<body> with <div id="root"> comes last after <head>.
Problem
When data are very long, JS bundle is executed before data are streamed to a browser. And therefore before <div id="root"> is present.
Im getting this in browser console:
Uncaught Error: Minified React error #299; visit https://react.dev/errors/299 for the full message or use the non-minified dev environment for full errors and additional helpful warnings.
at Wc.hydrateRoot (client-DIQpUtaV.js:49:33157)
at client-DIQpUtaV.js:142:3802
At least, I guess this is what is happening. 😃
Related code:
~__root.tsx
...
export const Route = createRootRouteWithContext<{
queryClient: QueryClient;
}>()({
component: RootComponent,
meta: () => [ ...
2024/~_providers.$.tsx (child page)
loader: async ({ context }) => {
await context.queryClient.ensureQueryData(expensesDataQueryOptions()); // very long data
},
client.tsx
/// <reference types="vinxi/types/client" />
import { hydrateRoot } from "react-dom/client";
import { StartClient } from "@tanstack/start";
import { createRouter } from "./router";
const router = createRouter();
hydrateRoot(document.getElementById("root")!, <StartClient router={router} />);
router.tsx
import { QueryClient } from "@tanstack/react-query";
import { createRouter as createTanStackRouter } from "@tanstack/react-router";
import { routerWithQueryClient } from "@tanstack/react-router-with-query";
import { routeTree } from "./routeTree.gen";
export function createRouter() {
const queryClient = new QueryClient();
const router = createTanStackRouter({
routeTree,
context: { queryClient },
defaultPreload: "intent",
});
return routerWithQueryClient(router, queryClient);
}
declare module "@tanstack/react-router" {
interface Register {
router: ReturnType<typeof createRouter>;
}
}
ssr.tsx
/// <reference types="vinxi/types/server" />
import {
createStartHandler,
defaultStreamHandler,
} from "@tanstack/start/server";
import { getRouterManifest } from "@tanstack/start/router-manifest";
import { createRouter } from "./router";
export default createStartHandler({
createRouter,
getRouterManifest,
})(defaultStreamHandler);
Your Example Website or App
https://github.com/ondrejvelisek/peoples-budget
Steps to Reproduce the Bug or Issue
- Open link https://peoples-budget.vercel.app/2024/odvetvi
- Wait
- See error in console (In some cases it works. I guess it depends on network conditions or caching?)
Expected behavior
I expect page got hydrated and react runs on client.
Screenshots or Videos
Platform
- OS: macOS
- Browser: Chrome
- Version: 129.0.6668.90 (Official Build) (arm64)
Additional context
No response
About this issue
- Original URL
- State: open
- Created 2 years ago
- Comments: 16 (4 by maintainers)
@Aslam97 Thanks. Sometimes I just need another pair of eyes. Even though I went through the app folder of the 2nd repo. I completely missed the document change. Which the first repo had, hence why it worked.
Many thanks for letting me know.
This could be due to the
useQuerythat happens before the root is rendered into the shell. I’ll have a closer look in a bit.