chore: add pageSnapshot option #34669
Merged
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
packages/playwright/src/index.ts
Outdated
| @@ -640,7 +640,7 @@ class ArtifactsRecorder { | |||
| await page.screenshot({ ...screenshotOptions, timeout: 5000, path, caret: 'initial' }); | |||
| }); | |||
|
|
|||
| this._pageSnapshotRecorder = new SnapshotRecorder(this, pageSnapshot, 'pageSnapshot', 'text/plain', '.ariasnapshot', async (page, path) => { | |||
| this._pageSnapshotRecorder = new SnapshotRecorder(this, pageSnapshot ?? 'only-on-failure', 'pageSnapshot', 'text/plain', '.ariasnapshot', async (page, path) => { | |||
There was a problem hiding this comment.
Consider adding a normalization function for pageSnapshot similar to normalizeScreenshotMode to ensure consistent handling of the pageSnapshot option.
Copilot is powered by AI, so mistakes are possible. Review output carefully before use.
There was a problem hiding this comment.
I dunno Copilot, let's add that when we need it. ScreenshotMode is a little bit more complicated of a type than pageSnapshot.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
yury-s
requested changes
Feb 10, 2025
| * since: v1.10 | ||
| - type: <[PageSnapshotMode]<"off"|"on"|"only-on-failure">> | ||
|
|
||
| Whether to automatically capture a ARIA snapshot of the page after each test. Defaults to `'only-on-failure'`. |
There was a problem hiding this comment.
Suggested change
| Whether to automatically capture a ARIA snapshot of the page after each test. Defaults to `'only-on-failure'`. | |
| Whether to automatically capture a ARIA snapshot of the page after each test. Defaults to `'off'`. |
I don't think we want it on by default.
There was a problem hiding this comment.
My recollection of when we discussed this is to enable it by default - let's discuss tonight.
| @@ -128,7 +128,7 @@ test('should work with screenshot: on', async ({ runInlineTest }, testInfo) => { | |||
| const result = await runInlineTest({ | |||
| ...testFiles, | |||
| 'playwright.config.ts': ` | |||
| module.exports = { use: { screenshot: 'on' } }; | |||
| module.exports = { use: { screenshot: 'on', pageSnapshot: 'off' } }; | |||
There was a problem hiding this comment.
Why did screenshot and trace tests change, let's revert this part?
There was a problem hiding this comment.
if pageSnapshot is on by default, it means that there's more attachments. all the changed tests assert on attachments, so they have to change. the easiest is to disable pageSnapshot, that way no assertions need to be changed.
| @@ -485,7 +485,7 @@ test('should work with video: retain-on-failure', async ({ runInlineTest }) => { | |||
| test('should work with video: on-first-retry', async ({ runInlineTest }) => { | |||
| const result = await runInlineTest({ | |||
| 'playwright.config.ts': ` | |||
| module.exports = { use: { video: 'on-first-retry' }, retries: 1, name: 'chromium' }; | |||
| module.exports = { use: { video: 'on-first-retry', pageSnapshot: 'off' }, retries: 1, name: 'chromium' }; | |||
| @@ -59,7 +59,7 @@ test('should stop tracing with trace: on-first-retry, when not retrying', async | |||
| test('should record api trace', async ({ runInlineTest, server }, testInfo) => { | |||
| const result = await runInlineTest({ | |||
| 'playwright.config.ts': ` | |||
| module.exports = { use: { trace: 'on' } }; | |||
| module.exports = { use: { trace: 'on', pageSnapshot: 'off' } }; | |||
Co-authored-by: Yury Semikhatsky <[email protected]> Signed-off-by: Simon Knott <[email protected]>
Test results for "tests 1"10 flaky37840 passed, 654 skipped Merge workflow run. |
yury-s
approved these changes
Feb 11, 2025
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.
As discussed yesterday, this makes
pageSnapshotavailable to configure as an option.Also adds a 5s timeout to the snapshot taking.
Follow-up to #34573.