跟踪查看器

介绍

¥Introduction

Playwright Trace Viewer 是一个 GUI 工具，可帮助你在脚本运行后探索记录的 Playwright 跟踪。当测试在 CI 上失败时，跟踪是调试测试的好方法。你可以打开跟踪 locally 或在浏览器中打开 trace.playwright.dev。

¥Playwright Trace Viewer is a GUI tool that helps you explore recorded Playwright traces after the script has ran. Traces are a great way for debugging your tests when they fail on CI. You can open traces locally or in your browser on trace.playwright.dev.

跟踪查看器功能

¥Trace Viewer features

行动

¥Actions

在“操作”选项卡中，你可以查看每个操作使用的定位器以及每个操作运行的时间。将鼠标悬停在测试的每个操作上，并直观地查看 DOM 快照中的变化。及时返回和前进，然后单击一个操作来检查和调试。使用“之前”和“之后”选项卡可以直观地查看操作之前和之后发生的情况。

¥In the Actions tab you can see what locator was used for every action and how long each one took to run. Hover over each action of your test and visually see the change in the DOM snapshot. Go back and forward in time and click an action to inspect and debug. Use the Before and After tabs to visually see what happened before and after the action.

选择每个操作会显示：

¥Selecting each action reveals:

• 动作快照

  ¥action snapshots

• 行动日志

  ¥action log

• 源代码位置

  ¥source code location

截图

¥Screenshots

当打开 screenshots 选项进行跟踪时，每个跟踪都会记录一个截屏视频并将其渲染为胶片。你可以将鼠标悬停在胶片上以查看每个操作和状态的放大图片，这有助于你轻松找到要检查的操作。

¥When tracing with the screenshots option turned on, each trace records a screencast and renders it as a film strip. You can hover over the film strip to see a magnified image of for each action and state which helps you easily find the action you want to inspect.

双击某个操作可查看该操作的时间范围。你可以使用时间线中的滑块来增加所选操作，这些操作将显示在“操作”选项卡中，并且所有控制台日志和网络日志将被过滤，仅显示所选操作的日志。

¥Double click on an action to see the time range for that action. You can use the slider in the timeline to increase the actions selected and these will be shown in the Actions tab and all console logs and network logs will be filtered to only show the logs for the actions selected.

快照

¥Snapshots

当启用 snapshots 选项（默认）进行跟踪时，Playwright 会为每个动作捕获一组完整的 DOM 快照。根据操作的类型，它将捕获：

¥When tracing with the snapshots option turned on (default), Playwright captures a set of complete DOM snapshots for each action. Depending on the type of the action, it will capture:

类型	描述
前	调用操作时的快照。
行动	执行输入时的快照。当探索 Playwright 具体点击的位置时，这种类型的快照特别有用。
后	动作后的快照。

典型的操作快照如下所示：

¥Here is what the typical Action snapshot looks like:

请注意它如何高亮 DOM 节点以及确切的单击位置。

¥Notice how it highlights both, the DOM Node as well as the exact click position.

来源

¥Source

当你将鼠标悬停在测试的每个操作上时，该操作的代码行会在源面板中高亮。

¥As you hover over each action of your test the line of code for that action is highlighted in the source panel.

调用

¥Call

调用选项卡向你显示有关操作的信息，例如所花费的时间、使用的定位器、是否处于严格模式以及使用的键。

¥The call tab shows you information about the action such as the time it took, what locator was used, if in strict mode and what key was used.

日志

¥Log

查看测试的完整日志，以更好地了解 Playwright 在幕后所做的事情，例如滚动到视图中、等待元素可见、启用和稳定以及执行单击、填充、按下等操作。

¥See a full log of your test to better understand what Playwright is doing behind the scenes such as scrolling into view, waiting for element to be visible, enabled and stable and performing actions such as click, fill, press etc.

错误

¥Errors

如果测试失败，你将在“错误”选项卡中看到每个测试的错误消息。时间线还将显示一条红线，高亮错误发生的位置。你还可以单击“源代码”选项卡来查看错误出现在源代码的哪一行。

¥If your test fails you will see the error messages for each test in the Errors tab. The timeline will also show a red line highlighting where the error occurred. You can also click on the source tab to see on which line of the source code the error is.

控制台

¥Console

查看来自浏览器和测试的控制台日志。将显示不同的图标来显示控制台日志是来自浏览器还是来自测试文件。

¥See console logs from the browser as well as from your test. Different icons are displayed to show you if the console log came from the browser or from the test file.

网络

¥Network

“网络”选项卡显示测试期间触发的所有网络请求。你可以按不同类型的请求、状态代码、方法、请求、内容类型、持续时间和大小进行排序。单击请求可查看有关该请求的更多信息，例如请求标头、响应标头、请求正文和响应正文。

¥The Network tab shows you all the network requests that were made during your test. You can sort by different types of requests, status code, method, request, content type, duration and size. Click on a request to see more information about it such as the request headers, response headers, request body and response body.

元数据

¥Metadata

在“操作”选项卡旁边，你将找到“元数据”选项卡，它将显示有关测试的更多信息，例如浏览器、视口大小、测试持续时间等。

¥Next to the Actions tab you will find the Metadata tab which will show you more information on your test such as the Browser, viewport size, test duration and more.

附件

¥Attachments

"附件" 选项卡允许你浏览附件。如果你正在执行 视觉回归测试，你将能够通过检查图片差异、实际图片和预期图片来比较屏幕截图。当你单击所需的图片时，你可以使用滑块将一张图片滑动到另一张图片上，以便你可以轻松地看到屏幕截图中的差异。

¥The "Attachments" tab allows you to explore attachments. If you're doing visual regression testing, you'll be able to compare screenshots by examining the image diff, the actual image and the expected image. When you click on the expected image you can use the slider to slide one image over the other so you can easily see the differences in your screenshots.

本地记录轨迹

¥Recording a trace locally

要在开发模式期间记录跟踪，请在运行测试时将 --trace 标志设置为 on。你还可以使用 用户界面模式 来获得更好的开发者体验。

¥To record a trace during development mode set the --trace flag to on when running your tests. You can also use UI Mode for a better developer experience.

npx playwright test --trace on

然后，你可以打开 HTML 报告并单击跟踪图标以打开跟踪。

¥You can then open the HTML report and click on the trace icon to open the trace.

npx playwright show-report

在 CI 上记录跟踪

¥Recording a trace on CI

通过在测试配置文件中设置 trace: 'on-first-retry' 选项，应在第一次重试失败测试时在持续集成上运行跟踪。这将为每个重试的测试生成一个 trace.zip 文件。

¥Traces should be run on continuous integration on the first retry of a failed test by setting the trace: 'on-first-retry' option in the test configuration file. This will produce a trace.zip file for each test that was retried.

Test

playwright.config.ts

import { defineConfig } from '@playwright/test';
export default defineConfig({
  retries: 1,
  use: {
    trace: 'on-first-retry',
  },
});

Library

const browser = await chromium.launch();
const context = await browser.newContext();

// Start tracing before creating / navigating a page.
await context.tracing.start({ screenshots: true, snapshots: true });

const page = await context.newPage();
await page.goto('https://playwright.nodejs.cn');

// Stop tracing and export it into a zip archive.
await context.tracing.stop({ path: 'trace.zip' });

记录跟踪的可用选项：

¥Available options to record a trace:

• 'on-first-retry' - 仅在第一次重试测试时记录跟踪。

  ¥'on-first-retry' - Record a trace only when retrying a test for the first time.

• 'on-all-retries' - 记录所有测试重试的痕迹。

  ¥'on-all-retries' - Record traces for all test retries.

• 'off' - 不记录痕迹。

  ¥'off' - Do not record a trace.

• 'on' - 记录每个测试的痕迹。（不推荐，因为它的性能很重）

  ¥'on' - Record a trace for each test. (not recommended as it's performance heavy)

• 'retain-on-failure' - 记录每个测试的跟踪，但将其从成功的测试运行中删除。

  ¥'retain-on-failure' - Record a trace for each test, but remove it from successful test runs.

如果你不启用重试但仍希望跟踪失败的测试，你也可以使用 trace: 'retain-on-failure'。

¥You can also use trace: 'retain-on-failure' if you do not enable retries but still want traces for failed tests.

如果你不使用 Playwright 作为测试运行程序，请改用 browserContext.tracing API。

¥If you are not using Playwright as a Test Runner, use the browserContext.tracing API instead.

打开跟踪

¥Opening the trace

你可以使用 Playwright CLI 或在 trace.playwright.dev 上的浏览器中打开保存的跟踪。确保添加 trace.zip 文件所在位置的完整路径。这应该包括 trace.zip 文件的完整路径。

¥You can open the saved trace using the Playwright CLI or in your browser on trace.playwright.dev. Make sure to add the full path to where your trace.zip file is located. This should include the full path to your trace.zip file.

npx playwright show-trace path/to/trace.zip

使用 trace.playwright.dev

¥Using trace.playwright.dev

trace.playwright.dev 是跟踪查看器的静态托管变体。你可以使用拖放功能上传跟踪文件。

¥trace.playwright.dev is a statically hosted variant of the Trace Viewer. You can upload trace files using drag and drop.

查看远程痕迹

¥Viewing remote traces

你可以使用其 URL 打开远程跟踪。它们可以在 CI 运行时生成，这样可以轻松查看远程跟踪，而无需手动下载文件。

¥You can open remote traces using it's URL. They could be generated on a CI run which makes it easy to view the remote trace without having to manually download the file.

npx playwright show-trace https://example.com/trace.zip

你还可以将某些可访问存储中上传的跟踪的 URL（例如在 CI 内）作为参数传递。CORS（跨域资源共享）规则可能适用。

¥You can also pass the URL of your uploaded trace (e.g. inside your CI) from some accessible storage as a parameter. CORS (Cross-Origin Resource Sharing) rules might apply.

https://trace.playwright.dev/?trace=https://demo.playwright.dev/reports/todomvc/data/cb0fa77ebd9487a5c899f3ae65a7ffdbac681182.zip