feat(trace viewer): Adds _debugName BrowserContextOption to let users define a name for their contexts #5205
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… define a name for their contexts.
This change is adding a new property on the BrowserContextOptions class called `_debugName`. This property allows defining a user-friendly name for the browser context, and currently it is being used in one place, the Trace Viewer. When user provides the new value in the following way:
```typescript
const { chromium } = require('playwright');
(async () => {
const browser = await chromium.launch();
const context = await browser.newContext({ _traceDir: __dirname, _debugName: 'My custom testcase name' });
await context.close();
await browser.close();
})();
```
The `_debugName` will be saved in the `*.trace` file for this browser context, on the `context-created` event, under the key `debugName`.
Later, when such a trace is displayed using Trace Viewer, the `debugName` will be displayed in the dropdown in the top right part of the app instead of the actual trace filename.
Fixes microsoft#5157.
|
Hey, two things to clarify here:
it('should record trace', (test, { browserName, platform }) => {
test.fixme();
}, async ({browser, testInfo, server}) => {
...
});This looks like those tests are disabled on purpose at the moment. I added a new test checking the |
|
Oh I also didn't add the docs yet, again not sure if those get added once the functionality is ready for deployment, or if it should be added in this PR. |
dgozman
changed the title
dgozman
approved these changes
Jan 28, 2021
| @@ -111,3 +113,19 @@ it('should record trace with POST', (test, { browserName, platform }) => { | |||
| expect(fs.existsSync(path.join(traceDir, 'resources', resourceEvent.requestSha1))).toBe(true); | |||
| expect(fs.existsSync(path.join(traceDir, 'resources', resourceEvent.responseSha1))).toBe(true); | |||
| }); | |||
|
|
|||
| it('should record trace with a debugName', (test, { browserName, platform }) => { | |||
| test.fixme(); | |||
There was a problem hiding this comment.
Tracing tests are flaky on the bots, I still need to figure out why and reenable them.
There was a problem hiding this comment.
What do you mean by bots?
There was a problem hiding this comment.
I mean our GitHub actions.
| @@ -373,6 +373,7 @@ BrowserType: | |||
| - no-preference | |||
| acceptDownloads: boolean? | |||
| _traceDir: string? | |||
| _debugName: string? | |||
There was a problem hiding this comment.
Underscore is good. We'll make it public once we are sure about the api. No need for docs yet.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change is adding a new property on the BrowserContextOptions class called
_debugName. This property allows defining a user-friendly name for the browser context, and currently it is being used in one place, the Trace Viewer. When user provides the new value in the following way:The
_debugNamewill be saved in the*.tracefile for this browser context, on thecontext-createdevent, under the keydebugName.Later, when such a trace is displayed using Trace Viewer, the
debugNamewill be displayed in the dropdown in the top right part of the app instead of the actual trace filename.Fixes #5157.