browser-webdriver-downloader 1.5.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 CrowdStrike
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# browser-webdriver-downloader
+
+[![npm version](https://badge.fury.io/js/browser-webdriver-downloader.svg)](https://badge.fury.io/js/browser-webdriver-downloader)
+
+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.

package/bin/install-msedgedriver.js

@@ -0,0 +1,7 @@
+'use strict';
+
+require('../src/utils/throw-up');
+
+const { install } = require('../src');
+
+install();

package/bin/msedgedriver.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+'use strict';
+
+require('../src/utils/throw-up');
+
+const execa = require('execa');
+const { getDriverPath } = require('../src');
+
+(async () => {
+  await execa(getDriverPath(), process.argv.slice(2), {
+    stdio: 'inherit',
+  });
+})();

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "browser-webdriver-downloader",
+  "version": "1.5.1",
+  "description": "Install and wrap msedgedriver in Node.js",
+  "bin": {
+    "msedgedriver": "bin/msedgedriver.js"
+  },
+  "main": "src",
+  "files": [
+    "bin",
+    "src"
+  ],
+  "keywords": [
+    "msedgedriver",
+    "webdriver"
+  ],
+  "scripts": {
+    "lint:git": "commitlint --default-branch main",
+    "lint:js": "eslint . --ext js,json",
+    "lint:md": "remark -f README.md",
+    "install": "node bin/install-msedgedriver",
+    "start": "node bin/msedgedriver.js",
+    "release": "standard-version",
+    "test": "mocha"
+  },
+  "standard-version": {
+    "scripts": {
+      "posttag": "git push --follow-tags --atomic"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/CrowdStrike/browser-webdriver-downloader.git"
+  },
+  "author": "Kelly Selden",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/CrowdStrike/browser-webdriver-downloader/issues"
+  },
+  "homepage": "https://github.com/CrowdStrike/browser-webdriver-downloader#readme",
+  "engines": {
+    "node": ">=14.15"
+  },
+  "dependencies": {
+    "execa": "^5.0.0",
+    "extract-zip": "^2.0.1",
+    "find-edge-version": "0.1.1",
+    "fs-extra": "^10.1.0",
+    "got": "^11.8.5",
+    "tmp": "0.2.1",
+    "yn": "^4.0.0"
+  },
+  "devDependencies": {
+    "@crowdstrike/commitlint": "^5.0.0",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
+    "chai-fs": "^2.0.0",
+    "eslint": "^8.0.0",
+    "eslint-config-crowdstrike": "^8.0.0",
+    "eslint-config-crowdstrike-node": "^3.0.0",
+    "eslint-plugin-json-files": "^1.0.0",
+    "eslint-plugin-mocha": "^10.0.0",
+    "eslint-plugin-node": "^11.0.0",
+    "mocha": "^10.0.0",
+    "mocha-helpers": "^6.2.1",
+    "remark-cli": "^11.0.0",
+    "remark-preset-lint-crowdstrike": "^2.0.0",
+    "renovate-config-standard": "^2.0.0",
+    "standard-node-template": "3.0.0",
+    "standard-version": "9.5.0"
+  }
+}

package/src/fs.js

@@ -0,0 +1,24 @@
+'use strict';
+
+const fs = { ...require('fs'), ...require('fs').promises };
+
+async function exists(path) {
+  try {
+    await fs.access(path, fs.constants.F_OK);
+
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+async function rename(from, to) {
+  // system tmp may be mounted on a different drive
+  // use `fs-extra` to prevent `Error: EXDEV: cross-device link not permitted, rename ...`
+  await require('fs-extra').move(from, to);
+}
+
+module.exports = {
+  exists,
+  rename,
+};

package/src/index.js

@@ -0,0 +1,241 @@
+'use strict';
+
+const got = require('got');
+const { promisify } = require('util');
+const fs = { ...require('fs'), ...require('fs').promises, ...require('../src/fs') };
+const path = require('path');
+const extractZip = require('extract-zip');
+const pipeline = promisify(require('stream').pipeline);
+const os = require('os');
+const { createTmpDir } = require('../src/tmp');
+const execa = require('execa');
+const yn = require('yn');
+
+const platform = os.platform();
+const arch = os.arch();
+
+const downloadHost = 'https://msedgedriver.azureedge.net';
+
+const driversRoot = path.join(__dirname, '../bin');
+
+function getDownloadName() {
+  let firstPart;
+  let secondPart;
+
+  if (platform === 'linux' && arch === 'x64') {
+    firstPart = 'linux';
+    secondPart = '64';
+  } else if (platform === 'darwin' && arch === 'x64') {
+    firstPart = 'mac';
+    secondPart = '64';
+  } else if (platform === 'darwin' && arch === 'arm64') {
+    firstPart = 'mac';
+    secondPart = '64';
+  } else if (platform === 'win32' && arch === 'x64') {
+    firstPart = 'win';
+    secondPart = '64';
+  } else if (platform === 'win32' && arch === 'x32') {
+    firstPart = 'win';
+    secondPart = '32';
+  } else if (platform === 'win32' && arch === 'arm64') {
+    firstPart = 'arm';
+    secondPart = '64';
+  } else {
+    throw new Error(`${platform} ${arch} not supported`);
+  }
+
+  return `edgedriver_${firstPart}${secondPart}.zip`;
+}
+
+async function getDriverVersion() {
+  let version;
+
+  if (process.env.EDGEDRIVER_VERSION) {
+    version = process.env.EDGEDRIVER_VERSION;
+  } else if (yn(process.env.DETECT_EDGEDRIVER_VERSION)) {
+    version = await getDetectedDriverVersion();
+  }
+
+  if (!version) {
+    version = await getLatestDriverVersion();
+  }
+
+  return version;
+}
+
+async function getDetectedDriverVersion() {
+  let version;
+
+  if (platform === 'win32') {
+    const findEdgeVersion = require('find-edge-version');
+
+    let result;
+
+    try {
+      result = await findEdgeVersion();
+    } catch (err) {
+      if (err.message !== 'MS Edge browser is not found') {
+        throw err;
+      }
+    }
+
+    if (result) {
+      version = result.version;
+    }
+  } else {
+    let browserCmd = (() => {
+      switch (platform) {
+        case 'linux': return 'microsoft-edge';
+        case 'darwin': return '/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge';
+        default: throw new Error(`Platform "${platform}" not supported`);
+      }
+    })();
+
+    let ps;
+
+    try {
+      ps = await execa(browserCmd, ['--version']);
+    } catch (err) {
+      if (err.code !== 'ENOENT') {
+        throw err;
+      }
+    }
+
+    if (ps) {
+      // "Microsoft Edge 105.0.1343.53 "
+      version = ps.stdout.match(/(?:\d|\.)+/)[0];
+    }
+  }
+
+  if (version) {
+    console.log(`DETECT_EDGEDRIVER_VERSION=${process.env.DETECT_EDGEDRIVER_VERSION}, detected version ${version}`);
+  } else {
+    console.log(`DETECT_EDGEDRIVER_VERSION=${process.env.DETECT_EDGEDRIVER_VERSION}, but Microsoft Edge install not found`);
+  }
+
+  return version;
+}
+
+async function getLatestDriverVersion() {
+  let { body } = await got.get(`${downloadHost}/LATEST_STABLE`);
+
+  // For example: '��102.0.1245.33\r\n'
+  let version = body.replace(/[^\d.]/g, '');
+
+  return version;
+}
+
+function getDriverName() {
+  if (platform === 'win32') {
+    return 'msedgedriver.exe';
+  } else {
+    return 'msedgedriver';
+  }
+}
+
+function getDriverPath(driverName = getDriverName()) {
+  return path.resolve(driversRoot, driverName);
+}
+
+async function install() {
+  let version = await getDriverVersion();
+
+  let driverName = getDriverName();
+
+  let driverPath = getDriverPath(driverName);
+
+  let shouldDownload = true;
+
+  if (await fs.exists(driverPath)) {
+    let ps = await execa(driverPath, ['--version']);
+
+    // "Microsoft Edge WebDriver 105.0.1343.53 (3a47f00402d579c8ba1fad7e143f9d73831b6765)"
+    let existingVersion = ps.stdout.match(/(?:\d|\.)+/)[0];
+
+    if (existingVersion === version) {
+      console.log(`Found ${driverPath} at version ${existingVersion}, not downloading`);
+
+      shouldDownload = false;
+    } else {
+      console.log(`Found ${driverPath} at different version ${existingVersion}, redownloading`);
+
+      await fs.unlink(driverPath);
+    }
+  }
+
+  if (shouldDownload) {
+    await downloadAndExtract({ version, driverName, driverPath });
+  }
+
+  console.log(`Edge WebDriver available at ${driverPath}`);
+
+  // await hackLocalBinSymlink();
+}
+
+async function downloadAndExtract({ version, driverName, driverPath }) {
+  let tmpPath = await createTmpDir();
+
+  let downloadPath = await download({ tmpPath, version });
+
+  await extract({ tmpPath, downloadPath, driverName, driverPath });
+
+  await fs.rm(tmpPath, { recursive: true, force: true });
+}
+
+async function download({ tmpPath, version }) {
+  let downloadName = getDownloadName();
+
+  let downloadPath = path.join(tmpPath, downloadName);
+
+  let downloadUrl = `${downloadHost}/${version}/${downloadName}`;
+
+  console.log(`Downloading ${downloadUrl}...`);
+
+  await pipeline(
+    got.stream(downloadUrl),
+    fs.createWriteStream(downloadPath),
+  );
+
+  return downloadPath;
+}
+
+async function extract({ tmpPath, downloadPath, driverName, driverPath }) {
+  console.log(`Extracting ${downloadPath}...`);
+
+  await extractZip(downloadPath, { dir: tmpPath });
+
+  let tmpDriverPath = path.join(tmpPath, driverName);
+
+  await fs.mkdir(path.dirname(driverPath), { recursive: true });
+
+  await fs.rename(tmpDriverPath, driverPath);
+}
+
+// eslint-disable-next-line no-unused-vars
+async function hackLocalBinSymlink() {
+  let packagePath = require.resolve('../package');
+  let { bin } = require(packagePath);
+  let packageRoot = path.dirname(packagePath);
+
+  for (let [name, _path] of Object.entries(bin)) {
+    let dest = path.join(packageRoot, 'node_modules/.bin', name);
+    let source = path.relative(path.dirname(dest), path.join(packageRoot, _path));
+
+    try {
+      await fs.unlink(dest);
+    } catch (err) {
+      if (err.code !== 'ENOENT') {
+        throw err;
+      }
+    }
+
+    await fs.symlink(source, dest);
+
+    console.log(`${dest} -> ${source}`);
+  }
+}
+
+module.exports = {
+  getDriverPath,
+  install,
+};

package/src/tmp.js

@@ -0,0 +1,8 @@
+'use strict';
+
+const { promisify } = require('util');
+const createTmpDir = promisify(require('tmp').dir);
+
+module.exports = {
+  createTmpDir,
+};

package/src/utils/throw-up.js

@@ -0,0 +1,4 @@
+'use strict';
+
+// https://medium.com/@dtinth/making-unhandled-promise-rejections-crash-the-node-js-process-ffc27cfcc9dd
+process.on('unhandledRejection', up => { throw up; });