fix: split async test into separate project, adapt tests when running in baseline svelte version

dominikg · dominikg · commit a6f2138d57a1 · 2025-07-15T15:21:12.000+02:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -95,7 +95,7 @@ jobs:
           # future test with rolldown-vite
           - node: 24
             os: ubuntu-latest
-            vite: 'rolldown-vite',
+            vite: 'rolldown-vite'
             svelte: 'current'
     steps:
       - uses: actions/checkout@v4
diff --git a/packages/e2e-tests/_test_dependencies/svelte-api-only/package.json b/packages/e2e-tests/_test_dependencies/svelte-api-only/package.json
@@ -15,6 +15,6 @@
   },
   "type": "module",
   "dependencies": {
-    "svelte": "^5.36.0"
+    "svelte": "^5.0.0"
   }
 }
diff --git a/packages/e2e-tests/css-treeshake/__tests__/css-treeshake.spec.ts b/packages/e2e-tests/css-treeshake/__tests__/css-treeshake.spec.ts
@@ -1,37 +1,48 @@
-import { browserLogs, findAssetFile, getColor, getEl, getText, isBuild } from '~utils';
+import {
+	browserLogs,
+	findAssetFile,
+	getColor,
+	getEl,
+	getText,
+	IS_SVELTE_BASELINE,
+	isBuild
+} from '~utils';
 import { expect } from 'vitest';
 
-test('should not have failed requests', async () => {
-	browserLogs.forEach((msg) => {
-		expect(msg).not.toMatch('404');
+// support for treeshaking css was added after 5.0.0
+describe.skipIf(IS_SVELTE_BASELINE)('css-treeshake', () => {
+	test('should not have failed requests', async () => {
+		browserLogs.forEach((msg) => {
+			expect(msg).not.toMatch('404');
+		});
 	});
-});
-
-test('should apply css from used components', async () => {
-	expect(await getText('#app')).toBe('App');
-	expect(await getColor('#app')).toBe('blue');
-	expect(await getText('#a')).toBe('A');
-	expect(await getColor('#a')).toBe('red');
-});
-
-test('should apply css from unused components that contain global styles', async () => {
-	expect(await getEl('head style[src]'));
-	expect(await getColor('#test')).toBe('green'); // from B.svelte
-});
 
-test('should not render unused components', async () => {
-	expect(await getEl('#b')).toBeNull();
-	expect(await getEl('#c')).toBeNull();
-});
+	test('should apply css from used components', async () => {
+		expect(await getText('#app')).toBe('App');
+		expect(await getColor('#app')).toBe('blue');
+		expect(await getText('#a')).toBe('A');
+		expect(await getColor('#a')).toBe('red');
+	});
 
-if (isBuild) {
-	test('should include unscoped global styles from unused components', async () => {
-		const cssOutput = findAssetFile(/index-.*\.css/);
-		expect(cssOutput).toContain('#test{color:green}'); // from B.svelte
+	test('should apply css from unused components that contain global styles', async () => {
+		expect(await getEl('head style[src]'));
+		expect(await getColor('#test')).toBe('green'); // from B.svelte
 	});
-	test('should not include scoped styles from unused components', async () => {
-		const cssOutput = findAssetFile(/index-.*\.css/);
-		// from C.svelte
-		expect(cssOutput).not.toContain('.unused');
+
+	test('should not render unused components', async () => {
+		expect(await getEl('#b')).toBeNull();
+		expect(await getEl('#c')).toBeNull();
 	});
-}
+
+	if (isBuild) {
+		test('should include unscoped global styles from unused components', async () => {
+			const cssOutput = findAssetFile(/index-.*\.css/);
+			expect(cssOutput).toContain('#test{color:green}'); // from B.svelte
+		});
+		test('should not include scoped styles from unused components', async () => {
+			const cssOutput = findAssetFile(/index-.*\.css/);
+			// from C.svelte
+			expect(cssOutput).not.toContain('.unused');
+		});
+	}
+});
diff --git a/packages/e2e-tests/import-queries/__tests__/__snapshots__/svelte-5/raw.txt b/packages/e2e-tests/import-queries/__tests__/__snapshots__/svelte-5/raw.txt
@@ -1,10 +1,14 @@
 <script lang="ts">
-	export let name: string;
-	let clicks = 0;
+	interface Props {
+		name: string;
+	}
+
+	let { name }: Props = $props();
+	let clicks = $state(0);
 </script>
 
 <button
-	on:click={() => {
+	onclick={() => {
 		clicks++;
 	}}>{name} clicks: {clicks}</button
 >
diff --git a/packages/e2e-tests/import-queries/__tests__/__snapshots__/svelte-5/ssr-raw.txt b/packages/e2e-tests/import-queries/__tests__/__snapshots__/svelte-5/ssr-raw.txt
@@ -1,10 +1,14 @@
 <script lang="ts">
-	export let name: string;
-	let clicks = 0;
+	interface Props {
+		name: string;
+	}
+
+	let { name }: Props = $props();
+	let clicks = $state(0);
 </script>
 
 <button
-	on:click={() => {
+	onclick={() => {
 		clicks++;
 	}}>{name} clicks: {clicks}</button
 >
diff --git a/packages/e2e-tests/import-queries/src/Dummy.svelte b/packages/e2e-tests/import-queries/src/Dummy.svelte
@@ -1,10 +1,14 @@
 <script lang="ts">
-	export let name: string;
-	let clicks = 0;
+	interface Props {
+		name: string;
+	}
+
+	let { name }: Props = $props();
+	let clicks = $state(0);
 </script>
 
 <button
-	on:click={() => {
+	onclick={() => {
 		clicks++;
 	}}>{name} clicks: {clicks}</button
 >
diff --git a/packages/e2e-tests/kit-async/.gitignore b/packages/e2e-tests/kit-async/.gitignore
@@ -0,0 +1,23 @@
+node_modules
+
+# Output
+.output
+.vercel
+.netlify
+.wrangler
+/.svelte-kit
+/build
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Env
+.env
+.env.*
+!.env.example
+!.env.test
+
+# Vite
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
diff --git a/packages/e2e-tests/kit-async/README.md b/packages/e2e-tests/kit-async/README.md
@@ -0,0 +1,38 @@
+# sv
+
+Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
+
+## Creating a project
+
+If you're seeing this, you've probably already done this step. Congrats!
+
+```bash
+# create a new project in the current directory
+npx sv create
+
+# create a new project in my-app
+npx sv create my-app
+```
+
+## Developing
+
+Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+
+```bash
+npm run dev
+
+# or start the server and open the app in a new browser tab
+npm run dev -- --open
+```
+
+## Building
+
+To create a production version of your app:
+
+```bash
+npm run build
+```
+
+You can preview the production build with `npm run preview`.
+
+> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
diff --git a/packages/e2e-tests/kit-async/__tests__/kit-async.spec.ts b/packages/e2e-tests/kit-async/__tests__/kit-async.spec.ts
@@ -0,0 +1,12 @@
+import { describe, expect, it } from 'vitest';
+import { getText, IS_SVELTE_BASELINE, sleep } from '~utils';
+
+describe.skipIf(IS_SVELTE_BASELINE)('kit-async', async () => {
+	it('works', async () => {
+		expect(await getText('h1')).toBe('Hello async world!');
+		expect(await getText('span')).toBe('Wait for it ...');
+		// TODO ideally this would wait for the actual async settled but that requires a new util
+		await sleep(700); // the async derived resolves after 500ms
+		expect(await getText('span')).toBe('foo');
+	});
+});
diff --git a/packages/e2e-tests/kit-async/package.json b/packages/e2e-tests/kit-async/package.json
@@ -0,0 +1,23 @@
+{
+  "name": "e2e-tests-kit-async",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite dev",
+    "build": "vite build",
+    "preview": "vite preview",
+    "prepare": "svelte-kit sync || echo ''",
+    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+    "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch"
+  },
+  "devDependencies": {
+    "@sveltejs/adapter-node": "^5.2.12",
+    "@sveltejs/kit": "^2.22.2",
+    "@sveltejs/vite-plugin-svelte": "workspace:^",
+    "svelte": "^5.36.0",
+    "svelte-check": "^4.0.0",
+    "typescript": "^5.8.3",
+    "vite": "^7.0.2"
+  }
+}
diff --git a/packages/e2e-tests/kit-async/src/app.d.ts b/packages/e2e-tests/kit-async/src/app.d.ts
@@ -0,0 +1,13 @@
+// See https://svelte.dev/docs/kit/types#app.d.ts
+// for information about these interfaces
+declare global {
+	namespace App {
+		// interface Error {}
+		// interface Locals {}
+		// interface PageData {}
+		// interface PageState {}
+		// interface Platform {}
+	}
+}
+
+export {};
diff --git a/packages/e2e-tests/kit-async/src/app.html b/packages/e2e-tests/kit-async/src/app.html
@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<link rel="icon" href="%sveltekit.assets%/favicon.png" />
+		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		%sveltekit.head%
+	</head>
+	<body data-sveltekit-preload-data="hover">
+		<div style="display: contents">%sveltekit.body%</div>
+	</body>
+</html>
diff --git a/packages/e2e-tests/kit-async/src/lib/async.svelte.js b/packages/e2e-tests/kit-async/src/lib/async.svelte.js
@@ -0,0 +1,10 @@
+export async function asyncFoo() {
+	const foo = $derived(
+		await new Promise((resolve) =>
+			setTimeout(() => {
+				resolve('foo');
+			}, 500)
+		)
+	);
+	return () => foo;
+}
diff --git a/packages/e2e-tests/kit-async/src/lib/index.ts b/packages/e2e-tests/kit-async/src/lib/index.ts
@@ -0,0 +1 @@
+// place files you want to import through the `$lib` alias in this folder.
diff --git a/packages/e2e-tests/kit-async/src/routes/+page.svelte b/packages/e2e-tests/kit-async/src/routes/+page.svelte
@@ -0,0 +1,13 @@
+<script>
+	import { asyncFoo } from '$lib/async.svelte.js';
+</script>
+
+<h1>Hello async world!</h1>
+<span>
+	<svelte:boundary>
+		{(await asyncFoo())()}
+		{#snippet pending()}
+			Wait for it ...
+		{/snippet}
+	</svelte:boundary>
+</span>
diff --git a/packages/e2e-tests/kit-async/static/favicon.png b/packages/e2e-tests/kit-async/static/favicon.png
diff --git a/packages/e2e-tests/kit-async/svelte.config.js b/packages/e2e-tests/kit-async/svelte.config.js
@@ -0,0 +1,18 @@
+import adapter from '@sveltejs/adapter-node';
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+	kit: {
+		// adapter-auto only supports some environments, see https://svelte.dev/docs/kit/adapter-auto for a list.
+		// If your environment is not supported, or you settled on a specific environment, switch out the adapter.
+		// See https://svelte.dev/docs/kit/adapters for more information about adapters.
+		adapter: adapter()
+	},
+	compilerOptions: {
+		experimental: {
+			async: true
+		}
+	}
+};
+
+export default config;
diff --git a/packages/e2e-tests/kit-async/tsconfig.json b/packages/e2e-tests/kit-async/tsconfig.json
@@ -0,0 +1,19 @@
+{
+	"extends": "./.svelte-kit/tsconfig.json",
+	"compilerOptions": {
+		"allowJs": true,
+		"checkJs": true,
+		"esModuleInterop": true,
+		"forceConsistentCasingInFileNames": true,
+		"resolveJsonModule": true,
+		"skipLibCheck": true,
+		"sourceMap": true,
+		"strict": true,
+		"moduleResolution": "bundler"
+	}
+	// Path aliases are handled by https://svelte.dev/docs/kit/configuration#alias
+	// except $lib which is handled by https://svelte.dev/docs/kit/configuration#files
+	//
+	// If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
+	// from the referenced tsconfig.json - TypeScript does not merge them in
+}
diff --git a/packages/e2e-tests/kit-async/vite.config.ts b/packages/e2e-tests/kit-async/vite.config.ts
@@ -0,0 +1,6 @@
+import { sveltekit } from '@sveltejs/kit/vite';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+	plugins: [sveltekit()]
+});
diff --git a/packages/e2e-tests/kit-node/__tests__/kit.spec.ts b/packages/e2e-tests/kit-node/__tests__/kit.spec.ts
diff --git a/packages/e2e-tests/kit-node/src/lib/async-util.svelte.js b/packages/e2e-tests/kit-node/src/lib/async-util.svelte.js
diff --git a/packages/e2e-tests/kit-node/src/routes/+page.svelte b/packages/e2e-tests/kit-node/src/routes/+page.svelte
diff --git a/packages/e2e-tests/kit-node/svelte.config.js b/packages/e2e-tests/kit-node/svelte.config.js
diff --git a/packages/e2e-tests/prebundle-svelte-deps/__tests__/prebundle-svelte-deps.spec.ts b/packages/e2e-tests/prebundle-svelte-deps/__tests__/prebundle-svelte-deps.spec.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,6 @@`
`15`	`15`	`},`
`16`	`16`	`"type": "module",`
`17`	`17`	`"dependencies": {`
`18`		`- "svelte": "^5.36.0"`
	`18`	`+ "svelte": "^5.0.0"`
`19`	`19`	`}`
`20`	`20`	`}`