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
21 changes: 19 additions & 2 deletions detect/synthetic-monitoring/playwright-checks/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,11 @@ Playwright Check Suites also provide specific configuration for your Playwright

* `installCommand:` Override the command to install dependencies. `npm install --dev` is used by default.

* `testCommand:` Override the command that runs tests. `npx playwright test` is used by default with the tags, projects, and config file options your check specifies.
* `testCommand:` Append to the command that runs tests. `npx playwright test` is used by default with the tags, projects, and config file options your check specifies.

* `group:` The group construct this check belongs to.
* `engine:` Override the runtime engine for the check (Node.js or Bun). See [`engine`](/constructs/playwright-check#param-engine).

* `group:` The group id construct this check belongs to.

### Customize install and test commands

Expand Down Expand Up @@ -225,6 +227,21 @@ npx checkly test --grep=e2e-test-suite

The `npx checkly test` command runs your Playwright tests locally using the same configuration that Checkly will use in production. This helps catch configuration errors before deployment.

## Cancelling runs

You can cancel queued or in-progress Playwright Check Suite runs from the UI or CLI. Cancellation applies to runs from **Schedule Now** and from test sessions started with:

- `npx checkly test`
- `npx checkly pw-test`
- `npx checkly trigger`

Two ways to cancel:

- In the UI, click **Cancel Run** on the Check Suite Runs page or the Test Session Run page
- Press <kbd>Ctrl</kbd>+<kbd>C</kbd> in the CLI (v8.0.0+) to cancel a recorded test session

Cancelled runs show a **Cancelled** status in run history. See [Cancellation](/concepts/cancellation) for details on what happens after a run is cancelled.

## Common issues & troubleshooting

### Configuration errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,27 +185,49 @@ Learn more about [customizing install commands](/detect/synthetic-monitoring/pla

## Dependency Caching

Checkly caches installed packages between check runs to speed up execution and reduce installation time. Dependencies are installed once and reused for subsequent runs until your lock files (`package-lock.json`, `pnpm-lock.yaml`, or `yarn.lock`), your `installCommand` or your working directory change.
Checkly caches installed packages between check runs to speed up execution and reduce installation time. Dependencies are installed once and reused for subsequent runs until your lock files (`package-lock.json`, `pnpm-lock.yaml`, or `yarn.lock`), your `installCommand`, your working directory, or your [`engine`](/constructs/playwright-check#param-engine) change.

### How caching works

When dependency caching is enabled:

1. On the first run, Checkly installs all packages from your lock file and stores them in cache
2. On subsequent runs, Checkly checks if your lock file, `installCommand` or working directory have changed
2. On subsequent runs, Checkly checks if your lock file, `package.json` files, `installCommand`, working directory, or `engine` have changed
3. If unchanged, Checkly uses the cached packages, skipping the installation step
4. If changed, Checkly installs packages again and updates the cache

Caching significantly reduces check execution time, especially for projects with many or large dependencies.

### Cache behavior by location type
The dependency cache uses a least-recently-used (LRU) policy. Active Playwright Check Suites automatically refresh their cache entry, so caches only expire for check suites that have not run in the last 30 days.

### Automatic retries

Checkly automatically retries transient failures during setup steps. Cache downloads retry up to 3 times with exponential backoff. If all attempts fail, the run falls back to a clean install.

### Dependency Cache behavior by location type

**Public Locations**: Dependency caching is **Always ON**.

**Private Locations**: Dependency caching is **OFF by default**. To enable caching and speed up check runs, set `DEPENDENCY_CACHE=CHECKLY_S3` in your [agent configuration](/platform/private-locations/agent-configuration).

## Playwright browser caching

Checkly caches Playwright browsers so that runs don't download them every time. How caching works depends on which location your checks run.

### Browser caching on Public Locations

Checkly caches Playwright browsers across all public regions to reduce startup time. When a new Playwright version is available, runs download browsers until Checkly updates the shared cache.

### Browser caching on Private Locations
Checkly caches Playwright browsers on each Private Location agent, grouped by Playwright version.
When a matching version exists in cache, Checkly skips the download — reducing startup time and making runs more reliable.

<Info>
Browser caching requires Private Location agent v8.2.0 or later.
</Info>


## Troubleshooting
## Troubleshooting Dependency Installation

### Package not found

Expand Down
Loading