-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat(nuxt): Add option autoInjectServerSentry
(no default import()
)
#14553
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
d435ce2
feat(nuxt): Add option `autoInjectServerSentry` (no default import())
s1gr1d 30c4bc5
add E2E tests
s1gr1d f5b0a8f
use correct file as server entry
s1gr1d 3b98f82
Merge branch 'develop' into sig/import-flag-default
s1gr1d 158b61b
add --import flag
s1gr1d 78affb6
add --import in nuxt-4 test app
s1gr1d 4763cde
Merge branch 'develop' into sig/import-flag-default
s1gr1d c6d6fbb
add changelog entry
s1gr1d d09d645
review suggestions
s1gr1d fd4f65a
Merge branch 'develop' into sig/import-flag-default
s1gr1d File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
add E2E tests
- Loading branch information
commit 30c4bc5b75ad70dbc3478dc88d692fe2e7ac4ce2
There are no files selected for viewing
24 changes: 24 additions & 0 deletions
24
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/.gitignore
This file contains hidden or 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,24 @@ | ||
# Nuxt dev/build outputs | ||
.output | ||
.data | ||
.nuxt | ||
.nitro | ||
.cache | ||
dist | ||
|
||
# Node dependencies | ||
node_modules | ||
|
||
# Logs | ||
logs | ||
*.log | ||
|
||
# Misc | ||
.DS_Store | ||
.fleet | ||
.idea | ||
|
||
# Local env files | ||
.env | ||
.env.* | ||
!.env.example |
2 changes: 2 additions & 0 deletions
2
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/.npmrc
This file contains hidden or 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 @@ | ||
@sentry:registry=http://127.0.0.1:4873 | ||
@sentry-internal:registry=http://127.0.0.1:4873 |
17 changes: 17 additions & 0 deletions
17
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/app.vue
This file contains hidden or 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,17 @@ | ||
<template> | ||
<NuxtLayout> | ||
<header> | ||
<nav> | ||
<ul> | ||
<li><NuxtLink to="/fetch-server-error">Fetch Server Error</NuxtLink></li> | ||
<li><NuxtLink to="/test-param/1234">Fetch Param</NuxtLink></li> | ||
<li><NuxtLink to="/client-error">Client Error</NuxtLink></li> | ||
</ul> | ||
</nav> | ||
</header> | ||
<NuxtPage /> | ||
</NuxtLayout> | ||
</template> | ||
|
||
<script setup> | ||
</script> |
22 changes: 22 additions & 0 deletions
22
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/components/ErrorButton.vue
This file contains hidden or 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,22 @@ | ||
<script setup> | ||
import { defineProps } from 'vue'; | ||
|
||
const props = defineProps({ | ||
errorText: { | ||
type: String, | ||
required: true | ||
}, | ||
id: { | ||
type: String, | ||
required: true | ||
} | ||
}) | ||
|
||
const triggerError = () => { | ||
throw new Error(props.errorText); | ||
}; | ||
</script> | ||
|
||
<template> | ||
<button :id="props.id" @click="triggerError">Trigger Error</button> | ||
</template> |
7 changes: 7 additions & 0 deletions
7
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/copyIITM.bash
This file contains hidden or 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,7 @@ | ||
# This script copies the `import-in-the-middle` content of the E2E test project root `node_modules` to the build output `node_modules` | ||
# For some reason, some files are missing in the output (like `hook.mjs`) and this is not reproducible in external, standalone projects. | ||
# | ||
# Things we tried (that did not fix the problem): | ||
# - Adding a resolution for `@vercel/nft` v0.27.0 (this worked in the standalone project) | ||
# - Also adding `@vercel/nft` v0.27.0 to pnpm `peerDependencyRules` | ||
cp -r node_modules/.pnpm/import-in-the-middle@1.*/node_modules/import-in-the-middle .output/server/node_modules/import-in-the-middle |
23 changes: 23 additions & 0 deletions
23
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/nuxt.config.ts
This file contains hidden or 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,23 @@ | ||
// https://nuxt.com/docs/api/configuration/nuxt-config | ||
export default defineNuxtConfig({ | ||
modules: ['@sentry/nuxt/module'], | ||
imports: { | ||
autoImport: false, | ||
}, | ||
runtimeConfig: { | ||
public: { | ||
sentry: { | ||
dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
}, | ||
}, | ||
}, | ||
nitro: { | ||
rollupConfig: { | ||
// @sentry/... is set external to prevent bundling all of Sentry into the `runtime.mjs` file in the build output | ||
external: [/@sentry\/.*/], | ||
}, | ||
}, | ||
sentry: { | ||
autoInjectServerSentry: 'top-level-import', | ||
} | ||
}); |
25 changes: 25 additions & 0 deletions
25
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/package.json
This file contains hidden or 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,25 @@ | ||
{ | ||
"name": "nuxt-3-dynamic-import", | ||
"private": true, | ||
"type": "module", | ||
"scripts": { | ||
"build": "nuxt build && bash ./copyIITM.bash", | ||
"dev": "nuxt dev", | ||
"generate": "nuxt generate", | ||
"preview": "nuxt preview", | ||
"start": "node .output/server/index.mjs", | ||
"clean": "npx nuxi cleanup", | ||
"test": "playwright test", | ||
"test:build": "pnpm install && npx playwright install && pnpm build", | ||
"test:assert": "pnpm test" | ||
}, | ||
"dependencies": { | ||
"@sentry/nuxt": "latest || *", | ||
"nuxt": "^3.14.0" | ||
}, | ||
"devDependencies": { | ||
"@nuxt/test-utils": "^3.14.1", | ||
"@playwright/test": "^1.44.1", | ||
"@sentry-internal/test-utils": "link:../../../test-utils" | ||
} | ||
} |
11 changes: 11 additions & 0 deletions
11
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/pages/client-error.vue
This file contains hidden or 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 @@ | ||
<script setup> | ||
import ErrorButton from '../components/ErrorButton.vue'; | ||
</script> | ||
|
||
<template> | ||
<ErrorButton id="errorBtn" error-text="Error thrown from Nuxt-3 E2E test app"/> | ||
<ErrorButton id="errorBtn2" error-text="Another Error thrown from Nuxt-3 E2E test app"/> | ||
</template> | ||
|
||
|
||
|
13 changes: 13 additions & 0 deletions
13
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/pages/fetch-server-error.vue
This file contains hidden or 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 @@ | ||
<template> | ||
<div> | ||
<button @click="fetchData">Fetch Server Data</button> | ||
</div> | ||
</template> | ||
|
||
<script setup lang="ts"> | ||
import { useFetch} from '#imports' | ||
|
||
const fetchData = async () => { | ||
await useFetch('/api/server-error'); | ||
} | ||
</script> |
3 changes: 3 additions & 0 deletions
3
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/pages/index.vue
This file contains hidden or 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,3 @@ | ||
<template> | ||
<h1>Hello!</h1> | ||
</template> |
23 changes: 23 additions & 0 deletions
23
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/pages/test-param/[param].vue
This file contains hidden or 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,23 @@ | ||
<script setup lang="ts"> | ||
import { useRoute, useFetch } from '#imports' | ||
|
||
const route = useRoute(); | ||
const param = route.params.param; | ||
|
||
const fetchError = async () => { | ||
await useFetch(`/api/param-error/${param}`); | ||
} | ||
|
||
const fetchData = async () => { | ||
await useFetch(`/api/test-param/${param}`); | ||
}; | ||
</script> | ||
|
||
<template> | ||
<p>Param: {{ $route.params.param }}</p> | ||
|
||
<ErrorButton id="errorBtn" errorText="Error thrown from Param Route Button" /> | ||
<button @click="fetchData">Fetch Server Data</button> | ||
<button @click="fetchError">Fetch Server Error</button> | ||
</template> | ||
|
19 changes: 19 additions & 0 deletions
19
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/playwright.config.ts
This file contains hidden or 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 @@ | ||
import { fileURLToPath } from 'node:url'; | ||
import type { ConfigOptions } from '@nuxt/test-utils/playwright'; | ||
import { getPlaywrightConfig } from '@sentry-internal/test-utils'; | ||
|
||
const nuxtConfigOptions: ConfigOptions = { | ||
nuxt: { | ||
rootDir: fileURLToPath(new URL('.', import.meta.url)), | ||
}, | ||
}; | ||
|
||
/* Make sure to import from '@nuxt/test-utils/playwright' in the tests | ||
* Like this: import { expect, test } from '@nuxt/test-utils/playwright' */ | ||
|
||
const config = getPlaywrightConfig({ | ||
startCommand: `pnpm start`, | ||
use: { ...nuxtConfigOptions }, | ||
}); | ||
|
||
export default config; |
Binary file added
BIN
+4.19 KB
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/public/favicon.ico
Binary file not shown.
16 changes: 16 additions & 0 deletions
16
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/sentry.client.config.ts
This file contains hidden or 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,16 @@ | ||
import * as Sentry from '@sentry/nuxt'; | ||
import { useRuntimeConfig } from '#imports'; | ||
|
||
Sentry.init({ | ||
environment: 'qa', // dynamic sampling bias to keep transactions | ||
dsn: useRuntimeConfig().public.sentry.dsn, | ||
tunnel: `http://localhost:3031/`, // proxy server | ||
tracesSampleRate: 1.0, | ||
integrations: [ | ||
Sentry.vueIntegration({ | ||
tracingOptions: { | ||
trackComponents: true, | ||
}, | ||
}), | ||
], | ||
}); |
8 changes: 8 additions & 0 deletions
8
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/sentry.server.config.ts
This file contains hidden or 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,8 @@ | ||
import * as Sentry from '@sentry/nuxt'; | ||
|
||
Sentry.init({ | ||
dsn: 'https://public@dsn.ingest.sentry.io/1337', | ||
environment: 'qa', // dynamic sampling bias to keep transactions | ||
tracesSampleRate: 1.0, // Capture 100% of the transactions | ||
tunnel: 'http://localhost:3031/', // proxy server | ||
}); |
5 changes: 5 additions & 0 deletions
5
...kages/e2e-tests/test-applications/nuxt-3-dynamic-import/server/api/param-error/[param].ts
This file contains hidden or 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,5 @@ | ||
import { defineEventHandler } from '#imports'; | ||
|
||
export default defineEventHandler(_e => { | ||
throw new Error('Nuxt 3 Param Server error'); | ||
}); |
5 changes: 5 additions & 0 deletions
5
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/server/api/server-error.ts
This file contains hidden or 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,5 @@ | ||
import { defineEventHandler } from '#imports'; | ||
|
||
export default defineEventHandler(event => { | ||
throw new Error('Nuxt 3 Server error'); | ||
}); |
7 changes: 7 additions & 0 deletions
7
...ckages/e2e-tests/test-applications/nuxt-3-dynamic-import/server/api/test-param/[param].ts
This file contains hidden or 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,7 @@ | ||
import { defineEventHandler, getRouterParam } from '#imports'; | ||
|
||
export default defineEventHandler(event => { | ||
const param = getRouterParam(event, 'param'); | ||
|
||
return `Param: ${param}!`; | ||
}); |
3 changes: 3 additions & 0 deletions
3
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/server/tsconfig.json
This file contains hidden or 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,3 @@ | ||
{ | ||
"extends": "../.nuxt/tsconfig.server.json" | ||
} |
6 changes: 6 additions & 0 deletions
6
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/start-event-proxy.mjs
This file contains hidden or 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 { startEventProxyServer } from '@sentry-internal/test-utils'; | ||
|
||
startEventProxyServer({ | ||
port: 3031, | ||
proxyServerName: 'nuxt-3-dynamic-import', | ||
}); |
105 changes: 105 additions & 0 deletions
105
dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/tests/errors.client.test.ts
This file contains hidden or 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,105 @@ | ||
import { expect, test } from '@nuxt/test-utils/playwright'; | ||
import { waitForError } from '@sentry-internal/test-utils'; | ||
|
||
test.describe('client-side errors', async () => { | ||
test('captures error thrown on click', async ({ page }) => { | ||
const errorPromise = waitForError('nuxt-3-dynamic-import', async errorEvent => { | ||
return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Nuxt-3 E2E test app'; | ||
}); | ||
|
||
await page.goto(`/client-error`); | ||
await page.locator('#errorBtn').click(); | ||
|
||
const error = await errorPromise; | ||
|
||
expect(error.transaction).toEqual('/client-error'); | ||
expect(error).toMatchObject({ | ||
exception: { | ||
values: [ | ||
{ | ||
type: 'Error', | ||
value: 'Error thrown from Nuxt-3 E2E test app', | ||
mechanism: { | ||
handled: false, | ||
}, | ||
}, | ||
], | ||
}, | ||
}); | ||
}); | ||
|
||
test('shows parametrized route on button error', async ({ page }) => { | ||
const errorPromise = waitForError('nuxt-3-dynamic-import', async errorEvent => { | ||
return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Param Route Button'; | ||
}); | ||
|
||
await page.goto(`/test-param/1234`); | ||
await page.locator('#errorBtn').click(); | ||
|
||
const error = await errorPromise; | ||
|
||
expect(error.sdk.name).toEqual('sentry.javascript.nuxt'); | ||
expect(error.transaction).toEqual('/test-param/:param()'); | ||
expect(error.request.url).toMatch(/\/test-param\/1234/); | ||
expect(error).toMatchObject({ | ||
exception: { | ||
values: [ | ||
{ | ||
type: 'Error', | ||
value: 'Error thrown from Param Route Button', | ||
mechanism: { | ||
handled: false, | ||
}, | ||
}, | ||
], | ||
}, | ||
}); | ||
}); | ||
|
||
test('page is still interactive after client error', async ({ page }) => { | ||
const error1Promise = waitForError('nuxt-3-dynamic-import', async errorEvent => { | ||
return errorEvent?.exception?.values?.[0]?.value === 'Error thrown from Nuxt-3 E2E test app'; | ||
}); | ||
|
||
await page.goto(`/client-error`); | ||
await page.locator('#errorBtn').click(); | ||
|
||
const error1 = await error1Promise; | ||
|
||
const error2Promise = waitForError('nuxt-3-dynamic-import', async errorEvent => { | ||
return errorEvent?.exception?.values?.[0]?.value === 'Another Error thrown from Nuxt-3 E2E test app'; | ||
}); | ||
|
||
await page.locator('#errorBtn2').click(); | ||
|
||
const error2 = await error2Promise; | ||
|
||
expect(error1).toMatchObject({ | ||
exception: { | ||
values: [ | ||
{ | ||
type: 'Error', | ||
value: 'Error thrown from Nuxt-3 E2E test app', | ||
mechanism: { | ||
handled: false, | ||
}, | ||
}, | ||
], | ||
}, | ||
}); | ||
|
||
expect(error2).toMatchObject({ | ||
exception: { | ||
values: [ | ||
{ | ||
type: 'Error', | ||
value: 'Another Error thrown from Nuxt-3 E2E test app', | ||
mechanism: { | ||
handled: false, | ||
}, | ||
}, | ||
], | ||
}, | ||
}); | ||
}); | ||
}); |
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.
Uh oh!
There was an error while loading. Please reload this page.