From a7709db207f9b9dfc6d43a86a22d2f94d2d7d67a Mon Sep 17 00:00:00 2001 From: Hannes Lenke Date: Mon, 9 Nov 2026 09:33:19 -0500 Subject: [PATCH 1/4] docs: correct Playwright option support for Browser checks - Mark channel as supported and explain how to use Google Chrome, which the Browser checks overview already lists. - Explain that launchOptions are ignored, and which launch options and Chromium arguments chromium.launch() keeps. - Mark deviceScaleFactor, testIdAttribute, contextOptions and bypassCSP as global configuration only, and list what test.use() accepts. - Add the missing built-in Node.js modules and the node: prefix to the runtime specification. Co-Authored-By: Claude Opus 5.5 --- .../browser-checks/overview.mdx | 2 +- .../browser-checks/playwright-support.mdx | 44 ++++++++++++++++--- platform/runtimes/runtime-specification.mdx | 7 +++ 3 files changed, 46 insertions(+), 7 deletions(-) diff --git a/detect/synthetic-monitoring/browser-checks/overview.mdx b/detect/synthetic-monitoring/browser-checks/overview.mdx index 1af354f7a..946fb7b27 100644 --- a/detect/synthetic-monitoring/browser-checks/overview.mdx +++ b/detect/synthetic-monitoring/browser-checks/overview.mdx @@ -37,7 +37,7 @@ Browser checks are automated tests that use real browsers to interact with your 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 diff --git a/detect/synthetic-monitoring/browser-checks/playwright-support.mdx b/detect/synthetic-monitoring/browser-checks/playwright-support.mdx index bbaf20e66..1aa004f43 100644 --- a/detect/synthetic-monitoring/browser-checks/playwright-support.mdx +++ b/detect/synthetic-monitoring/browser-checks/playwright-support.mdx @@ -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 ` | ✅ | @@ -87,20 +87,28 @@ We currently support the following configuration options. We will update this li | `offline` | ✅ | | `actionTimeout` | ✅ | | `navigationTimeout ` | ✅ | - | `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: + + ```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) @@ -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). +## 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. + +## 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. diff --git a/platform/runtimes/runtime-specification.mdx b/platform/runtimes/runtime-specification.mdx index ef065c51d..482493046 100644 --- a/platform/runtimes/runtime-specification.mdx +++ b/platform/runtimes/runtime-specification.mdx @@ -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 +- dgram - dns - fs (partial, we have restricted some file system operations for security reasons) +- https +- os - path +- perf_hooks - querystring - readline - stream +- stream/promises - string_decoder - timers - tls From 30421e316c699d22722bca3e58fdcfe08afaf4b0 Mon Sep 17 00:00:00 2001 From: Hannes Lenke Date: Mon, 9 Nov 2026 20:24:22 -0500 Subject: [PATCH 2/4] Apply suggestion from @hlenke --- detect/synthetic-monitoring/browser-checks/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/detect/synthetic-monitoring/browser-checks/overview.mdx b/detect/synthetic-monitoring/browser-checks/overview.mdx index 946fb7b27..2645ce57e 100644 --- a/detect/synthetic-monitoring/browser-checks/overview.mdx +++ b/detect/synthetic-monitoring/browser-checks/overview.mdx @@ -37,7 +37,7 @@ Browser checks are automated tests that use real browsers to interact with your Supported Browsers: - **Chromium**: Default browser, fast and reliable -- **Chrome**: Google Chrome for production-like testing, see [Use Google Chrome](/detect/synthetic-monitoring/browser-checks/playwright-support#use-google-chrome) +- **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 From 59a96796a4dabd8264c0dd5dc9d84ee832a349c7 Mon Sep 17 00:00:00 2001 From: Hannes Lenke Date: Mon, 9 Nov 2026 20:25:31 -0500 Subject: [PATCH 3/4] Apply suggestion from @hlenke --- .../synthetic-monitoring/browser-checks/playwright-support.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/detect/synthetic-monitoring/browser-checks/playwright-support.mdx b/detect/synthetic-monitoring/browser-checks/playwright-support.mdx index 1aa004f43..61331f126 100644 --- a/detect/synthetic-monitoring/browser-checks/playwright-support.mdx +++ b/detect/synthetic-monitoring/browser-checks/playwright-support.mdx @@ -140,7 +140,7 @@ 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. +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 From 5b5deca43655c862489b37691275b11f34121c34 Mon Sep 17 00:00:00 2001 From: Hannes Lenke Date: Mon, 9 Nov 2026 20:31:28 -0500 Subject: [PATCH 4/4] docs(runtimes): say what os, perf_hooks and dns offer in runtime 2026.04 Co-Authored-By: Claude Opus 5.5 --- platform/runtimes/runtime-specification.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/platform/runtimes/runtime-specification.mdx b/platform/runtimes/runtime-specification.mdx index 482493046..39e3a1243 100644 --- a/platform/runtimes/runtime-specification.mdx +++ b/platform/runtimes/runtime-specification.mdx @@ -47,12 +47,12 @@ You can also import them with the `node:` prefix, e.g. `node:path`. - buffer - crypto - dgram -- dns +- 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 +- 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 +- perf_hooks (partial in runtime `2026.04`: only `performance`) - querystring - readline - stream