fix: create environment once per worker with isolate: false (#8915)

Author: sheremet-va

packages/browser/src/client/client.ts

@@ -20,10 +20,11 @@ export const ENTRY_URL: string = `${
   location.protocol === 'https:' ? 'wss:' : 'ws:'
 }//${HOST}/__vitest_browser_api__?type=${PAGE_TYPE}&rpcId=${RPC_ID}&sessionId=${getBrowserState().sessionId}&projectName=${getBrowserState().config.name || ''}&method=${METHOD}&token=${(window as any).VITEST_API_TOKEN || '0'}`
 
-let setCancel = (_: CancelReason) => {}
-export const onCancel: Promise<CancelReason> = new Promise((resolve) => {
-  setCancel = resolve
-})
+const onCancelCallbacks: ((reason: CancelReason) => void)[] = []
+
+export function onCancel(callback: (reason: CancelReason) => void): void {
+  onCancelCallbacks.push(callback)
+}
 
 export interface VitestBrowserClient {
   rpc: BrowserRPC
@@ -74,7 +75,9 @@ function createClient() {
 
   ctx.rpc = createBirpc<WebSocketBrowserHandlers, WebSocketBrowserEvents>(
     {
-      onCancel: setCancel,
+      async onCancel(reason) {
+        await Promise.all(onCancelCallbacks.map(fn => fn(reason)))
+      },
       async createTesters(options) {
         const orchestrator = await waitForOrchestrator()
         return orchestrator.createTesters(options)

packages/browser/src/client/tester/runner.ts

@@ -312,7 +312,7 @@ export async function initiateRunner(
   })
   cachedRunner = runner
 
-  onCancel.then((reason) => {
+  onCancel((reason) => {
     runner.cancel?.(reason)
   })
 

packages/browser/src/client/tester/state.ts

@@ -8,6 +8,7 @@ const sessionId = getBrowserState().sessionId
 
 const state: WorkerGlobalState = {
   ctx: {
+    rpc: null as any,
     pool: 'browser',
     workerId: 1,
     config,

packages/browser/src/client/tester/tester.ts

@@ -103,6 +103,7 @@ async function prepareTestEnvironment(options: PrepareOptions) {
 
   state.metaEnv = import.meta.env
   state.onCancel = onCancel
+  state.ctx.rpc = rpc as any
   state.rpc = rpc as any
 
   const interceptor = createModuleMockerInterceptor()
@@ -253,7 +254,6 @@ async function cleanup() {
     await rpc.wdioSwitchContext('parent')
       .catch(error => unhandledError(error, 'Cleanup Error'))
   }
-  state.environmentTeardownRun = true
   await stopCoverageInsideWorker(config.coverage, moduleRunner, { isolate: config.browser.isolate }).catch((error) => {
     return unhandledError(error, 'Coverage Error')
   })

packages/ui/client/components/dashboard/ErrorEntry.vue

@@ -30,15 +30,4 @@ defineProps<{
       </li>
     </ul>
   </div>
-  <div v-if="error.VITEST_AFTER_ENV_TEARDOWN" text="sm" font-thin>
-    This error was caught after test environment was torn down. Make sure to cancel any running tasks before test finishes:<br>
-    <ul>
-      <li>
-        Cancel timeouts using clearTimeout and clearInterval.
-      </li>
-      <li>
-        Wait for promises to resolve using the await keyword.
-      </li>
-    </ul>
-  </div>
 </template>

packages/ui/client/shim.d.ts

@@ -9,6 +9,5 @@ declare interface Window {
 
 declare interface Error {
   VITEST_TEST_NAME?: string
-  VITEST_AFTER_ENV_TEARDOWN?: boolean
   VITEST_TEST_PATH?: string
 }

packages/vitest/src/integrations/env/jsdom.ts

@@ -7,6 +7,7 @@ function catchWindowErrors(window: DOMWindow) {
   let userErrorListenerCount = 0
   function throwUnhandlerError(e: ErrorEvent) {
     if (userErrorListenerCount === 0 && e.error != null) {
+      e.preventDefault()
       process.emit('uncaughtException', e.error)
     }
   }

packages/vitest/src/integrations/env/loader.ts

@@ -1,6 +1,6 @@
 import type { BuiltinEnvironment, VitestEnvironment } from '../../node/types/config'
 import type { Environment } from '../../types/environment'
-import type { ContextRPC, WorkerRPC } from '../../types/worker'
+import type { WorkerRPC } from '../../types/worker'
 import { readFileSync } from 'node:fs'
 import { isBuiltin } from 'node:module'
 import { pathToFileURL } from 'node:url'
@@ -54,14 +54,13 @@ export async function createEnvironmentLoader(root: string, rpc: WorkerRPC): Pro
 }
 
 export async function loadEnvironment(
-  ctx: ContextRPC,
+  name: string,
+  root: string,
   rpc: WorkerRPC,
 ): Promise<{ environment: Environment; loader?: ModuleRunner }> {
-  const name = ctx.environment.name
   if (isBuiltinEnvironment(name)) {
     return { environment: environments[name] }
   }
-  const root = ctx.config.root
   const loader = await createEnvironmentLoader(root, rpc)
   const packageId
     = name[0] === '.' || name[0] === '/'

packages/vitest/src/node/pool.ts

@@ -147,15 +147,12 @@ export function createPool(ctx: Vitest): ProcessPool {
 
         taskGroup.push({
           context: {
-            pool,
-            config: project.serializedConfig,
             files: specs.map(spec => ({ filepath: spec.moduleId, testLocations: spec.testLines })),
             invalidates,
-            environment,
-            projectName: project.name,
             providedContext: project.getProvidedContext(),
             workerId: workerId++,
           },
+          environment,
           project,
           env,
           execArgv,

packages/vitest/src/node/pools/pool.ts

@@ -208,7 +208,7 @@ export class Pool {
       distPath: this.options.distPath,
       project: task.project,
       method,
-      environment: task.context.environment.name,
+      environment: task.environment,
       env: task.env,
       execArgv: task.execArgv,
     }
@@ -280,7 +280,7 @@ function isEqualRunner(runner: PoolRunner, task: PoolTask) {
   return (
     runner.worker.name === task.worker
     && runner.project === task.project
-    && runner.environment === task.context.environment.name
+    && runner.environment.name === task.environment.name
     && (!runner.worker.canReuse || runner.worker.canReuse(task))
   )
 }