feat: Allow bypassing invalidateAll in enhance

.changeset/shaggy-trainers-drum.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': minor
+---
+
+[feat] Add `invalidateAll` boolean option to `enhance` callback

packages/kit/src/runtime/app/forms.js

@@ -28,16 +28,24 @@ export function enhance(form, submit = () => {}) {
 	 * @param {{
 	 *   action: URL;
 	 *   result: import('types').ActionResult;
-	 *   reset?: boolean
+	 *   reset?: boolean;
+	 *   invalidateAll?: boolean;
 	 * }} opts
 	 */
-	const fallback_callback = async ({ action, result, reset }) => {
+	const fallback_callback = async ({
+		action,
+		result,
+		reset,
+		invalidateAll: shouldInvalidateAll
+	}) => {
 		if (result.type === 'success') {
 			if (reset !== false) {
 				// We call reset from the prototype to avoid DOM clobbering
 				HTMLFormElement.prototype.reset.call(form);
 			}
-			await invalidateAll();
+			if (shouldInvalidateAll !== false) {
+				await invalidateAll();
+			}
 		}
 
 		// For success/failure results, only apply action if it belongs to the
@@ -112,7 +120,13 @@ export function enhance(form, submit = () => {}) {
 			action,
 			data,
 			form,
-			update: (opts) => fallback_callback({ action, result, reset: opts?.reset }),
+			update: (opts) =>
+				fallback_callback({
+					action,
+					result,
+					reset: opts?.reset,
+					invalidateAll: opts?.invalidateAll
+				}),
 			// @ts-expect-error generic constraints stuff we don't care about
 			result
 		});

packages/kit/test/apps/basics/src/routes/actions/invalidate-all/+layout.js

@@ -0,0 +1,5 @@
+export function load() {
+	return {
+		changes_every_load: new Date()
+	};
+}

packages/kit/test/apps/basics/src/routes/actions/invalidate-all/+page.server.js

@@ -0,0 +1,10 @@
+export function load({ url }) {
+	const invalidate_all = url.searchParams.get('invalidate_all') === 'true';
+	return {
+		invalidate_all
+	};
+}
+
+export const actions = {
+	default: () => {}
+};

packages/kit/test/apps/basics/src/routes/actions/invalidate-all/+page.svelte

@@ -0,0 +1,22 @@
+<script>
+	import { enhance } from '$app/forms';
+
+	export let data;
+
+	/**
+	 * @param {HTMLFormElement} node
+	 */
+	function enhanceWrapper(node) {
+		return enhance(
+			node,
+			() =>
+				({ update }) =>
+					update({ invalidateAll: data.invalidate_all })
+		);
+	}
+</script>
+
+<form method="POST" use:enhanceWrapper>
+	<pre>{data.changes_every_load.toISOString()}</pre>
+	<button type="submit">invalidate</button>
+</form>

packages/kit/test/apps/basics/test/test.js

@@ -828,6 +828,32 @@ test.describe('Matchers', () => {
 });
 
 test.describe('Actions', () => {
+	test("invalidateAll = false doesn't invalidate all", async ({ page, javaScriptEnabled }) => {
+		await page.goto('/actions/invalidate-all?invalidate_all=false');
+		const preSubmitContent = await page.locator('pre').textContent();
+		await page.click('button');
+		// The value that should not change is time-based and might not have the granularity to change
+		// if we don't give it time to
+		await page.waitForTimeout(1000);
+		const postSubmitContent = await page.locator('pre').textContent();
+		if (!javaScriptEnabled) {
+			expect(preSubmitContent).not.toBe(postSubmitContent);
+		} else {
+			expect(preSubmitContent).toBe(postSubmitContent);
+		}
+	});
+
+	test('invalidateAll = true does invalidate all', async ({ page }) => {
+		await page.goto('/actions/invalidate-all?invalidate_all=true');
+		const preSubmitContent = await page.locator('pre').textContent();
+		await page.click('button');
+		// The value that should not change is time-based and might not have the granularity to change
+		// if we don't give it time to
+		await page.waitForTimeout(1000);
+		const postSubmitContent = await page.locator('pre').textContent();
+		expect(preSubmitContent).not.toBe(postSubmitContent);
+	});
+
 	test('Error props are returned', async ({ page, javaScriptEnabled }) => {
 		await page.goto('/actions/form-errors');
 		await page.click('button');

packages/kit/test/apps/dev-only/package.json

@@ -1,5 +1,5 @@
 {
-	"name": "test-basics",
+	"name": "test-no",
 	"private": true,
 	"version": "0.0.2-next.0",
 	"scripts": {

packages/kit/types/ambient.d.ts

@@ -94,8 +94,9 @@ declare module '$app/forms' {
 				/**
 				 * Call this to get the default behavior of a form submission response.
 				 * @param options Set `reset: false` if you don't want the `<form>` values to be reset after a successful submission.
+				 * @param invalidateAll Set `invalidateAll: false` if you don't want the action to call `invalidateAll` after submission.
 				 */
-				update(options?: { reset: boolean }): Promise<void>;
+				update(options?: { reset?: boolean; invalidateAll?: boolean }): Promise<void>;
 		  }) => void)
 	>;