Skip to content

fix(react-router): (v7) fix static prerender non-ascii problem #12161

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

Merged
merged 4 commits into from
Nov 12, 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/shiny-cameras-try.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"integration": patch
"@react-router/dev": patch
"react-router": patch
---

fix(react-router): (v7) fix static prerender of non-ascii characters
1 change: 1 addition & 0 deletions contributors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,7 @@
- rubeonline
- ryanflorence
- ryanhiebert
- saengmotmi
- sanketshah19
- saul-atomrigs
- sbolel
Expand Down
87 changes: 87 additions & 0 deletions integration/vite-prerender-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -560,6 +560,93 @@ test.describe("Prerendering", () => {
);
});

test("Handles UTF-8 characters in prerendered and non-prerendered routes", async ({
page,
}) => {
fixture = await createFixture({
prerender: false,
files: {
...files,
"vite.config.ts": js`
import { defineConfig } from "vite";
import { reactRouter } from "@react-router/dev/vite";

export default defineConfig({
build: { manifest: true },
plugins: [
reactRouter({
prerender: ["/", "/utf8-prerendered"],
})
],
});
`,
"app/routes/utf8-prerendered.tsx": js`
import { useLoaderData } from 'react-router';
export function loader({ request }) {
return {
prerendered: request.headers.has('X-React-Router-Prerender') ? 'yes' : 'no',
data: "한글 데이터 - UTF-8 문자",
};
}

export default function Comp() {
let data = useLoaderData();
return (
<>
<h1 data-title>UTF-8 Prerendered</h1>
<p data-prerendered>{data.prerendered}</p>
<p data-content>{data.data}</p>
</>
);
}
`,
"app/routes/utf8-not-prerendered.tsx": js`
import { useLoaderData } from 'react-router';
export function loader({ request }) {
return {
prerendered: request.headers.has('X-React-Router-Prerender') ? 'yes' : 'no',
data: "非プリレンダリングデータ - UTF-8文字",
};
}

export default function Comp() {
let data = useLoaderData();
return (
<>
<h1 data-title>UTF-8 Not Prerendered</h1>
<p data-prerendered>{data.prerendered}</p>
<p data-content>{data.data}</p>
</>
);
}
`,
},
});
appFixture = await createAppFixture(fixture);

let app = new PlaywrightFixture(appFixture, page);

// Test prerendered route with UTF-8 characters
await app.goto("/utf8-prerendered");
await page.waitForSelector("[data-mounted]");
expect(await app.getHtml("[data-title]")).toContain("UTF-8 Prerendered");
expect(await app.getHtml("[data-prerendered]")).toContain("yes");
expect(await app.getHtml("[data-content]")).toContain(
"한글 데이터 - UTF-8 문자"
);

// Test non-prerendered route with UTF-8 characters
await app.goto("/utf8-not-prerendered");
await page.waitForSelector("[data-mounted]");
expect(await app.getHtml("[data-title]")).toContain(
"UTF-8 Not Prerendered"
);
expect(await app.getHtml("[data-prerendered]")).toContain("no");
expect(await app.getHtml("[data-content]")).toContain(
"非プリレンダリングデータ - UTF-8文字"
);
});

test("Renders down to the proper HydrateFallback", async ({ page }) => {
fixture = await createFixture({
prerender: true,
Expand Down
2 changes: 1 addition & 1 deletion packages/react-router-dev/vite/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1888,7 +1888,7 @@ async function handlePrerender(
reactRouterConfig,
viteConfig,
data
? { headers: { ...headers, "X-React-Router-Prerender-Data": data } }
? { headers: { ...headers, "X-React-Router-Prerender-Data": encodeURI(data) } }
: { headers }
);
}
Expand Down
5 changes: 4 additions & 1 deletion packages/react-router/lib/server-runtime/routes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,12 @@ export function createStaticHandlerDataRoutes(
// If we're prerendering, use the data passed in from prerendering
// the .data route so we dom't call loaders twice
if (args.request.headers.has("X-React-Router-Prerender-Data")) {
let encoded = args.request.headers.get(
const preRenderedData = args.request.headers.get(
"X-React-Router-Prerender-Data"
);
let encoded = preRenderedData
? decodeURI(preRenderedData)
: preRenderedData;
invariant(encoded, "Missing prerendered data for route");
let uint8array = new TextEncoder().encode(encoded);
let stream = new ReadableStream({
Expand Down