Add Playwright check type comparison #80
Merged
Conversation
This file contains hidden or 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
stefanjudis
force-pushed
the
add-pwn-comparison
branch
from
3044b5b to
a1ceb67
Compare
stefanjudis
force-pushed
the
add-pwn-comparison
branch
from
a1ceb67 to
9b83f86
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds a new documentation page that compares Playwright-based monitoring options and links it into the docs navigation, with a shared snippet for check run durations.
- Introduces a Playwright monitoring comparison page with feature table and guidance.
- Adds a reusable MDX snippet for max check durations.
- Registers the new page in docs.json.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| snippets/check-comparison.mdx | Exports shared check duration constants for reuse across docs. |
| docs.json | Adds navigation entry for the new comparison page. |
| detect/synthetic-monitoring/playwright-monitoring-comparison.mdx | New doc page with comparison content, imports shared durations, and presents a feature table. |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| | Supported test formats | API and Browser | API and Browser | API only | | ||
| | Multiple spec files | Yes | No | No | | ||
| | Flexible test selection via tags and projects | Yes | No | No | | ||
| | Browser compatibility | Chromium, Webkit, Firefox | Chromium, Chrome | Chromium, Chrome | |
There was a problem hiding this comment.
This row states that MultiStep Checks support 'Chromium, Chrome', but line 20 clarifies there's no browser available for MultiStep Checks. Update the MultiStep column to 'N/A' or 'None' to avoid contradiction.
Suggested change
| | Browser compatibility | Chromium, Webkit, Firefox | Chromium, Chrome | Chromium, Chrome | | |
| | Browser compatibility | Chromium, Webkit, Firefox | Chromium, Chrome | N/A | |
Comment on lines
38
to
39
| | Feature | Playwright Check Suite | Browser Check | MultiStep Check | | ||
| |-----------------------------------------------|-------------------------------|---------------------------------|---------------------------------| |
There was a problem hiding this comment.
The table header and separator should not include a leading empty column. The current diff shows double leading pipes earlier; ensure you use a single leading pipe per row as shown here to prevent an extra empty column.
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
| | Supported test formats | API and Browser | API and Browser | API only | | ||
| | Multiple spec files | Yes | No | No | | ||
| | Flexible test selection via tags and projects | Yes | No | No | | ||
| | Browser compatibility | Chromium, Webkit, Firefox | Chromium, Chrome | Chromium, Chrome | |
There was a problem hiding this comment.
Capitalize 'WebKit' correctly.
Suggested change
| | Browser compatibility | Chromium, Webkit, Firefox | Chromium, Chrome | Chromium, Chrome | | |
| | Browser compatibility | Chromium, WebKit, Firefox | Chromium, Chrome | Chromium, Chrome | |
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
MariadeAnton
left a comment
MariadeAnton
left a comment
There was a problem hiding this comment.
Minor suggestions for clarity @stefanjudis !
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
| | Feature | Playwright Check Suites | Browser Check | MultiStep Check | | ||
| |-----------------------------------------------|-------------------------------|---------------------------------|---------------------------------| | ||
| | Supports *Monitoring as Code* | Yes | Yes | Yes | | ||
| | Supported test formats | API and Browser | API and Browser | API only | |
Contributor
There was a problem hiding this comment.
Suggested change
| | Supported test formats | API and Browser | API and Browser | API only | | |
| | [Test fixtures ](https://playwright.dev/docs/test-fixtures) | API and Browser | API and Browser | API only | |
Would it make sense to make this Playwright named? As In Test Fixtures
Collaborator
Author
There was a problem hiding this comment.
I like that a lot! 💯 But I'll go for the actual fixtures names instead of browser and api.
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: María de Antón <maria@checklyhq.com>
Co-authored-by: María de Antón <maria@checklyhq.com>
Co-authored-by: María de Antón <maria@checklyhq.com>
Co-authored-by: María de Antón <maria@checklyhq.com>
Co-authored-by: María de Antón <maria@checklyhq.com>
Co-authored-by: María de Antón <maria@checklyhq.com>
Collaborator
Author
|
@MariadeAnton Ready for another round. I think it's way smoother and rounder now. :) great stuff! |
detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: María de Antón <maria@checklyhq.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Affected Components
Notes for the Reviewer
As part of documenting the migration from MultiStep or Browser checks I formalized the different playwright capabilities of all check types. :)