ref(nuxt): Extract handler patching to extra plugin for Nitro v2/v3

packages/nuxt/package.json

@@ -45,7 +45,13 @@
     "access": "public"
   },
   "peerDependencies": {
-    "nuxt": ">=3.7.0 || 4.x"
+    "nuxt": ">=3.7.0 || 4.x",
+    "nitro": "3.x"
+  },
+  "peerDependenciesMeta": {
+    "nitro": {
+      "optional": true
+    }
   },
   "dependencies": {
     "@nuxt/kit": "^3.13.2",
@@ -61,6 +67,7 @@
   "devDependencies": {
     "@nuxt/module-builder": "^0.8.4",
     "@nuxt/nitro-server": "^3.21.1",
+    "nitro": "^3.0.260311-beta",
     "nuxi": "^3.25.1",
     "nuxt": "3.17.7",
     "vite": "^5.4.11"

packages/nuxt/src/module.ts

@@ -80,6 +80,7 @@ export default defineNuxtModule<ModuleOptions>({
     const serverConfigFile = findDefaultSdkInitFile('server', nuxt);
 
     if (serverConfigFile) {
+      addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/handler-legacy.server'));
       addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/sentry.server'));
 
       addPlugin({

packages/nuxt/src/runtime/plugins/handler-legacy.server.ts

@@ -0,0 +1,7 @@
+import type { EventHandler } from 'h3';
+import type { NitroAppPlugin } from 'nitropack';
+import { patchEventHandler } from '../utils/patchEventHandler';
+
+export default (nitroApp => {
+  nitroApp.h3App.handler = patchEventHandler<EventHandler>(nitroApp.h3App.handler);
+}) satisfies NitroAppPlugin;

packages/nuxt/src/runtime/plugins/handler.server.ts

@@ -0,0 +1,13 @@
+import type { EventHandler } from 'nitro/h3';
+import type { NitroAppPlugin, NitroApp } from 'nitro/types';
+import { patchEventHandler } from '../utils/patchEventHandler';
+
+/**
+ * This plugin patches the h3 event handler for Nuxt v5+ (Nitro v3+).
+ */
+export default ((nitroApp: NitroApp) => {
+  if (nitroApp?.h3?.handler) {
+    // oxlint-disable-next-line @typescript-eslint/unbound-method
+    nitroApp.h3.handler = patchEventHandler<EventHandler>(nitroApp.h3.handler);
+  }
+}) satisfies NitroAppPlugin;

packages/nuxt/src/runtime/plugins/sentry.server.ts

@@ -1,20 +1,12 @@
-import {
-  debug,
-  flushIfServerless,
-  getDefaultIsolationScope,
-  getIsolationScope,
-  withIsolationScope,
-} from '@sentry/core';
-import type { EventHandler, H3Event } from 'h3';
+import { debug } from '@sentry/core';
+import type { H3Event } from 'h3';
 import type { NitroAppPlugin } from 'nitropack';
 import type { NuxtRenderHTMLContext } from 'nuxt/app';
 import { sentryCaptureErrorHook } from '../hooks/captureErrorHook';
 import { updateRouteBeforeResponse } from '../hooks/updateRouteBeforeResponse';
 import { addSentryTracingMetaTags } from '../utils';
 
 export default (nitroApp => {
-  nitroApp.h3App.handler = patchEventHandler(nitroApp.h3App.handler);
-
   nitroApp.hooks.hook('beforeResponse', updateRouteBeforeResponse);
 
   nitroApp.hooks.hook('error', sentryCaptureErrorHook);
@@ -37,26 +29,3 @@ export default (nitroApp => {
     }
   });
 }) satisfies NitroAppPlugin;
-
-function patchEventHandler(handler: EventHandler): EventHandler {
-  return new Proxy(handler, {
-    async apply(handlerTarget, handlerThisArg, handlerArgs: Parameters<EventHandler>) {
-      const isolationScope = getIsolationScope();
-      const newIsolationScope = isolationScope === getDefaultIsolationScope() ? isolationScope.clone() : isolationScope;
-
-      debug.log(
-        `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();
-        }
-      });
-    },
-  });
-}

packages/nuxt/src/runtime/utils.ts

@@ -1,6 +1,5 @@
 import type { ClientOptions, Context, SerializedTraceData } from '@sentry/core';
 import { captureException, debug, getClient, getTraceMetaTags } from '@sentry/core';
-import type { VueOptions } from '@sentry/vue/src/types';
 import type { CapturedErrorContext } from 'nitropack/types';
 import type { NuxtRenderHTMLContext } from 'nuxt/app';
 import type { ComponentPublicInstance } from 'vue';
@@ -69,7 +68,8 @@ export function reportNuxtError(options: {
 
   if (instance?.$props) {
     const sentryClient = getClient();
-    const sentryOptions = sentryClient ? (sentryClient.getOptions() as ClientOptions & VueOptions) : null;
+    // `attachProps` is defined in the Vue integration options, but the type is not exported from @sentry/vue, as it's only used internally.
+    const sentryOptions = sentryClient ? (sentryClient.getOptions() as ClientOptions & { attachProps: boolean }) : null;
 
     // `attachProps` is enabled by default and props should only not be attached if explicitly disabled (see DEFAULT_CONFIG in `vueIntegration`).
     // oxlint-disable-next-line typescript/no-unsafe-member-access

packages/nuxt/src/runtime/utils/patchEventHandler.ts

@@ -0,0 +1,35 @@
+import {
+  debug,
+  flushIfServerless,
+  getDefaultIsolationScope,
+  getIsolationScope,
+  withIsolationScope,
+} from '@sentry/core';
+
+/**
+ * Patches the H3 event handler of Nitro.
+ *
+ * Uses a TypeScript generic type to ensure the returned handler type fits different versions of Nitro.
+ */
+export function patchEventHandler<H3EventHandler extends Function>(handler: H3EventHandler): H3EventHandler {
+  return new Proxy(handler, {
+    async apply(handlerTarget, handlerThisArg, handlerArgs: unknown) {
+      const isolationScope = getIsolationScope();
+      const newIsolationScope = isolationScope === getDefaultIsolationScope() ? isolationScope.clone() : isolationScope;
+
+      debug.log(
+        `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();
+        }
+      });
+    },
+  });
+}

packages/nuxt/tsconfig.json

@@ -5,6 +5,7 @@
 
   "compilerOptions": {
     // package-specific options
-    "module": "esnext"
+    "module": "esnext",
+    "moduleResolution": "bundler"
   }
 }