playwriter 0.0.16 → 0.0.21

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.
Files changed (47) hide show
  1. package/dist/cdp-session.d.ts +21 -0
  2. package/dist/cdp-session.d.ts.map +1 -0
  3. package/dist/cdp-session.js +131 -0
  4. package/dist/cdp-session.js.map +1 -0
  5. package/dist/cdp-types.d.ts +15 -0
  6. package/dist/cdp-types.d.ts.map +1 -1
  7. package/dist/cdp-types.js.map +1 -1
  8. package/dist/create-logger.d.ts +9 -0
  9. package/dist/create-logger.d.ts.map +1 -0
  10. package/dist/create-logger.js +43 -0
  11. package/dist/create-logger.js.map +1 -0
  12. package/dist/extension/cdp-relay.d.ts +7 -3
  13. package/dist/extension/cdp-relay.d.ts.map +1 -1
  14. package/dist/extension/cdp-relay.js +22 -12
  15. package/dist/extension/cdp-relay.js.map +1 -1
  16. package/dist/mcp.js +86 -44
  17. package/dist/mcp.js.map +1 -1
  18. package/dist/mcp.test.d.ts.map +1 -1
  19. package/dist/mcp.test.js +669 -183
  20. package/dist/mcp.test.js.map +1 -1
  21. package/dist/prompt.md +38 -8
  22. package/dist/selector-generator.js +331 -0
  23. package/dist/start-relay-server.d.ts +1 -3
  24. package/dist/start-relay-server.d.ts.map +1 -1
  25. package/dist/start-relay-server.js +3 -16
  26. package/dist/start-relay-server.js.map +1 -1
  27. package/dist/utils.d.ts +3 -0
  28. package/dist/utils.d.ts.map +1 -1
  29. package/dist/utils.js +36 -0
  30. package/dist/utils.js.map +1 -1
  31. package/dist/wait-for-page-load.d.ts +16 -0
  32. package/dist/wait-for-page-load.d.ts.map +1 -0
  33. package/dist/wait-for-page-load.js +126 -0
  34. package/dist/wait-for-page-load.js.map +1 -0
  35. package/package.json +16 -12
  36. package/src/cdp-session.ts +156 -0
  37. package/src/cdp-types.ts +6 -0
  38. package/src/create-logger.ts +56 -0
  39. package/src/debugger.md +453 -0
  40. package/src/extension/cdp-relay.ts +32 -14
  41. package/src/mcp.test.ts +795 -189
  42. package/src/mcp.ts +101 -47
  43. package/src/prompt.md +38 -8
  44. package/src/snapshots/shadcn-ui-accessibility.md +94 -91
  45. package/src/start-relay-server.ts +3 -20
  46. package/src/utils.ts +45 -0
  47. package/src/wait-for-page-load.ts +173 -0
package/src/mcp.test.ts CHANGED
@@ -8,17 +8,21 @@ import fs from 'node:fs'
8
8
  import os from 'node:os'
9
9
  import { getCdpUrl } from './utils.js'
10
10
  import type { ExtensionState } from 'mcp-extension/src/types.js'
11
+ import type { Protocol } from 'devtools-protocol'
12
+ import { imageSize } from 'image-size'
13
+ import { getCDPSessionForPage } from './cdp-session.js'
14
+ import { startPlayWriterCDPRelayServer, type RelayServer } from './extension/cdp-relay.js'
15
+ import { createFileLogger } from './create-logger.js'
16
+ import type { CDPCommand } from './cdp-types.js'
11
17
 
12
- import { spawn } from 'node:child_process'
18
+ declare const window: any
19
+ declare const document: any
13
20
 
14
21
 
15
22
  const execAsync = promisify(exec)
16
23
 
17
24
  async function getExtensionServiceWorker(context: BrowserContext) {
18
-
19
25
  let serviceWorkers = context.serviceWorkers().filter(sw => sw.url().startsWith('chrome-extension://'))
20
-
21
-
22
26
  let serviceWorker = serviceWorkers[0]
23
27
  if (!serviceWorker) {
24
28
  serviceWorker = await context.waitForEvent('serviceworker', {
@@ -26,6 +30,14 @@ async function getExtensionServiceWorker(context: BrowserContext) {
26
30
  })
27
31
  }
28
32
 
33
+ for (let i = 0; i < 50; i++) {
34
+ const isReady = await serviceWorker.evaluate(() => {
35
+ // @ts-ignore
36
+ return typeof globalThis.toggleExtensionForActiveTab === 'function'
37
+ })
38
+ if (isReady) break
39
+ await new Promise(r => setTimeout(r, 100))
40
+ }
29
41
 
30
42
  return serviceWorker
31
43
  }
@@ -51,6 +63,68 @@ async function killProcessOnPort(port: number): Promise<void> {
51
63
  }
52
64
  }
53
65
 
66
+ interface TestContext {
67
+ browserContext: Awaited<ReturnType<typeof chromium.launchPersistentContext>>
68
+ userDataDir: string
69
+ relayServer: RelayServer
70
+ }
71
+
72
+ async function setupTestContext({ tempDirPrefix }: { tempDirPrefix: string }): Promise<TestContext> {
73
+ await killProcessOnPort(19988)
74
+
75
+ console.log('Building extension...')
76
+ await execAsync('TESTING=1 pnpm build', { cwd: '../extension' })
77
+ console.log('Extension built')
78
+
79
+ const localLogPath = path.join(process.cwd(), 'relay-server.log')
80
+ const logger = createFileLogger({ logFilePath: localLogPath })
81
+ const relayServer = await startPlayWriterCDPRelayServer({ port: 19988, logger })
82
+
83
+ const userDataDir = fs.mkdtempSync(path.join(os.tmpdir(), tempDirPrefix))
84
+ const extensionPath = path.resolve('../extension/dist')
85
+
86
+ const browserContext = await chromium.launchPersistentContext(userDataDir, {
87
+ channel: 'chromium',
88
+ headless: !process.env.HEADFUL,
89
+ colorScheme: 'dark',
90
+ args: [
91
+ `--disable-extensions-except=${extensionPath}`,
92
+ `--load-extension=${extensionPath}`,
93
+ ],
94
+ })
95
+
96
+ const serviceWorker = await getExtensionServiceWorker(browserContext)
97
+
98
+ const page = await browserContext.newPage()
99
+ await page.goto('about:blank')
100
+
101
+ await serviceWorker.evaluate(async () => {
102
+ await globalThis.toggleExtensionForActiveTab()
103
+ })
104
+
105
+ return { browserContext, userDataDir, relayServer }
106
+ }
107
+
108
+ async function cleanupTestContext(ctx: TestContext | null, cleanup?: (() => Promise<void>) | null): Promise<void> {
109
+ if (ctx?.browserContext) {
110
+ await ctx.browserContext.close()
111
+ }
112
+ if (ctx?.relayServer) {
113
+ ctx.relayServer.close()
114
+ }
115
+
116
+ if (ctx?.userDataDir) {
117
+ try {
118
+ fs.rmSync(ctx.userDataDir, { recursive: true, force: true })
119
+ } catch (e) {
120
+ console.error('Failed to cleanup user data dir:', e)
121
+ }
122
+ }
123
+ if (cleanup) {
124
+ await cleanup()
125
+ }
126
+ }
127
+
54
128
  declare global {
55
129
  var toggleExtensionForActiveTab: () => Promise<{ isConnected: boolean; state: ExtensionState }>;
56
130
  var getExtensionState: () => ExtensionState;
@@ -60,106 +134,57 @@ declare global {
60
134
  describe('MCP Server Tests', () => {
61
135
  let client: Awaited<ReturnType<typeof createMCPClient>>['client']
62
136
  let cleanup: (() => Promise<void>) | null = null
63
- let browserContext: Awaited<ReturnType<typeof chromium.launchPersistentContext>> | null = null
64
- let userDataDir: string
65
- let relayServerProcess: any
137
+ let testCtx: TestContext | null = null
66
138
 
67
139
  beforeAll(async () => {
68
- await killProcessOnPort(19988)
69
-
70
- // Build extension
71
- console.log('Building extension...')
72
- await execAsync('TESTING=1 pnpm build', { cwd: '../extension' })
73
- console.log('Extension built')
74
-
75
- // Start Relay Server manually
76
- relayServerProcess = spawn('pnpm', ['tsx', 'src/start-relay-server.ts'], {
77
- cwd: process.cwd(),
78
- stdio: 'inherit'
79
- })
80
-
81
- // Wait for port 19988 to be ready
82
- await new Promise<void>((resolve, reject) => {
83
- let retries = 0
84
- const interval = setInterval(async () => {
85
- try {
86
- const { stdout } = await execAsync('lsof -ti:19988')
87
- if (stdout.trim()) {
88
- clearInterval(interval)
89
- resolve()
90
- }
91
- } catch {
92
- // ignore
93
- }
94
- retries++
95
- if (retries > 30) {
96
- clearInterval(interval)
97
- reject(new Error('Relay server failed to start'))
98
- }
99
- }, 1000)
100
- })
140
+ testCtx = await setupTestContext({ tempDirPrefix: 'pw-test-' })
101
141
 
102
142
  const result = await createMCPClient()
103
143
  client = result.client
104
144
  cleanup = result.cleanup
145
+ }, 600000)
105
146
 
106
- userDataDir = fs.mkdtempSync(path.join(os.tmpdir(), 'pw-test-'))
107
- const extensionPath = path.resolve('../extension/dist')
147
+ afterAll(async () => {
148
+ await cleanupTestContext(testCtx, cleanup)
149
+ cleanup = null
150
+ testCtx = null
151
+ })
108
152
 
109
- browserContext = await chromium.launchPersistentContext(userDataDir, {
110
- channel: 'chromium', // <- this opts into new headless
111
- headless: !process.env.HEADFUL,
112
- args: [
113
- `--disable-extensions-except=${extensionPath}`,
114
- `--load-extension=${extensionPath}`,
115
- ],
116
- })
153
+ const getBrowserContext = () => {
154
+ if (!testCtx?.browserContext) throw new Error('Browser not initialized')
155
+ return testCtx.browserContext
156
+ }
117
157
 
118
- // Wait for service worker and connect
158
+ it('should inject script via addScriptTag through CDP relay', async () => {
159
+ const browserContext = getBrowserContext()
119
160
  const serviceWorker = await getExtensionServiceWorker(browserContext)
120
161
 
121
- // Wait for extension to initialize global functions
122
- for (let i = 0; i < 50; i++) {
123
- const isReady = await serviceWorker.evaluate(() => {
124
- // @ts-ignore
125
- return typeof globalThis.toggleExtensionForActiveTab === 'function'
126
- })
127
- if (isReady) break
128
- await new Promise(r => setTimeout(r, 100))
129
- }
130
-
131
- // Create a page to attach to
132
162
  const page = await browserContext.newPage()
133
- await page.goto('about:blank')
163
+ await page.setContent('<html><body><button id="btn">Click</button></body></html>')
164
+ await page.bringToFront()
134
165
 
135
- // Connect the tab
136
166
  await serviceWorker.evaluate(async () => {
137
- await globalThis.toggleExtensionForActiveTab()
167
+ await globalThis.toggleExtensionForActiveTab()
138
168
  })
169
+ await new Promise(r => setTimeout(r, 500))
139
170
 
140
- }, 600000) // 10 minutes timeout
171
+ const browser = await chromium.connectOverCDP(getCdpUrl())
172
+ const cdpPage = browser.contexts()[0].pages().find(p => {
173
+ return p.url().startsWith('about:')
174
+ })
175
+ expect(cdpPage).toBeDefined()
141
176
 
142
- afterAll(async () => {
143
- if (browserContext) {
144
- await browserContext.close()
145
- }
146
- if (relayServerProcess) {
147
- relayServerProcess.kill()
148
- }
149
- await killProcessOnPort(19988)
177
+ const hasGlobalBefore = await cdpPage!.evaluate(() => !!(globalThis as any).__testGlobal)
178
+ expect(hasGlobalBefore).toBe(false)
150
179
 
151
- if (userDataDir) {
152
- try {
153
- fs.rmSync(userDataDir, { recursive: true, force: true })
154
- } catch (e) {
155
- console.error('Failed to cleanup user data dir:', e)
156
- }
157
- }
158
- if (cleanup) {
159
- await cleanup()
160
- cleanup = null
161
- }
162
- })
180
+ await cdpPage!.addScriptTag({ content: 'globalThis.__testGlobal = { foo: "bar" };' })
181
+
182
+ const hasGlobalAfter = await cdpPage!.evaluate(() => (globalThis as any).__testGlobal)
183
+ expect(hasGlobalAfter).toEqual({ foo: 'bar' })
184
+
185
+ await browser.close()
186
+ await page.close()
187
+ }, 60000)
163
188
 
164
189
  it('should execute code and capture console output', async () => {
165
190
  await client.callTool({
@@ -204,7 +229,7 @@ describe('MCP Server Tests', () => {
204
229
  }, 30000)
205
230
 
206
231
  it('should show extension as connected for pages created via newPage()', async () => {
207
- if (!browserContext) throw new Error('Browser not initialized')
232
+ const browserContext = getBrowserContext()
208
233
  const serviceWorker = await getExtensionServiceWorker(browserContext)
209
234
 
210
235
  // Create a page via MCP (which uses context.newPage())
@@ -341,9 +366,7 @@ describe('MCP Server Tests', () => {
341
366
  })
342
367
 
343
368
  it('should handle new pages and toggling with new connections', async () => {
344
- if (!browserContext) throw new Error('Browser not initialized')
345
-
346
- // Find the correct service worker by URL
369
+ const browserContext = getBrowserContext()
347
370
  const serviceWorker = await getExtensionServiceWorker(browserContext)
348
371
 
349
372
  // 1. Create a new page
@@ -430,8 +453,7 @@ describe('MCP Server Tests', () => {
430
453
  })
431
454
 
432
455
  it('should handle new pages and toggling with persistent connection', async () => {
433
- if (!browserContext) throw new Error('Browser not initialized')
434
-
456
+ const browserContext = getBrowserContext()
435
457
  const serviceWorker = await getExtensionServiceWorker(browserContext)
436
458
 
437
459
  // Connect once
@@ -502,7 +524,7 @@ describe('MCP Server Tests', () => {
502
524
  await directBrowser.close()
503
525
  })
504
526
  it('should maintain connection across reloads and navigation', async () => {
505
- if (!browserContext) throw new Error('Browser not initialized')
527
+ const browserContext = getBrowserContext()
506
528
  const serviceWorker = await getExtensionServiceWorker(browserContext)
507
529
 
508
530
  // 1. Setup page
@@ -551,93 +573,7 @@ describe('MCP Server Tests', () => {
551
573
  })
552
574
 
553
575
  it('should support multiple concurrent tabs', async () => {
554
- if (!browserContext) throw new Error('Browser not initialized')
555
- const serviceWorker = await getExtensionServiceWorker(browserContext)
556
- await new Promise(resolve => setTimeout(resolve, 500))
557
-
558
- // Tab A
559
- const pageA = await browserContext.newPage()
560
- await pageA.goto('https://example.com/tab-a')
561
- await pageA.bringToFront()
562
- await new Promise(resolve => setTimeout(resolve, 500))
563
- await serviceWorker.evaluate(async () => {
564
- await globalThis.toggleExtensionForActiveTab()
565
- })
566
-
567
- // Tab B
568
- const pageB = await browserContext.newPage()
569
- await pageB.goto('https://example.com/tab-b')
570
- await pageB.bringToFront()
571
- await new Promise(resolve => setTimeout(resolve, 500))
572
- await serviceWorker.evaluate(async () => {
573
- await globalThis.toggleExtensionForActiveTab()
574
- })
575
-
576
- // Get target IDs for both
577
- const targetIds = await serviceWorker.evaluate(async () => {
578
- const state = globalThis.getExtensionState()
579
- const chrome = globalThis.chrome
580
- const tabs = await chrome.tabs.query({})
581
- const tabA = tabs.find((t: any) => t.url?.includes('tab-a'))
582
- const tabB = tabs.find((t: any) => t.url?.includes('tab-b'))
583
- return {
584
- idA: state.tabs.get(tabA?.id ?? -1)?.targetId,
585
- idB: state.tabs.get(tabB?.id ?? -1)?.targetId
586
- }
587
- })
588
-
589
- expect(targetIds).toMatchInlineSnapshot({
590
- idA: expect.any(String),
591
- idB: expect.any(String)
592
- }, `
593
- {
594
- "idA": Any<String>,
595
- "idB": Any<String>,
596
- }
597
- `)
598
- expect(targetIds.idA).not.toBe(targetIds.idB)
599
-
600
- // Verify independent connections
601
- const browser = await chromium.connectOverCDP(getCdpUrl())
602
-
603
- const pages = browser.contexts()[0].pages()
604
-
605
- const results = await Promise.all(pages.map(async (p) => ({
606
- url: p.url(),
607
- title: await p.title()
608
- })))
609
-
610
- expect(results).toMatchInlineSnapshot(`
611
- [
612
- {
613
- "title": "",
614
- "url": "about:blank",
615
- },
616
- {
617
- "title": "Example Domain",
618
- "url": "https://example.com/tab-a",
619
- },
620
- {
621
- "title": "Example Domain",
622
- "url": "https://example.com/tab-b",
623
- },
624
- ]
625
- `)
626
-
627
- // Verify execution on both pages
628
- const pageA_CDP = pages.find(p => p.url().includes('tab-a'))
629
- const pageB_CDP = pages.find(p => p.url().includes('tab-b'))
630
-
631
- expect(await pageA_CDP?.evaluate(() => 10 + 10)).toBe(20)
632
- expect(await pageB_CDP?.evaluate(() => 20 + 20)).toBe(40)
633
-
634
- await browser.close()
635
- await pageA.close()
636
- await pageB.close()
637
- })
638
-
639
- it('should support multiple concurrent tabs', async () => {
640
- if (!browserContext) throw new Error('Browser not initialized')
576
+ const browserContext = getBrowserContext()
641
577
  const serviceWorker = await getExtensionServiceWorker(browserContext)
642
578
  await new Promise(resolve => setTimeout(resolve, 500))
643
579
 
@@ -723,10 +659,9 @@ describe('MCP Server Tests', () => {
723
659
  })
724
660
 
725
661
  it('should show correct url when enabling extension after navigation', async () => {
726
- if (!browserContext) throw new Error('Browser not initialized')
662
+ const browserContext = getBrowserContext()
727
663
  const serviceWorker = await getExtensionServiceWorker(browserContext)
728
664
 
729
- // 1. Open a new page (extension not yet enabled for it)
730
665
  const page = await browserContext.newPage()
731
666
  const targetUrl = 'https://example.com/late-enable'
732
667
  await page.goto(targetUrl)
@@ -755,10 +690,9 @@ describe('MCP Server Tests', () => {
755
690
  })
756
691
 
757
692
  it('should be able to reconnect after disconnecting everything', async () => {
758
- if (!browserContext) throw new Error('Browser not initialized')
693
+ const browserContext = getBrowserContext()
759
694
  const serviceWorker = await getExtensionServiceWorker(browserContext)
760
695
 
761
- // 1. Use the existing about:blank page from beforeAll
762
696
  const pages = await browserContext.pages()
763
697
  expect(pages.length).toBeGreaterThan(0)
764
698
  const page = pages[0]
@@ -1233,7 +1167,7 @@ describe('MCP Server Tests', () => {
1233
1167
  }, 30000)
1234
1168
 
1235
1169
  it('should maintain correct page.url() with service worker pages', async () => {
1236
- if (!browserContext) throw new Error('Browser not initialized')
1170
+ const browserContext = getBrowserContext()
1237
1171
  const serviceWorker = await getExtensionServiceWorker(browserContext)
1238
1172
 
1239
1173
  const page = await browserContext.newPage()
@@ -1260,7 +1194,7 @@ describe('MCP Server Tests', () => {
1260
1194
  }, 30000)
1261
1195
 
1262
1196
  it('should maintain correct page.url() after repeated connections', async () => {
1263
- if (!browserContext) throw new Error('Browser not initialized')
1197
+ const browserContext = getBrowserContext()
1264
1198
  const serviceWorker = await getExtensionServiceWorker(browserContext)
1265
1199
 
1266
1200
  const page = await browserContext.newPage()
@@ -1288,7 +1222,7 @@ describe('MCP Server Tests', () => {
1288
1222
  }, 30000)
1289
1223
 
1290
1224
  it('should maintain correct page.url() with concurrent MCP and CDP connections', async () => {
1291
- if (!browserContext) throw new Error('Browser not initialized')
1225
+ const browserContext = getBrowserContext()
1292
1226
  const serviceWorker = await getExtensionServiceWorker(browserContext)
1293
1227
 
1294
1228
  const page = await browserContext.newPage()
@@ -1328,7 +1262,7 @@ describe('MCP Server Tests', () => {
1328
1262
  }, 30000)
1329
1263
 
1330
1264
  it('should maintain correct page.url() with iframe-heavy pages', async () => {
1331
- if (!browserContext) throw new Error('Browser not initialized')
1265
+ const browserContext = getBrowserContext()
1332
1266
  const serviceWorker = await getExtensionServiceWorker(browserContext)
1333
1267
 
1334
1268
  const page = await browserContext.newPage()
@@ -1357,8 +1291,362 @@ describe('MCP Server Tests', () => {
1357
1291
  await page.close()
1358
1292
  }, 60000)
1359
1293
 
1294
+ it('should capture screenshot correctly', async () => {
1295
+ const browserContext = getBrowserContext()
1296
+ const serviceWorker = await getExtensionServiceWorker(browserContext)
1297
+
1298
+ const page = await browserContext.newPage()
1299
+ await page.goto('https://example.com/')
1300
+ await page.bringToFront()
1301
+
1302
+ await serviceWorker.evaluate(async () => {
1303
+ await globalThis.toggleExtensionForActiveTab()
1304
+ })
1305
+
1306
+ await new Promise(r => setTimeout(r, 500))
1307
+
1308
+ const capturedCommands: CDPCommand[] = []
1309
+ const commandHandler = ({ command }: { clientId: string; command: CDPCommand }) => {
1310
+ if (command.method === 'Page.captureScreenshot') {
1311
+ capturedCommands.push(command)
1312
+ }
1313
+ }
1314
+ testCtx!.relayServer.on('cdp:command', commandHandler)
1315
+
1316
+ const browser = await chromium.connectOverCDP(getCdpUrl())
1317
+ const cdpPage = browser.contexts()[0].pages().find(p => p.url().includes('example.com'))
1318
+
1319
+ expect(cdpPage).toBeDefined()
1320
+
1321
+ const viewportSize = cdpPage!.viewportSize()
1322
+ console.log('Viewport size:', viewportSize)
1323
+
1324
+ const viewportScreenshot = await cdpPage!.screenshot()
1325
+ expect(viewportScreenshot).toBeDefined()
1326
+
1327
+ const viewportDimensions = imageSize(viewportScreenshot)
1328
+ console.log('Viewport screenshot dimensions:', viewportDimensions)
1329
+ expect(viewportDimensions.width).toBeGreaterThan(0)
1330
+ expect(viewportDimensions.height).toBeGreaterThan(0)
1331
+ if (viewportSize) {
1332
+ expect(viewportDimensions.width).toBe(viewportSize.width)
1333
+ expect(viewportDimensions.height).toBe(viewportSize.height)
1334
+ }
1335
+
1336
+ const fullPageScreenshot = await cdpPage!.screenshot({ fullPage: true })
1337
+ expect(fullPageScreenshot).toBeDefined()
1338
+
1339
+ const fullPageDimensions = imageSize(fullPageScreenshot)
1340
+ console.log('Full page screenshot dimensions:', fullPageDimensions)
1341
+ expect(fullPageDimensions.width).toBeGreaterThan(0)
1342
+ expect(fullPageDimensions.height).toBeGreaterThan(0)
1343
+ expect(fullPageDimensions.width).toBeGreaterThanOrEqual(viewportDimensions.width!)
1344
+
1345
+ testCtx!.relayServer.off('cdp:command', commandHandler)
1346
+
1347
+ expect(capturedCommands.length).toBe(2)
1348
+ expect(capturedCommands.map(c => ({
1349
+ method: c.method,
1350
+ params: c.params
1351
+ }))).toMatchInlineSnapshot(`
1352
+ [
1353
+ {
1354
+ "method": "Page.captureScreenshot",
1355
+ "params": {
1356
+ "captureBeyondViewport": false,
1357
+ "clip": {
1358
+ "height": 720,
1359
+ "scale": 1,
1360
+ "width": 1280,
1361
+ "x": 0,
1362
+ "y": 0,
1363
+ },
1364
+ "format": "png",
1365
+ },
1366
+ },
1367
+ {
1368
+ "method": "Page.captureScreenshot",
1369
+ "params": {
1370
+ "captureBeyondViewport": false,
1371
+ "clip": {
1372
+ "height": 528,
1373
+ "scale": 1,
1374
+ "width": 1280,
1375
+ "x": 0,
1376
+ "y": 0,
1377
+ },
1378
+ "format": "png",
1379
+ },
1380
+ },
1381
+ ]
1382
+ `)
1383
+
1384
+ const screenshotPath = path.join(os.tmpdir(), 'playwriter-test-screenshot.png')
1385
+ fs.writeFileSync(screenshotPath, viewportScreenshot)
1386
+ console.log('Screenshot saved to:', screenshotPath)
1387
+
1388
+ await browser.close()
1389
+ await page.close()
1390
+ }, 60000)
1391
+
1392
+ it('should capture element screenshot with correct coordinates', async () => {
1393
+ const browserContext = getBrowserContext()
1394
+ const serviceWorker = await getExtensionServiceWorker(browserContext)
1395
+
1396
+ const target = { x: 200, y: 150, width: 300, height: 100 }
1397
+ const scrolledTarget = { x: 100, y: 1500, width: 200, height: 80 }
1398
+
1399
+ const page = await browserContext.newPage()
1400
+ await page.setContent(`
1401
+ <html>
1402
+ <head>
1403
+ <style>
1404
+ body { margin: 0; padding: 0; height: 2000px; }
1405
+ #target {
1406
+ position: absolute;
1407
+ top: ${target.y}px;
1408
+ left: ${target.x}px;
1409
+ width: ${target.width}px;
1410
+ height: ${target.height}px;
1411
+ background: red;
1412
+ }
1413
+ #scrolled-target {
1414
+ position: absolute;
1415
+ top: ${scrolledTarget.y}px;
1416
+ left: ${scrolledTarget.x}px;
1417
+ width: ${scrolledTarget.width}px;
1418
+ height: ${scrolledTarget.height}px;
1419
+ background: blue;
1420
+ }
1421
+ </style>
1422
+ </head>
1423
+ <body>
1424
+ <div id="target">Target Element</div>
1425
+ <div id="scrolled-target">Scrolled Target</div>
1426
+ </body>
1427
+ </html>
1428
+ `)
1429
+ await page.bringToFront()
1430
+
1431
+ await serviceWorker.evaluate(async () => {
1432
+ await globalThis.toggleExtensionForActiveTab()
1433
+ })
1434
+
1435
+ await new Promise(r => setTimeout(r, 500))
1436
+
1437
+ const capturedCommands: CDPCommand[] = []
1438
+ const commandHandler = ({ command }: { clientId: string; command: CDPCommand }) => {
1439
+ if (command.method === 'Page.captureScreenshot') {
1440
+ capturedCommands.push(command)
1441
+ }
1442
+ }
1443
+ testCtx!.relayServer.on('cdp:command', commandHandler)
1444
+
1445
+ const browser = await chromium.connectOverCDP(getCdpUrl())
1446
+ let cdpPage
1447
+ for (const p of browser.contexts()[0].pages()) {
1448
+ const html = await p.content()
1449
+ if (html.includes('scrolled-target')) {
1450
+ cdpPage = p
1451
+ break
1452
+ }
1453
+ }
1454
+ expect(cdpPage).toBeDefined()
1455
+
1456
+ await cdpPage!.locator('#target').screenshot()
1457
+
1458
+ await cdpPage!.locator('#scrolled-target').screenshot()
1459
+
1460
+ testCtx!.relayServer.off('cdp:command', commandHandler)
1461
+
1462
+ expect(capturedCommands.length).toBe(2)
1463
+
1464
+ const targetCmd = capturedCommands[0]
1465
+ expect(targetCmd.method).toBe('Page.captureScreenshot')
1466
+ const targetClip = (targetCmd.params as any).clip
1467
+ expect(targetClip.x).toBe(target.x)
1468
+ expect(targetClip.y).toBe(target.y)
1469
+ expect(targetClip.width).toBe(target.width)
1470
+ expect(targetClip.height).toBe(target.height)
1471
+
1472
+ const scrolledCmd = capturedCommands[1]
1473
+ expect(scrolledCmd.method).toBe('Page.captureScreenshot')
1474
+ const scrolledClip = (scrolledCmd.params as any).clip
1475
+ expect(scrolledClip.x).toBe(scrolledTarget.x)
1476
+ expect(scrolledClip.y).toBe(scrolledTarget.y)
1477
+ expect(scrolledClip.width).toBe(scrolledTarget.width)
1478
+ expect(scrolledClip.height).toBe(scrolledTarget.height)
1479
+
1480
+ await browser.close()
1481
+ await page.close()
1482
+ }, 60000)
1483
+
1484
+ it('should get locator string for element using getLocatorStringForElement', async () => {
1485
+ const browserContext = getBrowserContext()
1486
+ const serviceWorker = await getExtensionServiceWorker(browserContext)
1487
+
1488
+ const page = await browserContext.newPage()
1489
+ await page.setContent(`
1490
+ <html>
1491
+ <body>
1492
+ <button id="test-btn">Click Me</button>
1493
+ <input type="text" placeholder="Enter name" />
1494
+ </body>
1495
+ </html>
1496
+ `)
1497
+ await page.bringToFront()
1498
+
1499
+ await serviceWorker.evaluate(async () => {
1500
+ await globalThis.toggleExtensionForActiveTab()
1501
+ })
1502
+
1503
+ await new Promise(r => setTimeout(r, 500))
1504
+
1505
+ const result = await client.callTool({
1506
+ name: 'execute',
1507
+ arguments: {
1508
+ code: js`
1509
+ let testPage;
1510
+ for (const p of context.pages()) {
1511
+ const html = await p.content();
1512
+ if (html.includes('test-btn')) { testPage = p; break; }
1513
+ }
1514
+ if (!testPage) throw new Error('Test page not found');
1515
+ const btn = testPage.locator('#test-btn');
1516
+ const locatorString = await getLocatorStringForElement(btn);
1517
+ console.log('Locator string:', locatorString);
1518
+ const locatorFromString = eval('testPage.' + locatorString);
1519
+ const count = await locatorFromString.count();
1520
+ console.log('Locator count:', count);
1521
+ const text = await locatorFromString.textContent();
1522
+ console.log('Locator text:', text);
1523
+ `,
1524
+ timeout: 30000,
1525
+ },
1526
+ })
1527
+
1528
+ expect(result.isError).toBeFalsy()
1529
+ const text = (result.content as any)[0]?.text || ''
1530
+ expect(text).toContain('Locator string:')
1531
+ expect(text).toContain("getByRole('button', { name: 'Click Me' })")
1532
+ expect(text).toContain('Locator count: 1')
1533
+ expect(text).toContain('Locator text: Click Me')
1534
+
1535
+ await page.close()
1536
+ }, 60000)
1537
+
1538
+ it('should return correct layout metrics via CDP', async () => {
1539
+ const browserContext = getBrowserContext()
1540
+ const serviceWorker = await getExtensionServiceWorker(browserContext)
1541
+
1542
+ const page = await browserContext.newPage()
1543
+ await page.goto('https://example.com/')
1544
+ await page.bringToFront()
1545
+
1546
+ await serviceWorker.evaluate(async () => {
1547
+ await globalThis.toggleExtensionForActiveTab()
1548
+ })
1549
+
1550
+ await new Promise(r => setTimeout(r, 500))
1551
+
1552
+ const browser = await chromium.connectOverCDP(getCdpUrl())
1553
+ const cdpPage = browser.contexts()[0].pages().find(p => p.url().includes('example.com'))
1554
+ expect(cdpPage).toBeDefined()
1555
+
1556
+ const wsUrl = getCdpUrl()
1557
+ const cdpSession = await getCDPSessionForPage({ page: cdpPage!, wsUrl })
1558
+
1559
+ const layoutMetrics = await cdpSession.send('Page.getLayoutMetrics')
1560
+
1561
+ const normalized = {
1562
+ cssLayoutViewport: layoutMetrics.cssLayoutViewport,
1563
+ cssVisualViewport: layoutMetrics.cssVisualViewport,
1564
+ layoutViewport: layoutMetrics.layoutViewport,
1565
+ visualViewport: layoutMetrics.visualViewport,
1566
+ devicePixelRatio: layoutMetrics.cssVisualViewport.clientWidth > 0
1567
+ ? layoutMetrics.visualViewport.clientWidth / layoutMetrics.cssVisualViewport.clientWidth
1568
+ : 1,
1569
+ }
1570
+
1571
+ expect(normalized).toMatchInlineSnapshot(`
1572
+ {
1573
+ "cssLayoutViewport": {
1574
+ "clientHeight": 720,
1575
+ "clientWidth": 1280,
1576
+ "pageX": 0,
1577
+ "pageY": 0,
1578
+ },
1579
+ "cssVisualViewport": {
1580
+ "clientHeight": 720,
1581
+ "clientWidth": 1280,
1582
+ "offsetX": 0,
1583
+ "offsetY": 0,
1584
+ "pageX": 0,
1585
+ "pageY": 0,
1586
+ "scale": 1,
1587
+ "zoom": 1,
1588
+ },
1589
+ "devicePixelRatio": 1,
1590
+ "layoutViewport": {
1591
+ "clientHeight": 720,
1592
+ "clientWidth": 1280,
1593
+ "pageX": 0,
1594
+ "pageY": 0,
1595
+ },
1596
+ "visualViewport": {
1597
+ "clientHeight": 720,
1598
+ "clientWidth": 1280,
1599
+ "offsetX": 0,
1600
+ "offsetY": 0,
1601
+ "pageX": 0,
1602
+ "pageY": 0,
1603
+ "scale": 1,
1604
+ "zoom": 1,
1605
+ },
1606
+ }
1607
+ `)
1608
+
1609
+ const windowDpr = await cdpPage!.evaluate(() => (globalThis as any).devicePixelRatio)
1610
+ console.log('window.devicePixelRatio:', windowDpr)
1611
+ expect(windowDpr).toBe(1)
1612
+
1613
+ cdpSession.detach()
1614
+ await browser.close()
1615
+ await page.close()
1616
+ }, 60000)
1617
+
1618
+ it('should support getCDPSession through the relay', async () => {
1619
+ const browserContext = getBrowserContext()
1620
+ const serviceWorker = await getExtensionServiceWorker(browserContext)
1621
+
1622
+ const page = await browserContext.newPage()
1623
+ await page.goto('https://example.com/')
1624
+ await page.bringToFront()
1625
+
1626
+ await serviceWorker.evaluate(async () => {
1627
+ await globalThis.toggleExtensionForActiveTab()
1628
+ })
1629
+
1630
+ await new Promise(r => setTimeout(r, 500))
1631
+
1632
+ const browser = await chromium.connectOverCDP(getCdpUrl())
1633
+ const cdpPage = browser.contexts()[0].pages().find(p => p.url().includes('example.com'))
1634
+ expect(cdpPage).toBeDefined()
1635
+
1636
+ const wsUrl = getCdpUrl()
1637
+ const client = await getCDPSessionForPage({ page: cdpPage!, wsUrl })
1638
+
1639
+ const layoutMetrics = await client.send('Page.getLayoutMetrics')
1640
+ expect(layoutMetrics.cssVisualViewport).toBeDefined()
1641
+ expect(layoutMetrics.cssVisualViewport.clientWidth).toBeGreaterThan(0)
1642
+
1643
+ client.detach()
1644
+ await browser.close()
1645
+ await page.close()
1646
+ }, 60000)
1647
+
1360
1648
  it('should work with stagehand', async () => {
1361
- if (!browserContext) throw new Error('Browser not initialized')
1649
+ const browserContext = getBrowserContext()
1362
1650
  const serviceWorker = await getExtensionServiceWorker(browserContext)
1363
1651
 
1364
1652
  await serviceWorker.evaluate(async () => {
@@ -1411,6 +1699,59 @@ describe('MCP Server Tests', () => {
1411
1699
  await stagehand.close()
1412
1700
  }, 60000)
1413
1701
 
1702
+ it('should preserve system color scheme instead of forcing light mode', async () => {
1703
+ const browserContext = getBrowserContext()
1704
+ const serviceWorker = await getExtensionServiceWorker(browserContext)
1705
+
1706
+ const page = await browserContext.newPage()
1707
+ await page.goto('https://example.com')
1708
+ await page.bringToFront()
1709
+
1710
+ const colorSchemeBefore = await page.evaluate(() => {
1711
+ return window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light'
1712
+ })
1713
+ console.log('Color scheme before MCP connection:', colorSchemeBefore)
1714
+
1715
+ await serviceWorker.evaluate(async () => {
1716
+ await globalThis.toggleExtensionForActiveTab()
1717
+ })
1718
+ await new Promise(r => setTimeout(r, 500))
1719
+
1720
+ const result = await client.callTool({
1721
+ name: 'execute',
1722
+ arguments: {
1723
+ code: js`
1724
+ const pages = context.pages();
1725
+ const urls = pages.map(p => p.url());
1726
+ const targetPage = pages.find(p => p.url().includes('example.com'));
1727
+ if (!targetPage) {
1728
+ return { error: 'Page not found', urls };
1729
+ }
1730
+ const isDark = await targetPage.evaluate(() => window.matchMedia('(prefers-color-scheme: dark)').matches);
1731
+ const isLight = await targetPage.evaluate(() => window.matchMedia('(prefers-color-scheme: light)').matches);
1732
+ return { matchesDark: isDark, matchesLight: isLight };
1733
+ `,
1734
+ },
1735
+ })
1736
+
1737
+ console.log('Color scheme after MCP connection:', result.content)
1738
+
1739
+ expect(result.content).toMatchInlineSnapshot(`
1740
+ [
1741
+ {
1742
+ "text": "Return value:
1743
+ {
1744
+ "matchesDark": true,
1745
+ "matchesLight": false
1746
+ }",
1747
+ "type": "text",
1748
+ },
1749
+ ]
1750
+ `)
1751
+
1752
+ await page.close()
1753
+ }, 60000)
1754
+
1414
1755
  })
1415
1756
 
1416
1757
 
@@ -1421,3 +1762,268 @@ function tryJsonParse(str: string) {
1421
1762
  return str
1422
1763
  }
1423
1764
  }
1765
+
1766
+ describe('CDP Session Tests', () => {
1767
+ let testCtx: TestContext | null = null
1768
+
1769
+ beforeAll(async () => {
1770
+ testCtx = await setupTestContext({ tempDirPrefix: 'pw-cdp-test-' })
1771
+ }, 600000)
1772
+
1773
+ afterAll(async () => {
1774
+ await cleanupTestContext(testCtx)
1775
+ testCtx = null
1776
+ })
1777
+
1778
+ const getBrowserContext = () => {
1779
+ if (!testCtx?.browserContext) throw new Error('Browser not initialized')
1780
+ return testCtx.browserContext
1781
+ }
1782
+
1783
+ it('should enable debugger and pause on debugger statement via CDP session', async () => {
1784
+ const browserContext = getBrowserContext()
1785
+ const serviceWorker = await getExtensionServiceWorker(browserContext)
1786
+
1787
+ const page = await browserContext.newPage()
1788
+ await page.goto('https://example.com/')
1789
+ await page.bringToFront()
1790
+
1791
+ await serviceWorker.evaluate(async () => {
1792
+ await globalThis.toggleExtensionForActiveTab()
1793
+ })
1794
+ await new Promise(r => setTimeout(r, 500))
1795
+
1796
+ const browser = await chromium.connectOverCDP(getCdpUrl())
1797
+ const cdpPage = browser.contexts()[0].pages().find(p => p.url().includes('example.com'))
1798
+ expect(cdpPage).toBeDefined()
1799
+
1800
+ const wsUrl = getCdpUrl()
1801
+ const cdpSession = await getCDPSessionForPage({ page: cdpPage!, wsUrl })
1802
+ await cdpSession.send('Debugger.enable')
1803
+
1804
+ const pausedPromise = new Promise<Protocol.Debugger.PausedEvent>((resolve) => {
1805
+ cdpSession.on('Debugger.paused', (params) => {
1806
+ resolve(params as Protocol.Debugger.PausedEvent)
1807
+ })
1808
+ })
1809
+
1810
+ cdpPage!.evaluate(`
1811
+ (function testFunction() {
1812
+ const localVar = 'hello';
1813
+ const numberVar = 42;
1814
+ const objVar = { key: 'value', nested: { a: 1 } };
1815
+ debugger;
1816
+ return localVar + numberVar;
1817
+ })()
1818
+ `)
1819
+
1820
+ const pausedEvent = await Promise.race([
1821
+ pausedPromise,
1822
+ new Promise<never>((_, reject) => setTimeout(() => reject(new Error('Debugger.paused timeout')), 5000))
1823
+ ])
1824
+
1825
+ const stackTrace = pausedEvent.callFrames.map(frame => ({
1826
+ functionName: frame.functionName || '(anonymous)',
1827
+ lineNumber: frame.location.lineNumber,
1828
+ columnNumber: frame.location.columnNumber,
1829
+ }))
1830
+
1831
+ expect({
1832
+ reason: pausedEvent.reason,
1833
+ stackTrace: stackTrace.slice(0, 3),
1834
+ }).toMatchInlineSnapshot(`
1835
+ {
1836
+ "reason": "other",
1837
+ "stackTrace": [
1838
+ {
1839
+ "columnNumber": 16,
1840
+ "functionName": "testFunction",
1841
+ "lineNumber": 4,
1842
+ },
1843
+ {
1844
+ "columnNumber": 14,
1845
+ "functionName": "(anonymous)",
1846
+ "lineNumber": 6,
1847
+ },
1848
+ {
1849
+ "columnNumber": 29,
1850
+ "functionName": "evaluate",
1851
+ "lineNumber": 289,
1852
+ },
1853
+ ],
1854
+ }
1855
+ `)
1856
+
1857
+ const topFrame = pausedEvent.callFrames[0]
1858
+ const scopeChain = topFrame.scopeChain
1859
+
1860
+ const localScope = scopeChain.find(s => s.type === 'local')
1861
+ const localVars: Record<string, unknown> = {}
1862
+
1863
+ if (localScope?.object.objectId) {
1864
+ const propsResult = await cdpSession.send('Runtime.getProperties', {
1865
+ objectId: localScope.object.objectId,
1866
+ ownProperties: true,
1867
+ })
1868
+
1869
+ for (const prop of propsResult.result) {
1870
+ if (prop.value) {
1871
+ localVars[prop.name] = prop.value.type === 'object'
1872
+ ? `[object ${prop.value.className || prop.value.subtype || 'Object'}]`
1873
+ : prop.value.value
1874
+ }
1875
+ }
1876
+ }
1877
+
1878
+ expect({
1879
+ scopeTypes: scopeChain.map(s => s.type),
1880
+ localVariables: localVars,
1881
+ }).toMatchInlineSnapshot(`
1882
+ {
1883
+ "localVariables": {
1884
+ "localVar": "hello",
1885
+ "numberVar": 42,
1886
+ "objVar": "[object Object]",
1887
+ },
1888
+ "scopeTypes": [
1889
+ "local",
1890
+ "global",
1891
+ ],
1892
+ }
1893
+ `)
1894
+
1895
+ const evalResult = await cdpSession.send('Debugger.evaluateOnCallFrame', {
1896
+ callFrameId: topFrame.callFrameId,
1897
+ expression: 'localVar + " world " + numberVar',
1898
+ })
1899
+
1900
+ expect({
1901
+ evaluatedExpression: 'localVar + " world " + numberVar',
1902
+ result: evalResult.result.value,
1903
+ type: evalResult.result.type,
1904
+ }).toMatchInlineSnapshot(`
1905
+ {
1906
+ "evaluatedExpression": "localVar + " world " + numberVar",
1907
+ "result": "hello world 42",
1908
+ "type": "string",
1909
+ }
1910
+ `)
1911
+
1912
+ await cdpSession.send('Debugger.resume')
1913
+ await cdpSession.send('Debugger.disable')
1914
+ cdpSession.detach()
1915
+ await browser.close()
1916
+ await page.close()
1917
+ }, 60000)
1918
+
1919
+ it('should profile JavaScript execution using CDP Profiler', async () => {
1920
+ const browserContext = getBrowserContext()
1921
+ const serviceWorker = await getExtensionServiceWorker(browserContext)
1922
+
1923
+ const page = await browserContext.newPage()
1924
+ await page.goto('https://example.com/')
1925
+ await page.bringToFront()
1926
+
1927
+ await serviceWorker.evaluate(async () => {
1928
+ await globalThis.toggleExtensionForActiveTab()
1929
+ })
1930
+ await new Promise(r => setTimeout(r, 500))
1931
+
1932
+ const browser = await chromium.connectOverCDP(getCdpUrl())
1933
+ const cdpPage = browser.contexts()[0].pages().find(p => p.url().includes('example.com'))
1934
+ expect(cdpPage).toBeDefined()
1935
+
1936
+ const wsUrl = getCdpUrl()
1937
+ const cdpSession = await getCDPSessionForPage({ page: cdpPage!, wsUrl })
1938
+ await cdpSession.send('Profiler.enable')
1939
+ await cdpSession.send('Profiler.start')
1940
+
1941
+ await cdpPage!.evaluate(`
1942
+ (() => {
1943
+ function fibonacci(n) {
1944
+ if (n <= 1) return n
1945
+ return fibonacci(n - 1) + fibonacci(n - 2)
1946
+ }
1947
+ for (let i = 0; i < 5; i++) {
1948
+ fibonacci(20)
1949
+ }
1950
+ for (let i = 0; i < 1000; i++) {
1951
+ document.querySelectorAll('*')
1952
+ }
1953
+ })()
1954
+ `)
1955
+
1956
+ const stopResult = await cdpSession.send('Profiler.stop')
1957
+ const profile = stopResult.profile
1958
+
1959
+ const functionNames = profile.nodes
1960
+ .map(n => n.callFrame.functionName)
1961
+ .filter(name => name && name.length > 0)
1962
+ .slice(0, 10)
1963
+
1964
+ expect({
1965
+ hasNodes: profile.nodes.length > 0,
1966
+ nodeCount: profile.nodes.length,
1967
+ durationMicroseconds: profile.endTime - profile.startTime,
1968
+ sampleFunctionNames: functionNames,
1969
+ }).toMatchInlineSnapshot(`
1970
+ {
1971
+ "durationMicroseconds": 7500,
1972
+ "hasNodes": true,
1973
+ "nodeCount": 7,
1974
+ "sampleFunctionNames": [
1975
+ "(root)",
1976
+ "(program)",
1977
+ "(idle)",
1978
+ "evaluate",
1979
+ ],
1980
+ }
1981
+ `)
1982
+
1983
+ await cdpSession.send('Profiler.disable')
1984
+ cdpSession.detach()
1985
+ await browser.close()
1986
+ await page.close()
1987
+ }, 60000)
1988
+
1989
+ it('should click at correct coordinates on high-DPI simulation', async () => {
1990
+ const browserContext = getBrowserContext()
1991
+ const serviceWorker = await getExtensionServiceWorker(browserContext)
1992
+
1993
+ const page = await browserContext.newPage()
1994
+ await page.goto('https://example.com/')
1995
+ await page.bringToFront()
1996
+
1997
+ await serviceWorker.evaluate(async () => {
1998
+ await globalThis.toggleExtensionForActiveTab()
1999
+ })
2000
+ await new Promise(r => setTimeout(r, 500))
2001
+
2002
+ const browser = await chromium.connectOverCDP(getCdpUrl())
2003
+ const cdpPage = browser.contexts()[0].pages().find(p => p.url().includes('example.com'))
2004
+ expect(cdpPage).toBeDefined()
2005
+
2006
+ const h1Bounds = await cdpPage!.locator('h1').boundingBox()
2007
+ expect(h1Bounds).toBeDefined()
2008
+ console.log('H1 bounding box:', h1Bounds)
2009
+
2010
+ await cdpPage!.evaluate(() => {
2011
+ (window as any).clickedAt = null;
2012
+ document.addEventListener('click', (e) => {
2013
+ (window as any).clickedAt = { x: e.clientX, y: e.clientY };
2014
+ });
2015
+ })
2016
+
2017
+ await cdpPage!.locator('h1').click()
2018
+
2019
+ const clickedAt = await cdpPage!.evaluate(() => (window as any).clickedAt)
2020
+ console.log('Clicked at:', clickedAt)
2021
+
2022
+ expect(clickedAt).toBeDefined()
2023
+ expect(clickedAt.x).toBeGreaterThan(0)
2024
+ expect(clickedAt.y).toBeGreaterThan(0)
2025
+
2026
+ await browser.close()
2027
+ await page.close()
2028
+ }, 60000)
2029
+ })