[Nuxt] Node server config import results in ReferenceError: require is not defined in ES module scope, you can use import instead #15423

botafi · 2025-02-14T19:28:46Z

Is there an existing issue for this?

I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
I have reviewed the documentation https://docs.sentry.io/
I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/nuxt

SDK Version

9.1.0

Framework Version

Nuxt 3.15.0

Link to Sentry event

No response

Reproduction Example/SDK Setup

Those files were created using the commands in steps:
sentry.client.config.ts

import * as Sentry from "@sentry/nuxt";

Sentry.init({
  // If set up, you can use your runtime config here
  // dsn: useRuntimeConfig().public.sentry.dsn,
  dsn: "https://REDACTED",

  // We recommend adjusting this value in production, or using tracesSampler
  // for finer control
  tracesSampleRate: 1.0,

  // This sets the sample rate to be 10%. You may want this to be 100% while
  // in development and sample at a lower rate in production
  replaysSessionSampleRate: 0.1,
  
  // If the entire session is not sampled, use the below sample rate to sample
  // sessions when an error occurs.
  replaysOnErrorSampleRate: 1.0,
  
  // If you don't want to use Session Replay, just remove the line below:
  integrations: [Sentry.replayIntegration()],
  
  // Setting this option to true will print useful information to the console while you're setting up Sentry.
  debug: false,
});

sentry.server.config.ts

import * as Sentry from "@sentry/nuxt";
 
Sentry.init({
  dsn: "https://REDACTED",

  // We recommend adjusting this value in production, or using tracesSampler
  // for finer control
  tracesSampleRate: 1.0,
  
  // Setting this option to true will print useful information to the console while you're setting up Sentry.
  debug: false,
});

nuxt.config.ts

// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
  compatibilityDate: '2024-11-01',
  devtools: { enabled: true },
  modules: ['@sentry/nuxt/module'],

  sentry: {
    sourceMapsUploadOptions: {
      org: 'REDACTED',
      project: 'nuxt-test'
    }
  },

  sourcemap: {
    client: 'hidden'
  }
})

package.json

{
  "name": "nuxt-app",
  "private": true,
  "type": "module",
  "scripts": {
    "build": "nuxt build",
    "dev": "nuxt dev",
    "generate": "nuxt generate",
    "preview": "nuxt preview",
    "postinstall": "nuxt prepare"
  },
  "dependencies": {
    "@sentry/nuxt": "^9.1.0",
    "import-in-the-middle": "^1.13.0",
    "nuxt": "^3.15.4",
    "vue": "latest",
    "vue-router": "latest"
  },
  "packageManager": "[email protected]+sha512.1f79bc245a66eb0b07c5d4d83131240774642caaa86ef7d0434ab47c0d16f66b04e21e0c086eb61e62c77efc4d7f7ec071afad3796af64892fae66509173893a"
}

Steps to Reproduce

Use Node 22 with pnpm
Create a new Nuxt project using pnpm dlx nuxi@latest init test
cd test
pnpm i
Setup Sentry using npx @sentry/wizard@latest -i nuxt --saas --org REDACTED --project nuxt-test
pnpm i
pnpm run build
node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs

We reproduced this on two different machines (MacOS)

Expected Result

The built Nuxt application will run with imported Sentry server config

Actual Result

node --import ./.output/server/sentry.server.config.mjs .output/server/index.mjs

file:///REDACTED/test/.output/server/sentry.server.config.mjs:9122
  if (require.resolve && require.resolve.paths) {
  ^

ReferenceError: require is not defined in ES module scope, you can use import instead
    at requireRequireInTheMiddle (file:///REDACTED/test/.output/server/sentry.server.config.mjs:9122:3)
    at file:///REDACTED/test/output/server/sentry.server.config.mjs:9333:33
    at ModuleJob.run (node:internal/modules/esm/module_job:271:25)
    at async onImport.tracePromise.__proto__ (node:internal/modules/esm/loader:578:26)
    at async asyncRunEntryPointWithESMLoader (node:internal/modules/run_main:111:9)

Node.js v22.14.0

The text was updated successfully, but these errors were encountered:

CoconutTheSlayer · 2025-02-14T19:30:54Z

I have the same issue 👍

davionbot · 2025-02-15T01:59:36Z

I have an issue using pnpm as well. I think when using npm, it will work.

botafi · 2025-02-15T13:10:20Z

I semi-resolved issues with Sentry in Nuxt using nightly Nuxt 3x and hardcoding require-in-the-middle version < 7.5
"require-in-the-middle": "7.4.0",
"nuxt": "npm:[email protected]",

But these issues should not exist with a very basic Nuxt + Sentry init setup
Related issues found:

Upgrading from v7.4 to v7.5 breaks ESM application nodejs/require-in-the-middle#110
Cannot find module './moment-timezone' after upgrading to v3.15.3 nuxt/nuxt#30749 (comment)

The issue is not with the pnpm as far as I know as sentry dep is not just bundled correctly

wkl007 · 2025-02-17T04:31:33Z

I have the same issue

timfish · 2025-02-17T09:27:47Z

It looks like this is caused by Vite bundling require-in-the-middle and incorrectly bundling it's side-effects as ESM when they are in fact CJS:

Transitive dependencies of linked dependencies are bundled in SSR build vitejs/vite#19403

Can anyone confirm that this is only an issue with pnpm + vite and doesn't occur with npm?

timfish · 2025-02-17T10:32:40Z

Does enabling the pnpm node-linker=hoisted mode fix this issue?

.npmrc

node-linker=hoisted

botafi · 2025-02-17T10:48:35Z

@timfish I won't be able to confirm with npm right now. Hopefully someone else will be able to confirm.
Just FYI the other issue with Nuxt (resolved with the nightly package) was
Cannot find module 'REDACTED/test/node_modules/.pnpm/@[email protected]_@[email protected]/node_modules/@opentelemetry/resources/build/esm/detectors/platform/node/machine-id/execAsync' imported from REDACTED/test/node_modules/.pnpm/@[email protected]_@[email protected]/node_modules/@opentelemetry/resources/build/esm/detectors/platform/node/machine-id/getMachineId-darwin.js
This was after I got rid of the require-in-the-middle 7.5 issue

s1gr1d · 2025-02-17T13:21:00Z

I just debugged this with @Lms24 and the only workaround right now is disabling Sentry in dev mode or using another package manager.

The file import referenced in the "Cannot find module" error is correct - both files exist in node_modules. The problem is that ESM needs the file extension when importing the file and the OpenTelemetry JS packages do not add the file extensions. There is an open issue about this in the OTel repository: open-telemetry/opentelemetry-js#4898

If you would add the .js extension in the file getMachineId-darwin.js of your node_modules, the issue would be resolved.

Lms24 · 2025-02-17T13:34:55Z

the only workaround right now is disabling Sentry in dev mode

OR switching to a sane package manager, like npm or yarn :)

timfish · 2025-02-17T13:45:10Z

If this only occurs in dev mode, you might be seeing this issue or some variation of it:

Pre-bundled dependencies doesn't dedupe imports in external files vitejs/vite#3910

botafi · 2025-02-17T13:55:09Z

@s1gr1d Disabling the Sentry in dev mode does not work as when you import anything from Sentry like captureException it will try to bundle the Sentry during build and will cause broken dev mode

@Lms24 Is it a pnpm issue when updating Nuxt to nightly fixes it? :-)

All our issues with Sentry + Nuxt were resolved using #15423 (comment)

I just wanted to mention it so more people don't burn multiple hours trying to integrate Sentry with Nuxt

timfish · 2025-02-17T14:16:18Z

Is it a pnpm issue when updating Nuxt to nightly fixes it? :-)

I've been looking into the issue with require-in-the-middle since I made the innocuous change that was released in 7.5.0 and caused this breakage.

This issue is only reproducable when pnpm and Vite are used together. I don't know enough about how pnpm works to know whether this is specifically caused by pnpm or Vite, but this is not an issue with either npm or yarn.

All our issues with Sentry + Nuxt were resolved using #15423 (comment)

Forcing require-in-the-middle to v7.4.0 just reverts the recent changes which pnpm + Vite can't handle.

You can see the full discussion here:

Upgrading from v7.4 to v7.5 breaks ESM application nodejs/require-in-the-middle#110

botafi · 2025-02-17T14:38:48Z

Is it a pnpm issue when updating Nuxt to nightly fixes it? :-)

I've been looking into the issue with require-in-the-middle since I made the innocuous change that was released in 7.5.0 and caused this breakage.

This issue is only reproducable when pnpm and Vite are used together. I don't know enough about how pnpm works to know whether this is specifically caused by pnpm or Vite, but this is not an issue with either npm or yarn.

All our issues with Sentry + Nuxt were resolved using #15423 (comment)

Forcing require-in-the-middle to v7.4.0 just reverts the recent changes which pnpm + Vite can't handle.

You can see the full discussion here:

Upgrading from v7.4 to v7.5 breaks ESM application nodejs/require-in-the-middle#110

that makes sense, thanks!

timfish · 2025-02-21T18:39:41Z

[email protected] has just been published. This removes the side-effects that Vite was incorrectly bundling which should help work around this issue.

getsantry bot added the Waiting for: Product Owner label Feb 14, 2025

getsantry bot added this to GitHub Issues with 👀 3 Feb 14, 2025

getsantry bot moved this to Waiting for: Product Owner in GitHub Issues with 👀 3 Feb 14, 2025

github-actions bot added the Package: nuxt Issues related to the Sentry Nuxt SDK label Feb 14, 2025

botafi changed the title ~~[Nuxt] Server config ReferenceError: require is not defined in ES module scope, you can use import instead~~ [Nuxt] Node server config import results in ReferenceError: require is not defined in ES module scope, you can use import instead Feb 14, 2025

s1gr1d mentioned this issue Feb 17, 2025

[Nuxt] require() of ES Module node:fs not supported. #15410

Closed

3 tasks

s1gr1d self-assigned this Feb 17, 2025

getsantry bot removed the Waiting for: Product Owner label Feb 17, 2025

getsantry bot removed the status in GitHub Issues with 👀 3 Feb 17, 2025

s1gr1d mentioned this issue Feb 17, 2025

feat(nuxt): Add peerDependency for require-in-the-middle #15429

Closed

getsantry bot added the Waiting for: Product Owner label Feb 17, 2025

getsantry bot moved this to Waiting for: Product Owner in GitHub Issues with 👀 3 Feb 17, 2025

getsantry bot removed the Waiting for: Product Owner label Feb 17, 2025

getsantry bot removed the status in GitHub Issues with 👀 3 Feb 17, 2025

botafi closed this as completed Feb 17, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Nuxt] Node server config import results in ReferenceError: require is not defined in ES module scope, you can use import instead #15423

[Nuxt] Node server config import results in ReferenceError: require is not defined in ES module scope, you can use import instead #15423

botafi commented Feb 14, 2025 •

edited

Loading

CoconutTheSlayer commented Feb 14, 2025

davionbot commented Feb 15, 2025

botafi commented Feb 15, 2025 •

edited

Loading

wkl007 commented Feb 17, 2025

timfish commented Feb 17, 2025 •

edited

Loading

timfish commented Feb 17, 2025

botafi commented Feb 17, 2025

s1gr1d commented Feb 17, 2025 •

edited

Loading

Lms24 commented Feb 17, 2025

timfish commented Feb 17, 2025 •

edited

Loading

botafi commented Feb 17, 2025

timfish commented Feb 17, 2025

botafi commented Feb 17, 2025

timfish commented Feb 21, 2025

[Nuxt] Node server config import results in ReferenceError: require is not defined in ES module scope, you can use import instead #15423

[Nuxt] Node server config import results in ReferenceError: require is not defined in ES module scope, you can use import instead #15423

Comments

botafi commented Feb 14, 2025 • edited Loading

Is there an existing issue for this?

How do you use Sentry?

Which SDK are you using?

SDK Version

Framework Version

Link to Sentry event

Reproduction Example/SDK Setup

Steps to Reproduce

Expected Result

Actual Result

CoconutTheSlayer commented Feb 14, 2025

davionbot commented Feb 15, 2025

botafi commented Feb 15, 2025 • edited Loading

wkl007 commented Feb 17, 2025

timfish commented Feb 17, 2025 • edited Loading

timfish commented Feb 17, 2025

botafi commented Feb 17, 2025

s1gr1d commented Feb 17, 2025 • edited Loading

Lms24 commented Feb 17, 2025

timfish commented Feb 17, 2025 • edited Loading

botafi commented Feb 17, 2025

timfish commented Feb 17, 2025

botafi commented Feb 17, 2025

timfish commented Feb 21, 2025

botafi commented Feb 14, 2025 •

edited

Loading

botafi commented Feb 15, 2025 •

edited

Loading

timfish commented Feb 17, 2025 •

edited

Loading

s1gr1d commented Feb 17, 2025 •

edited

Loading

timfish commented Feb 17, 2025 •

edited

Loading