Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

cherry-pick(#31781): chore: show error when opening newer trace with … (#31797)

Browse source 
…old viewer

Reference: https://github.com/microsoft/playwright-java/issues/1617
This commit is contained in:
Yury Semikhatsky 2024-07-22 10:01:28 -07:00 committed by GitHub
parent b129abab04
commit 2f17a270b6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 20 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
packages/trace-viewer/src/sw.ts
View file

@ -19,6 +19,7 @@ import { unwrapPopoutUrl } from './snapshotRenderer';
import { SnapshotServer } from './snapshotServer'; import { SnapshotServer } from './snapshotServer';
import { TraceModel } from './traceModel'; import { TraceModel } from './traceModel';
import { FetchTraceModelBackend, ZipTraceModelBackend } from './traceModelBackends'; import { FetchTraceModelBackend, ZipTraceModelBackend } from './traceModelBackends';
import { TraceVersionError } from './traceModernizer';
// @ts-ignore // @ts-ignore
declare const self: ServiceWorkerGlobalScope; declare const self: ServiceWorkerGlobalScope;
@ -57,6 +58,8 @@ async function loadTrace(traceUrl: string, traceFileName: string | null, clientI
console.error(error); console.error(error);
if (error?.message?.includes('Cannot find .trace file') && await traceModel.hasEntry('index.html')) if (error?.message?.includes('Cannot find .trace file') && await traceModel.hasEntry('index.html'))
throw new Error('Could not load trace. Did you upload a Playwright HTML report instead? Make sure to extract the archive first and then double-click the index.html file or put it on a web server.'); throw new Error('Could not load trace. Did you upload a Playwright HTML report instead? Make sure to extract the archive first and then double-click the index.html file or put it on a web server.');
if (error instanceof TraceVersionError)
throw new Error(`Could not load trace from ${traceFileName || traceUrl}. ${error.message}`);
if (traceFileName) if (traceFileName)
throw new Error(`Could not load trace from ${traceFileName}. Make sure to upload a valid Playwright trace.`); throw new Error(`Could not load trace from ${traceFileName}. Make sure to upload a valid Playwright trace.`);
throw new Error(`Could not load trace from ${traceUrl}. Make sure a valid Playwright Trace is accessible over this url.`); throw new Error(`Could not load trace from ${traceUrl}. Make sure a valid Playwright Trace is accessible over this url.`);

14
packages/trace-viewer/src/traceModernizer.ts
View file

@ -22,6 +22,15 @@ import type * as traceV6 from './versions/traceV6';
import type { ActionEntry, ContextEntry, PageEntry } from './entries'; import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { SnapshotStorage } from './snapshotStorage'; import type { SnapshotStorage } from './snapshotStorage';
export class TraceVersionError extends Error {
constructor(message: string) {
super(message);
this.name = 'TraceVersionError';
}
}
const latestVersion: trace.VERSION = 7;
export class TraceModernizer { export class TraceModernizer {
private _contextEntry: ContextEntry; private _contextEntry: ContextEntry;
private _snapshotStorage: SnapshotStorage; private _snapshotStorage: SnapshotStorage;
@ -71,6 +80,8 @@ export class TraceModernizer {
const contextEntry = this._contextEntry; const contextEntry = this._contextEntry;
switch (event.type) { switch (event.type) {
case 'context-options': { case 'context-options': {
if (event.version > latestVersion)
throw new TraceVersionError('The trace was created by a newer version of Playwright and is not supported by this version of the viewer. Please use latest Playwright to open the trace.');
this._version = event.version; this._version = event.version;
contextEntry.origin = event.origin; contextEntry.origin = event.origin;
contextEntry.browserName = event.browserName; contextEntry.browserName = event.browserName;
@ -181,9 +192,8 @@ export class TraceModernizer {
let version = this._version || event.version; let version = this._version || event.version;
if (version === undefined) if (version === undefined)
return [event]; return [event];
const lastVersion: trace.VERSION = 7;
let events = [event]; let events = [event];
for (; version < lastVersion; ++version) for (; version < latestVersion; ++version)
events = (this as any)[`_modernize_${version}_to_${version + 1}`].call(this, events); events = (this as any)[`_modernize_${version}_to_${version + 1}`].call(this, events);
return events; return events;
} }

BIN
tests/assets/trace-from-the-future.zip Normal file
View file

Binary file not shown.

5
tests/library/trace-viewer.spec.ts
View file

@ -120,6 +120,11 @@ test('should open simple trace viewer', async ({ showTraceViewer }) => {
]); ]);
}); });
test('should complain about newer version of trace in old viewer', async ({ showTraceViewer, asset }, testInfo) => {
const traceViewer = await showTraceViewer([asset('trace-from-the-future.zip')]);
await expect(traceViewer.page.getByText('The trace was created by a newer version of Playwright and is not supported by this version of the viewer.')).toBeVisible();
});
test('should contain action info', async ({ showTraceViewer }) => { test('should contain action info', async ({ showTraceViewer }) => {
const traceViewer = await showTraceViewer([traceFile]); const traceViewer = await showTraceViewer([traceFile]);
await traceViewer.selectAction('locator.click'); await traceViewer.selectAction('locator.click');