`vite` SSR module error when importing isomorphic library within `globalSetup` file #522

bhvngt · 2022-01-13T16:39:24Z

Describe the bug

I was trying out this feature and came across this peculiar issue. I am using an isomorphic library supabase-js. When I import it in a file that is sourced by globalSetup, it throws following error.

21:38:19 [vite] Error when evaluating SSR module /node_modules/@supabase/supabase-js/dist/main/index.js:
ReferenceError: exports is not defined
    at eval (/node_modules/@supabase/supabase-js/dist/main/index.js:17:23)
    at instantiateModule (/home/projects/node-3cxxqh/node_modules/vite/dist/node/chunks/dep-76613303.js:60094:15)
21:38:19 [vite] Error when evaluating SSR module ./test/globalSetup.ts:
ReferenceError: exports is not defined
    at eval (/node_modules/@supabase/supabase-js/dist/main/index.js:17:23)
    at instantiateModule (/home/projects/node-3cxxqh/node_modules/vite/dist/node/chunks/dep-76613303.js:60094:15)
(node:6) UnhandledPromiseRejectionWarning: ReferenceError: exports is not defined
    at eval (/node_modules/@supabase/supabase-js/dist/main/index.js:17:23)
    at instantiateModule (/home/projects/node-3cxxqh/node_modules/vite/dist/node/chunks/dep-76613303.js:60094:15)

When I import the same in a normal test file it works fine.

Reproduction

Here's the playground where the error is reproduced.

System Info

System:
    OS: macOS 12.1
    CPU: (4) x64 Intel(R) Core(TM) i5-6267U CPU @ 2.90GHz
    Memory: 75.13 MB / 16.00 GB
    Shell: 3.3.1 - /usr/local/bin/fish
  Binaries:
    Node: 16.13.1 - /var/folders/n0/qyzlydqj6cv8qt68qd6dbprh0000gn/T/fnm_multishells/47821_1641998710149/bin/node
    npm: 8.1.2 - /var/folders/n0/qyzlydqj6cv8qt68qd6dbprh0000gn/T/fnm_multishells/47821_1641998710149/bin/npm
  Browsers:
    Chrome: 97.0.4692.71
    Chrome Canary: 99.0.4826.0
    Edge: 96.0.1054.43
    Firefox: 95.0.2
    Safari: 15.2

Used Package Manager

pnpm

Validations

Follow our Code of Conduct
Read the Contributing Guidelines.
Read the docs.
Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
The provided reproduction is a minimal reproducible example of the bug.

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

dominikg · 2022-01-14T15:06:36Z

To setup client connections please use setupFiles with beforeAll.
Setup global would be a place to ensure your local supabase service is started.

You cannot share data or exports directly from globalSetup to test files.

In regards to the error it looks like supabase-js may be packaged in a way that vite.ssrLoadModule tries to load its cjs entry as esm

bhvngt · 2022-01-15T07:01:03Z

My understanding is that beforeAll runs at the beginning of every test file run. Hence, it ends up running x number of times for x test files. I was looking at setting something up before the entire test run (for all files). For this use case, is globalSetup way to go?

I don't plan to share any data or exports directly to test files from globalSetup. I just wanted to set some environmental config before I run my test files.

supabase-js is exporting main(commonjs), module(esm) and umd builds. I am not very sure if this is supabase packaging issue or is this an issue with vitejs.

When I import supabase-js inside my test files, it works without any issue during vitest run.

bhvngt · 2022-01-15T07:47:06Z

I am facing somewhat similar issue when I import fetch from cross-fetch in a globalSetup file.

13:15:13 [vite] Error when evaluating SSR module /node_modules/cross-fetch/dist/node-ponyfill.js:
ReferenceError: require is not defined
    at /node_modules/cross-fetch/dist/node-ponyfill.js:1:19

I have updated the playground for easy reproduction.

dominikg · 2022-01-15T10:35:49Z

supabase only declares a "module" field in package.json, not an exports map and it also use .js extension for both cjs and mjs instead of using explict .mjs. From a node perspective, supabase is a commonjs package. (module field is only a convention for bundlers, nothing official by node)

cross-fetch seems to be cjs too, you may get around that one by using node-fetch (v3 is esm) directly.

This seems to be a bug or implementation error that prevents working with cjs packages in globalSetup,

I'd like to learn more about your usecase/intentions. The way you're using isomorphic packages in globalSetup - which is only ever run in a node environment - still makes me wonder if you're trying to do something it is not meant for.

bhvngt · 2022-01-15T10:39:42Z

Thanks @dominikg for your reply.

About my use case - I am setting up couple of dataset in the database before my test runs begin. I am fetching some of the data from other services using fetch. I would like to do this before any test is run and would like to dismantle them once all tests have run to keep the state cleaned up.

bhvngt · 2022-01-15T10:41:10Z

supabase only declares a "module" field in package.json, not an exports map and it also use .js extension for both cjs and mjs instead of using explict .mjs. From a node perspective, supabase is a commonjs package. (module field is only a convention for bundlers, nothing official by node)

hmm. Will raise this as an issue to supabase team

bhvngt · 2022-01-15T10:48:49Z

cross-fetch seems to be cjs too, you may get around that one by using node-fetch (v3 is esm) directly.

I tried node-fetch (3.1.0) in my playground and got following error.

16:16:15 [vite] Error when evaluating SSR module /node_modules/fetch-blob/streams.cjs:
ReferenceError: require is not defined
    at /node_modules/fetch-blob/streams.cjs:22:19
    at instantiateModule (/home/projects/node-3cxxqh/node_modules/vite/dist/node/chunks/dep-76613303.js:60094:15)
16:16:15 [vite] Error when evaluating SSR module /node_modules/fetch-blob/index.js:
ReferenceError: require is not defined
    at /node_modules/fetch-blob/streams.cjs:20:19
    at instantiateModule (/home/projects/node-3cxxqh/node_modules/vite/dist/node/chunks/dep-76613303.js:60094:15)
16:16:15 [vite] Error when evaluating SSR module /node_modules/node-fetch/src/body.js:
ReferenceError: require is not defined
    at /node_modules/fetch-blob/streams.cjs:20:19
    at instantiateModule (/home/projects/node-3cxxqh/node_modules/vite/dist/node/chunks/dep-76613303.js:60094:15)
16:16:15 [vite] Error when evaluating SSR module /node_modules/node-fetch/src/index.js:
ReferenceError: require is not defined
    at /node_modules/fetch-blob/streams.cjs:20:19
    at instantiateModule (/home/projects/node-3cxxqh/node_modules/vite/dist/node/chunks/dep-76613303.js:60094:15)
16:16:15 [vite] Error when evaluating SSR module ./test/globalSetup.ts:
ReferenceError: require is not defined
    at /node_modules/fetch-blob/streams.cjs:20:19
    at instantiateModule (/home/projects/node-3cxxqh/node_modules/vite/dist/node/chunks/dep-76613303.js:60094:15)

bhvngt · 2022-01-15T10:52:29Z

I am just wondering why both supabase and cross-fetch works when run within the test files by vitest and breaks only when run within globalSetup.

tirli · 2022-01-19T01:13:24Z

I'm getting the same error even for simple server startup, like here:

import { createServer } from 'vite'

export async function globalSetup() {
  const server = await createServer({
    root: resolve(__dirname, '..'),
    server: {
      port: 3000,
    },
  })

  await server.listen()

  return async () => {
    await server.close()
  }
}

So probably not related to isomorphic libs?

dominikg · 2022-01-21T12:45:07Z

It is related to cjs. Even though vite itself is primarily working with es modules, it is itself distributed as cjs.

https://github.com/vitejs/vite/blob/3fb4118026e2745140894afb9755298656750f43/packages/vite/package.json#L10

dist/node/index.js

'use strict';

Object.defineProperty(exports, '__esModule', { value: true });

var build = require('./chunks/dep-f5552faa.js');
require('fs');

related bug in vite repo: vitejs/vite#2579

Demivan · 2022-01-23T08:27:03Z

As a workaround you can use createRequire to create a require function that can import CommonJs modules.

import { createRequire } from 'module'
const require = createRequire(import.meta.url)

dominikg · 2022-01-23T12:35:01Z

i had implemented it with dynamic import before changing it to ssrLoadModule, there are also issues with that approach and using vite has the benefit of builtin ts support

dominikg · 2022-02-03T18:34:04Z

@bhvngt @tirli globalSetup should work with external modules now. Please let me know if you're still experiencing issues.

bhvngt · 2022-02-04T05:02:58Z

@dominikg its working pretty well. Here's the playground where it is working.

When I run vitest --ui, globalSetup seems to be running twice. However, in vitest run globalsetup runs only once. Could this be due to the way stackblitz is setup?

In general, is it expected to run once for the entire test run or will it run once per worker thread?

dominikg · 2022-02-04T08:37:12Z

once per run

dominikg · 2022-02-04T12:18:31Z

can confirm that with --ui globalSetup is executed twice, thats a different issue though.

dominikg · 2022-02-04T12:30:32Z

reported as #679

bhvngt mentioned this issue Jan 13, 2022

feat: global setup #372

Merged

dominikg mentioned this issue Jan 24, 2022

refactor: use vite-node to load globalSetup #624

Merged

sheremet-va closed this as completed Apr 5, 2022

github-actions bot locked and limited conversation to collaborators Jun 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`vite` SSR module error when importing isomorphic library within `globalSetup` file #522

`vite` SSR module error when importing isomorphic library within `globalSetup` file #522

bhvngt commented Jan 13, 2022

dominikg commented Jan 14, 2022

bhvngt commented Jan 15, 2022 •

edited

Loading

bhvngt commented Jan 15, 2022

dominikg commented Jan 15, 2022

bhvngt commented Jan 15, 2022 •

edited

Loading

bhvngt commented Jan 15, 2022

bhvngt commented Jan 15, 2022

bhvngt commented Jan 15, 2022 •

edited

Loading

tirli commented Jan 19, 2022

dominikg commented Jan 21, 2022

Demivan commented Jan 23, 2022

dominikg commented Jan 23, 2022

dominikg commented Feb 3, 2022

bhvngt commented Feb 4, 2022 •

edited

Loading

dominikg commented Feb 4, 2022

dominikg commented Feb 4, 2022

dominikg commented Feb 4, 2022

vite SSR module error when importing isomorphic library within globalSetup file #522

vite SSR module error when importing isomorphic library within globalSetup file #522

Comments

bhvngt commented Jan 13, 2022

Describe the bug

Reproduction

System Info

Used Package Manager

Validations

dominikg commented Jan 14, 2022

bhvngt commented Jan 15, 2022 • edited Loading

bhvngt commented Jan 15, 2022

dominikg commented Jan 15, 2022

bhvngt commented Jan 15, 2022 • edited Loading

bhvngt commented Jan 15, 2022

bhvngt commented Jan 15, 2022

bhvngt commented Jan 15, 2022 • edited Loading

tirli commented Jan 19, 2022

dominikg commented Jan 21, 2022

Demivan commented Jan 23, 2022

dominikg commented Jan 23, 2022

dominikg commented Feb 3, 2022

bhvngt commented Feb 4, 2022 • edited Loading

dominikg commented Feb 4, 2022

dominikg commented Feb 4, 2022

dominikg commented Feb 4, 2022

`vite` SSR module error when importing isomorphic library within `globalSetup` file #522

`vite` SSR module error when importing isomorphic library within `globalSetup` file #522

bhvngt commented Jan 15, 2022 •

edited

Loading

bhvngt commented Jan 15, 2022 •

edited

Loading

bhvngt commented Jan 15, 2022 •

edited

Loading

bhvngt commented Feb 4, 2022 •

edited

Loading