feat(nuxt)!: Bundle server config into Nitro build

Author: s1gr1d

dev-packages/e2e-tests/test-applications/nuxt-4/instrument-preload.mjs

@@ -0,0 +1,9 @@
+// Simulates a v10-style `node --import` preload that fully initializes the SDK
+// before the config bundled into the server build runs its own `Sentry.init`.
+import * as Sentry from '@sentry/nuxt';
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  tracesSampleRate: 1.0,
+  tunnel: 'http://localhost:3031/',
+});

dev-packages/e2e-tests/test-applications/nuxt-4/nuxt-start-dev-server.bash

@@ -12,10 +12,11 @@
     "clean": "npx nuxi cleanup",
     "test": "playwright test",
     "test:prod": "TEST_ENV=production playwright test",
-    "test:dev": "bash ./nuxt-start-dev-server.bash && TEST_ENV=development playwright test environment",
+    "test:dev": "TEST_ENV=development playwright test environment",
     "test:build": "pnpm install && pnpm build",
     "test:build-canary": "pnpm add nuxt@npm:nuxt-nightly@latest && pnpm add nitropack@npm:nitropack-nightly@latest && pnpm install --force && pnpm build",
-    "test:assert": "pnpm test:prod && pnpm test:dev"
+    "test:assert": "pnpm test:prod && pnpm test:dev",
+    "test:prod:import": "TEST_ENV=production-import playwright test"
   },
   "dependencies": {
     "@pinia/nuxt": "^0.5.5",
@@ -38,6 +39,11 @@
         "build-command": "E2E_TEST_OTEL_SETUP=true pnpm test:build",
         "assert-command": "E2E_TEST_OTEL_SETUP=true pnpm test:assert",
         "label": "nuxt-4 (tracer provider)"
+      },
+      {
+        "build-command": "pnpm test:build",
+        "assert-command": "pnpm test:prod:import",
+        "label": "nuxt-4 (--import compat)"
       }
     ],
     "optionalVariants": [

dev-packages/e2e-tests/test-applications/nuxt-4/package.json

@@ -8,10 +8,16 @@ if (!testEnv) {
 
 const getStartCommand = () => {
   if (testEnv === 'development') {
-    return "NODE_OPTIONS='--import ./.nuxt/dev/sentry.server.config.mjs' nuxt dev -p 3030";
+    // The Sentry server config is bundled into the dev server via a nitro plugin, so no preload is needed.
+    return 'nuxt dev -p 3030';
   }
 
   if (testEnv === 'production') {
+    return 'pnpm start';
+  }
+
+  // Runs the suite with the compat shim preloaded, like existing `--import` deploy commands do.
+  if (testEnv === 'production-import') {
     return 'pnpm start:import';
   }
 

dev-packages/e2e-tests/test-applications/nuxt-4/playwright.config.ts

@@ -1,4 +1,4 @@
-import { readFileSync, readdirSync } from 'node:fs';
+import { existsSync, readFileSync, readdirSync } from 'node:fs';
 import path from 'node:path';
 import { expect, test } from '@playwright/test';
 
@@ -43,3 +43,37 @@ test.describe('Orchestrion build-time injection', () => {
     expect(clientBundle).not.toMatch(/orchestrion:/);
   });
 });
+
+test.describe('Sentry server config injection', () => {
+  test('evaluates Sentry.init before nitro runs its plugins', () => {
+    const nitroChunk = readFileSync(path.join(process.cwd(), '.output/server/chunks/nitro/nitro.mjs'), 'utf8');
+
+    // The app DSN only appears in the transpiled `Sentry.init` options object, so it marks where
+    // init evaluates inside the chunk.
+    const initIndex = nitroChunk.indexOf('https://public@dsn.ingest.sentry.io/1337');
+    const runPluginsIndex = nitroChunk.indexOf('runNitroPlugins');
+
+    expect(initIndex).toBeGreaterThan(-1);
+    expect(runPluginsIndex).toBeGreaterThan(-1);
+    expect(initIndex).toBeLessThan(runPluginsIndex);
+  });
+
+  test('emits the `--import` compatibility shim at the former config path', () => {
+    const shimPath = path.join(process.cwd(), '.output/server/sentry.server.config.mjs');
+
+    expect(existsSync(shimPath)).toBe(true);
+    expect(readFileSync(shimPath, 'utf8')).toContain('no longer needed');
+  });
+
+  test('does not bake tracing meta tags into prerendered pages', () => {
+    // Prerendering executes the server bundle at build time; init is skipped there, so no Sentry
+    // client may leak trace meta tags into the static HTML.
+    const prerenderedPage = readFileSync(
+      path.join(process.cwd(), '.output/public/rendering-modes/pre-rendered-page/index.html'),
+      'utf8',
+    );
+
+    expect(prerenderedPage).not.toContain('sentry-trace');
+    expect(prerenderedPage).not.toContain('baggage');
+  });
+});

dev-packages/e2e-tests/test-applications/nuxt-4/tests/build-injection.test.ts

@@ -0,0 +1,75 @@
+import type { ChildProcess } from 'node:child_process';
+import { spawn } from 'node:child_process';
+import { expect, test } from '@playwright/test';
+import { getSpanOp, waitForStreamedSpan } from '@sentry-internal/test-utils';
+
+// `node --import` start commands must keep working now that the config is bundled: the emitted
+// config file is a shim that only prints a removal hint, and a preload that really initializes
+// the SDK must not cause a second init. Each test spawns its own server on a dedicated port.
+
+interface PreloadedServer {
+  child: ChildProcess;
+  output: () => string;
+}
+
+async function startServerWithPreload(preloadPath: string, port: string): Promise<PreloadedServer> {
+  const child = spawn('node', ['--import', preloadPath, '.output/server/index.mjs'], {
+    env: { ...process.env, PORT: port },
+  });
+
+  let output = '';
+  child.stdout?.on('data', chunk => (output += chunk));
+  child.stderr?.on('data', chunk => (output += chunk));
+
+  for (let attempt = 0; attempt < 100; attempt++) {
+    try {
+      await fetch(`http://localhost:${port}/`);
+      break;
+    } catch {
+      await new Promise(resolve => setTimeout(resolve, 200));
+    }
+  }
+
+  return { child, output: () => output };
+}
+
+test('serves traced requests with the shim preloaded and prints the removal hint', async () => {
+  const server = await startServerWithPreload('./.output/server/sentry.server.config.mjs', '3081');
+
+  try {
+    const spanPromise = waitForStreamedSpan(
+      'nuxt-4',
+      span => span.is_segment === true && span.attributes?.['url.path']?.value === '/test-param/8281',
+    );
+
+    const response = await fetch('http://localhost:3081/test-param/8281');
+    expect(response.status).toBe(200);
+
+    const span = await spanPromise;
+    expect(getSpanOp(span)).toBe('http.server');
+    expect(server.output()).toContain('no longer needed');
+  } finally {
+    server.child.kill();
+  }
+});
+
+test('skips the second init when a preload already initialized the SDK', async () => {
+  const server = await startServerWithPreload('./instrument-preload.mjs', '3082');
+
+  try {
+    const spanPromise = waitForStreamedSpan(
+      'nuxt-4',
+      span => span.is_segment === true && span.attributes?.['url.path']?.value === '/test-param/8282',
+    );
+
+    const response = await fetch('http://localhost:3082/test-param/8282');
+    expect(response.status).toBe(200);
+
+    // The preload-created client stays active and still delivers events.
+    const span = await spanPromise;
+    expect(getSpanOp(span)).toBe('http.server');
+    expect(server.output()).toContain('already initialized');
+  } finally {
+    server.child.kill();
+  }
+});

dev-packages/e2e-tests/test-applications/nuxt-4/tests/import-compat.test.ts

@@ -12,7 +12,7 @@
     "clean": "npx nuxi cleanup",
     "test": "playwright test",
     "test:prod": "TEST_ENV=production playwright test",
-    "test:dev": "bash ./nuxt-start-dev-server.bash && TEST_ENV=development playwright test environment",
+    "test:dev": "TEST_ENV=development playwright test environment",
     "test:build": "pnpm install && pnpm build",
     "test:build-canary": "pnpm add nuxt@npm:nuxt-nightly@latest && pnpm add nitro@npm:nitro-nightly@latest && pnpm install --force && pnpm build",
     "test:assert": "pnpm test:prod && pnpm test:dev"

dev-packages/e2e-tests/test-applications/nuxt-5/nuxt-start-dev-server.bash

@@ -8,11 +8,12 @@ if (!testEnv) {
 
 const getStartCommand = () => {
   if (testEnv === 'development') {
-    return "NODE_OPTIONS='--import ./.nuxt/dev/sentry.server.config.mjs' nuxt dev -p 3030";
+    // The Sentry server config is bundled into the dev server via a nitro plugin, so no preload is needed.
+    return 'nuxt dev -p 3030';
   }
 
   if (testEnv === 'production') {
-    return 'pnpm start:import';
+    return 'pnpm start';
   }
 
   throw new Error(`Unknown test env: ${testEnv}`);