fix: update thrown/returned Response handling in staticHandler (#9465)

Author: brophdawg11

.changeset/metal-drinks-melt.md

@@ -0,0 +1,5 @@
+---
+"@remix-run/router": patch
+---
+
+Clean up response APIs for unstable_createStaticHandler queryRoute

package.json

@@ -107,7 +107,7 @@
   },
   "filesize": {
     "packages/router/dist/router.js": {
-      "none": "101 kB"
+      "none": "105 kB"
     },
     "packages/react-router/dist/react-router.production.min.js": {
       "none": "12.5 kB"

packages/router/__tests__/router-test.ts

@@ -10286,6 +10286,20 @@ describe("a router", () => {
         };
       }
 
+      it("should match routes automatically if no routeId is provided", async () => {
+        let { queryRoute } = createStaticHandler(SSR_ROUTES);
+        let data;
+
+        data = await queryRoute(createRequest("/parent"));
+        expect(data).toBe("PARENT LOADER");
+
+        data = await queryRoute(createRequest("/parent?index"));
+        expect(data).toBe("PARENT INDEX LOADER");
+
+        data = await queryRoute(createRequest("/parent/child"), "child");
+        expect(data).toBe("CHILD LOADER");
+      });
+
       it("should support singular route load navigations (primitives)", async () => {
         let { queryRoute } = createStaticHandler(SSR_ROUTES);
         let data;
@@ -10317,6 +10331,7 @@ describe("a router", () => {
       });
 
       it("should support singular route load navigations (Responses)", async () => {
+        /* eslint-disable jest/no-conditional-expect */
         let T = setupFlexRouteTest();
         let data;
 
@@ -10329,9 +10344,13 @@ describe("a router", () => {
         expect(await data.text()).toBe("Created!");
 
         // Thrown Success Response
-        data = await T.rejectLoader(new Response("Created!", { status: 201 }));
-        expect(data.status).toBe(201);
-        expect(await data.text()).toBe("Created!");
+        try {
+          await T.rejectLoader(new Response("Created!", { status: 201 }));
+          expect(false).toBe(true);
+        } catch (data) {
+          expect(data.status).toBe(201);
+          expect(await data.text()).toBe("Created!");
+        }
 
         // Returned Redirect Response
         data = await T.resolveLoader(
@@ -10359,9 +10378,14 @@ describe("a router", () => {
         expect(await data.text()).toBe("Why?");
 
         // Thrown Error Response
-        data = await T.rejectLoader(new Response("Oh no!", { status: 401 }));
-        expect(data.status).toBe(401);
-        expect(await data.text()).toBe("Oh no!");
+        try {
+          await T.rejectLoader(new Response("Oh no!", { status: 401 }));
+          expect(false).toBe(true);
+        } catch (data) {
+          expect(data.status).toBe(401);
+          expect(await data.text()).toBe("Oh no!");
+        }
+        /* eslint-enable jest/no-conditional-expect */
       });
 
       it("should support singular route load navigations (Errors)", async () => {
@@ -10445,6 +10469,7 @@ describe("a router", () => {
       });
 
       it("should support singular route submit navigations (Responses)", async () => {
+        /* eslint-disable jest/no-conditional-expect */
         let T = setupFlexRouteTest();
         let data;
 
@@ -10457,9 +10482,13 @@ describe("a router", () => {
         expect(await data.text()).toBe("Created!");
 
         // Thrown Success Response
-        data = await T.rejectAction(new Response("Created!", { status: 201 }));
-        expect(data.status).toBe(201);
-        expect(await data.text()).toBe("Created!");
+        try {
+          await T.rejectAction(new Response("Created!", { status: 201 }));
+          expect(false).toBe(true);
+        } catch (data) {
+          expect(data.status).toBe(201);
+          expect(await data.text()).toBe("Created!");
+        }
 
         // Returned Redirect Response
         data = await T.resolveAction(
@@ -10487,9 +10516,14 @@ describe("a router", () => {
         expect(await data.text()).toBe("Why?");
 
         // Thrown Error Response
-        data = await T.rejectAction(new Response("Oh no!", { status: 401 }));
-        expect(data.status).toBe(401);
-        expect(await data.text()).toBe("Oh no!");
+        try {
+          await T.rejectAction(new Response("Oh no!", { status: 401 }));
+          expect(false).toBe(true);
+        } catch (data) {
+          expect(data.status).toBe(401);
+          expect(await data.text()).toBe("Oh no!");
+        }
+        /* eslint-enable jest/no-conditional-expect */
       });
 
       it("should support singular route submit navigations (Errors)", async () => {
@@ -10650,19 +10684,78 @@ describe("a router", () => {
         );
       });
 
+      it("should handle not found routes with a 404 Response", async () => {
+        /* eslint-disable jest/no-conditional-expect */
+        let { queryRoute } = createStaticHandler([
+          {
+            id: "root",
+            path: "/",
+          },
+        ]);
+
+        try {
+          await queryRoute(createRequest("/junk"));
+          expect(false).toBe(true);
+        } catch (data) {
+          expect(data instanceof Response).toBe(true);
+          expect(data.status).toBe(404);
+          expect(data.statusText).toBe("Not Found");
+          expect(data.headers.get("X-Remix-Router-Error")).toBe("yes");
+        }
+
+        try {
+          await queryRoute(createRequest("/"), "junk");
+          expect(false).toBe(true);
+        } catch (data) {
+          expect(data instanceof Response).toBe(true);
+          expect(data.status).toBe(404);
+          expect(data.statusText).toBe("Not Found");
+          expect(data.headers.get("X-Remix-Router-Error")).toBe("yes");
+        }
+
+        try {
+          await queryRoute(createSubmitRequest("/junk"));
+          expect(false).toBe(true);
+        } catch (data) {
+          expect(data instanceof Response).toBe(true);
+          expect(data.status).toBe(404);
+          expect(data.statusText).toBe("Not Found");
+          expect(data.headers.get("X-Remix-Router-Error")).toBe("yes");
+        }
+
+        try {
+          await queryRoute(createSubmitRequest("/"), "junk");
+          expect(false).toBe(true);
+        } catch (data) {
+          expect(data instanceof Response).toBe(true);
+          expect(data.status).toBe(404);
+          expect(data.statusText).toBe("Not Found");
+          expect(data.headers.get("X-Remix-Router-Error")).toBe("yes");
+        }
+
+        /* eslint-enable jest/no-conditional-expect */
+      });
+
       it("should handle not found action submissions with a 405 Response", async () => {
+        /* eslint-disable jest/no-conditional-expect */
         let { queryRoute } = createStaticHandler([
           {
             id: "root",
             path: "/",
           },
         ]);
-        let request = createSubmitRequest("/");
-        let data = await queryRoute(request, "root");
-        expect(data instanceof Response).toBe(true);
-        expect(data.status).toBe(405);
-        expect(data.statusText).toBe("Method Not Allowed");
-        expect(await data.text()).toBe("No action found for [/]");
+
+        try {
+          await queryRoute(createSubmitRequest("/"), "root");
+          expect(false).toBe(true);
+        } catch (data) {
+          expect(data instanceof Response).toBe(true);
+          expect(data.status).toBe(405);
+          expect(data.statusText).toBe("Method Not Allowed");
+          expect(data.headers.get("X-Remix-Router-Error")).toBe("yes");
+          expect(await data.text()).toBe("No action found for [/]");
+        }
+        /* eslint-enable jest/no-conditional-expect */
       });
     });
   });