Add support for future.unstable_passThroughRequests

.changeset/stupid-lamps-confess.md

@@ -0,0 +1,6 @@
+---
+"@react-router/dev": patch
+"react-router": patch
+---
+
+Add future.unstable_passThroughRequests flag

CLAUDE.md

@@ -0,0 +1 @@
+See [./AGENTS.md]

packages/react-router-dev/config/config.ts

@@ -86,6 +86,7 @@ type ValidateConfigFunction = (config: ReactRouterConfig) => string | void;
 
 interface FutureConfig {
   unstable_optimizeDeps: boolean;
+  unstable_passThroughRequests: boolean;
   unstable_subResourceIntegrity: boolean;
   unstable_trailingSlashAwareDataRequests: boolean;
   /**
@@ -684,6 +685,8 @@ async function resolveConfig({
   let future: FutureConfig = {
     unstable_optimizeDeps:
       userAndPresetConfigs.future?.unstable_optimizeDeps ?? false,
+    unstable_passThroughRequests:
+      userAndPresetConfigs.future?.unstable_passThroughRequests ?? false,
     unstable_subResourceIntegrity:
       userAndPresetConfigs.future?.unstable_subResourceIntegrity ?? false,
     unstable_trailingSlashAwareDataRequests:

packages/react-router/__tests__/router/fetchers-test.ts

@@ -172,6 +172,19 @@ describe("fetchers", () => {
       await A.loaders.foo.resolve("A DATA");
       expect(A.fetcher.state).toBe("idle");
       expect(A.fetcher.data).toBe("A DATA");
+      expect(A.loaders.foo.stub).toHaveBeenCalledWith({
+        params: {},
+        request: new Request("http://localhost/foo", {
+          signal: A.loaders.foo.stub.mock.calls[0][0].request.signal,
+        }),
+        unstable_pattern: "/foo",
+        unstable_path: {
+          pathname: "/foo",
+          search: "",
+          hash: "",
+        },
+        context: {},
+      });
     });
 
     it("loader re-fetch", async () => {
@@ -212,11 +225,19 @@ describe("fetchers", () => {
       expect(A.fetcher.formAction).toBe("/foo");
       expect(A.fetcher.formData).toEqual(createFormData({ key: "value" }));
       expect(A.fetcher.formEncType).toBe("application/x-www-form-urlencoded");
-      expect(
-        new URL(
-          A.loaders.foo.stub.mock.calls[0][0].request.url,
-        ).searchParams.toString(),
-      ).toBe("key=value");
+      expect(A.loaders.foo.stub).toHaveBeenCalledWith({
+        params: {},
+        request: new Request("http://localhost/foo?key=value", {
+          signal: A.loaders.foo.stub.mock.calls[0][0].request.signal,
+        }),
+        unstable_pattern: "/foo",
+        unstable_path: {
+          pathname: "/foo",
+          search: "?key=value",
+          hash: "",
+        },
+        context: {},
+      });
 
       await A.loaders.foo.resolve("A DATA");
       expect(A.fetcher.state).toBe("idle");
@@ -264,6 +285,17 @@ describe("fetchers", () => {
         formData: createFormData({ key: "value" }),
       });
       expect(A.fetcher.state).toBe("submitting");
+      expect(A.actions.foo.stub).toHaveBeenCalledWith({
+        params: {},
+        request: expect.any(Request),
+        unstable_pattern: "/foo",
+        unstable_path: {
+          pathname: "/foo",
+          search: "",
+          hash: "",
+        },
+        context: {},
+      });
 
       await A.actions.foo.resolve("A ACTION");
       expect(A.fetcher.state).toBe("loading");
@@ -374,6 +406,7 @@ describe("fetchers", () => {
           signal: A.loaders.root.stub.mock.calls[0][0].request.signal,
         }),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
     });
@@ -3375,6 +3408,7 @@ describe("fetchers", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 
@@ -3405,6 +3439,7 @@ describe("fetchers", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 
@@ -3433,6 +3468,7 @@ describe("fetchers", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 
@@ -3461,6 +3497,7 @@ describe("fetchers", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 
@@ -3490,6 +3527,7 @@ describe("fetchers", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 
@@ -3521,6 +3559,7 @@ describe("fetchers", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 
@@ -3551,6 +3590,7 @@ describe("fetchers", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 

packages/react-router/__tests__/router/router-test.ts

@@ -1752,6 +1752,7 @@ describe("a router", () => {
           signal: nav.loaders.tasks.stub.mock.calls[0][0].request.signal,
         }),
         unstable_pattern: "/tasks",
+        unstable_path: { pathname: "/tasks", search: "", hash: "" },
         context: {},
       });
 
@@ -1762,6 +1763,7 @@ describe("a router", () => {
           signal: nav2.loaders.tasksId.stub.mock.calls[0][0].request.signal,
         }),
         unstable_pattern: "/tasks/:id",
+        unstable_path: { pathname: "/tasks/1", search: "", hash: "" },
         context: {},
       });
 
@@ -1772,6 +1774,11 @@ describe("a router", () => {
           signal: nav3.loaders.tasks.stub.mock.calls[0][0].request.signal,
         }),
         unstable_pattern: "/tasks",
+        unstable_path: {
+          pathname: "/tasks",
+          search: "?foo=bar",
+          hash: "#hash",
+        },
         context: {},
       });
 
@@ -1784,6 +1791,11 @@ describe("a router", () => {
           signal: nav4.loaders.tasks.stub.mock.calls[0][0].request.signal,
         }),
         unstable_pattern: "/tasks",
+        unstable_path: {
+          pathname: "/tasks",
+          search: "?foo=bar",
+          hash: "#hash",
+        },
         context: {},
       });
 
@@ -2210,6 +2222,7 @@ describe("a router", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: "/tasks",
+        unstable_path: { pathname: "/tasks", search: "", hash: "" },
         context: {},
       });
 
@@ -2254,7 +2267,8 @@ describe("a router", () => {
       expect(nav.actions.tasks.stub).toHaveBeenCalledWith({
         params: {},
         request: expect.any(Request),
-        unstable_pattern: expect.any(String),
+        unstable_pattern: "/tasks",
+        unstable_path: { pathname: "/tasks", search: "?foo=bar", hash: "" },
         context: {},
       });
       // Assert request internals, cannot do a deep comparison above since some
@@ -2289,6 +2303,7 @@ describe("a router", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 

packages/react-router/__tests__/router/ssr-test.ts

@@ -837,12 +837,29 @@ describe("ssr", () => {
       ]);
       await query(createRequest("/child"));
 
+      expect(rootLoaderStub).toHaveBeenCalledTimes(1);
+      expect(rootLoaderStub).toHaveBeenCalledWith({
+        request: new Request("http://localhost/child"),
+        unstable_pattern: "/child",
+        unstable_path: { pathname: "/child", search: "", hash: "" },
+        params: {},
+        context: {},
+      });
       // @ts-expect-error
       let rootLoaderRequest = rootLoaderStub.mock.calls[0][0]?.request;
-      // @ts-expect-error
-      let childLoaderRequest = childLoaderStub.mock.calls[0][0]?.request;
       expect(rootLoaderRequest.method).toBe("GET");
       expect(rootLoaderRequest.url).toBe("http://localhost/child");
+
+      expect(childLoaderStub).toHaveBeenCalledTimes(1);
+      expect(childLoaderStub).toHaveBeenCalledWith({
+        request: new Request("http://localhost/child"),
+        unstable_pattern: "/child",
+        unstable_path: { pathname: "/child", search: "", hash: "" },
+        params: {},
+        context: {},
+      });
+      // @ts-expect-error
+      let childLoaderRequest = childLoaderStub.mock.calls[0][0]?.request;
       expect(childLoaderRequest.method).toBe("GET");
       expect(childLoaderRequest.url).toBe("http://localhost/child");
     });
@@ -874,6 +891,14 @@ describe("ssr", () => {
         }),
       );
 
+      expect(actionStub).toHaveBeenCalledTimes(1);
+      expect(actionStub).toHaveBeenCalledWith({
+        request: expect.any(Request),
+        unstable_pattern: "/child",
+        unstable_path: { pathname: "/child", search: "", hash: "" },
+        params: {},
+        context: {},
+      });
       // @ts-expect-error
       let actionRequest = actionStub.mock.calls[0][0]?.request;
       expect(actionRequest.method).toBe("POST");
@@ -883,14 +908,31 @@ describe("ssr", () => {
       );
       expect((await actionRequest.formData()).get("key")).toBe("value");
 
+      expect(rootLoaderStub).toHaveBeenCalledTimes(1);
+      expect(rootLoaderStub).toHaveBeenCalledWith({
+        request: expect.any(Request),
+        unstable_pattern: "/child",
+        unstable_path: { pathname: "/child", search: "", hash: "" },
+        params: {},
+        context: {},
+      });
       // @ts-expect-error
       let rootLoaderRequest = rootLoaderStub.mock.calls[0][0]?.request;
-      // @ts-expect-error
-      let childLoaderRequest = childLoaderStub.mock.calls[0][0]?.request;
       expect(rootLoaderRequest.method).toBe("GET");
       expect(rootLoaderRequest.url).toBe("http://localhost/child");
       expect(rootLoaderRequest.headers.get("test")).toBe("value");
       expect(await rootLoaderRequest.text()).toBe("");
+
+      expect(childLoaderStub).toHaveBeenCalledTimes(1);
+      expect(childLoaderStub).toHaveBeenCalledWith({
+        request: expect.any(Request),
+        unstable_pattern: "/child",
+        unstable_path: { pathname: "/child", search: "", hash: "" },
+        params: {},
+        context: {},
+      });
+      // @ts-expect-error
+      let childLoaderRequest = childLoaderStub.mock.calls[0][0]?.request;
       expect(childLoaderRequest.method).toBe("GET");
       expect(childLoaderRequest.url).toBe("http://localhost/child");
       expect(childLoaderRequest.headers.get("test")).toBe("value");

packages/react-router/__tests__/router/submission-test.ts

@@ -949,6 +949,7 @@ describe("submissions", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 
@@ -984,6 +985,7 @@ describe("submissions", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 
@@ -1017,6 +1019,7 @@ describe("submissions", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 
@@ -1122,6 +1125,7 @@ describe("submissions", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 
@@ -1161,6 +1165,7 @@ describe("submissions", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 
@@ -1197,6 +1202,7 @@ describe("submissions", () => {
         params: {},
         request: expect.any(Request),
         unstable_pattern: expect.any(String),
+        unstable_path: expect.any(Object),
         context: {},
       });
 

packages/react-router/lib/dom-export/hydrated-router.tsx

@@ -178,7 +178,8 @@ function createHydratedRouter({
     unstable_instrumentations,
     mapRouteProperties,
     future: {
-      middleware: ssrInfo.context.future.v8_middleware,
+      unstable_passThroughRequests:
+        ssrInfo.context.future.unstable_passThroughRequests,
     },
     dataStrategy: getTurboStreamSingleFetchDataStrategy(
       () => router,

packages/react-router/lib/dom/server.tsx

@@ -423,6 +423,7 @@ export function createStaticRouter(
     get future() {
       return {
         v8_middleware: false,
+        unstable_passThroughRequests: false,
         ...opts?.future,
       };
     },

packages/react-router/lib/dom/ssr/entry.ts

@@ -44,6 +44,7 @@ export interface EntryContext extends FrameworkContextObject {
 }
 
 export interface FutureConfig {
+  unstable_passThroughRequests: boolean;
   unstable_subResourceIntegrity: boolean;
   unstable_trailingSlashAwareDataRequests: boolean;
   v8_middleware: boolean;

packages/react-router/lib/dom/ssr/routes-test-stub.tsx

@@ -132,6 +132,8 @@ export function createRoutesStub(
     if (routerRef.current == null) {
       frameworkContextRef.current = {
         future: {
+          unstable_passThroughRequests:
+            future?.unstable_passThroughRequests === true,
           unstable_subResourceIntegrity:
             future?.unstable_subResourceIntegrity === true,
           v8_middleware: future?.v8_middleware === true,