/** * Copyright (c) Microsoft Corporation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { contextTest, expect } from '../config/browserTest'; import { InMemorySnapshotter } from '../../packages/playwright-core/lib/server/trace/test/inMemorySnapshotter'; const it = contextTest.extend<{ snapshotter: InMemorySnapshotter }>({ snapshotter: async ({ toImpl, context }, run) => { const snapshotter = new InMemorySnapshotter(toImpl(context)); await snapshotter.initialize(); await run(snapshotter); await snapshotter.dispose(); }, }); it.describe('snapshots', () => { it('should collect snapshot', async ({ page, toImpl, snapshotter }) => { await page.setContent(''); const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); expect(distillSnapshot(snapshot)).toBe(''); }); it('should preserve BASE and other content on reset', async ({ page, toImpl, snapshotter, server }) => { await page.goto(server.EMPTY_PAGE); const snapshot1 = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); const html1 = snapshot1.render().html; expect(html1).toContain(` { await page.goto(server.EMPTY_PAGE); await page.route('**/style.css', route => { route.fulfill({ body: 'button { color: red; }', }).catch(() => {}); }); await page.setContent(''); const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); const resource = snapshot.resourceByUrl(`http://localhost:${server.PORT}/style.css`, 'GET'); expect(resource).toBeTruthy(); }); it('should collect multiple', async ({ page, toImpl, snapshotter }) => { await page.setContent(''); await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); await snapshotter.captureSnapshot(toImpl(page), 'call@2', 'snapshot@call@2'); expect(snapshotter.snapshotCount()).toBe(2); }); it('should respect inline CSSOM change', async ({ page, toImpl, snapshotter }) => { await page.setContent(''); const snapshot1 = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); expect(distillSnapshot(snapshot1)).toBe(''); await page.evaluate(() => { (document.styleSheets[0].cssRules[0] as any).style.color = 'blue'; }); const snapshot2 = await snapshotter.captureSnapshot(toImpl(page), 'call@2', 'snapshot@call@2'); expect(distillSnapshot(snapshot2)).toBe(''); }); it('should respect CSSOM change through CSSGroupingRule', async ({ page, toImpl, snapshotter }) => { await page.setContent(''); await page.evaluate(() => { window['rule'] = document.styleSheets[0].cssRules[0]; void 0; }); const snapshot1 = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); expect(distillSnapshot(snapshot1)).toBe(''); await page.evaluate(() => { window['rule'].cssRules[0].style.color = 'blue'; }); const snapshot2 = await snapshotter.captureSnapshot(toImpl(page), 'call@2', 'snapshot@call@2'); expect(distillSnapshot(snapshot2)).toBe(''); await page.evaluate(() => { window['rule'].insertRule('button { color: green; }', 1); }); const snapshot3 = await snapshotter.captureSnapshot(toImpl(page), 'call@3', 'snapshot@call@3'); expect(distillSnapshot(snapshot3)).toBe(''); }); it('should respect node removal', async ({ page, toImpl, snapshotter }) => { await page.setContent('
'); const snapshot1 = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); expect(distillSnapshot(snapshot1)).toBe('
'); await page.evaluate(() => document.getElementById('button2').remove()); const snapshot2 = await snapshotter.captureSnapshot(toImpl(page), 'call@2', 'snapshot@call@2'); expect(distillSnapshot(snapshot2)).toBe('
'); }); it('should respect attr removal', async ({ page, toImpl, snapshotter }) => { await page.setContent('
'); const snapshot1 = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); expect(distillSnapshot(snapshot1)).toBe('
'); await page.evaluate(() => document.getElementById('div').removeAttribute('attr2')); const snapshot2 = await snapshotter.captureSnapshot(toImpl(page), 'call@2', 'snapshot@call@2'); expect(distillSnapshot(snapshot2)).toBe('
'); }); it('should have a custom doctype', async ({ page, server, toImpl, snapshotter }) => { await page.goto(server.EMPTY_PAGE); await page.setContent('hi'); const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); expect(distillSnapshot(snapshot)).toBe('hi'); }); it('should replace meta charset attr that specifies charset', async ({ page, server, toImpl, snapshotter }) => { await page.goto(server.EMPTY_PAGE); await page.setContent(''); const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); expect(distillSnapshot(snapshot)).toBe(''); }); it('should replace meta content attr that specifies charset', async ({ page, server, toImpl, snapshotter }) => { await page.goto(server.EMPTY_PAGE); await page.setContent(''); const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); expect(distillSnapshot(snapshot)).toBe(''); }); it('should respect subresource CSSOM change', async ({ page, server, toImpl, snapshotter }) => { await page.goto(server.EMPTY_PAGE); await page.route('**/style.css', route => { route.fulfill({ body: 'button { color: red; }', }).catch(() => {}); }); await page.setContent(''); const snapshot1 = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); expect(distillSnapshot(snapshot1)).toBe(''); await page.evaluate(() => { (document.styleSheets[0].cssRules[0] as any).style.color = 'blue'; }); const snapshot2 = await snapshotter.captureSnapshot(toImpl(page), 'call@2', 'snapshot@call@2'); const resource = snapshot2.resourceByUrl(`http://localhost:${server.PORT}/style.css`, 'GET'); expect((await snapshotter.resourceContentForTest(resource.response.content._sha1)).toString()).toBe('button { color: blue; }'); }); it('should capture frame', async ({ page, server, toImpl, snapshotter }) => { await page.route('**/empty.html', route => { route.fulfill({ body: '', contentType: 'text/html' }).catch(() => {}); }); await page.route('**/frame.html', route => { route.fulfill({ body: '', contentType: 'text/html' }).catch(() => {}); }); await page.goto(server.EMPTY_PAGE); for (let counter = 0; ; ++counter) { const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@' + counter, 'snapshot@call@' + counter); const text = distillSnapshot(snapshot).replace(/frame@[^"]+["]/, '"'); if (text === '\">') break; await page.waitForTimeout(250); } }); it('should capture iframe', async ({ page, server, toImpl, snapshotter }) => { await page.route('**/empty.html', route => { route.fulfill({ body: '', contentType: 'text/html' }).catch(() => {}); }); await page.route('**/iframe.html', route => { route.fulfill({ body: '', contentType: 'text/html' }).catch(() => {}); }); await page.goto(server.EMPTY_PAGE); // Marking iframe hierarchy is racy, do not expect snapshot, wait for it. for (let counter = 0; ; ++counter) { const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@' + counter, 'snapshot@call@' + counter); const text = distillSnapshot(snapshot).replace(/frame@[^"]+["]/, '"'); if (text === '') break; await page.waitForTimeout(250); } }); it('should capture iframe with srcdoc', async ({ page, server, toImpl, snapshotter }) => { await page.route('**/empty.html', route => { route.fulfill({ body: '', contentType: 'text/html' }).catch(() => {}); }); await page.goto(server.EMPTY_PAGE); // Marking iframe hierarchy is racy, do not expect snapshot, wait for it. for (let counter = 0; ; ++counter) { const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@' + counter, 'snapshot@call@' + counter); const text = distillSnapshot(snapshot).replace(/frame@[^"]+["]/, '"'); if (text === '') break; await page.waitForTimeout(250); } }); it('should capture snapshot target', async ({ page, toImpl, snapshotter }) => { await page.setContent(''); { const handle = await page.$('text=Hello'); const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1', toImpl(handle)); expect(distillSnapshot(snapshot, false /* distillTarget */)).toBe(''); } { const handle = await page.$('text=World'); const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@2', 'snapshot@call@2', toImpl(handle)); expect(distillSnapshot(snapshot, false /* distillTarget */)).toBe(''); } }); it('should collect on attribute change', async ({ page, toImpl, snapshotter }) => { await page.setContent(''); { const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); expect(distillSnapshot(snapshot)).toBe(''); } const handle = await page.$('text=Hello')!; await handle.evaluate(element => element.setAttribute('data', 'one')); { const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@2', 'snapshot@call@2'); expect(distillSnapshot(snapshot)).toBe(''); } await handle.evaluate(element => element.setAttribute('data', 'two')); { const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@3', 'snapshot@call@3'); expect(distillSnapshot(snapshot)).toBe(''); } }); it('empty adopted style sheets should not prevent node refs', async ({ page, toImpl, snapshotter, browserName }) => { it.skip(browserName !== 'chromium', 'Constructed stylesheets are only in Chromium.'); await page.setContent(''); await page.evaluate(() => { const sheet = new CSSStyleSheet(); (document as any).adoptedStyleSheets = [sheet]; const sheet2 = new CSSStyleSheet(); for (const element of [document.createElement('div'), document.createElement('span')]) { const root = element.attachShadow({ mode: 'open' }); root.append('foo'); (root as any).adoptedStyleSheets = [sheet2]; document.body.appendChild(element); } }); const renderer1 = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); // Expect some adopted style sheets. expect(distillSnapshot(renderer1)).toContain('__playwright_style_sheet_'); const renderer2 = await snapshotter.captureSnapshot(toImpl(page), 'call@2', 'snapshot@call@2'); const snapshot2 = renderer2.snapshot(); // Second snapshot should be just a copy of the first one. expect(snapshot2.html).toEqual([[1, 13]]); }); it('should not navigate on anchor clicks', async ({ page, toImpl, snapshotter }) => { await page.setContent('example.com'); const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'call@1', 'snapshot@call@1'); expect(distillSnapshot(snapshot)).toBe('example.com'); }); }); function distillSnapshot(snapshot, distillTarget = true) { let { html } = snapshot.render(); if (distillTarget) html = html.replace(/\s__playwright_target__="[^"]+"/g, ''); return html .replace(/