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

feat: support atomic browser installation - attempt 2 (#3008)

Browse source 
Currently, Ctrl-C while extracting browser might yield users in
a bad place.

This patch adds a marker file inside browser directory to make
sure that browser extraction completed.

Note: this was already attempted in #2489, but was eventually
reverted in #2534.

References #2660
This commit is contained in:
Andrey Lushnikov 2020-07-17 16:39:27 -07:00 committed by GitHub
parent a75835e077
commit ef2a6522b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/install/browserPaths.ts
View file

@ -118,6 +118,10 @@ export function browserDirectory(browsersPath: string, browser: BrowserDescripto
return path.join(browsersPath, `${browser.name}-${browser.revision}`); return path.join(browsersPath, `${browser.name}-${browser.revision}`);
} }
export function markerFilePath(browsersPath: string, browser: BrowserDescriptor): string {
return path.join(browserDirectory(browsersPath, browser), 'INSTALLATION_COMPLETE');
}
export function isBrowserDirectory(browserPath: string): boolean { export function isBrowserDirectory(browserPath: string): boolean {
const baseName = path.basename(browserPath); const baseName = path.basename(browserPath);
return baseName.startsWith('chromium-') || baseName.startsWith('firefox-') || baseName.startsWith('webkit-'); return baseName.startsWith('chromium-') || baseName.startsWith('firefox-') || baseName.startsWith('webkit-');

21
src/install/installer.ts
View file

@ -26,6 +26,7 @@ import * as browserFetcher from './browserFetcher';
const fsMkdirAsync = util.promisify(fs.mkdir.bind(fs)); const fsMkdirAsync = util.promisify(fs.mkdir.bind(fs));
const fsReaddirAsync = util.promisify(fs.readdir.bind(fs)); const fsReaddirAsync = util.promisify(fs.readdir.bind(fs));
const fsReadFileAsync = util.promisify(fs.readFile.bind(fs)); const fsReadFileAsync = util.promisify(fs.readFile.bind(fs));
const fsExistsAsync = (filePath: string) => fsReadFileAsync(filePath).then(() => true).catch(e => false);
const fsUnlinkAsync = util.promisify(fs.unlink.bind(fs)); const fsUnlinkAsync = util.promisify(fs.unlink.bind(fs));
const fsWriteFileAsync = util.promisify(fs.writeFile.bind(fs)); const fsWriteFileAsync = util.promisify(fs.writeFile.bind(fs));
const removeFolderAsync = util.promisify(removeFolder); const removeFolderAsync = util.promisify(removeFolder);
@ -44,15 +45,24 @@ export async function installBrowsersWithProgressBar(packagePath: string) {
} }
async function validateCache(packagePath: string, browsersPath: string, linksDir: string) { async function validateCache(packagePath: string, browsersPath: string, linksDir: string) {
// 1. Collect unused downloads and package descriptors. // 1. Collect used downloads and package descriptors.
const allBrowsers: browserPaths.BrowserDescriptor[] = []; const usedBrowserPaths: Set<string> = new Set();
for (const fileName of await fsReaddirAsync(linksDir)) { for (const fileName of await fsReaddirAsync(linksDir)) {
const linkPath = path.join(linksDir, fileName); const linkPath = path.join(linksDir, fileName);
let linkTarget = ''; let linkTarget = '';
try { try {
linkTarget = (await fsReadFileAsync(linkPath)).toString(); linkTarget = (await fsReadFileAsync(linkPath)).toString();
const browsers = JSON.parse((await fsReadFileAsync(path.join(linkTarget, 'browsers.json'))).toString())['browsers']; const browsers = JSON.parse((await fsReadFileAsync(path.join(linkTarget, 'browsers.json'))).toString())['browsers'];
allBrowsers.push(...browsers); for (const browser of browsers) {
const usedBrowserPath = browserPaths.browserDirectory(browsersPath, browser);
const browserRevision = parseInt(browser.revision, 10);
// Old browser installations don't have marker file.
const shouldHaveMarkerFile = (browser.name === 'chromium' && browserRevision >= 786218) ||
(browser.name === 'firefox' && browserRevision >= 1128) ||
(browser.name === 'webkit' && browserRevision >= 1307);
if (!shouldHaveMarkerFile || (await fsExistsAsync(browserPaths.markerFilePath(browsersPath, browser))))
usedBrowserPaths.add(usedBrowserPath);
}
} catch (e) { } catch (e) {
if (linkTarget) if (linkTarget)
logPolitely('Failed to process descriptor at ' + linkTarget); logPolitely('Failed to process descriptor at ' + linkTarget);
@ -64,8 +74,8 @@ async function validateCache(packagePath: string, browsersPath: string, linksDir
let downloadedBrowsers = (await fsReaddirAsync(browsersPath)).map(file => path.join(browsersPath, file)); let downloadedBrowsers = (await fsReaddirAsync(browsersPath)).map(file => path.join(browsersPath, file));
downloadedBrowsers = downloadedBrowsers.filter(file => browserPaths.isBrowserDirectory(file)); downloadedBrowsers = downloadedBrowsers.filter(file => browserPaths.isBrowserDirectory(file));
const directories = new Set<string>(downloadedBrowsers); const directories = new Set<string>(downloadedBrowsers);
for (const browser of allBrowsers) for (const browserPath of usedBrowserPaths)
directories.delete(browserPaths.browserDirectory(browsersPath, browser)); directories.delete(browserPath);
for (const directory of directories) { for (const directory of directories) {
logPolitely('Removing unused browser at ' + directory); logPolitely('Removing unused browser at ' + directory);
await removeFolderAsync(directory).catch(e => {}); await removeFolderAsync(directory).catch(e => {});
@ -76,6 +86,7 @@ async function validateCache(packagePath: string, browsersPath: string, linksDir
for (const browser of myBrowsers) { for (const browser of myBrowsers) {
const browserPath = browserPaths.browserDirectory(browsersPath, browser); const browserPath = browserPaths.browserDirectory(browsersPath, browser);
await browserFetcher.downloadBrowserWithProgressBar(browserPath, browser); await browserFetcher.downloadBrowserWithProgressBar(browserPath, browser);
await fsWriteFileAsync(browserPaths.markerFilePath(browsersPath, browser), '');
} }
} }