form-tester 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/skills/playwright-cli/SKILL.md +278 -0
- package/.claude/skills/playwright-cli/references/request-mocking.md +87 -0
- package/.claude/skills/playwright-cli/references/running-code.md +232 -0
- package/.claude/skills/playwright-cli/references/session-management.md +169 -0
- package/.claude/skills/playwright-cli/references/storage-state.md +275 -0
- package/.claude/skills/playwright-cli/references/test-generation.md +88 -0
- package/.claude/skills/playwright-cli/references/tracing.md +139 -0
- package/.claude/skills/playwright-cli/references/video-recording.md +43 -0
- package/README.md +75 -0
- package/form-tester.config.example.json +3 -0
- package/form-tester.js +984 -0
- package/package.json +26 -0
- package/tests/form-tester.test.js +120 -0
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# Browser Session Management
|
|
2
|
+
|
|
3
|
+
Run multiple isolated browser sessions concurrently with state persistence.
|
|
4
|
+
|
|
5
|
+
## Named Browser Sessions
|
|
6
|
+
|
|
7
|
+
Use `-s` flag to isolate browser contexts:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Browser 1: Authentication flow
|
|
11
|
+
playwright-cli -s=auth open https://app.example.com/login
|
|
12
|
+
|
|
13
|
+
# Browser 2: Public browsing (separate cookies, storage)
|
|
14
|
+
playwright-cli -s=public open https://example.com
|
|
15
|
+
|
|
16
|
+
# Commands are isolated by browser session
|
|
17
|
+
playwright-cli -s=auth fill e1 "user@example.com"
|
|
18
|
+
playwright-cli -s=public snapshot
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Browser Session Isolation Properties
|
|
22
|
+
|
|
23
|
+
Each browser session has independent:
|
|
24
|
+
- Cookies
|
|
25
|
+
- LocalStorage / SessionStorage
|
|
26
|
+
- IndexedDB
|
|
27
|
+
- Cache
|
|
28
|
+
- Browsing history
|
|
29
|
+
- Open tabs
|
|
30
|
+
|
|
31
|
+
## Browser Session Commands
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# List all browser sessions
|
|
35
|
+
playwright-cli list
|
|
36
|
+
|
|
37
|
+
# Stop a browser session (close the browser)
|
|
38
|
+
playwright-cli close # stop the default browser
|
|
39
|
+
playwright-cli -s=mysession close # stop a named browser
|
|
40
|
+
|
|
41
|
+
# Stop all browser sessions
|
|
42
|
+
playwright-cli close-all
|
|
43
|
+
|
|
44
|
+
# Forcefully kill all daemon processes (for stale/zombie processes)
|
|
45
|
+
playwright-cli kill-all
|
|
46
|
+
|
|
47
|
+
# Delete browser session user data (profile directory)
|
|
48
|
+
playwright-cli delete-data # delete default browser data
|
|
49
|
+
playwright-cli -s=mysession delete-data # delete named browser data
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Environment Variable
|
|
53
|
+
|
|
54
|
+
Set a default browser session name via environment variable:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
export PLAYWRIGHT_CLI_SESSION="mysession"
|
|
58
|
+
playwright-cli open example.com # Uses "mysession" automatically
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Common Patterns
|
|
62
|
+
|
|
63
|
+
### Concurrent Scraping
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
#!/bin/bash
|
|
67
|
+
# Scrape multiple sites concurrently
|
|
68
|
+
|
|
69
|
+
# Start all browsers
|
|
70
|
+
playwright-cli -s=site1 open https://site1.com &
|
|
71
|
+
playwright-cli -s=site2 open https://site2.com &
|
|
72
|
+
playwright-cli -s=site3 open https://site3.com &
|
|
73
|
+
wait
|
|
74
|
+
|
|
75
|
+
# Take snapshots from each
|
|
76
|
+
playwright-cli -s=site1 snapshot
|
|
77
|
+
playwright-cli -s=site2 snapshot
|
|
78
|
+
playwright-cli -s=site3 snapshot
|
|
79
|
+
|
|
80
|
+
# Cleanup
|
|
81
|
+
playwright-cli close-all
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### A/B Testing Sessions
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
# Test different user experiences
|
|
88
|
+
playwright-cli -s=variant-a open "https://app.com?variant=a"
|
|
89
|
+
playwright-cli -s=variant-b open "https://app.com?variant=b"
|
|
90
|
+
|
|
91
|
+
# Compare
|
|
92
|
+
playwright-cli -s=variant-a screenshot
|
|
93
|
+
playwright-cli -s=variant-b screenshot
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Persistent Profile
|
|
97
|
+
|
|
98
|
+
By default, browser profile is kept in memory only. Use `--persistent` flag on `open` to persist the browser profile to disk:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
# Use persistent profile (auto-generated location)
|
|
102
|
+
playwright-cli open https://example.com --persistent
|
|
103
|
+
|
|
104
|
+
# Use persistent profile with custom directory
|
|
105
|
+
playwright-cli open https://example.com --profile=/path/to/profile
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Default Browser Session
|
|
109
|
+
|
|
110
|
+
When `-s` is omitted, commands use the default browser session:
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
# These use the same default browser session
|
|
114
|
+
playwright-cli open https://example.com
|
|
115
|
+
playwright-cli snapshot
|
|
116
|
+
playwright-cli close # Stops default browser
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Browser Session Configuration
|
|
120
|
+
|
|
121
|
+
Configure a browser session with specific settings when opening:
|
|
122
|
+
|
|
123
|
+
```bash
|
|
124
|
+
# Open with config file
|
|
125
|
+
playwright-cli open https://example.com --config=.playwright/my-cli.json
|
|
126
|
+
|
|
127
|
+
# Open with specific browser
|
|
128
|
+
playwright-cli open https://example.com --browser=firefox
|
|
129
|
+
|
|
130
|
+
# Open in headed mode
|
|
131
|
+
playwright-cli open https://example.com --headed
|
|
132
|
+
|
|
133
|
+
# Open with persistent profile
|
|
134
|
+
playwright-cli open https://example.com --persistent
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
## Best Practices
|
|
138
|
+
|
|
139
|
+
### 1. Name Browser Sessions Semantically
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
# GOOD: Clear purpose
|
|
143
|
+
playwright-cli -s=github-auth open https://github.com
|
|
144
|
+
playwright-cli -s=docs-scrape open https://docs.example.com
|
|
145
|
+
|
|
146
|
+
# AVOID: Generic names
|
|
147
|
+
playwright-cli -s=s1 open https://github.com
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### 2. Always Clean Up
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
# Stop browsers when done
|
|
154
|
+
playwright-cli -s=auth close
|
|
155
|
+
playwright-cli -s=scrape close
|
|
156
|
+
|
|
157
|
+
# Or stop all at once
|
|
158
|
+
playwright-cli close-all
|
|
159
|
+
|
|
160
|
+
# If browsers become unresponsive or zombie processes remain
|
|
161
|
+
playwright-cli kill-all
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### 3. Delete Stale Browser Data
|
|
165
|
+
|
|
166
|
+
```bash
|
|
167
|
+
# Remove old browser data to free disk space
|
|
168
|
+
playwright-cli -s=oldsession delete-data
|
|
169
|
+
```
|
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
# Storage Management
|
|
2
|
+
|
|
3
|
+
Manage cookies, localStorage, sessionStorage, and browser storage state.
|
|
4
|
+
|
|
5
|
+
## Storage State
|
|
6
|
+
|
|
7
|
+
Save and restore complete browser state including cookies and storage.
|
|
8
|
+
|
|
9
|
+
### Save Storage State
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
# Save to auto-generated filename (storage-state-{timestamp}.json)
|
|
13
|
+
playwright-cli state-save
|
|
14
|
+
|
|
15
|
+
# Save to specific filename
|
|
16
|
+
playwright-cli state-save my-auth-state.json
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Restore Storage State
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# Load storage state from file
|
|
23
|
+
playwright-cli state-load my-auth-state.json
|
|
24
|
+
|
|
25
|
+
# Reload page to apply cookies
|
|
26
|
+
playwright-cli open https://example.com
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Storage State File Format
|
|
30
|
+
|
|
31
|
+
The saved file contains:
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
"cookies": [
|
|
36
|
+
{
|
|
37
|
+
"name": "session_id",
|
|
38
|
+
"value": "abc123",
|
|
39
|
+
"domain": "example.com",
|
|
40
|
+
"path": "/",
|
|
41
|
+
"expires": 1735689600,
|
|
42
|
+
"httpOnly": true,
|
|
43
|
+
"secure": true,
|
|
44
|
+
"sameSite": "Lax"
|
|
45
|
+
}
|
|
46
|
+
],
|
|
47
|
+
"origins": [
|
|
48
|
+
{
|
|
49
|
+
"origin": "https://example.com",
|
|
50
|
+
"localStorage": [
|
|
51
|
+
{ "name": "theme", "value": "dark" },
|
|
52
|
+
{ "name": "user_id", "value": "12345" }
|
|
53
|
+
]
|
|
54
|
+
}
|
|
55
|
+
]
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Cookies
|
|
60
|
+
|
|
61
|
+
### List All Cookies
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
playwright-cli cookie-list
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Filter Cookies by Domain
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
playwright-cli cookie-list --domain=example.com
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Filter Cookies by Path
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
playwright-cli cookie-list --path=/api
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Get Specific Cookie
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
playwright-cli cookie-get session_id
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Set a Cookie
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
# Basic cookie
|
|
89
|
+
playwright-cli cookie-set session abc123
|
|
90
|
+
|
|
91
|
+
# Cookie with options
|
|
92
|
+
playwright-cli cookie-set session abc123 --domain=example.com --path=/ --httpOnly --secure --sameSite=Lax
|
|
93
|
+
|
|
94
|
+
# Cookie with expiration (Unix timestamp)
|
|
95
|
+
playwright-cli cookie-set remember_me token123 --expires=1735689600
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Delete a Cookie
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
playwright-cli cookie-delete session_id
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Clear All Cookies
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
playwright-cli cookie-clear
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Advanced: Multiple Cookies or Custom Options
|
|
111
|
+
|
|
112
|
+
For complex scenarios like adding multiple cookies at once, use `run-code`:
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
playwright-cli run-code "async page => {
|
|
116
|
+
await page.context().addCookies([
|
|
117
|
+
{ name: 'session_id', value: 'sess_abc123', domain: 'example.com', path: '/', httpOnly: true },
|
|
118
|
+
{ name: 'preferences', value: JSON.stringify({ theme: 'dark' }), domain: 'example.com', path: '/' }
|
|
119
|
+
]);
|
|
120
|
+
}"
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## Local Storage
|
|
124
|
+
|
|
125
|
+
### List All localStorage Items
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
playwright-cli localstorage-list
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Get Single Value
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
playwright-cli localstorage-get token
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Set Value
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
playwright-cli localstorage-set theme dark
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Set JSON Value
|
|
144
|
+
|
|
145
|
+
```bash
|
|
146
|
+
playwright-cli localstorage-set user_settings '{"theme":"dark","language":"en"}'
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### Delete Single Item
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
playwright-cli localstorage-delete token
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Clear All localStorage
|
|
156
|
+
|
|
157
|
+
```bash
|
|
158
|
+
playwright-cli localstorage-clear
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### Advanced: Multiple Operations
|
|
162
|
+
|
|
163
|
+
For complex scenarios like setting multiple values at once, use `run-code`:
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
playwright-cli run-code "async page => {
|
|
167
|
+
await page.evaluate(() => {
|
|
168
|
+
localStorage.setItem('token', 'jwt_abc123');
|
|
169
|
+
localStorage.setItem('user_id', '12345');
|
|
170
|
+
localStorage.setItem('expires_at', Date.now() + 3600000);
|
|
171
|
+
});
|
|
172
|
+
}"
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
## Session Storage
|
|
176
|
+
|
|
177
|
+
### List All sessionStorage Items
|
|
178
|
+
|
|
179
|
+
```bash
|
|
180
|
+
playwright-cli sessionstorage-list
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### Get Single Value
|
|
184
|
+
|
|
185
|
+
```bash
|
|
186
|
+
playwright-cli sessionstorage-get form_data
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Set Value
|
|
190
|
+
|
|
191
|
+
```bash
|
|
192
|
+
playwright-cli sessionstorage-set step 3
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Delete Single Item
|
|
196
|
+
|
|
197
|
+
```bash
|
|
198
|
+
playwright-cli sessionstorage-delete step
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### Clear sessionStorage
|
|
202
|
+
|
|
203
|
+
```bash
|
|
204
|
+
playwright-cli sessionstorage-clear
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
## IndexedDB
|
|
208
|
+
|
|
209
|
+
### List Databases
|
|
210
|
+
|
|
211
|
+
```bash
|
|
212
|
+
playwright-cli run-code "async page => {
|
|
213
|
+
return await page.evaluate(async () => {
|
|
214
|
+
const databases = await indexedDB.databases();
|
|
215
|
+
return databases;
|
|
216
|
+
});
|
|
217
|
+
}"
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Delete Database
|
|
221
|
+
|
|
222
|
+
```bash
|
|
223
|
+
playwright-cli run-code "async page => {
|
|
224
|
+
await page.evaluate(() => {
|
|
225
|
+
indexedDB.deleteDatabase('myDatabase');
|
|
226
|
+
});
|
|
227
|
+
}"
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
## Common Patterns
|
|
231
|
+
|
|
232
|
+
### Authentication State Reuse
|
|
233
|
+
|
|
234
|
+
```bash
|
|
235
|
+
# Step 1: Login and save state
|
|
236
|
+
playwright-cli open https://app.example.com/login
|
|
237
|
+
playwright-cli snapshot
|
|
238
|
+
playwright-cli fill e1 "user@example.com"
|
|
239
|
+
playwright-cli fill e2 "password123"
|
|
240
|
+
playwright-cli click e3
|
|
241
|
+
|
|
242
|
+
# Save the authenticated state
|
|
243
|
+
playwright-cli state-save auth.json
|
|
244
|
+
|
|
245
|
+
# Step 2: Later, restore state and skip login
|
|
246
|
+
playwright-cli state-load auth.json
|
|
247
|
+
playwright-cli open https://app.example.com/dashboard
|
|
248
|
+
# Already logged in!
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
### Save and Restore Roundtrip
|
|
252
|
+
|
|
253
|
+
```bash
|
|
254
|
+
# Set up authentication state
|
|
255
|
+
playwright-cli open https://example.com
|
|
256
|
+
playwright-cli eval "() => { document.cookie = 'session=abc123'; localStorage.setItem('user', 'john'); }"
|
|
257
|
+
|
|
258
|
+
# Save state to file
|
|
259
|
+
playwright-cli state-save my-session.json
|
|
260
|
+
|
|
261
|
+
# ... later, in a new session ...
|
|
262
|
+
|
|
263
|
+
# Restore state
|
|
264
|
+
playwright-cli state-load my-session.json
|
|
265
|
+
playwright-cli open https://example.com
|
|
266
|
+
# Cookies and localStorage are restored!
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
## Security Notes
|
|
270
|
+
|
|
271
|
+
- Never commit storage state files containing auth tokens
|
|
272
|
+
- Add `*.auth-state.json` to `.gitignore`
|
|
273
|
+
- Delete state files after automation completes
|
|
274
|
+
- Use environment variables for sensitive data
|
|
275
|
+
- By default, sessions run in-memory mode which is safer for sensitive operations
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# Test Generation
|
|
2
|
+
|
|
3
|
+
Generate Playwright test code automatically as you interact with the browser.
|
|
4
|
+
|
|
5
|
+
## How It Works
|
|
6
|
+
|
|
7
|
+
Every action you perform with `playwright-cli` generates corresponding Playwright TypeScript code.
|
|
8
|
+
This code appears in the output and can be copied directly into your test files.
|
|
9
|
+
|
|
10
|
+
## Example Workflow
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
# Start a session
|
|
14
|
+
playwright-cli open https://example.com/login
|
|
15
|
+
|
|
16
|
+
# Take a snapshot to see elements
|
|
17
|
+
playwright-cli snapshot
|
|
18
|
+
# Output shows: e1 [textbox "Email"], e2 [textbox "Password"], e3 [button "Sign In"]
|
|
19
|
+
|
|
20
|
+
# Fill form fields - generates code automatically
|
|
21
|
+
playwright-cli fill e1 "user@example.com"
|
|
22
|
+
# Ran Playwright code:
|
|
23
|
+
# await page.getByRole('textbox', { name: 'Email' }).fill('user@example.com');
|
|
24
|
+
|
|
25
|
+
playwright-cli fill e2 "password123"
|
|
26
|
+
# Ran Playwright code:
|
|
27
|
+
# await page.getByRole('textbox', { name: 'Password' }).fill('password123');
|
|
28
|
+
|
|
29
|
+
playwright-cli click e3
|
|
30
|
+
# Ran Playwright code:
|
|
31
|
+
# await page.getByRole('button', { name: 'Sign In' }).click();
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Building a Test File
|
|
35
|
+
|
|
36
|
+
Collect the generated code into a Playwright test:
|
|
37
|
+
|
|
38
|
+
```typescript
|
|
39
|
+
import { test, expect } from '@playwright/test';
|
|
40
|
+
|
|
41
|
+
test('login flow', async ({ page }) => {
|
|
42
|
+
// Generated code from playwright-cli session:
|
|
43
|
+
await page.goto('https://example.com/login');
|
|
44
|
+
await page.getByRole('textbox', { name: 'Email' }).fill('user@example.com');
|
|
45
|
+
await page.getByRole('textbox', { name: 'Password' }).fill('password123');
|
|
46
|
+
await page.getByRole('button', { name: 'Sign In' }).click();
|
|
47
|
+
|
|
48
|
+
// Add assertions
|
|
49
|
+
await expect(page).toHaveURL(/.*dashboard/);
|
|
50
|
+
});
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Best Practices
|
|
54
|
+
|
|
55
|
+
### 1. Use Semantic Locators
|
|
56
|
+
|
|
57
|
+
The generated code uses role-based locators when possible, which are more resilient:
|
|
58
|
+
|
|
59
|
+
```typescript
|
|
60
|
+
// Generated (good - semantic)
|
|
61
|
+
await page.getByRole('button', { name: 'Submit' }).click();
|
|
62
|
+
|
|
63
|
+
// Avoid (fragile - CSS selectors)
|
|
64
|
+
await page.locator('#submit-btn').click();
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### 2. Explore Before Recording
|
|
68
|
+
|
|
69
|
+
Take snapshots to understand the page structure before recording actions:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
playwright-cli open https://example.com
|
|
73
|
+
playwright-cli snapshot
|
|
74
|
+
# Review the element structure
|
|
75
|
+
playwright-cli click e5
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### 3. Add Assertions Manually
|
|
79
|
+
|
|
80
|
+
Generated code captures actions but not assertions. Add expectations in your test:
|
|
81
|
+
|
|
82
|
+
```typescript
|
|
83
|
+
// Generated action
|
|
84
|
+
await page.getByRole('button', { name: 'Submit' }).click();
|
|
85
|
+
|
|
86
|
+
// Manual assertion
|
|
87
|
+
await expect(page.getByText('Success')).toBeVisible();
|
|
88
|
+
```
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
# Tracing
|
|
2
|
+
|
|
3
|
+
Capture detailed execution traces for debugging and analysis. Traces include DOM snapshots, screenshots, network activity, and console logs.
|
|
4
|
+
|
|
5
|
+
## Basic Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# Start trace recording
|
|
9
|
+
playwright-cli tracing-start
|
|
10
|
+
|
|
11
|
+
# Perform actions
|
|
12
|
+
playwright-cli open https://example.com
|
|
13
|
+
playwright-cli click e1
|
|
14
|
+
playwright-cli fill e2 "test"
|
|
15
|
+
|
|
16
|
+
# Stop trace recording
|
|
17
|
+
playwright-cli tracing-stop
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Trace Output Files
|
|
21
|
+
|
|
22
|
+
When you start tracing, Playwright creates a `traces/` directory with several files:
|
|
23
|
+
|
|
24
|
+
### `trace-{timestamp}.trace`
|
|
25
|
+
|
|
26
|
+
**Action log** - The main trace file containing:
|
|
27
|
+
- Every action performed (clicks, fills, navigations)
|
|
28
|
+
- DOM snapshots before and after each action
|
|
29
|
+
- Screenshots at each step
|
|
30
|
+
- Timing information
|
|
31
|
+
- Console messages
|
|
32
|
+
- Source locations
|
|
33
|
+
|
|
34
|
+
### `trace-{timestamp}.network`
|
|
35
|
+
|
|
36
|
+
**Network log** - Complete network activity:
|
|
37
|
+
- All HTTP requests and responses
|
|
38
|
+
- Request headers and bodies
|
|
39
|
+
- Response headers and bodies
|
|
40
|
+
- Timing (DNS, connect, TLS, TTFB, download)
|
|
41
|
+
- Resource sizes
|
|
42
|
+
- Failed requests and errors
|
|
43
|
+
|
|
44
|
+
### `resources/`
|
|
45
|
+
|
|
46
|
+
**Resources directory** - Cached resources:
|
|
47
|
+
- Images, fonts, stylesheets, scripts
|
|
48
|
+
- Response bodies for replay
|
|
49
|
+
- Assets needed to reconstruct page state
|
|
50
|
+
|
|
51
|
+
## What Traces Capture
|
|
52
|
+
|
|
53
|
+
| Category | Details |
|
|
54
|
+
|----------|---------|
|
|
55
|
+
| **Actions** | Clicks, fills, hovers, keyboard input, navigations |
|
|
56
|
+
| **DOM** | Full DOM snapshot before/after each action |
|
|
57
|
+
| **Screenshots** | Visual state at each step |
|
|
58
|
+
| **Network** | All requests, responses, headers, bodies, timing |
|
|
59
|
+
| **Console** | All console.log, warn, error messages |
|
|
60
|
+
| **Timing** | Precise timing for each operation |
|
|
61
|
+
|
|
62
|
+
## Use Cases
|
|
63
|
+
|
|
64
|
+
### Debugging Failed Actions
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
playwright-cli tracing-start
|
|
68
|
+
playwright-cli open https://app.example.com
|
|
69
|
+
|
|
70
|
+
# This click fails - why?
|
|
71
|
+
playwright-cli click e5
|
|
72
|
+
|
|
73
|
+
playwright-cli tracing-stop
|
|
74
|
+
# Open trace to see DOM state when click was attempted
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Analyzing Performance
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
playwright-cli tracing-start
|
|
81
|
+
playwright-cli open https://slow-site.com
|
|
82
|
+
playwright-cli tracing-stop
|
|
83
|
+
|
|
84
|
+
# View network waterfall to identify slow resources
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Capturing Evidence
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
# Record a complete user flow for documentation
|
|
91
|
+
playwright-cli tracing-start
|
|
92
|
+
|
|
93
|
+
playwright-cli open https://app.example.com/checkout
|
|
94
|
+
playwright-cli fill e1 "4111111111111111"
|
|
95
|
+
playwright-cli fill e2 "12/25"
|
|
96
|
+
playwright-cli fill e3 "123"
|
|
97
|
+
playwright-cli click e4
|
|
98
|
+
|
|
99
|
+
playwright-cli tracing-stop
|
|
100
|
+
# Trace shows exact sequence of events
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Trace vs Video vs Screenshot
|
|
104
|
+
|
|
105
|
+
| Feature | Trace | Video | Screenshot |
|
|
106
|
+
|---------|-------|-------|------------|
|
|
107
|
+
| **Format** | .trace file | .webm video | .png/.jpeg image |
|
|
108
|
+
| **DOM inspection** | Yes | No | No |
|
|
109
|
+
| **Network details** | Yes | No | No |
|
|
110
|
+
| **Step-by-step replay** | Yes | Continuous | Single frame |
|
|
111
|
+
| **File size** | Medium | Large | Small |
|
|
112
|
+
| **Best for** | Debugging | Demos | Quick capture |
|
|
113
|
+
|
|
114
|
+
## Best Practices
|
|
115
|
+
|
|
116
|
+
### 1. Start Tracing Before the Problem
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
# Trace the entire flow, not just the failing step
|
|
120
|
+
playwright-cli tracing-start
|
|
121
|
+
playwright-cli open https://example.com
|
|
122
|
+
# ... all steps leading to the issue ...
|
|
123
|
+
playwright-cli tracing-stop
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### 2. Clean Up Old Traces
|
|
127
|
+
|
|
128
|
+
Traces can consume significant disk space:
|
|
129
|
+
|
|
130
|
+
```bash
|
|
131
|
+
# Remove traces older than 7 days
|
|
132
|
+
find .playwright-cli/traces -mtime +7 -delete
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
## Limitations
|
|
136
|
+
|
|
137
|
+
- Traces add overhead to automation
|
|
138
|
+
- Large traces can consume significant disk space
|
|
139
|
+
- Some dynamic content may not replay perfectly
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Video Recording
|
|
2
|
+
|
|
3
|
+
Capture browser automation sessions as video for debugging, documentation, or verification. Produces WebM (VP8/VP9 codec).
|
|
4
|
+
|
|
5
|
+
## Basic Recording
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
# Start recording
|
|
9
|
+
playwright-cli video-start
|
|
10
|
+
|
|
11
|
+
# Perform actions
|
|
12
|
+
playwright-cli open https://example.com
|
|
13
|
+
playwright-cli snapshot
|
|
14
|
+
playwright-cli click e1
|
|
15
|
+
playwright-cli fill e2 "test input"
|
|
16
|
+
|
|
17
|
+
# Stop and save
|
|
18
|
+
playwright-cli video-stop demo.webm
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Best Practices
|
|
22
|
+
|
|
23
|
+
### 1. Use Descriptive Filenames
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
# Include context in filename
|
|
27
|
+
playwright-cli video-stop recordings/login-flow-2024-01-15.webm
|
|
28
|
+
playwright-cli video-stop recordings/checkout-test-run-42.webm
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Tracing vs Video
|
|
32
|
+
|
|
33
|
+
| Feature | Video | Tracing |
|
|
34
|
+
|---------|-------|---------|
|
|
35
|
+
| Output | WebM file | Trace file (viewable in Trace Viewer) |
|
|
36
|
+
| Shows | Visual recording | DOM snapshots, network, console, actions |
|
|
37
|
+
| Use case | Demos, documentation | Debugging, analysis |
|
|
38
|
+
| Size | Larger | Smaller |
|
|
39
|
+
|
|
40
|
+
## Limitations
|
|
41
|
+
|
|
42
|
+
- Recording adds slight overhead to automation
|
|
43
|
+
- Large recordings can consume significant disk space
|