feat(firefox): cache firefox pre-compiled scripts (#2087)

This commit is contained in:
Pavel Feldman 2020-05-04 09:34:59 -07:00 committed by GitHub
parent 08d713973e
commit 1f0217986e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 46 additions and 6 deletions

View File

@ -22,6 +22,7 @@ import * as util from 'util';
import * as removeFolder from 'rimraf';
import * as browserPaths from '../install/browserPaths';
import * as browserFetcher from '../install/browserFetcher';
import { Playwright } from '../server/playwright';
const fsMkdirAsync = util.promisify(fs.mkdir.bind(fs));
const fsReaddirAsync = util.promisify(fs.readdir.bind(fs));
@ -40,10 +41,10 @@ export async function installBrowsersWithProgressBar(packagePath: string) {
}
await fsMkdirAsync(linksDir, { recursive: true });
await fsWriteFileAsync(path.join(linksDir, sha1(packagePath)), packagePath);
await validateCache(browsersPath, linksDir);
await validateCache(packagePath, browsersPath, linksDir);
}
async function validateCache(browsersPath: string, linksDir: string) {
async function validateCache(packagePath: string, browsersPath: string, linksDir: string) {
// 1. Collect unused downloads and package descriptors.
const allBrowsers: browserPaths.BrowserDescriptor[] = [];
for (const fileName of await fsReaddirAsync(linksDir)) {
@ -73,10 +74,24 @@ async function validateCache(browsersPath: string, linksDir: string) {
// 3. Install missing browsers.
for (const browser of allBrowsers) {
const browserPath = browserPaths.browserDirectory(browsersPath, browser);
await browserFetcher.downloadBrowserWithProgressBar(browserPath, browser);
if (await browserFetcher.downloadBrowserWithProgressBar(browserPath, browser))
await installBrowser(packagePath, browserPath, browser);
}
}
async function installBrowser(packagePath: string, browserPath: string, browser: browserPaths.BrowserDescriptor) {
if (browser.name !== 'firefox')
return;
const firefox = new Playwright(packagePath, [browser]).firefox!;
const userDataDir = path.join(browserPath, 'cached-profile');
await fsMkdirAsync(userDataDir, { recursive: true });
logPolitely('Pre-compiling Firefox scripts at ' + userDataDir);
const browserContext = await firefox.launchPersistentContext(userDataDir);
const page = await browserContext.newPage();
await page.goto('data:text/html,<html>Hello world</html>');
await browserContext.close();
}
function sha1(data: string): string {
const sum = crypto.createHash('sha1');
sum.update(data);

View File

@ -54,13 +54,14 @@ export interface BrowserType<Browser> {
export abstract class AbstractBrowserType<Browser> implements BrowserType<Browser> {
private _name: string;
readonly _browserPath: string;
private _executablePath: string | undefined;
constructor(packagePath: string, browser: browserPaths.BrowserDescriptor) {
this._name = browser.name;
const browsersPath = browserPaths.browsersPath(packagePath);
const browserPath = browserPaths.browserDirectory(browsersPath, browser);
this._executablePath = browserPaths.executablePath(browserPath, browser);
this._browserPath = browserPaths.browserDirectory(browsersPath, browser);
this._executablePath = browserPaths.executablePath(this._browserPath, browser);
}
executablePath(): string {

View File

@ -91,7 +91,7 @@ export class Firefox extends AbstractBrowserType<FFBrowser> {
let temporaryProfileDir = null;
if (!userDataDir) {
userDataDir = await mkdtempAsync(path.join(os.tmpdir(), 'playwright_dev_firefox_profile-'));
userDataDir = await this._createTemporaryProfile();
temporaryProfileDir = userDataDir;
}
@ -189,6 +189,15 @@ export class Firefox extends AbstractBrowserType<FFBrowser> {
return firefoxArguments;
}
async _createTemporaryProfile(): Promise<string> {
const userDataDir = await mkdtempAsync(path.join(os.tmpdir(), 'playwright_dev_firefox_profile-'));
const cachedProfileDir = path.join(this._browserPath, 'cached-profile');
const files = fs.readdirSync(cachedProfileDir);
for (const file of files)
copyRecursiveSync(path.join(cachedProfileDir, file), userDataDir);
return userDataDir;
}
}
function wrapTransportWithWebSocket(transport: ConnectionTransport, logger: InnerLogger, port: number): WebSocketWrapper {
@ -319,3 +328,18 @@ function wrapTransportWithWebSocket(transport: ConnectionTransport, logger: Inne
return new WebSocketWrapper(wsEndpoint,
[pendingBrowserContextCreations, pendingBrowserContextDeletions, browserContextIds, sessionToSocket, sockets]);
}
function copyRecursiveSync(source: string, targetFolder: string) {
const target = path.join(targetFolder, path.basename(source));
const stat = fs.lstatSync(source);
if (stat.isFile()) {
fs.copyFileSync(source, target);
return;
}
if (stat.isDirectory()) {
fs.mkdirSync(target, { recursive: true });
const files = fs.readdirSync(source);
for (const file of files)
copyRecursiveSync(path.join(source, file), target);
}
}