feat: global setup #372

dominikg · 2021-12-30T13:10:53Z

fixes #300

ideas for tests, documentation and api improvements welcome

Questions:

this only worked for javascript files in my manual tests. how important is ts support and what needs to be done
should buildEnd be in a separate enforce: 'post' plugin
jest has a slightly different api with two separate files. This PR has more flexibility but is it ok to diverge from jest here

netlify · 2021-12-30T13:10:59Z

✔️ Deploy Preview for vitest-dev ready!

🔨 Explore the source changes: 62d95d5

🔍 Inspect the deploy log: https://app.netlify.com/sites/vitest-dev/deploys/61dbf28b8a7c0500079e63bd

😎 Browse the preview: https://deploy-preview-372--vitest-dev.netlify.app

patak-dev · 2021-12-30T14:09:43Z

Great! About the API, is there a reason we want to use a file-based API instead of accepting the setup function in the config?

/// <reference types="vitest" />

import { defineConfig } from 'vite'

export default defineConfig({
  test: {
    global: true,
    globalSetup: async function() {
      const server = await startServer()
      return async() => {
        await server.close()
      }
    },
  }
})

Is the idea that it could be less verbose because you normally will need to import this function from a file anyways? Maybe we could accept a function (or array of functions), but still, allow to pass a file name as a shortcut? (with the same API as you propose, but it looks better as an optional shortcut than as the API for this feature to me... but maybe everyone is very used to using files for this purpose)

dominikg · 2021-12-30T14:45:55Z

i did take a cue from jests feature which uses files (likely because their config can also be json) and it aligns with vitest's own setupFiles

Directly using a function in config would simplify the internal implementation which i like a lot. But then you'd have to use regular imports for all the things you want/need in setup and that could bloat the config itself. I'm leaning towards the file approach due to prior art and dx result.

But if using the function approach enables ts support without extra work and the bloat is not an issue i'm all for it. in the end jest users can write a simple wrapper around their existing files and import that

patak-dev · 2021-12-30T16:11:59Z

What about providing both ways? (both in setupFiles and globalSetup). You can pass a setup function (with optional cleanup as a return param) or a module path if that is more comfortable (or a list of these). I know this will be two ways to do the same things, but seeing the module path as a shortcut for the real function seems a good way to justify it (and also due to compat). We could maybe avoid the named exports in the module version and only accept the default export form to simplify the API?
@antfu do you have a preference here?

antfu · 2021-12-30T16:43:38Z

The setupFiles can't be an inline function as it is supposed to be running in each worker with different environments. For globalSetup I see no problem with that.

dominikg · 2021-12-30T19:50:23Z

implementation as function here: https://github.com/dominikg/vitest/tree/feat/global-setup-function

the complexity in vitest is greatly reduced, except for this little "hack": https://github.com/dominikg/vitest/blob/22c5ec2ef05c4001ffaff43d581914c2328e2e62/packages/vitest/src/node/pool.ts#L80

Unfortunately stacktraces don't look great when globalSetup gets bundled into the config:

20:26 $ pnpm test

> @vitest/test-globalSetup@ test /home/dominikg/develop/vitest/test/global-setup
> vitest

file:///home/dominikg/develop/vitest/test/global-setup/vitest.config.ts.js?t=1640892430013:9
  throw new Error("ooops");
        ^

Error: ooops
    at vitest_global_setup_default (file:///home/dominikg/develop/vitest/test/global-setup/vitest.config.ts.js?t=1640892430013:9:9)

this is not good and i'd rather have a stacktrace referencing the correct files and lines. Is that something that can be improved in vite's config bundling?

mitchelvanbever · 2022-01-04T06:59:23Z

docs/config/index.md

+- **Type:** `string | string[]`
+
+Path to global setup files, relative to project root
+```js


The setup file entry doesn't have an example of how to use the setting. Might consider removing it here (or we might end up needing to put examples for each rule.

mitchelvanbever · 2022-01-04T07:01:05Z

docs/config/index.md

+}
+```
+
+Multiple globalSetup files are possible. setup and teardown are executed sequentially with teardown in reverse order.


Maybe adding a callout to this will do it a little more justice 🙂

mitchelvanbever · 2022-01-04T07:03:20Z

docs/config/index.md

+}
+```
+
+Files can either export named functions


Suggested change

Files can either export named functions

Example

mitchelvanbever · 2022-01-04T07:03:48Z

docs/config/index.md

+```
+
+or a setup function as default that returns the teardown
+```js


Could be all in one example (divised by comments to show the different approaches

…import.

…nning

…r handling

…tead of showing examples inline

antfu · 2022-01-10T08:48:24Z

Let's ship it for now, and we can see how we could improve the stacktrace later.

dominikg · 2022-01-10T09:15:27Z

The stacktraces in this PR should be fine. I'm still a bit worried about the intermittent test failures. Havn't been able to reliably reproduce/debug it unfortunately as it only happens on windows and trying to get to the bottom of a possible v8 issue inside a virtual machine running windows hasn't been a great experience at all.

maybe @userquin has an idea?

Steps to try to reproduce:

checkout this PR
run pnpm i && pnpm build
run pnpm test:ci

sometimes it fails with an error like this (different testcases)

examples/vue test: FATAL ERROR: v8::FromJust Maybe value is Nothing.
examples/vue test:  1: 00007FF63D8E30AF v8::internal::CodeObjectRegistry::~CodeObjectRegistry+112511
examples/vue test:  2: 00007FF63D872216 DSA_meth_get_flags+65542
examples/vue test:  3: 00007FF63D8730CD node::OnFatalError+301
examples/vue test:  4: 00007FF63E18F4C5 v8::V8::FromJustIsNothing+53
examples/vue test:  5: 00007FF63D85B203 v8::base::CPU::has_sse+31491
examples/vue test:  6: 00007FF63D945BF7 uv_timer_stop+1207
examples/vue test:  7: 00007FF63D9421CB uv_async_send+331
examples/vue test:  8: 00007FF63D94195C uv_loop_init+1292
examples/vue test:  9: 00007FF63D941AFA uv_run+202
examples/vue test: 10: 00007FF63D910C05 node::SpinEventLoop+309
examples/vue test: 11: 00007FF63D7AB4D0 v8::internal::wasm::SignatureMap::Freeze+35776
examples/vue test: 12: 00007FF63D7A6B28 v8::internal::wasm::SignatureMap::Freeze+16920
examples/vue test: 13: 00007FF63D9322DD uv_poll_stop+557
examples/vue test: 14: 00007FF63E743DF0 v8::internal::compiler::RepresentationChanger::Uint32OverflowOperatorFor+146416
examples/vue test: 15: 00007FFC64087034 BaseThreadInitThunk+20
examples/vue test: 16: 00007FFC64E82651 RtlUserThreadStart+33
examples/vue test: Failed
undefined

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [vitest](https://github.com/vitest-dev/vitest) | devDependencies | patch | [`0.0.139` -> `0.0.140`](https://renovatebot.com/diffs/npm/vitest/0.0.139/0.0.140) | --- ### Release Notes <details> <summary>vitest-dev/vitest</summary> ### [`v0.0.140`](https://github.com/vitest-dev/vitest/releases/v0.0.140) [Compare Source](vitest-dev/vitest@v0.0.139...v0.0.140) ##### Bug Fixes - inline snapshot if not called inside suite ([6d743c5](vitest-dev/vitest@6d743c5)), closes [#484](vitest-dev/vitest#484) - **ui:** flex / percentage based layout ([#492](vitest-dev/vitest#492)) ([c43ebaf](vitest-dev/vitest@c43ebaf)) - correctly inline shapshot with properties ([4603ffd](vitest-dev/vitest@4603ffd)) - mocking is lost with threads: false ([28b97d8](vitest-dev/vitest@28b97d8)), closes [#482](vitest-dev/vitest#482) - Reflect.get called on non-object ([3c9073a](vitest-dev/vitest@3c9073a)), closes [#479](vitest-dev/vitest#479) - snapshot ignores indentation ([aff1481](vitest-dev/vitest@aff1481)) - **ui:** reduce graph container size ([#478](vitest-dev/vitest#478)) ([23e1e62](vitest-dev/vitest@23e1e62)) ##### Features - global setup ([#372](vitest-dev/vitest#372)) ([eaa119f](vitest-dev/vitest@eaa119f)) - **ui:** tasks state group ([7782e7d](vitest-dev/vitest@7782e7d)) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Reviewed-on: https://kolaente.dev/vikunja/frontend/pulls/1348 Co-authored-by: renovate <renovatebot@kolaente.de> Co-committed-by: renovate <renovatebot@kolaente.de>

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

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.

Here's the playground where the error is reproduced.

patak-dev · 2022-01-13T16:21:41Z

@bhvngt could you create an issue with this info so it is easier to track it?

bhvngt · 2022-01-13T16:40:05Z

@patak-dev #522

…vitest-dev#372 (vitest-dev#373)

dominikg force-pushed the feat/globalSetup branch 2 times, most recently from 543a61a to cb2710a Compare January 3, 2022 09:27

mitchelvanbever suggested changes Jan 4, 2022

View reviewed changes

dominikg force-pushed the feat/globalSetup branch from 3ac952a to d372de5 Compare January 4, 2022 11:08

mitchelvanbever approved these changes Jan 4, 2022

View reviewed changes

dominikg force-pushed the feat/globalSetup branch from 6d56a1b to 46d2eed Compare January 5, 2022 09:01

dominikg added 7 commits January 5, 2022 15:04

feat: global setup

7e2e349

fix: use ssrLoadModule to load global setup files instead of dynamic …

5c1dc58

…import.

test: implement testcase verifying that server started in setup is ru…

061dd6c

…nning

test: remove throwing errors in teardown examples

d63c94c

fix: add ssr.noExternal: true to config for globalSetup, improve erro…

d2f96d0

…r handling

docs: update globalSetup docs to reduce verbosity, link to config ins…

6c3c2ad

…tead of showing examples inline

fix: update lockfile

0f48694

dominikg force-pushed the feat/globalSetup branch from 46d2eed to 0f48694 Compare January 5, 2022 14:06

antfu added 2 commits January 10, 2022 16:43

Merge branch 'main' into pr/dominikg/372

ba35d24

chore: update

62d95d5

antfu approved these changes Jan 10, 2022

View reviewed changes

antfu merged commit eaa119f into vitest-dev:main Jan 10, 2022

chaii3 pushed a commit to chaii3/vitest that referenced this pull request May 13, 2022

feat(useWebWorker): allow provide WorkerOptions for the Worker, closes …

0c04f2b

…vitest-dev#372 (vitest-dev#373)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: global setup #372

feat: global setup #372

dominikg commented Dec 30, 2021 •

edited

netlify bot commented Dec 30, 2021 •

edited

patak-dev commented Dec 30, 2021

dominikg commented Dec 30, 2021

patak-dev commented Dec 30, 2021

antfu commented Dec 30, 2021

dominikg commented Dec 30, 2021 •

edited

mitchelvanbever Jan 4, 2022

mitchelvanbever Jan 4, 2022

mitchelvanbever Jan 4, 2022

mitchelvanbever Jan 4, 2022

antfu commented Jan 10, 2022

dominikg commented Jan 10, 2022

bhvngt commented Jan 13, 2022

patak-dev commented Jan 13, 2022

bhvngt commented Jan 13, 2022

feat: global setup #372

feat: global setup #372

Conversation

dominikg commented Dec 30, 2021 • edited

netlify bot commented Dec 30, 2021 • edited

patak-dev commented Dec 30, 2021

dominikg commented Dec 30, 2021

patak-dev commented Dec 30, 2021

antfu commented Dec 30, 2021

dominikg commented Dec 30, 2021 • edited

mitchelvanbever Jan 4, 2022

Choose a reason for hiding this comment

mitchelvanbever Jan 4, 2022

Choose a reason for hiding this comment

mitchelvanbever Jan 4, 2022

Choose a reason for hiding this comment

mitchelvanbever Jan 4, 2022

Choose a reason for hiding this comment

antfu commented Jan 10, 2022

dominikg commented Jan 10, 2022

bhvngt commented Jan 13, 2022

patak-dev commented Jan 13, 2022

bhvngt commented Jan 13, 2022

dominikg commented Dec 30, 2021 •

edited

netlify bot commented Dec 30, 2021 •

edited

dominikg commented Dec 30, 2021 •

edited