From 508b3399065afe4dc27e4d83e064cc3f98114c7d Mon Sep 17 00:00:00 2001 From: Andrei Borza Date: Fri, 6 Dec 2024 13:26:03 +0100 Subject: [PATCH 1/2] feat(nitro-utils): Add `patchEventHandler` to nitro-utils and use it in the nuxt sdk --- .../sentry.server.config.ts | 1 + .../server/api/server-error.ts | 5 +++ .../tests/errors.server.test.ts | 33 ++++++++++++++++- packages/nitro-utils/src/nitro/utils.ts | 30 +++++++++++++++ .../nuxt/src/runtime/plugins/sentry.server.ts | 37 ++----------------- 5 files changed, 71 insertions(+), 35 deletions(-) create mode 100644 packages/nitro-utils/src/nitro/utils.ts diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/sentry.server.config.ts b/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/sentry.server.config.ts index 729b2296c683..f08dea23ae03 100644 --- a/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/sentry.server.config.ts +++ b/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/sentry.server.config.ts @@ -5,4 +5,5 @@ Sentry.init({ environment: 'qa', // dynamic sampling bias to keep transactions tracesSampleRate: 1.0, // Capture 100% of the transactions tunnel: 'http://localhost:3031/', // proxy server + debug: !!process.env.DEBUG, }); diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/server/api/server-error.ts b/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/server/api/server-error.ts index ec961a010510..779286fa8262 100644 --- a/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/server/api/server-error.ts +++ b/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/server/api/server-error.ts @@ -1,5 +1,10 @@ +import { getDefaultIsolationScope } from '@sentry/core'; +import * as Sentry from '@sentry/nuxt'; import { defineEventHandler } from '#imports'; export default defineEventHandler(event => { + Sentry.setTag('my-isolated-tag', true); + Sentry.setTag('my-global-scope-isolated-tag', getDefaultIsolationScope().getScopeData().tags['my-isolated-tag']); // We set this tag to be able to assert that the previously set tag has not leaked into the global isolation scope + throw new Error('Nuxt 3 Server error'); }); diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/tests/errors.server.test.ts b/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/tests/errors.server.test.ts index 3066a736cf96..053ec5b6ab67 100644 --- a/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/tests/errors.server.test.ts +++ b/dev-packages/e2e-tests/test-applications/nuxt-3-top-level-import/tests/errors.server.test.ts @@ -1,8 +1,12 @@ import { expect, test } from '@playwright/test'; -import { waitForError } from '@sentry-internal/test-utils'; +import { waitForError, waitForTransaction } from '@sentry-internal/test-utils'; test.describe('server-side errors', async () => { test('captures api fetch error (fetched on click)', async ({ page }) => { + const transactionEventPromise = waitForTransaction('nuxt-3-top-level-import', async transactionEvent => { + return transactionEvent?.transaction === 'GET /api/server-error'; + }); + const errorPromise = waitForError('nuxt-3-top-level-import', async errorEvent => { return errorEvent?.exception?.values?.[0]?.value === 'Nuxt 3 Server error'; }); @@ -10,6 +14,7 @@ test.describe('server-side errors', async () => { await page.goto(`/fetch-server-error`); await page.getByText('Fetch Server Data', { exact: true }).click(); + const transactionEvent = await transactionEventPromise; const error = await errorPromise; expect(error.transaction).toEqual('GET /api/server-error'); @@ -18,6 +23,32 @@ test.describe('server-side errors', async () => { expect(exception.type).toEqual('Error'); expect(exception.value).toEqual('Nuxt 3 Server error'); expect(exception.mechanism.handled).toBe(false); + + expect(error.tags?.['my-isolated-tag']).toBe(true); + expect(error.tags?.['my-global-scope-isolated-tag']).not.toBeDefined(); + expect(transactionEvent.tags?.['my-isolated-tag']).toBe(true); + expect(transactionEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined(); + }); + + test('isolates requests', async ({ page }) => { + const transactionEventPromise = waitForTransaction('nuxt-3-top-level-import', async transactionEvent => { + return transactionEvent?.transaction === 'GET /api/server-error'; + }); + + const errorPromise = waitForError('nuxt-3-top-level-import', async errorEvent => { + return errorEvent?.exception?.values?.[0]?.value === 'Nuxt 3 Server error'; + }); + + await page.goto(`/fetch-server-error`); + await page.getByText('Fetch Server Data', { exact: true }).click(); + + const transactionEvent = await transactionEventPromise; + const error = await errorPromise; + + expect(error.tags?.['my-isolated-tag']).toBe(true); + expect(error.tags?.['my-global-scope-isolated-tag']).not.toBeDefined(); + expect(transactionEvent.tags?.['my-isolated-tag']).toBe(true); + expect(transactionEvent.tags?.['my-global-scope-isolated-tag']).not.toBeDefined(); }); test('captures api fetch error (fetched on click) with parametrized route', async ({ page }) => { diff --git a/packages/nitro-utils/src/nitro/utils.ts b/packages/nitro-utils/src/nitro/utils.ts new file mode 100644 index 000000000000..8e8f08cf1a3b --- /dev/null +++ b/packages/nitro-utils/src/nitro/utils.ts @@ -0,0 +1,30 @@ +import { GLOBAL_OBJ, flush, getClient, logger, vercelWaitUntil } from '@sentry/core'; + +/** + * Flushes Sentry for serverless environments. + */ +export async function flushIfServerless(): Promise { + const isServerless = !!process.env.LAMBDA_TASK_ROOT || !!process.env.VERCEL || !!process.env.NETLIFY; + + // @ts-expect-error - this is not typed + if (GLOBAL_OBJ[Symbol.for('@vercel/request-context')]) { + vercelWaitUntil(flushWithTimeout()); + } else if (isServerless) { + await flushWithTimeout(); + } +} + +/** + * Flushes Sentry. + */ +export async function flushWithTimeout(): Promise { + const isDebug = getClient()?.getOptions()?.debug; + + try { + isDebug && logger.log('Flushing events...'); + await flush(2000); + isDebug && logger.log('Done flushing events'); + } catch (e) { + isDebug && logger.log('Error while flushing events:\n', e); + } +} diff --git a/packages/nuxt/src/runtime/plugins/sentry.server.ts b/packages/nuxt/src/runtime/plugins/sentry.server.ts index 15dd2ea27e61..f85e69883bb8 100644 --- a/packages/nuxt/src/runtime/plugins/sentry.server.ts +++ b/packages/nuxt/src/runtime/plugins/sentry.server.ts @@ -1,13 +1,5 @@ -import { - GLOBAL_OBJ, - flush, - getClient, - getDefaultIsolationScope, - getIsolationScope, - logger, - vercelWaitUntil, - withIsolationScope, -} from '@sentry/core'; +import { patchEventHandler } from '@sentry-internal/nitro-utils'; +import { GLOBAL_OBJ, flush, getClient, logger, vercelWaitUntil } from '@sentry/core'; import * as Sentry from '@sentry/node'; import { H3Error } from 'h3'; import { defineNitroPlugin } from 'nitropack/runtime'; @@ -15,30 +7,7 @@ import type { NuxtRenderHTMLContext } from 'nuxt/app'; import { addSentryTracingMetaTags, extractErrorContext } from '../utils'; export default defineNitroPlugin(nitroApp => { - nitroApp.h3App.handler = new Proxy(nitroApp.h3App.handler, { - async apply(handlerTarget, handlerThisArg, handlerArgs: Parameters) { - // In environments where we cannot make use of OTel httpInstrumentation, we still need to ensure requests are properly isolated (e.g. when just importing the Sentry server config at the top level instead of `--import`). - // If OTel httpInstrumentation works, requests will be already isolated by the SentryHttpInstrumentation. - // We can identify this by comparing the current isolation scope to the default one. The requests are properly isolated if - // the current isolation scope is different from the default one. If that is not the case, we fork the isolation scope here. - const isolationScope = getIsolationScope(); - const newIsolationScope = isolationScope === getDefaultIsolationScope() ? isolationScope.clone() : isolationScope; - - logger.log( - `[Sentry] Patched h3 event handler. ${ - isolationScope === newIsolationScope ? 'Using existing' : 'Created new' - } isolation scope.`, - ); - - return withIsolationScope(newIsolationScope, async () => { - try { - return await handlerTarget.apply(handlerThisArg, handlerArgs); - } finally { - await flushIfServerless(); - } - }); - }, - }); + nitroApp.h3App.handler = patchEventHandler(nitroApp.h3App.handler); nitroApp.hooks.hook('error', async (error, errorContext) => { // Do not handle 404 and 422 From 10b0bb4a831dbc1f253051e0d5dba5f5339c7709 Mon Sep 17 00:00:00 2001 From: Andrei Borza Date: Fri, 6 Dec 2024 14:38:03 +0100 Subject: [PATCH 2/2] Add nitro-utils package --- packages/nuxt/package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/nuxt/package.json b/packages/nuxt/package.json index 1fc8a05b6b3f..949680d467df 100644 --- a/packages/nuxt/package.json +++ b/packages/nuxt/package.json @@ -53,6 +53,7 @@ }, "devDependencies": { "@nuxt/module-builder": "^0.8.4", + "@sentry-internal/nitro-utils": "8.42.0", "nuxt": "^3.13.2" }, "scripts": {