Skip to content

feat(remix-server-runtime): pass AppLoadContext to the server's handleRequest function #2045

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

Closed
wants to merge 2 commits into from
Closed
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: 6 additions & 1 deletion docs/api/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -494,14 +494,19 @@ import { renderToString } from "react-dom/server";
import type {
EntryContext,
HandleDataRequestFunction,
AppLoadContext,
} from "@remix-run/node"; // or cloudflare/deno
import { RemixServer } from "@remix-run/react";

export default function handleRequest(
request: Request,
responseStatusCode: number,
responseHeaders: Headers,
remixContext: EntryContext
remixContext: EntryContext,
// This is the context you passed in to your server adapter's getLoadContext() function.
// It is the same value that is also passed to your loaders and actions.
// See also the description of the loader `context` parameter later in this document.
loadContext: AppLoadContext,
) {
const markup = renderToString(
<RemixServer context={remixContext} url={request.url} />
Expand Down
29 changes: 29 additions & 0 deletions packages/remix-server-runtime/__tests__/server-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1720,5 +1720,34 @@ describe("shared server runtime", () => {
expect(calls.length).toBe(2 * DATA_CALL_MULTIPIER);
expect(spy.console.mock.calls.length).toBe(1 * DATA_CALL_MULTIPIER);
});

test("provides load context to server entrypoint", async () => {
let build = mockServerBuild({
root: {
default: {},
},
"routes/index": {
parentId: "root",
default: () => null,
index: true
}
});

build.entry.module.default = jest.fn(
async (request, responseStatusCode, responseHeaders, entryContext, loadContext) =>
new Response(loadContext, {
status: responseStatusCode,
headers: responseHeaders
})
);

let handler = createRequestHandler(build, {}, ServerMode.Development);
let request = new Request(`${baseUrl}/`, { method: "get" });
let loadContext = "load context";

let result = await handler(request, loadContext);
expect(result.status).toBe(200);
expect(await result.text()).toBe(loadContext);
});
});
});
2 changes: 1 addition & 1 deletion packages/remix-server-runtime/__tests__/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export function mockServerBuild(
entry: {
module: {
default: jest.fn(
async (request, responseStatusCode, responseHeaders, entryContext) =>
async (request, responseStatusCode, responseHeaders, entryContext, loadContext) =>
new Response(null, {
status: responseStatusCode,
headers: responseHeaders,
Expand Down
4 changes: 3 additions & 1 deletion packages/remix-server-runtime/build.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import type { DataFunctionArgs } from "./routeModules";
import type { AssetsManifest, EntryContext, FutureConfig } from "./entry";
import type { ServerRouteManifest } from "./routes";
import type { AppLoadContext } from "./data";

/**
* The output of the compiler for the server build.
Expand All @@ -21,7 +22,8 @@ export interface HandleDocumentRequestFunction {
request: Request,
responseStatusCode: number,
responseHeaders: Headers,
context: EntryContext
context: EntryContext,
loadContext: AppLoadContext
): Promise<Response> | Response;
}

Expand Down
6 changes: 4 additions & 2 deletions packages/remix-server-runtime/server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -828,7 +828,8 @@ async function handleDocumentRequest({
request,
responseStatusCode,
responseHeaders,
entryContext
entryContext,
loadContext
);
} catch (error: any) {
responseStatusCode = 500;
Expand All @@ -848,7 +849,8 @@ async function handleDocumentRequest({
request,
responseStatusCode,
responseHeaders,
entryContext
entryContext,
loadContext
);
} catch (error: any) {
return returnLastResortErrorResponse(error, serverMode);
Expand Down