chore: inject executor

vitest-dev · sheremet-va · Feb 13, 2023 · Feb 13, 2023 · Feb 13, 2023 · Feb 13, 2023
commit c033b2bad49546caf9727c14322acba5b9549b78
diff --git a/docs/advanced/runner.md b/docs/advanced/runner.md
@@ -83,9 +83,11 @@ export interface VitestRunner {
 }
 ```
 
-When initiating this class, Vitest passes down Vitest config, - you should expose it as a `config` property, and test executor, which is an instance of `ViteNodeRunner`.
+When initiating this class, Vitest passes down Vitest config, - you should expose it as a `config` property.
 
 ::: warning
+Vitest also injects an instance of `ViteNodeRunner` as `__vitest_executor` property. You can use it to process files in `importFile` method (this is default behavior of `TestRunner`` and `BenchmarkRunner`).
+
 `ViteNodeRunner` exposes `executeId` method, which is used to import test files in a Vite-friendly environment. Meaning, it will resolve imports and transform file content at runtime so that Node can understand it.
 :::
 

diff --git a/packages/runner/package.json b/packages/runner/package.json
@@ -37,9 +37,6 @@
     "dev": "rollup -c --watch",
     "prepublishOnly": "pnpm build"
   },
-  "peerDependencies": {
-    "vite-node": "*"
-  },
   "dependencies": {
     "@vitest/utils": "workspace:*",
     "p-limit": "^4.0.0",

diff --git a/packages/runner/rollup.config.js b/packages/runner/rollup.config.js
@@ -8,7 +8,6 @@ const external = [
   ...builtinModules,
   ...Object.keys(pkg.dependencies || {}),
   ...Object.keys(pkg.peerDependencies || {}),
-  'vite-node/client',
 ]
 
 const entries = {

diff --git a/packages/runner/src/types/runner.ts b/packages/runner/src/types/runner.ts
@@ -1,4 +1,3 @@
-import type { ViteNodeRunner } from 'vite-node/client'
 import type { File, SequenceHooks, Suite, TaskResult, Test, TestContext } from './tasks'
 
 export interface VitestRunnerConfig {
@@ -21,7 +20,7 @@ export interface VitestRunnerConfig {
 export type VitestRunnerImportSource = 'collect' | 'setup'
 
 export interface VitestRunnerConstructor {
-  new (config: VitestRunnerConfig, executor: ViteNodeRunner): VitestRunner
+  new (config: VitestRunnerConfig): VitestRunner
 }
 
 export interface VitestRunner {

diff --git a/packages/vitest/src/runtime/entry.ts b/packages/vitest/src/runtime/entry.ts
@@ -13,6 +13,8 @@ import { setupGlobalEnv, withEnv } from './setup.node'
 import { rpc } from './rpc'
 import type { VitestExecutor } from './execute'
 
+const runnersFile = resolve(distDir, 'runners.js')
+
 function groupBy<T, K extends string | number | symbol>(collection: T[], iteratee: (item: T) => K) {
   return collection.reduce((acc, item) => {
     const key = iteratee(item)
@@ -24,7 +26,7 @@ function groupBy<T, K extends string | number | symbol>(collection: T[], iterate
 
 async function getTestRunnerConstructor(config: ResolvedConfig, executor: VitestExecutor): Promise<VitestRunnerConstructor> {
   if (!config.runner) {
-    const { VitestTestRunner, NodeBenchmarkRunner } = await executor.executeFile(resolve(distDir, 'runners.js'))
+    const { VitestTestRunner, NodeBenchmarkRunner } = await executor.executeFile(runnersFile)
     return (config.mode === 'test' ? VitestTestRunner : NodeBenchmarkRunner) as VitestRunnerConstructor
   }
   const mod = await executor.executeId(config.runner)
@@ -35,7 +37,14 @@ async function getTestRunnerConstructor(config: ResolvedConfig, executor: Vitest
 
 async function getTestRunner(config: ResolvedConfig, executor: VitestExecutor): Promise<VitestRunner> {
   const TestRunner = await getTestRunnerConstructor(config, executor)
-  const testRunner = new TestRunner(config, executor)
+  const testRunner = new TestRunner(config)
+
+  // inject private executor to every runner
+  Object.defineProperty(testRunner, '__vitest_executor', {
+    value: executor,
+    enumerable: false,
+    configurable: false,
+  })
 
   if (!testRunner.config)
     testRunner.config = config

diff --git a/packages/vitest/src/runtime/runners/benchmark.ts b/packages/vitest/src/runtime/runners/benchmark.ts
@@ -122,12 +122,14 @@ async function runBenchmarkSuite(suite: Suite, runner: VitestRunner) {
 }
 
 export class NodeBenchmarkRunner implements VitestRunner {
-  constructor(public config: ResolvedConfig, private executor: VitestExecutor) {}
+  private __vitest_executor!: VitestExecutor
+
+  constructor(public config: ResolvedConfig) {}
 
   importFile(filepath: string, source: VitestRunnerImportSource): unknown {
     if (source === 'setup')
       getWorkerState().moduleCache.delete(filepath)
-    return this.executor.executeId(filepath)
+    return this.__vitest_executor.executeId(filepath)
   }
 
   async runSuite(suite: Suite): Promise<void> {

diff --git a/packages/vitest/src/runtime/runners/test.ts b/packages/vitest/src/runtime/runners/test.ts
@@ -10,13 +10,14 @@ import type { VitestExecutor } from '../execute'
 export class VitestTestRunner implements VitestRunner {
   private snapshotClient = getSnapshotClient()
   private workerState = getWorkerState()
+  private __vitest_executor!: VitestExecutor
 
-  constructor(public config: ResolvedConfig, private executor: VitestExecutor) {}
+  constructor(public config: ResolvedConfig) {}
 
   importFile(filepath: string, source: VitestRunnerImportSource): unknown {
     if (source === 'setup')
       this.workerState.moduleCache.delete(filepath)
-    return this.executor.executeId(filepath)
+    return this.__vitest_executor.executeId(filepath)
   }
 
   onBeforeRun() {