chore(snapshot): implement in-memory snapshot (#5624)

This commit is contained in:
Pavel Feldman 2021-02-25 13:09:26 -08:00 committed by GitHub
parent b285936721
commit 992f808210
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 136 additions and 226 deletions

View file

@ -411,11 +411,11 @@ export class Frame extends SdkObject {
private _setContentCounter = 0; private _setContentCounter = 0;
readonly _detachedPromise: Promise<void>; readonly _detachedPromise: Promise<void>;
private _detachedCallback = () => {}; private _detachedCallback = () => {};
readonly traceId: string; readonly idInSnapshot: string;
constructor(page: Page, id: string, parentFrame: Frame | null) { constructor(page: Page, id: string, parentFrame: Frame | null) {
super(page); super(page);
this.traceId = parentFrame ? `frame@${id}` : page.traceId; this.idInSnapshot = parentFrame ? `frame@${id}` : page.idInSnapshot;
this.attribution.frame = this; this.attribution.frame = this;
this._id = id; this._id = id;
this._page = page; this._page = page;

View file

@ -147,11 +147,11 @@ export class Page extends SdkObject {
_ownedContext: BrowserContext | undefined; _ownedContext: BrowserContext | undefined;
readonly selectors: Selectors; readonly selectors: Selectors;
_video: Video | null = null; _video: Video | null = null;
readonly traceId: string; readonly idInSnapshot: string;
constructor(delegate: PageDelegate, browserContext: BrowserContext) { constructor(delegate: PageDelegate, browserContext: BrowserContext) {
super(browserContext); super(browserContext);
this.traceId = 'page@' + createGuid(); this.idInSnapshot = 'page@' + createGuid();
this.attribution.page = this; this.attribution.page = this;
this._delegate = delegate; this._delegate = delegate;
this._closedCallback = () => {}; this._closedCallback = () => {};

View file

@ -0,0 +1,71 @@
/**
* 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 { BrowserContext } from '../browserContext';
import { ContextResources, FrameSnapshot } from './snapshot';
import { SnapshotRenderer } from './snapshotRenderer';
import { NetworkResponse, SnapshotStorage } from './snapshotServer';
import { Snapshotter, SnapshotterBlob, SnapshotterDelegate, SnapshotterResource } from './snapshotter';
export class InMemorySnapshotter implements SnapshotStorage, SnapshotterDelegate {
private _blobs = new Map<string, Buffer>();
private _resources = new Map<string, SnapshotterResource>();
private _frameSnapshots = new Map<string, FrameSnapshot[]>();
private _snapshots = new Map<string, SnapshotRenderer>();
private _contextResources: ContextResources = new Map();
private _snapshotter: Snapshotter;
constructor(context: BrowserContext) {
this._snapshotter = new Snapshotter(context, this);
}
onBlob(blob: SnapshotterBlob): void {
this._blobs.set(blob.sha1, blob.buffer);
}
onResource(resource: SnapshotterResource): void {
this._resources.set(resource.resourceId, resource);
let resources = this._contextResources.get(resource.url);
if (!resources) {
resources = [];
this._contextResources.set(resource.url, resources);
}
resources.push({ frameId: resource.frameId, resourceId: resource.resourceId });
}
onFrameSnapshot(snapshot: FrameSnapshot): void {
const key = snapshot.pageId + '/' + snapshot.frameId;
let frameSnapshots = this._frameSnapshots.get(key);
if (!frameSnapshots) {
frameSnapshots = [];
this._frameSnapshots.set(key, frameSnapshots);
}
frameSnapshots.push(snapshot);
this._snapshots.set(snapshot.snapshotId, new SnapshotRenderer(new Map(this._contextResources), frameSnapshots, frameSnapshots.length - 1));
}
resourceContent(sha1: string): Buffer | undefined {
return this._blobs.get(sha1);
}
resourceById(resourceId: string): NetworkResponse | undefined {
return this._resources.get(resourceId)!;
}
snapshotById(snapshotId: string): SnapshotRenderer | undefined {
return this._snapshots.get(snapshotId);
}
}

View file

@ -34,8 +34,19 @@ export type ResourceOverride = {
}; };
export type FrameSnapshot = { export type FrameSnapshot = {
snapshotId: string,
pageId: string,
frameId: string,
frameUrl: string,
doctype?: string, doctype?: string,
html: NodeSnapshot, html: NodeSnapshot,
resourceOverrides: ResourceOverride[], resourceOverrides: ResourceOverride[],
viewport: { width: number, height: number }, viewport: { width: number, height: number },
}; };
export type ContextResources = Map<string, { resourceId: string, frameId: string }[]>;
export type RenderedFrameSnapshot = {
html: string;
resources: { [key: string]: { resourceId: string, sha1?: string } };
};

View file

@ -14,23 +14,14 @@
* limitations under the License. * limitations under the License.
*/ */
import { FrameSnapshot, NodeSnapshot } from './snapshot'; import { ContextResources, FrameSnapshot, NodeSnapshot, RenderedFrameSnapshot } from './snapshot';
export type ContextResources = Map<string, { resourceId: string, frameId: string }[]>;
export type RenderedFrameSnapshot = {
html: string;
resources: { [key: string]: { resourceId: string, sha1?: string } };
};
export class SnapshotRenderer { export class SnapshotRenderer {
private _snapshots: FrameSnapshot[]; private _snapshots: FrameSnapshot[];
private _index: number; private _index: number;
private _contextResources: ContextResources; private _contextResources: ContextResources;
private _frameId: string;
constructor(frameId: string, contextResources: ContextResources, snapshots: FrameSnapshot[], index: number) { constructor(contextResources: ContextResources, snapshots: FrameSnapshot[], index: number) {
this._frameId = frameId;
this._contextResources = contextResources; this._contextResources = contextResources;
this._snapshots = snapshots; this._snapshots = snapshots;
this._index = index; this._index = index;
@ -80,7 +71,7 @@ export class SnapshotRenderer {
const resources: { [key: string]: { resourceId: string, sha1?: string } } = {}; const resources: { [key: string]: { resourceId: string, sha1?: string } } = {};
for (const [url, contextResources] of this._contextResources) { for (const [url, contextResources] of this._contextResources) {
const contextResource = contextResources.find(r => r.frameId === this._frameId) || contextResources[0]; const contextResource = contextResources.find(r => r.frameId === snapshot.frameId) || contextResources[0];
if (contextResource) if (contextResource)
resources[url] = { resourceId: contextResource.resourceId }; resources[url] = { resourceId: contextResource.resourceId };
} }

View file

@ -16,8 +16,9 @@
import * as http from 'http'; import * as http from 'http';
import querystring from 'querystring'; import querystring from 'querystring';
import { SnapshotRenderer, RenderedFrameSnapshot } from './snapshotRenderer'; import { SnapshotRenderer } from './snapshotRenderer';
import { HttpServer } from '../../utils/httpServer'; import { HttpServer } from '../../utils/httpServer';
import type { RenderedFrameSnapshot } from './snapshot';
export type NetworkResponse = { export type NetworkResponse = {
contentType: string; contentType: string;
@ -26,9 +27,9 @@ export type NetworkResponse = {
}; };
export interface SnapshotStorage { export interface SnapshotStorage {
resourceContent(sha1: string): Buffer; resourceContent(sha1: string): Buffer | undefined;
resourceById(resourceId: string): NetworkResponse; resourceById(resourceId: string): NetworkResponse | undefined;
snapshotByName(snapshotName: string): SnapshotRenderer | undefined; snapshotById(snapshotId: string): SnapshotRenderer | undefined;
} }
export class SnapshotServer { export class SnapshotServer {
@ -207,7 +208,7 @@ export class SnapshotServer {
response.setHeader('Cache-Control', 'public, max-age=31536000'); response.setHeader('Cache-Control', 'public, max-age=31536000');
response.setHeader('Content-Type', 'application/json'); response.setHeader('Content-Type', 'application/json');
const parsed: any = querystring.parse(request.url!.substring(request.url!.indexOf('?') + 1)); const parsed: any = querystring.parse(request.url!.substring(request.url!.indexOf('?') + 1));
const snapshot = this._snapshotStorage.snapshotByName(parsed.snapshotName); const snapshot = this._snapshotStorage.snapshotById(parsed.snapshotName);
const snapshotData: any = snapshot ? snapshot.render() : { html: '' }; const snapshotData: any = snapshot ? snapshot.render() : { html: '' };
response.end(JSON.stringify(snapshotData)); response.end(JSON.stringify(snapshotData));
return true; return true;
@ -236,9 +237,14 @@ export class SnapshotServer {
} }
const resource = this._snapshotStorage.resourceById(resourceId); const resource = this._snapshotStorage.resourceById(resourceId);
if (!resource)
return false;
const sha1 = overrideSha1 || resource.responseSha1; const sha1 = overrideSha1 || resource.responseSha1;
try { try {
const content = this._snapshotStorage.resourceContent(sha1); const content = this._snapshotStorage.resourceContent(sha1);
if (!content)
return false;
response.statusCode = 200; response.statusCode = 200;
let contentType = resource.contentType; let contentType = resource.contentType;
const isTextEncoding = /^text\/|^application\/(javascript|json)/.test(contentType); const isTextEncoding = /^text\/|^application\/(javascript|json)/.test(contentType);

View file

@ -21,12 +21,13 @@ import { helper, RegisteredListener } from '../helper';
import { debugLogger } from '../../utils/debugLogger'; import { debugLogger } from '../../utils/debugLogger';
import { Frame } from '../frames'; import { Frame } from '../frames';
import { SnapshotData, frameSnapshotStreamer, kSnapshotBinding, kSnapshotStreamer } from './snapshotterInjected'; import { SnapshotData, frameSnapshotStreamer, kSnapshotBinding, kSnapshotStreamer } from './snapshotterInjected';
import { calculateSha1 } from '../../utils/utils'; import { calculateSha1, createGuid } from '../../utils/utils';
import { FrameSnapshot } from './snapshot'; import { FrameSnapshot } from './snapshot';
export type SnapshotterResource = { export type SnapshotterResource = {
resourceId: string,
pageId: string, pageId: string,
frameId: string, // Empty means main frame frameId: string,
url: string, url: string,
contentType: string, contentType: string,
responseHeaders: { name: string, value: string }[], responseHeaders: { name: string, value: string }[],
@ -45,7 +46,7 @@ export type SnapshotterBlob = {
export interface SnapshotterDelegate { export interface SnapshotterDelegate {
onBlob(blob: SnapshotterBlob): void; onBlob(blob: SnapshotterBlob): void;
onResource(resource: SnapshotterResource): void; onResource(resource: SnapshotterResource): void;
onFrameSnapshot(frame: Frame, frameUrl: string, snapshot: FrameSnapshot, snapshotId?: string): void; onFrameSnapshot(snapshot: FrameSnapshot): void;
} }
export class Snapshotter { export class Snapshotter {
@ -61,6 +62,10 @@ export class Snapshotter {
]; ];
this._context.exposeBinding(kSnapshotBinding, false, (source, data: SnapshotData) => { this._context.exposeBinding(kSnapshotBinding, false, (source, data: SnapshotData) => {
const snapshot: FrameSnapshot = { const snapshot: FrameSnapshot = {
snapshotId: data.snapshotId,
pageId: source.page.idInSnapshot,
frameId: source.frame.idInSnapshot,
frameUrl: data.url,
doctype: data.doctype, doctype: data.doctype,
html: data.html, html: data.html,
viewport: data.viewport, viewport: data.viewport,
@ -76,7 +81,7 @@ export class Snapshotter {
snapshot.resourceOverrides.push({ url, ref: content }); snapshot.resourceOverrides.push({ url, ref: content });
} }
} }
this._delegate.onFrameSnapshot(source.frame, data.url, snapshot, data.snapshotId); this._delegate.onFrameSnapshot(snapshot);
}); });
this._context._doAddInitScript('(' + frameSnapshotStreamer.toString() + ')()'); this._context._doAddInitScript('(' + frameSnapshotStreamer.toString() + ')()');
} }
@ -114,7 +119,7 @@ export class Snapshotter {
const context = await parent._mainContext(); const context = await parent._mainContext();
await context.evaluateInternal(({ kSnapshotStreamer, frameElement, frameId }) => { await context.evaluateInternal(({ kSnapshotStreamer, frameElement, frameId }) => {
(window as any)[kSnapshotStreamer].markIframe(frameElement, frameId); (window as any)[kSnapshotStreamer].markIframe(frameElement, frameId);
}, { kSnapshotStreamer, frameElement, frameId: frame.traceId }); }, { kSnapshotStreamer, frameElement, frameId: frame.idInSnapshot });
frameElement.dispose(); frameElement.dispose();
} catch (e) { } catch (e) {
// Ignore // Ignore
@ -147,8 +152,9 @@ export class Snapshotter {
const body = await response.body().catch(e => debugLogger.log('error', e)); const body = await response.body().catch(e => debugLogger.log('error', e));
const responseSha1 = body ? calculateSha1(body) : 'none'; const responseSha1 = body ? calculateSha1(body) : 'none';
const resource: SnapshotterResource = { const resource: SnapshotterResource = {
pageId: page.traceId, pageId: page.idInSnapshot,
frameId: response.frame().traceId, frameId: response.frame().idInSnapshot,
resourceId: 'resource@' + createGuid(),
url, url,
contentType, contentType,
responseHeaders: response.headers(), responseHeaders: response.headers(),

View file

@ -26,7 +26,7 @@ export type SnapshotData = {
}[], }[],
viewport: { width: number, height: number }, viewport: { width: number, height: number },
url: string, url: string,
snapshotId?: string, snapshotId: string,
}; };
export const kSnapshotStreamer = '__playwright_snapshot_streamer_'; export const kSnapshotStreamer = '__playwright_snapshot_streamer_';
@ -92,7 +92,7 @@ export function frameSnapshotStreamer() {
const observerConfig = { attributes: true, subtree: true }; const observerConfig = { attributes: true, subtree: true };
this._observer.observe(document, observerConfig); this._observer.observe(document, observerConfig);
this._streamSnapshot(); this._streamSnapshot('snapshot@initial');
} }
private _interceptNativeMethod(obj: any, method: string, cb: (thisObj: any, result: any) => void) { private _interceptNativeMethod(obj: any, method: string, cb: (thisObj: any, result: any) => void) {
@ -168,7 +168,7 @@ export function frameSnapshotStreamer() {
this._streamSnapshot(snapshotId); this._streamSnapshot(snapshotId);
} }
private _streamSnapshot(snapshotId?: string) { private _streamSnapshot(snapshotId: string) {
if (this._timer) { if (this._timer) {
clearTimeout(this._timer); clearTimeout(this._timer);
this._timer = undefined; this._timer = undefined;
@ -178,7 +178,7 @@ export function frameSnapshotStreamer() {
(window as any)[kSnapshotBinding](snapshot).catch((e: any) => {}); (window as any)[kSnapshotBinding](snapshot).catch((e: any) => {});
} catch (e) { } catch (e) {
} }
this._timer = setTimeout(() => this._streamSnapshot(), 100); this._timer = setTimeout(() => this._streamSnapshot(`snapshot@${performance.now()}`), 100);
} }
private _sanitizeUrl(url: string): string { private _sanitizeUrl(url: string): string {
@ -228,7 +228,7 @@ export function frameSnapshotStreamer() {
} }
} }
private _captureSnapshot(snapshotId?: string): SnapshotData { private _captureSnapshot(snapshotId: string): SnapshotData {
const snapshotNumber = ++this._lastSnapshotNumber; const snapshotNumber = ++this._lastSnapshotNumber;
let nodeCounter = 0; let nodeCounter = 0;
let shadowDomNesting = 0; let shadowDomNesting = 0;

View file

@ -129,8 +129,6 @@ export type FrameSnapshotTraceEvent = {
pageId: string, pageId: string,
frameId: string, frameId: string,
snapshot: FrameSnapshot, snapshot: FrameSnapshot,
frameUrl: string,
snapshotId?: string,
}; };
export type TraceEvent = export type TraceEvent =

View file

@ -121,7 +121,7 @@ class ContextTracer implements SnapshotterDelegate {
contextId: this._contextId, contextId: this._contextId,
pageId: resource.pageId, pageId: resource.pageId,
frameId: resource.frameId, frameId: resource.frameId,
resourceId: 'resource@' + createGuid(), resourceId: resource.resourceId,
url: resource.url, url: resource.url,
contentType: resource.contentType, contentType: resource.contentType,
responseHeaders: resource.responseHeaders, responseHeaders: resource.responseHeaders,
@ -134,16 +134,14 @@ class ContextTracer implements SnapshotterDelegate {
this._appendTraceEvent(event); this._appendTraceEvent(event);
} }
onFrameSnapshot(frame: Frame, frameUrl: string, snapshot: FrameSnapshot, snapshotId?: string): void { onFrameSnapshot(snapshot: FrameSnapshot): void {
const event: trace.FrameSnapshotTraceEvent = { const event: trace.FrameSnapshotTraceEvent = {
timestamp: monotonicTime(), timestamp: monotonicTime(),
type: 'snapshot', type: 'snapshot',
contextId: this._contextId, contextId: this._contextId,
pageId: frame._page.traceId, pageId: snapshot.pageId,
frameId: frame.traceId, frameId: snapshot.frameId,
snapshot: snapshot, snapshot: snapshot,
frameUrl,
snapshotId,
}; };
this._appendTraceEvent(event); this._appendTraceEvent(event);
} }
@ -163,7 +161,7 @@ class ContextTracer implements SnapshotterDelegate {
timestamp: monotonicTime(), timestamp: monotonicTime(),
type: 'action', type: 'action',
contextId: this._contextId, contextId: this._contextId,
pageId: sdkObject.attribution.page.traceId, pageId: sdkObject.attribution.page.idInSnapshot,
objectType: metadata.type, objectType: metadata.type,
method: metadata.method, method: metadata.method,
// FIXME: filter out evaluation snippets, binary // FIXME: filter out evaluation snippets, binary
@ -179,7 +177,7 @@ class ContextTracer implements SnapshotterDelegate {
} }
private _onPage(page: Page) { private _onPage(page: Page) {
const pageId = page.traceId; const pageId = page.idInSnapshot;
const event: trace.PageCreatedTraceEvent = { const event: trace.PageCreatedTraceEvent = {
timestamp: monotonicTime(), timestamp: monotonicTime(),

View file

@ -1,124 +0,0 @@
/**
* 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 fs from 'fs';
import path from 'path';
import * as playwright from '../../../..';
import * as util from 'util';
import { ActionEntry, ContextEntry, TraceModel } from './traceModel';
import { SnapshotServer } from '../../snapshot/snapshotServer';
const fsReadFileAsync = util.promisify(fs.readFile.bind(fs));
const fsWriteFileAsync = util.promisify(fs.writeFile.bind(fs));
export class ScreenshotGenerator {
private _resourcesDir: string;
private _browserPromise: Promise<playwright.Browser>;
private _snapshotServer: SnapshotServer;
private _traceModel: TraceModel;
private _rendering = new Map<ActionEntry, Promise<Buffer | undefined>>();
private _lock = new Lock(3);
constructor(snapshotServer: SnapshotServer, resourcesDir: string, traceModel: TraceModel) {
this._snapshotServer = snapshotServer;
this._resourcesDir = resourcesDir;
this._traceModel = traceModel;
this._browserPromise = playwright.chromium.launch();
}
generateScreenshot(actionId: string): Promise<Buffer | undefined> {
const { context, action } = this._traceModel.actionById(actionId);
if (!this._rendering.has(action)) {
this._rendering.set(action, this._render(context, action).then(body => {
this._rendering.delete(action);
return body;
}));
}
return this._rendering.get(action)!;
}
private async _render(contextEntry: ContextEntry, actionEntry: ActionEntry): Promise<Buffer | undefined> {
const imageFileName = path.join(this._resourcesDir, actionEntry.action.timestamp + '-screenshot.png');
try {
return await fsReadFileAsync(imageFileName);
} catch (e) {
// fall through
}
const { action } = actionEntry;
const browser = await this._browserPromise;
await this._lock.obtain();
const page = await browser.newPage({
viewport: contextEntry.created.viewportSize,
deviceScaleFactor: contextEntry.created.deviceScaleFactor
});
try {
await page.goto(this._snapshotServer.snapshotRootUrl());
const snapshots = action.snapshots || [];
const snapshotId = snapshots.length ? snapshots[0].snapshotId : undefined;
const snapshotUrl = this._snapshotServer.snapshotUrl(action.pageId!, snapshotId, action.endTime);
console.log('Generating screenshot for ' + action.method); // eslint-disable-line no-console
await page.evaluate(snapshotUrl => (window as any).showSnapshot(snapshotUrl), snapshotUrl);
try {
const element = await page.$(action.params.selector || '*[__playwright_target__]');
if (element) {
await element.evaluate(e => {
e.style.backgroundColor = '#ff69b460';
});
}
} catch (e) {
console.log(e); // eslint-disable-line no-console
}
const imageData = await page.screenshot();
await fsWriteFileAsync(imageFileName, imageData);
return imageData;
} catch (e) {
console.log(e); // eslint-disable-line no-console
} finally {
await page.close();
this._lock.release();
}
}
}
class Lock {
private _maxWorkers: number;
private _callbacks: (() => void)[] = [];
private _workers = 0;
constructor(maxWorkers: number) {
this._maxWorkers = maxWorkers;
}
async obtain() {
while (this._workers === this._maxWorkers)
await new Promise<void>(f => this._callbacks.push(f));
++this._workers;
}
release() {
--this._workers;
const callbacks = this._callbacks;
this._callbacks = [];
for (const callback of callbacks)
callback();
}
}

View file

@ -16,7 +16,8 @@
import { createGuid } from '../../../utils/utils'; import { createGuid } from '../../../utils/utils';
import * as trace from '../common/traceEvents'; import * as trace from '../common/traceEvents';
import { ContextResources, SnapshotRenderer } from '../../snapshot/snapshotRenderer'; import { SnapshotRenderer } from '../../snapshot/snapshotRenderer';
import { ContextResources } from '../../snapshot/snapshot';
export * as trace from '../common/traceEvents'; export * as trace from '../common/traceEvents';
export class TraceModel { export class TraceModel {
@ -74,7 +75,6 @@ export class TraceModel {
const action: ActionEntry = { const action: ActionEntry = {
actionId, actionId,
action: event, action: event,
thumbnailUrl: `/action-preview/${actionId}.png`,
resources: pageEntry.resources, resources: pageEntry.resources,
}; };
pageEntry.resources = []; pageEntry.resources = [];
@ -156,8 +156,8 @@ export class TraceModel {
const { pageEntry, contextEntry } = this.pageEntries.get(pageId)!; const { pageEntry, contextEntry } = this.pageEntries.get(pageId)!;
const frameSnapshots = pageEntry.snapshotsByFrameId[frameId]; const frameSnapshots = pageEntry.snapshotsByFrameId[frameId];
for (let index = 0; index < frameSnapshots.length; index++) { for (let index = 0; index < frameSnapshots.length; index++) {
if (frameSnapshots[index].snapshotId === snapshotId) if (frameSnapshots[index].snapshot.snapshotId === snapshotId)
return new SnapshotRenderer(frameId, this.contextResources.get(contextEntry.created.contextId)!, frameSnapshots.map(fs => fs.snapshot), index); return new SnapshotRenderer(this.contextResources.get(contextEntry.created.contextId)!, frameSnapshots.map(fs => fs.snapshot), index);
} }
} }
@ -170,7 +170,7 @@ export class TraceModel {
if (timestamp && snapshot.timestamp <= timestamp) if (timestamp && snapshot.timestamp <= timestamp)
snapshotIndex = index; snapshotIndex = index;
} }
return snapshotIndex >= 0 ? new SnapshotRenderer(frameId, this.contextResources.get(contextEntry.created.contextId)!, frameSnapshots.map(fs => fs.snapshot), snapshotIndex) : undefined; return snapshotIndex >= 0 ? new SnapshotRenderer(this.contextResources.get(contextEntry.created.contextId)!, frameSnapshots.map(fs => fs.snapshot), snapshotIndex) : undefined;
} }
} }
@ -197,7 +197,6 @@ export type PageEntry = {
export type ActionEntry = { export type ActionEntry = {
actionId: string; actionId: string;
action: trace.ActionTraceEvent; action: trace.ActionTraceEvent;
thumbnailUrl: string;
resources: trace.NetworkResourceTraceEvent[]; resources: trace.NetworkResourceTraceEvent[];
}; };

View file

@ -18,7 +18,6 @@ import fs from 'fs';
import path from 'path'; import path from 'path';
import * as playwright from '../../../..'; import * as playwright from '../../../..';
import * as util from 'util'; import * as util from 'util';
import { ScreenshotGenerator } from './screenshotGenerator';
import { TraceModel } from './traceModel'; import { TraceModel } from './traceModel';
import { NetworkResourceTraceEvent, TraceEvent } from '../common/traceEvents'; import { NetworkResourceTraceEvent, TraceEvent } from '../common/traceEvents';
import { ServerRouteHandler, HttpServer } from '../../../utils/httpServer'; import { ServerRouteHandler, HttpServer } from '../../../utils/httpServer';
@ -62,7 +61,6 @@ class TraceViewer implements SnapshotStorage {
// Served by TraceViewer // Served by TraceViewer
// - "/traceviewer/..." - our frontend. // - "/traceviewer/..." - our frontend.
// - "/file?filePath" - local files, used by sources tab. // - "/file?filePath" - local files, used by sources tab.
// - "/action-preview/..." - lazily generated action previews.
// - "/sha1/<sha1>" - trace resource bodies, used by network previews. // - "/sha1/<sha1>" - trace resource bodies, used by network previews.
// //
// Served by SnapshotServer // Served by SnapshotServer
@ -73,6 +71,7 @@ class TraceViewer implements SnapshotStorage {
// and translates them into "/resources/<resourceId>". // and translates them into "/resources/<resourceId>".
const server = new HttpServer(); const server = new HttpServer();
new SnapshotServer(server, this);
const traceModelHandler: ServerRouteHandler = (request, response) => { const traceModelHandler: ServerRouteHandler = (request, response) => {
response.statusCode = 200; response.statusCode = 200;
@ -82,9 +81,6 @@ class TraceViewer implements SnapshotStorage {
}; };
server.routePath('/contexts', traceModelHandler); server.routePath('/contexts', traceModelHandler);
const snapshotServer = new SnapshotServer(server, this);
const screenshotGenerator = this._document ? new ScreenshotGenerator(snapshotServer, this._document.resourcesDir, this._document.model) : undefined;
const traceViewerHandler: ServerRouteHandler = (request, response) => { const traceViewerHandler: ServerRouteHandler = (request, response) => {
const relativePath = request.url!.substring('/traceviewer/'.length); const relativePath = request.url!.substring('/traceviewer/'.length);
const absolutePath = path.join(__dirname, '..', '..', '..', 'web', ...relativePath.split('/')); const absolutePath = path.join(__dirname, '..', '..', '..', 'web', ...relativePath.split('/'));
@ -92,26 +88,6 @@ class TraceViewer implements SnapshotStorage {
}; };
server.routePrefix('/traceviewer/', traceViewerHandler, true); server.routePrefix('/traceviewer/', traceViewerHandler, true);
const actionPreviewHandler: ServerRouteHandler = (request, response) => {
if (!screenshotGenerator)
return false;
const fullPath = request.url!.substring('/action-preview/'.length);
const actionId = fullPath.substring(0, fullPath.indexOf('.png'));
screenshotGenerator.generateScreenshot(actionId).then(body => {
if (!body) {
response.statusCode = 404;
response.end();
} else {
response.statusCode = 200;
response.setHeader('Content-Type', 'image/png');
response.setHeader('Content-Length', body.byteLength);
response.end(body);
}
});
return true;
};
server.routePrefix('/action-preview/', actionPreviewHandler);
const fileHandler: ServerRouteHandler = (request, response) => { const fileHandler: ServerRouteHandler = (request, response) => {
try { try {
const url = new URL('http://localhost' + request.url!); const url = new URL('http://localhost' + request.url!);
@ -141,19 +117,19 @@ class TraceViewer implements SnapshotStorage {
await uiPage.goto(urlPrefix + '/traceviewer/traceViewer/index.html'); await uiPage.goto(urlPrefix + '/traceviewer/traceViewer/index.html');
} }
resourceById(resourceId: string): NetworkResourceTraceEvent { resourceById(resourceId: string): NetworkResourceTraceEvent | undefined {
const traceModel = this._document!.model; const traceModel = this._document!.model;
return traceModel.resourceById.get(resourceId)!; return traceModel.resourceById.get(resourceId)!;
} }
snapshotByName(snapshotName: string): SnapshotRenderer | undefined { snapshotById(snapshotName: string): SnapshotRenderer | undefined {
const traceModel = this._document!.model; const traceModel = this._document!.model;
const parsed = parseSnapshotName(snapshotName); const parsed = parseSnapshotName(snapshotName);
const snapshot = parsed.snapshotId ? traceModel.findSnapshotById(parsed.pageId, parsed.frameId, parsed.snapshotId) : traceModel.findSnapshotByTime(parsed.pageId, parsed.frameId, parsed.timestamp!); const snapshot = parsed.snapshotId ? traceModel.findSnapshotById(parsed.pageId, parsed.frameId, parsed.snapshotId) : traceModel.findSnapshotByTime(parsed.pageId, parsed.frameId, parsed.timestamp!);
return snapshot; return snapshot;
} }
resourceContent(sha1: string): Buffer { resourceContent(sha1: string): Buffer | undefined {
return fs.readFileSync(path.join(this._document!.resourcesDir, sha1)); return fs.readFileSync(path.join(this._document!.resourcesDir, sha1));
} }
} }

View file

@ -80,18 +80,3 @@
display: inline; display: inline;
padding-left: 5px; padding-left: 5px;
} }
.action-thumbnail {
flex: none;
display: flex;
align-items: center;
justify-content: center;
width: 200px;
height: 100px;
box-shadow: var(--box-shadow);
}
.action-thumbnail img {
max-width: 200px;
max-height: 100px;
}

View file

@ -16,8 +16,6 @@
import { Story, Meta } from '@storybook/react/types-6-0'; import { Story, Meta } from '@storybook/react/types-6-0';
import { ActionList, ActionListProps } from './actionList'; import { ActionList, ActionListProps } from './actionList';
import gotoThumbnailUrl from './assets/action-thumbnail-goto.png';
import clickThumbnailUrl from './assets/action-thumbnail-click.png';
export default { export default {
title: 'TraceViewer/ActionList', title: 'TraceViewer/ActionList',
@ -43,7 +41,6 @@ Primary.args = {
startTime: Date.now(), startTime: Date.now(),
endTime: Date.now(), endTime: Date.now(),
}, },
thumbnailUrl: gotoThumbnailUrl,
resources: [], resources: [],
}, },
{ {
@ -57,7 +54,6 @@ Primary.args = {
startTime: Date.now(), startTime: Date.now(),
endTime: Date.now(), endTime: Date.now(),
}, },
thumbnailUrl: clickThumbnailUrl,
resources: [], resources: [],
} }
] ]

View file

@ -35,8 +35,7 @@ export const ActionList: React.FC<ActionListProps> = ({
}) => { }) => {
const targetAction = highlightedAction || selectedAction; const targetAction = highlightedAction || selectedAction;
return <div className='action-list'>{actions.map(actionEntry => { return <div className='action-list'>{actions.map(actionEntry => {
const { action, actionId, thumbnailUrl } = actionEntry; const { action, actionId } = actionEntry;
const selector = action.params.selector;
return <div return <div
className={'action-entry' + (actionEntry === targetAction ? ' selected' : '')} className={'action-entry' + (actionEntry === targetAction ? ' selected' : '')}
key={actionId} key={actionId}
@ -50,9 +49,6 @@ export const ActionList: React.FC<ActionListProps> = ({
{action.params.selector && <div className='action-selector' title={action.params.selector}>{action.params.selector}</div>} {action.params.selector && <div className='action-selector' title={action.params.selector}>{action.params.selector}</div>}
{action.method === 'goto' && action.params.url && <div className='action-url' title={action.params.url}>{action.params.url}</div>} {action.method === 'goto' && action.params.url && <div className='action-url' title={action.params.url}>{action.params.url}</div>}
</div> </div>
<div className='action-thumbnail'>
<img src={thumbnailUrl} />
</div>
</div>; </div>;
})}</div>; })}</div>;
}; };

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 159 KiB

View file

@ -63,7 +63,7 @@ it('should record trace', (test, { browserName, platform }) => {
expect(clickEvent).toBeTruthy(); expect(clickEvent).toBeTruthy();
expect(clickEvent.snapshots.length).toBe(2); expect(clickEvent.snapshots.length).toBe(2);
const snapshotId = clickEvent.snapshots[0].snapshotId; const snapshotId = clickEvent.snapshots[0].snapshotId;
const snapshotEvent = traceEvents.find(event => event.type === 'snapshot' && event.snapshotId === snapshotId) as trace.FrameSnapshotTraceEvent; const snapshotEvent = traceEvents.find(event => event.type === 'snapshot' && event.snapshot.snapshotId === snapshotId) as trace.FrameSnapshotTraceEvent;
expect(snapshotEvent).toBeTruthy(); expect(snapshotEvent).toBeTruthy();
}); });

View file

@ -155,6 +155,7 @@ DEPS['src/service.ts'] = ['src/remote/'];
DEPS['src/cli/'] = ['src/cli/**', 'src/client/**', 'src/install/**', 'src/generated/', 'src/server/injected/', 'src/debug/injected/', 'src/server/trace/**', 'src/utils/**']; DEPS['src/cli/'] = ['src/cli/**', 'src/client/**', 'src/install/**', 'src/generated/', 'src/server/injected/', 'src/debug/injected/', 'src/server/trace/**', 'src/utils/**'];
DEPS['src/server/supplements/recorder/recorderApp.ts'] = ['src/common/', 'src/utils/', 'src/server/', 'src/server/chromium/']; DEPS['src/server/supplements/recorder/recorderApp.ts'] = ['src/common/', 'src/utils/', 'src/server/', 'src/server/chromium/'];
DEPS['src/server/supplements/recorderSupplement.ts'] = ['src/server/snapshot/', ...DEPS['src/server/']];
DEPS['src/utils/'] = ['src/common/']; DEPS['src/utils/'] = ['src/common/'];
// Trace viewer // Trace viewer