2021-01-28 04:42:51 +01:00
|
|
|
/**
|
|
|
|
|
* 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';
|
2021-02-11 15:36:15 +01:00
|
|
|
import fs from 'fs';
|
|
|
|
|
import path from 'path';
|
2021-02-24 20:52:59 +01:00
|
|
|
import querystring from 'querystring';
|
2021-01-29 00:09:20 +01:00
|
|
|
import { TraceServer } from './traceServer';
|
2021-02-25 04:29:16 +01:00
|
|
|
import type { FrameSnapshot, SerializedFrameSnapshot } from './frameSnapshot';
|
|
|
|
|
import type { NetworkResourceTraceEvent } from '../common/traceEvents';
|
|
|
|
|
|
|
|
|
|
export interface SnapshotStorage {
|
|
|
|
|
resourceById(resourceId: string): NetworkResourceTraceEvent;
|
|
|
|
|
snapshotByName(snapshotName: string): FrameSnapshot | undefined;
|
|
|
|
|
}
|
2021-01-28 04:42:51 +01:00
|
|
|
|
|
|
|
|
export class SnapshotServer {
|
|
|
|
|
private _resourcesDir: string | undefined;
|
2021-02-25 04:29:16 +01:00
|
|
|
private _urlPrefix: string;
|
|
|
|
|
private _snapshotStorage: SnapshotStorage;
|
2021-01-28 04:42:51 +01:00
|
|
|
|
2021-02-25 04:29:16 +01:00
|
|
|
constructor(server: TraceServer, snapshotStorage: SnapshotStorage, resourcesDir: string | undefined) {
|
2021-01-28 04:42:51 +01:00
|
|
|
this._resourcesDir = resourcesDir;
|
2021-02-25 04:29:16 +01:00
|
|
|
this._urlPrefix = server.urlPrefix();
|
|
|
|
|
this._snapshotStorage = snapshotStorage;
|
2021-01-28 04:42:51 +01:00
|
|
|
|
2021-01-29 00:09:20 +01:00
|
|
|
server.routePath('/snapshot/', this._serveSnapshotRoot.bind(this), true);
|
|
|
|
|
server.routePath('/snapshot/service-worker.js', this._serveServiceWorker.bind(this));
|
2021-02-24 20:52:59 +01:00
|
|
|
server.routePath('/snapshot-data', this._serveSnapshot.bind(this));
|
2021-01-29 00:09:20 +01:00
|
|
|
server.routePrefix('/resources/', this._serveResource.bind(this));
|
2021-01-28 04:42:51 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
snapshotRootUrl() {
|
2021-02-25 04:29:16 +01:00
|
|
|
return this._urlPrefix + '/snapshot/';
|
2021-01-28 04:42:51 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
snapshotUrl(pageId: string, snapshotId?: string, timestamp?: number) {
|
2021-01-29 00:09:20 +01:00
|
|
|
// Prefer snapshotId over timestamp.
|
2021-01-28 04:42:51 +01:00
|
|
|
if (snapshotId)
|
2021-02-25 04:29:16 +01:00
|
|
|
return this._urlPrefix + `/snapshot/pageId/${pageId}/snapshotId/${snapshotId}/main`;
|
2021-01-28 04:42:51 +01:00
|
|
|
if (timestamp)
|
2021-02-25 04:29:16 +01:00
|
|
|
return this._urlPrefix + `/snapshot/pageId/${pageId}/timestamp/${timestamp}/main`;
|
2021-01-28 04:42:51 +01:00
|
|
|
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(`
|
|
|
|
|
<style>
|
|
|
|
|
html, body {
|
|
|
|
|
margin: 0;
|
|
|
|
|
padding: 0;
|
|
|
|
|
}
|
|
|
|
|
iframe {
|
|
|
|
|
position: absolute;
|
|
|
|
|
top: 0;
|
|
|
|
|
left: 0;
|
|
|
|
|
width: 100%;
|
|
|
|
|
height: 100%;
|
|
|
|
|
border: none;
|
|
|
|
|
}
|
|
|
|
|
</style>
|
|
|
|
|
<body>
|
|
|
|
|
<script>
|
2021-01-29 00:09:20 +01:00
|
|
|
navigator.serviceWorker.register('./service-worker.js');
|
|
|
|
|
|
|
|
|
|
let showPromise = Promise.resolve();
|
|
|
|
|
if (!navigator.serviceWorker.controller)
|
|
|
|
|
showPromise = new Promise(resolve => navigator.serviceWorker.oncontrollerchange = resolve);
|
|
|
|
|
|
2021-01-28 04:42:51 +01:00
|
|
|
let current = document.createElement('iframe');
|
|
|
|
|
document.body.appendChild(current);
|
|
|
|
|
let next = document.createElement('iframe');
|
|
|
|
|
document.body.appendChild(next);
|
|
|
|
|
next.style.visibility = 'hidden';
|
2021-02-04 15:24:53 +01:00
|
|
|
const onload = () => {
|
|
|
|
|
let temp = current;
|
|
|
|
|
current = next;
|
|
|
|
|
next = temp;
|
|
|
|
|
current.style.visibility = 'visible';
|
|
|
|
|
next.style.visibility = 'hidden';
|
|
|
|
|
};
|
|
|
|
|
current.onload = onload;
|
|
|
|
|
next.onload = onload;
|
2021-01-28 04:42:51 +01:00
|
|
|
|
2021-02-04 15:24:53 +01:00
|
|
|
window.showSnapshot = async url => {
|
|
|
|
|
await showPromise;
|
|
|
|
|
next.src = url;
|
2021-01-28 04:42:51 +01:00
|
|
|
};
|
|
|
|
|
</script>
|
|
|
|
|
</body>
|
|
|
|
|
`);
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
2021-02-24 20:52:59 +01:00
|
|
|
private _serveServiceWorker(request: http.IncomingMessage, response: http.ServerResponse): boolean {
|
|
|
|
|
function serviceWorkerMain(self: any /* ServiceWorkerGlobalScope */) {
|
2021-02-25 03:38:04 +01:00
|
|
|
const snapshotResources = new Map<string, { [key: string]: { resourceId?: string, sha1?: string } }>();
|
2021-01-28 04:42:51 +01:00
|
|
|
|
|
|
|
|
self.addEventListener('install', function(event: any) {
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
self.addEventListener('activate', function(event: any) {
|
|
|
|
|
event.waitUntil(self.clients.claim());
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
function respond404(): Response {
|
|
|
|
|
return new Response(null, { status: 404 });
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function respondNotAvailable(): Response {
|
|
|
|
|
return new Response('<body>Snapshot is not available</body>', { 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<Response> {
|
|
|
|
|
const request = event.request;
|
2021-02-25 04:29:16 +01:00
|
|
|
const pathname = new URL(request.url).pathname;
|
|
|
|
|
if (pathname === '/snapshot/service-worker.js' || pathname === '/snapshot/')
|
|
|
|
|
return fetch(event.request);
|
|
|
|
|
|
|
|
|
|
let snapshotId: string;
|
2021-01-28 04:42:51 +01:00
|
|
|
if (request.mode === 'navigate') {
|
2021-02-25 04:29:16 +01:00
|
|
|
snapshotId = pathname;
|
2021-01-28 04:42:51 +01:00
|
|
|
} else {
|
|
|
|
|
const client = (await self.clients.get(event.clientId))!;
|
2021-02-25 04:29:16 +01:00
|
|
|
snapshotId = new URL(client.url).pathname;
|
2021-01-28 04:42:51 +01:00
|
|
|
}
|
2021-01-29 15:57:57 +01:00
|
|
|
if (request.mode === 'navigate') {
|
2021-02-25 04:29:16 +01:00
|
|
|
const htmlResponse = await fetch(`/snapshot-data?snapshotName=${snapshotId}`);
|
2021-02-25 03:38:04 +01:00
|
|
|
const { html, resources }: SerializedFrameSnapshot = await htmlResponse.json();
|
2021-02-24 20:52:59 +01:00
|
|
|
if (!html)
|
|
|
|
|
return respondNotAvailable();
|
2021-02-25 04:29:16 +01:00
|
|
|
snapshotResources.set(snapshotId, resources);
|
2021-01-29 15:57:57 +01:00
|
|
|
const response = new Response(html, { status: 200, headers: { 'Content-Type': 'text/html' } });
|
|
|
|
|
return response;
|
|
|
|
|
}
|
2021-01-28 04:42:51 +01:00
|
|
|
|
2021-02-25 04:29:16 +01:00
|
|
|
const resources = snapshotResources.get(snapshotId)!;
|
2021-01-30 00:24:38 +01:00
|
|
|
const urlWithoutHash = removeHash(request.url);
|
2021-02-25 03:38:04 +01:00
|
|
|
const resource = resources[urlWithoutHash];
|
2021-01-28 04:42:51 +01:00
|
|
|
if (!resource)
|
|
|
|
|
return respond404();
|
2021-01-29 00:09:20 +01:00
|
|
|
|
2021-02-25 03:38:04 +01:00
|
|
|
const fetchUrl = resource.sha1 ?
|
|
|
|
|
`/resources/${resource.resourceId}/override/${resource.sha1}` :
|
2021-01-30 00:24:38 +01:00
|
|
|
`/resources/${resource.resourceId}`;
|
|
|
|
|
const fetchedResponse = await fetch(fetchUrl);
|
|
|
|
|
const headers = new Headers(fetchedResponse.headers);
|
2021-01-29 00:09:20 +01:00
|
|
|
// 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.
|
2021-02-25 03:38:04 +01:00
|
|
|
if (resource.sha1) {
|
2021-01-30 00:24:38 +01:00
|
|
|
// 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,
|
2021-01-29 00:09:20 +01:00
|
|
|
});
|
2021-01-30 00:24:38 +01:00
|
|
|
return response;
|
2021-01-28 04:42:51 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
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');
|
2021-01-29 00:09:20 +01:00
|
|
|
response.end(`(${serviceWorkerMain.toString()})(self)`);
|
2021-01-28 04:42:51 +01:00
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
2021-02-24 20:52:59 +01:00
|
|
|
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');
|
2021-02-24 23:22:34 +01:00
|
|
|
const parsed: any = querystring.parse(request.url!.substring(request.url!.indexOf('?') + 1));
|
2021-02-25 04:29:16 +01:00
|
|
|
const snapshot = this._snapshotStorage.snapshotByName(parsed.snapshotName);
|
2021-02-24 23:22:34 +01:00
|
|
|
const snapshotData: any = snapshot ? snapshot.serialize() : { html: '' };
|
2021-02-24 20:52:59 +01:00
|
|
|
response.end(JSON.stringify(snapshotData));
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
2021-01-29 00:09:20 +01:00
|
|
|
private _serveResource(request: http.IncomingMessage, response: http.ServerResponse): boolean {
|
2021-01-28 04:42:51 +01:00
|
|
|
if (!this._resourcesDir)
|
|
|
|
|
return false;
|
|
|
|
|
|
2021-01-29 00:09:20 +01:00
|
|
|
// - /resources/<resourceId>
|
|
|
|
|
// - /resources/<resourceId>/override/<overrideSha1>
|
|
|
|
|
const parts = request.url!.split('/');
|
2021-01-28 04:42:51 +01:00
|
|
|
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;
|
|
|
|
|
}
|
|
|
|
|
|
2021-02-25 04:29:16 +01:00
|
|
|
const resource = this._snapshotStorage.resourceById(resourceId);
|
2021-01-28 04:42:51 +01:00
|
|
|
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);
|
2021-02-04 15:24:53 +01:00
|
|
|
response.setHeader('Cache-Control', 'public, max-age=31536000');
|
2021-01-28 04:42:51 +01:00
|
|
|
response.end(content);
|
|
|
|
|
return true;
|
|
|
|
|
} catch (e) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
