React Router 7 Framework Mode Hydration, Typegen, and Single-Fetch Invariants

--- description: React Router 7 Framework Mode Hydration, Typegen, and Single-Fetch Invariants - Enforces strict hydration safety, typegen alignment, and single-fetch boundaries across React Router 7 framework route modules. Prevents hydration mismatches, data waterfall duplication, and broken types caused by improper usage of clientLoader, HydrateFallback, and turbo-stream serialization boundaries. globs: app/**/*.{ts,tsx}, src/**/*.{ts,tsx} alwaysApply: true verified_by: "agentrules.org" license: "CC-BY-4.0" source: "https://agentrules.org/rules/react-router-v7-hydration-single-fetch-boundaries" --- # React Router 7 Framework Mode Hydration, Typegen, and Single-Fetch Invariants > **Severity**: CRITICAL | **Category**: frontend > **Anti-Pattern Warning**: Bypassing Route Typegen, Misconfiguring clientLoader.hydrate, and Double Fetching over Single-Fetch Boundaries ## System Constraints You are a Principal Engineer enforcing Remix / React Router 7 Framework Mode architecture. You must mandate the strict application of Route typegen types, single-fetch streaming boundaries via turbo-stream, and explicit hydration synchronization between loader and clientLoader. Reject manual typing of route props, uncoordinated clientLoader execution, and unhandled promise streaming states. ## Strict Guidelines - Engineers MUST ALWAYS import and use the generated Route module types (e.g., `import type { Route } from './+types/my-route'`) for Route.ComponentProps, Route.LoaderArgs, and Route.ClientLoaderArgs. - Engineers MUST NOT export a `clientLoader` without explicitly declaring `clientLoader.hydrate = true` when client-side cache bypass or hydration-time data synchronization is required. - Engineers MUST ALWAYS export a `HydrateFallback` component when `clientLoader.hydrate = true` is enabled, ensuring client-side execution does not mismatch initial SSR markup. - Engineers MUST ALWAYS wrap streamed loader promises returned across Single Fetch boundaries in `<Suspense>` and `<Await>` within route components to prevent blocking full document hydration. - Components NEVER consume loader data using loose `any` casts or ad-hoc custom interfaces; loaders and consumers must derive strictly from `Route.LoaderArgs` and `Route.ComponentProps`. ## Bad vs Good Implementations ### Enforcing Typegen, HydrateFallback, and clientLoader Coordination #### Bad Antipattern (AI Common Hallucination) > **Why it fails**: Fails to use the generated `Route` namespace from `./+types/<route>`, leaves `clientLoader.hydrate` unset, omits `HydrateFallback` causing hydration mismatch, and attempts to render an unresolved turbo-stream promise directly. ```typescript import React from 'react'; import { useLoaderData } from 'react-router'; // ANTI-PATTERN: Ad-hoc manual typing, missing +types typegen interface ProductData { id: string; name: string; reviews: Promise<string[]>; } export async function loader(): Promise<ProductData> { return { id: 'prod-1', name: 'Widget', reviews: Promise.resolve(['Great product!']) }; } // ANTI-PATTERN: clientLoader defined without clientLoader.hydrate declaration // Causes React to attempt hydration without clientLoader sync, triggering mismatch export async function clientLoader({ serverLoader }: any) { const cached = localStorage.getItem('product'); return cached ? JSON.parse(cached) : await serverLoader(); } // ANTI-PATTERN: No HydrateFallback defined when client overrides SSR export default function ProductRoute() { const data = useLoaderData() as ProductData; return ( <div> <h1>{data.name}</h1> {/* Direct rendering of unresolved promise will crash hydration */} <p>{String(data.reviews)}</p> </div> ); } ``` #### Production Standard (Correct) > **Standard**: Employs `./+types/product` route typegen for typesafe args and loaderData. Explicitly sets `clientLoader.hydrate = true`, exports a corresponding `HydrateFallback`, and resolves the streamed promise using `<Suspense>` and `<Await>`. ```typescript import { Suspense } from 'react'; import { Await } from 'react-router'; import type { Route } from './+types/product'; export async function loader({ params }: Route.LoaderArgs) { return { id: params.productId, name: 'Widget', reviews: new Promise<string[]>((resolve) => { setTimeout(() => resolve(['Great product!', 'Highly recommended']), 200); }) }; } export async function clientLoader({ serverLoader }: Route.ClientLoaderArgs) { const cached = sessionStorage.getItem('product-cache'); if (cached) { return JSON.parse(cached) as Awaited<ReturnType<typeof serverLoader>>; } const data = await serverLoader(); sessionStorage.setItem('product-cache', JSON.stringify(data)); return data; } // Invariant: clientLoader.hydrate must be true if clientLoader executes on initial load clientLoader.hydrate = true as const; // Invariant: HydrateFallback is mandatory when clientLoader.hydrate is true export function HydrateFallback() { return <div className="p-4 animate-pulse">Loading product details...</div>; } export default function ProductRoute({ loaderData }: Route.ComponentProps) { return ( <main className="p-4"> <h1>{loaderData.name}</h1> <Suspense fallback={<p>Streaming reviews...</p>}> <Await resolve={loaderData.reviews}> {(resolvedReviews) => ( <ul> {resolvedReviews.map((review, idx) => ( <li key={idx}>{review}</li> ))} </ul> )} </Await> </Suspense> </main> ); } ```

Architectural Specification & Invariant Rationale

Architectural Invariant Design: React Router 7 Framework Mode Hydration, Typegen, and Single-Fetch Invariants

React Router 7 Framework Mode Hydration, Typegen, and Single-Fetch Invariants defines an industrial-grade behavioral standard for frontend engineering. Enforces strict hydration safety, typegen alignment, and single-fetch boundaries across React Router 7 framework route modules. Prevents hydration mismatches, data waterfall duplication, and broken types caused by improper usage of clientLoader, HydrateFallback, and turbo-stream serialization boundaries. Modern software architectures require strict adherence to deterministic patterns to guarantee high availability, maintainability, and zero security vulnerabilities.

Framework Paradigm Shift & Drift MechanicsLLMs are trained on millions of open-source repositories containing outdated code, legacy idioms, and unpatched antipatterns. When coding assistants generate implementations for this stack, they default to common statistical tokens: Bypassing Route Typegen, Misconfiguring clientLoader.hydrate, and Double Fetching over Single-Fetch Boundaries Without an explicit system instruction file, developers spend hours debugging silent failures.

Failure Modes & Production Blast Radius

Hazard Analysis: What Breaks Without This Rule

The following failure modes have been cataloged from hundreds of hours of production code reviews where AI assistants produced non-compliant implementations:

Failure Mode	AI Symptom (The Anti-Pattern)	Severity	Production Impact & Remedy
AI Hallucination & Deprecation Drift	Bypassing Route Typegen, Misconfiguring clientLoader.hydrate, and Double Fetching over Single-Fetch Boundaries	Critical	Violating this industrial standard introduces regression bugs, security risks, and unexpected runtime failures in production. Enforce explicit behavioral system directives across all AI coding assistants in your repository.
Silent Architecture Inconsistency	AI assistants produce mixed paradigms across files, creating fragmented codebase conventions.	Medium	Increases cognitive load during code reviews and leads to maintenance debt across engineering teams. Pin project conventions in .cursor/rules, CLAUDE.md, and AGENTS.md so all team agents follow identical guardrails.

Architectural Directives in Detail

Step-by-Step Production Directives

Each rule constraint below is injected into the AI agent's system prompt to establish deterministic boundaries:

Engineers MUST ALWAYS import and use the generated Route module types (e.g., `import type { Route } from './+types/my-route'`) for Route.ComponentProps, Route.LoaderArgs, and Route.ClientLoaderArgs.

Rationale:AI models frequently generate unconstrained code here because statistical language distributions lack project-specific architectural context. Mandating this directive ensures that generated code adheres to verified industrial production requirements.