cypress 9.5.1 → 9.5.4

package/lib/cli.js

@@ -223,6 +223,10 @@ const createProgram = () => {
 const addCypressRunCommand = program => {
   return program.command('run').usage('[options]').description('Runs Cypress tests from the CLI without the GUI').option('-b, --browser <browser-name-or-path>', text('browserRunMode')).option('--ci-build-id <id>', text('ciBuildId')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-e, --env <env>', text('env')).option('--group <name>', text('group')).option('-k, --key <record-key>', text('key')).option('--headed', text('headed')).option('--headless', text('headless')).option('--no-exit', text('exit')).option('--parallel', text('parallel')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('-q, --quiet', text('quiet')).option('--record [bool]', text('record'), coerceFalse).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-s, --spec <spec>', text('spec')).option('-t, --tag <tag>', text('tag')).option('--dev', text('dev'), coerceFalse);
 };
+
+const addCypressOpenCommand = program => {
+  return program.command('open').usage('[options]').description('Opens Cypress in the interactive GUI.').option('-b, --browser <browser-path>', text('browserOpenMode')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-d, --detached [bool]', text('detached'), coerceFalse).option('-e, --env <env>', text('env')).option('--global', text('global')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('--dev', text('dev'), coerceFalse);
+};
 /**
  * Casts known command line options for "cypress run" to their intended type.
  * For example if the user passes "--port 5005" the ".port" property should be
@@ -322,10 +326,10 @@ module.exports = {
     program.option('-v, --version', text('version')).command('version').description(text('version')).action(() => {
       showVersions(args);
     });
-    program.command('open').usage('[options]').description('Opens Cypress in the interactive GUI.').option('-b, --browser <browser-path>', text('browserOpenMode')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-d, --detached [bool]', text('detached'), coerceFalse).option('-e, --env <env>', text('env')).option('--global', text('global')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('--dev', text('dev'), coerceFalse).action(opts => {
+    addCypressOpenCommand(program).action(opts => {
       debug('opening Cypress');
 
-      require('./exec/open').start(util.parseOpts(opts)).catch(util.logErrorExit1);
+      require('./exec/open').start(util.parseOpts(opts)).then(util.exit).catch(util.logErrorExit1);
     });
     addCypressRunCommand(program).action((...fnArgs) => {
       debug('running Cypress with args %o', fnArgs);
@@ -337,7 +341,7 @@ module.exports = {
 
       require('./exec/open').start({ ...util.parseOpts(opts),
         testingType: 'component'
-      }).catch(util.logErrorExit1);
+      }).then(util.exit).catch(util.logErrorExit1);
     });
     program.command('run-ct').usage('[options]').description('Runs all Cypress Component Testing suites').option('-b, --browser <browser-name-or-path>', text('browserRunMode')).option('--ci-build-id <id>', text('ciBuildId')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-e, --env <env>', text('env')).option('--group <name>', text('group')).option('-k, --key <record-key>', text('key')).option('--headed', text('headed')).option('--headless', text('headless')).option('--no-exit', text('exit')).option('--parallel', text('parallel')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('-q, --quiet', text('quiet')).option('--record [bool]', text('record'), coerceFalse).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-s, --spec <spec>', text('spec')).option('-t, --tag <tag>', text('tag')).option('--dev', text('dev'), coerceFalse).action(opts => {
       debug('running Cypress run-ct');

package/lib/errors.js

@@ -79,7 +79,7 @@ const binaryNotExecutable = executable => {
 
     Please check that you have the appropriate user permissions.
 
-    You can also try clearing the cache with 'cypress cache clear' and reinstalling. 
+    You can also try clearing the cache with 'cypress cache clear' and reinstalling.
   `
   };
 };

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/open.js

@@ -12,41 +12,48 @@ const {
   processTestingType
 } = require('./shared');
 
-module.exports = {
-  start(options = {}) {
-    if (!util.isInstalledGlobally() && !options.global && !options.project) {
-      options.project = process.cwd();
-    }
+const processOpenOptions = options => {
+  if (!util.isInstalledGlobally() && !options.global && !options.project) {
+    options.project = process.cwd();
+  }
 
-    const args = [];
+  const args = [];
 
-    if (options.config) {
-      args.push('--config', options.config);
-    }
+  if (options.config) {
+    args.push('--config', options.config);
+  }
 
-    if (options.configFile !== undefined) {
-      args.push('--config-file', options.configFile);
-    }
+  if (options.configFile !== undefined) {
+    args.push('--config-file', options.configFile);
+  }
 
-    if (options.browser) {
-      args.push('--browser', options.browser);
-    }
+  if (options.browser) {
+    args.push('--browser', options.browser);
+  }
 
-    if (options.env) {
-      args.push('--env', options.env);
-    }
+  if (options.env) {
+    args.push('--env', options.env);
+  }
 
-    if (options.port) {
-      args.push('--port', options.port);
-    }
+  if (options.port) {
+    args.push('--port', options.port);
+  }
 
-    if (options.project) {
-      args.push('--project', options.project);
-    }
+  if (options.project) {
+    args.push('--project', options.project);
+  }
+
+  args.push(...processTestingType(options.testingType));
+  debug('opening from options %j', options);
+  debug('command line arguments %j', args);
+  return args;
+};
 
-    args.push(...processTestingType(options.testingType));
-    debug('opening from options %j', options);
-    debug('command line arguments %j', args);
+module.exports = {
+  processOpenOptions,
+
+  start(options = {}) {
+    const args = processOpenOptions(options);
 
     function open() {
       return spawn.start(args, {

package/lib/exec/spawn.js

@@ -26,8 +26,18 @@ const errors = require('../errors');
 
 const isXlibOrLibudevRe = /^(?:Xlib|libudev)/;
 const isHighSierraWarningRe = /\*\*\* WARNING/;
-const isRenderWorkerRe = /\.RenderWorker-/;
-const GARBAGE_WARNINGS = [isXlibOrLibudevRe, isHighSierraWarningRe, isRenderWorkerRe];
+const isRenderWorkerRe = /\.RenderWorker-/; // Chromium (which Electron uses) always makes several attempts to connect to the system dbus.
+// This works fine in most desktop environments, but in a docker container, there is no dbus service
+// and Chromium emits several error lines, similar to these:
+// [1957:0406/160550.146820:ERROR:bus.cc(392)] Failed to connect to the bus: Failed to connect to socket /var/run/dbus/system_bus_socket: No such file or directory
+// [1957:0406/160550.147994:ERROR:bus.cc(392)] Failed to connect to the bus: Address does not contain a colon
+// These warnings are absolutely harmless. Failure to connect to dbus means that electron won't be able to access the user's
+// credential wallet (none exists in a docker container) and won't show up in the system tray (again, none exists).
+// Failure to connect is expected and normal here, but users frequently misidentify these errors as the cause of their problems.
+// https://github.com/cypress-io/cypress/issues/19299
+
+const isDbusWarning = /Failed to connect to the bus:/;
+const GARBAGE_WARNINGS = [isXlibOrLibudevRe, isHighSierraWarningRe, isRenderWorkerRe, isDbusWarning];
 
 const isGarbageLineWarning = str => {
   return _.some(GARBAGE_WARNINGS, re => {
@@ -109,19 +119,23 @@ module.exports = {
         const envOverrides = util.getEnvOverrides(options);
         const electronArgs = [];
         const node11WindowsFix = isPlatform('win32');
+        let startScriptPath;
 
         if (options.dev) {
-          // if we're in dev then reset
+          executable = 'node'; // if we're in dev then reset
           // the launch cmd to be 'npm run dev'
-          executable = 'node';
-          electronArgs.unshift(path.resolve(__dirname, '..', '..', '..', 'scripts', 'start.js'));
-          debug('in dev mode the args became %o', args);
+
+          startScriptPath = path.resolve(__dirname, '..', '..', '..', 'scripts', 'start.js'), debug('in dev mode the args became %o', args);
         }
 
         if (!options.dev && verify.needsSandbox()) {
           electronArgs.push('--no-sandbox');
         } // strip dev out of child process options
 
+        /**
+         * @type {import('child_process').ForkOptions}
+         */
+
 
         let stdioOptions = _.pick(options, 'env', 'detached', 'stdio'); // figure out if we're going to be force enabling or disabling colors.
         // also figure out whether we should force stdout and stderr into thinking
@@ -148,8 +162,7 @@ module.exports = {
 
         if (stdioOptions.env.ELECTRON_RUN_AS_NODE) {
           // Since we are running electron as node, we need to add an entry point file.
-          const serverEntryPoint = path.join(state.getBinaryPkgPath(path.dirname(executable)), '..', 'index.js');
-          args = [serverEntryPoint, ...args];
+          startScriptPath = path.join(state.getBinaryPkgPath(path.dirname(executable)), '..', 'index.js');
         } else {
           // Start arguments with "--" so Electron knows these are OUR
           // arguments and does not try to sanitize them. Otherwise on Windows
@@ -158,8 +171,12 @@ module.exports = {
           args = [...electronArgs, '--', ...args];
         }
 
-        debug('spawning Cypress with executable: %s', executable);
+        if (startScriptPath) {
+          args.unshift(startScriptPath);
+        }
+
         debug('spawn args %o %o', args, _.omit(stdioOptions, 'env'));
+        debug('spawning Cypress with executable: %s', executable);
         const child = cp.spawn(executable, args, stdioOptions);
 
         function resolveOn(event) {

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/download.js

@@ -79,8 +79,8 @@ const getCA = () => {
 const prepend = urlPath => {
   const endpoint = url.resolve(getBaseUrl(), urlPath);
   const platform = os.platform();
-  const pathTemplate = util.getEnv('CYPRESS_DOWNLOAD_PATH_TEMPLATE');
-  return pathTemplate ? pathTemplate.replace('${endpoint}', endpoint).replace('${platform}', platform).replace('${arch}', arch()) : `${endpoint}?platform=${platform}&arch=${arch()}`;
+  const pathTemplate = util.getEnv('CYPRESS_DOWNLOAD_PATH_TEMPLATE', true);
+  return pathTemplate ? pathTemplate.replace(/\\?\$\{endpoint\}/, endpoint).replace(/\\?\$\{platform\}/, platform).replace(/\\?\$\{arch\}/, arch()) : `${endpoint}?platform=${platform}&arch=${arch()}`;
 };
 
 const getUrl = version => {

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.slice(0, 8)].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.4",
   "main": "index.js",
   "scripts": {
     "postinstall": "node index.js --exec install",
@@ -39,7 +39,7 @@
     "listr2": "^3.8.3",
     "lodash": "^4.17.21",
     "log-symbols": "^4.0.0",
-    "minimist": "^1.2.5",
+    "minimist": "^1.2.6",
     "ospath": "^1.2.2",
     "pretty-bytes": "^5.6.0",
     "proxy-from-env": "1.0.0",
@@ -64,6 +64,12 @@
     "node": ">=12.0.0"
   },
   "types": "types",
+  "buildInfo": {
+    "commitBranch": "develop",
+    "commitSha": "6934c0398fea92cc05714b18f21f7f06645a0b70",
+    "commitDate": "2022-04-11T17:25:33.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"
   ]
-}
+}

package/types/cypress-eventemitter.d.ts

@@ -30,4 +30,4 @@ interface NodeEventEmitter {
 
 // We use the Buffer class for dealing with binary data, especially around the
 // selectFile interface.
-type BufferType = import("buffer/").Buffer
+type BufferType = typeof import("buffer/").Buffer

package/types/cypress-npm-api.d.ts

@@ -36,7 +36,7 @@ declare namespace CypressCommandLine {
    */
   interface CypressRunOptions extends CypressCommonOptions {
     /**
-     * Specify different browser to run tests in, either by name or by filesystem path
+     * Specify browser to run tests in, either by name or by filesystem path
     */
     browser: string
     /**
@@ -118,7 +118,7 @@ declare namespace CypressCommandLine {
    */
   interface CypressOpenOptions extends CypressCommonOptions {
     /**
-     * Specify a filesystem path to a custom browser
+     * Specify browser to run tests in, either by name or by filesystem path
      */
     browser: string
     /**

package/types/cypress.d.ts

@@ -24,9 +24,15 @@ declare namespace Cypress {
   interface CommandFn<T extends keyof ChainableMethods> {
     (this: Mocha.Context, ...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]> | void
   }
+  interface CommandFns {
+    [name: string]: (this: Mocha.Context, ...args: any) => any
+  }
   interface CommandFnWithSubject<T extends keyof ChainableMethods, S> {
     (this: Mocha.Context, prevSubject: S, ...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]> | void
   }
+  interface CommandFnsWithSubject<S> {
+    [name: string]: (this: Mocha.Context, prevSubject: S, ...args: any) => any
+  }
   interface CommandOriginalFn<T extends keyof ChainableMethods> extends CallableFunction {
     (...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]>
   }
@@ -467,6 +473,14 @@ declare namespace Cypress {
       add<T extends keyof Chainable, S extends PrevSubject>(
           name: T, options: CommandOptions & { prevSubject: S[] }, fn: CommandFnWithSubject<T, PrevSubjectMap<void>[S]>,
       ): void
+      addAll<T extends keyof Chainable>(fns: CommandFns): void
+      addAll<T extends keyof Chainable>(options: CommandOptions & {prevSubject: false}, fns: CommandFns): void
+      addAll<T extends keyof Chainable, S extends PrevSubject>(
+          options: CommandOptions & { prevSubject: true | S | ['optional'] }, fns: CommandFnsWithSubject<PrevSubjectMap[S]>,
+      ): void
+      addAll<T extends keyof Chainable, S extends PrevSubject>(
+          options: CommandOptions & { prevSubject: S[] }, fns: CommandFnsWithSubject<PrevSubjectMap<void>[S]>,
+      ): void
       overwrite<T extends keyof Chainable>(name: T, fn: CommandFnWithOriginalFn<T>): void
       overwrite<T extends keyof Chainable, S extends PrevSubject>(name: T, fn: CommandFnWithOriginalFnAndSubject<T, PrevSubjectMap[S]>): void
     }
@@ -2341,7 +2355,7 @@ declare namespace Cypress {
   type Agent<T extends sinon.SinonSpy> = SinonSpyAgent<T> & T
 
   interface CookieDefaults {
-    preserve: string | string[] | RegExp | ((cookie: any) => boolean)
+    preserve: string | string[] | RegExp | ((cookie: Cookie) => boolean)
   }
 
   interface Failable {
@@ -3347,7 +3361,7 @@ declare namespace Cypress {
     (chainer: 'be.a', type: string): Chainable<Subject>
     /**
      * Asserts that the target is a number or a date greater than the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(6).should('be.above', 5)
      * @see http://chaijs.com/api/bdd/#method_above
@@ -3367,7 +3381,7 @@ declare namespace Cypress {
     (chainer: 'be.an', value: string): Chainable<Subject>
     /**
      * Asserts that the target is a number or a `n` date greater than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(6).should('be.at.least', 5)
      * @see http://chaijs.com/api/bdd/#method_least
@@ -3376,7 +3390,7 @@ declare namespace Cypress {
     (chainer: 'be.at.least', value: number | Date): Chainable<Subject>
     /**
      * Asserts that the target is a number or a `n` date less than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(4).should('be.below', 5)
      * @see http://chaijs.com/api/bdd/#method_below
@@ -3392,7 +3406,7 @@ declare namespace Cypress {
      */
     (chainer: 'be.arguments'): Chainable<Subject>
     /**
-     * Asserts that the target is a number that’s within a given +/- `delta` range of the given number `expected`. However, it’s often best to assert that the target is equal to its expected value.
+     * Asserts that the target is a number that’s within a given +/- `delta` range of the given number `expected`. However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(5.1).should('be.approximately', 5, 0.5)
      * @alias closeTo
@@ -3401,7 +3415,7 @@ declare namespace Cypress {
      */
     (chainer: 'be.approximately', value: number, delta: number): Chainable<Subject>
     /**
-     * Asserts that the target is a number that’s within a given +/- `delta` range of the given number `expected`. However, it’s often best to assert that the target is equal to its expected value.
+     * Asserts that the target is a number that’s within a given +/- `delta` range of the given number `expected`. However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(5.1).should('be.closeTo', 5, 0.5)
      * @see http://chaijs.com/api/bdd/#method_closeto
@@ -3435,7 +3449,7 @@ declare namespace Cypress {
     (chainer: 'be.false'): Chainable<Subject>
     /**
      * Asserts that the target is a number or a date greater than the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(6).should('be.greaterThan', 5)
      * @alias above
@@ -3445,7 +3459,7 @@ declare namespace Cypress {
     (chainer: 'be.greaterThan', value: number): Chainable<Subject>
     /**
      * Asserts that the target is a number or a date greater than the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(6).should('be.gt', 5)
      * @alias above
@@ -3455,7 +3469,7 @@ declare namespace Cypress {
     (chainer: 'be.gt', value: number): Chainable<Subject>
     /**
      * Asserts that the target is a number or a `n` date greater than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(6).should('be.gte', 5)
      * @alias least
@@ -3465,7 +3479,7 @@ declare namespace Cypress {
     (chainer: 'be.gte', value: number): Chainable<Subject>
     /**
      * Asserts that the target is a number or a `n` date less than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(4).should('be.lessThan', 5)
      * @alias below
@@ -3475,7 +3489,7 @@ declare namespace Cypress {
     (chainer: 'be.lessThan', value: number): Chainable<Subject>
     /**
      * Asserts that the target is a number or a `n` date less than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(4).should('be.lt', 5)
      * @alias below
@@ -3485,7 +3499,7 @@ declare namespace Cypress {
     (chainer: 'be.lt', value: number): Chainable<Subject>
     /**
      * Asserts that the target is a number or a date less than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(4).should('be.lte', 5)
      * @alias most
@@ -3494,7 +3508,7 @@ declare namespace Cypress {
      */
     (chainer: 'be.lte', value: number): Chainable<Subject>
     /**
-     * Asserts that the target is loosely (`==`) equal to `true`. However, it’s often best to assert that the target is strictly (`===`) or deeply equal to its expected value.
+     * Asserts that the target is loosely (`==`) equal to `true`. However, it's often best to assert that the target is strictly (`===`) or deeply equal to its expected value.
      * @example
      *    cy.wrap(1).should('be.ok')
      * @see http://chaijs.com/api/bdd/#method_ok
@@ -3535,7 +3549,7 @@ declare namespace Cypress {
     (chainer: 'be.NaN'): Chainable<Subject>
     /**
      * Asserts that the target is a number or a date greater than or equal to the given number or date `start`, and less than or equal to the given number or date `finish` respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(6).should('be.within', 5, 10)
      * @see http://chaijs.com/api/bdd/#method_within
@@ -3544,8 +3558,8 @@ declare namespace Cypress {
     (chainer: 'be.within', start: number, end: number): Chainable<Subject>
     (chainer: 'be.within', start: Date, end: Date): Chainable<Subject>
     /**
-     * When one argument is provided, `.change` asserts that the given function `subject` returns a different value when it’s invoked before the target function compared to when it’s invoked afterward.
-     * However, it’s often best to assert that `subject` is equal to its expected value.
+     * When one argument is provided, `.change` asserts that the given function `subject` returns a different value when it's invoked before the target function compared to when it's invoked afterward.
+     * However, it's often best to assert that `subject` is equal to its expected value.
      * @example
      *    let dots = ''
      *    function addDot() { dots += '.' }
@@ -3575,8 +3589,8 @@ declare namespace Cypress {
      */
     (chainer: 'contain', value: any): Chainable<Subject>
     /**
-     * When one argument is provided, `.decrease` asserts that the given function `subject` returns a lesser number when it’s invoked after invoking the target function compared to when it’s invoked beforehand.
-     * `.decrease` also causes all `.by` assertions that follow in the chain to assert how much lesser of a number is returned. It’s often best to assert that the return value decreased by the expected amount, rather than asserting it decreased by any amount.
+     * When one argument is provided, `.decrease` asserts that the given function `subject` returns a lesser number when it's invoked after invoking the target function compared to when it's invoked beforehand.
+     * `.decrease` also causes all `.by` assertions that follow in the chain to assert how much lesser of a number is returned. it's often best to assert that the return value decreased by the expected amount, rather than asserting it decreased by any amount.
      * @example
      *    let val = 1
      *    function subtractTwo() { val -= 2 }
@@ -3606,7 +3620,7 @@ declare namespace Cypress {
      */
     (chainer: 'deep.equal', value: Subject): Chainable<Subject>
     /**
-     * Asserts that the target is not strictly (`===`) equal to either `null` or `undefined`. However, it’s often best to assert that the target is equal to its expected value.
+     * Asserts that the target is not strictly (`===`) equal to either `null` or `undefined`. However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(1).should('exist')
      * @see http://chaijs.com/api/bdd/#method_exist
@@ -3825,10 +3839,10 @@ declare namespace Cypress {
      */
     (chainer: 'include.members' | 'include.ordered.members' | 'include.deep.ordered.members', value: any[]): Chainable<Subject>
     /**
-     * When one argument is provided, `.increase` asserts that the given function `subject` returns a greater number when it’s
-     * invoked after invoking the target function compared to when it’s invoked beforehand.
+     * When one argument is provided, `.increase` asserts that the given function `subject` returns a greater number when it's
+     * invoked after invoking the target function compared to when it's invoked beforehand.
      * `.increase` also causes all `.by` assertions that follow in the chain to assert how much greater of a number is returned.
-     * It’s often best to assert that the return value increased by the expected amount, rather than asserting it increased by any amount.
+     * it's often best to assert that the return value increased by the expected amount, rather than asserting it increased by any amount.
      *
      * When two arguments are provided, `.increase` asserts that the value of the given object `subject`’s `prop` property is greater after
      * invoking the target function compared to beforehand.
@@ -3875,7 +3889,7 @@ declare namespace Cypress {
     (chainer: 'satisfy', fn: (val: any) => boolean): Chainable<Subject>
     /**
      * When no arguments are provided, `.throw` invokes the target function and asserts that an error is thrown.
-     * When one argument is provided, and it’s a string, `.throw` invokes the target function and asserts that an error is thrown with a message that contains that string.
+     * When one argument is provided, and it's a string, `.throw` invokes the target function and asserts that an error is thrown with a message that contains that string.
      * @example
      *    function badFn() { throw new TypeError('Illegal salmon!') }
      *    cy.wrap(badFn).should('throw')
@@ -3887,7 +3901,7 @@ declare namespace Cypress {
     (chainer: 'throw', value?: string | RegExp): Chainable<Subject>
     /**
      * When no arguments are provided, `.throw` invokes the target function and asserts that an error is thrown.
-     * When one argument is provided, and it’s a string, `.throw` invokes the target function and asserts that an error is thrown with a message that contains that string.
+     * When one argument is provided, and it's a string, `.throw` invokes the target function and asserts that an error is thrown with a message that contains that string.
      * @example
      *    function badFn() { throw new TypeError('Illegal salmon!') }
      *    cy.wrap(badFn).should('throw')
@@ -3956,7 +3970,7 @@ declare namespace Cypress {
     (chainer: 'not.be.a', type: string): Chainable<Subject>
     /**
      * Asserts that the target is a not number or not a date greater than the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(6).should('not.be.above', 10)
      * @see http://chaijs.com/api/bdd/#method_above
@@ -3976,7 +3990,7 @@ declare namespace Cypress {
     (chainer: 'not.be.an', value: string): Chainable<Subject>
     /**
      * Asserts that the target is not a number or not a `n` date greater than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(6).should('not.be.at.least', 10)
      * @see http://chaijs.com/api/bdd/#method_least
@@ -3985,7 +3999,7 @@ declare namespace Cypress {
     (chainer: 'not.be.at.least', value: number | Date): Chainable<Subject>
     /**
      * Asserts that the target is not a number or not a `n` date less than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(4).should('not.be.below', 1)
      * @see http://chaijs.com/api/bdd/#method_below
@@ -4001,7 +4015,7 @@ declare namespace Cypress {
      */
     (chainer: 'not.be.arguments'): Chainable<Subject>
     /**
-     * Asserts that the target is a not number that’s within a given +/- `delta` range of the given number `expected`. However, it’s often best to assert that the target is equal to its expected value.
+     * Asserts that the target is a not number that’s within a given +/- `delta` range of the given number `expected`. However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(5.1).should('not.be.approximately', 6, 0.5)
      * @alias closeTo
@@ -4010,7 +4024,7 @@ declare namespace Cypress {
      */
     (chainer: 'not.be.approximately', value: number, delta: number): Chainable<Subject>
     /**
-     * Asserts that the target is not a number that’s within a given +/- `delta` range of the given number `expected`. However, it’s often best to assert that the target is equal to its expected value.
+     * Asserts that the target is not a number that’s within a given +/- `delta` range of the given number `expected`. However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(5.1).should('not.be.closeTo', 6, 0.5)
      * @see http://chaijs.com/api/bdd/#method_closeto
@@ -4044,7 +4058,7 @@ declare namespace Cypress {
     (chainer: 'not.be.false'): Chainable<Subject>
     /**
      * Asserts that the target is a not number or a date greater than the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(6).should('be.greaterThan', 7)
      * @alias above
@@ -4054,7 +4068,7 @@ declare namespace Cypress {
     (chainer: 'not.be.greaterThan', value: number): Chainable<Subject>
     /**
      * Asserts that the target is a not number or a date greater than the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(6).should('not.be.gt', 7)
      * @alias above
@@ -4064,7 +4078,7 @@ declare namespace Cypress {
     (chainer: 'not.be.gt', value: number): Chainable<Subject>
     /**
      * Asserts that the target is a not number or a `n` date greater than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(6).should('not.be.gte', 7)
      * @alias least
@@ -4074,7 +4088,7 @@ declare namespace Cypress {
     (chainer: 'not.be.gte', value: number): Chainable<Subject>
     /**
      * Asserts that the target is not a number or a `n` date less than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(4).should('not.be.lessThan', 3)
      * @alias below
@@ -4084,7 +4098,7 @@ declare namespace Cypress {
     (chainer: 'not.be.lessThan', value: number): Chainable<Subject>
     /**
      * Asserts that the target is not a number or a `n` date less than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(4).should('not.be.lt', 3)
      * @alias below
@@ -4094,7 +4108,7 @@ declare namespace Cypress {
     (chainer: 'not.be.lt', value: number): Chainable<Subject>
     /**
      * Asserts that the target is not a number or a date less than or equal to the given number or date n respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(4).should('not.be.lte', 3)
      * @alias most
@@ -4103,7 +4117,7 @@ declare namespace Cypress {
      */
     (chainer: 'not.be.lte', value: number): Chainable<Subject>
     /**
-     * Asserts that the target is not loosely (`==`) equal to `true`. However, it’s often best to assert that the target is strictly (`===`) or deeply equal to its expected value.
+     * Asserts that the target is not loosely (`==`) equal to `true`. However, it's often best to assert that the target is strictly (`===`) or deeply equal to its expected value.
      * @example
      *    cy.wrap(0).should('not.be.ok')
      * @see http://chaijs.com/api/bdd/#method_ok
@@ -4144,7 +4158,7 @@ declare namespace Cypress {
     (chainer: 'not.be.NaN'): Chainable<Subject>
     /**
      * Asserts that the target is not a number or a date greater than or equal to the given number or date `start`, and less than or equal to the given number or date `finish` respectively.
-     * However, it’s often best to assert that the target is equal to its expected value.
+     * However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(3).should('not.be.within', 5, 10)
      * @see http://chaijs.com/api/bdd/#method_within
@@ -4153,8 +4167,8 @@ declare namespace Cypress {
     (chainer: 'not.be.within', start: number, end: number): Chainable<Subject>
     (chainer: 'not.be.within', start: Date, end: Date): Chainable<Subject>
     /**
-     * When one argument is provided, `.change` asserts that the given function `subject` returns a different value when it’s invoked before the target function compared to when it’s invoked afterward.
-     * However, it’s often best to assert that `subject` is equal to its expected value.
+     * When one argument is provided, `.change` asserts that the given function `subject` returns a different value when it's invoked before the target function compared to when it's invoked afterward.
+     * However, it's often best to assert that `subject` is equal to its expected value.
      * @example
      *    let dots = ''
      *    function addDot() { dots += '.' }
@@ -4184,8 +4198,8 @@ declare namespace Cypress {
      */
     (chainer: 'not.contain', value: any): Chainable<Subject>
     /**
-     * When one argument is provided, `.decrease` asserts that the given function `subject` does not returns a lesser number when it’s invoked after invoking the target function compared to when it’s invoked beforehand.
-     * `.decrease` also causes all `.by` assertions that follow in the chain to assert how much lesser of a number is returned. It’s often best to assert that the return value decreased by the expected amount, rather than asserting it decreased by any amount.
+     * When one argument is provided, `.decrease` asserts that the given function `subject` does not returns a lesser number when it's invoked after invoking the target function compared to when it's invoked beforehand.
+     * `.decrease` also causes all `.by` assertions that follow in the chain to assert how much lesser of a number is returned. it's often best to assert that the return value decreased by the expected amount, rather than asserting it decreased by any amount.
      * @example
      *    let val = 1
      *    function subtractTwo() { val -= 2 }
@@ -4214,7 +4228,7 @@ declare namespace Cypress {
      */
     (chainer: 'not.deep.equal', value: Subject): Chainable<Subject>
     /**
-     * Asserts that the target is not strictly (`===`) equal to either `null` or `undefined`. However, it’s often best to assert that the target is equal to its expected value.
+     * Asserts that the target is not strictly (`===`) equal to either `null` or `undefined`. However, it's often best to assert that the target is equal to its expected value.
      * @example
      *    cy.wrap(null).should('not.exist')
      * @see http://chaijs.com/api/bdd/#method_exist
@@ -4409,10 +4423,10 @@ declare namespace Cypress {
      */
     (chainer: 'not.include.members' | 'not.include.ordered.members' | 'not.include.deep.ordered.members', value: any[]): Chainable<Subject>
     /**
-     * When one argument is provided, `.increase` asserts that the given function `subject` returns a greater number when it’s
-     * invoked after invoking the target function compared to when it’s invoked beforehand.
+     * When one argument is provided, `.increase` asserts that the given function `subject` returns a greater number when it's
+     * invoked after invoking the target function compared to when it's invoked beforehand.
      * `.increase` also causes all `.by` assertions that follow in the chain to assert how much greater of a number is returned.
-     * It’s often best to assert that the return value increased by the expected amount, rather than asserting it increased by any amount.
+     * it's often best to assert that the return value increased by the expected amount, rather than asserting it increased by any amount.
      *
      * When two arguments are provided, `.increase` asserts that the value of the given object `subject`’s `prop` property is greater after
      * invoking the target function compared to beforehand.
@@ -4459,7 +4473,7 @@ declare namespace Cypress {
     (chainer: 'not.satisfy', fn: (val: any) => boolean): Chainable<Subject>
     /**
      * When no arguments are provided, `.throw` invokes the target function and asserts that no error is thrown.
-     * When one argument is provided, and it’s a string, `.throw` invokes the target function and asserts that no error is thrown with a message that contains that string.
+     * When one argument is provided, and it's a string, `.throw` invokes the target function and asserts that no error is thrown with a message that contains that string.
      * @example
      *    function badFn() { console.log('Illegal salmon!') }
      *    cy.wrap(badFn).should('not.throw')
@@ -4471,7 +4485,7 @@ declare namespace Cypress {
     (chainer: 'not.throw', value?: string | RegExp): Chainable<Subject>
     /**
      * When no arguments are provided, `.throw` invokes the target function and asserts that no error is thrown.
-     * When one argument is provided, and it’s a string, `.throw` invokes the target function and asserts that no error is thrown with a message that contains that string.
+     * When one argument is provided, and it's a string, `.throw` invokes the target function and asserts that no error is thrown with a message that contains that string.
      * @example
      *    function badFn() { console.log('Illegal salmon!') }
      *    cy.wrap(badFn).should('not.throw')
@@ -5712,6 +5726,7 @@ declare namespace Cypress {
     name: string
     /** Override *name* for display purposes only */
     displayName: string
+    /** additional information to include in the log */
     message: any
     /** Set to false if you want to control the finishing of the command in the log yourself */
     autoEnd: boolean