test(e2e): Add SvelteKit e2e test (v8 SDK) (#406)

.changeset/config.json

@@ -12,6 +12,7 @@
     "@spotlightjs/website",
     "@spotlightjs/demo-sveltekit",
     "@spotlightjs/e2e-tests-astro",
-    "@spotlightjs/e2e-tests-nextjs"
+    "@spotlightjs/e2e-tests-nextjs",
+    "@spotlightjs/e2e-tests-sveltekit"
   ]
 }

e2e-tests/sveltekit/.eslintignore

@@ -0,0 +1,13 @@
+.DS_Store
+node_modules
+/build
+/.svelte-kit
+/package
+.env
+.env.*
+!.env.example
+
+# Ignore files for PNPM, NPM and YARN
+pnpm-lock.yaml
+package-lock.json
+yarn.lock

e2e-tests/sveltekit/.eslintrc.cjs

@@ -0,0 +1,31 @@
+/** @type { import("eslint").Linter.FlatConfig } */
+module.exports = {
+	root: true,
+	extends: [
+		'eslint:recommended',
+		'plugin:@typescript-eslint/recommended',
+		'plugin:svelte/recommended',
+		'prettier'
+	],
+	parser: '@typescript-eslint/parser',
+	plugins: ['@typescript-eslint'],
+	parserOptions: {
+		sourceType: 'module',
+		ecmaVersion: 2020,
+		extraFileExtensions: ['.svelte']
+	},
+	env: {
+		browser: true,
+		es2017: true,
+		node: true
+	},
+	overrides: [
+		{
+			files: ['*.svelte'],
+			parser: 'svelte-eslint-parser',
+			parserOptions: {
+				parser: '@typescript-eslint/parser'
+			}
+		}
+	]
+};

e2e-tests/sveltekit/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+node_modules
+/build
+/.svelte-kit
+/package
+.env
+.env.*
+!.env.example
+.vercel
+.output
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*

e2e-tests/sveltekit/.npmrc

@@ -0,0 +1 @@
+engine-strict=true

e2e-tests/sveltekit/.prettierignore

@@ -0,0 +1,13 @@
+.DS_Store
+node_modules
+/build
+/.svelte-kit
+/package
+.env
+.env.*
+!.env.example
+
+# Ignore files for PNPM, NPM and YARN
+pnpm-lock.yaml
+package-lock.json
+yarn.lock

e2e-tests/sveltekit/.prettierrc

@@ -0,0 +1,8 @@
+{
+	"useTabs": true,
+	"singleQuote": true,
+	"trailingComma": "none",
+	"printWidth": 100,
+	"plugins": ["prettier-plugin-svelte"],
+	"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
+}

e2e-tests/sveltekit/README.md

@@ -0,0 +1,38 @@
+# create-svelte
+
+Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
+
+## 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
+npm create svelte@latest
+
+# create a new project in my-app
+npm create svelte@latest 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://kit.svelte.dev/docs/adapters) for your target environment.

e2e-tests/sveltekit/package.json

@@ -0,0 +1,48 @@
+{
+	"name": "@spotlightjs/e2e-tests-sveltekit",
+	"version": "0.0.1",
+	"scripts": {
+		"dev": "vite dev",
+		"build": "vite build",
+		"preview": "vite preview",
+		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+		"test": "vitest",
+		"lint": "prettier --check . && eslint .",
+		"format": "prettier --write .",
+		"clean": "rimraf .svelte-kit",
+		"test:e2e:prepare": "playwright install --with-deps",
+		"test:e2e": "playwright test",
+		"test:e2e:ci": "pnpm test:e2e:prepare && pnpm test:e2e"
+	},
+	"dependencies": {
+		"@sentry/sveltekit": "8.7.0"
+	},
+	"devDependencies": {
+		"@fontsource/fira-mono": "^4.5.10",
+		"@neoconfetti/svelte": "^1.0.0",
+		"@spotlightjs/spotlight": "workspace:*",
+		"@sveltejs/adapter-auto": "^2.0.0",
+		"@sveltejs/kit": "^1.27.4",
+		"@types/cookie": "^0.5.1",
+		"@typescript-eslint/eslint-plugin": "^6.0.0",
+		"@typescript-eslint/parser": "^6.0.0",
+		"eslint": "^8.28.0",
+		"eslint-config-prettier": "^9.0.0",
+		"eslint-plugin-svelte": "^2.30.0",
+		"prettier": "^3.0.0",
+		"prettier-plugin-svelte": "^3.0.0",
+		"svelte": "^4.2.7",
+		"svelte-check": "^3.6.0",
+		"tslib": "^2.4.1",
+		"typescript": "^5.0.0",
+		"vite": "^4.5.2",
+		"vitest": "^0.34.0",
+		"@types/node": "20.10.4",
+		"@playwright/test": "^1.40.1"
+	},
+	"type": "module",
+	"volta": {
+		"extends": "../../package.json"
+	}
+}

e2e-tests/sveltekit/playwright.config.ts

@@ -0,0 +1,79 @@
+import { defineConfig, devices } from '@playwright/test';
+
+// Use process.env.PORT by default and fallback to port 3000
+const PORT = process.env.PORT || 5173;
+
+// Set webServer.url and use.baseURL with the location of the WebServer respecting the correct set port
+const baseURL = `http://localhost:${PORT}`;
+
+// Reference: https://playwright.dev/docs/test-configuration
+export default defineConfig({
+	// Timeout per test
+	timeout: 30 * 1000,
+	// Test directory
+	testDir: 'tests',
+	/* Fail the build on CI if you accidentally left test.only in the source code. */
+	forbidOnly: !!process.env.CI,
+	/* Retry on CI only */
+	retries: process.env.CI ? 2 : 0,
+	/* Opt out of parallel tests on CI. */
+	workers: process.env.CI ? 1 : undefined,
+	// Artifacts folder where screenshots, videos, and traces are stored.
+	outputDir: 'test-results/',
+
+	// Run your local dev server before starting the tests:
+	// https://playwright.dev/docs/test-advanced#launching-a-development-web-server-during-the-tests
+	webServer: {
+		command: 'pnpm dev',
+		url: baseURL,
+		timeout: 120 * 1000,
+		reuseExistingServer: false
+	},
+
+	use: {
+		// Use baseURL so to make navigations relative.
+		// More information: https://playwright.dev/docs/api/class-testoptions#test-options-base-url
+		baseURL,
+
+		// Retry a test if its failing with enabled tracing. This allows you to analyze the DOM, console logs, network traffic etc.
+		// More information: https://playwright.dev/docs/trace-viewer
+		trace: 'retry-with-trace'
+
+		// All available context options: https://playwright.dev/docs/api/class-browser#browser-new-context
+		// contextOptions: {
+		//   ignoreHTTPSErrors: true,
+		// },
+	},
+
+	projects: [
+		{
+			name: 'Desktop Chrome',
+			use: {
+				...devices['Desktop Chrome']
+			}
+		}
+		// {
+		//   name: 'Desktop Firefox',
+		//   use: {
+		//     ...devices['Desktop Firefox'],
+		//   },
+		// },
+		// {
+		//   name: 'Desktop Safari',
+		//   use: {
+		//     ...devices['Desktop Safari'],
+		//   },
+		// },
+		// Test against mobile viewports.
+		// {
+		//   name: "Mobile Chrome",
+		//   use: {
+		//     ...devices["Pixel 5"],
+		//   },
+		// },
+		// {
+		//   name: "Mobile Safari",
+		//   use: devices["iPhone 12"],
+		// },
+	]
+});

e2e-tests/sveltekit/src/app.d.ts

@@ -0,0 +1,12 @@
+// See https://kit.svelte.dev/docs/types#app
+// for information about these interfaces
+declare global {
+	namespace App {
+		// interface Error {}
+		// interface Locals {}
+		// interface PageData {}
+		// interface Platform {}
+	}
+}
+
+export {};

e2e-tests/sveltekit/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>

e2e-tests/sveltekit/src/hooks.client.ts

@@ -0,0 +1,13 @@
+import * as Sentry from '@sentry/sveltekit';
+import { init as initSpotlight } from '@spotlightjs/spotlight';
+
+Sentry.init({
+	debug: true,
+	tracesSampleRate: 1.0
+});
+
+if (import.meta.env.DEV) {
+	initSpotlight({ injectImmediately: true, anchor: 'bottomRight', debug: true });
+}
+
+export const handleError = Sentry.handleErrorWithSentry();

e2e-tests/sveltekit/src/hooks.server.ts

@@ -0,0 +1,16 @@
+import * as Sentry from '@sentry/sveltekit';
+import { setupSidecar } from '@spotlightjs/spotlight/sidecar';
+
+Sentry.init({
+	debug: true,
+	tracesSampleRate: 1.0,
+	spotlight: import.meta.env.DEV
+});
+
+if (import.meta.env.DEV) {
+	setupSidecar();
+}
+
+export const handleError = Sentry.handleErrorWithSentry();
+
+export const handle = Sentry.sentryHandle();

e2e-tests/sveltekit/src/routes/+layout.svelte

@@ -0,0 +1,53 @@
+<script>
+	import Header from './Header.svelte';
+	import './styles.css';
+</script>
+
+<div class="app">
+	<Header />
+
+	<main>
+		<slot />
+	</main>
+
+	<footer>
+		<p>visit <a href="https://kit.svelte.dev">kit.svelte.dev</a> to learn SvelteKit</p>
+	</footer>
+</div>
+
+<style>
+	.app {
+		display: flex;
+		flex-direction: column;
+		min-height: 100vh;
+	}
+
+	main {
+		flex: 1;
+		display: flex;
+		flex-direction: column;
+		padding: 1rem;
+		width: 100%;
+		max-width: 64rem;
+		margin: 0 auto;
+		box-sizing: border-box;
+	}
+
+	footer {
+		display: flex;
+		flex-direction: column;
+		justify-content: center;
+		align-items: center;
+		padding: 12px;
+	}
+
+	footer a {
+		font-weight: bold;
+	}
+
+	@media (min-width: 480px) {
+		footer {
+			padding: 12px 0;
+		}
+	}
+</style>