cypress 9.5.1 → 9.5.2

package/lib/exec/info.js

@@ -18,7 +18,8 @@ const _ = require('lodash'); // color for numbers and show values
 
 const g = chalk.green; // color for paths
 
-const p = chalk.cyan; // urls
+const p = chalk.cyan;
+const red = chalk.red; // urls
 
 const link = chalk.blue.underline; // to be exported
 
@@ -50,52 +51,63 @@ const formatCypressVariables = () => {
   return maskSensitiveVariables(vars);
 };
 
-methods.start = (options = {}) => {
+methods.start = async (options = {}) => {
   const args = ['--mode=info'];
-  return spawn.start(args, {
+  await spawn.start(args, {
     dev: options.dev
-  }).then(() => {
-    console.log();
-    const proxyVars = methods.findProxyEnvironmentVariables();
-
-    if (_.isEmpty(proxyVars)) {
-      console.log('Proxy Settings: none detected');
-    } else {
-      console.log('Proxy Settings:');
-
-      _.forEach(proxyVars, (value, key) => {
-        console.log('%s: %s', key, g(value));
-      });
-
-      console.log();
-      console.log('Learn More: %s', link('https://on.cypress.io/proxy-configuration'));
-      console.log();
-    }
-  }).then(() => {
-    const cyVars = formatCypressVariables();
-
-    if (_.isEmpty(cyVars)) {
-      console.log('Environment Variables: none detected');
-    } else {
-      console.log('Environment Variables:');
-
-      _.forEach(cyVars, (value, key) => {
-        console.log('%s: %s', key, g(value));
-      });
-    }
-  }).then(() => {
+  });
+  console.log();
+  const proxyVars = methods.findProxyEnvironmentVariables();
+
+  if (_.isEmpty(proxyVars)) {
+    console.log('Proxy Settings: none detected');
+  } else {
+    console.log('Proxy Settings:');
+
+    _.forEach(proxyVars, (value, key) => {
+      console.log('%s: %s', key, g(value));
+    });
+
     console.log();
-    console.log('Application Data:', p(util.getApplicationDataFolder()));
-    console.log('Browser Profiles:', p(util.getApplicationDataFolder('browsers')));
-    console.log('Binary Caches: %s', p(state.getCacheDir()));
-  }).then(() => {
+    console.log('Learn More: %s', link('https://on.cypress.io/proxy-configuration'));
     console.log();
-    return util.getOsVersionAsync().then(osVersion => {
-      console.log('Cypress Version: %s', g(util.pkgVersion()));
-      console.log('System Platform: %s (%s)', g(os.platform()), g(osVersion));
-      console.log('System Memory: %s free %s', g(prettyBytes(os.totalmem())), g(prettyBytes(os.freemem())));
+  }
+
+  const cyVars = formatCypressVariables();
+
+  if (_.isEmpty(cyVars)) {
+    console.log('Environment Variables: none detected');
+  } else {
+    console.log('Environment Variables:');
+
+    _.forEach(cyVars, (value, key) => {
+      console.log('%s: %s', key, g(value));
     });
-  });
+  }
+
+  console.log();
+  console.log('Application Data:', p(util.getApplicationDataFolder()));
+  console.log('Browser Profiles:', p(util.getApplicationDataFolder('browsers')));
+  console.log('Binary Caches: %s', p(state.getCacheDir()));
+  console.log();
+  const osVersion = await util.getOsVersionAsync();
+  const buildInfo = util.pkgBuildInfo();
+  const isStable = buildInfo && buildInfo.stable;
+  console.log('Cypress Version: %s', g(util.pkgVersion()), isStable ? g('(stable)') : red('(pre-release)'));
+  console.log('System Platform: %s (%s)', g(os.platform()), g(osVersion));
+  console.log('System Memory: %s free %s', g(prettyBytes(os.totalmem())), g(prettyBytes(os.freemem())));
+
+  if (!buildInfo) {
+    console.log();
+    console.log('This is the', red('development'), '(un-built) Cypress CLI.');
+  } else if (!isStable) {
+    console.log();
+    console.log('This is a', red('pre-release'), 'build of Cypress.');
+    console.log('Build info:');
+    console.log('  Commit SHA:', g(buildInfo.commitSha));
+    console.log('  Commit Branch:', g(buildInfo.commitBranch));
+    console.log('  Commit Date:', g(buildInfo.commitDate));
+  }
 };
 
 module.exports = methods;

package/lib/exec/versions.js

@@ -43,8 +43,11 @@ const getVersions = () => {
     debug('binary versions %o', versions);
     return versions;
   }).then(binaryVersions => {
+    const buildInfo = util.pkgBuildInfo();
+    let packageVersion = util.pkgVersion();
+    if (!buildInfo) packageVersion += ' (development)';else if (!buildInfo.stable) packageVersion += ' (pre-release)';
     const versions = {
-      package: util.pkgVersion(),
+      package: packageVersion,
       binary: binaryVersions.binary || 'not installed',
       electronVersion: binaryVersions.electronVersion || 'not found',
       electronNodeVersion: binaryVersions.electronNodeVersion || 'not found'

package/lib/tasks/install.js

@@ -6,8 +6,6 @@ const arch = require('arch');
 
 const os = require('os');
 
-const url = require('url');
-
 const path = require('path');
 
 const chalk = require('chalk');
@@ -45,95 +43,17 @@ const {
 
 const verbose = require('../VerboseRenderer');
 
-const getNpmArgv = () => {
-  const json = process.env.npm_config_argv;
-
-  if (!json) {
-    return;
-  }
-
-  debug('found npm argv json %o', json);
-
-  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/...", ...
-
-
-const getVersionSpecifier = (startDir = path.resolve(__dirname, '../..')) => {
-  const argv = getNpmArgv();
-
-  if ((process.env.npm_package_resolved || '').endsWith('cypress.tgz')) {
-    return process.env.npm_package_resolved;
-  }
-
-  if (argv) {
-    const tgz = _.find(argv, t => t.endsWith('cypress.tgz'));
-
-    if (tgz) {
-      return tgz;
-    }
-  }
-
-  const getVersionSpecifierFromPkg = dir => {
-    debug('looking for versionSpecifier %o', {
-      dir
-    });
-
-    const tryParent = () => {
-      const parentPath = path.resolve(dir, '..');
-
-      if (parentPath === dir) {
-        debug('reached FS root with no versionSpecifier found');
-        return;
-      }
-
-      return getVersionSpecifierFromPkg(parentPath);
-    };
-
-    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();
-
-      return specifier || tryParent();
-    });
-  }; // recurse through parent directories until package.json with `cypress` is found
-
-
-  return getVersionSpecifierFromPkg(startDir).then(versionSpecifier => {
-    debug('finished looking for versionSpecifier', {
-      versionSpecifier
-    });
-    return versionSpecifier;
-  });
-};
-
-const betaNpmUrlRe = /^\/beta\/npm\/(?<version>[0-9.]+)\/(?<platformSlug>.+?)\/(?<artifactSlug>.+?)\/cypress\.tgz$/; // convert a prerelease NPM package .tgz URL to the corresponding binary .zip URL
-
-const getBinaryUrlFromPrereleaseNpmUrl = npmUrl => {
-  let parsed;
-
-  try {
-    parsed = url.parse(npmUrl);
-  } catch (e) {
-    return;
-  }
-
-  const matches = betaNpmUrlRe.exec(parsed.pathname);
-
-  if (parsed.hostname !== 'cdn.cypress.io' || !matches) {
-    return;
-  }
+const {
+  buildInfo,
+  version
+} = require('../../package.json');
 
-  const {
-    version,
-    artifactSlug
-  } = matches.groups;
-  parsed.pathname = `/beta/binary/${version}/${os.platform()}-${arch()}/${artifactSlug}/cypress.zip`;
-  return parsed.format();
-};
+function _getBinaryUrlFromBuildInfo({
+  commitSha,
+  commitBranch
+}) {
+  return `https://cdn.cypress.io/beta/binary/${version}/${os.platform()}-${arch()}/${commitBranch}-${commitSha}/cypress.zip`;
+}
 
 const alreadyInstalledMsg = () => {
   if (!util.isPostInstall()) {
@@ -237,37 +157,64 @@ const validateOS = () => {
     return platformInfo.match(/(darwin|linux|win32)-x64/);
   });
 };
+/**
+ * Returns the version to install - either a string like `1.2.3` to be fetched
+ * from the download server or a file path or HTTP URL.
+ */
+
+
+function getVersionOverride({
+  envVarVersion,
+  buildInfo
+}) {
+  // let this environment variable reset the binary version we need
+  if (envVarVersion) {
+    return envVarVersion;
+  }
 
-const start = (options = {}) => {
-  debug('installing with options %j', options);
+  if (buildInfo && !buildInfo.stable) {
+    logger.log(chalk.yellow(stripIndent`
+        ${logSymbols.warning} Warning: You are installing a pre-release build of Cypress.
 
-  _.defaults(options, {
-    force: false
-  });
+        Bugs may be present which do not exist in production builds.
 
-  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
-    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`
-        ${chalk.yellow('Note:')} Skipping binary installation: Environment variable CYPRESS_INSTALL_BINARY = 0.`);
-      logger.log();
-      return Promise.resolve();
-    }
+        This build was created from:
+          * Commit SHA: ${buildInfo.commitSha}
+          * Commit Branch: ${buildInfo.commitBranch}
+          * Commit Timestamp: ${buildInfo.commitDate}
+      `));
+    logger.log();
+    return _getBinaryUrlFromBuildInfo(buildInfo);
+  }
+}
+
+function getEnvVarVersion() {
+  if (!util.getEnv('CYPRESS_INSTALL_BINARY')) return; // because passed file paths are often double quoted
+  // and might have extra whitespace around, be robust and trim the string
+
+  const trimAndRemoveDoubleQuotes = true;
+  const envVarVersion = util.getEnv('CYPRESS_INSTALL_BINARY', trimAndRemoveDoubleQuotes);
+  debug('using environment variable CYPRESS_INSTALL_BINARY "%s"', envVarVersion);
+  return envVarVersion;
+}
+
+const start = async (options = {}) => {
+  debug('installing with options %j', options);
+  const envVarVersion = getEnvVarVersion();
 
-    binaryUrlOverride = envVarVersion;
+  if (envVarVersion === '0') {
+    debug('environment variable CYPRESS_INSTALL_BINARY = 0, skipping install');
+    logger.log(stripIndent`
+        ${chalk.yellow('Note:')} Skipping binary installation: Environment variable CYPRESS_INSTALL_BINARY = 0.`);
+    logger.log();
+    return;
   }
 
+  _.defaults(options, {
+    force: false,
+    buildInfo
+  });
+
   if (util.getEnv('CYPRESS_CACHE_FOLDER')) {
     const envCache = util.getEnv('CYPRESS_CACHE_FOLDER');
     logger.log(stripIndent`
@@ -278,16 +225,22 @@ const start = (options = {}) => {
     logger.log();
   }
 
-  const installDir = state.getVersionDir(pkgVersion);
+  const pkgVersion = util.pkgVersion();
+  const versionOverride = getVersionOverride({
+    envVarVersion,
+    buildInfo: options.buildInfo
+  });
+  const versionToInstall = versionOverride || pkgVersion;
+  debug('version in package.json is %s, version to install is %s', pkgVersion, versionToInstall);
+  const installDir = state.getVersionDir(pkgVersion, options.buildInfo);
   const cacheDir = state.getCacheDir();
   const binaryDir = state.getBinaryDir(pkgVersion);
-  return validateOS().then(isValid => {
-    if (!isValid) {
-      return throwFormErrorText(errors.invalidOS)();
-    }
-  }).then(() => {
-    return fs.ensureDirAsync(cacheDir);
-  }).catch({
+
+  if (!(await validateOS())) {
+    return throwFormErrorText(errors.invalidOS)();
+  }
+
+  await fs.ensureDirAsync(cacheDir).catch({
     code: 'EACCES'
   }, err => {
     return throwFormErrorText(errors.invalidCacheDirectory)(stripIndent`
@@ -295,24 +248,11 @@ const start = (options = {}) => {
 
     ${err.message}
     `);
-  }).then(() => {
-    return Promise.all([state.getBinaryPkgAsync(binaryDir).then(state.getBinaryPkgVersion), 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);
+  });
+  const binaryPkg = await state.getBinaryPkgAsync(binaryDir);
+  const binaryVersion = await state.getBinaryPkgVersion(binaryPkg);
 
+  const shouldInstall = () => {
     if (!binaryVersion) {
       debug('no binary installed under cli version');
       return true;
@@ -329,92 +269,90 @@ const start = (options = {}) => {
       return true;
     }
 
-    if (binaryVersion === needVersion || !util.isSemver(needVersion)) {
+    if (binaryVersion === versionToInstall || !util.isSemver(versionToInstall)) {
       // our version matches, tell the user this is a noop
       alreadyInstalledMsg();
       return false;
     }
 
     return true;
-  }).then(shouldInstall => {
-    // noop if we've been told not to download
-    if (!shouldInstall) {
-      debug('Not downloading or installing binary');
-      return;
-    }
+  }; // noop if we've been told not to download
 
-    if (needVersion !== pkgVersion) {
-      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)}
+  if (!shouldInstall()) {
+    return debug('Not downloading or installing binary');
+  }
 
-            Instead we will install version: ${chalk.green(needVersion)}
+  if (envVarVersion) {
+    logger.log(chalk.yellow(stripIndent`
+        ${logSymbols.warning} Warning: Forcing a binary version different than the default.
 
-            These versions may not work properly together.
-        `));
-      logger.log();
-    } // see if version supplied is a path to a binary
+          The CLI expected to install version: ${chalk.green(pkgVersion)}
 
+          Instead we will install version: ${chalk.green(versionToInstall)}
 
-    return fs.pathExistsAsync(needVersion).then(exists => {
-      if (exists) {
-        return path.extname(needVersion) === '.zip' ? needVersion : false;
-      }
+          These versions may not work properly together.
+      `));
+    logger.log();
+  }
 
-      const possibleFile = util.formAbsolutePath(needVersion);
-      debug('checking local file', possibleFile, 'cwd', process.cwd());
-      return fs.pathExistsAsync(possibleFile).then(exists => {
-        // if this exists return the path to it
-        // else false
-        if (exists && path.extname(possibleFile) === '.zip') {
-          return possibleFile;
-        }
+  const getLocalFilePath = async () => {
+    // see if version supplied is a path to a binary
+    if (await fs.pathExistsAsync(versionToInstall)) {
+      return path.extname(versionToInstall) === '.zip' ? versionToInstall : false;
+    }
 
-        return false;
-      });
-    }).then(pathToLocalFile => {
-      if (pathToLocalFile) {
-        const absolutePath = path.resolve(needVersion);
-        debug('found local file at', absolutePath);
-        debug('skipping download');
-        const rendererOptions = getRendererOptions();
-        return new Listr([unzipTask({
-          progress: {
-            throttle: 100,
-            onProgress: null
-          },
-          zipFilePath: absolutePath,
-          installDir,
-          rendererOptions
-        })], {
-          rendererOptions
-        }).run();
-      }
-
-      if (options.force) {
-        debug('Cypress already installed at', installDir);
-        debug('but the installation was forced');
-      }
-
-      debug('preparing to download and unzip version ', needVersion, 'to path', installDir);
-      const downloadDir = os.tmpdir();
-      return downloadAndUnzip({
-        version: needVersion,
-        installDir,
-        downloadDir
-      });
-    }) // delay 1 sec for UX, unless we are testing
-    .then(() => {
-      return Promise.delay(1000);
-    }).then(displayCompletionMsg);
-  });
+    const possibleFile = util.formAbsolutePath(versionToInstall);
+    debug('checking local file', possibleFile, 'cwd', process.cwd()); // if this exists return the path to it
+    // else false
+
+    if ((await fs.pathExistsAsync(possibleFile)) && path.extname(possibleFile) === '.zip') {
+      return possibleFile;
+    }
+
+    return false;
+  };
+
+  const pathToLocalFile = await getLocalFilePath();
+
+  if (pathToLocalFile) {
+    const absolutePath = path.resolve(versionToInstall);
+    debug('found local file at', absolutePath);
+    debug('skipping download');
+    const rendererOptions = getRendererOptions();
+    return new Listr([unzipTask({
+      progress: {
+        throttle: 100,
+        onProgress: null
+      },
+      zipFilePath: absolutePath,
+      installDir,
+      rendererOptions
+    })], {
+      rendererOptions
+    }).run();
+  }
+
+  if (options.force) {
+    debug('Cypress already installed at', installDir);
+    debug('but the installation was forced');
+  }
+
+  debug('preparing to download and unzip version ', versionToInstall, 'to path', installDir);
+  const downloadDir = os.tmpdir();
+  await downloadAndUnzip({
+    version: versionToInstall,
+    installDir,
+    downloadDir
+  }); // delay 1 sec for UX, unless we are testing
+
+  await Promise.delay(1000);
+  displayCompletionMsg();
 };
 
 module.exports = {
   start,
-  _getVersionSpecifier: getVersionSpecifier,
-  _getBinaryUrlFromPrereleaseNpmUrl: getBinaryUrlFromPrereleaseNpmUrl
+  _getBinaryUrlFromBuildInfo
 };
 
 const unzipTask = ({

package/lib/tasks/state.js

@@ -79,7 +79,11 @@ const getBinaryDir = (version = util.pkgVersion()) => {
   return path.join(getVersionDir(version), getPlatFormBinaryFolder());
 };
 
-const getVersionDir = (version = util.pkgVersion()) => {
+const getVersionDir = (version = util.pkgVersion(), buildInfo = util.pkgBuildInfo()) => {
+  if (buildInfo && !buildInfo.stable) {
+    version = ['beta', version, buildInfo.commitBranch, buildInfo.commitSha].join('-');
+  }
+
   return path.join(getCacheDir(), version);
 };
 /**

package/lib/util.js

@@ -338,6 +338,10 @@ const util = {
     return process.cwd();
   },
 
+  pkgBuildInfo() {
+    return pkg.buildInfo;
+  },
+
   pkgVersion() {
     return pkg.version;
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress",
-  "version": "9.5.1",
+  "version": "9.5.2",
   "main": "index.js",
   "scripts": {
     "postinstall": "node index.js --exec install",
@@ -64,6 +64,12 @@
     "node": ">=12.0.0"
   },
   "types": "types",
+  "buildInfo": {
+    "commitBranch": "develop",
+    "commitSha": "5db2cd996834043b3c825625cf0100957e14a663",
+    "commitDate": "2022-03-14T18:42:32.000Z",
+    "stable": true
+  },
   "description": "Cypress.io end to end testing tool",
   "homepage": "https://github.com/cypress-io/cypress",
   "license": "MIT",
@@ -89,4 +95,4 @@
     "test",
     "testing"
   ]
-}
+}