Skip to content

feat(react-router-express): support non-express servers #13742

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

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from
Draft
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
5 changes: 5 additions & 0 deletions .changeset/sharp-nails-complain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@react-router/express": minor
---

Add support for web servers other than express.
1 change: 1 addition & 0 deletions contributors.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
- 0xEddie
- 3fuyang
- 43081j
- aarbi
- abdallah-nour
- abeadam
Expand Down
43 changes: 26 additions & 17 deletions packages/react-router-express/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ import {
createReadableStreamFromReadable,
writeReadableStreamToWritable,
} from "@react-router/node";
import type { IncomingMessage, ServerResponse } from "node:http";
import { TLSSocket } from "node:tls";

type MaybePromise<T> = T | Promise<T>;

Expand All @@ -26,15 +28,15 @@ type MaybePromise<T> = T | Promise<T>;
* values that are generated by Express middleware like `req.session`.
*/
export type GetLoadContextFunction = (
req: express.Request,
res: express.Response
req: IncomingMessage,
res: ServerResponse
) => MiddlewareEnabled extends true
? MaybePromise<unstable_InitialContext>
: MaybePromise<AppLoadContext>;

export type RequestHandler = (
req: express.Request,
res: express.Response,
req: IncomingMessage,
res: ServerResponse,
next: express.NextFunction
) => Promise<void>;

Expand All @@ -53,9 +55,9 @@ export function createRequestHandler({
let handleRequest = createRemixRequestHandler(build, mode);

return async (
req: express.Request,
res: express.Response,
next: express.NextFunction
req: IncomingMessage,
res: ServerResponse,
next: (err?: unknown) => void
) => {
try {
let request = createRemixRequest(req, res);
Expand All @@ -73,7 +75,7 @@ export function createRequestHandler({
}

export function createRemixHeaders(
requestHeaders: express.Request["headers"]
requestHeaders: IncomingMessage["headers"]
): Headers {
let headers = new Headers();

Expand All @@ -93,13 +95,16 @@ export function createRemixHeaders(
}

export function createRemixRequest(
req: express.Request,
res: express.Response
req: IncomingMessage,
res: ServerResponse
): Request {
// req.hostname doesn't include port information so grab that from
// `X-Forwarded-Host` or `Host`
let [, hostnamePortStr] = req.get("X-Forwarded-Host")?.split(":") ?? [];
let [, hostPortStr] = req.get("host")?.split(":") ?? [];
let [, hostnamePortStr] =
typeof req.headers["X-Forwarded-Host"] === "string"
? req.headers["X-Forwarded-Host"].split(":")
: [];
let [, hostPortStr] = req.headers["host"]?.split(":") ?? [];
let hostnamePort = Number.parseInt(hostnamePortStr, 10);
let hostPort = Number.parseInt(hostPortStr, 10);
let port = Number.isSafeInteger(hostnamePort)
Expand All @@ -108,9 +113,13 @@ export function createRemixRequest(
? hostPort
: "";
// Use req.hostname here as it respects the "trust proxy" setting
let resolvedHost = `${req.hostname}${port ? `:${port}` : ""}`;
const protocol = req.socket instanceof TLSSocket ? "https" : "http";
const requestUrl = new URL(
`${protocol}://${req.headers.host}${req.url ?? ""}`
);
let resolvedHost = `${requestUrl.hostname}${port ? `:${port}` : ""}`;
// Use `req.originalUrl` so Remix is aware of the full path
let url = new URL(`${req.protocol}://${resolvedHost}${req.originalUrl}`);
let url = new URL(`${protocol}://${resolvedHost}${req.url}`);

// Abort action/loaders once we can no longer write a response
let controller: AbortController | null = new AbortController();
Expand All @@ -136,14 +145,14 @@ export function createRemixRequest(
}

export async function sendRemixResponse(
res: express.Response,
res: ServerResponse,
nodeResponse: Response
): Promise<void> {
res.statusMessage = nodeResponse.statusText;
res.status(nodeResponse.status);
res.statusCode = nodeResponse.status;

for (let [key, value] of nodeResponse.headers.entries()) {
res.append(key, value);
res.appendHeader(key, value);
}

if (nodeResponse.headers.get("Content-Type")?.match(/text\/event-stream/i)) {
Expand Down
Loading