123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183 |
- /**
- * @license
- * Copyright 2023 Google Inc.
- * SPDX-License-Identifier: Apache-2.0
- */
- import fs from 'fs';
- import os from 'os';
- import path from 'path';
- import debug from 'debug';
- import { Browser, executablePathByBrowser, getVersionComparator, } from './browser-data/browser-data.js';
- import { detectBrowserPlatform } from './detectPlatform.js';
- const debugCache = debug('puppeteer:browsers:cache');
- /**
- * @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);
- }
- readMetadata() {
- return this.#cache.readMetadata(this.browser);
- }
- writeMetadata(metadata) {
- this.#cache.writeMetadata(this.browser, metadata);
- }
- }
- /**
- * 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);
- }
- metadataFile(browser) {
- return path.join(this.browserRoot(browser), '.metadata');
- }
- readMetadata(browser) {
- const metatadaPath = this.metadataFile(browser);
- if (!fs.existsSync(metatadaPath)) {
- return { aliases: {} };
- }
- // TODO: add type-safe parsing.
- const data = JSON.parse(fs.readFileSync(metatadaPath, 'utf8'));
- if (typeof data !== 'object') {
- throw new Error('.metadata is not an object');
- }
- return data;
- }
- writeMetadata(browser, metadata) {
- const metatadaPath = this.metadataFile(browser);
- fs.mkdirSync(path.dirname(metatadaPath), { recursive: true });
- fs.writeFileSync(metatadaPath, JSON.stringify(metadata, null, 2));
- }
- resolveAlias(browser, alias) {
- const metadata = this.readMetadata(browser);
- if (alias === 'latest') {
- return Object.values(metadata.aliases || {})
- .sort(getVersionComparator(browser))
- .at(-1);
- }
- return metadata.aliases[alias];
- }
- 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) {
- const metadata = this.readMetadata(browser);
- for (const alias of Object.keys(metadata.aliases)) {
- if (metadata.aliases[alias] === buildId) {
- delete metadata.aliases[alias];
- }
- }
- 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()})`);
- }
- try {
- options.buildId =
- this.resolveAlias(options.browser, options.buildId) ?? options.buildId;
- }
- catch {
- debugCache('could not read .metadata file for the browser');
- }
- 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
|