Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat(nuxt): Set transaction name for server error #13292

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.

Sign up for GitHub

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 4 commits into from
Aug 12, 2024
Merged

feat(nuxt): Set transaction name for server error #13292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bd6ceac
feat(nuxt): Set transaction name for server error
s1gr1d Aug 9, 2024
cb53af3
review changes
s1gr1d Aug 12, 2024
5e24021
Merge branch 'develop' into sig/nuxt-nitro-error-data
s1gr1d Aug 12, 2024
a6b26b0
Merge branch 'develop' into sig/nuxt-nitro-error-data
s1gr1d Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-3/app.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
<header>
<nav>
<ul>
<li><NuxtLink to="/fetch-server-error">Fetch Server Error</NuxtLink></li>
<li><NuxtLink to="/param-error/1234">Fetch Param Server Error</NuxtLink></li>
<li><NuxtLink to="/client-error">Client Error</NuxtLink></li>
</ul>
</nav>
Expand All @@ -11,3 +13,5 @@
</NuxtLayout>
</template>

<script setup>
</script>
11 changes: 11 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-3/pages/fetch-server-error.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<template>
<div>
<button @click="fetchData">Fetch Server Data</button>
</div>
</template>

<script setup lang="ts">
const fetchData = async () => {
await useFetch('/api/server-error');
}
</script>
11 changes: 11 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-3/pages/test-param/[param].vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
<template>
<p>{{ $route.params.param }} - {{ $route.params.param }}</p>

<ErrorButton errorText="Error thrown from Param Route Button" />
<button @click="fetchData">Fetch Server Data</button>
</template>

<script setup lang="ts">
const route = useRoute();
const param = route.params.param;

const fetchData = async () => {
await useFetch(`/api/param-error/${param}`);
}
</script>
3 changes: 3 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-3/server/api/param-error/[param].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default defineEventHandler(_e => {
throw new Error('Nuxt 3 Param Server error');
});
3 changes: 3 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-3/server/api/server-error.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default defineEventHandler(event => {
throw new Error('Nuxt 3 Server error');
});
5 changes: 5 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-3/server/api/test-param/[param].ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export default defineEventHandler(event => {
const param = getRouterParam(event, 'param');

return `Param: ${param}!`;
});
3 changes: 3 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-3/server/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "../.nuxt/tsconfig.server.json"
}
40 changes: 40 additions & 0 deletions dev-packages/e2e-tests/test-applications/nuxt-3/tests/errors.server.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import { expect, test } from '@playwright/test';
import { waitForError } from '@sentry-internal/test-utils';

test.describe('server-side errors', async () => {
test('captures api fetch error (fetched on click)', async ({ page }) => {
const errorPromise = waitForError('nuxt-3', async errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Nuxt 3 Server error';
});

await page.goto(`/fetch-server-error`);
await page.getByText('Fetch Server Data').click();

const error = await errorPromise;

expect(error.transaction).toEqual('GET /api/server-error');

const exception = error.exception.values[0];
expect(exception.type).toEqual('Error');
expect(exception.value).toEqual('Nuxt 3 Server error');
expect(exception.mechanism.handled).toBe(false);
});

test('captures api fetch error (fetched on click) with parametrized route', async ({ page }) => {
const errorPromise = waitForError('nuxt-3', async errorEvent => {
return errorEvent?.exception?.values?.[0]?.value === 'Nuxt 3 Param Server error';
});

await page.goto(`/test-param/1234`);
await page.getByText('Fetch Server Data').click();

const error = await errorPromise;

expect(error.transaction).toEqual('GET /api/param-error/1234');

const exception = error.exception.values[0];
expect(exception.type).toEqual('Error');
expect(exception.value).toEqual('Nuxt 3 Param Server error');
expect(exception.mechanism.handled).toBe(false);
});
});
13 changes: 11 additions & 2 deletions packages/nuxt/src/runtime/plugins/sentry.server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { captureException } from '@sentry/node';
import * as Sentry from '@sentry/node';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

super-l/hint: It's totally fine to make a namespace (import * as) or named imports. No need to change it back, just fyi :)

import { H3Error } from 'h3';
import { defineNitroPlugin } from 'nitropack/runtime';
import type { NuxtRenderHTMLContext } from 'nuxt/app';
Expand All @@ -14,9 +14,18 @@ export default defineNitroPlugin(nitroApp => {
}
}

const { method, path } = {
method: errorContext.event && errorContext.event._method ? errorContext.event._method : '',
path: errorContext.event && errorContext.event._path ? errorContext.event._path : null,
};

if (path) {
Sentry.getCurrentScope().setTransactionName(`${method} ${path}`);
}

const structuredContext = extractErrorContext(errorContext);

captureException(error, {
Sentry.captureException(error, {
captureContext: { contexts: { nuxt: structuredContext } },
mechanism: { handled: false },
});
Expand Down