puppeteer/utils/ChromiumDownloader.js

245 lines
7.4 KiB
JavaScript
Raw Normal View History

/**
* 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.
*/
2017-08-02 19:06:47 +00:00
const os = require('os');
const https = require('https');
const fs = require('fs');
const path = require('path');
const extract = require('extract-zip');
const util = require('util');
const URL = require('url');
const removeRecursive = require('rimraf');
// @ts-ignore
const ProxyAgent = require('https-proxy-agent');
// @ts-ignore
const getProxyForUrl = require('proxy-from-env').getProxyForUrl;
2017-08-02 19:06:47 +00:00
const DOWNLOADS_FOLDER = path.join(__dirname, '..', '.local-chromium');
const DEFAULT_DOWNLOAD_HOST = 'https://storage.googleapis.com';
2017-08-02 19:06:47 +00:00
const downloadURLs = {
linux: '%s/chromium-browser-snapshots/Linux_x64/%d/chrome-linux.zip',
mac: '%s/chromium-browser-snapshots/Mac/%d/chrome-mac.zip',
win32: '%s/chromium-browser-snapshots/Win/%d/chrome-win32.zip',
win64: '%s/chromium-browser-snapshots/Win_x64/%d/chrome-win32.zip',
};
module.exports = {
2017-06-21 20:51:06 +00:00
/**
* @return {!Array<string>}
*/
2017-06-21 20:51:06 +00:00
supportedPlatforms: function() {
return Object.keys(downloadURLs);
},
2017-06-21 20:51:06 +00:00
/**
* @return {string}
*/
2017-06-21 20:51:06 +00:00
currentPlatform: function() {
const platform = os.platform();
2017-06-21 20:51:06 +00:00
if (platform === 'darwin')
return 'mac';
if (platform === 'linux')
return 'linux';
if (platform === 'win32')
return os.arch() === 'x64' ? 'win64' : 'win32';
return '';
},
2017-06-21 20:51:06 +00:00
/**
* @param {string} platform
* @param {string} revision
* @return {!Promise<boolean>}
*/
2017-06-21 20:51:06 +00:00
canDownloadRevision: function(platform, revision) {
console.assert(downloadURLs[platform], 'Unknown platform: ' + platform);
const options = requestOptions(util.format(downloadURLs[platform], DEFAULT_DOWNLOAD_HOST, revision), 'HEAD');
let resolve;
const promise = new Promise(x => resolve = x);
const request = https.request(options, response => {
2017-06-21 20:51:06 +00:00
resolve(response.statusCode === 200);
});
request.on('error', error => {
console.error(error);
resolve(false);
});
request.end();
return promise;
},
2017-06-21 20:51:06 +00:00
/**
* @param {string} platform
* @param {string} revision
* @param {string} [downloadHost=DEFAULT_DOWNLOAD_HOST]
* @param {?function(number, number)} progressCallback
* @return {!Promise}
*/
downloadRevision: function(platform, revision, downloadHost = DEFAULT_DOWNLOAD_HOST, progressCallback) {
let url = downloadURLs[platform];
2017-06-21 20:51:06 +00:00
console.assert(url, `Unsupported platform: ${platform}`);
url = util.format(url, downloadHost, revision);
const zipPath = path.join(DOWNLOADS_FOLDER, `download-${platform}-${revision}.zip`);
const folderPath = getFolderPath(platform, revision);
2017-06-21 20:51:06 +00:00
if (fs.existsSync(folderPath))
return;
if (!fs.existsSync(DOWNLOADS_FOLDER))
fs.mkdirSync(DOWNLOADS_FOLDER);
return downloadFile(url, zipPath, progressCallback)
.then(() => extractZip(zipPath, folderPath))
.catch(err => err)
.then(err => {
if (fs.existsSync(zipPath))
fs.unlinkSync(zipPath);
if (err)
throw err;
});
2017-06-21 20:51:06 +00:00
},
2017-06-21 20:51:06 +00:00
/**
* @return {!Array<!{platform:string, revision: string}>}
*/
downloadedRevisions: function() {
if (!fs.existsSync(DOWNLOADS_FOLDER))
return [];
const fileNames = fs.readdirSync(DOWNLOADS_FOLDER);
return fileNames.map(fileName => parseFolderPath(fileName)).filter(revision => !!revision);
},
/**
* @param {string} platform
* @param {string} revision
* @return {!Promise}
*/
removeRevision: function(platform, revision) {
console.assert(downloadURLs[platform], `Unsupported platform: ${platform}`);
const folderPath = getFolderPath(platform, revision);
console.assert(fs.existsSync(folderPath));
return new Promise(fulfill => removeRecursive(folderPath, fulfill));
},
/**
* @param {string} platform
* @param {string} revision
* @return {!{folderPath: string, executablePath: string, downloaded: boolean}}
*/
2017-06-21 20:51:06 +00:00
revisionInfo: function(platform, revision) {
console.assert(downloadURLs[platform], `Unsupported platform: ${platform}`);
const folderPath = getFolderPath(platform, revision);
let executablePath = '';
2017-06-21 20:51:06 +00:00
if (platform === 'mac')
executablePath = path.join(folderPath, 'chrome-mac', 'Chromium.app', 'Contents', 'MacOS', 'Chromium');
else if (platform === 'linux')
executablePath = path.join(folderPath, 'chrome-linux', 'chrome');
else if (platform === 'win32' || platform === 'win64')
executablePath = path.join(folderPath, 'chrome-win32', 'chrome.exe');
else
throw 'Unsupported platform: ' + platform;
2017-06-21 20:51:06 +00:00
return {
executablePath,
folderPath,
downloaded: fs.existsSync(folderPath)
2017-06-21 20:51:06 +00:00
};
},
};
/**
* @param {string} platform
* @param {string} revision
* @return {string}
*/
function getFolderPath(platform, revision) {
return path.join(DOWNLOADS_FOLDER, platform + '-' + revision);
}
/**
* @param {string} folderPath
* @return {?{platform: string, revision: string}}
*/
function parseFolderPath(folderPath) {
const name = path.basename(folderPath);
const splits = name.split('-');
if (splits.length !== 2)
return null;
const [platform, revision] = splits;
if (!downloadURLs[platform])
return null;
return {platform, revision};
}
/**
* @param {string} url
* @param {string} destinationPath
* @param {?function(number, number)} progressCallback
* @return {!Promise}
*/
function downloadFile(url, destinationPath, progressCallback) {
let fulfill, reject;
const promise = new Promise((x, y) => { fulfill = x; reject = y; });
const options = requestOptions(url);
const request = https.get(options, response => {
2017-06-21 20:51:06 +00:00
if (response.statusCode !== 200) {
const error = new Error(`Download failed: server returned code ${response.statusCode}. URL: ${url}`);
2017-06-21 20:51:06 +00:00
// consume response data to free up memory
response.resume();
reject(error);
return;
}
const file = fs.createWriteStream(destinationPath);
2017-06-21 20:51:06 +00:00
file.on('finish', () => fulfill());
file.on('error', error => reject(error));
response.pipe(file);
const totalBytes = parseInt(/** @type {string} */ (response.headers['content-length']), 10);
2017-06-21 20:51:06 +00:00
if (progressCallback)
response.on('data', onData.bind(null, totalBytes));
});
request.on('error', error => reject(error));
return promise;
function onData(totalBytes, chunk) {
progressCallback(totalBytes, chunk.length);
}
}
/**
* @param {string} zipPath
* @param {string} folderPath
* @return {!Promise<?Error>}
*/
function extractZip(zipPath, folderPath) {
2017-06-21 20:51:06 +00:00
return new Promise(fulfill => extract(zipPath, {dir: folderPath}, fulfill));
}
function requestOptions(url, method = 'GET') {
/** @type {Object} */
const result = URL.parse(url);
result.method = method;
const proxyURL = getProxyForUrl(url);
if (proxyURL) {
/** @type {Object} */
const parsedProxyURL = URL.parse(proxyURL);
parsedProxyURL.secureProxy = parsedProxyURL.protocol === 'https:';
result.agent = new ProxyAgent(parsedProxyURL);
}
return result;
}