test(nuxt): Test mysql instrumentation with orchestrion bundler plugin (#21782)

Adds a Nuxt 4 E2E test app that shows how orchestrion (build-time
`diagnostics_channel` injection) can be wired into a meta framework, so
DB instrumentation works on bundled server code without `--import`.

- Rollup plugin instead of Vite. Nuxt's server is built by Nitro
(Rollup), so the orchestrion code transform is wired in as a Nitro
Rollup plugin, mirroring the existing Vite plugin.

- Local module to inject `init` to "server entry". Nitro does not expose
an explicit server entry to place the Sentry init in. A small local Nuxt
module (mirroring `@sentry/nuxt`'s `addSentryTopImport`) injects a
top-level `import './sentry.server.config.mjs'` into Nitro's built
entry, so `node .output/server/index.mjs` initializes Sentry first

- Both instrumentation paths coexist. orchestrion handles the bundled
`mysql` (auto.db.orchestrion.mysql), while OTel keeps instrumenting
everything left external (`ioredis`, `http`, …)

Author: s1gr1d

dev-packages/e2e-tests/test-applications/nuxt-4-orchestrion/.gitignore

@@ -0,0 +1,24 @@
+# Nuxt dev/build outputs
+.output
+.data
+.nuxt
+.nitro
+.cache
+dist
+
+# Node dependencies
+node_modules
+
+# Logs
+logs
+*.log
+
+# Misc
+.DS_Store
+.fleet
+.idea
+
+# Local env files
+.env
+.env.*
+!.env.example

dev-packages/e2e-tests/test-applications/nuxt-4-orchestrion/app/app.vue

@@ -0,0 +1,6 @@
+<template>
+  <div>
+    <NuxtRouteAnnouncer />
+    <NuxtWelcome />
+  </div>
+</template>

dev-packages/e2e-tests/test-applications/nuxt-4-orchestrion/docker-compose.yml

@@ -0,0 +1,31 @@
+services:
+  db:
+    image: mysql:8.0
+    restart: always
+    container_name: e2e-tests-nuxt-4-orchestrion-mysql
+    # The `mysql` 2.x driver doesn't speak MySQL 8's default
+    # `caching_sha2_password` auth, so force the legacy plugin.
+    command: ['--default-authentication-plugin=mysql_native_password']
+    ports:
+      - '3306:3306'
+    environment:
+      MYSQL_ROOT_PASSWORD: docker
+    healthcheck:
+      test: ['CMD-SHELL', 'mysqladmin ping -h 127.0.0.1 -uroot -pdocker']
+      interval: 2s
+      timeout: 3s
+      retries: 30
+      start_period: 10s
+
+  redis:
+    image: redis:7
+    restart: always
+    container_name: e2e-tests-nuxt-4-orchestrion-redis
+    ports:
+      - '6379:6379'
+    healthcheck:
+      test: ['CMD', 'redis-cli', 'ping']
+      interval: 2s
+      timeout: 3s
+      retries: 30
+      start_period: 5s

dev-packages/e2e-tests/test-applications/nuxt-4-orchestrion/global-setup.mjs

@@ -0,0 +1,14 @@
+import { execSync } from 'child_process';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export default async function globalSetup() {
+  // Start MySQL via Docker Compose. `--wait` blocks until the healthcheck
+  // in docker-compose.yml passes, so the app can connect immediately.
+  execSync('docker compose up -d --wait', {
+    cwd: __dirname,
+    stdio: 'inherit',
+  });
+}

dev-packages/e2e-tests/test-applications/nuxt-4-orchestrion/global-teardown.mjs

@@ -0,0 +1,12 @@
+import { execSync } from 'child_process';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+export default async function globalTeardown() {
+  execSync('docker compose down --volumes', {
+    cwd: __dirname,
+    stdio: 'inherit',
+  });
+}

dev-packages/e2e-tests/test-applications/nuxt-4-orchestrion/modules/sentry-server-init.ts

@@ -0,0 +1,35 @@
+import { existsSync, readFileSync, writeFileSync } from 'node:fs';
+import { createResolver, defineNuxtModule } from '@nuxt/kit';
+
+const SERVER_CONFIG_FILENAME = 'sentry.server.config';
+
+/**
+ * Local demo module — NOT part of `@sentry/nuxt`.
+ *
+ * The orchestrion bundler approach needs the Sentry init to run inside the
+ * server build (so the diagnostics-channel subscribers are registered before
+ * the first request) WITHOUT relying on `node --import`.
+ */
+export default defineNuxtModule({
+  meta: { name: 'sentry-server-init' },
+  setup(_options, nuxt) {
+    nuxt.hooks.hook('nitro:init', nitro => {
+      nitro.hooks.hook('close', () => {
+        const entryFilePath = createResolver(nitro.options.output.serverDir).resolve('index.mjs');
+
+        if (!existsSync(entryFilePath)) {
+          return;
+        }
+
+        const topImport = `import './${SERVER_CONFIG_FILENAME}.mjs';\n`;
+        const data = readFileSync(entryFilePath, 'utf8');
+
+        if (data.startsWith(topImport)) {
+          return;
+        }
+
+        writeFileSync(entryFilePath, topImport + data, 'utf8');
+      });
+    });
+  },
+});

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

@@ -0,0 +1,50 @@
+import codeTransformerRollup from '@apm-js-collab/code-transformer-bundler-plugins/rollup';
+import { INSTRUMENTED_MODULE_NAMES, SENTRY_INSTRUMENTATIONS } from '@sentry/server-utils/orchestrion/config';
+
+// Mirrors the marker that `sentryOrchestrionPlugin()` (the Vite plugin) prepends to entry chunks.
+const orchestrionBundlerMarker = {
+  name: 'sentry-orchestrion-marker',
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  renderChunk(code: string, chunk: any): { code: string; map: null } | null {
+    if (!chunk.isEntry) {
+      return null;
+    }
+    const banner =
+      'globalThis.__SENTRY_ORCHESTRION__=(globalThis.__SENTRY_ORCHESTRION__||{});globalThis.__SENTRY_ORCHESTRION__.bundler=true;\n';
+    return { code: banner + code, map: null };
+  },
+};
+
+// https://nuxt.com/docs/api/configuration/nuxt-config
+export default defineNuxtConfig({
+  compatibilityDate: '2025-07-15',
+  devtools: { enabled: true },
+
+  modules: ['@sentry/nuxt/module', './modules/sentry-server-init'],
+
+  runtimeConfig: {
+    public: {
+      sentry: {
+        dsn: 'https://public@dsn.ingest.sentry.io/1337',
+      },
+    },
+  },
+
+  nitro: {
+    // Nuxt's server is built by Nitro (Rollup), not Vite — so the orchestrion
+    // code transform has to run as a Nitro Rollup plugin to reach `server/api/*`
+    // routes. Force-bundle ONLY the instrumented deps (`mysql`) via
+    // `externals.inline`; externalized deps are `require()`d from `node_modules`
+    // at runtime and never pass through the transform.
+    externals: {
+      inline: INSTRUMENTED_MODULE_NAMES,
+    },
+    rollupConfig: {
+      plugins: [
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        codeTransformerRollup({ instrumentations: SENTRY_INSTRUMENTATIONS }) as any,
+        orchestrionBundlerMarker,
+      ],
+    },
+  },
+});

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

@@ -0,0 +1,38 @@
+{
+  "name": "nuxt-4-orchestrion",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "build": "nuxt build",
+    "dev": "nuxt dev",
+    "generate": "nuxt generate",
+    "preview": "nuxt preview",
+    "start": "node .output/server/index.mjs",
+    "start:import": "node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs",
+    "clean": "npx nuxi cleanup",
+    "test": "playwright test",
+    "test:prod": "TEST_ENV=production playwright test",
+    "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"
+  },
+  "//": "Need to use ioredis 5.10.1 because that's the last version before they support tracing channels",
+  "dependencies": {
+    "@sentry/nuxt": "file:../../packed/sentry-nuxt-packed.tgz",
+    "@sentry/server-utils": "file:../../packed/sentry-server-utils-packed.tgz",
+    "ioredis": "5.10.1",
+    "mysql": "^2.18.1",
+    "nuxt": "^4.4.8",
+    "vue": "^3.5.38",
+    "vue-router": "^5.1.0"
+  },
+  "devDependencies": {
+    "@apm-js-collab/code-transformer-bundler-plugins": "^0.5.0",
+    "@playwright/test": "~1.56.0",
+    "@sentry-internal/test-utils": "link:../../../test-utils"
+  },
+  "volta": {
+    "extends": "../../package.json",
+    "node": "22.20.0"
+  }
+}

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

@@ -0,0 +1,11 @@
+import { getPlaywrightConfig } from '@sentry-internal/test-utils';
+
+const config = getPlaywrightConfig({
+  startCommand: 'pnpm start',
+});
+
+export default {
+  ...config,
+  globalSetup: './global-setup.mjs',
+  globalTeardown: './global-teardown.mjs',
+};