Fix data route ordering in dev (#54364)

Previously we were appending the data routes to the dynamic routes array which didn't ensure the data routes come before the normal dynamic routes allowing a catch-all to override the data route. Fixes: #53887
vercel · Aug 22, 2023 · c89f97e · c89f97e
1 parent 705b2ef
commit c89f97e
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 1 deletion.
diff --git a/packages/next/src/server/lib/router-utils/setup-dev.ts b/packages/next/src/server/lib/router-utils/setup-dev.ts
@@ -1246,10 +1246,12 @@ async function startWatcher(opts: SetupOpts) {
           })
           .filter(Boolean) as any
 
+        const dataRoutes: typeof opts.fsChecker.dynamicRoutes = []
+
         for (const page of sortedRoutes) {
           const route = buildDataRoute(page, 'development')
           const routeRegex = getRouteRegex(route.page)
-          opts.fsChecker.dynamicRoutes.push({
+          dataRoutes.push({
             ...route,
             regex: routeRegex.re.toString(),
             match: getRouteMatcher({
@@ -1267,6 +1269,7 @@ async function startWatcher(opts: SetupOpts) {
             }),
           })
         }
+        opts.fsChecker.dynamicRoutes.unshift(...dataRoutes)
 
         if (!prevSortedRoutes?.every((val, idx) => val === sortedRoutes[idx])) {
           // emit the change so clients fetch the update

diff --git a/test/integration/dynamic-routing/pages/[name]/[comment]/[...rest].js b/test/integration/dynamic-routing/pages/[name]/[comment]/[...rest].js
@@ -0,0 +1,12 @@
+// this checks priority issues with catch-all routes that
+// can match `_next/data/build-id/path.json
+
+export function getServerSideProps() {
+  return {
+    notFound: true,
+  }
+}
+
+export default function Page() {
+  return <p>nested catch-all</p>
+}
diff --git a/test/integration/dynamic-routing/test/index.test.js b/test/integration/dynamic-routing/test/index.test.js
@@ -1318,6 +1318,22 @@ function runTests({ dev }) {
               nxtPrest: 'nxtPrest',
             },
           },
+          {
+            dataRouteRegex: normalizeRegEx(
+              `^\\/_next\\/data\\/${escapeRegex(
+                buildId
+              )}\\/([^\\/]+?)\\/([^\\/]+?)\\/(.+?)\\.json$`
+            ),
+            namedDataRouteRegex: `^/_next/data/${escapeRegex(
+              buildId
+            )}/(?<nxtPname>[^/]+?)/(?<nxtPcomment>[^/]+?)/(?<nxtPrest>.+?)\\.json$`,
+            page: '/[name]/[comment]/[...rest]',
+            routeKeys: {
+              nxtPcomment: 'nxtPcomment',
+              nxtPname: 'nxtPname',
+              nxtPrest: 'nxtPrest',
+            },
+          },
         ],
         dynamicRoutes: [
           {
@@ -1458,6 +1474,19 @@ function runTests({ dev }) {
               nxtPcomment: 'nxtPcomment',
             },
           },
+          {
+            namedRegex:
+              '^/(?<nxtPname>[^/]+?)/(?<nxtPcomment>[^/]+?)/(?<nxtPrest>.+?)(?:/)?$',
+            page: '/[name]/[comment]/[...rest]',
+            regex: normalizeRegEx(
+              '^\\/([^\\/]+?)\\/([^\\/]+?)\\/(.+?)(?:\\/)?$'
+            ),
+            routeKeys: {
+              nxtPcomment: 'nxtPcomment',
+              nxtPname: 'nxtPname',
+              nxtPrest: 'nxtPrest',
+            },
+          },
         ],
         rsc: {
           header: 'RSC',
@@ -1475,6 +1504,7 @@ function runTests({ dev }) {
 
       expect(manifest).toEqual({
         '/[name]/[comment]': 'pages/[name]/[comment].js',
+        '/[name]/[comment]/[...rest]': 'pages/[name]/[comment]/[...rest].js',
         '/[name]/comments': 'pages/[name]/comments.js',
         '/[name]': 'pages/[name].js',
         '/[name]/on-mount-redir': 'pages/[name]/on-mount-redir.html',