fix: prevent beforeNavigate() for download links (#9660)

* do not call before navigate for downloads

* changeset

* add test

* remove # from test download link

Author: teemingc

.changeset/shiny-eels-greet.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': minor
+---
+
+fix: do not call beforeNavigate for download links

packages/kit/src/runtime/client/client.js

@@ -1266,8 +1266,8 @@ export function create_client(app, target) {
 			const a = find_anchor(element, container);
 			if (!a) return;
 
-			const { url, external } = get_link_info(a, base);
-			if (external) return;
+			const { url, external, download } = get_link_info(a, base);
+			if (external || download) return;
 
 			const options = get_router_options(a);
 
@@ -1300,8 +1300,8 @@ export function create_client(app, target) {
 			observer.disconnect();
 
 			for (const a of container.querySelectorAll('a')) {
-				const { url, external } = get_link_info(a, base);
-				if (external) continue;
+				const { url, external, download } = get_link_info(a, base);
+				if (external || download) continue;
 
 				const options = get_router_options(a);
 				if (options.reload) continue;
@@ -1517,7 +1517,7 @@ export function create_client(app, target) {
 				const a = find_anchor(/** @type {Element} */ (event.composedPath()[0]), container);
 				if (!a) return;
 
-				const { url, external, target } = get_link_info(a, base);
+				const { url, external, target, download } = get_link_info(a, base);
 				if (!url) return;
 
 				// bail out before `beforeNavigate` if link opens in a different tab
@@ -1545,6 +1545,8 @@ export function create_client(app, target) {
 				)
 					return;
 
+				if (download) return;
+
 				// Ignore the following but fire beforeNavigate
 				if (external || options.reload) {
 					if (before_navigate({ url, type: 'link' })) {

packages/kit/src/runtime/client/utils.js

@@ -133,10 +133,11 @@ export function get_link_info(a, base) {
 		!url ||
 		!!target ||
 		is_external_url(url, base) ||
-		(a.getAttribute('rel') || '').split(/\s+/).includes('external') ||
-		a.hasAttribute('download');
+		(a.getAttribute('rel') || '').split(/\s+/).includes('external');
 
-	return { url, external, target };
+	const download = url?.origin === location.origin && a.hasAttribute('download');
+
+	return { url, external, target, download };
 }
 
 /**

packages/kit/test/apps/basics/src/routes/before-navigate/prevent-navigation/+page.svelte

@@ -20,4 +20,5 @@
 <a href="/before-navigate/prevent-navigation?x=1">self</a>
 <a href="https://google.com" target="_blank" rel="noreferrer">_blank</a>
 <a href="https://google.de">external</a>
+<a download href="">external</a>
 <pre>{times_triggered} {unload} {navigation_type}</pre>

packages/kit/test/apps/basics/test/cross-platform/client.test.js

@@ -213,6 +213,18 @@ test.describe('beforeNavigate', () => {
 
 		expect(await page.innerHTML('pre')).toBe('2 false goto');
 	});
+
+	test('is triggered after clicking a download link', async ({ page, baseURL }) => {
+		await page.goto('/before-navigate/prevent-navigation');
+
+		await page.click('a[download]');
+		expect(await page.innerHTML('pre')).toBe('0 false undefined');
+
+		await page.click('a[href="/before-navigate/a"]');
+
+		expect(page.url()).toBe(baseURL + '/before-navigate/prevent-navigation');
+		expect(await page.innerHTML('pre')).toBe('1 false link');
+	});
 });
 
 test.describe('Scrolling', () => {