Skip to content

ref(remix): Avoid unnecessary error wrapping HandleDocumentRequestFunction #17680

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 4 commits into from
Sep 17, 2025
Merged

ref(remix): Avoid unnecessary error wrapping HandleDocumentRequestFunction #17680

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d3e9a08
fix(remix): Actually capture exceptions for `HandleDocumentRequestFun…
mydea Sep 17, 2025
e11807c
drop it instead
mydea Sep 17, 2025
0286ca1
fix it
mydea Sep 17, 2025
783d85d
fix lint
mydea Sep 17, 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
7 changes: 3 additions & 4 deletions packages/remix/src/server/errors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,10 @@ export function errorHandleDocumentRequestFunction(
const { request, responseStatusCode, responseHeaders, context, loadContext } = requestContext;

return handleCallbackErrors(
() => {
return origDocumentRequestFunction.call(this, request, responseStatusCode, responseHeaders, context, loadContext);
},
() => origDocumentRequestFunction.call(this, request, responseStatusCode, responseHeaders, context, loadContext),
err => {
throw err;
// eslint-disable-next-line @typescript-eslint/no-floating-promises
captureRemixServerException(err, 'HandleDocumentRequestFunction', request);
},
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Potential bug: The error callback for HandleDocumentRequestFunction no longer re-throws errors, swallowing exceptions and breaking the error handling flow for document requests.

  • Description: The onError callback for errorHandleDocumentRequestFunction no longer re-throws the caught error. This violates the contract of the handleCallbackErrors utility, which is designed to always propagate exceptions after executing the callback. By removing throw err;, any error occurring during the server-side document rendering process is captured but then swallowed. This prevents Remix's higher-level error handling from triggering, which can lead to clients receiving incomplete or invalid HTML responses instead of a proper error page, while the server continues in an inconsistent state.

  • Suggested fix: Restore the original behavior by re-adding throw err; at the end of the onError callback. This ensures that after the exception is captured, it is correctly propagated, allowing Remix's standard error handling mechanisms to generate a proper error response.
    severity: 0.85, confidence: 0.98

Did we get this right? 👍 / 👎 to inform future reviews.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this already re-throws out of the box.

);
}
Expand Down
Loading