test: Add Sveltekit E2E tests #695
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| node_modules | ||
|
|
||
| # Output | ||
| .output | ||
| .vercel | ||
| /.svelte-kit | ||
| /build | ||
|
|
||
| # OS | ||
| .DS_Store | ||
| Thumbs.db | ||
|
|
||
| # Env | ||
| .env | ||
| .env.* | ||
| !.env.example | ||
| !.env.test | ||
|
|
||
| # Vite | ||
| vite.config.js.timestamp-* | ||
| vite.config.ts.timestamp-* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| engine-strict=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| { | ||
| "name": "sveltekit-test-app", | ||
| "version": "0.0.1", | ||
| "type": "module", | ||
| "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" | ||
| }, | ||
| "devDependencies": { | ||
| "@sveltejs/adapter-auto": "^3.0.0", | ||
| "@sveltejs/kit": "^2.0.0", | ||
| "@sveltejs/vite-plugin-svelte": "^4.0.0", | ||
| "svelte": "^5.0.0", | ||
| "svelte-check": "^4.0.0", | ||
| "typescript": "^5.0.0", | ||
| "vite": "^5.0.3" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| // See https://svelte.dev/docs/kit/types#app | ||
| // for information about these interfaces | ||
| declare global { | ||
| namespace App { | ||
| // interface Error {} | ||
| // interface Locals {} | ||
| // interface PageData {} | ||
| // interface PageState {} | ||
| // interface Platform {} | ||
| } | ||
| } | ||
|
|
||
| export {}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <!doctype html> | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| // place files you want to import through the `$lib` alias in this folder. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| <h1>Welcome to SvelteKit</h1> | ||
| <p>Visit <a href="https://svelte.dev/docs/kit">svelte.dev/docs/kit</a> to read the documentation</p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| import adapter from '@sveltejs/adapter-auto'; | ||
| import { vitePreprocess } from '@sveltejs/vite-plugin-svelte'; | ||
|
|
||
| /** @type {import('@sveltejs/kit').Config} */ | ||
| const config = { | ||
| // Consult https://svelte.dev/docs/kit/integrations#preprocessors | ||
| // for more information about preprocessors | ||
| preprocess: vitePreprocess(), | ||
|
|
||
| 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() | ||
| } | ||
| }; | ||
|
|
||
| export default config; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| import { sveltekit } from '@sveltejs/kit/vite'; | ||
| import { defineConfig } from 'vite'; | ||
|
|
||
| export default defineConfig({ | ||
| plugins: [sveltekit()] | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| /* eslint-disable jest/expect-expect */ | ||
| import { Integration } from '../../lib/Constants'; | ||
| import { | ||
| checkEnvBuildPlugin, | ||
| checkFileContents, | ||
| checkFileExists, | ||
| checkIfBuilds, | ||
| checkIfRunsOnDevMode, | ||
| checkIfRunsOnProdMode, | ||
| checkPackageJson, | ||
| cleanupGit, | ||
| KEYS, | ||
| revertLocalChanges, | ||
| startWizardInstance, | ||
| TEST_ARGS, | ||
| } from '../utils'; | ||
| import * as path from 'path'; | ||
|
|
||
| describe('Sveltekit', () => { | ||
| const integration = Integration.sveltekit; | ||
| const projectDir = path.resolve( | ||
| __dirname, | ||
| '../test-applications/sveltekit-test-app', | ||
| ); | ||
|
|
||
| beforeAll(async () => { | ||
| const wizardInstance = startWizardInstance(integration, projectDir); | ||
|
|
||
| const packageManagerPrompted = await wizardInstance.waitForOutput( | ||
| 'Please select your package manager.', | ||
| { | ||
| optional: true, | ||
| } | ||
| ); | ||
|
|
||
| const tracingOptionPrompted = | ||
| packageManagerPrompted && | ||
| (await wizardInstance.sendStdinAndWaitForOutput( | ||
| // Selecting `yarn` as the package manager | ||
| [KEYS.DOWN, KEYS.ENTER], | ||
| // "Do you want to enable Tracing", sometimes doesn't work as `Tracing` can be printed in bold. | ||
| 'to track the performance of your application?', | ||
| { | ||
| timeout: 240_000, | ||
| } | ||
| )); | ||
|
|
||
| const replayOptionPrompted = | ||
| tracingOptionPrompted && | ||
| (await wizardInstance.sendStdinAndWaitForOutput( | ||
| [KEYS.ENTER], | ||
| // "Do you want to enable Sentry Session Replay", sometimes doesn't work as `Sentry Session Replay` can be printed in bold. | ||
| 'to get a video-like reproduction of errors during a user session?', | ||
| )); | ||
|
|
||
| replayOptionPrompted && | ||
| (await wizardInstance.sendStdinAndWaitForOutput( | ||
| [KEYS.ENTER], | ||
| 'Do you want to create an example page', | ||
| { | ||
| optional: true, | ||
| }, | ||
| )); | ||
|
|
||
| await wizardInstance.sendStdinAndWaitForOutput( | ||
| [KEYS.ENTER, KEYS.ENTER], | ||
| 'Successfully installed the Sentry SvelteKit SDK!', | ||
| ); | ||
|
|
||
| wizardInstance.kill(); | ||
| }); | ||
|
|
||
| afterAll(() => { | ||
| revertLocalChanges(projectDir); | ||
| cleanupGit(projectDir); | ||
| }); | ||
|
|
||
| test('should have the correct package.json', () => { | ||
| checkPackageJson(projectDir, integration); | ||
| }); | ||
|
|
||
| test('should have the correct .env.sentry-build-plugin', () => { | ||
| checkEnvBuildPlugin(projectDir); | ||
| }); | ||
|
|
||
| test('example page exists', () => { | ||
| checkFileExists(path.resolve(projectDir, 'src/routes/sentry-example/+page.svelte')); | ||
| checkFileExists(path.resolve(projectDir, 'src/routes/sentry-example/+server.js')); | ||
| }); | ||
|
|
||
| test('vite.config contains sentry plugin', () => { | ||
| checkFileContents(path.resolve(projectDir, 'vite.config.ts'), `plugins: [sentrySvelteKit({ | ||
| sourceMapsUploadOptions: { | ||
| `); | ||
| }); | ||
|
|
||
| test('hook files created', () => { | ||
| checkFileExists(path.resolve(projectDir, 'src/hooks.server.ts')); | ||
| checkFileExists(path.resolve(projectDir, 'src/hooks.client.ts')); | ||
| }); | ||
|
|
||
| test('hooks.client.ts contains sentry import', () => { | ||
| checkFileContents( | ||
| path.resolve(projectDir, 'src/hooks.client.ts'), | ||
| [`import * as Sentry from '@sentry/sveltekit';`, | ||
| `Sentry.init({ | ||
| dsn: '${TEST_ARGS.PROJECT_DSN}', | ||
|
|
||
| tracesSampleRate: 1.0, | ||
|
|
||
| // This sets the sample rate to be 10%. You may want this to be 100% while | ||
| // in development and sample at a lower rate in production | ||
| replaysSessionSampleRate: 0.1, | ||
|
|
||
| // If the entire session is not sampled, use the below sample rate to sample | ||
| // sessions when an error occurs. | ||
| replaysOnErrorSampleRate: 1.0, | ||
|
|
||
| // If you don't want to use Session Replay, just remove the line below: | ||
| integrations: [replayIntegration()], | ||
| });`]); | ||
| }); | ||
|
|
||
|
|
||
| test('hooks.server.ts contains sentry import', () => { | ||
| checkFileContents( | ||
| path.resolve(projectDir, 'src/hooks.server.ts'), | ||
| [ | ||
| `import * as Sentry from '@sentry/sveltekit';`, | ||
| `Sentry.init({ | ||
| dsn: '${TEST_ARGS.PROJECT_DSN}', | ||
|
|
||
| tracesSampleRate: 1.0, | ||
|
|
||
| // uncomment the line below to enable Spotlight (https://spotlightjs.com) | ||
| // spotlight: import.meta.env.DEV, | ||
| });`]) | ||
| }); | ||
|
|
||
|
|
||
| test('runs on dev mode correctly', async () => { | ||
| await checkIfRunsOnDevMode(projectDir, 'ready in'); | ||
| }); | ||
|
|
||
| test('should build successfully', async () => { | ||
| await checkIfBuilds(projectDir, 'Successfully uploaded source maps to Sentry'); | ||
| }); | ||
|
|
||
| test('runs on prod mode correctly', async () => { | ||
| // We can't use the full prompt `Network: use--host to expose` as `--host` can be printed in bold. | ||
| await checkIfRunsOnProdMode(projectDir, 'to expose', "preview"); | ||
| }); | ||
| }); | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add or adjust a test that checks for
replayIntegrationbeing added andtracesSampleRate: 1.0?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, added 👍