Skip to content

Ensure resource route errors go through handleError w/middleware enabled #14078

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.

Sign up for GitHub

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 3 commits into from
Jul 29, 2025
Merged

Ensure resource route errors go through handleError w/middleware enabled #14078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e62505
Ensure resource route errors go through handleError when middleware i…
brophdawg11 Jul 25, 2025
e8a9e92
Update tests
brophdawg11 Jul 25, 2025
69ff159
Add changeset
brophdawg11 Jul 29, 2025
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
5 changes: 5 additions & 0 deletions .changeset/cool-pigs-cheer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-router": patch
---

[UNSTABLE] Ensure resource route errors go through `handleError` w/middleware enabled
101 changes: 48 additions & 53 deletions packages/react-router/__tests__/router/context-middleware-test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2704,16 +2704,11 @@ describe("context/middleware", () => {
},
]);

let res = await handler.queryRoute(
new Request("http://localhost/parent/"),
{
await expect(
handler.queryRoute(new Request("http://localhost/parent/"), {
unstable_respond: (v) => v,
},
);

expect(await res.text()).toBe(
"Error: You may only call `next()` once per middleware",
);
}),
).rejects.toThrow("You may only call `next()` once per middleware");
});
});

Expand Down Expand Up @@ -2756,14 +2751,12 @@ describe("context/middleware", () => {
]);

let requestContext = new unstable_RouterContextProvider();
let res = await handler.queryRoute(
new Request("http://localhost/parent/child"),
{
await expect(
handler.queryRoute(new Request("http://localhost/parent/child"), {
requestContext,
unstable_respond: (v) => v,
},
);
expect(await res.text()).toBe("Error: PARENT 2");
}),
).rejects.toThrow("PARENT 2");

expect(requestContext.get(parentContext)).toEqual("PARENT 1");
expect(requestContext.get(childContext)).toEqual("empty");
Expand Down Expand Up @@ -2808,14 +2801,12 @@ describe("context/middleware", () => {
]);

let requestContext = new unstable_RouterContextProvider();
let res = await handler.queryRoute(
new Request("http://localhost/parent/child"),
{
await expect(
handler.queryRoute(new Request("http://localhost/parent/child"), {
requestContext,
unstable_respond: (v) => v,
},
);
expect(await res.text()).toBe("Error: CHILD UP");
}),
).rejects.toThrow("CHILD UP");

expect(requestContext.get(parentContext)).toEqual("PARENT DOWN");
expect(requestContext.get(childContext)).toEqual("CHILD DOWN");
Expand Down Expand Up @@ -2883,14 +2874,15 @@ describe("context/middleware", () => {
]);

let requestContext = new unstable_RouterContextProvider();
let res = await handler.queryRoute(
new Request("http://localhost/parent/child", {
method: "post",
body: createFormData({}),
}),
{ requestContext, unstable_respond: (v) => v },
);
expect(await res.text()).toEqual("Error: child 1 error");
await expect(
handler.queryRoute(
new Request("http://localhost/parent/child", {
method: "post",
body: createFormData({}),
}),
{ requestContext, unstable_respond: (v) => v },
),
).rejects.toThrow("child 1 error");

expect(requestContext.get(orderContext)).toEqual([
"parent start",
Expand Down Expand Up @@ -2966,14 +2958,15 @@ describe("context/middleware", () => {
]);

let requestContext = new unstable_RouterContextProvider();
let res = await handler.queryRoute(
new Request("http://localhost/parent/child", {
method: "post",
body: createFormData({}),
}),
{ requestContext, unstable_respond: (v) => v },
);
expect(await res.text()).toEqual("Error: child 2 error");
await expect(
handler.queryRoute(
new Request("http://localhost/parent/child", {
method: "post",
body: createFormData({}),
}),
{ requestContext, unstable_respond: (v) => v },
),
).rejects.toThrow("child 2 error");

expect(requestContext.get(orderContext)).toEqual([
"parent start",
Expand Down Expand Up @@ -3046,14 +3039,15 @@ describe("context/middleware", () => {
]);

let requestContext = new unstable_RouterContextProvider();
let res = await handler.queryRoute(
new Request("http://localhost/parent/child", {
method: "post",
body: createFormData({}),
}),
{ requestContext, unstable_respond: (v) => v },
);
expect(await res.text()).toEqual("Error: child 1 action error");
await expect(
handler.queryRoute(
new Request("http://localhost/parent/child", {
method: "post",
body: createFormData({}),
}),
{ requestContext, unstable_respond: (v) => v },
),
).rejects.toThrow("child 1 action error");

expect(requestContext.get(orderContext)).toEqual([
"parent action start",
Expand Down Expand Up @@ -3129,14 +3123,15 @@ describe("context/middleware", () => {
]);

let requestContext = new unstable_RouterContextProvider();
let res = await handler.queryRoute(
new Request("http://localhost/parent/child", {
method: "post",
body: createFormData({}),
}),
{ requestContext, unstable_respond: (v) => v },
);
expect(await res.text()).toEqual("Error: child 2 error");
await expect(
handler.queryRoute(
new Request("http://localhost/parent/child", {
method: "post",
body: createFormData({}),
}),
{ requestContext, unstable_respond: (v) => v },
),
).rejects.toThrow("child 2 error");

expect(requestContext.get(orderContext)).toEqual([
"parent start",
Expand Down
86 changes: 70 additions & 16 deletions packages/react-router/lib/router/router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,10 @@ export interface StaticHandler {
requestContext?: unknown;
dataStrategy?: DataStrategyFunction<unknown>;
unstable_respond?: (res: Response) => MaybePromise<Response>;
unstable_stream?: (
context: unstable_RouterContextProvider,
queryRoute: (r: Request) => Promise<Response>,
) => MaybePromise<Response>;
},
): Promise<any>;
}
Expand Down Expand Up @@ -3845,6 +3849,7 @@ export function createStaticHandler(
requestContext,
dataStrategy,
unstable_respond: respond,
unstable_stream: stream,
}: Parameters<StaticHandler["queryRoute"]>[1] = {},
): Promise<any> {
let url = new URL(request.url);
Expand Down Expand Up @@ -3878,13 +3883,14 @@ export function createStaticHandler(
}

if (
respond &&
matches.some(
(m) =>
m.route.unstable_middleware ||
(typeof m.route.lazy === "object" &&
m.route.lazy.unstable_middleware),
)
stream ||
(respond &&
matches.some(
(m) =>
m.route.unstable_middleware ||
(typeof m.route.lazy === "object" &&
m.route.lazy.unstable_middleware),
))
) {
invariant(
requestContext instanceof unstable_RouterContextProvider,
Expand All @@ -3903,6 +3909,54 @@ export function createStaticHandler(
},
true,
async () => {
if (stream) {
let res = await stream(
requestContext as unstable_RouterContextProvider,
async (revalidationRequest: Request) => {
let result = await queryImpl(
revalidationRequest,
location,
matches!,
requestContext,
dataStrategy || null,
false,
match!,
null,
false,
);

if (isResponse(result)) {
return result;
}

let error = result.errors
? Object.values(result.errors)[0]
: undefined;

if (error !== undefined) {
// If we got back result.errors, that means the loader/action threw
// _something_ that wasn't a Response, but it's not guaranteed/required
// to be an `instanceof Error` either, so we have to use throw here to
// preserve the "error" state outside of queryImpl.
throw error;
}

// Pick off the right state value to return
let value = result.actionData
? Object.values(result.actionData)[0]
: Object.values(result.loaderData)[0];

return typeof value === "string"
? new Response(value)
: Response.json(value);
},
);
return res;
}

// Should always be true given the if statement above
invariant(respond, "Expected respond to be defined");

let result = await queryImpl(
request,
location,
Expand Down Expand Up @@ -3936,18 +3990,17 @@ export function createStaticHandler(
? Object.values(result.actionData)[0]
: Object.values(result.loaderData)[0];

return typeof value === "string"
? new Response(value)
: Response.json(value);
return respond(
typeof value === "string"
? new Response(value)
: Response.json(value),
);
},
(error) => {
if (isResponse(error)) {
return respond(error);
return respond ? respond(error) : error;
}
return new Response(String(error), {
status: 500,
statusText: "Unexpected Server Error",
});
throw error;
},
);
return response;
Expand Down Expand Up @@ -5595,7 +5648,8 @@ async function callRouteMiddleware(
return result;
}
} else {
return next();
result = await next();
return result;
}
} catch (error) {
if (!middlewareState.middlewareError) {
Expand Down
40 changes: 38 additions & 2 deletions packages/react-router/lib/server-runtime/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,8 +619,44 @@ async function handleResourceRequest(
let response = await staticHandler.queryRoute(request, {
routeId,
requestContext: loadContext,
unstable_respond: build.future.unstable_middleware
? (ctx) => ctx
unstable_stream: build.future.unstable_middleware
? async (_, queryRoute) => {
try {
let result = await queryRoute(request);
if (isResponse(result)) {
return result;
}

if (typeof result === "string") {
return new Response(result);
}

return Response.json(result);
} catch (error) {
if (isResponse(error)) {
return error;
}

if (isRouteErrorResponse(error)) {
handleError(error);
return errorResponseToJson(error, serverMode);
}

if (
error instanceof Error &&
error.message === "Expected a response from queryRoute"
) {
let newError = new Error(
"Expected a Response to be returned from resource route handler",
);
handleError(newError);
return returnLastResortErrorResponse(newError, serverMode);
}

handleError(error);
return returnLastResortErrorResponse(error, serverMode);
}
}
: undefined,
});

Expand Down