Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Fix installing from GitHub URL #5669

Merged
merged 2 commits into from Apr 17, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
44 changes: 4 additions & 40 deletions install.js
Expand Up @@ -14,45 +14,6 @@
* limitations under the License.
*/

const fs = require('fs');
const path = require('path');
const child_process = require('child_process');
const {promisify} = require('util');

const fsAccess = promisify(fs.access);
const exec = promisify(child_process.exec);

const fileExists = async filePath => fsAccess(filePath).then(() => true).catch(() => false);

/*
* Now Puppeteer is built with TypeScript, we need to ensure that
* locally we have the generated output before trying to install.
*
* For users installing puppeteer this is fine, they will have the
* generated lib/ directory as we ship it when we publish to npm.
*
* However, if you're cloning the repo to contribute, you won't have the
* generated lib/ directory so this script checks if we need to run
* TypeScript first to ensure the output exists and is in the right
* place.
*/
async function compileTypeScript() {
return exec('npm run tsc').catch(err => {
console.error('Error running TypeScript', err);
process.exit(1);
});
}

async function ensureLibDirectoryExists() {
const libPath = path.join(__dirname, 'lib');
const libExists = await fileExists(libPath);
if (libExists) return;

logPolitely('Compiling TypeScript before install...');
await compileTypeScript();
}


/**
* This file is part of public API.
*
Expand All @@ -62,13 +23,16 @@ async function ensureLibDirectoryExists() {
* still possible to install a supported browser using this script when
* necessary.
*/

const compileTypeScriptIfRequired = require('./typescript-if-required');

const supportedProducts = {
'chrome': 'Chromium',
'firefox': 'Firefox Nightly'
};

async function download() {
await ensureLibDirectoryExists();
await compileTypeScriptIfRequired();

const downloadHost = process.env.PUPPETEER_DOWNLOAD_HOST || process.env.npm_config_puppeteer_download_host || process.env.npm_package_config_puppeteer_download_host;
const puppeteer = require('./index');
Expand Down
1 change: 1 addition & 0 deletions package.json
Expand Up @@ -18,6 +18,7 @@
"debug-unit": "node --inspect-brk test/test.js",
"test-doclint": "mocha --config mocha-config/doclint-tests.js",
"test": "npm run tsc && npm run lint --silent && npm run coverage && npm run test-doclint && npm run test-types",
"prepare": "node typescript-if-required.js",
"prepublishOnly": "npm run tsc",
"dev-install": "npm run tsc && node install.js",
"install": "node install.js",
Expand Down
61 changes: 61 additions & 0 deletions typescript-if-required.js
@@ -0,0 +1,61 @@
/**
* Copyright 2020 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.
*/

const child_process = require('child_process');
const path = require('path');
const fs = require('fs');
const {promisify} = require('util');

const exec = promisify(child_process.exec);
const fsAccess = promisify(fs.access);

const fileExists = async filePath => fsAccess(filePath).then(() => true).catch(() => false);
/*

* Now Puppeteer is built with TypeScript, we need to ensure that
* locally we have the generated output before trying to install.
*
* For users installing puppeteer this is fine, they will have the
* generated lib/ directory as we ship it when we publish to npm.
*
* However, if you're cloning the repo to contribute, you won't have the
* generated lib/ directory so this script checks if we need to run
* TypeScript first to ensure the output exists and is in the right
* place.
*/
async function compileTypeScript() {
return exec('npm run tsc').catch(err => {
console.error('Error running TypeScript', err);
process.exit(1);
});
}

async function compileTypeScriptIfRequired() {
const libPath = path.join(__dirname, 'lib');
const libExists = await fileExists(libPath);
if (libExists) return;

console.log('Puppeteer:', 'Compiling TypeScript...');
await compileTypeScript();
}

// It's being run as node typescript-if-required.js, not require('..')
if (require.main === module)
compileTypeScriptIfRequired();


mathiasbynens marked this conversation as resolved.
Show resolved Hide resolved
module.exports = compileTypeScriptIfRequired;