追踪视图

Vitest 浏览器模式支持生成 Playwright 的 追踪文件。要启用追踪，你需要在 test.browser 配置中设置 trace 选项。

WARNING

生成追踪文件仅在使用 Playwright 提供者 时可用。

vitest.config.js

import { defineConfig } from 'vitest/config'
import { playwright } from '@vitest/browser-playwright'

export default defineConfig({
  test: {
    browser: {
      provider: playwright(),
      trace: 'on',
    },
  },
})

CLI

vitest --browser.trace=on

默认情况下，Vitest 会为每个测试生成一个追踪文件。你也可以通过将其设置为 'on-first-retry'、'on-all-retries' 或 'retain-on-failure' 来配置为仅在测试失败时生成追踪。文件将保存在测试文件旁边的 __traces__ 文件夹中。追踪文件的名称包含项目名称、测试名称、repeats 计数和 retry 计数：

chromium-my-test-0-0.trace.zip
^^^^^^^^ 项目名称
         ^^^^^^ 测试名称
                ^ 重复计数
                  ^ 重试计数

要更改输出目录，你可以在 test.browser.trace 配置中设置 tracesDir 选项。这样所有追踪文件将存储在同一个目录中，按测试文件分组。

vitest.config.js

import { defineConfig } from 'vitest/config'
import { playwright } from '@vitest/browser-playwright'

export default defineConfig({
  test: {
    browser: {
      provider: playwright(),
      trace: {
        mode: 'on',
        // 路径相对于项目根目录
        tracesDir: './playwright-traces',
      },
    },
  },
})

追踪文件在报告器中作为 注解 可用。例如，在 HTML 报告器中，你可以在测试详情中找到追踪文件的链接。

追踪标记

你可以添加显式的命名标记，使追踪时间线更易于阅读：

import { page } from 'vitest/browser'

document.body.innerHTML = `
  <button type="button">Sign in</button>
`

await page.getByRole('button', { name: 'Sign in' }).mark('sign in button rendered')

page.mark(name) 和 locator.mark(name) 均可用。

你也可以使用 page.mark(name, callback) 将多个操作分组在一个标记下：

await page.mark('sign in flow', async () => {
  await page.getByRole('textbox', { name: 'Email' }).fill('john@example.com')
  await page.getByRole('textbox', { name: 'Password' }).fill('secret')
  await page.getByRole('button', { name: 'Sign in' }).click()
})

你也可以使用 vi.defineHelper() 包装可复用的辅助函数，这样追踪条目会指向调用辅助函数的位置，而不是其内部实现：

import { vi } from 'vitest'
import { page } from 'vitest/browser'

const myRender = vi.defineHelper(async (content: string) => {
  document.body.innerHTML = content
  await page.elementLocator(document.body).mark('render helper')
})

test('renders content', async () => {
  await myRender('<button>Hello</button>') // 追踪指向这一行
})

预览

要打开追踪文件，你可以使用 Playwright 追踪查看器。在终端中运行以下命令：

npx playwright show-trace "path-to-trace-file"

这将启动追踪查看器并加载指定的追踪文件。

或者，你可以在浏览器中打开 https://trace.playwright.dev 处的追踪查看器，并将追踪文件上传到那里。

源代码位置

当你打开追踪时，你会注意到 Vitest 将浏览器交互分组，并将它们链接回测试中触发它们的确切行。以下情况会自动发生：

• expect.element(...) 断言
• 交互操作，如 click、fill、type、hover、selectOptions、upload、dragAndDrop、tab、keyboard、wheel 和截图

在底层，Playwright 仍然像往常一样记录其自己的低级动作事件。Vitest 用源代码位置组包装它们，以便你可以直接从追踪时间线跳转到测试中的相关行。

请记住，像 expect(value).toBe(...) 这样的普通断言在 Node 中运行，而不是在浏览器中，所以它们不会显示在追踪中。

对于任何未自动覆盖的内容，你可以使用 page.mark() 或 locator.mark() 添加自己的追踪组 — 参见上面的 追踪标记。