Fix getStaticPaths regression (#11993)

* Revert "Remove dependency on path-to-regexp (#11983)" This reverts commit 633eeaa. * Add test for regression * Add a changeset * Pin path-to-regexp
withastro · Sep 13, 2024 · ffba5d7 · ffba5d7
1 parent 2d016d4
commit ffba5d7
Show file tree

Hide file tree

Showing 6 changed files with 99 additions and 31 deletions.
diff --git a/.changeset/happy-ways-sin.md b/.changeset/happy-ways-sin.md
@@ -0,0 +1,7 @@
+---
+'astro': patch
+---
+
+Fix getStaticPaths regression
+
+This reverts a previous change meant to remove a dependency, to fix a regression with multiple nested spread routes.
diff --git a/packages/astro/package.json b/packages/astro/package.json
@@ -168,6 +168,7 @@
     "ora": "^8.1.0",
     "p-limit": "^6.1.0",
     "p-queue": "^8.0.1",
+    "path-to-regexp": "6.2.2",
     "preferred-pm": "^4.0.0",
     "prompts": "^2.4.2",
     "rehype": "^13.0.1",

diff --git a/packages/astro/src/core/routing/manifest/generator.ts b/packages/astro/src/core/routing/manifest/generator.ts
@@ -1,5 +1,7 @@
 import type { AstroConfig, RoutePart } from '../../../@types/astro.js';
 
+import { compile } from 'path-to-regexp';
+
 /**
  * Sanitizes the parameters object by normalizing string values and replacing certain characters with their URL-encoded equivalents.
  * @param {Record<string, string | number | undefined>} params - The parameters object to be sanitized.
@@ -22,40 +24,45 @@ export function getRouteGenerator(
 	segments: RoutePart[][],
 	addTrailingSlash: AstroConfig['trailingSlash'],
 ) {
+	const template = segments
+		.map((segment) => {
+			return (
+				'/' +
+				segment
+					.map((part) => {
+						if (part.spread) {
+							return `:${part.content.slice(3)}(.*)?`;
+						} else if (part.dynamic) {
+							return `:${part.content}`;
+						} else {
+							return part.content
+								.normalize()
+								.replace(/\?/g, '%3F')
+								.replace(/#/g, '%23')
+								.replace(/%5B/g, '[')
+								.replace(/%5D/g, ']')
+								.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+						}
+					})
+					.join('')
+			);
+		})
+		.join('');
+
+	// Unless trailingSlash config is set to 'always', don't automatically append it.
+	let trailing: '/' | '' = '';
+	if (addTrailingSlash === 'always' && segments.length) {
+		trailing = '/';
+	}
+	const toPath = compile(template + trailing);
 	return (params: Record<string, string | number | undefined>): string => {
 		const sanitizedParams = sanitizeParams(params);
+		const path = toPath(sanitizedParams);
 
-		// Unless trailingSlash config is set to 'always', don't automatically append it.
-		let trailing: '/' | '' = '';
-		if (addTrailingSlash === 'always' && segments.length) {
-			trailing = '/';
-		}
-
-		const path =
-			segments
-				.map((segment) => {
-					return (
-						'/' +
-						segment
-							.map((part) => {
-								if (part.spread) {
-									return `${sanitizedParams[part.content.slice(3)] || ''}`;
-								} else if (part.dynamic) {
-									return `${sanitizedParams[part.content] || ''}`;
-								} else {
-									return part.content
-										.normalize()
-										.replace(/\?/g, '%3F')
-										.replace(/#/g, '%23')
-										.replace(/%5B/g, '[')
-										.replace(/%5D/g, ']');
-								}
-							})
-							.join('')
-					);
-				})
-				.join('') + trailing;
-
+		// When generating an index from a rest parameter route, `path-to-regexp` will return an
+		// empty string instead "/". This causes an inconsistency with static indexes that may result
+		// in the incorrect routes being rendered.
+		// To fix this, we return "/" when the path is empty.
 		return path || '/';
 	};
 }
diff --git a/...es/astro/test/fixtures/get-static-paths-pages/src/pages/archive/[...slug]/[...page].astro b/...es/astro/test/fixtures/get-static-paths-pages/src/pages/archive/[...slug]/[...page].astro
@@ -0,0 +1,37 @@
+---
+export async function getStaticPaths({ paginate }) {
+
+  const paths = [
+    {
+      slug: 'news/july-2024',
+      items: ['item 1', 'item 2', 'item 3', 'item 4', 'item 5', 'item 6'],
+      contentType: 'news',
+      monthYear: 'july-2024',
+    }
+  ];
+
+  return paths.flatMap((path) => {
+    return paginate(path.items, {
+      params: { slug: path.slug },
+      props: {
+        contentType: path.contentType,
+        monthYear: path.monthYear,
+      },
+      pageSize: 2,
+    });
+  });
+}
+
+const { slug, page } = Astro.params;
+---
+
+<html>
+  <head>
+    <title>Testing</title>
+  </head>
+  <body>
+    <h1>Testing</h1>
+    <p id="slug">{slug}</p>
+    <p id="page">{page}</p>
+  </body>
+</html>
diff --git a/packages/astro/test/get-static-paths-pages.test.js b/packages/astro/test/get-static-paths-pages.test.js
@@ -25,4 +25,12 @@ describe('getStaticPaths with trailingSlash: ignore', () => {
 		let $ = cheerio.load(html);
 		assert.equal($('h1').text(), 'Page 2');
 	});
+
+	// for regression: https://github.com/withastro/astro/issues/11990
+	it('nested static paths generate', async () => {
+		let html = await fixture.readFile('/archive/news/july-2024/2/index.html');
+		let $ = cheerio.load(html);
+		assert.equal($('#slug').text(), 'news');
+		assert.equal($('#page').text(), 'july-2024/2');
+	})
 });
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml