fix(nuxt): Fix CommonJS interop for force-inlined instrumented packages (#24799)

Since v11, build-time instrumentation force-inlines the instrumented
drivers (mongoose, ioredis, mysql, ...) into the Nitro bundle while
their CommonJS dependencies stay external. Since Node 23, CJS namespaces
carry a `module.exports` key next to `default` (nodejs/node#53848), so
Rollup's `'auto'` interop no longer unwraps those requires and the
drivers crash at startup (`mquery is not a constructor`).

No single interop mode (a `requireReturnsDefault` value) fixes this and
works for all externals. `debug` needs the namespace, while `mquery` and
`lodash.defaults` need `module.exports`. So we unwrap builtins plus a
known list and keep `'auto'` for the rest.

Fixes #24775
Fixes #24786

Author: s1gr1d

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

@@ -17,6 +17,22 @@ services:
       retries: 30
       start_period: 10s
 
+  mongo:
+    image: mongo:8
+    restart: always
+    container_name: e2e-tests-nuxt-4-mongo
+    ports:
+      - '27017:27017'
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: root
+      MONGO_INITDB_ROOT_PASSWORD: docker
+    healthcheck:
+      test: ['CMD-SHELL', 'mongosh --quiet --eval "db.adminCommand(''ping'').ok"']
+      interval: 2s
+      timeout: 3s
+      retries: 30
+      start_period: 10s
+
   redis:
     image: redis:7
     restart: always

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

@@ -5,7 +5,7 @@ import { fileURLToPath } from 'url';
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
 export default async function globalSetup() {
-  // Start MySQL + Redis via Docker Compose. `--wait` blocks until the
+  // Start MySQL, MongoDB, and Redis via Docker Compose. `--wait` blocks until the
   // healthchecks in docker-compose.yml pass, so the app can connect immediately.
   execSync('docker compose up -d --wait', {
     cwd: __dirname,

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

@@ -23,6 +23,7 @@
     "@pinia/nuxt": "^0.5.5",
     "@sentry/nuxt": "file:../../packed/sentry-nuxt-packed.tgz",
     "ioredis": "5.10.1",
+    "mongoose": "^9.10.2",
     "mysql": "^2.18.1",
     "nuxt": "^4.1.2"
   },
@@ -31,8 +32,7 @@
     "@sentry-internal/test-utils": "link:../../../test-utils"
   },
   "volta": {
-    "extends": "../../package.json",
-    "node": "22.20.0"
+    "extends": "../../package.json"
   },
   "sentryTest": {
     "variants": [

dev-packages/e2e-tests/test-applications/nuxt-4/server/api/db-mongoose.ts

@@ -0,0 +1,19 @@
+import { defineEventHandler } from '#imports';
+import mongoose from 'mongoose';
+
+const BlogPost = mongoose.model('BlogPost', new mongoose.Schema({ title: String }));
+
+// SCRAM-SHA-1 on purpose: this handshake lazily `require()`s the `crypto` builtin inside a try
+// block, which only works when the bundled driver gets a real interop for builtin requires (#24775).
+const MONGO_URL = 'mongodb://root:docker@127.0.0.1:27017/test?authSource=admin&authMechanism=SCRAM-SHA-1';
+
+export default defineEventHandler(async () => {
+  if (mongoose.connection.readyState !== mongoose.ConnectionStates.connected) {
+    await mongoose.connect(MONGO_URL);
+  }
+
+  await new BlogPost({ title: 'test-post' }).save();
+  const found = await BlogPost.findOne({ title: 'test-post' });
+
+  return { title: found?.title };
+});

dev-packages/e2e-tests/test-applications/nuxt-4/tests/db-drivers.test.ts

@@ -67,6 +67,46 @@ test('Instruments ioredis automatically', async ({ baseURL }) => {
   );
 });
 
+// The Nitro bundle force-inlines the instrumented drivers while their CommonJS dependencies and
+// Node builtins stay external, and every `require()` across that boundary needs working interop.
+test('Instruments mongoose automatically', async ({ baseURL }) => {
+  const spansPromise = collectRequestSpans('/api/db-mongoose');
+
+  const response = await fetch(`${baseURL}/api/db-mongoose`);
+  expect(response.status).toBe(200);
+  await expect(response.json()).resolves.toEqual({ title: 'test-post' });
+
+  const spans = await spansPromise;
+
+  const rootSpan = spans.find(span => span.is_segment);
+  expect(rootSpan).toBeDefined();
+  expect(getSpanOp(rootSpan!)).toBe('http.server');
+
+  const mongooseSpans = spans.filter(
+    span => span.attributes['sentry.origin']?.value === 'auto.db.mongoose.diagnostic_channel',
+  );
+  expect(mongooseSpans).toHaveLength(2);
+
+  const saveSpan = mongooseSpans.find(span => span.name === 'save blogposts');
+  expect(saveSpan?.status).toBe('ok');
+  expect(saveSpan?.is_segment).toBe(false);
+  expect(saveSpan?.attributes['sentry.op']).toEqual({ type: 'string', value: 'db' });
+  expect(saveSpan?.attributes['db.system.name']).toEqual({ type: 'string', value: 'mongodb' });
+  expect(saveSpan?.attributes['db.namespace']).toEqual({ type: 'string', value: 'test' });
+  expect(saveSpan?.attributes['db.collection.name']).toEqual({ type: 'string', value: 'blogposts' });
+  expect(saveSpan?.attributes['db.operation.name']).toEqual({ type: 'string', value: 'save' });
+
+  const findOneSpan = mongooseSpans.find(span => span.name === 'findOne blogposts');
+  expect(findOneSpan?.status).toBe('ok');
+  expect(findOneSpan?.is_segment).toBe(false);
+  expect(findOneSpan?.attributes['sentry.op']).toEqual({ type: 'string', value: 'db' });
+  expect(findOneSpan?.attributes['db.system.name']).toEqual({ type: 'string', value: 'mongodb' });
+  expect(findOneSpan?.attributes['db.namespace']).toEqual({ type: 'string', value: 'test' });
+  expect(findOneSpan?.attributes['db.collection.name']).toEqual({ type: 'string', value: 'blogposts' });
+  expect(findOneSpan?.attributes['db.operation.name']).toEqual({ type: 'string', value: 'findOne' });
+  expect(findOneSpan?.attributes['db.query.text']).toEqual({ type: 'string', value: '{"title":"?"}' });
+});
+
 test('Instruments mysql automatically', async ({ baseURL }) => {
   const spansPromise = collectRequestSpans('/api/db-mysql');
 

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

@@ -0,0 +1,16 @@
+services:
+  mongo:
+    image: mongo:8
+    restart: always
+    container_name: e2e-tests-nuxt-5-mongo
+    ports:
+      - '27017:27017'
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: root
+      MONGO_INITDB_ROOT_PASSWORD: docker
+    healthcheck:
+      test: ['CMD-SHELL', 'mongosh --quiet --eval "db.adminCommand(''ping'').ok"']
+      interval: 2s
+      timeout: 3s
+      retries: 30
+      start_period: 10s

dev-packages/e2e-tests/test-applications/nuxt-5/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 MongoDB 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-5/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-5/package.json

@@ -27,6 +27,7 @@
   "dependencies": {
     "@pinia/nuxt": "^0.11.3",
     "@sentry/nuxt": "file:../../packed/sentry-nuxt-packed.tgz",
+    "mongoose": "^9.10.2",
     "ofetch": "^2.0.0-alpha.3",
     "nitro": "latest",
     "nuxt": "npm:nuxt-nightly@5x",
@@ -41,7 +42,6 @@
   },
   "volta": {
     "extends": "../../package.json",
-    "node": "22.20.0",
     "pnpm": "11.10.0"
   }
 }

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

@@ -23,4 +23,8 @@ const config = getPlaywrightConfig({
   startCommand: getStartCommand(),
 });
 
-export default config;
+export default {
+  ...config,
+  globalSetup: './global-setup.mjs',
+  globalTeardown: './global-teardown.mjs',
+};