Skip to content
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
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Handle errors emitted while a cancelled Node readable stream is closing.
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import assert from "node:assert/strict";
import { createReadStream } from "node:fs";
import path from "node:path";
import { fileURLToPath } from "node:url";

const { createReadableStreamFromReadable } = await import(
process.env.STREAM_MODULE_PATH
);
let missingFile = path.join(
path.dirname(fileURLToPath(import.meta.url)),
"does-not-exist.txt",
);
let source = createReadStream(missingFile);
let closed = new Promise((resolve) => source.once("close", resolve));
let stream = createReadableStreamFromReadable(source);
await stream.cancel();
assert.equal(source.destroyed, true);
await closed;
assert.equal(source.closed, true);
console.log("process survived");
8 changes: 8 additions & 0 deletions packages/react-router-node/__tests__/stream-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -218,3 +218,11 @@ describe("writeAsyncIterableToWritable", () => {
);
});
});

describe("createReadableStreamFromReadable", () => {
it("does not crash when cancelling a file that fails to open", () => {
expect(runFixtureProcess("stream-cancelled-missing-file.mjs")).toEqual(
survivedProcess,
);
});
});
6 changes: 6 additions & 0 deletions packages/react-router-node/stream.ts
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,12 @@ class StreamPump {
this.stream.off("error", this.error);
this.stream.off("end", this.close);
this.stream.off("close", this.close);

// The destroyed stream can still emit an error (e.g. a file that fails to
// open after the cancel), so keep handling it until the stream closes
let ignoreError = () => {};
this.stream.on("error", ignoreError);
this.stream.once("close", () => this.stream.off("error", ignoreError));
}

enqueue(chunk: Uint8Array | string) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Handle `HEAD` response bodies consistently in Framework, RSC Framework, and RSC Data modes, preserving response metadata and deferred data handling.
138 changes: 138 additions & 0 deletions packages/react-router/__tests__/rsc/server-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
type RSCMatch,
type RSCRouteConfigEntry,
} from "../../lib/rsc/server.rsc";
import { routeRSCServerRequest } from "../../lib/rsc/server.ssr";
import { URL_LIMIT } from "../../lib/dom/ssr/fog-of-war";

describe("RSC server", () => {
Expand Down Expand Up @@ -59,6 +60,143 @@ describe("RSC server", () => {
expect(routeDiscovery.mode).toBe("lazy");
});

describe("request methods", () => {
test.each(["GET", "HEAD"])(
"handles %s resource responses",
async (method) => {
let finishCancellation = () => {};
let cancel = jest.fn(
() =>
new Promise<void>((_, reject) => {
finishCancellation = () => reject(new Error("Stream closed"));
}),
);
let body = new ReadableStream({
start(controller) {
controller.enqueue(new TextEncoder().encode("Hello"));
},
pull(controller) {
controller.close();
},
cancel,
});
let middlewareHasBody = false;
let response = await matchRSCServerRequest({
createTemporaryReferenceSet: () => ({}),
request: new Request("https://remix.run/resource", { method }),
routes: [
{
id: "resource",
path: "/resource",
middleware: [
async (_, next) => {
let response = await next();
middlewareHasBody = response.body !== null;
response.headers.set("X-Middleware", "yes");
return response;
},
],
loader: () =>
new Response(body, {
status: 201,
statusText: "Created",
headers: {
"Content-Type": "text/plain",
"Content-Length": "5",
},
}),
},
],
generateResponse() {
throw new Error(
"Resource response should not be encoded as Flight",
);
},
});

expect(middlewareHasBody).toBe(true);
expect(response.status).toBe(201);
expect(response.statusText).toBe("Created");
expect(response.headers.get("Content-Type")).toBe("text/plain");
expect(response.headers.get("Content-Length")).toBe("5");
expect(response.headers.get("X-Middleware")).toBe("yes");
expect(response.body === null).toBe(method === "HEAD");
expect(await response.text()).toBe(method === "HEAD" ? "" : "Hello");
expect(cancel).toHaveBeenCalledTimes(method === "HEAD" ? 1 : 0);
finishCancellation();
await new Promise((resolve) => setTimeout(resolve, 0));
},
);

test("preserves HEAD Flight bodies for SSR rendering", async () => {
let response = await matchRSCServerRequest({
createTemporaryReferenceSet: () => ({}),
request: new Request("https://remix.run/", { method: "HEAD" }),
routes: [{ id: "root", path: "/", Component: () => null }],
generateResponse: () => new Response("Encoded Flight"),
});

expect(response.headers.get("React-Router-Resource")).toBeNull();
expect(await response.text()).toBe("Encoded Flight");
});
});

test.each(["return", "throw"])(
"handles HEAD resource middleware responses (%s)",
async (behavior) => {
let cancel = jest.fn();
let resourceResponse = new Response(new ReadableStream({ cancel }), {
status: 403,
headers: { "Content-Type": "text/plain" },
});
let request = new Request("https://remix.run/resource", {
method: "HEAD",
});
let serverResponse = await matchRSCServerRequest({
createTemporaryReferenceSet: () => ({}),
request,
routes: [
{
id: "resource",
path: "/resource",
middleware: [
() => {
if (behavior === "throw") throw resourceResponse;
return resourceResponse;
},
],
loader() {
throw new Error("Resource loader should not be called");
},
},
],
generateResponse() {
throw new Error("Resource response should not be encoded as Flight");
},
});

expect(serverResponse.status).toBe(403);
expect(serverResponse.headers.get("Content-Type")).toBe("text/plain");
expect(serverResponse.headers.get("React-Router-Resource")).toBe("true");
expect(serverResponse.body).toBeNull();
expect(cancel).toHaveBeenCalledTimes(1);
expect(
await routeRSCServerRequest({
request,
serverResponse,
createFromReadableStream() {
throw new Error(
"Resource response should not be decoded as Flight",
);
},
renderHTML() {
throw new Error("Resource response should not be rendered as HTML");
},
}),
).toBe(serverResponse);
},
);

describe("manifest requests", () => {
test("rejects manifest requests over the URL limit", async () => {
let path = `/${"a".repeat(URL_LIMIT)}.manifest`;
Expand Down
69 changes: 62 additions & 7 deletions packages/react-router/__tests__/server-runtime/server-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@
* @jest-environment node
*/

import { setImmediate } from "node:timers/promises";

import { createContext, type StaticHandlerContext } from "react-router";

import { createRequestHandler } from "../../lib/server-runtime/server";
import { ServerMode } from "../../lib/server-runtime/mode";
import { URL_LIMIT } from "../../lib/dom/ssr/fog-of-war";
import { mockServerBuild } from "./utils";
import { Deferred } from "../../vendor/turbo-stream-v2/utils";

function spyConsole() {
// https://github.com/facebook/react/issues/7047
Expand Down Expand Up @@ -81,15 +84,67 @@ describe("server", () => {
},
);

it("strips body for HEAD requests", async () => {
let handler = createRequestHandler(build);
let response = await handler(
new Request("http://localhost:3000/", {
method: "HEAD",
}),
it.each(["GET", "HEAD"])("handles %s response bodies", async (method) => {
let cancel = jest.fn(() => Promise.reject(new Error("Stream closed")));
let body = new ReadableStream({
start(controller) {
controller.enqueue(new TextEncoder().encode("Hello"));
},
pull(controller) {
controller.close();
},
cancel,
});
let build = mockServerBuild(
{
root: { path: "/", default: () => null },
},
{
handleDocumentRequest: () =>
new Response(body, {
status: 201,
statusText: "Created",
headers: { "Content-Type": "text/plain" },
}),
},
);
let response = await createRequestHandler(build)(
new Request("http://localhost:3000/", { method }),
);

expect(await response.text()).toBe("");
expect(response.status).toBe(201);
expect(response.statusText).toBe("Created");
expect(response.headers.get("Content-Type")).toBe("text/plain");
expect(response.body === null).toBe(method === "HEAD");
expect(await response.text()).toBe(method === "HEAD" ? "" : "Hello");
expect(cancel).toHaveBeenCalledTimes(method === "HEAD" ? 1 : 0);
await setImmediate();
});

it("handles nested deferred rejections after a HEAD data response", async () => {
let outer = new Deferred();
let inner = new Deferred();
let build = mockServerBuild({
root: {
path: "/",
default: () => null,
loader: () => ({ outer: outer.promise }),
},
});
let response = await createRequestHandler(build)(
new Request("http://localhost:3000/_root.data", { method: "HEAD" }),
);

expect(response.status).toBe(200);
expect(response.headers.get("Content-Type")).toBe("text/x-script");
expect(response.body).toBeNull();

outer.resolve({ inner: inner.promise });
await setImmediate();
inner.reject(new Error("Nested deferred rejection"));
await setImmediate();

expect(spy.console).not.toHaveBeenCalled();
});

it("accepts proper values from getLoadContext (without middleware)", async () => {
Expand Down
21 changes: 20 additions & 1 deletion packages/react-router/lib/rsc/server.rsc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -491,14 +491,15 @@ export async function matchRSCServerRequest({
!leafMatch.route.Component &&
!leafMatch.route.ErrorBoundary
) {
return generateResourceResponse(
let response = await generateResourceResponse(
routerRequest,
routes,
basename,
leafMatch.route.id,
requestContext,
onError,
);
return normalizeResourceResponse(request, response);
}

let response = await generateRenderResponse(
Expand All @@ -523,6 +524,24 @@ export async function matchRSCServerRequest({
return response;
}

function normalizeResourceResponse(
request: Request,
response: Response,
): Response {
if (request.method === "HEAD") {
response.body?.cancel().catch(() => {});
let headers = new Headers(response.headers);
// Resource middleware can return before the response is tagged for SSR.
headers.set("React-Router-Resource", "true");
return new Response(null, {
status: response.status,
statusText: response.statusText,
headers,
});
}
return response;
}

async function generateManifestResponse(
routes: RSCRouteConfigEntry[],
basename: string | undefined,
Expand Down
2 changes: 2 additions & 0 deletions packages/react-router/lib/server-runtime/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,8 @@ function derive(build: ServerBuild, mode?: string) {
}

if (request.method === "HEAD") {
// Cancel the dropped body so its stream (e.g. an open file) is released
response.body?.cancel().catch(() => {});
return new Response(null, {
headers: response.headers,
status: response.status,
Expand Down
Loading
Loading