Bundling SSR Modules using CommonJS exports alias results in ReferenceError: exports is not defined #2579

GrygrFlzr · 2021-03-18T11:36:49Z

Describe the bug

When importing an SSR module, if

it uses the exports alias instead of module.exports,
ssr.noExternal is declared with the module

Vite is unable to evaluate it. This can also happen with the more common module.exports, but seems to not be guaranteed.

While this behavior may seem esoteric due to modern proliferation of module.exports, this is a feature of Node since v0.1.16 and has not been deprecated. In addition, there are instances of various npm modules in the wild which use this method of exporting fields, including, but not limited to:

...and much, much, more searchable on GitHub. I believe this is also an output of some bundlers.

Reproduction

https://github.com/GrygrFlzr/vite-cjs-ssr

git clone https://github.com/GrygrFlzr/vite-cjs-ssr.git
cd vite-cjs-ssr
npm i
npm run dev

Visit http://localhost:3000 to trigger SSR, which consists of a very simple script that uses the cookie npm module.
The page will render exports is not defined and errors will show up in the server console:

6:29:45 PM [vite] new dependencies found: cookie, updating...
6:29:45 PM [vite] Error when evaluating SSR module /node_modules/cookie/index.js:
ReferenceError: exports is not defined
    at /node_modules/cookie/index.js:15:1
    at instantiateModule (C:\Users\GrygrFlzr\Documents\projects\vite-cjs\node_modules\vite\dist\node\chunks\dep-efe32886.js:68893:166)
ReferenceError: exports is not defined
    at /node_modules/cookie/index.js:13:1
    at instantiateModule (C:\Users\GrygrFlzr\Documents\projects\vite-cjs\node_modules\vite\dist\node\chunks\dep-efe32886.js:68893:166)

System Info

vite version: 2.1.2
Operating System: Windows 10 10.0.19042
Node version: 14.16.0
Package manager and version: npm 6.14.11

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

techniq · 2021-03-18T12:22:50Z

@GrygrFlzr I believe I am running into this issue as well, and had posted an issue with LayerCake. I have a minimal SvelteKit repo here if it helps to troubleshoot.

rifler · 2021-04-02T19:05:16Z

are there any workarounds?

bryik · 2021-04-06T03:41:18Z

are there any workarounds?

You could try importing the library via ye olde <script> in the <head> and then assign from window instead of importing. This worked for me with D3 and SvelteKit anyways.

BetaConnector · 2021-04-06T07:01:37Z

Same problem with faunadb.
Unfortunately if you want to stick with netlify there is no other choice.

benmccann · 2021-04-06T17:44:48Z

I believe this is also an output of some bundlers.

It turns out that Rollup creates output that uses just exports instead of module.exports so this is probably quite common to hit. A user reported this issue with apollo-link-prismic which is written in ESM but then bundled to CJS with Rollup

anilbhattaraitoronto · 2021-04-06T22:20:14Z

I am having exactly the same error with better-sqlite3 .

yaquawa · 2021-04-06T23:34:00Z

Can't solve the problem even using the module.exports...

jlkiri · 2021-04-07T14:53:14Z

For me changing to module.exports also does not solve the problem: I get module is not defined error.

leemove · 2021-04-12T11:51:15Z

It looks like doesn't support commomjs

BetaConnector · 2021-04-12T12:38:25Z

@rifler, check out my issue:
#2862

I converted the module from cjs to esm. After that I placed the module directly into my project and removed the dependency.

This is really ugly but seems to work for rhis moment.

@GrygrFlzr, how are your plans regarding to cjs modules? Will there be a solution or is cjs just not supported?

ggoodman · 2021-04-12T15:24:33Z

#2890 talks about a potential, but ugly work-around.

quantuminformation · 2021-04-14T07:44:34Z

@ggoodman I'm not even using vite-cjs-ssr and I get this error

10:38:19 [vite] Error when evaluating SSR module /node_modules/node-timecodes/dist/index.js:
ReferenceError: exports is not defined
    at /node_modules/node-timecodes/dist/index.js:5:23```

I've seen a few issues that seem related like:
https://github.com/mhkeller/layercake/issues/41

Jakeii · 2021-12-28T14:45:08Z

Another lesser used syntax module['exports'] = xyz; also seems to be affected by this issue, discovered trying to import https://github.com/infusion/Fraction.js into a sveltekit project.

leetrout · 2022-01-01T00:32:41Z

@benmccann see metonym/carbon-charts-svelte-examples#1

crypticwasp254 · 2022-01-08T18:49:57Z

have you tried

import {* as somename} from 'module';
//tried with cookie and it worked
import * as cookie from 'cookie';

marcelchastain · 2022-01-30T03:14:29Z

Managed to get around a similar issue by using the vite-plugin-commonjs plugin:

// vite.config.ts
import { esbuildCommonjs, viteCommonjs } from "@originjs/vite-plugin-commonjs";
import react from "@vitejs/plugin-react";
import { UserConfig } from "vite";
import ssr from "vite-plugin-ssr/plugin";

const config: UserConfig = {
  plugins: [viteCommonjs(), react(), ssr()],
  optimizeDeps: {
    esbuildOptions: {
      plugins: [esbuildCommonjs(["@app/config"])],  // the problematic cjs module
    },
    include: ["@app/config"],  // also here
  },
};

export default config;

andreataglia · 2022-03-30T17:43:03Z

This workaround works for me:

Inside vite.config.ts

optimizeDeps: {
    include: ['badPackage'],
},

thewilkybarkid · 2022-04-04T10:12:48Z

I seem to have a related problem with the fp-ts-routing library: Vite just hangs; adding it to optimizeDeps.include makes no difference; including it in ssr.noExternal sees a ReferenceError: exports is not defined error thrown.

vite build works successfully, however.

samullman · 2022-06-01T02:55:00Z

I was having this issue and fixed with https://github.com/originjs/vite-plugins/tree/main/packages/vite-plugin-commonjs

Working on a sveltekit project may help someone in the future

lmiller1990 · 2022-06-27T05:26:57Z

I am seeing something similar - exports is not defined. It only happens on my windows machine; not macOS or linux. The built assets are completely different.

I'll verify someone else in my company can repro on a windows machine before making an issue. The repo in question is cypress-io/cypress - cd packages/app && yarn build-prod-ui. I'm on the latest Vite (2.9.13).

Could be dup of #8800

patak-dev · 2022-06-27T06:04:08Z

This issue was closed for vite v3, please check the latest beta. You'll need to add the dep to ssr.noExternal

ollyde · 2022-07-03T19:08:38Z

I can't seem to get basic node modules working on the build version, using svelte-kit build

Works on dev mode.
/// send_form.ts
import * as geoip from 'geoip-lite';

Adding

ssr: {
    noExternal: ['geoip-lite']
}

Gives the error
config.kit.ssr has been removed — use the handle hook instead: https://kit.svelte.dev/docs/hooks#handle

The https://kit.svelte.dev/docs/hooks#handle
Doesn't really explain why it's useful for this :-/

vite: {
    optimizeDeps: {
        include: ['geoip-lite']
    }
}

Doesn't, out of ideas here...

I'm amazed that something this basic is broken..

benmccann · 2022-07-03T20:15:17Z

@OllyDixon you put the config in the wrong place. It needs to go in kit.vite.ssr and not kit.ssr

I'm amazed that you broke something this basic 😉

ollyde · 2022-07-03T20:16:25Z

I removed all of the config and added the import like this instead import geoip from 'geoip-lite'; and it works, thanks for the reply.

theotherdon · 2022-07-15T15:46:05Z

Wa also able to resolve this issue by using the vite-plugin-commonjs plugin.

GrygrFlzr added the pending triage label Mar 18, 2021

GrygrFlzr changed the title ~~SSR Modules using CommonJS exports alias results in ReferenceError: exports is not defined~~ Importing SSR Modules using CommonJS exports alias results in ReferenceError: exports is not defined Mar 18, 2021

techniq mentioned this issue Mar 18, 2021

SvelteKit / Vite support (works out of the box now, site and examples will be updated soon) mhkeller/layercake#41

Closed

GrygrFlzr changed the title ~~Importing SSR Modules using CommonJS exports alias results in ReferenceError: exports is not defined~~ Bundling SSR Modules using CommonJS exports alias results in ReferenceError: exports is not defined Mar 18, 2021

GrygrFlzr mentioned this issue Mar 22, 2021

FAQ sveltejs/kit#581

Closed

devrnt mentioned this issue Mar 25, 2021

ReferenceError: require is not defined sveltejs/kit#655

Closed

ivanhofer mentioned this issue Mar 26, 2021

Support for sveltekit ivanhofer/typesafe-i18n#18

Closed

GrygrFlzr added bug: ssr p5-urgent Fix build-breaking bugs affecting most users, should be released ASAP (priority) and removed pending triage labels Mar 27, 2021

patak-dev added feat: ssr and removed bug: ssr labels Mar 27, 2021

brillout mentioned this issue Mar 29, 2021

require is not defined error when using cjs dependency in page server files vikejs/vike#20

Closed

benmccann mentioned this issue Apr 12, 2021

issue with using CommonJS modules in "svelte/kit build" sveltejs/kit#928

Closed

ixxie mentioned this issue Apr 13, 2021

supabase-js fails with @sveltejs/kit (warning, sveltejs/kit is experimental) supabase/supabase-js#89

Closed

furudean mentioned this issue Apr 15, 2021

error: exports is not defined when using ViteDevServer.ssrLoadModule #2890

Closed

Conduitry mentioned this issue Apr 18, 2021

Repeated errors from [vite] after pnpm init svelte@next my-app (2.0.0-next.55): Error when evaluating SSR module cookie: ReferenceError: exports is not defined sveltejs/kit#1113

Closed

brillout mentioned this issue Dec 7, 2021

Bundling SSR Modules using CommonJS exports alias results in ReferenceError: exports is not defined brillout/esm-cjs-interop-playground#5

Open

ClarkXia mentioned this issue Dec 14, 2021

vite 模式下的 SSR 方案 alibaba/ice#4651

Closed

This was referenced Dec 31, 2021

[Bug]: Cannot import labels enum carbon-design-system/carbon-charts#1255

Closed

Sveltekit and SSR crash andrew-secret/svelte-datepicker#101

Open

benmccann added p3-minor-bug An edge case that only affects very specific usage (priority) and removed p4-important Violate documented behavior or significantly improves performance (priority) labels Jan 21, 2022

dominikg mentioned this issue Jan 21, 2022

vite SSR module error when importing isomorphic library within globalSetup file vitest-dev/vitest#522

Closed

6 tasks

bluwy mentioned this issue Jan 24, 2022

Error when evaluating SSR module in dev mode sveltejs/kit#3520

Closed

benmccann added p4-important Violate documented behavior or significantly improves performance (priority) and removed p3-minor-bug An edge case that only affects very specific usage (priority) labels Jan 30, 2022

benmccann mentioned this issue Jan 31, 2022

fix: externalize dependencies by default during SSR #6698

Closed

9 tasks

frandiox mentioned this issue Mar 9, 2022

[BUG] Vite fails on 3p package that contains scss imports during SSR pass Shopify/hydrogen-v1#869

Closed

benmccann mentioned this issue May 5, 2022

fix: externalize dependencies by default during SSR #8033

Closed

9 tasks

patak-dev mentioned this issue Jun 1, 2022

feat: support cjs noExternal in SSR dev, fix #2579 #8430

Merged

4 tasks

patak-dev closed this as completed in #8430 Jun 18, 2022

patak-dev added a commit that referenced this issue Jun 18, 2022

feat: support cjs noExternal in SSR dev, fix #2579 (#8430)

11d2191

github-actions bot locked and limited conversation to collaborators Jul 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bundling SSR Modules using CommonJS exports alias results in ReferenceError: exports is not defined #2579

Bundling SSR Modules using CommonJS exports alias results in ReferenceError: exports is not defined #2579

GrygrFlzr commented Mar 18, 2021 •

edited

techniq commented Mar 18, 2021

rifler commented Apr 2, 2021

bryik commented Apr 6, 2021

BetaConnector commented Apr 6, 2021

benmccann commented Apr 6, 2021 •

edited

anilbhattaraitoronto commented Apr 6, 2021

yaquawa commented Apr 6, 2021

jlkiri commented Apr 7, 2021

leemove commented Apr 12, 2021

BetaConnector commented Apr 12, 2021

ggoodman commented Apr 12, 2021

quantuminformation commented Apr 14, 2021

Jakeii commented Dec 28, 2021

leetrout commented Jan 1, 2022

crypticwasp254 commented Jan 8, 2022

marcelchastain commented Jan 30, 2022 •

edited

andreataglia commented Mar 30, 2022 •

edited

thewilkybarkid commented Apr 4, 2022

samullman commented Jun 1, 2022

lmiller1990 commented Jun 27, 2022 •

edited

patak-dev commented Jun 27, 2022

ollyde commented Jul 3, 2022 •

edited

benmccann commented Jul 3, 2022

ollyde commented Jul 3, 2022

theotherdon commented Jul 15, 2022

Bundling SSR Modules using CommonJS exports alias results in ReferenceError: exports is not defined #2579

Bundling SSR Modules using CommonJS exports alias results in ReferenceError: exports is not defined #2579

Comments

GrygrFlzr commented Mar 18, 2021 • edited

Describe the bug

Reproduction

System Info

techniq commented Mar 18, 2021

rifler commented Apr 2, 2021

bryik commented Apr 6, 2021

BetaConnector commented Apr 6, 2021

benmccann commented Apr 6, 2021 • edited

anilbhattaraitoronto commented Apr 6, 2021

yaquawa commented Apr 6, 2021

jlkiri commented Apr 7, 2021

leemove commented Apr 12, 2021

BetaConnector commented Apr 12, 2021

ggoodman commented Apr 12, 2021

quantuminformation commented Apr 14, 2021

Jakeii commented Dec 28, 2021

leetrout commented Jan 1, 2022

crypticwasp254 commented Jan 8, 2022

marcelchastain commented Jan 30, 2022 • edited

andreataglia commented Mar 30, 2022 • edited

thewilkybarkid commented Apr 4, 2022

samullman commented Jun 1, 2022

lmiller1990 commented Jun 27, 2022 • edited

patak-dev commented Jun 27, 2022

ollyde commented Jul 3, 2022 • edited

benmccann commented Jul 3, 2022

ollyde commented Jul 3, 2022

theotherdon commented Jul 15, 2022

GrygrFlzr commented Mar 18, 2021 •

edited

benmccann commented Apr 6, 2021 •

edited

marcelchastain commented Jan 30, 2022 •

edited

andreataglia commented Mar 30, 2022 •

edited

lmiller1990 commented Jun 27, 2022 •

edited

ollyde commented Jul 3, 2022 •

edited