Skip to content

Add Playwright check type comparison#80

Merged
stefanjudis merged 17 commits intomainfrom
add-pwn-comparison
Oct 17, 2025
Merged

Add Playwright check type comparison#80
stefanjudis merged 17 commits intomainfrom
add-pwn-comparison

Conversation

@stefanjudis
Copy link
Copy Markdown
Collaborator

Affected Components

  • Content & Marketing
  • Pricing
  • Test
  • Docs
  • Learn
  • Other

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. :)

image image

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
| 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 |
Copy link

Copilot AI Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 |

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great catch!

Comment on lines +38 to +39
| Feature | Playwright Check Suite | Browser Check | MultiStep Check |
|-----------------------------------------------|-------------------------------|---------------------------------|---------------------------------|
Copy link

Copilot AI Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
| 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 |
Copy link

Copilot AI Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalize 'WebKit' correctly.

Suggested change
| Browser compatibility | Chromium, Webkit, Firefox | Chromium, Chrome | Chromium, Chrome |
| Browser compatibility | Chromium, WebKit, Firefox | Chromium, Chrome | Chromium, Chrome |

Copilot uses AI. Check for mistakes.
Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
stefanjudis and others added 3 commits October 16, 2025 09:32
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>
Copy link
Copy Markdown
Contributor

@MariadeAnton MariadeAnton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor suggestions for clarity @stefanjudis !

Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx
Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
| 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 |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Collaborator Author

@stefanjudis stefanjudis Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that a lot! 💯 But I'll go for the actual fixtures names instead of browser and api.

Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
stefanjudis and others added 2 commits October 16, 2025 12:06
Co-authored-by: María de Antón <maria@checklyhq.com>
Co-authored-by: María de Antón <maria@checklyhq.com>
stefanjudis and others added 2 commits October 16, 2025 12:08
Co-authored-by: María de Antón <maria@checklyhq.com>
Co-authored-by: María de Antón <maria@checklyhq.com>
stefanjudis and others added 2 commits October 16, 2025 12:10
Co-authored-by: María de Antón <maria@checklyhq.com>
Co-authored-by: María de Antón <maria@checklyhq.com>
@stefanjudis
Copy link
Copy Markdown
Collaborator Author

@MariadeAnton Ready for another round. I think it's way smoother and rounder now. :) great stuff!

Comment thread detect/synthetic-monitoring/playwright-monitoring-comparison.mdx Outdated
Co-authored-by: María de Antón <maria@checklyhq.com>
Copy link
Copy Markdown
Contributor

@MariadeAnton MariadeAnton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏🏼

@stefanjudis stefanjudis merged commit fa3678d into main Oct 17, 2025
3 checks passed
@stefanjudis stefanjudis deleted the add-pwn-comparison branch October 17, 2025 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants