Vitest Release Notes

Features

• Return a disposable from doMock() - by @kirkwaiblinger in #9332 (e3e65)
• Added chai style assertions for spying - by @ronnakamoto and @sheremet-va in #8842 (841df)
• Update to sinon/fake-timers v15 and add setTickMode to timer controls - by @atscott and @sheremet-va in #8726 (4b480)

api:

• Support tests starting or ending with test in experimental_parseSpecification - by @jgillick and Jeremy Gillick in #9235 (2f367)
• Add filters to createSpecification - by @sheremet-va in #9336 (c8e6c)
• Expose runTestFiles as alternative to runTestSpecifications - by @sheremet-va in #9443 (43d76)

browser:

• Add userEvent.wheel API - by @macarie in #9188 (66080)

coverage:

• Support ignore start/stop ignore hints - by @AriPerkkio in #9204 (e59c9)

experimental:

• Add onModuleRunner hook to worker.init - by @sheremet-va in #9286 (e977f)

runner:

• Enhance retry options - by @MazenSamehR, Matan Shavit, @AriPerkkio and @sheremet-va in #9370 (9e4cf)

🐞 Bug Fixes

• Deprecate several vitest/* entry points - by @sheremet-va in #9347 (fd459)
• Use meta.url in createRequire - by @sheremet-va in #9441 (e3422)
• Preact browser mode init example of render function not async - by @WuMingDao in #9375 (2bea5)
• browser: Avoid updating screenshots when toMatchScreenshot passes - by @macarie in #9289 (46aab)
• coverage: Infer transform mode for uncovered files - by @AriPerkkio in #9435 (f3967)
• deps: Update all non-major dependencies - by @hi-ogawa in #9192 (90c30)

View changes on GitHub

Original source Report a problem

🚀 Experimental Features

• Support openTelemetry for browser mode - by @hi-ogawa in #9180 (1ec3a)
• Support TRACEPARENT and TRACESTATE environment variables for OpenTelemetry context propagation - by @Copilot, hi-ogawa and @hi-ogawa in #9295 (876cb)

🐞 Bug Fixes

• Improve asymmetric matcher diff readability by unwrapping container matchers - by @Copilot, sheremet-va, hi-ogawa and @hi-ogawa in #9330 (b2ec7)
• Improve runner error when importing outside of test context - by @sheremet-va in #9335 (2dd3d)
• Replace crypto.randomUUID to allow insecure environments (fix #9… - by @plusgut in #9339 and #9 (e6a3f)
• Handle null options in addEventHandler #9371 - by @ThibautMarechal in #9372 and #9371 (40841)
• Typo in browser.provider error - by @deammer in #9394 (4b67f)

browser:

• Fix process.env and import.meta.env defines in inline project - by @hi-ogawa in #9239 (b70c9)
• Fix upload File instance - by @hi-ogawa in #9294 (b6778)
• Fix invalid project token for artifacts assets - by @hi-ogawa in #9321 (caa7d)
• Log ErrorEvent.message when unhandled ErrorEvent.error is null - by @hi-ogawa in #9322 (5d84e)
• Support fileParallelism on an instance - by @sheremet-va in #9328 (15006)

coverage:

• Remove unnecessary istanbul-lib-source-maps usage - by @AriPerkkio in #9344 (b0940)
• Apply patch from istanbuljs/istanbuljs#837 - by @AriPerkkio and sapphi-red in #9413 and #837 (e05ce)

fsModuleCache:

• Don't store importers in cache - by @sheremet-va in #9422 (75136)
• Add importers alongside importedModules - by @sheremet-va in #9423 (59f92)

mocker:

• Fix mock transform with class - by @hi-ogawa in #9421 (d390e)

pool:

• Validate environment options when reusing the worker - by @sheremet-va in #9349 (a8a88)
• Handle worker start failures gracefully - by @AriPerkkio in #9337 (200da)

reporter:

• Report test module if it failed to run - by @sheremet-va in #9272 (c7888)

runner:

• Respect nested test.only within describe.only - by @Ujjwaljain16 in #9021 and #9213 (55d5d)

typecheck:

• Improve error message when tsc outputs help text - by @Ujjwaljain16 in #9214 (7b10a)

ui:

• Detect gzip by magic numbers instead of Content-Type header in html reporter - by @Copilot, hi-ogawa and @hi-ogawa in #9278 (dd033)

webdriverio:

• Fall back to WebDriver Classic #9244 - by @JustasMonkev in #9373 and #9244 (c23dd)

View changes on GitHub

Original source Report a problem

🐞 Bug Fixes

• Fix browser mode default testTimeout back to 15 seconds - by @hi-ogawa in #9167 (da0ad)
• Avoid crashing on process.versions stub - by @AriPerkkio in #9174 (78cfb)
• Reject calling suite function inside test - by @hi-ogawa in #9198 (1a259)
• Allow inlining fully dynamic import - by @hi-ogawa in #9137 (56851)
• Fix module graph UI on html reporter with headless browser mode - by @hi-ogawa in #9219 (60642)
• Log deprecated test.poolOptions if it's set - by @sheremet-va in #9226 (f7f6a)
• View changes on GitHub

browser:

• Import recordArtifact from the vitest package - by @macarie in #9186 (01c56)
• Fix import.meta.env define - by @hi-ogawa in #9205 (01a9a)
• String formatting bug when including placeholders in console.log - by @michael-debs and @hi-ogawa in #9030 and #9131 (84a30)

coverage:

• Istanbul untested files source maps are off - by @AriPerkkio in #9208 (372e8)

experimental:

• Export setupEnvironment for custom pools - by @AriPerkkio in #9187 (5d26b)

• View changes on GitHub

Original source Report a problem

🚀 Experimental Features

• cache: Add opt-out on a plugin level, fix internal root cache - by @sheremet-va in #9154 (a68f7)
• reporters: Print import duration breakdown - by @sheremet-va in #9105 (122ff)

🐞 Bug Fixes

• Keep built-in id as is in bun and deno - by @sheremet-va in #9117 (075ab)
• Use optimizeDeps.rolldownOptions to fix depreated warning + fix ssr.external: true - by @hi-ogawa in #9121 (fd8bd)
• Fix external behavior with deps.optimizer - by @hi-ogawa in #9125 (4c754)
• Very minor typo in "Chrome DevTools Protocol" - by @HowToTestFrontend in #9146 (20997)
• browser: Run toMatchScreenshot only once when used with expect.element - by @macarie in #9132 (0d2e7)
• coverage: Istanbul provider to not break source maps - by @AriPerkkio in #9040 (e4ca9)
• deps: Update dependency tinyexec to v1 - in #9122 (fd786)
• docs: Remove --browser.provider from docs - by @sheremet-va in #9115 (120b3)
• expect: Preserve currentTestName in extended matchers - by @macarie in #9106 (e4345)
• pool: Terminate workers on CTRL+c forceful exits - by @AriPerkkio in #9140 (d57d8)
• reporters: Show project in github reporter - by @sheremet-va in #9138 (bb65e)
• spy: Do not mock overriden method, if parent was automocked - by @sheremet-va in #9116 (1a246)
• web-worker: MessagePort objects passed to Worker.postMessage work when clone === "native" - by @whitphx in #9118 (deee8)

View changes on GitHub

Original source Report a problem

🚀 Experimental Features

• browser: Expose utils.configurePrettyDOM - by @sheremet-va in #9103 (2cc34)
• runner: Add full names to tasks - by @macarie in #9087 (821aa)
• ui: Add tabbed failure view for toMatchScreenshot with comparison slider - by @macarie in #8813 (c37c2)

🐞 Bug Fixes

• Externalize before caching - by @sheremet-va in #9077 (e1b2e)

• Collect the duration of external imports - by @sheremet-va in #9097 (3326c)

• Rename collect to import, remove prepare - by @sheremet-va in #9091 (1256b)

• browser:

  • Unsubscribe onCancel on rpc destroy - by @AriPerkkio in #9088 (f5b72)
  • Revert the viewport scaling in non-ui mode #9018 - by @sheremet-va in #9072 and #9018 (64502)

• coverage:

  • Invalidate circular modules correctly on rerun with coverage - by @aicest in #9096 (6f22c)

• expect:

  • Allow function as standard schema - by @hi-ogawa in #9099 (ed8a2)

• jsdom:

  • Reuse abort signals if possible - by @sheremet-va in #9090 (2c468)

• pool:

  • Init VITEST_POOL_ID + VITEST_WORKER_ID before environment setup - by @AriPerkkio in #9085 (37918)

• web-worker:

  • postMessage to send ports to workers - by @whitphx and @AriPerkkio in #9078 (9d176)

🏎 Performance

• Replace debug with obug - by @sxzz and @AriPerkkio in #9057 (acc51)

• View changes on GitHub

Original source Report a problem

Experimental Features

• api: Add extensible test artifact API - by @macarie in #8987 (77292)
• See more at https://vitest.dev/api/advanced/artifacts
• expect: Provide task in MatchState - by @macarie in #9022 (afd1f)
• experimental: Support OpenTelemetry traces - by @sheremet-va in #8994 (d6d33)
• See more at https://vitest.dev/guide/open-telemetry

Performance

• experimental: Add file system cache - by @sheremet-va in #9026 (1b147)
• See more at https://vitest.dev/config/experimental#experimental-fsmodulecache
• View changes on GitHub

Original source Report a problem

🐞 Bug Fixes

browser

• Don't scale the iframe if UI is disabled - by @sheremet-va in #9018 (5406e)
• Handle dependency stack traces with external source maps. Resolves: #9003 - by @iclectic in #9016 and #9003 (57ae5)

bun

• Parsing of stack trace for bun runtime - by @nazarhussain in #9032 (f3ec6)

core

• Prevent starting new run when cancelling - by @AriPerkkio in #8991 (eb98d)

pool

• Prevent writing to closed worker - by @AriPerkkio and @sheremet-va in #9023 (042c6)

reporters

• Report correct test run duration at the end - by @sheremet-va in #8969 (bc3a6)

ui

• Use execution time from ws reporter (onFinished) - by @userquin in #8975 (f56dc)

View changes on GitHub

Original source Report a problem