Expose patchRoutesOnNavigation errors directly (#12111)

Author: brophdawg11

.changeset/shy-chicken-talk.md

@@ -0,0 +1,5 @@
+---
+"@remix-run/router": patch
+---
+
+Expose errors thown from `patchRoutesOnNavigation` directly to `useRouteError` instead of wrapping them in a 400 `ErrorResponse` instance

packages/router/__tests__/lazy-discovery-test.ts

@@ -2064,15 +2064,7 @@ describe("Lazy Route Discovery (Fog of War)", () => {
         actionData: null,
         loaderData: {},
         errors: {
-          a: new ErrorResponseImpl(
-            400,
-            "Bad Request",
-            new Error(
-              'Unable to match URL "/a/b" - the `patchRoutesOnNavigation()` ' +
-                "function threw the following error:\nError: broke!"
-            ),
-            true
-          ),
+          a: new Error("broke!"),
         },
       });
       expect(router.state.matches.map((m) => m.route.id)).toEqual(["a"]);
@@ -2139,15 +2131,7 @@ describe("Lazy Route Discovery (Fog of War)", () => {
         actionData: null,
         loaderData: {},
         errors: {
-          a: new ErrorResponseImpl(
-            400,
-            "Bad Request",
-            new Error(
-              'Unable to match URL "/a/b" - the `patchRoutesOnNavigation()` ' +
-                "function threw the following error:\nError: broke!"
-            ),
-            true
-          ),
+          a: new Error("broke!"),
         },
       });
       expect(router.state.matches.map((m) => m.route.id)).toEqual(["a"]);
@@ -2213,16 +2197,7 @@ describe("Lazy Route Discovery (Fog of War)", () => {
         actionData: null,
         loaderData: {},
         errors: {
-          parent: new ErrorResponseImpl(
-            400,
-            "Bad Request",
-            new Error(
-              'Unable to match URL "/parent/child/grandchild" - the ' +
-                "`patchRoutesOnNavigation()` function threw the following " +
-                "error:\nError: broke!"
-            ),
-            true
-          ),
+          parent: new Error("broke!"),
         },
       });
       expect(router.state.matches.map((m) => m.route.id)).toEqual([
@@ -2274,16 +2249,7 @@ describe("Lazy Route Discovery (Fog of War)", () => {
         actionData: null,
         loaderData: {},
         errors: {
-          parent: new ErrorResponseImpl(
-            400,
-            "Bad Request",
-            new Error(
-              'Unable to match URL "/parent/child/grandchild" - the ' +
-                "`patchRoutesOnNavigation()` function threw the following " +
-                "error:\nError: broke!"
-            ),
-            true
-          ),
+          parent: new Error("broke!"),
         },
       });
       expect(router.state.matches.map((m) => m.route.id)).toEqual([

packages/router/router.ts

@@ -1690,17 +1690,15 @@ export function createRouter(init: RouterInit): Router {
       if (discoverResult.type === "aborted") {
         return { shortCircuited: true };
       } else if (discoverResult.type === "error") {
-        let { boundaryId, error } = handleDiscoverRouteError(
-          location.pathname,
-          discoverResult
-        );
+        let boundaryId = findNearestBoundary(discoverResult.partialMatches)
+          .route.id;
         return {
           matches: discoverResult.partialMatches,
           pendingActionResult: [
             boundaryId,
             {
               type: ResultType.error,
-              error,
+              error: discoverResult.error,
             },
           ],
         };
@@ -1868,15 +1866,13 @@ export function createRouter(init: RouterInit): Router {
       if (discoverResult.type === "aborted") {
         return { shortCircuited: true };
       } else if (discoverResult.type === "error") {
-        let { boundaryId, error } = handleDiscoverRouteError(
-          location.pathname,
-          discoverResult
-        );
+        let boundaryId = findNearestBoundary(discoverResult.partialMatches)
+          .route.id;
         return {
           matches: discoverResult.partialMatches,
           loaderData: {},
           errors: {
-            [boundaryId]: error,
+            [boundaryId]: discoverResult.error,
           },
         };
       } else if (!discoverResult.matches) {
@@ -2254,8 +2250,7 @@ export function createRouter(init: RouterInit): Router {
       if (discoverResult.type === "aborted") {
         return;
       } else if (discoverResult.type === "error") {
-        let { error } = handleDiscoverRouteError(path, discoverResult);
-        setFetcherError(key, routeId, error, { flushSync });
+        setFetcherError(key, routeId, discoverResult.error, { flushSync });
         return;
       } else if (!discoverResult.matches) {
         setFetcherError(
@@ -2547,8 +2542,7 @@ export function createRouter(init: RouterInit): Router {
       if (discoverResult.type === "aborted") {
         return;
       } else if (discoverResult.type === "error") {
-        let { error } = handleDiscoverRouteError(path, discoverResult);
-        setFetcherError(key, routeId, error, { flushSync });
+        setFetcherError(key, routeId, discoverResult.error, { flushSync });
         return;
       } else if (!discoverResult.matches) {
         setFetcherError(
@@ -3124,23 +3118,6 @@ export function createRouter(init: RouterInit): Router {
     return { notFoundMatches: matches, route, error };
   }
 
-  function handleDiscoverRouteError(
-    pathname: string,
-    discoverResult: DiscoverRoutesErrorResult
-  ) {
-    return {
-      boundaryId: findNearestBoundary(discoverResult.partialMatches).route.id,
-      error: getInternalRouterError(400, {
-        type: "route-discovery",
-        pathname,
-        message:
-          discoverResult.error != null && "message" in discoverResult.error
-            ? discoverResult.error
-            : String(discoverResult.error),
-      }),
-    };
-  }
-
   function cancelActiveDeferreds(
     predicate?: (routeId: string) => boolean
   ): string[] {
@@ -5485,7 +5462,7 @@ function getInternalRouterError(
     pathname?: string;
     routeId?: string;
     method?: string;
-    type?: "defer-action" | "invalid-body" | "route-discovery";
+    type?: "defer-action" | "invalid-body";
     message?: string;
   } = {}
 ) {
@@ -5494,11 +5471,7 @@ function getInternalRouterError(
 
   if (status === 400) {
     statusText = "Bad Request";
-    if (type === "route-discovery") {
-      errorMessage =
-        `Unable to match URL "${pathname}" - the \`patchRoutesOnNavigation()\` ` +
-        `function threw the following error:\n${message}`;
-    } else if (method && pathname && routeId) {
+    if (method && pathname && routeId) {
       errorMessage =
         `You made a ${method} request to "${pathname}" but ` +
         `did not provide a \`loader\` for route "${routeId}", ` +