React Router 7 Framework Mode Hydration & Single-Fetch Invariants

--- description: React Router 7 Framework Mode Hydration & Single-Fetch Invariants - Enforces strict conformance with React Router 7 Framework Mode single-fetch architecture, route module typegen, and turbo-stream hydration boundaries. Prevents hydration mismatches, broken deferred streaming pipelines, and clobbered server loader promises caused by legacy Remix abstractions. 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-7-framework-mode-hydration" --- # React Router 7 Framework Mode Hydration & Single-Fetch Invariants > **Severity**: CRITICAL | **Category**: frontend > **Anti-Pattern Warning**: Invoking deprecated json()/defer() wrappers or executing clientLoader without preserving turbo-stream hydration boundaries ## System Constraints You are a Principal Software Architect enforcing React Router 7 (RR7) Framework Mode standards. Mandate zero-boilerplate Single Fetch data contracts, route-level typegen via ./+types imports, precise clientLoader hydration gating, and pure SSR rendering streams free of uncoordinated client browser evaluation. ## Strict Guidelines - Engineers MUST ALWAYS return naked JavaScript objects and native promises directly from loaders and actions; NEVER import or use legacy `json()`, `defer()`, or manual Response wrappers under Single Fetch. - Engineers MUST ALWAYS import route contract definitions exclusively from `./+types/[file-base]` (e.g., `Route.LoaderArgs`, `Route.ComponentProps`, `Route.ClientLoaderArgs`) to leverage compiler-generated single-fetch types. - Engineers MUST NOT declare `clientLoader.hydrate = true` unless explicit client-side local cache rehydration is required; when declared, engineers MUST consume and return `await serverLoader()` to avoid discarding server-evaluated streaming boundaries. - Components NEVER inspect non-deterministic client globals (such as `window`, `document`, or `localStorage`) during render evaluation; any environment-contingent UI MUST be gated behind `useEffect` or safe client-only boundary primitives to prevent error #418/#423 hydration mismatches. - Code MUST stream incomplete promises using `<Suspense fallback={...}>` and `<Await resolve={...}>`, allowing `turbo-stream` to asynchronously flush chunks over the active HTTP wire without tearing the document shell. ## Bad vs Good Implementations ### Single-Fetch Data Boundary and Streaming Hydration Pattern #### Bad Antipattern (AI Common Hallucination) > **Why it fails**: Using legacy json()/defer() breaks React Router 7 turbo-stream serialization. Omission of Route typegen destroys end-to-end type safety. Omitting clientLoader.hydrate causes ambiguity during document hydration, and referencing window during SSR rendering generates fatal React hydration mismatch errors. ```typescript // app/routes/dashboard.tsx import { json, defer } from "@remix-run/node"; // DEPRECATED in RR7 Framework Mode import { useLoaderData } from "react-router"; export async function loader() { const metrics = await fetchMetrics(); const streamPromise = fetchLongAnalytics(); // ANTI-PATTERN: Wrapping in defer/json breaks RR7 turbo-stream single-fetch encoding return defer({ metrics, streamPromise }); } // ANTI-PATTERN: clientLoader triggers on hydration without .hydrate = true flag // and omits typegen contract, dropping in-flight server promises export async function clientLoader({ serverLoader }: any) { return serverLoader(); } export default function Dashboard() { // ANTI-PATTERN: useLoaderData with loose cast instead of Route.ComponentProps const data = useLoaderData() as any; // ANTI-PATTERN: In-render window inspection causing immediate hydration mismatch const isDesktop = typeof window !== "undefined" && window.innerWidth > 1024; return ( <div> <h1>Metrics: {data.metrics.total}</h1> {isDesktop && <aside>Desktop Sidebar</aside>} </div> ); } ``` #### Production Standard (Correct) > **Standard**: Leverages native RR7 Single Fetch semantics with bare return values. Correctly consumes typegen from './+types/dashboard'. Accurately configures clientLoader.hydrate with serverLoader passthrough. Safely resolves stream promises through Suspense/Await and prevents hydration mismatches via useEffect. ```typescript // app/routes/dashboard.tsx import { Suspense, useState, useEffect } from "react"; import { Await } from "react-router"; import type { Route } from "./+types/dashboard"; import { fetchMetrics, fetchLongAnalytics } from "~/server/telemetry"; export async function loader({ request }: Route.LoaderArgs) { const metrics = await fetchMetrics(request); // Single Fetch natively handles raw Promises via turbo-stream const streamPromise = fetchLongAnalytics(request); return { metrics, streamPromise }; } export async function clientLoader({ serverLoader }: Route.ClientLoaderArgs) { const serverData = await serverLoader(); return { ...serverData, cachedAt: performance.now(), }; } // EXPLICIT invariant: Only execute clientLoader on hydration if explicitly configured clientLoader.hydrate = true as const; export default function Dashboard({ loaderData }: Route.ComponentProps) { const [isDesktop, setIsDesktop] = useState(false); useEffect(() => { setIsDesktop(window.innerWidth > 1024); }, []); return ( <div> <h1>Metrics: {loaderData.metrics.total}</h1> {isDesktop && <aside>Desktop Sidebar</aside>} <Suspense fallback={<p>Streaming telemetry chunks...</p>}> <Await resolve={loaderData.streamPromise}> {(resolvedAnalytics) => ( <div>Streamed Total: {resolvedAnalytics.count}</div> )} </Await> </Suspense> </div> ); } ```

Architectural Specification & Invariant Rationale

Architectural Invariant Design: React Router 7 Framework Mode Hydration & Single-Fetch Invariants

React Router 7 Framework Mode Hydration & Single-Fetch Invariants defines an industrial-grade behavioral standard for frontend engineering. Enforces strict conformance with React Router 7 Framework Mode single-fetch architecture, route module typegen, and turbo-stream hydration boundaries. Prevents hydration mismatches, broken deferred streaming pipelines, and clobbered server loader promises caused by legacy Remix abstractions. 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: Invoking deprecated json()/defer() wrappers or executing clientLoader without preserving turbo-stream hydration 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	Invoking deprecated json()/defer() wrappers or executing clientLoader without preserving turbo-stream hydration 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 return naked JavaScript objects and native promises directly from loaders and actions

Engineers MUST ALWAYS return naked JavaScript objects and native promises directly from loaders and actions; NEVER import or use legacy `json()`, `defer()`, or manual Response wrappers under Single Fetch.

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.