kit: SvelteKit 2.21.3 Breaks Certain CommonJS Packages in Production

Describe the bug

After upgrading to SvelteKit 2.21.5 from SvelteKit 2.21.2, I am starting to get ReferenceError: require is not defined in ES module scope whenever I import a package that uses require in any capacity. This did not happen before SvelteKit 2.21.3.

I thought it might be an issue with specific packages or projects, but it’s not. I tested three different projects, all with different dependencies, and the same problem occurred.

Examples of affected packages:

I concluded that the issue is caused by SvelteKit versions >= 2.21.3 because I kept downgrading, and once I went below 2.21.3, things worked as expected.

Reproduction

  • Create a new SvelteKit project
  • Install one or more of the packages mentioned above
  • Import one or more of them in a server module (e.g. +page.server.ts, code inside a .server.ts file, or files inside the $lib/server directory)
  • Build your app
  • Run the app and execute any code that would cause the module to be loaded

Logs

ReferenceError: require is not defined in ES module scope, you can use import instead
This file is being treated as an ES module because it has a '.js' file extension and '[REDACTED_PATH]/package.json' contains "type": "module". To treat it as a CommonJS script, rename it to use the '.cjs' file extension.
    at ExportsCache.has (file://[REDACTED_PATH]/build/server/chunks/hooks.server-MojicEX3.js:15490:20)
    at Module.patchedRequire (file://[REDACTED_PATH]/build/server/chunks/hooks.server-MojicEX3.js:15618:22)
    at Hook._require.Module.require (file://[REDACTED_PATH]/build/server/chunks/hooks.server-MojicEX3.js:15557:28)
    at require (node:internal/modules/helpers:135:16)
    at Object.<anonymous> ([REDACTED_PATH]/node_modules/highlight.js/lib/index.js:1:12)
    at Module._compile (node:internal/modules/cjs/loader:1730:14)
    at Object..js (node:internal/modules/cjs/loader:1895:10)
    at Module.load (node:internal/modules/cjs/loader:1465:32)
    at Function._load (node:internal/modules/cjs/loader:1282:12)
    at TracingChannel.traceSync (node:diagnostics_channel:322:14)

System Info

System:
    OS: Windows 11 10.0.26100
    CPU: (28) x64 Intel(R) Core(TM) i7-14700K
    Memory: 35.78 GB / 63.70 GB
  Binaries:
    Node: 22.16.0 - C:\Program Files\nodejs\node.EXE
    npm: 11.4.1 - ~\AppData\Roaming\npm\npm.CMD
    bun: 1.2.16 - ~\.bun\bin\bun.EXE
  Browsers:
    Edge: Chromium (137.0.3296.68)
    Internet Explorer: 11.0.26100.1882
  npmPackages:
    @sveltejs/adapter-node: ^5.2.12 => 5.2.12
    @sveltejs/kit: ^2.21.5 => 2.21.5
    @sveltejs/vite-plugin-svelte: ^5.1.0 => 5.1.0
    svelte: ^5.34.2 => 5.34.2
    vite: ^6.3.5 => 6.3.5

Severity

blocking an upgrade

Additional Information

No response

About this issue

  • Original URL
  • State: closed
  • Created a year ago
  • Reactions: 6
  • Comments: 29 (8 by maintainers)

Most upvoted comments

I can confirm this issue with the package @sentry/sveltekit.

I found the cause. It is because of both @sveltejs/kit (>= 2.21.3) and @sentry/sveltekit.

I had the following code in hooks.client.ts:

import * as Sentry from "@sentry/sveltekit";
import { handleErrorWithSentry } from "@sentry/sveltekit";

Sentry.init({
  dsn: "[REDACTED]",
  tracesSampleRate: 1.0,
  enabled: import.meta.env.PROD,
});

export const handleError = handleErrorWithSentry();

And this code in hooks.server.ts:

import * as Sentry from "@sentry/sveltekit";
import { sequence } from "@sveltejs/kit/hooks";
import { handleErrorWithSentry, sentryHandle } from "@sentry/sveltekit";

Sentry.init({
  dsn: "[REDACTED]",
  tracesSampleRate: 1.0,
  enabled: import.meta.env.PROD,
});

export const handle = sequence(sentryHandle());

export const handleError = handleErrorWithSentry();

After I commented those out, I was able to build and run my application normally without encountering the errors reported in the original message.

For some reason, SvelteKit versions after 2.21.3 don’t play nicely with @sentry/sveltekit (or the other way around?).

The reason I wasn’t able to reproduce the issue is that the reproduction project didn’t use @sentry/sveltekit. After adding it to the reproduction project, I began to encounter the same errors.

@eltigerchino attached is a dead-simple project that only requires you to run npm install or pnpm install, build the project, and then run node .\build\index.js in the project’s root directory.

After that, navigate to localhost:3000, type anything in the “Markdown” text area, and press convert. You will see that a 500 Internal Server Error is thrown in the network tab, and an error message is shown in the UI.

Once you comment out the Sentry stuff from hooks.client.ts and hooks.server.ts files & rebuild the project, you will no longer encounter the issue.

I set up Sentry using a temporary project on my account, so please let me know when you are done so I can take it down before any malicious actors abuse the API keys 😅

Also, I am running the project on Windows 11 Pro 24H2 and using Node v22.16.0. However, the issue also occurs on Linux and within Linux Docker containers.

sveltekit-2.21.3-bug-reproduction.zip

Thank you! So sorry you had to go out of your way for this. I think I have enough to find out the cause of the issue. But, it’s more likely that we will merge https://github.com/sveltejs/kit/pull/13894 and revert this whole bundling fiasco. I’m so sorry for all the trouble this has caused!

Same problem here (svelteKit + sentry).

@eltigerchino externalising does work, yes. However, another issue arises with specific packages, where, when externalised, they cause errors with the development server when imported. If I recall correctly, they were marked and highlight.js.

All packages are externalised during SSR by default so adding Sentry to that list is important to tell SvelteKit not to bundle it although it has a dependency on SvelteKit (that new behaviour causing issues).

I tried the createRequire workaround, but it didn’t work. I got the same bug after building & running.

Yeah, you won’t be able to do this yourself. It has to be in the same module as where require is being used. I suspect https://www.npmjs.com/package/@rollup/plugin-commonjs is already doing this and it’s what we use in the Node adapter so that CJS packages work when bundled (this is a separate step after the Vite build where we don’t have that plugin because we never bundled dependencies before during this stage).

@Cluster2a

  • I deleted the Sentry project, so the plugin might not work properly during the build.
  • You have to execute code that imports CJS modules. The app doesn’t do that by default, but typing something in the text area and pressing convert will throw an error because the API endpoint that handles the request imports marked.

@eltigerchino attached is a dead-simple project that only requires you to run npm install or pnpm install, build the project, and then run node .\build\index.js in the project’s root directory.

After that, navigate to localhost:3000, type anything in the “Markdown” text area, and press convert. You will see that a 500 Internal Server Error is thrown in the network tab, and an error message is shown in the UI.

Once you comment out the Sentry stuff from hooks.client.ts and hooks.server.ts files & rebuild the project, you will no longer encounter the issue.

I set up Sentry using a temporary project on my account, so please let me know when you are done so I can take it down before any malicious actors abuse the API keys 😅

Also, I am running the project on Windows 11 Pro 24H2 and using Node v22.16.0. However, the issue also occurs on Linux and within Linux Docker containers.

File deleted

It’s not enough to install the packages. You also have to import them to a server file e.g. hooks.server.ts.

Yes, I’ve installed them and imported them into a server file.

Here is a minimal repo that creates the error: yaman-cruise/svelte-sentry

1. run `pnpm build` and you'll get the error

This doesn’t error for me after running pnpm build. Which Node version and operating system are you using when running the build? I’m running on WSL 2 Ubuntu 22.04.5 LTS and Node v18.20.8

I’ll share a reproduction project shortly.

I also encounter the issue, but my logs seems to indicate that it’s related to chokidar this time.

Dependency Version
@sentry/sveltekit 9.29.0
@sveltejs/kit 2.21.5

It is interesting to note, that chokidar is not one of my dependencies, it is a dependency of one of my dependencies.

Staying on @sveltejs/kit@2.21.2 is the only way I’ve found to avoid the issue.

✗ Build failed in 10.92s
error during build:
[commonjs--resolver] ../../node_modules/.pnpm/fsevents@2.3.3/node_modules/fsevents/fsevents.node (1:0): Unexpected character '�' (Note that you need plugins to import files that are not JavaScript)
file: /REDACTED/node_modules/.pnpm/fsevents@2.3.3/node_modules/fsevents/fsevents.node:1:0 (/REDACTED/node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/index.js)

1: ����@<�
                              ��*...
   ^
4* 
                      h���/System/Library/Frameworks/CoreFoundation.framework/Versions...
3: ���H��1�H���L���L���H�����L�E�L��H��1�����uH�E�H�[A^A_]��}f.�UH��AWAVSPI��H��I��H�H...

    at getRollupError (file:///REDACTED/node_modules/.pnpm/rollup@4.42.0/node_modules/rollup/dist/es/shared/parseAst.js:401:41)
    at ParseError.initialise (file:///REDACTED/node_modules/.pnpm/rollup@4.42.0/node_modules/rollup/dist/es/shared/node-entry.js:14293:28)
    at convertNode (file:///REDACTED/node_modules/.pnpm/rollup@4.42.0/node_modules/rollup/dist/es/shared/node-entry.js:16197:10)
    at convertProgram (file:///REDACTED/node_modules/.pnpm/rollup@4.42.0/node_modules/rollup/dist/es/shared/node-entry.js:15440:12)
    at Module.setSource (file:///REDACTED/node_modules/.pnpm/rollup@4.42.0/node_modules/rollup/dist/es/shared/node-entry.js:17185:24)
    at async ModuleLoader.addModuleSource (file:///REDACTED/node_modules/.pnpm/rollup@4.42.0/node_modules/rollup/dist/es/shared/node-entry.js:21187:13)
 ELIFECYCLE  Command failed with exit code 1.
ERROR: command finished with error: command (/REDACTED/apps/website) ~/Library/pnpm/.tools/pnpm/10.12.1/bin/pnpm run build exited (1)