feat(rsc): add unstable_getRequest (#14758)

Author: jacob-ebey

.changeset/plenty-olives-rush.md

@@ -0,0 +1,5 @@
+---
+"react-router": patch
+---
+
+add RSC unstable_getRequest

integration/rsc/rsc-test.ts

@@ -545,7 +545,12 @@ implementations.forEach((implementation) => {
                       id: "render-route-error-response",
                       path: "render-route-error-response/:id?",
                       lazy: () => import("./routes/render-route-error-response/home"),
-                    }
+                    },
+                    {
+                      id: "get-request",
+                      path: "/get-request",
+                      lazy: () => import("./routes/get-request/get-request"),
+                    },
                   ],
                 },
               ] satisfies RSCRouteConfig;
@@ -1549,6 +1554,17 @@ implementations.forEach((implementation) => {
                 return <p>Oh no D:</p>;
               }
             `,
+
+            "src/routes/get-request/get-request.tsx": js`
+              import { unstable_getRequest as getRequest } from "react-router";
+
+              export function action() { return null; }
+
+              export default function GetRequest() {
+                const request = getRequest();
+                return <p>{request.method}</p>;
+              }
+            `,
           },
         });
       });
@@ -1892,6 +1908,20 @@ implementations.forEach((implementation) => {
           );
           await expect(page.getByText("400 Oh no! Test")).toBeAttached();
         });
+
+        test("Supports getRequest in server components", async ({ page }) => {
+          await page.goto(`http://localhost:${port}/get-request`);
+          await expect(page.getByText("GET")).toBeAttached();
+
+          const response = await page.request.fetch(
+            `http://localhost:${port}/get-request`,
+            {
+              method: "POST",
+            },
+          );
+          const body = await response.text();
+          expect(body).toContain("<p>POST</p>");
+        });
       });
 
       test.describe("Server Actions", () => {

packages/react-router/index-react-server.ts

@@ -1,5 +1,8 @@
 // RSC APIs
-export { matchRSCServerRequest as unstable_matchRSCServerRequest } from "./lib/rsc/server.rsc";
+export {
+  getRequest as unstable_getRequest,
+  matchRSCServerRequest as unstable_matchRSCServerRequest,
+} from "./lib/rsc/server.rsc";
 
 export type {
   DecodeActionFunction as unstable_DecodeActionFunction,

packages/react-router/index.ts

@@ -316,7 +316,8 @@ export {
 export { RSCDefaultRootErrorBoundary as UNSAFE_RSCDefaultRootErrorBoundary } from "./lib/rsc/errorBoundaries";
 
 // Re-export of RSC types
-import type { matchRSCServerRequest } from "./lib/rsc/server.rsc";
+import type { getRequest, matchRSCServerRequest } from "./lib/rsc/server.rsc";
+export declare const unstable_getRequest: typeof getRequest;
 export declare const unstable_matchRSCServerRequest: typeof matchRSCServerRequest;
 
 export type {

packages/react-router/lib/rsc/server.rsc.ts

@@ -78,6 +78,7 @@ const WithHydrateFallbackProps: typeof WithHydrateFallbackPropsType =
 
 type ServerContext = {
   redirect?: Response;
+  request: Request;
   runningAction: boolean;
 };
 
@@ -88,6 +89,16 @@ const globalVar = (typeof globalThis !== "undefined" ? globalThis : global) as {
 const ServerStorage = (globalVar.___reactRouterServerStorage___ ??=
   new AsyncLocalStorage<ServerContext>());
 
+export function getRequest() {
+  const ctx = ServerStorage.getStore();
+
+  if (!ctx)
+    throw new Error(
+      "getRequest must be called from within a React Server render context",
+    );
+  return ctx.request;
+}
+
 export const redirect: typeof baseRedirect = (...args) => {
   const response = baseRedirect(...args);
 
@@ -782,6 +793,7 @@ async function generateRenderResponse(
 
   let actionResult: Promise<unknown> | undefined;
   const ctx: ServerContext = {
+    request,
     runningAction: false,
   };