blob: 0af8720d01865a3beb32897f628944162588a364 [file] [log] [blame]
/**
* @license
* Copyright 2023 Google Inc.
* SPDX-License-Identifier: Apache-2.0
*/
import fs from 'fs';
import os from 'os';
import path from 'path';
import { Browser, executablePathByBrowser, } from './browser-data/browser-data.js';
import { detectBrowserPlatform } from './detectPlatform.js';
/**
* @public
*/
export class InstalledBrowser {
browser;
buildId;
platform;
executablePath;
#cache;
/**
* @internal
*/
constructor(cache, browser, buildId, platform) {
this.#cache = cache;
this.browser = browser;
this.buildId = buildId;
this.platform = platform;
this.executablePath = cache.computeExecutablePath({
browser,
buildId,
platform,
});
}
/**
* Path to the root of the installation folder. Use
* {@link computeExecutablePath} to get the path to the executable binary.
*/
get path() {
return this.#cache.installationDir(this.browser, this.platform, this.buildId);
}
}
/**
* The cache used by Puppeteer relies on the following structure:
*
* - rootDir
* -- <browser1> | browserRoot(browser1)
* ---- <platform>-<buildId> | installationDir()
* ------ the browser-platform-buildId
* ------ specific structure.
* -- <browser2> | browserRoot(browser2)
* ---- <platform>-<buildId> | installationDir()
* ------ the browser-platform-buildId
* ------ specific structure.
* @internal
*/
export class Cache {
#rootDir;
constructor(rootDir) {
this.#rootDir = rootDir;
}
/**
* @internal
*/
get rootDir() {
return this.#rootDir;
}
browserRoot(browser) {
return path.join(this.#rootDir, browser);
}
installationDir(browser, platform, buildId) {
return path.join(this.browserRoot(browser), `${platform}-${buildId}`);
}
clear() {
fs.rmSync(this.#rootDir, {
force: true,
recursive: true,
maxRetries: 10,
retryDelay: 500,
});
}
uninstall(browser, platform, buildId) {
fs.rmSync(this.installationDir(browser, platform, buildId), {
force: true,
recursive: true,
maxRetries: 10,
retryDelay: 500,
});
}
getInstalledBrowsers() {
if (!fs.existsSync(this.#rootDir)) {
return [];
}
const types = fs.readdirSync(this.#rootDir);
const browsers = types.filter((t) => {
return Object.values(Browser).includes(t);
});
return browsers.flatMap(browser => {
const files = fs.readdirSync(this.browserRoot(browser));
return files
.map(file => {
const result = parseFolderPath(path.join(this.browserRoot(browser), file));
if (!result) {
return null;
}
return new InstalledBrowser(this, browser, result.buildId, result.platform);
})
.filter((item) => {
return item !== null;
});
});
}
computeExecutablePath(options) {
options.platform ??= detectBrowserPlatform();
if (!options.platform) {
throw new Error(`Cannot download a binary for the provided platform: ${os.platform()} (${os.arch()})`);
}
const installationDir = this.installationDir(options.browser, options.platform, options.buildId);
return path.join(installationDir, executablePathByBrowser[options.browser](options.platform, options.buildId));
}
}
function parseFolderPath(folderPath) {
const name = path.basename(folderPath);
const splits = name.split('-');
if (splits.length !== 2) {
return;
}
const [platform, buildId] = splits;
if (!buildId || !platform) {
return;
}
return { platform, buildId };
}
//# sourceMappingURL=Cache.js.map