breaking: refresh all load functions/queries when clicking a link to the current URL

.changeset/breezy-bananas-divide.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': major
+---
+
+breaking: refresh all load functions/queries when clicking a link to the current URL

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

@@ -661,13 +661,13 @@ function persist_state() {
 
 /**
  * @param {string | URL} url
- * @param {{ replace?: boolean; reset?: boolean; refreshAll?: boolean; invalidate?: Array<string | URL | ((url: URL) => boolean)>; state?: Record<string, any>; persistState?: boolean }} options
- * @param {number} redirect_count
+ * @param {{ type?: import('@sveltejs/kit').NavigationType; replace?: boolean; reset?: boolean; refreshAll?: boolean; invalidate?: Array<string | URL | ((url: URL) => boolean)>; state?: Record<string, any>; persistState?: boolean; event?: Event }} [options]
+ * @param {number} [redirect_count]
  * @param {{}} [nav_token]
  * @param {NavigationIntent | undefined} [intent] navigation intent, when already known by the caller (avoids recomputing it)
  * @returns {Promise<void>}
  */
-export async function _goto(url, options, redirect_count, nav_token, intent) {
+export async function _goto(url, options = {}, redirect_count = 0, nav_token = {}, intent) {
 	/** @type {Set<string>} */
 	let query_keys;
 	/** @type {Set<string>} */
@@ -680,12 +680,13 @@ export async function _goto(url, options, redirect_count, nav_token, intent) {
 	}
 
 	await navigate({
-		type: 'goto',
+		type: options.type ?? 'goto',
 		url: resolve_url(url),
 		reset: options.reset,
 		replace_state: options.replace,
 		state: options.state,
 		persist_state: options.persistState,
+		event: options.event,
 		redirect_count,
 		nav_token,
 		intent,
@@ -1607,7 +1608,7 @@ async function load_root_error_page({ error, url, route }) {
 		// client-side navigation if the root layout loader throws a redirect while
 		// rendering the default error page
 		if (error instanceof Redirect) {
-			await _goto(new URL(error.location, location.href), {}, 0);
+			await _goto(new URL(error.location, location.href));
 			return;
 		}
 
@@ -2892,7 +2893,7 @@ export async function applyAction(result) {
 	if (result.type === 'error') {
 		await set_nearest_error_page(result.error);
 	} else if (result.type === 'redirect') {
-		await _goto(result.location, { refreshAll: true }, 0);
+		await _goto(result.location, { refreshAll: true });
 	} else {
 		page.form = result.data;
 		page.status = result.status;
@@ -3108,11 +3109,13 @@ function _start_router() {
 			setTimeout(fulfil, 100); // fallback for edge case where rAF doesn't fire because e.g. tab was backgrounded
 		});
 
-		await navigate({
+		const changed = url.href !== location.href;
+
+		await _goto(url, {
 			type: 'link',
-			url,
 			reset: options.reset,
-			replace_state: options.replace_state ?? url.href === location.href,
+			replace: options.replace_state ?? !changed,
+			refreshAll: !changed,
 			event
 		});
 	});

packages/kit/src/runtime/client/remote-functions/form.svelte.js

@@ -262,13 +262,9 @@ export function form(id) {
 
 					if (response.redirect) {
 						// Use internal version to allow redirects to external URLs
-						void _goto(
-							response.redirect,
-							{
-								refreshAll: should_refresh
-							},
-							0
-						);
+						void _goto(response.redirect, {
+							refreshAll: should_refresh
+						});
 						return true;
 					}
 

packages/kit/src/runtime/client/remote-functions/prerender.svelte.js

@@ -100,7 +100,7 @@ export function prerender(id) {
 
 				if (result.redirect) {
 					// Use internal version to allow redirects to external URLs
-					void _goto(result.redirect, {}, 0);
+					void _goto(result.redirect);
 					return;
 				}
 

packages/kit/src/runtime/client/remote-functions/query-batch.svelte.js

@@ -50,7 +50,7 @@ export function query_batch(id) {
 
 						if (response.redirect) {
 							// Use internal version to allow redirects to external URLs
-							await _goto(response.redirect, {}, 0);
+							await _goto(response.redirect);
 
 							// settle all batched promises (with `undefined`, like a redirect
 							// from a non-batched query) so that callers don't hang forever

packages/kit/src/runtime/client/remote-functions/query/index.js

@@ -30,7 +30,7 @@ export function query(id) {
 
 			if (result.redirect) {
 				// Use internal version to allow redirects to external URLs
-				await _goto(result.redirect, {}, 0);
+				await _goto(result.redirect);
 			}
 		});
 	};

packages/kit/src/runtime/client/remote-functions/shared.svelte.js

@@ -197,7 +197,7 @@ export async function remote_request(url, init) {
 export async function handle_side_channel_response(response) {
 	if (response.type === 'redirect') {
 		// Use internal version to allow redirects to external URLs
-		await _goto(response.location, {}, 0);
+		await _goto(response.location);
 		throw new Redirect(307, response.location);
 	}
 

packages/kit/test/apps/async/src/routes/remote/link-refresh/+page.svelte

@@ -0,0 +1,8 @@
+<script>
+	import { increment, get_count, reset } from './data.remote.js';
+</script>
+
+<button id="reset" onclick={() => reset()}>reset</button>
+<button id="increment" onclick={() => increment()}>increment</button>
+
+<a id="count" href="/remote/link-refresh">{await get_count()}</a>

packages/kit/test/apps/async/src/routes/remote/link-refresh/data.remote.js

@@ -0,0 +1,15 @@
+import { command, query } from '$app/server';
+
+let count = 0;
+
+export const reset = command(() => {
+	count = 0;
+	get_count().refresh();
+});
+
+export const increment = command(() => {
+	count += 1;
+	// don't refresh!
+});
+
+export const get_count = query(() => count);

packages/kit/test/apps/async/test/client.test.js

@@ -31,6 +31,21 @@ test.describe('remote functions', () => {
 		expect(response.headers()['cache-control']).toBe('private, no-store');
 	});
 
+	test('clicking a link to the current page refreshes active queries', async ({ page }) => {
+		await page.goto('/remote/link-refresh');
+		await page.locator('#reset').click();
+
+		const a = page.locator('#count');
+
+		await expect(a).toHaveText('0');
+
+		await page.locator('#increment').click();
+		await expect(a).toHaveText('0');
+
+		await a.click();
+		await expect(a).toHaveText('1');
+	});
+
 	test('packages can re-export remote functions', async ({ page }) => {
 		await page.goto('/remote-lib');
 		await expect(page.locator('h1')).toHaveText('lib says hello');