Skip to content

Commit

Permalink
cherry-pick(9726): feat(traceviewer): show load progress
Browse files Browse the repository at this point in the history
  • Loading branch information
pavelfeldman committed Oct 25, 2021
1 parent b3a1d34 commit 676a2a0
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 15 deletions.
17 changes: 11 additions & 6 deletions packages/playwright-core/src/web/traceViewer/sw.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,16 @@ const scopePath = new URL(self.registration.scope).pathname;

const loadedTraces = new Map<string, { traceModel: TraceModel, snapshotServer: SnapshotServer, clientId: string }>();

async function loadTrace(trace: string, clientId: string): Promise<TraceModel> {
async function loadTrace(trace: string, clientId: string, progress: (done: number, total: number) => void): Promise<TraceModel> {
const entry = loadedTraces.get(trace);
if (entry)
return entry.traceModel;
const traceModel = new TraceModel();
const url = trace.startsWith('http') || trace.startsWith('blob') ? trace : `/file?path=${trace}`;
await traceModel.load(url);
let url = trace.startsWith('http') || trace.startsWith('blob') ? trace : `/file?path=${trace}`;
// Dropbox does not support cors.
if (url.startsWith('https://www.dropbox.com/'))
url = 'https://dl.dropboxusercontent.com/' + url.substring('https://www.dropbox.com/'.length);
await traceModel.load(url, progress);
const snapshotServer = new SnapshotServer(traceModel.storage());
loadedTraces.set(trace, { traceModel, snapshotServer, clientId });
return traceModel;
Expand All @@ -47,8 +50,8 @@ async function loadTrace(trace: string, clientId: string): Promise<TraceModel> {
// @ts-ignore
async function doFetch(event: FetchEvent): Promise<Response> {
const request = event.request;
const snapshotUrl = request.mode === 'navigate' ?
request.url : (await self.clients.get(event.clientId))!.url;
const client = await self.clients.get(event.clientId);
const snapshotUrl = request.mode === 'navigate' ? request.url : client!.url;
const traceUrl = new URL(snapshotUrl).searchParams.get('trace')!;
const { snapshotServer } = loadedTraces.get(traceUrl) || {};

Expand All @@ -62,7 +65,9 @@ async function doFetch(event: FetchEvent): Promise<Response> {
}

if (relativePath === '/context') {
const traceModel = await loadTrace(traceUrl, event.clientId);
const traceModel = await loadTrace(traceUrl, event.clientId, (done: number, total: number) => {
client.postMessage({ method: 'progress', params: { done, total } });
});
return new Response(JSON.stringify(traceModel!.contextEntry), {
status: 200,
headers: { 'Content-Type': 'application/json' }
Expand Down
10 changes: 5 additions & 5 deletions packages/playwright-core/src/web/traceViewer/traceModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ export class TraceModel {
this.contextEntry = createEmptyContext();
}

async load(traceURL: string) {
const response = await fetch(traceURL, { mode: 'cors' });
const blob = await response.blob();
const zipReader = new zipjs.ZipReader(new zipjs.BlobReader(blob), { useWebWorkers: false }) as zip.ZipReader;
async load(traceURL: string, progress: (done: number, total: number) => void) {
const zipReader = new zipjs.ZipReader(
new zipjs.HttpReader(traceURL, { mode: 'cors' }),
{ useWebWorkers: false }) as zip.ZipReader;
let traceEntry: zip.Entry | undefined;
let networkEntry: zip.Entry | undefined;
for (const entry of await zipReader.getEntries()) {
for (const entry of await zipReader.getEntries({ onprogress: progress })) {
if (entry.filename.endsWith('.trace'))
traceEntry = entry;
if (entry.filename.endsWith('.network'))
Expand Down
13 changes: 13 additions & 0 deletions packages/playwright-core/src/web/traceViewer/ui/workbench.css
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,19 @@
font-weight: bold;
}

.progress {
position: relative;
margin: auto;
width: 400px;
height: 10px;
border: 1px solid #aaa;
}

.inner-progress {
background-color: #aaa;
height: 100%;
}

.workbench {
contain: size;
user-select: none;
Expand Down
20 changes: 16 additions & 4 deletions packages/playwright-core/src/web/traceViewer/ui/workbench.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ export const Workbench: React.FunctionComponent<{
const [selectedAction, setSelectedAction] = React.useState<ActionTraceEvent | undefined>();
const [highlightedAction, setHighlightedAction] = React.useState<ActionTraceEvent | undefined>();
const [selectedTab, setSelectedTab] = React.useState<string>('logs');
const [progress, setProgress] = React.useState<{ done: number, total: number }>({ done: 0, total: 0 });

const handleDropEvent = (event: any) => {
event.preventDefault();
Expand All @@ -52,7 +53,15 @@ export const Workbench: React.FunctionComponent<{
React.useEffect(() => {
(async () => {
if (traceURL) {
const swListener = (event: any) => {
if (event.data.method === 'progress')
setProgress(event.data.params);
};
navigator.serviceWorker.addEventListener('message', swListener);
setProgress({ done: 0, total: 1 });
const contextEntry = (await fetch(`context?trace=${traceURL}`).then(response => response.json())) as ContextEntry;
navigator.serviceWorker.removeEventListener('message', swListener);
setProgress({ done: 0, total: 0 });
modelUtil.indexModel(contextEntry);
setContextEntry(contextEntry);
} else {
Expand All @@ -64,18 +73,21 @@ export const Workbench: React.FunctionComponent<{
const defaultSnapshotSize = contextEntry.options.viewport || { width: 1280, height: 720 };
const boundaries = { minimum: contextEntry.startTime, maximum: contextEntry.endTime };

if (!traceURL) {
if (!traceURL || progress.total) {
return <div className='vbox workbench'>
<div className='hbox header'>
<div className='logo'>🎭</div>
<div className='product'>Playwright</div>
<div className='spacer'></div>
</div>
<div className='drop-target'
{!!progress.total && <div className='progress'>
<div className='inner-progress' style={{ width: (100 * progress.done / progress.total) + '%' }}></div>
</div>}
{!progress.total && <div className='drop-target'
onDragOver={event => { event.preventDefault(); }}
onDrop={event => handleDropEvent(event)}>
Drop Playwright Trace here
</div>
Drop Playwright Trace here
</div>}
</div>;
}

Expand Down

0 comments on commit 676a2a0

Please sign in to comment.