browser-webdriver-downloader 2.0.6 → 2.2.0

package/README.md

@@ -7,3 +7,7 @@ Install and wrap msedgedriver in Node.js
 Setting `EDGEDRIVER_VERSION` will prevent it from downloading latest, for example `EDGEDRIVER_VERSION=102.0.1245.33 npm install`.
 
 Setting `DETECT_EDGEDRIVER_VERSION=true` will match your installed Edge version.
+
+Setting `SKIP_EDGEDRIVER_DOWNLOAD=true` will skip the download.
+
+Any supported proxy config from [proxy-from-env](https://www.npmjs.com/package/proxy-from-env) will work.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browser-webdriver-downloader",
-  "version": "2.0.6",
+  "version": "2.2.0",
   "description": "Install and wrap msedgedriver in Node.js",
   "bin": {
     "msedgedriver": "bin/msedgedriver.js"
@@ -47,6 +47,8 @@
     "find-edge-version": "0.1.1",
     "fs-extra": "^11.0.0",
     "got": "^12.0.0",
+    "https-proxy-agent": "^7.0.2",
+    "proxy-from-env": "^1.1.0",
     "tmp": "0.2.1",
     "yn": "^5.0.0"
   },

package/src/index.js

@@ -8,11 +8,14 @@ const pipeline = promisify(require('stream').pipeline);
 const os = require('os');
 const { createTmpDir } = require('../src/tmp');
 const execa = require('execa');
+const { getProxyForUrl } = require('proxy-from-env');
+const { HttpsProxyAgent } = require('https-proxy-agent');
 
 const platform = os.platform();
 const arch = os.arch();
 
 const downloadHost = 'https://msedgedriver.azureedge.net';
+const latestVersionUrl = `${downloadHost}/LATEST_STABLE`;
 
 const driversRoot = path.join(__dirname, '../bin');
 
@@ -117,10 +120,12 @@ async function getDetectedDriverVersion() {
 }
 
 async function getLatestDriverVersion() {
+  let options = getGotOptions(latestVersionUrl);
+
   // eslint-disable-next-line node/no-missing-import
   const { got } = await import('got');
 
-  let { body } = await got.get(`${downloadHost}/LATEST_STABLE`);
+  let { body } = await got.get(latestVersionUrl, options);
 
   // For example: '��102.0.1245.33\r\n'
   let version = body.replace(/[^\d.]/g, '');
@@ -140,7 +145,23 @@ function getDriverPath(driverName = getDriverName()) {
   return path.resolve(driversRoot, driverName);
 }
 
+async function shouldSkipDownload() {
+  const { default: yn } = await import('yn');
+
+  let shouldSkipDownload = yn(process.env.SKIP_EDGEDRIVER_DOWNLOAD);
+
+  if (shouldSkipDownload) {
+    console.log(`SKIP_EDGEDRIVER_DOWNLOAD=${process.env.SKIP_EDGEDRIVER_DOWNLOAD}, skipping download`);
+  }
+
+  return shouldSkipDownload;
+}
+
 async function install() {
+  if (await shouldSkipDownload()) {
+    return;
+  }
+
   let version = await getDriverVersion();
 
   let driverName = getDriverName();
@@ -192,13 +213,15 @@ async function download({ tmpPath, version }) {
 
   let downloadUrl = `${downloadHost}/${version}/${downloadName}`;
 
+  let options = getGotOptions(downloadUrl);
+
   console.log(`Downloading ${downloadUrl}...`);
 
   // eslint-disable-next-line node/no-missing-import
   const { got } = await import('got');
 
   await pipeline(
-    got.stream(downloadUrl),
+    got.stream(downloadUrl, options),
     fs.createWriteStream(downloadPath),
   );
 
@@ -241,7 +264,23 @@ async function hackLocalBinSymlink() {
   }
 }
 
+function getGotOptions(url) {
+  let options = {};
+
+  let proxyUrl = getProxyForUrl(url);
+
+  if (proxyUrl) {
+    options.agent = {
+      ...options.agent,
+      https: new HttpsProxyAgent(proxyUrl),
+    };
+  }
+
+  return options;
+}
+
 module.exports = {
   getDriverPath,
   install,
+  getGotOptions,
 };