Skip to content

Latest commit

 

History

History
201 lines (150 loc) · 5.96 KB

improving-performance.md

File metadata and controls

201 lines (150 loc) · 5.96 KB
Raw
title
性能优化 | 指南

性能优化

测试隔离

默认情况下，Vitest 在基于pool 的隔离环境中运行每个测试文件：

  • threads 池在单独的 Worker 中运行每个测试文件
  • forks 池在单独的 forked child process 中运行每个测试文件
  • vmThreads 池在单独的 VM context 中运行每个测试文件，但它并行工作

这大大增加了测试时间，这对于不依赖副作用并正确清理其状态的项目来说可能是不可取的（对于具有 node 环境的项目来说通常是这样）。在这种情况下，禁用隔离将提高测试的速度。要做到这一点，你可以向 CLI 提供 --no-isolate 标志，或者将 config 中的test.isolate 属性设置为 false。如果你使用 poolMatchGlobs 同时使用多个池，你还可以禁用正在使用的特定池的隔离。

::: code-group

vitest --no-isolate
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    isolate: false,
    // 你还可以仅对特定池禁用隔离
    poolOptions: {
      forks: {
        isolate: false,
      },
    },
  },
})

:::

:::tip 如果使用的是 vmThreads 池，则不能禁用隔离。请改用 threads 池来提高测试性能。 :::

对于某些项目，可能还需要禁用并行性以缩短启动时间。为此，请向 CLI 提供 --no-file-parallelism 标志，或将 config 中的test.fileParallelism 属性设置为 false。

::: code-group

vitest --no-file-parallelism
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    fileParallelism: false,
  },
})

:::

Pool

默认情况下，Vitest 在 pool: 'forks' 中运行测试。虽然 'forks' 池更适合解决兼容性问题（hanging process 和segfaults），但在较大的项目中，它可能比 pool: 'threads' 稍慢。

你可以尝试通过切换配置中的 pool 选项来改善测试运行时间：

::: code-group

vitest --pool=threads
import { defineConfig } from 'vitest/config'

export default defineConfig({
  test: {
    pool: 'threads',
  },
})

:::

Sharding

测试分片意味着一次运行一小部分测试用例。当你有多台可用于同时运行测试的机器时，它会很有用。

要在多个不同的运行中拆分 Vitest 测试，请将 --shard 选项与 --reporter=blob 选项一起使用：

vitest run --reporter=blob --shard=1/3 # 1st machine
vitest run --reporter=blob --shard=2/3 # 2nd machine
vitest run --reporter=blob --shard=3/3 # 3rd machine

从每台计算机收集存储在 .vitest-reports 目录中的结果，并使用 --merge-reports 选项将其合并：

vitest --merge-reports
Github action example

This setup is also used at https://github.com/vitest-tests/test-sharding.

# Inspired from https://playwright.dev/docs/test-sharding
name: Tests
on:
  push:
    branches:
      - main
jobs:
  tests:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        shardIndex: [1, 2, 3, 4]
        shardTotal: [4]
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: Install pnpm
        uses: pnpm/action-setup@v4

      - name: Install dependencies
        run: pnpm i

      - name: Run tests
        run: pnpm run test --reporter=blob --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}

      - name: Upload blob report to GitHub Actions Artifacts
        if: ${{ !cancelled() }}
        uses: actions/upload-artifact@v4
        with:
          name: blob-report-${{ matrix.shardIndex }}
          path: .vitest-reports/*
          include-hidden-files: true
          retention-days: 1

  merge-reports:
    if: ${{ !cancelled() }}
    needs: [tests]

    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: Install pnpm
        uses: pnpm/action-setup@v4

      - name: Install dependencies
        run: pnpm i

      - name: Download blob reports from GitHub Actions Artifacts
        uses: actions/download-artifact@v4
        with:
          path: .vitest-reports
          pattern: blob-report-*
          merge-multiple: true

      - name: Merge reports
        run: npx vitest --merge-reports

:::tip 测试分片在多 CPU 数量的机器上也很有用。

Vitest 将只在其主线程中运行一个 Vite 服务器。其余的线程用于运行测试文件。 在高 CPU 计数的机器中，主线程可能会成为瓶颈，因为它无法处理来自线程的所有请求。例如，在 32 CPU 机器中，主线程负责处理来自 31 个测试线程的负载。

为了减少主线程的 Vite 服务器的负载，可以使用测试分片。负载可以在多个 Vite 服务器上进行平衡。

# Example for splitting tests on 32 CPU to 4 shards.
# As each process needs 1 main thread, there's 7 threads for test runners (1+7)*4 = 32
# Use VITEST_MAX_THREADS or VITEST_MAX_FORKS depending on the pool:
VITEST_MAX_THREADS=7 vitest run --reporter=blob --shard=1/4 & \
VITEST_MAX_THREADS=7 vitest run --reporter=blob --shard=2/4 & \
VITEST_MAX_THREADS=7 vitest run --reporter=blob --shard=3/4 & \
VITEST_MAX_THREADS=7 vitest run --reporter=blob --shard=4/4 & \
wait # https://man7.org/linux/man-pages/man2/waitpid.2.html

vitest --merge-reports

:::