prerender external links (#3826)

* prerender external links * update tests * changeset * lint * add note about prerendering
sveltejs · Feb 17, 2022 · 58a480e · 58a480e
1 parent bf457af
commit 58a480e
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 8 deletions.
diff --git a/.changeset/tall-berries-guess.md b/.changeset/tall-berries-guess.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+[breaking] Crawl rel="external" links when prerendering
diff --git a/documentation/docs/07-a-options.md b/documentation/docs/07-a-options.md
@@ -43,3 +43,5 @@ Adding a `rel=external` attribute to a link...
 ```
 
 ...will trigger a browser navigation when the link is clicked.
+
+> SvelteKit does not exclude root-relative external links from prerendering, which will cause 404s if these URLs are intended to be served by a separate app. Use a custom [`prerender.onError`](/docs/configuration#prerender) handler if you need to ignore them.
diff --git a/packages/kit/src/core/adapt/prerender/crawl.js b/packages/kit/src/core/adapt/prerender/crawl.js
@@ -8,8 +8,6 @@ const TAG_OPEN = /[a-zA-Z]/;
 const TAG_CHAR = /[a-zA-Z0-9]/;
 const ATTRIBUTE_NAME = /[^\t\n\f />"'=]/;
 
-const EXTERNAL = /\bexternal\b/;
-
 const WHITESPACE = /[\s\n\r]/;
 
 /** @param {string} html */
@@ -88,7 +86,6 @@ export function crawl(html) {
 					}
 				}
 
-				let rel = '';
 				let href = '';
 
 				while (i < html.length) {
@@ -149,9 +146,7 @@ export function crawl(html) {
 								i -= 1;
 							}
 
-							if (name === 'rel') {
-								rel = value;
-							} else if (name === 'href') {
+							if (name === 'href') {
 								href = value;
 							} else if (name === 'src') {
 								hrefs.push(value);
@@ -183,7 +178,7 @@ export function crawl(html) {
 					i += 1;
 				}
 
-				if (href && !EXTERNAL.test(rel)) {
+				if (href) {
 					hrefs.push(href);
 				}
 			}

diff --git a/packages/kit/src/core/adapt/prerender/fixtures/ignore-rel-external/output.json b/packages/kit/src/core/adapt/prerender/fixtures/ignore-rel-external/output.json
diff --git a/...r/fixtures/ignore-rel-external/input.html → .../fixtures/include-rel-external/input.html b/...r/fixtures/ignore-rel-external/input.html → .../fixtures/include-rel-external/input.html
diff --git a/packages/kit/src/core/adapt/prerender/fixtures/include-rel-external/output.json b/packages/kit/src/core/adapt/prerender/fixtures/include-rel-external/output.json
@@ -0,0 +1 @@
+["/styles.css", "/favicon.png", "https://external.com", "/wheee"]
Original file line number	Diff line number	Diff line change
Expand Up		@@ -43,3 +43,5 @@ Adding a `rel=external` attribute to a link...
		```

		...will trigger a browser navigation when the link is clicked.

		> SvelteKit does not exclude root-relative external links from prerendering, which will cause 404s if these URLs are intended to be served by a separate app. Use a custom [`prerender.onError`](/docs/configuration#prerender) handler if you need to ignore them.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		["/styles.css", "/favicon.png", "https://external.com", "/wheee"]