docs: Trace-viewer-intro (#16254)

microsoft · Aug 10, 2022 · 05dc5cf · 05dc5cf
1 parent 0d0da1d
commit 05dc5cf
Show file tree

Hide file tree

Showing 14 changed files with 225 additions and 15 deletions.
diff --git a/docs/src/codegen.md b/docs/src/codegen.md
@@ -288,4 +288,4 @@ await page.PauseAsync();
 
 ## What's Next
 
-- [See a trace of your tests](./trace-viewer.md)
+- [See a trace of your tests](./trace-viewer-intro.md)
diff --git a/docs/src/getting-started-vscode-js.md b/docs/src/getting-started-vscode-js.md
@@ -93,4 +93,4 @@ As you interact with the page Codegen will generate the test for you in the newl
 
 - [Write tests using web first assertions, page fixtures and locators](./writing-tests.md)
 - [See test reports](./running-tests.md#test-reports)
-- [See a trace of your tests](./trace-viewer.md)
+- [See a trace of your tests](./trace-viewer-intro.md)
diff --git a/docs/src/intro-csharp.md b/docs/src/intro-csharp.md
@@ -194,5 +194,5 @@ See our doc on [Test Runners](./test-runners.md) to learn more about running tes
 - [Run single tests, multiple tests, headed mode](./running-tests.md)
 - [Learn more about the NUnit and MSTest base classes](./test-runners.md)
 - [Generate tests with Codegen](./codegen.md)
-- [See a trace of your tests](./trace-viewer.md)
+- [See a trace of your tests](./trace-viewer-intro.md)
 - [Using Playwright as library](./library.md)
diff --git a/docs/src/intro-js.md b/docs/src/intro-js.md
@@ -96,4 +96,4 @@ npx playwright show-report
 - [Write tests using web first assertions, page fixtures and locators](./writing-tests.md)
 - [Run single tests, multiple tests, headed mode](./running-tests.md)
 - [Generate tests with Codegen](./codegen.md)
-- [See a trace of your tests](./trace-viewer.md)
+- [See a trace of your tests](./trace-viewer-intro.md)
diff --git a/docs/src/intro-python.md b/docs/src/intro-python.md
@@ -64,4 +64,4 @@ See our doc on [Running Tests](./running-tests.md) to learn more about running t
 - [Write tests using web first assertions, page fixtures and locators](./writing-tests.md)
 - [Run single tests, multiple tests, headed mode](./running-tests.md)
 - [Generate tests with Codegen](./codegen.md)
-- [See a trace of your tests](./trace-viewer.md)
+- [See a trace of your tests](./trace-viewer-intro.md)
diff --git a/docs/src/running-tests-csharp.md b/docs/src/running-tests-csharp.md
@@ -93,4 +93,4 @@ Check out our [debugging guide](./debug.md) to learn more about the [Playwright
 ## What's Next
 
 - [Generate tests with Codegen](./codegen.md)
-- [See a trace of your tests](./trace-viewer.md)
+- [See a trace of your tests](./trace-viewer-intro.md)
diff --git a/docs/src/running-tests-js.md b/docs/src/running-tests-js.md
@@ -105,4 +105,4 @@ You can click on each test and explore the tests errors as well as each step of
 ## What's Next
 
 - [Generate tests with Codegen](./codegen.md)
-- [See a trace of your tests](./trace-viewer.md)
+- [See a trace of your tests](./trace-viewer-intro.md)
diff --git a/docs/src/running-tests-python.md b/docs/src/running-tests-python.md
@@ -83,4 +83,4 @@ Check out our [debugging guide](./debug.md) to learn more about the [Playwright
 ## What's Next
 
 - [Generate tests with Codegen](./codegen.md)
-- [See a trace of your tests](./trace-viewer.md)
+- [See a trace of your tests](./trace-viewer-intro.md)
diff --git a/docs/src/trace-viewer-intro-csharp-java-python.md b/docs/src/trace-viewer-intro-csharp-java-python.md
@@ -0,0 +1,120 @@
+---
+id: trace-viewer-intro
+title: "Trace Viewer"
+---
+
+Playwright Trace Viewer is a GUI tool that lets you explore recorded Playwright traces of your tests meaning you can go back and forward though each action of your test and visually see what was happening during each action.
+
+**You will learn**
+
+- How to record a trace
+- How to open the HTML report
+- How to open the trace viewer
+
+## Recording a trace
+
+Traces can be recorded using the [`property: BrowserContext.tracing`] API as follows:
+
+```java
+Browser browser = browserType.launch();
+BrowserContext context = browser.newContext();
+
+// Start tracing before creating / navigating a page.
+context.tracing().start(new Tracing.StartOptions()
+  .setScreenshots(true)
+  .setSnapshots(true)
+  .setSources(true));
+
+Page page = context.newPage();
+page.navigate("https://playwright.dev");
+
+// Stop tracing and export it into a zip archive.
+context.tracing().stop(new Tracing.StopOptions()
+  .setPath(Paths.get("trace.zip")));
+```
+
+```python async
+browser = await chromium.launch()
+context = await browser.new_context()
+
+# Start tracing before creating / navigating a page.
+await context.tracing.start(screenshots=True, snapshots=True, sources=True)
+
+await page.goto("https://playwright.dev")
+
+# Stop tracing and export it into a zip archive.
+await context.tracing.stop(path = "trace.zip")
+```
+
+```python sync
+browser = chromium.launch()
+context = browser.new_context()
+
+# Start tracing before creating / navigating a page.
+context.tracing.start(screenshots=True, snapshots=True, sources=True)
+
+page.goto("https://playwright.dev")
+
+# Stop tracing and export it into a zip archive.
+context.tracing.stop(path = "trace.zip")
+```
+
+```csharp
+await using var browser = playwright.Chromium.LaunchAsync();
+await using var context = await browser.NewContextAsync();
+
+// Start tracing before creating / navigating a page.
+await context.Tracing.StartAsync(new()
+{
+  Screenshots = true,
+  Snapshots = true,
+  Sources = true
+});
+
+var page = context.NewPageAsync();
+await page.GotoAsync("https://playwright.dev");
+
+// Stop tracing and export it into a zip archive.
+await context.Tracing.StopAsync(new()
+{
+  Path = "trace.zip"
+});
+```
+
+This will record the trace and place it into the file named `trace.zip`.
+
+
+## Opening the trace
+
+You can open the saved trace using Playwright CLI or in your browser on [`trace.playwright.dev`](https://trace.playwright.dev).
+
+```bash js
+npx playwright show-trace trace.zip
+```
+
+```bash java
+mvn exec:java -e -Dexec.mainClass=com.microsoft.playwright.CLI -Dexec.args="show-trace trace.zip"
+```
+
+```bash python
+playwright show-trace trace.zip
+```
+
+```bash csharp
+pwsh bin\Debug\netX\playwright.ps1 show-trace trace.zip
+```
+
+
+## Viewing the trace
+
+View traces of your test by clicking through each action or hovering using the timeline and see the state of the page before and after the action. Inspect the log, source and network during each step of the test. The trace viewer creates a DOM snapshot so you can fully interact with it, open devtools etc.
+
+
+
+<img width="941" alt="image" src="https://user-images.githubusercontent.com/13063165/182618490-3340cfbf-7ac9-46e2-8157-6a8ce52dca28.png" />
+
+
+
+To learn more check out our detailed guide on [Trace Viewer](/trace-viewer.md).
+
+
diff --git a/docs/src/trace-viewer-intro-js.md b/docs/src/trace-viewer-intro-js.md
@@ -0,0 +1,89 @@
+---
+id: trace-viewer-intro
+title: "Trace Viewer"
+---
+
+Playwright Trace Viewer is a GUI tool that lets you explore recorded Playwright traces of your tests meaning you can go back and forward though each action of your test and visually see what was happening during each action.
+
+**You will learn**
+
+- [How to record a trace](/trace-viewer-intro.md#recording-a-trace)
+- [How to open the HTML report](/trace-viewer-intro.md#opening-the-html-report)
+- [How to open and view the trace](/trace-viewer-intro.md#viewing-the-trace)
+
+
+## Recording a Trace
+
+By default the [playwright.config](/test-configuration.md#record-test-trace) file will contain the configuration needed to create a `trace.zip` file for each test. Traces are setup to run `on-first-retry` meaning they will be run on the first retry of a failed test. Also `retires` are set to 2 when running on CI and 0 locally. This means the traces will be recorded on the first retry of a failed test but not on the first run and not on the second retry.
+
+```js tab=js-js
+// @ts-check
+
+/** @type {import('@playwright/test').PlaywrightTestConfig} */
+const config = {
+  retries: process.env.CI ? 2 : 0, // set to 2 when running on CI
+  ...
+  use: {
+    trace: 'on-first-retry', // record traces on first retry of each test
+  },
+};
+
+module.exports = config;
+```
+
+```js tab=js-ts
+import type { PlaywrightTestConfig } from '@playwright/test';
+const config: PlaywrightTestConfig = {
+  retries: process.env.CI ? 2 : 0, // set to 2 when running on CI
+  ...
+  use: {
+    trace: 'on-first-retry', // record traces on first retry of each test
+  },
+};
+export default config;
+```
+
+To learn more about available options to record a trace check out our detailed guide on [Trace Viewer](/trace-viewer.md).
+
+Traces are normally run in a Continuous Integration(CI) environment as locally you can use [debugging](/debug.md) methods to debug tests. However should you want to run traces locally you can force tracing to be on with `--trace on`.
+
+```bash
+npx playwright test --trace on
+```
+
+:::note 
+The `trace-on` flag was introduced in Playwright v1.25. Check your `package.json` to sure you have at least this version of Playwright installed.
+:::
+
+## Opening the HTML Report
+
+If you have a failed test then tests will run a total of 3 times. On the first retry the trace will be recorded. After the second retry the tests will stop running and a HTML report is available to view.
+
+```bash
+npx playwright show-report
+```
+
+In the HTML report click on the trace icon to directly open the trace file.
+
+<img width="744" alt="image" src="https://user-images.githubusercontent.com/13063165/182853447-e26f4d39-b4e2-4d9b-a890-ac1838c088e1.png" />
+
+You can also click on the test file and then click the 'Retry #1' tab which will show you a traces section in your html report. Here you can open the trace by clicking on the screenshot.
+
+<img width="749" alt="image" src="https://user-images.githubusercontent.com/13063165/183130559-16a83a39-2f1d-4560-850c-d025fad789b3.png" />
+
+
+To learn more about reporters check out our detailed guide on reporters including the [HTML Reporter](/test-reporters.md#html-reporter).
+
+## Viewing the Trace
+
+View traces of your test by clicking through each action or hovering using the timeline and see the state of the page before and after the action. Inspect the log, source and network during each step of the test. The trace viewer creates a DOM snapshot so you can fully interact with it, open devtools etc.
+
+
+
+<img width="941" alt="image" src="https://user-images.githubusercontent.com/13063165/182618490-3340cfbf-7ac9-46e2-8157-6a8ce52dca28.png" />
+
+
+
+To learn more about traces check out our detailed guide on [Trace Viewer](/trace-viewer.md).
+
+
diff --git a/docs/src/trace-viewer.md b/docs/src/trace-viewer.md
@@ -52,13 +52,14 @@ await page.goto('https://playwright.dev');
 await context.tracing.stop({ path: 'trace.zip' });
 ```
 
-You can also use `trace: 'retain-on-failure'` if you do not enable retries but still want traces for failed tests.
-
 Available options to record a trace:
+- `'on-first-retry'` - Record a trace only when retrying a test for the first time.
 - `'off'` - Do not record a trace.
-- `'on'` - Record a trace for each test.
+- `'on'` - Record a trace for each test. (not recommended as it's performance heavy)
 - `'retain-on-failure'` - Record a trace for each test, but remove it from successful test runs.
-- `'on-first-retry'` - Record a trace only when retrying a test for the first time.
+
+
+You can also use `trace: 'retain-on-failure'` if you do not enable retries but still want traces for failed tests.
 
 If you are not using Playwright Test, use the [`property: BrowserContext.tracing`] API instead.
 

diff --git a/docs/src/writing-tests-csharp.md b/docs/src/writing-tests-csharp.md
@@ -237,4 +237,4 @@ public class UnitTest1 : PageTest
 
 - [Run single tests, multiple tests, headed mode](./running-tests.md)
 - [Generate tests with Codegen](./codegen.md)
-- [See a trace of your tests](./trace-viewer.md)
+- [See a trace of your tests](./trace-viewer-intro.md)
diff --git a/docs/src/writing-tests-js.md b/docs/src/writing-tests-js.md
@@ -146,4 +146,4 @@ test.describe("navigation", () => {
 
 - [Run single tests, multiple tests, headed mode](./running-tests.md)
 - [Generate tests with Codegen](./codegen.md)
-- [See a trace of your tests](./trace-viewer.md)
+- [See a trace of your tests](./trace-viewer-intro.md)
diff --git a/docs/src/writing-tests-python.md b/docs/src/writing-tests-python.md
@@ -104,4 +104,4 @@ def test_main_navigation(page: Page):
 
 - [Run single tests, multiple tests, headed mode](./running-tests.md)
 - [Generate tests with Codegen](./codegen.md)
-- [See a trace of your tests](./trace-viewer.md)
+- [See a trace of your tests](./trace-viewer-intro.md)