1f5e333f00
* chore: Don't store revisions in `package.json` It's quite messy to have to require the `package.json` file in multiple places purely to find out what revision of a given browser we want to use. We can also achieve better type safety by placing it in an actual source file. This commit makes that change and also tidies up our reliance on `package.json` within the source code generally; we now only use it to find the location of the Puppeteer root such that we know where to install downloaded browsers to. To avoid using `package.json` to parse the name of the module, we also now explicitly have an entry point for the Puppeteer module and the Puppeter Core module. This will make it easier in the future to ship less code as part of core (e.g. core never needs to download a browser, so why ship that code?). Core can also then not have any revisions based info contained in it. The test install script has also been updated to ensure that puppeteer-core can be installed correctly too. Finally, the `install` script has been moved to TypeScript for nicer typechecking and safety. The functionality of it has not changed.
87 lines
2.7 KiB
JavaScript
87 lines
2.7 KiB
JavaScript
/**
|
|
* Copyright 2017 Google Inc. All rights reserved.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
/**
|
|
* This file is part of public API.
|
|
*
|
|
* By default, the `puppeteer` package runs this script during the installation
|
|
* process unless one of the env flags is provided.
|
|
* `puppeteer-core` package doesn't include this step at all. However, it's
|
|
* still possible to install a supported browser using this script when
|
|
* necessary.
|
|
*/
|
|
|
|
const compileTypeScriptIfRequired = require('./typescript-if-required');
|
|
|
|
async function download() {
|
|
await compileTypeScriptIfRequired();
|
|
// need to ensure TS is compiled before loading the installer
|
|
const { downloadBrowser, logPolitely } = require('./lib/cjs/install');
|
|
|
|
if (process.env.PUPPETEER_SKIP_DOWNLOAD) {
|
|
logPolitely(
|
|
'**INFO** Skipping browser download. "PUPPETEER_SKIP_DOWNLOAD" environment variable was found.'
|
|
);
|
|
return;
|
|
}
|
|
if (
|
|
process.env.NPM_CONFIG_PUPPETEER_SKIP_DOWNLOAD ||
|
|
process.env.npm_config_puppeteer_skip_download
|
|
) {
|
|
logPolitely(
|
|
'**INFO** Skipping browser download. "PUPPETEER_SKIP_DOWNLOAD" was set in npm config.'
|
|
);
|
|
return;
|
|
}
|
|
if (
|
|
process.env.NPM_PACKAGE_CONFIG_PUPPETEER_SKIP_DOWNLOAD ||
|
|
process.env.npm_package_config_puppeteer_skip_download
|
|
) {
|
|
logPolitely(
|
|
'**INFO** Skipping browser download. "PUPPETEER_SKIP_DOWNLOAD" was set in project config.'
|
|
);
|
|
return;
|
|
}
|
|
if (process.env.PUPPETEER_SKIP_CHROMIUM_DOWNLOAD) {
|
|
logPolitely(
|
|
'**INFO** Skipping browser download. "PUPPETEER_SKIP_CHROMIUM_DOWNLOAD" environment variable was found.'
|
|
);
|
|
return;
|
|
}
|
|
if (
|
|
process.env.NPM_CONFIG_PUPPETEER_SKIP_CHROMIUM_DOWNLOAD ||
|
|
process.env.npm_config_puppeteer_skip_chromium_download
|
|
) {
|
|
logPolitely(
|
|
'**INFO** Skipping browser download. "PUPPETEER_SKIP_CHROMIUM_DOWNLOAD" was set in npm config.'
|
|
);
|
|
return;
|
|
}
|
|
if (
|
|
process.env.NPM_PACKAGE_CONFIG_PUPPETEER_SKIP_CHROMIUM_DOWNLOAD ||
|
|
process.env.npm_package_config_puppeteer_skip_chromium_download
|
|
) {
|
|
logPolitely(
|
|
'**INFO** Skipping browser download. "PUPPETEER_SKIP_CHROMIUM_DOWNLOAD" was set in project config.'
|
|
);
|
|
return;
|
|
}
|
|
|
|
downloadBrowser();
|
|
}
|
|
|
|
download();
|