/** * 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 * as http from 'http'; import fs from 'fs'; import path from 'path'; import querystring from 'querystring'; import type { TraceModel } from './traceModel'; import * as trace from '../common/traceEvents'; import { TraceServer } from './traceServer'; export class SnapshotServer { private _resourcesDir: string | undefined; private _server: TraceServer; private _resourceById: Map; private _traceModel: TraceModel; constructor(server: TraceServer, traceModel: TraceModel, resourcesDir: string | undefined) { this._resourcesDir = resourcesDir; this._server = server; this._resourceById = new Map(); this._traceModel = traceModel; for (const contextEntry of traceModel.contexts) { for (const pageEntry of contextEntry.pages) { for (const action of pageEntry.actions) action.resources.forEach(r => this._resourceById.set(r.resourceId, r)); pageEntry.resources.forEach(r => this._resourceById.set(r.resourceId, r)); } } server.routePath('/snapshot/', this._serveSnapshotRoot.bind(this), true); server.routePath('/snapshot/service-worker.js', this._serveServiceWorker.bind(this)); server.routePath('/snapshot-data', this._serveSnapshot.bind(this)); server.routePrefix('/resources/', this._serveResource.bind(this)); } snapshotRootUrl() { return this._server.urlPrefix() + '/snapshot/'; } snapshotUrl(pageId: string, snapshotId?: string, timestamp?: number) { // Prefer snapshotId over timestamp. if (snapshotId) return this._server.urlPrefix() + `/snapshot/pageId/${pageId}/snapshotId/${snapshotId}/main`; if (timestamp) return this._server.urlPrefix() + `/snapshot/pageId/${pageId}/timestamp/${timestamp}/main`; return 'data:text/html,Snapshot is not available'; } private _serveSnapshotRoot(request: http.IncomingMessage, response: http.ServerResponse): boolean { response.statusCode = 200; response.setHeader('Cache-Control', 'public, max-age=31536000'); response.setHeader('Content-Type', 'text/html'); response.end(` `); return true; } private _frameSnapshotData(parsed: { pageId: string, frameId: string, snapshotId?: string, timestamp?: number }) { let contextEntry; let pageEntry; for (const c of this._traceModel.contexts) { for (const p of c.pages) { if (p.created.pageId === parsed.pageId) { contextEntry = c; pageEntry = p; } } } if (!contextEntry || !pageEntry) return { html: '' }; const frameSnapshots = pageEntry.snapshotsByFrameId[parsed.frameId] || []; let snapshotIndex = -1; for (let index = 0; index < frameSnapshots.length; index++) { const current = snapshotIndex === -1 ? undefined : frameSnapshots[snapshotIndex]; const snapshot = frameSnapshots[index]; // Prefer snapshot with exact id. const exactMatch = parsed.snapshotId && snapshot.snapshotId === parsed.snapshotId; const currentExactMatch = current && parsed.snapshotId && current.snapshotId === parsed.snapshotId; // If not available, prefer the latest snapshot before the timestamp. const timestampMatch = parsed.timestamp && snapshot.timestamp <= parsed.timestamp; if (exactMatch || (timestampMatch && !currentExactMatch)) snapshotIndex = index; } let html = this._serializeSnapshot(frameSnapshots, snapshotIndex); html += ``; const resourcesByUrl = contextEntry.resourcesByUrl; const overridenUrls = contextEntry.overridenUrls; const resourceOverrides: any = {}; for (const o of frameSnapshots[snapshotIndex].snapshot.resourceOverrides) resourceOverrides[o.url] = o.sha1; return { html, resourcesByUrl, overridenUrls, resourceOverrides }; } private _serializeSnapshot(snapshots: trace.FrameSnapshotTraceEvent[], initialSnapshotIndex: number): string { const visit = (n: trace.NodeSnapshot, snapshotIndex: number): string => { // Text node. if (typeof n === 'string') return escapeText(n); if (!(n as any)._string) { if (Array.isArray(n[0])) { // Node reference. const referenceIndex = snapshotIndex - n[0][0]; if (referenceIndex >= 0 && referenceIndex < snapshotIndex) { const nodes = snapshotNodes(snapshots[referenceIndex].snapshot); const nodeIndex = n[0][1]; if (nodeIndex >= 0 && nodeIndex < nodes.length) (n as any)._string = visit(nodes[nodeIndex], referenceIndex); } } else if (typeof n[0] === 'string') { // Element node. const builder: string[] = []; builder.push('<', n[0]); for (const [attr, value] of Object.entries(n[1] || {})) builder.push(' ', attr, '="', escapeAttribute(value as string), '"'); builder.push('>'); for (let i = 2; i < n.length; i++) builder.push(visit(n[i], snapshotIndex)); if (!autoClosing.has(n[0])) builder.push(''); (n as any)._string = builder.join(''); } else { // Why are we here? Let's not throw, just in case. (n as any)._string = ''; } } return (n as any)._string; }; const snapshot = snapshots[initialSnapshotIndex].snapshot; let html = visit(snapshot.html, initialSnapshotIndex); if (snapshot.doctype) html = `` + html; return html; } private _serveServiceWorker(request: http.IncomingMessage, response: http.ServerResponse): boolean { function serviceWorkerMain(self: any /* ServiceWorkerGlobalScope */) { const pageToResourcesByUrl = new Map(); const pageToOverriddenUrls = new Map(); const snapshotToResourceOverrides = new Map(); self.addEventListener('install', function(event: any) { }); self.addEventListener('activate', function(event: any) { event.waitUntil(self.clients.claim()); }); function parseUrl(urlString: string): { pageId: string, frameId: string, timestamp?: number, snapshotId?: string } { const url = new URL(urlString); const parts = url.pathname.split('/'); if (!parts[0]) parts.shift(); if (!parts[parts.length - 1]) parts.pop(); // - /snapshot/pageId//snapshotId// // - /snapshot/pageId//timestamp// if (parts.length !== 6 || parts[0] !== 'snapshot' || parts[1] !== 'pageId' || (parts[3] !== 'snapshotId' && parts[3] !== 'timestamp')) throw new Error(`Unexpected url "${urlString}"`); return { pageId: parts[2], frameId: parts[5] === 'main' ? parts[2] : parts[5], snapshotId: (parts[3] === 'snapshotId' ? parts[4] : undefined), timestamp: (parts[3] === 'timestamp' ? +parts[4] : undefined), }; } function respond404(): Response { return new Response(null, { status: 404 }); } function respondNotAvailable(): Response { return new Response('Snapshot is not available', { status: 200, headers: { 'Content-Type': 'text/html' } }); } function removeHash(url: string) { try { const u = new URL(url); u.hash = ''; return u.toString(); } catch (e) { return url; } } async function doFetch(event: any /* FetchEvent */): Promise { try { const pathname = new URL(event.request.url).pathname; if (pathname === '/snapshot/service-worker.js' || pathname === '/snapshot/') return fetch(event.request); } catch (e) { } const request = event.request; let parsed: { pageId: string, frameId: string, timestamp?: number, snapshotId?: string }; if (request.mode === 'navigate') { parsed = parseUrl(request.url); } else { const client = (await self.clients.get(event.clientId))!; parsed = parseUrl(client.url); } if (request.mode === 'navigate') { const htmlResponse = await fetch(`/snapshot-data?pageId=${parsed.pageId}&snapshotId=${parsed.snapshotId}×tamp=${parsed.timestamp}&frameId=${parsed.frameId}`); const { html, resourcesByUrl, overridenUrls, resourceOverrides } = await htmlResponse.json(); if (!html) return respondNotAvailable(); pageToResourcesByUrl.set(parsed.pageId, resourcesByUrl); pageToOverriddenUrls.set(parsed.pageId, overridenUrls); snapshotToResourceOverrides.set(parsed.snapshotId + '@' + parsed.timestamp, resourceOverrides); const response = new Response(html, { status: 200, headers: { 'Content-Type': 'text/html' } }); return response; } const resourcesByUrl = pageToResourcesByUrl.get(parsed.pageId); const overridenUrls = pageToOverriddenUrls.get(parsed.pageId); const resourceOverrides = snapshotToResourceOverrides.get(parsed.snapshotId + '@' + parsed.timestamp); const urlWithoutHash = removeHash(request.url); const resourcesWithUrl = resourcesByUrl?.[urlWithoutHash] || []; const resource = resourcesWithUrl.find(r => r.frameId === parsed.frameId) || resourcesWithUrl[0]; if (!resource) return respond404(); const overrideSha1 = resourceOverrides?.[urlWithoutHash]; const fetchUrl = overrideSha1 ? `/resources/${resource.resourceId}/override/${overrideSha1}` : `/resources/${resource.resourceId}`; const fetchedResponse = await fetch(fetchUrl); const headers = new Headers(fetchedResponse.headers); // We make a copy of the response, instead of just forwarding, // so that response url is not inherited as "/resources/...", but instead // as the original request url. // Response url turns into resource base uri that is used to resolve // relative links, e.g. url(/foo/bar) in style sheets. if (overridenUrls?.[urlWithoutHash]) { // No cache, so that we refetch overridden resources. headers.set('Cache-Control', 'no-cache'); } const response = new Response(fetchedResponse.body, { status: fetchedResponse.status, statusText: fetchedResponse.statusText, headers, }); return response; } self.addEventListener('fetch', function(event: any) { event.respondWith(doFetch(event)); }); } response.statusCode = 200; response.setHeader('Cache-Control', 'public, max-age=31536000'); response.setHeader('Content-Type', 'application/javascript'); response.end(`(${serviceWorkerMain.toString()})(self)`); return true; } private _serveSnapshot(request: http.IncomingMessage, response: http.ServerResponse): boolean { response.statusCode = 200; response.setHeader('Cache-Control', 'public, max-age=31536000'); response.setHeader('Content-Type', 'application/json'); const parsed = querystring.parse(request.url!.substring(request.url!.indexOf('?') + 1)); const snapshotData = this._frameSnapshotData(parsed as any); response.end(JSON.stringify(snapshotData)); return true; } private _serveResource(request: http.IncomingMessage, response: http.ServerResponse): boolean { if (!this._resourcesDir) return false; // - /resources/ // - /resources//override/ const parts = request.url!.split('/'); if (!parts[0]) parts.shift(); if (!parts[parts.length - 1]) parts.pop(); if (parts[0] !== 'resources') return false; let resourceId; let overrideSha1; if (parts.length === 2) { resourceId = parts[1]; } else if (parts.length === 4 && parts[2] === 'override') { resourceId = parts[1]; overrideSha1 = parts[3]; } else { return false; } const resource = this._resourceById.get(resourceId); if (!resource) return false; const sha1 = overrideSha1 || resource.responseSha1; try { const content = fs.readFileSync(path.join(this._resourcesDir, sha1)); response.statusCode = 200; let contentType = resource.contentType; const isTextEncoding = /^text\/|^application\/(javascript|json)/.test(contentType); if (isTextEncoding && !contentType.includes('charset')) contentType = `${contentType}; charset=utf-8`; response.setHeader('Content-Type', contentType); for (const { name, value } of resource.responseHeaders) response.setHeader(name, value); response.removeHeader('Content-Encoding'); response.removeHeader('Access-Control-Allow-Origin'); response.setHeader('Access-Control-Allow-Origin', '*'); response.removeHeader('Content-Length'); response.setHeader('Content-Length', content.byteLength); response.setHeader('Cache-Control', 'public, max-age=31536000'); response.end(content); return true; } catch (e) { return false; } } } const autoClosing = new Set(['AREA', 'BASE', 'BR', 'COL', 'COMMAND', 'EMBED', 'HR', 'IMG', 'INPUT', 'KEYGEN', 'LINK', 'MENUITEM', 'META', 'PARAM', 'SOURCE', 'TRACK', 'WBR']); const escaped = { '&': '&', '<': '<', '>': '>', '"': '"', '\'': ''' }; function escapeAttribute(s: string): string { return s.replace(/[&<>"']/ug, char => (escaped as any)[char]); } function escapeText(s: string): string { return s.replace(/[&<]/ug, char => (escaped as any)[char]); } function snapshotNodes(snapshot: trace.FrameSnapshot): trace.NodeSnapshot[] { if (!(snapshot as any)._nodes) { const nodes: trace.NodeSnapshot[] = []; const visit = (n: trace.NodeSnapshot) => { if (typeof n === 'string') { nodes.push(n); } else if (typeof n[0] === 'string') { for (let i = 2; i < n.length; i++) visit(n[i]); nodes.push(n); } }; visit(snapshot.html); (snapshot as any)._nodes = nodes; } return (snapshot as any)._nodes; }