Skip to content

Commit 1fd6bd8

Browse files
authored
Merge pull request #167 from checkly/michelle/red-89-update-docs-with-new-troubleshooting-cases
feat: add more pw error cases to troubleshoot [red-89]
2 parents 2f4a6f7 + 5feea5a commit 1fd6bd8

3 files changed

Lines changed: 34 additions & 1 deletion

File tree

detect/synthetic-monitoring/playwright-checks/configuration.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -239,3 +239,19 @@ If tests fail due to authentication issues:
239239

240240
- Verify environment variables are set correctly in Checkly. You can verify your environment variables using `npx checkly env ls`, or looking at your Global or Check's environment variables in the Checkly Webapp to ensure any `process.env.VARIABLE_NAME` call from your test is defined.
241241
- For persistent authentication, use Playwright's [`storageState`](https://playwright.dev/docs/auth#reuse-authentication-state) feature.
242+
243+
**webServer configuration requires additional files**
244+
245+
When using `webServer` in your Playwright config, you need to include the server files in your check configuration:
246+
247+
- Add server files to the `include` parameter in your [Playwright check configuration](/constructs/playwright-check/#param-include)
248+
- Include all files needed to start the server (e.g., server scripts, config files)
249+
- Alternatively, skip `webServer` on Checkly and use your deployed URL: `...(process.env.CHECKLY ? {} : { webServer: { ... } })`
250+
251+
**No tests found**
252+
253+
If Playwright couldn't find any tests to run, this usually means a mismatch between your config and your test files:
254+
255+
- Verify your `--grep` pattern matches actual test tags or projects
256+
- Verify the `testDir` path in `playwright.config.ts` matches the actual directory containing your test files
257+
- Ensure path aliases (`~/`, `@/`) in imports are configured in your `tsconfig.json`, or replace them with relative paths

detect/synthetic-monitoring/playwright-checks/custom-dependencies.mdx

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,4 +189,19 @@ If Checkly uses the wrong package manager:
189189
If package installation exceeds time limits:
190190

191191
- Check for large dependencies that can be optimized
192-
- Consider using a custom `installCommand` to install only required packages
192+
- Consider using a custom `installCommand` to install only required packages
193+
194+
### Memory usage exceeded
195+
196+
If you see errors indicating that memory limits were exceeded during installation:
197+
198+
- Optimize your dependencies to reduce memory consumption
199+
- Consider using a custom `installCommand` to install only necessary packages
200+
201+
### General installation failures
202+
203+
If you encounter general installation errors:
204+
205+
- Review the full error logs for specific issues
206+
- Ensure all dependencies are compatible with the Node.js version used by Checkly
207+
- Consider using a custom `installCommand` to handle complex installations

detect/synthetic-monitoring/playwright-checks/timeouts.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ Failed to run install command
7171
- Check if your registry is slow or has issues
7272
- Update and commit your lock file
7373

74+
See the [Custom dependencies troubleshooting guide](/detect/synthetic-monitoring/playwright-checks/custom-dependencies#troubleshooting) for more detailed solutions.
75+
7476
### Global timeout exceeded
7577

7678
```

0 commit comments

Comments
 (0)