cypress 5.1.0 → 5.5.0

package/lib/tasks/install.js

@@ -1,126 +1,159 @@
 "use strict";
 
-function _templateObject7() {
-  var data = _taggedTemplateLiteral(["\n          ", " Warning: Forcing a binary version different than the default.\n\n            The CLI expected to install version: ", "\n\n            Instead we will install version: ", "\n\n            These versions may not work properly together.\n        "]);
+const _ = require('lodash');
 
-  _templateObject7 = function _templateObject7() {
-    return data;
-  };
+const os = require('os');
 
-  return data;
-}
+const url = require('url');
 
-function _templateObject6() {
-  var data = _taggedTemplateLiteral(["\n      Cypress ", " is installed in ", "\n      "]);
+const path = require('path');
 
-  _templateObject6 = function _templateObject6() {
-    return data;
-  };
+const chalk = require('chalk');
 
-  return data;
-}
+const debug = require('debug')('cypress:cli');
 
-function _templateObject5() {
-  var data = _taggedTemplateLiteral(["\n    Failed to access ", ":\n\n    ", "\n    "]);
+const Listr = require('listr');
 
-  _templateObject5 = function _templateObject5() {
-    return data;
-  };
+const verbose = require('@cypress/listr-verbose-renderer');
 
-  return data;
-}
+const Promise = require('bluebird');
 
-function _templateObject4() {
-  var data = _taggedTemplateLiteral(["\n        ", " Overriding Cypress cache directory to: ", "\n\n              Previous installs of Cypress may not be found.\n      "]);
+const logSymbols = require('log-symbols');
 
-  _templateObject4 = function _templateObject4() {
-    return data;
-  };
+const {
+  stripIndent
+} = require('common-tags');
 
-  return data;
-}
+const fs = require('../fs');
 
-function _templateObject3() {
-  var data = _taggedTemplateLiteral(["\n        ", " Skipping binary installation: Environment variable CYPRESS_INSTALL_BINARY = 0."]);
+const download = require('./download');
 
-  _templateObject3 = function _templateObject3() {
-    return data;
-  };
+const util = require('../util');
 
-  return data;
-}
+const state = require('./state');
 
-function _templateObject2() {
-  var data = _taggedTemplateLiteral(["\n      ", " Warning: It looks like you've installed Cypress globally.\n\n        This will work, but it's not recommended.\n\n        The recommended way to install Cypress is as a devDependency per project.\n\n        You should probably run these commands:\n\n        - ", "\n        - ", "\n    "], ["\n      ", " Warning: It looks like you\\'ve installed Cypress globally.\n\n        This will work, but it'\\s not recommended.\n\n        The recommended way to install Cypress is as a devDependency per project.\n\n        You should probably run these commands:\n\n        - ", "\n        - ", "\n    "]);
+const unzip = require('./unzip');
 
-  _templateObject2 = function _templateObject2() {
-    return data;
-  };
+const logger = require('../logger');
 
-  return data;
-}
+const {
+  throwFormErrorText,
+  errors
+} = require('../errors');
 
-function _templateObject() {
-  var data = _taggedTemplateLiteral(["\n      Skipping installation:\n\n        Pass the ", " option if you'd like to reinstall anyway.\n    "]);
+const getNpmArgv = () => {
+  const json = process.env.npm_config_argv;
 
-  _templateObject = function _templateObject() {
-    return data;
-  };
+  if (!json) {
+    return;
+  }
+
+  debug('found npm argv json %o', json);
 
-  return data;
-}
+  try {
+    return JSON.parse(json).original || [];
+  } catch (e) {
+    return [];
+  }
+}; // attempt to discover the version specifier used to install Cypress
+// for example: "^5.0.0", "https://cdn.cypress.io/...", ...
 
-function _taggedTemplateLiteral(strings, raw) { if (!raw) { raw = strings.slice(0); } return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
 
-var _ = require('lodash');
+const getVersionSpecifier = (startDir = path.resolve(__dirname, '../..')) => {
+  const argv = getNpmArgv();
 
-var os = require('os');
+  if (argv) {
+    const tgz = _.find(argv, t => t.endsWith('cypress.tgz'));
 
-var path = require('path');
+    if (tgz) {
+      return tgz;
+    }
+  }
 
-var chalk = require('chalk');
+  const getVersionSpecifierFromPkg = dir => {
+    debug('looking for versionSpecifier %o', {
+      dir
+    });
 
-var debug = require('debug')('cypress:cli');
+    const tryParent = () => {
+      const parentPath = path.resolve(dir, '..');
 
-var Listr = require('listr');
+      if (parentPath === dir) {
+        debug('reached FS root with no versionSpecifier found');
+        return;
+      }
 
-var verbose = require('@cypress/listr-verbose-renderer');
+      return getVersionSpecifierFromPkg(parentPath);
+    };
 
-var Promise = require('bluebird');
+    return fs.readJSON(path.join(dir, 'package.json')).catch(() => ({})).then(pkg => {
+      const specifier = _.chain(['dependencies', 'devDependencies', 'optionalDependencies']).map(prop => _.get(pkg, `${prop}.cypress`)).compact().first().value();
 
-var logSymbols = require('log-symbols');
+      return specifier || tryParent();
+    });
+  }; // recurse through parent directories until package.json with `cypress` is found
 
-var _require = require('common-tags'),
-    stripIndent = _require.stripIndent;
 
-var fs = require('../fs');
+  return getVersionSpecifierFromPkg(startDir).then(versionSpecifier => {
+    debug('finished looking for versionSpecifier', {
+      versionSpecifier
+    });
+    return versionSpecifier;
+  });
+};
 
-var download = require('./download');
+const betaNpmUrlRe = /^\/beta\/npm\/(?<version>[0-9.]+)\/(?<artifactSlug>[^/]+)\/cypress\.tgz$/; // convert a prerelease NPM package .tgz URL to the corresponding binary .zip URL
 
-var util = require('../util');
+const getBinaryUrlFromPrereleaseNpmUrl = npmUrl => {
+  let parsed;
 
-var state = require('./state');
+  try {
+    parsed = url.parse(npmUrl);
+  } catch (e) {
+    return;
+  }
 
-var unzip = require('./unzip');
+  const matches = betaNpmUrlRe.exec(parsed.pathname);
 
-var logger = require('../logger');
+  if (parsed.hostname !== 'cdn.cypress.io' || !matches) {
+    return;
+  }
 
-var _require2 = require('../errors'),
-    throwFormErrorText = _require2.throwFormErrorText,
-    errors = _require2.errors;
+  const {
+    version,
+    artifactSlug
+  } = matches.groups;
+  parsed.pathname = `/beta/binary/${version}/${os.platform()}-${os.arch()}/${artifactSlug}/cypress.zip`;
+  return parsed.format();
+};
 
-var alreadyInstalledMsg = function alreadyInstalledMsg() {
+const alreadyInstalledMsg = () => {
   if (!util.isPostInstall()) {
-    logger.log(stripIndent(_templateObject(), chalk.yellow('--force')));
+    logger.log(stripIndent`
+      Skipping installation:
+
+        Pass the ${chalk.yellow('--force')} option if you'd like to reinstall anyway.
+    `);
   }
 };
 
-var displayCompletionMsg = function displayCompletionMsg() {
+const displayCompletionMsg = () => {
   // check here to see if we are globally installed
   if (util.isInstalledGlobally()) {
     // if we are display a warning
     logger.log();
-    logger.warn(stripIndent(_templateObject2(), logSymbols.warning, chalk.cyan('npm uninstall -g cypress'), chalk.cyan('npm install --save-dev cypress')));
+    logger.warn(stripIndent`
+      ${logSymbols.warning} Warning: It looks like you\'ve installed Cypress globally.
+
+        This will work, but it'\s not recommended.
+
+        The recommended way to install Cypress is as a devDependency per project.
+
+        You should probably run these commands:
+
+        - ${chalk.cyan('npm uninstall -g cypress')}
+        - ${chalk.cyan('npm install --save-dev cypress')}
+    `);
     return;
   }
 
@@ -131,52 +164,53 @@ var displayCompletionMsg = function displayCompletionMsg() {
   logger.log();
 };
 
-var downloadAndUnzip = function downloadAndUnzip(_ref) {
-  var version = _ref.version,
-      installDir = _ref.installDir,
-      downloadDir = _ref.downloadDir;
-  var progress = {
+const downloadAndUnzip = ({
+  version,
+  installDir,
+  downloadDir
+}) => {
+  const progress = {
     throttle: 100,
     onProgress: null
   };
-  var downloadDestination = path.join(downloadDir, 'cypress.zip');
-  var rendererOptions = getRendererOptions(); // let the user know what version of cypress we're downloading!
+  const downloadDestination = path.join(downloadDir, 'cypress.zip');
+  const rendererOptions = getRendererOptions(); // let the user know what version of cypress we're downloading!
 
-  logger.log("Installing Cypress ".concat(chalk.gray("(version: ".concat(version, ")"))));
+  logger.log(`Installing Cypress ${chalk.gray(`(version: ${version})`)}`);
   logger.log();
-  var tasks = new Listr([{
+  const tasks = new Listr([{
     title: util.titleize('Downloading Cypress'),
-    task: function task(ctx, _task) {
+    task: (ctx, task) => {
       // as our download progresses indicate the status
-      progress.onProgress = progessify(_task, 'Downloading Cypress');
+      progress.onProgress = progessify(task, 'Downloading Cypress');
       return download.start({
-        version: version,
-        downloadDestination: downloadDestination,
-        progress: progress
-      }).then(function (redirectVersion) {
+        version,
+        downloadDestination,
+        progress
+      }).then(redirectVersion => {
         if (redirectVersion) version = redirectVersion;
-        debug("finished downloading file: ".concat(downloadDestination));
-      }).then(function () {
+        debug(`finished downloading file: ${downloadDestination}`);
+      }).then(() => {
         // save the download destination for unzipping
-        util.setTaskTitle(_task, util.titleize(chalk.green('Downloaded Cypress')), rendererOptions.renderer);
+        util.setTaskTitle(task, util.titleize(chalk.green('Downloaded Cypress')), rendererOptions.renderer);
       });
     }
   }, unzipTask({
-    progress: progress,
+    progress,
     zipFilePath: downloadDestination,
-    installDir: installDir,
-    rendererOptions: rendererOptions
+    installDir,
+    rendererOptions
   }), {
     title: util.titleize('Finishing Installation'),
-    task: function task(ctx, _task2) {
-      var cleanup = function cleanup() {
+    task: (ctx, task) => {
+      const cleanup = () => {
         debug('removing zip file %s', downloadDestination);
         return fs.removeAsync(downloadDestination);
       };
 
-      return cleanup().then(function () {
+      return cleanup().then(() => {
         debug('finished installation in', installDir);
-        util.setTaskTitle(_task2, util.titleize(chalk.green('Finished Installation'), chalk.gray(installDir)), rendererOptions.renderer);
+        util.setTaskTitle(task, util.titleize(chalk.green('Finished Installation'), chalk.gray(installDir)), rendererOptions.renderer);
       });
     }
   }], rendererOptions); // start the tasks!
@@ -184,9 +218,7 @@ var downloadAndUnzip = function downloadAndUnzip(_ref) {
   return Promise.resolve(tasks.run());
 };
 
-var start = function start() {
-  var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
+const start = (options = {}) => {
   // handle deprecated / removed
   if (util.getEnv('CYPRESS_BINARY_VERSION')) {
     return throwFormErrorText(errors.removed.CYPRESS_BINARY_VERSION)();
@@ -202,56 +234,77 @@ var start = function start() {
     force: false
   });
 
-  var pkgVersion = util.pkgVersion();
-  var needVersion = pkgVersion;
+  const pkgVersion = util.pkgVersion();
+  let needVersion = pkgVersion;
+  let binaryUrlOverride;
   debug('version in package.json is', needVersion); // let this environment variable reset the binary version we need
 
   if (util.getEnv('CYPRESS_INSTALL_BINARY')) {
     // because passed file paths are often double quoted
     // and might have extra whitespace around, be robust and trim the string
-    var trimAndRemoveDoubleQuotes = true;
-    var envVarVersion = util.getEnv('CYPRESS_INSTALL_BINARY', trimAndRemoveDoubleQuotes);
+    const trimAndRemoveDoubleQuotes = true;
+    const envVarVersion = util.getEnv('CYPRESS_INSTALL_BINARY', trimAndRemoveDoubleQuotes);
     debug('using environment variable CYPRESS_INSTALL_BINARY "%s"', envVarVersion);
 
     if (envVarVersion === '0') {
       debug('environment variable CYPRESS_INSTALL_BINARY = 0, skipping install');
-      logger.log(stripIndent(_templateObject3(), chalk.yellow('Note:')));
+      logger.log(stripIndent`
+        ${chalk.yellow('Note:')} Skipping binary installation: Environment variable CYPRESS_INSTALL_BINARY = 0.`);
       logger.log();
       return Promise.resolve();
-    } // if this doesn't match the expected version
-    // then print warning to the user
-
-
-    if (envVarVersion !== needVersion) {
-      // reset the version to the env var version
-      needVersion = envVarVersion;
     }
+
+    binaryUrlOverride = envVarVersion;
   }
 
   if (util.getEnv('CYPRESS_CACHE_FOLDER')) {
-    var envCache = util.getEnv('CYPRESS_CACHE_FOLDER');
-    logger.log(stripIndent(_templateObject4(), chalk.yellow('Note:'), chalk.cyan(envCache)));
+    const envCache = util.getEnv('CYPRESS_CACHE_FOLDER');
+    logger.log(stripIndent`
+        ${chalk.yellow('Note:')} Overriding Cypress cache directory to: ${chalk.cyan(envCache)}
+
+              Previous installs of Cypress may not be found.
+      `);
     logger.log();
   }
 
-  var installDir = state.getVersionDir(pkgVersion);
-  var cacheDir = state.getCacheDir();
-  var binaryDir = state.getBinaryDir(pkgVersion);
-  return fs.ensureDirAsync(cacheDir)["catch"]({
+  const installDir = state.getVersionDir(pkgVersion);
+  const cacheDir = state.getCacheDir();
+  const binaryDir = state.getBinaryDir(pkgVersion);
+  return fs.ensureDirAsync(cacheDir).catch({
     code: 'EACCES'
-  }, function (err) {
-    return throwFormErrorText(errors.invalidCacheDirectory)(stripIndent(_templateObject5(), chalk.cyan(cacheDir), err.message));
-  }).then(function () {
-    return state.getBinaryPkgVersionAsync(binaryDir);
-  }).then(function (binaryVersion) {
+  }, err => {
+    return throwFormErrorText(errors.invalidCacheDirectory)(stripIndent`
+    Failed to access ${chalk.cyan(cacheDir)}:
+
+    ${err.message}
+    `);
+  }).then(() => {
+    return Promise.all([state.getBinaryPkgVersionAsync(binaryDir), getVersionSpecifier()]);
+  }).then(([binaryVersion, versionSpecifier]) => {
+    if (!binaryUrlOverride && versionSpecifier) {
+      const computedBinaryUrl = getBinaryUrlFromPrereleaseNpmUrl(versionSpecifier);
+
+      if (computedBinaryUrl) {
+        debug('computed binary url from version specifier %o', {
+          computedBinaryUrl,
+          needVersion
+        });
+        binaryUrlOverride = computedBinaryUrl;
+      }
+    }
+
+    needVersion = binaryUrlOverride || needVersion;
+    debug('installed version is', binaryVersion, 'version needed is', needVersion);
+
     if (!binaryVersion) {
       debug('no binary installed under cli version');
       return true;
     }
 
-    debug('installed version is', binaryVersion, 'version needed is', needVersion);
     logger.log();
-    logger.log(stripIndent(_templateObject6(), chalk.green(binaryVersion), chalk.cyan(installDir)));
+    logger.log(stripIndent`
+      Cypress ${chalk.green(binaryVersion)} is installed in ${chalk.cyan(installDir)}
+      `);
     logger.log();
 
     if (options.force) {
@@ -266,7 +319,7 @@ var start = function start() {
     }
 
     return true;
-  }).then(function (shouldInstall) {
+  }).then(shouldInstall => {
     // noop if we've been told not to download
     if (!shouldInstall) {
       debug('Not downloading or installing binary');
@@ -274,19 +327,27 @@ var start = function start() {
     }
 
     if (needVersion !== pkgVersion) {
-      logger.log(chalk.yellow(stripIndent(_templateObject7(), logSymbols.warning, chalk.green(pkgVersion), chalk.green(needVersion))));
+      logger.log(chalk.yellow(stripIndent`
+          ${logSymbols.warning} Warning: Forcing a binary version different than the default.
+
+            The CLI expected to install version: ${chalk.green(pkgVersion)}
+
+            Instead we will install version: ${chalk.green(needVersion)}
+
+            These versions may not work properly together.
+        `));
       logger.log();
     } // see if version supplied is a path to a binary
 
 
-    return fs.pathExistsAsync(needVersion).then(function (exists) {
+    return fs.pathExistsAsync(needVersion).then(exists => {
       if (exists) {
         return path.extname(needVersion) === '.zip' ? needVersion : false;
       }
 
-      var possibleFile = util.formAbsolutePath(needVersion);
+      const possibleFile = util.formAbsolutePath(needVersion);
       debug('checking local file', possibleFile, 'cwd', process.cwd());
-      return fs.pathExistsAsync(possibleFile).then(function (exists) {
+      return fs.pathExistsAsync(possibleFile).then(exists => {
         // if this exists return the path to it
         // else false
         if (exists && path.extname(possibleFile) === '.zip') {
@@ -295,20 +356,20 @@ var start = function start() {
 
         return false;
       });
-    }).then(function (pathToLocalFile) {
+    }).then(pathToLocalFile => {
       if (pathToLocalFile) {
-        var absolutePath = path.resolve(needVersion);
+        const absolutePath = path.resolve(needVersion);
         debug('found local file at', absolutePath);
         debug('skipping download');
-        var rendererOptions = getRendererOptions();
+        const rendererOptions = getRendererOptions();
         return new Listr([unzipTask({
           progress: {
             throttle: 100,
             onProgress: null
           },
           zipFilePath: absolutePath,
-          installDir: installDir,
-          rendererOptions: rendererOptions
+          installDir,
+          rendererOptions
         })], rendererOptions).run();
       }
 
@@ -318,50 +379,53 @@ var start = function start() {
       }
 
       debug('preparing to download and unzip version ', needVersion, 'to path', installDir);
-      var downloadDir = os.tmpdir();
+      const downloadDir = os.tmpdir();
       return downloadAndUnzip({
         version: needVersion,
-        installDir: installDir,
-        downloadDir: downloadDir
+        installDir,
+        downloadDir
       });
     }) // delay 1 sec for UX, unless we are testing
-    .then(function () {
+    .then(() => {
       return Promise.delay(1000);
     }).then(displayCompletionMsg);
   });
 };
 
 module.exports = {
-  start: start
+  start,
+  _getVersionSpecifier: getVersionSpecifier,
+  _getBinaryUrlFromPrereleaseNpmUrl: getBinaryUrlFromPrereleaseNpmUrl
 };
 
-var unzipTask = function unzipTask(_ref2) {
-  var zipFilePath = _ref2.zipFilePath,
-      installDir = _ref2.installDir,
-      progress = _ref2.progress,
-      rendererOptions = _ref2.rendererOptions;
+const unzipTask = ({
+  zipFilePath,
+  installDir,
+  progress,
+  rendererOptions
+}) => {
   return {
     title: util.titleize('Unzipping Cypress'),
-    task: function task(ctx, _task3) {
+    task: (ctx, task) => {
       // as our unzip progresses indicate the status
-      progress.onProgress = progessify(_task3, 'Unzipping Cypress');
+      progress.onProgress = progessify(task, 'Unzipping Cypress');
       return unzip.start({
-        zipFilePath: zipFilePath,
-        installDir: installDir,
-        progress: progress
-      }).then(function () {
-        util.setTaskTitle(_task3, util.titleize(chalk.green('Unzipped Cypress')), rendererOptions.renderer);
+        zipFilePath,
+        installDir,
+        progress
+      }).then(() => {
+        util.setTaskTitle(task, util.titleize(chalk.green('Unzipped Cypress')), rendererOptions.renderer);
       });
     }
   };
 };
 
-var progessify = function progessify(task, title) {
+const progessify = (task, title) => {
   // return higher order function
-  return function (percentComplete, remaining) {
-    percentComplete = chalk.white(" ".concat(percentComplete, "%")); // pluralize seconds remaining
+  return (percentComplete, remaining) => {
+    percentComplete = chalk.white(` ${percentComplete}%`); // pluralize seconds remaining
 
-    remaining = chalk.gray("".concat(remaining, "s"));
+    remaining = chalk.gray(`${remaining}s`);
     util.setTaskTitle(task, util.titleize(title, percentComplete, remaining), getRendererOptions().renderer);
   };
 }; // if we are running in CI then use
@@ -369,14 +433,14 @@ var progessify = function progessify(task, title) {
 // the default
 
 
-var getRendererOptions = function getRendererOptions() {
-  var renderer = util.isCi() ? verbose : 'default';
+const getRendererOptions = () => {
+  let renderer = util.isCi() ? verbose : 'default';
 
   if (logger.logLevel() === 'silent') {
     renderer = 'silent';
   }
 
   return {
-    renderer: renderer
+    renderer
   };
 };