feat(nuxt): Conditionally use plugins based on Nitro version (v2/v3)

Author: s1gr1d

packages/nuxt/src/module.ts

@@ -81,13 +81,23 @@ export default defineNuxtModule<ModuleOptions>({
     const isNitroV3 = (await getNitroMajorVersion()) >= 3;
 
     if (serverConfigFile) {
-      addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/handler-legacy.server'));
+      if (isNitroV3) {
+        addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/handler.server'));
+      } else {
+        addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/handler-legacy.server'));
+      }
+
       addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/sentry.server'));
 
       addPlugin({
         src: moduleDirResolver.resolve('./runtime/plugins/route-detector.server'),
         mode: 'server',
       });
+
+      // Preps the middleware instrumentation module.
+      addMiddlewareImports();
+      addStorageInstrumentation(nuxt, !isNitroV3);
+      addDatabaseInstrumentation(nuxt.options.nitro, !isNitroV3, moduleOptions);
     }
 
     if (clientConfigFile || serverConfigFile) {
@@ -116,13 +126,6 @@ export default defineNuxtModule<ModuleOptions>({
       };
     });
 
-    // Preps the the middleware instrumentation module.
-    if (serverConfigFile) {
-      addMiddlewareImports();
-      addStorageInstrumentation(nuxt);
-      addDatabaseInstrumentation(nuxt.options.nitro, moduleOptions);
-    }
-
     // Add the sentry config file to the include array
     nuxt.hook('prepare:types', options => {
       const tsConfig = options.tsConfig as { include?: string[] };
@@ -148,7 +151,7 @@ export default defineNuxtModule<ModuleOptions>({
         return;
       }
 
-      if (serverConfigFile) {
+      if (serverConfigFile && !isNitroV3) {
         addMiddlewareInstrumentation(nitro);
       }
 

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

@@ -13,10 +13,15 @@ export default (nitroApp => {
 
   // @ts-expect-error - 'render:html' is a valid hook name in the Nuxt context
   nitroApp.hooks.hook('render:html', (html: NuxtRenderHTMLContext, { event }: { event: H3Event }) => {
-    const headers = event.node.res?.getHeaders() || {};
+    // h3 v1 (Nuxt 4): event.node.res.getHeaders(); h3 v2 (Nuxt 5): event.node is undefined
+    const nodeResHeadersH3v1 = event.node?.res?.getHeaders() || {};
+
+    // h3 v2 (Nuxt 5): response headers are on event.res.headers
+    const isPreRenderedPage =
+      Object.keys(nodeResHeadersH3v1).includes('x-nitro-prerender') ||
+      // oxlint-disable-next-line typescript/no-explicit-any
+      !!(event as any).res?.headers?.has?.('x-nitro-prerender');
 
-    const isPreRenderedPage = Object.keys(headers).includes('x-nitro-prerender');
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
     const isSWRCachedPage = event?.context?.cache?.options.swr as boolean | undefined;
 
     if (!isPreRenderedPage && !isSWRCachedPage) {

packages/nuxt/src/vite/databaseConfig.ts

@@ -7,7 +7,11 @@ import { addServerTemplate } from '../vendor/server-template';
 /**
  * Sets up the database instrumentation.
  */
-export function addDatabaseInstrumentation(nitro: NitroConfig, moduleOptions?: SentryNuxtModuleOptions): void {
+export function addDatabaseInstrumentation(
+  nitro: NitroConfig,
+  isLegacyNitro: boolean,
+  moduleOptions?: SentryNuxtModuleOptions,
+): void {
   if (!nitro.experimental?.database) {
     // We cannot use DEBUG_BUILD here because it is a runtime flag, so it is not available for build time scripts
     // So we have to pass in the module options to the build time script
@@ -38,5 +42,9 @@ export function addDatabaseInstrumentation(nitro: NitroConfig, moduleOptions?: S
     },
   });
 
-  addServerPlugin(createResolver(import.meta.url).resolve('./runtime/plugins/database-legacy.server'));
+  if (isLegacyNitro) {
+    addServerPlugin(createResolver(import.meta.url).resolve('./runtime/plugins/database-legacy.server'));
+  } else {
+    addServerPlugin(createResolver(import.meta.url).resolve('./runtime/plugins/database.server'));
+  }
 }

packages/nuxt/src/vite/storageConfig.ts

@@ -5,7 +5,7 @@ import { addServerTemplate } from '../vendor/server-template';
 /**
  * Prepares the storage config export to be used in the runtime storage instrumentation.
  */
-export function addStorageInstrumentation(nuxt: Nuxt): void {
+export function addStorageInstrumentation(nuxt: Nuxt, isLegacyNitro: boolean): void {
   const moduleDirResolver = createResolver(import.meta.url);
   const userStorageMounts = Object.keys(nuxt.options.nitro.storage || {});
 
@@ -17,5 +17,9 @@ export function addStorageInstrumentation(nuxt: Nuxt): void {
     },
   });
 
-  addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/storage-legacy.server'));
+  if (isLegacyNitro) {
+    addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/storage-legacy.server'));
+  } else {
+    addServerPlugin(moduleDirResolver.resolve('./runtime/plugins/storage.server'));
+  }
 }