Skip to content

fix(trace): should survive ping as the first command after restart #37656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 30, 2025
Merged

fix(trace): should survive ping as the first command after restart #37656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 22 additions & 21 deletions packages/trace-viewer/src/sw/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,16 +93,27 @@ async function doFetch(event: FetchEvent): Promise<Response> {
const request = event.request;
const client = await self.clients.get(event.clientId);

const urlInScope = request.url.startsWith(self.registration.scope) ? new URL(unwrapPopoutUrl(request.url)) : undefined;
const relativePath = urlInScope?.pathname.substring(scopePath.length - 1);

if (relativePath !== '/contexts' && !clientIdToTraceUrls.has(event.clientId)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need it when url is undefined?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, for the urls out of the scope the code lower will work.

// Service worker was restarted upon subresource fetch.
// It was stopped because ping did not keep it alive since the tab itself was throttled.
const params = await loadClientIdParams(event.clientId);
if (params) {
for (const traceUrl of params.traceUrls)
await loadTrace(traceUrl, null, client, params.limit, () => {});
}
}

// When trace viewer is deployed over https, we will force upgrade
// insecure http subresources to https. Otherwise, these will fail
// to load inside our https snapshots.
// In this case, we also match http resources from the archive by
// the https urls.
const isDeployedAsHttps = self.registration.scope.startsWith('https://');

if (request.url.startsWith(self.registration.scope)) {
const url = new URL(unwrapPopoutUrl(request.url));
const relativePath = url.pathname.substring(scopePath.length - 1);
if (urlInScope && relativePath) {
if (relativePath === '/ping') {
await gc();
return new Response(null, { status: 200 });
Expand All @@ -112,12 +123,12 @@ async function doFetch(event: FetchEvent): Promise<Response> {
return new Response(null, { status: 200 });
}

const traceUrl = url.searchParams.get('trace');
const traceUrl = urlInScope.searchParams.get('trace');

if (relativePath === '/contexts') {
try {
const limit = url.searchParams.has('limit') ? +url.searchParams.get('limit')! : undefined;
const traceModel = await loadTrace(traceUrl!, url.searchParams.get('traceFileName'), client, limit, (done: number, total: number) => {
const limit = urlInScope.searchParams.has('limit') ? +urlInScope.searchParams.get('limit')! : undefined;
const traceModel = await loadTrace(traceUrl!, urlInScope.searchParams.get('traceFileName'), client, limit, (done: number, total: number) => {
client.postMessage({ method: 'progress', params: { done, total } });
});
return new Response(JSON.stringify(traceModel!.contextEntries), {
Expand All @@ -132,30 +143,20 @@ async function doFetch(event: FetchEvent): Promise<Response> {
}
}

if (!clientIdToTraceUrls.has(event.clientId)) {
// Service worker was restarted upon subresource fetch.
// It was stopped because ping did not keep it alive since the tab itself was throttled.
const params = await loadClientIdParams(event.clientId);
if (params) {
for (const traceUrl of params.traceUrls)
await loadTrace(traceUrl, null, client, params.limit, () => {});
}
}

if (relativePath.startsWith('/snapshotInfo/')) {
const { snapshotServer } = loadedTraces.get(traceUrl!) || {};
if (!snapshotServer)
return new Response(null, { status: 404 });
const pageOrFrameId = relativePath.substring('/snapshotInfo/'.length);
return snapshotServer.serveSnapshotInfo(pageOrFrameId, url.searchParams);
return snapshotServer.serveSnapshotInfo(pageOrFrameId, urlInScope.searchParams);
}

if (relativePath.startsWith('/snapshot/')) {
const { snapshotServer } = loadedTraces.get(traceUrl!) || {};
if (!snapshotServer)
return new Response(null, { status: 404 });
const pageOrFrameId = relativePath.substring('/snapshot/'.length);
const response = snapshotServer.serveSnapshot(pageOrFrameId, url.searchParams, url.href);
const response = snapshotServer.serveSnapshot(pageOrFrameId, urlInScope.searchParams, urlInScope.href);
if (isDeployedAsHttps)
response.headers.set('Content-Security-Policy', 'upgrade-insecure-requests');
return response;
Expand All @@ -166,7 +167,7 @@ async function doFetch(event: FetchEvent): Promise<Response> {
if (!snapshotServer)
return new Response(null, { status: 404 });
const pageOrFrameId = relativePath.substring('/closest-screenshot/'.length);
return snapshotServer.serveClosestScreenshot(pageOrFrameId, url.searchParams);
return snapshotServer.serveClosestScreenshot(pageOrFrameId, urlInScope.searchParams);
}

if (relativePath.startsWith('/sha1/')) {
Expand All @@ -175,13 +176,13 @@ async function doFetch(event: FetchEvent): Promise<Response> {
for (const trace of loadedTraces.values()) {
const blob = await trace.traceModel.resourceForSha1(sha1);
if (blob)
return new Response(blob, { status: 200, headers: downloadHeaders(url.searchParams) });
return new Response(blob, { status: 200, headers: downloadHeaders(urlInScope.searchParams) });
}
return new Response(null, { status: 404 });
}

if (relativePath.startsWith('/file/')) {
const path = url.searchParams.get('path')!;
const path = urlInScope.searchParams.get('path')!;
const traceViewerServer = clientIdToTraceUrls.get(event.clientId ?? '')?.traceViewerServer;
if (!traceViewerServer)
throw new Error('client is not initialized');
Expand Down
20 changes: 20 additions & 0 deletions tests/library/trace-viewer.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2056,3 +2056,23 @@ test('should survive service worker restart', async ({ page, runAndTrace, server
const snapshot2 = await traceViewer.snapshotFrame('Set content');
await expect(snapshot2.locator('body')).toHaveText('Old world');
});

test('should survive ping after service worker restart', async ({ page, runAndTrace, server }) => {
const traceViewer = await runAndTrace(async () => {
await page.goto(server.EMPTY_PAGE);
await page.setContent('Old world');
await page.evaluate(() => document.body.textContent = 'New world');
});
const snapshot1 = await traceViewer.snapshotFrame('Evaluate');
await expect(snapshot1.locator('body')).toHaveText('New world');

const status = await traceViewer.page.evaluate(async () => {
const response1 = await fetch('restartServiceWorker');
const response2 = await fetch('ping');
return response1.status + '/' + response2.status;
});
expect(status).toBe('200/200');

const snapshot2 = await traceViewer.snapshotFrame('Set content');
await expect(snapshot2.locator('body')).toHaveText('Old world');
});
Loading