Custom Pool

WARNING

这是高级 API。如果你只想要运行测试，你可能不需要这个。它主要被库的作者使用。

Vitest 在默认情况下以多种方式运行测试：

threads 使用 node:worker_threads 运行测试（通过新的 worker 上下文提供隔离）
forks 使用 node:child_process 运行测试（通过新的 child_process.fork 进程提供隔离）
vmThreads 使用 node:worker_threads 运行测试（但是通过 vm 模块而不是新的 worker 上下文提供隔离）
browser 使用浏览器提供程序运行测试
typescript 在测试中运行类型检查

你可以通过指定文件路径来提供自己的池：

import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    // 默认情况下，将使用自定义池运行每个文件
    pool: './my-custom-pool.ts',
    // 可以使用 `poolOptions` 对象提供选项
    poolOptions: {
      myCustomPool: {
        customProperty: true,
      },
    },
    // 还可以为文件子集指定池
    poolMatchGlobs: [['**/*.custom.test.ts', './my-custom-pool.ts']],
  },
})

API

在 pool 选项中指定的文件应该导出一个函数（可以是异步的），该函数接受 Vitest 接口作为其第一个选项。这个函数需要返回一个与 ProcessPool 接口匹配的对象：

import { ProcessPool, WorkspaceProject } from 'vitest/node'

export interface ProcessPool {
  name: string
  runTests: (
    files: [project: WorkspaceProject, testFile: string][],
    invalidates?: string[]
  ) => Promise<void>
  collectTests: (
    files: [project: WorkspaceProject, testFile: string][],
    invalidates?: string[]
  ) => Promise<void>
  close?: () => Promise<void>
}

这个函数只会被调用一次（除非服务器配置被更新），通常最好在这个函数内初始化测试所需的一切，并在调用 runTests 时重复使用它。

Vitest 在安排运行新测试时调用 runTest。如果 files 为空，将不会调用它。第一个参数是一个元组数组：第一个元素是对工作区项目的引用，第二个元素是测试文件的绝对路径。在调用 runTests 之前，文件将使用 sequencer 进行排序。可能（但不太可能）会有相同的文件出现两次，但它们将始终属于不同的项目 - 这是通过 vitest.workspace.ts 配置实现的。

Vitest 会等到 runTests 执行完毕后才结束运行（即只有在 runTests 解决后才会触发 onFinished）。

如果你正在使用自定义池，需要自行提供测试文件及其结果 - 可以参考 vitest.state（最重要的是 collectFiles 和 updateTasks）。Vitest 使用 @vitest/runner 包中的 startTests 函数来执行这些操作。

如果通过 CLI 命令调用 vitest.collect 或 vitest list，则 Vitest 将调用 collectTests。它的工作方式与 runTests 相同，但你不必运行测试回调，只需通过调用 vitest.state.collectFiles(files) 来报告它们的任务。

要在不同的进程之间进行通信，可以使用 vitest/node 中的 createMethodsRPC 创建方法对象，并使用你喜欢的任何形式的通信。例如，要将 WebSockets 与 birpc 一起使用，你可以编写以下内容：

import { createBirpc } from 'birpc'
import { parse, stringify } from 'flatted'
import { createMethodsRPC, WorkspaceProject } from 'vitest/node'

function createRpc(project: WorkspaceProject, wss: WebSocketServer) {
  return createBirpc(createMethodsRPC(project), {
    post: msg => wss.send(msg),
    on: fn => wss.on('message', fn),
    serialize: stringify,
    deserialize: parse,
  })
}

为了确保收集每个测试，你可以调用 ctx.state.collectFiles 并将其交给 Vitest 报告器：

async function runTests(project: WorkspaceProject, tests: string[]) {
  // ... 运行测试，放入 `files` 和 `tasks` 中
  const methods = createMethodsRPC(project)
  await methods.onCollected(files)
  // 大多数报告都依赖于在 `onTaskUpdate` 中更新结果
  await methods.onTaskUpdate(tasks)
}

可以在 pool/custom-pool.ts 中看到一个简单的示例。

Custom Pool ​

API ​

Custom Pool

API