Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion detect/synthetic-monitoring/browser-checks/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Browser checks are automated tests that use real browsers to interact with your
<Info>
Supported Browsers:
- **Chromium**: Default browser, fast and reliable
- **Chrome**: Google Chrome for production-like testing
- **Chrome**: Google Chrome for production-like testing. See [Use Google Chrome](/detect/synthetic-monitoring/browser-checks/playwright-support#use-google-chrome).
- **Mobile Simulation**: Test responsive designs and mobile workflows
</Info>

Expand Down
44 changes: 38 additions & 6 deletions detect/synthetic-monitoring/browser-checks/playwright-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ We currently support the following configuration options. We will update this li
| `permissions` | ✅ |
| `timezoneId` | ✅ |
| `viewport` | ✅ |
| `deviceScaleFactor` | ✅ |
| `deviceScaleFactor` | ✅ Global configuration only |
| `hasTouch ` | ✅ |
| `isMobile ` | ✅ |
| `javaScriptEnabled ` | ✅ |
Expand All @@ -87,20 +87,28 @@ We currently support the following configuration options. We will update this li
| `offline` | ✅ |
| `actionTimeout` | ✅ |
| `navigationTimeout ` | ✅ |

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Wording (optional): you answered "add these" on my last review, but the Use table still has no acceptDownloads or userAgent row, although the test.use() list below includes both. This adds the two rows:

Suggested change
| `navigationTimeout ` | ✅ |
| `navigationTimeout ` | ✅ |
| `acceptDownloads` | ✅ |
| `userAgent` | ✅ |

| `testIdAttribute` | ✅ |
| `testIdAttribute` | ✅ Global configuration only |
| `connectOptions` | ❌ |
| `contextOptions` | ✅ |
| `bypassCSP` | ✅ |
| `contextOptions` | ✅ Global configuration only |
| `bypassCSP` | ✅ Global configuration only |
| `proxy` | ✅ |
| `launchOptions` | ❌ |
| `launchOptions` | ❌ See [Browser launch options](#browser-launch-options) |
| `storageState` | ❌ |
| `browserName` | ❌ |
| `channel` | ❌ |
| `channel` | ✅ See [Use Google Chrome](#use-google-chrome) |
| `headless` | ❌ |
| `screenshot` | ❌ |
| `trace` | ❌ |
| `video` | ❌ |

In a test file, `test.use()` accepts only these options: `acceptDownloads`, `actionTimeout`, `baseURL`, `channel`, `colorScheme`, `extraHTTPHeaders`, `geolocation`, `hasTouch`, `httpCredentials`, `ignoreHTTPSErrors`, `isMobile`, `javaScriptEnabled`, `locale`, `navigationTimeout`, `offline`, `permissions`, `proxy`, `timezoneId`, `userAgent` and `viewport`. Checkly ignores any other option in `test.use()` and logs a line like this one:

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Wording (optional): this list includes acceptDownloads and userAgent, but the Use table above has no rows for them. A reader scanning the table would think they're unsupported. Adding two ✅ rows keeps the table and this list in agreement.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

add these


```text
Local configuration key "testIdAttribute" is not supported by Checkly.
```

Set options marked "Global configuration only" in the [global configuration](#global-configuration) instead.

For more information about the `use` options you can check Playwright official documentation [Test use options](https://playwright.dev/docs/test-use-options)
</Tab>
<Tab title="Expect">
Expand All @@ -122,6 +130,30 @@ A check using [the Playwright Test Runner (`@playwright/test`)](https://playwrig
When `use.extraHTTPHeaders` is missing from the Playwright configuration, Checkly adds its trace headers automatically. See how to [add Checkly's trace headers to your custom HTTP headers](/resolve/traces/overview#add-trace-headers-to-custom-http-headers).
</Note>

## Use Google Chrome

Browser checks run in Chromium by default. To run a check in Google Chrome, set `channel` to `chrome` in your test file:

```ts example.spec.ts
import { test } from '@playwright/test'

test.use({ channel: 'chrome' })
```

Write `channel: 'chrome'` as a literal string in your check's code, not through a variable or a function. Checkly reads the code to decide whether the check needs Chrome. If it doesn't find the literal string, the check can run in Chromium instead.

## Browser launch options

Checkly ignores `launchOptions`, both in the global configuration and in `test.use()`.

When you launch a browser yourself with `chromium.launch()`, Checkly passes on only these launch options: `channel`, `logger`, `proxy`, `slowMo` and `timeout`. It ignores all others, such as `executablePath` or `headless`. The browser always runs headless.

Of the Chromium arguments in `args`, Checkly keeps only `--disable-web-security` and `--host-resolver-rules=...`. It drops every other argument and logs a warning like this one:

```text
Warning: chromium launch argument "--use-fake-device-for-media-stream" is not whitelisted by Checkly and will be ignored. If you need to use this argument, please contact support.
```

## Hooks
Playwright Test Runner offers hook functions such as `test.afterEach()` and `test.beforeEach()` that run before or after individual test cases or `test.afterAll()` and `test.beforeAll()` that run before or after all tests have started/finished.

Expand Down
9 changes: 8 additions & 1 deletion platform/runtimes/runtime-specification.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,22 @@ The following standard Node modules are included and can be used as normal, e.g.
import * as path from 'path'
```

You can also import them with the `node:` prefix, e.g. `node:path`.

- assert
- buffer
- crypto
- dns
- dgram
- dns (in runtime `2026.04`, `dns.setServers()` and `dns.setDefaultResultOrder()` apply only to the check that calls them)
- fs (partial, we have restricted some file system operations for security reasons)
- https
- os (partial in runtime `2026.04`: `platform()`, `arch()`, `type()`, `endianness()`, `tmpdir()`, `homedir()`, `EOL`, `devNull` and `constants`. Other `os` functions, such as `hostname()` or `cpus()`, throw an error)
- path
- perf_hooks (partial in runtime `2026.04`: only `performance`)
- querystring
- readline
- stream
- stream/promises
- string_decoder
- timers
- tls
Expand Down
Loading