Non unique custom routes ID error and test

lucasferreira · Oct 31, 2022 · 3738662 · 3738662
1 parent 9228db0
commit 3738662
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/packages/remix-dev/__tests__/defineRoutes-test.ts b/packages/remix-dev/__tests__/defineRoutes-test.ts
@@ -97,4 +97,16 @@ describe("defineRoutes", () => {
 
     expect(Object.entries(routes)).toHaveLength(3);
   });
+
+  it("throws an error when one route already exists with the same custom ID", () => {
+    function defineNonUniqueRoutes() {
+      defineRoutes((route) => {
+        route("/user/:id", "routes/index.tsx", { id: "user" });
+        route("/user", "routes/index.tsx", { id: "user" });
+        route("/other", "routes/other-route.tsx");
+      });
+    }
+
+    expect(defineNonUniqueRoutes).toThrow("must be unique");
+  });
 });
diff --git a/packages/remix-dev/config/routes.ts b/packages/remix-dev/config/routes.ts
@@ -155,6 +155,13 @@ export function defineRoutes(
       file,
     };
 
+    if (!!options.id && options.id in routes) {
+      throw new Error(
+        `You tried to define a route with custom id "${options.id}" but one ` +
+          "already exists. Custom route ids must be unique"
+      );
+    }
+
     routes[route.id] = route;
 
     if (children) {