/** * 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 { folio as baseFolio } from './fixtures'; import { InMemorySnapshotter } from '../lib/server/snapshot/inMemorySnapshotter'; import { HttpServer } from '../lib/utils/httpServer'; import { SnapshotServer } from '../lib/server/snapshot/snapshotServer'; type TestFixtures = { snapshotter: any; snapshotPort: number; }; export const fixtures = baseFolio.extend(); fixtures.snapshotter.init(async ({ context, toImpl }, runTest) => { const snapshotter = new InMemorySnapshotter(toImpl(context)); await snapshotter.initialize(); await runTest(snapshotter); await snapshotter.dispose(); }); fixtures.snapshotPort.init(async ({ snapshotter, testWorkerIndex }, runTest) => { const httpServer = new HttpServer(); new SnapshotServer(httpServer, snapshotter); const port = 9700 + testWorkerIndex; httpServer.start(port); await runTest(port); httpServer.stop(); }); const { it, describe, expect } = fixtures.build(); describe('snapshots', (suite, { mode }) => { suite.skip(mode !== 'default'); }, () => { it('should collect snapshot', async ({ snapshotter, page, toImpl }) => { await page.setContent(''); const snapshot = await snapshotter.captureSnapshot(toImpl(page), 'snapshot'); expect(distillSnapshot(snapshot)).toBe(''); }); it('should capture resources', async ({ snapshotter, page, toImpl, server }) => { 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), 'snapshot'); const { resources } = snapshot.render(); const cssHref = `http://localhost:${server.PORT}/style.css`; expect(resources[cssHref]).toBeTruthy(); }); it('should collect multiple', async ({ snapshotter, page, toImpl }) => { await page.setContent(''); const snapshots = []; snapshotter.on('snapshot', snapshot => snapshots.push(snapshot)); await snapshotter.captureSnapshot(toImpl(page), 'snapshot1'); await snapshotter.captureSnapshot(toImpl(page), 'snapshot2'); expect(snapshots.length).toBe(2); }); it('should only collect on change', async ({ snapshotter, page }) => { await page.setContent(''); const snapshots = []; snapshotter.on('snapshot', snapshot => snapshots.push(snapshot)); await Promise.all([ new Promise(f => snapshotter.once('snapshot', f)), snapshotter.setAutoSnapshotInterval(25), ]); await Promise.all([ new Promise(f => snapshotter.once('snapshot', f)), page.setContent('') ]); expect(snapshots.length).toBe(2); }); it('should respect inline CSSOM change', async ({ snapshotter, page }) => { await page.setContent(''); const snapshots = []; snapshotter.on('snapshot', snapshot => snapshots.push(snapshot)); await Promise.all([ new Promise(f => snapshotter.once('snapshot', f)), snapshotter.setAutoSnapshotInterval(25), ]); expect(distillSnapshot(snapshots[0])).toBe(''); await Promise.all([ new Promise(f => snapshotter.once('snapshot', f)), page.evaluate(() => { (document.styleSheets[0].cssRules[0] as any).style.color = 'blue'; }) ]); expect(distillSnapshot(snapshots[1])).toBe(''); }); it('should respect subresource CSSOM change', async ({ snapshotter, page, server }) => { await page.goto(server.EMPTY_PAGE); await page.route('**/style.css', route => { route.fulfill({ body: 'button { color: red; }', }).catch(() => {}); }); await page.setContent(''); const snapshots = []; snapshotter.on('snapshot', snapshot => snapshots.push(snapshot)); await Promise.all([ new Promise(f => snapshotter.once('snapshot', f)), snapshotter.setAutoSnapshotInterval(25), ]); expect(distillSnapshot(snapshots[0])).toBe(''); await Promise.all([ new Promise(f => snapshotter.once('snapshot', f)), page.evaluate(() => { (document.styleSheets[0].cssRules[0] as any).style.color = 'blue'; }) ]); const { resources } = snapshots[1].render(); const cssHref = `http://localhost:${server.PORT}/style.css`; const { sha1 } = resources[cssHref]; expect(snapshotter.resourceContent(sha1).toString()).toBe('button { color: blue; }'); }); it('should capture iframe', (test, { browserName }) => { test.skip(browserName === 'firefox'); }, async ({ contextFactory, snapshotter, page, server, snapshotPort, toImpl }) => { 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. let counter = 0; let snapshot: any; for (; ; ++counter) { snapshot = await snapshotter.captureSnapshot(toImpl(page), 'snapshot' + counter); const text = distillSnapshot(snapshot).replace(/frame@[^"]+["]/, '"'); if (text === '') break; await page.waitForTimeout(250); } // Render snapshot, check expectations. const previewContext = await contextFactory(); const previewPage = await previewContext.newPage(); await previewPage.goto(`http://localhost:${snapshotPort}/snapshot/`); await previewPage.evaluate(snapshotId => { (window as any).showSnapshot(snapshotId); }, `${snapshot.snapshot().pageId}?name=snapshot${counter}`); while (previewPage.frames().length < 4) await new Promise(f => previewPage.once('frameattached', f)); const button = await previewPage.frames()[3].waitForSelector('button'); expect(await button.textContent()).toBe('Hello iframe'); }); }); function distillSnapshot(snapshot) { const { html } = snapshot.render(); return html .replace(/