kyfx
/
playwright
mirror of https://github.com/microsoft/playwright.git
4
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update tracing.group docs (#33487)

This commit is contained in:
Dmitry Gozman 2024-11-07 03:57:18 -08:00 committed by GitHub
parent 43e4ba9f2f
commit 67e8defbe9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 30 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/src/api/class-tracing.md
View File

@ -284,30 +284,24 @@ To specify the final trace zip file name, you need to pass `path` option to
## async method: Tracing.group ## async method: Tracing.group
* since: v1.49 * since: v1.49
Creates a new group within the trace, assigning any subsequent API calls to this group, until [`method: Tracing.groupEnd`] is called. Groups can be nested and will be visible in the trace viewer and test reports.
:::caution :::caution
When using Playwright test runner, we strongly recommend `test.step` instead. Use `test.step` instead when available.
::: :::
Creates a new group within the trace, assigning any subsequent API calls to this group, until [`method: Tracing.groupEnd`] is called. Groups can be nested and will be visible in the trace viewer.
**Usage** **Usage**
```js ```js
await context.tracing.start({ screenshots: true, snapshots: true }); // use test.step instead
await context.tracing.group('Open Playwright.dev'); await test.step('Log in', async () => {
// All actions between group and groupEnd will be shown in the trace viewer as a group. // ...
const page = await context.newPage(); });
await page.goto('https://playwright.dev/');
await context.tracing.groupEnd();
await context.tracing.group('Open API Docs of Tracing');
await page.getByRole('link', { name: 'API' }).click();
await page.getByRole('link', { name: 'Tracing' }).click();
await context.tracing.groupEnd();
// This Trace will have two groups: 'Open Playwright.dev' and 'Open API Docs of Tracing'.
``` ```
```java ```java
// All actions between group and groupEnd will be shown in the trace viewer as a group. // All actions between group and groupEnd
// will be shown in the trace viewer as a group.
page.context().tracing.group("Open Playwright.dev > API"); page.context().tracing.group("Open Playwright.dev > API");
page.navigate("https://playwright.dev/"); page.navigate("https://playwright.dev/");
page.getByRole(AriaRole.LINK, new Page.GetByRoleOptions().setName("API")).click(); page.getByRole(AriaRole.LINK, new Page.GetByRoleOptions().setName("API")).click();
@ -315,7 +309,8 @@ page.context().tracing.groupEnd();
``` ```
```python sync ```python sync
# All actions between group and groupEnd will be shown in the trace viewer as a group. # All actions between group and group_end
# will be shown in the trace viewer as a group.
page.context.tracing.group("Open Playwright.dev > API") page.context.tracing.group("Open Playwright.dev > API")
page.goto("https://playwright.dev/") page.goto("https://playwright.dev/")
page.get_by_role("link", name="API").click() page.get_by_role("link", name="API").click()
@ -323,7 +318,8 @@ page.context.tracing.group_end()
``` ```
```python async ```python async
# All actions between group and groupEnd will be shown in the trace viewer as a group. # All actions between group and group_end
# will be shown in the trace viewer as a group.
await page.context.tracing.group("Open Playwright.dev > API") await page.context.tracing.group("Open Playwright.dev > API")
await page.goto("https://playwright.dev/") await page.goto("https://playwright.dev/")
await page.get_by_role("link", name="API").click() await page.get_by_role("link", name="API").click()
@ -331,7 +327,8 @@ await page.context.tracing.group_end()
``` ```
```csharp ```csharp
// All actions between group and groupEnd will be shown in the trace viewer as a group. // All actions between GroupAsync and GroupEndAsync
// will be shown in the trace viewer as a group.
await Page.Context().Tracing.GroupAsync("Open Playwright.dev > API"); await Page.Context().Tracing.GroupAsync("Open Playwright.dev > API");
await Page.GotoAsync("https://playwright.dev/"); await Page.GotoAsync("https://playwright.dev/");
await Page.GetByRole(AriaRole.Link, new() { Name = "API" }).ClickAsync(); await Page.GetByRole(AriaRole.Link, new() { Name = "API" }).ClickAsync();
@ -342,17 +339,16 @@ await Page.Context().Tracing.GroupEndAsync();
* since: v1.49 * since: v1.49
- `name` <[string]> - `name` <[string]>
Group name shown in the actions tree in trace viewer. Group name shown in the trace viewer.
### option: Tracing.group.location ### option: Tracing.group.location
* since: v1.49 * since: v1.49
- `location` ?<[Object]> - `location` ?<[Object]>
- `file` <[string]> Source file path to be shown in the trace viewer source tab. - `file` <[string]>
- `line` ?<[int]> Line number in the source file. - `line` ?<[int]>
- `column` ?<[int]> Column number in the source file. - `column` ?<[int]>
Specifies a custom location for the group start to be shown in source tab in trace viewer. Specifies a custom location for the group to be shown in the trace viewer. Defaults to the location of the [`method: Tracing.group`] call.
By default, location of the [`method: Tracing.group`] call is shown.
## async method: Tracing.groupEnd ## async method: Tracing.groupEnd
* since: v1.49 * since: v1.49

36
packages/playwright-core/types/types.d.ts vendored
View File

@ -21056,50 +21056,34 @@ export interface Touchscreen {
*/ */
export interface Tracing { export interface Tracing {
/** /**
* **NOTE** Use `test.step` instead when available.
*
* Creates a new group within the trace, assigning any subsequent API calls to this group, until * Creates a new group within the trace, assigning any subsequent API calls to this group, until
* [tracing.groupEnd()](https://playwright.dev/docs/api/class-tracing#tracing-group-end) is called. Groups can be * [tracing.groupEnd()](https://playwright.dev/docs/api/class-tracing#tracing-group-end) is called. Groups can be
* nested and will be visible in the trace viewer and test reports. * nested and will be visible in the trace viewer.
*
* **NOTE** When using Playwright test runner, we strongly recommend `test.step` instead.
* *
* **Usage** * **Usage**
* *
* ```js * ```js
* await context.tracing.start({ screenshots: true, snapshots: true }); * // use test.step instead
* await context.tracing.group('Open Playwright.dev'); * await test.step('Log in', async () => {
* // All actions between group and groupEnd will be shown in the trace viewer as a group. * // ...
* const page = await context.newPage(); * });
* await page.goto('https://playwright.dev/');
* await context.tracing.groupEnd();
* await context.tracing.group('Open API Docs of Tracing');
* await page.getByRole('link', { name: 'API' }).click();
* await page.getByRole('link', { name: 'Tracing' }).click();
* await context.tracing.groupEnd();
* // This Trace will have two groups: 'Open Playwright.dev' and 'Open API Docs of Tracing'.
* ``` * ```
* *
* @param name Group name shown in the actions tree in trace viewer. * @param name Group name shown in the trace viewer.
* @param options * @param options
*/ */
group(name: string, options?: { group(name: string, options?: {
/** /**
* Specifies a custom location for the group start to be shown in source tab in trace viewer. By default, location of * Specifies a custom location for the group to be shown in the trace viewer. Defaults to the location of the
* the [tracing.group(name[, options])](https://playwright.dev/docs/api/class-tracing#tracing-group) call is shown. * [tracing.group(name[, options])](https://playwright.dev/docs/api/class-tracing#tracing-group) call.
*/ */
location?: { location?: {
/**
* Source file path to be shown in the trace viewer source tab.
*/
file: string; file: string;
/**
* Line number in the source file.
*/
line?: number; line?: number;
/**
* Column number in the source file.
*/
column?: number; column?: number;
}; };
}): Promise<void>; }): Promise<void>;