cypress 3.0.3 → 3.1.3

package/lib/cli.js

@@ -21,6 +21,7 @@ function unknownOption(flag) {
   var type = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'option';
 
   if (this._allowUnknownOption) return;
+
   logger.error();
   logger.error('  error: unknown ' + type + ':', flag);
   logger.error();
@@ -35,7 +36,7 @@ var coerceFalse = function coerceFalse(arg) {
 };
 
 var parseOpts = function parseOpts(opts) {
-  opts = _.pick(opts, 'project', 'spec', 'reporter', 'reporterOptions', 'path', 'destination', 'port', 'env', 'cypressVersion', 'config', 'record', 'key', 'browser', 'detached', 'headed', 'global', 'dev', 'force', 'exit', 'cachePath', 'cacheList', 'cacheClear');
+  opts = _.pick(opts, 'project', 'spec', 'reporter', 'reporterOptions', 'path', 'destination', 'port', 'env', 'cypressVersion', 'config', 'record', 'key', 'browser', 'detached', 'headed', 'global', 'dev', 'force', 'exit', 'cachePath', 'cacheList', 'cacheClear', 'parallel', 'group', 'ciBuildId');
 
   if (opts.exit) {
     opts = _.omit(opts, 'exit');
@@ -59,14 +60,17 @@ var descriptions = {
   detached: 'runs Cypress application in detached mode',
   project: 'path to the project',
   global: 'force Cypress into global mode as if its globally installed',
-  version: 'Prints Cypress version',
+  version: 'prints Cypress version',
   headed: 'displays the Electron browser instead of running headlessly',
   dev: 'runs cypress in development and bypasses binary check',
   forceInstall: 'force install the Cypress binary',
   exit: 'keep the browser open after tests finish',
   cachePath: 'print the cypress binary cache path',
   cacheList: 'list the currently cached versions',
-  cacheClear: 'delete the Cypress binary cache'
+  cacheClear: 'delete the Cypress binary cache',
+  group: 'a named group for recorded runs in the Cypress dashboard',
+  parallel: 'enables concurrent runs and automatic load balancing of specs across multiple machines or processes',
+  ciBuildId: 'the unique identifier for a run on your CI provider. typically a "BUILD_ID" env var. this value is automatically detected for most CI providers'
 };
 
 var knownCommands = ['version', 'run', 'open', 'install', 'verify', '-v', '--version', 'help', '-h', '--help', 'cache'];
@@ -85,6 +89,7 @@ function includesVersion(args) {
 
 function showVersions() {
   debug('printing Cypress version');
+
   return require('./exec/versions').getVersions().then(function () {
     var versions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
 
@@ -112,7 +117,7 @@ module.exports = {
 
     program.option('-v, --version', text('version')).command('version').description(text('version')).action(showVersions);
 
-    program.command('run').usage('[options]').description('Runs Cypress tests from the CLI without the GUI').option('--record [bool]', text('record'), coerceFalse).option('--headed', text('headed')).option('-k, --key <record-key>', text('key')).option('-s, --spec <spec>', text('spec')).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-p, --port <port>', text('port')).option('-e, --env <env>', text('env')).option('-c, --config <config>', text('config')).option('-b, --browser <browser-name>', text('browser')).option('-P, --project <project-path>', text('project')).option('--no-exit', text('exit')).option('--dev', text('dev'), coerceFalse).action(function (opts) {
+    program.command('run').usage('[options]').description('Runs Cypress tests from the CLI without the GUI').option('--record [bool]', text('record'), coerceFalse).option('--headed', text('headed')).option('-k, --key <record-key>', text('key')).option('-s, --spec <spec>', text('spec')).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-p, --port <port>', text('port')).option('-e, --env <env>', text('env')).option('-c, --config <config>', text('config')).option('-b, --browser <browser-name>', text('browser')).option('-P, --project <project-path>', text('project')).option('--parallel', text('parallel')).option('--group <name>', text('group')).option('--ci-build-id <id>', text('ciBuildId')).option('--no-exit', text('exit')).option('--dev', text('dev'), coerceFalse).action(function (opts) {
       debug('running Cypress');
       require('./exec/run').start(parseOpts(opts)).then(util.exit).catch(util.logErrorExit1);
     });
@@ -130,6 +135,7 @@ module.exports = {
       var defaultOpts = { force: true, welcomeMessage: false };
       var parsedOpts = parseOpts(opts);
       var options = _.extend(parsedOpts, defaultOpts);
+
       require('./tasks/verify').start(options).catch(util.logErrorExit1);
     });
 
@@ -137,6 +143,7 @@ module.exports = {
       if (opts.command || !_.includes(['list', 'path', 'clear'], opts)) {
         unknownOption.call(this, 'cache ' + opts, 'sub-command');
       }
+
       cache[opts]();
     });
 
@@ -153,10 +160,12 @@ module.exports = {
     // Deprecated Catches
 
     var firstCommand = args[2];
+
     if (!_.includes(knownCommands, firstCommand)) {
       debug('unknown command %s', firstCommand);
       logger.error('Unknown command', '"' + firstCommand + '"');
       program.outputHelp();
+
       return util.exit(1);
     }
 
@@ -167,7 +176,9 @@ module.exports = {
       // so we have to manually catch '-v, --version'
       return showVersions();
     }
+
     debug('program parsing arguments');
+
     return program.parse(args);
   }
 };

package/lib/cypress.js

@@ -15,6 +15,7 @@ var cypressModuleApi = {
     var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
 
     options = util.normalizeModuleOptions(options);
+
     return _open.start(options);
   },
   run: function run() {
@@ -33,6 +34,7 @@ var cypressModuleApi = {
               message: 'Could not find Cypress test run results'
             };
           }
+
           return output;
         });
       });

package/lib/errors.js

@@ -3,7 +3,7 @@
 var _templateObject = _taggedTemplateLiteral(['\n    Search for an existing issue or open a GitHub issue at\n\n      ', '\n  '], ['\n    Search for an existing issue or open a GitHub issue at\n\n      ', '\n  ']),
     _templateObject2 = _taggedTemplateLiteral(['\n    \nPlease reinstall Cypress by running: ', '\n  '], ['\n    \\nPlease reinstall Cypress by running: ', '\n  ']),
     _templateObject3 = _taggedTemplateLiteral(['\n\n    Reasons this may happen:\n      \n    - node was installed as \'root\' or with \'sudo\'\n    - the cypress npm package as \'root\' or with \'sudo\'\n    \n    Please check that you have the appropriate user permissions.\n  '], ['\\n\n    Reasons this may happen:\n      \n    - node was installed as \'root\' or with \'sudo\'\n    - the cypress npm package as \'root\' or with \'sudo\'\n    \n    Please check that you have the appropriate user permissions.\n  ']),
-    _templateObject4 = _taggedTemplateLiteral(['\n\n    We expected the binary to be installed here: ', '\n \n    Reasons it may be missing:\n\n    - You\'re caching \'node_modules\' but are not caching this path: ', '\n    - You ran \'npm install\' at an earlier build step but did not persist: ', '\n\n    Properly caching the binary will fix this error and avoid downloading and unzipping Cypress.\n\n    Alternatively, you can run \'cypress install\' to download the binary again.\n\n    https://on.cypress.io/not-installed-ci-error\n  '], ['\\n\n    We expected the binary to be installed here: ', '\n \n    Reasons it may be missing:\n\n    - You\'re caching \'node_modules\' but are not caching this path: ', '\n    - You ran \'npm install\' at an earlier build step but did not persist: ', '\n\n    Properly caching the binary will fix this error and avoid downloading and unzipping Cypress.\n\n    Alternatively, you can run \'cypress install\' to download the binary again.\n\n    https://on.cypress.io/not-installed-ci-error\n  ']),
+    _templateObject4 = _taggedTemplateLiteral(['\n\n    We expected the binary to be installed here: ', '\n \n    Reasons it may be missing:\n\n    - You\'re caching \'node_modules\' but are not caching this path: ', '\n    - You ran \'npm install\' at an earlier build step but did not persist: ', '\n\n    Properly caching the binary will fix this error and avoid downloading and unzipping Cypress.\n\n    Alternatively, you can run \'cypress install\' to download the binary again.\n\n    ', '\n  '], ['\\n\n    We expected the binary to be installed here: ', '\n \n    Reasons it may be missing:\n\n    - You\'re caching \'node_modules\' but are not caching this path: ', '\n    - You ran \'npm install\' at an earlier build step but did not persist: ', '\n\n    Properly caching the binary will fix this error and avoid downloading and unzipping Cypress.\n\n    Alternatively, you can run \'cypress install\' to download the binary again.\n\n    ', '\n  ']),
     _templateObject5 = _taggedTemplateLiteral(['\n    There was a problem spawning Xvfb.\n\n    This is likely a problem with your system, permissions, or installation of Xvfb.\n    '], ['\n    There was a problem spawning Xvfb.\n\n    This is likely a problem with your system, permissions, or installation of Xvfb.\n    ']),
     _templateObject6 = _taggedTemplateLiteral(['\n    Install XVFB and run Cypress again.\n\n    Read our documentation on dependencies for more information:\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n    '], ['\n    Install XVFB and run Cypress again.\n\n    Read our documentation on dependencies for more information:\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n    ']),
     _templateObject7 = _taggedTemplateLiteral(['\n    This is usually caused by a missing library or dependency.\n\n    The error below should indicate which dependency is missing.\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n  '], ['\n    This is usually caused by a missing library or dependency.\n\n    The error below should indicate which dependency is missing.\n\n      ', '\n\n    If you are using Docker, we provide containers with all required dependencies installed.\n  ']),
@@ -42,7 +42,7 @@ var failedDownload = {
 
 var failedUnzip = {
   description: 'The Cypress App could not be unzipped.',
-  solution: stripIndent(_templateObject, issuesUrl)
+  solution: stripIndent(_templateObject, chalk.blue(issuesUrl))
 };
 
 var missingApp = function missingApp(binaryDir) {
@@ -62,7 +62,7 @@ var binaryNotExecutable = function binaryNotExecutable(executable) {
 var notInstalledCI = function notInstalledCI(executable) {
   return {
     description: 'The cypress npm package is installed, but the Cypress binary is missing.',
-    solution: stripIndent(_templateObject4, chalk.cyan(executable), util.getCacheDir(), util.getCacheDir())
+    solution: stripIndent(_templateObject4, chalk.cyan(executable), util.getCacheDir(), util.getCacheDir(), chalk.blue('https://on.cypress.io/not-installed-ci-error'))
   };
 };
 
@@ -73,13 +73,13 @@ var nonZeroExitCodeXvfb = {
 
 var missingXvfb = {
   description: 'Your system is missing the dependency: XVFB',
-  solution: stripIndent(_templateObject6, requiredDependenciesUrl)
+  solution: stripIndent(_templateObject6, chalk.blue(requiredDependenciesUrl))
 };
 
 var missingDependency = {
   description: 'Cypress failed to start.',
   // this message is too Linux specific
-  solution: stripIndent(_templateObject7, requiredDependenciesUrl)
+  solution: stripIndent(_templateObject7, chalk.blue(requiredDependenciesUrl))
 };
 
 var invalidCacheDirectory = {
@@ -94,7 +94,7 @@ var versionMismatch = {
 
 var unexpected = {
   description: 'An unexpected error occurred while verifying the Cypress executable.',
-  solution: stripIndent(_templateObject8, docsUrl, issuesUrl)
+  solution: stripIndent(_templateObject8, chalk.blue(docsUrl), chalk.blue(issuesUrl))
 };
 
 var removed = {
@@ -111,6 +111,7 @@ var removed = {
 var CYPRESS_RUN_BINARY = {
   notValid: function notValid(value) {
     var properFormat = '**/' + state.getPlatformExecutable();
+
     return {
       description: 'Could not run binary set by environment variable CYPRESS_RUN_BINARY=' + value,
       solution: 'Ensure the environment variable is a path to the Cypress binary, matching ' + properFormat
@@ -158,6 +159,7 @@ function formErrorText(info, msg) {
 
 var raise = function raise(text) {
   var err = new Error(text);
+
   err.known = true;
   throw err;
 };

package/lib/exec/run.js

@@ -68,6 +68,18 @@ var processRunOptions = function processRunOptions() {
     args.push('--record', options.record);
   }
 
+  if (options.parallel) {
+    args.push('--parallel');
+  }
+
+  if (options.group) {
+    args.push('--group', options.group);
+  }
+
+  if (options.ciBuildId) {
+    args.push('--ci-build-id', options.ciBuildId);
+  }
+
   if (options.outputPath) {
     args.push('--output-path', options.outputPath);
   }

package/lib/exec/spawn.js

@@ -80,6 +80,7 @@ module.exports = {
         }
 
         var overrides = util.getEnvOverrides();
+        var node11WindowsFix = isPlatform('win32');
 
         debug('spawning Cypress with executable: %s', executable);
         debug('spawn forcing env overrides %o', overrides);
@@ -93,8 +94,12 @@ module.exports = {
         // also figure out whether we should force stdout and stderr into thinking
         // it is a tty as opposed to a pipe.
         options.env = _.extend({}, options.env, overrides);
+        if (node11WindowsFix) {
+          options = _.extend({}, options, { windowsHide: false });
+        }
 
         var child = cp.spawn(executable, args, options);
+
         child.on('close', resolve);
         child.on('error', reject);
 
@@ -141,8 +146,8 @@ module.exports = {
 
     if (needsXvfb) {
       return xvfb.start().then(userFriendlySpawn).finally(xvfb.stop);
-    } else {
-      return userFriendlySpawn();
     }
+
+    return userFriendlySpawn();
   }
 };

package/lib/exec/versions.js

@@ -16,10 +16,12 @@ var getVersions = function getVersions() {
 
     if (util.getEnv('CYPRESS_RUN_BINARY')) {
       var envBinaryPath = path.resolve(util.getEnv('CYPRESS_RUN_BINARY'));
+
       return state.parseRealPlatformBinaryFolderAsync(envBinaryPath).then(function (envBinaryDir) {
         if (!envBinaryDir) {
           return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))();
         }
+
         debug('CYPRESS_RUN_BINARY has binaryDir:', envBinaryDir);
 
         return envBinaryDir;
@@ -27,6 +29,7 @@ var getVersions = function getVersions() {
         return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))(err.message);
       });
     }
+
     return state.getBinaryDir();
   }).then(state.getBinaryPkgVersionAsync).then(function (binaryVersion) {
     return {

package/lib/exec/xvfb.js

@@ -27,6 +27,7 @@ module.exports = {
 
   start: function start() {
     debug('Starting XVFB');
+
     return xvfb.startAsync().catch({ nonZeroExitCode: true }, throwFormErrorText(errors.nonZeroExitCodeXvfb)).catch(function (err) {
       if (err.known) {
         throw err;
@@ -37,6 +38,7 @@ module.exports = {
   },
   stop: function stop() {
     debug('Stopping XVFB');
+
     return xvfb.stopAsync();
   },
   isNeeded: function isNeeded() {
@@ -48,6 +50,7 @@ module.exports = {
   verify: function verify() {
     return xvfb.startAsync().then(R.T).catch(function (err) {
       debug('Could not verify xvfb: %s', err.message);
+
       return false;
     }).finally(xvfb.stopAsync);
   }

package/lib/logger.js

@@ -24,6 +24,7 @@ var warn = function warn() {
   }
 
   if (logLevel() === 'silent') return;
+
   logs.push(messages.join(' '));
   console.log(chalk.yellow.apply(chalk, messages)); // eslint-disable-line no-console
 };
@@ -36,6 +37,7 @@ var log = function log() {
   }
 
   if (logLevel() === 'silent' || logLevel() === 'warn') return;
+
   logs.push(messages.join(' '));
   (_console = console).log.apply(_console, messages); // eslint-disable-line no-console
 };
@@ -44,6 +46,7 @@ var log = function log() {
 // on each one to allow easy unit testing for specific message
 var logLines = function logLines(text) {
   var lines = text.split('\n');
+
   R.forEach(log, lines);
 };
 

package/lib/tasks/cache.js

@@ -7,6 +7,7 @@ var util = require('../util');
 
 var path = function path() {
   logger.log(state.getCacheDir());
+
   return undefined;
 };
 

package/lib/tasks/download.js

@@ -27,20 +27,37 @@ var _require2 = require('../errors'),
 var fs = require('../fs');
 var util = require('../util');
 
-var baseUrl = 'https://download.cypress.io/';
+var defaultBaseUrl = 'https://download.cypress.io/';
+
+var getBaseUrl = function getBaseUrl() {
+  if (util.getEnv('CYPRESS_DOWNLOAD_MIRROR')) {
+    var baseUrl = util.getEnv('CYPRESS_DOWNLOAD_MIRROR');
+
+    if (!baseUrl.endsWith('/')) {
+      baseUrl += '/';
+    }
+
+    return baseUrl;
+  }
+
+  return defaultBaseUrl;
+};
 
 var prepend = function prepend(urlPath) {
-  var endpoint = url.resolve(baseUrl, urlPath);
+  var endpoint = url.resolve(getBaseUrl(), urlPath);
   var platform = os.platform();
   var arch = os.arch();
+
   return endpoint + '?platform=' + platform + '&arch=' + arch;
 };
 
 var getUrl = function getUrl(version) {
   if (is.url(version)) {
     debug('version is already an url', version);
+
     return version;
   }
+
   return version ? prepend('desktop/' + version) : prepend('desktop');
 };
 
@@ -50,6 +67,7 @@ var statusMessage = function statusMessage(err) {
 
 var prettyDownloadErr = function prettyDownloadErr(err, version) {
   var msg = stripIndent(_templateObject, getUrl(version), statusMessage(err));
+
   debug(msg);
 
   return throwFormErrorText(errors.failedDownload)(msg);
@@ -73,6 +91,7 @@ var downloadFromUrl = function downloadFromUrl(_ref) {
       url: url,
       followRedirect: function followRedirect(response) {
         var version = response.headers['x-version'];
+
         debug('redirect version:', version);
         if (version) {
           // set the version in options if we have one.
@@ -131,6 +150,7 @@ var start = function start(_ref2) {
   if (!downloadDestination) {
     la(is.unemptyString(downloadDestination), 'missing download dir', _arguments);
   }
+
   if (!progress) {
     progress = { onProgress: function onProgress() {
         return {};
@@ -138,6 +158,7 @@ var start = function start(_ref2) {
   }
 
   var url = getUrl(version);
+
   progress.throttle = 100;
 
   debug('needed Cypress version: %s', version);

package/lib/tasks/install.js

@@ -83,6 +83,7 @@ var downloadAndUnzip = function downloadAndUnzip(_ref) {
 
       return download.start({ version: version, downloadDestination: downloadDestination, progress: progress }).then(function (redirectVersion) {
         if (redirectVersion) version = redirectVersion;
+
         debug('finished downloading file: ' + downloadDestination);
       }).then(function () {
         // save the download destination for unzipping
@@ -100,6 +101,7 @@ var downloadAndUnzip = function downloadAndUnzip(_ref) {
 
       var cleanup = function cleanup() {
         debug('removing zip file %s', downloadDestination);
+
         return fs.removeAsync(downloadDestination);
       };
 
@@ -136,18 +138,21 @@ var start = function start() {
 
   var pkgVersion = util.pkgVersion();
   var needVersion = pkgVersion;
+
   debug('version in package.json is', needVersion);
 
   // let this environment variable reset the binary version we need
   if (util.getEnv('CYPRESS_INSTALL_BINARY')) {
 
     var envVarVersion = util.getEnv('CYPRESS_INSTALL_BINARY');
+
     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();
+
       return Promise.resolve();
     }
 
@@ -162,6 +167,7 @@ var start = function start() {
 
   if (util.getEnv('CYPRESS_CACHE_FOLDER')) {
     var envCache = util.getEnv('CYPRESS_CACHE_FOLDER');
+
     logger.log(stripIndent(_templateObject4, chalk.yellow('Note:'), chalk.cyan(envCache)));
     logger.log();
   }
@@ -178,6 +184,7 @@ var start = function start() {
 
     if (!binaryVersion) {
       debug('no binary installed under cli version');
+
       return true;
     }
 
@@ -189,12 +196,14 @@ var start = function start() {
 
     if (options.force) {
       debug('performing force install over existing binary');
+
       return true;
     }
 
     if (binaryVersion === needVersion || !util.isSemver(needVersion)) {
       // our version matches, tell the user this is a noop
       alreadyInstalledMsg();
+
       return false;
     }
 
@@ -203,6 +212,7 @@ var start = function start() {
     // noop if we've been told not to download
     if (!shouldInstall) {
       debug('Not downloading or installing binary');
+
       return;
     }
 
@@ -218,6 +228,7 @@ var start = function start() {
       }
 
       var possibleFile = util.formAbsolutePath(needVersion);
+
       debug('checking local file', possibleFile, 'cwd', process.cwd());
 
       return fs.pathExistsAsync(possibleFile).then(function (exists) {
@@ -226,15 +237,18 @@ var start = function start() {
         if (exists && path.extname(possibleFile) === '.zip') {
           return possibleFile;
         }
+
         return false;
       });
     }).then(function (pathToLocalFile) {
       if (pathToLocalFile) {
         var absolutePath = path.resolve(needVersion);
+
         debug('found local file at', absolutePath);
         debug('skipping download');
 
         var rendererOptions = getRendererOptions();
+
         return new Listr([unzipTask({
           progress: {
             throttle: 100,
@@ -254,6 +268,7 @@ var start = function start() {
       debug('preparing to download and unzip version ', needVersion, 'to path', installDir);
 
       var downloadDir = os.tmpdir();
+
       return downloadAndUnzip({ version: needVersion, installDir: installDir, downloadDir: downloadDir });
     })
     // delay 1 sec for UX, unless we are testing
@@ -272,6 +287,7 @@ var unzipTask = function unzipTask(_ref2) {
       installDir = _ref2.installDir,
       progress = _ref2.progress,
       rendererOptions = _ref2.rendererOptions;
+
   return {
     title: util.titleize('Unzipping Cypress'),
     task: function task(ctx, _task3) {
@@ -302,9 +318,11 @@ var progessify = function progessify(task, title) {
 // the default
 var getRendererOptions = function getRendererOptions() {
   var renderer = util.isCi() ? verbose : 'default';
+
   if (logger.logLevel() === 'silent') {
     renderer = 'silent';
   }
+
   return {
     renderer: renderer
   };

package/lib/tasks/state.js

@@ -10,6 +10,7 @@ var util = require('../util');
 
 var getPlatformExecutable = function getPlatformExecutable() {
   var platform = os.platform();
+
   switch (platform) {
     case 'darwin':
       return 'Contents/MacOS/Cypress';
@@ -25,6 +26,7 @@ var getPlatformExecutable = function getPlatformExecutable() {
 
 var getPlatFormBinaryFolder = function getPlatFormBinaryFolder() {
   var platform = os.platform();
+
   switch (platform) {
     case 'darwin':
       return 'Cypress.app';
@@ -40,6 +42,7 @@ var getPlatFormBinaryFolder = function getPlatFormBinaryFolder() {
 
 var getBinaryPkgPath = function getBinaryPkgPath(binaryDir) {
   var platform = os.platform();
+
   switch (platform) {
     case 'darwin':
       return path.join(binaryDir, 'Contents', 'Resources', 'app', 'package.json');
@@ -70,11 +73,14 @@ var getVersionDir = function getVersionDir() {
 
 var getCacheDir = function getCacheDir() {
   var cache_directory = util.getCacheDir();
+
   if (util.getEnv('CYPRESS_CACHE_FOLDER')) {
     var envVarCacheDir = util.getEnv('CYPRESS_CACHE_FOLDER');
+
     debug('using environment variable CYPRESS_CACHE_FOLDER %s', envVarCacheDir);
     cache_directory = path.resolve(envVarCacheDir);
   }
+
   return cache_directory;
 };
 
@@ -84,9 +90,11 @@ var parseRealPlatformBinaryFolderAsync = function parseRealPlatformBinaryFolderA
     if (!realPath.toString().endsWith(getPlatformExecutable())) {
       return false;
     }
+
     if (os.platform() === 'darwin') {
       return path.resolve(realPath, '..', '..', '..');
     }
+
     return path.resolve(realPath, '..');
   });
 };
@@ -102,6 +110,7 @@ var getBinaryStatePath = function getBinaryStatePath(binaryDir) {
 var getBinaryStateContentsAsync = function getBinaryStateContentsAsync(binaryDir) {
   return fs.readJsonAsync(getBinaryStatePath(binaryDir)).catch({ code: 'ENOENT' }, SyntaxError, function () {
     debug('could not read binary_state.json file');
+
     return {};
   });
 };
@@ -129,11 +138,14 @@ var getPathToExecutable = function getPathToExecutable(binaryDir) {
 
 var getBinaryPkgVersionAsync = function getBinaryPkgVersionAsync(binaryDir) {
   var pathToPackageJson = getBinaryPkgPath(binaryDir);
+
   debug('Reading binary package.json from:', pathToPackageJson);
+
   return fs.pathExistsAsync(pathToPackageJson).then(function (exists) {
     if (!exists) {
       return null;
     }
+
     return fs.readJsonAsync(pathToPackageJson).get('version');
   });
 };

package/lib/tasks/unzip.js

@@ -35,6 +35,7 @@ var unzip = function unzip(_ref) {
     return new Promise(function (resolve, reject) {
       return yauzl.open(zipFilePath, function (err, zipFile) {
         if (err) return reject(err);
+
         // debug('zipfile.paths:', zipFile)
         // zipFile.on('entry', debug)
         // debug(zipFile.readEntry())
@@ -90,12 +91,9 @@ var unzip = function unzip(_ref) {
           var copyingFileRe = /^copying file/;
 
           var sp = cp.spawn('ditto', ['-xkV', zipFilePath, installDir]);
-          sp.on('error', function () {
-            return (
-              // f-it just unzip with node
-              unzipWithNode()
-            );
-          });
+
+          // f-it just unzip with node
+          sp.on('error', unzipWithNode);
 
           sp.on('close', function (code) {
             if (code === 0) {
@@ -139,13 +137,16 @@ var start = function start(_ref2) {
       progress = _ref2.progress;
 
   la(is.unemptyString(installDir), 'missing installDir');
-  if (!progress) progress = { onProgress: function onProgress() {
-      return {};
-    } };
+  if (!progress) {
+    progress = { onProgress: function onProgress() {
+        return {};
+      } };
+  }
 
   return fs.pathExists(installDir).then(function (exists) {
     if (exists) {
       debug('removing existing unzipped binary', installDir);
+
       return fs.removeAsync(installDir);
     }
   }).then(function () {

package/lib/tasks/verify.js

@@ -32,7 +32,9 @@ var state = require('./state');
 
 var checkExecutable = function checkExecutable(binaryDir) {
   var executable = state.getPathToExecutable(binaryDir);
+
   debug('checking if executable exists', executable);
+
   return util.isExecutableAsync(executable).then(function (isExecutable) {
     debug('Binary is executable? :', isExecutable);
     if (!isExecutable) {
@@ -42,6 +44,7 @@ var checkExecutable = function checkExecutable(binaryDir) {
     if (util.isCi()) {
       return throwFormErrorText(errors.notInstalledCI(executable))();
     }
+
     return throwFormErrorText(errors.missingApp(binaryDir))(stripIndent(_templateObject, chalk.cyan(executable)));
   });
 };
@@ -49,29 +52,35 @@ var checkExecutable = function checkExecutable(binaryDir) {
 var runSmokeTest = function runSmokeTest(binaryDir) {
   debug('running smoke test');
   var cypressExecPath = state.getPathToExecutable(binaryDir);
+
   debug('using Cypress executable %s', cypressExecPath);
 
   var onXvfbError = function onXvfbError(err) {
     debug('caught xvfb error %s', err.message);
+
     return throwFormErrorText(errors.missingXvfb)('Caught error trying to run XVFB: "' + err.message + '"');
   };
 
   var onSmokeTestError = function onSmokeTestError(err) {
     debug('Smoke test failed:', err);
+
     return throwFormErrorText(errors.missingDependency)(err.stderr || err.message);
   };
 
   var needsXvfb = xvfb.isNeeded();
+
   debug('needs XVFB?', needsXvfb);
 
   var spawn = function spawn() {
     var random = _.random(0, 1000);
     var args = ['--smoke-test', '--ping=' + random];
     var smokeTestCommand = cypressExecPath + ' ' + args.join(' ');
+
     debug('smoke test command:', smokeTestCommand);
 
     return Promise.resolve(util.exec(cypressExecPath, args)).catch(onSmokeTestError).then(function (result) {
       var smokeTestReturned = result.stdout;
+
       debug('smoke test stdout "%s"', smokeTestReturned);
 
       if (!util.stdoutLineMatches(String(random), smokeTestReturned)) {
@@ -85,9 +94,9 @@ var runSmokeTest = function runSmokeTest(binaryDir) {
     return xvfb.start().catch(onXvfbError).then(spawn).finally(function () {
       return xvfb.stop().catch(onXvfbError);
     });
-  } else {
-    return spawn();
   }
+
+  return spawn();
 };
 
 function testBinary(version, binaryDir) {
@@ -101,6 +110,7 @@ function testBinary(version, binaryDir) {
   // the verbose renderer else use
   // the default
   var renderer = util.isCi() ? verbose : 'default';
+
   if (logger.logLevel() === 'silent') renderer = 'silent';
 
   var rendererOptions = {
@@ -111,11 +121,13 @@ function testBinary(version, binaryDir) {
     title: util.titleize('Verifying Cypress can run', chalk.gray(binaryDir)),
     task: function task(ctx, _task) {
       debug('clearing out the verified version');
+
       return state.clearBinaryStateAsync(binaryDir).then(function () {
         return Promise.all([runSmokeTest(binaryDir), Promise.resolve().delay(1500)] // good user experience
         );
       }).then(function () {
         debug('write verified: true');
+
         return state.writeBinaryVerifiedAsync(true, binaryDir);
       }).then(function () {
         util.setTaskTitle(_task, util.titleize(chalk.green('Verified Cypress!'), chalk.gray(binaryDir)), rendererOptions.renderer);
@@ -134,6 +146,7 @@ var maybeVerify = function maybeVerify(installedVersion, binaryDir) {
     debug('is Verified ?', isVerified);
 
     var shouldVerify = !isVerified;
+
     // force verify if options.force
     if (options.force) {
       debug('force verify');
@@ -166,6 +179,7 @@ var start = function start() {
 
   var parseBinaryEnvVar = function parseBinaryEnvVar() {
     var envBinaryPath = util.getEnv('CYPRESS_RUN_BINARY');
+
     debug('CYPRESS_RUN_BINARY exists, =', envBinaryPath);
     logger.log(stripIndent(_templateObject4, chalk.yellow('Note:'), chalk.white('CYPRESS_RUN_BINARY='), chalk.cyan(envBinaryPath)));
     logger.log();
@@ -181,6 +195,7 @@ var start = function start() {
       if (!envBinaryDir) {
         return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))();
       }
+
       debug('CYPRESS_RUN_BINARY has binaryDir:', envBinaryDir);
 
       binaryDir = envBinaryDir;
@@ -204,6 +219,7 @@ var start = function start() {
 
     if (!binaryVersion) {
       debug('no Cypress binary found for cli version ', packageVersion);
+
       return throwFormErrorText(errors.missingApp(binaryDir))('\n      Cannot read binary version from: ' + chalk.cyan(state.getBinaryPkgPath(binaryDir)) + '\n    ');
     }
 

package/lib/util.js

@@ -35,6 +35,7 @@ function normalizeModuleOptions() {
 function stdoutLineMatches(expectedLine, stdout) {
   var lines = stdout.split('\n').map(R.trim);
   var lineMatches = R.equals(expectedLine);
+
   return lines.some(lineMatches);
 }
 
@@ -175,9 +176,9 @@ var util = {
         }).catch(function () {
           return os.release();
         });
-      } else {
-        return os.release();
       }
+
+      return os.release();
     });
   },
 
@@ -190,24 +191,32 @@ var util = {
     if (path.isAbsolute(filename)) {
       return filename;
     }
+
     return path.join(process.cwd(), '..', '..', filename);
   },
   getEnv: function getEnv(varName) {
     var envVar = process.env[varName];
     var configVar = process.env['npm_config_' + varName];
     var packageConfigVar = process.env['npm_package_config_' + varName];
+
     if (envVar) {
       debug('Using ' + varName + ' from environment variable');
+
       return envVar;
     }
+
     if (configVar) {
       debug('Using ' + varName + ' from npm config');
+
       return configVar;
     }
+
     if (packageConfigVar) {
       debug('Using ' + varName + ' from package.json config');
+
       return packageConfigVar;
     }
+
     return undefined;
   },
   getCacheDir: function getCacheDir() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress",
-  "version": "3.0.3",
+  "version": "3.1.3",
   "main": "index.js",
   "bin": {
     "cypress": "bin/cypress"
@@ -26,7 +26,7 @@
     "@types/bluebird": "3.5.18",
     "@types/chai": "4.0.8",
     "@types/chai-jquery": "1.1.35",
-    "@types/jquery": "3.2.16",
+    "@types/jquery": "3.3.6",
     "@types/lodash": "4.14.87",
     "@types/minimatch": "3.0.3",
     "@types/mocha": "2.2.44",
@@ -52,7 +52,7 @@
     "lodash": "4.17.10",
     "log-symbols": "2.2.0",
     "minimist": "1.2.0",
-    "progress": "1.1.8",
+    "moment": "2.22.2",
     "ramda": "0.24.1",
     "request": "2.87.0",
     "request-progress": "0.3.1",

package/types/index.d.ts

@@ -10,12 +10,14 @@
 /// <reference path="./blob-util.d.ts" />
 /// <reference path="./bluebird.d.ts" />
 /// <reference path="./minimatch.d.ts" />
+/// <reference path="./moment.d.ts" />
 
 /// <reference types="chai" />
 /// <reference types="chai-jquery" />
 /// <reference types="jquery" />
 /// <reference types="lodash" />
 /// <reference types="mocha" />
+/// <reference types="moment" />
 /// <reference types="sinon" />
 /// <reference types="sinon-chai" />
 
@@ -100,7 +102,7 @@ declare namespace Cypress {
      * @example
      *    const todaysDate = Cypress.moment().format("MMM DD, YYYY")
      */
-    moment: (...args: any[]) => any // perhaps we want to add moment as a dependency for types?
+    moment: Moment.MomentStatic
     /**
      * Cypress automatically includes Bluebird and exposes it as Cypress.Promise.
      *
@@ -1104,7 +1106,7 @@ declare namespace Cypress {
      *    cy.screenshot()
      *    cy.get(".post").screenshot()
      */
-    screenshot(options?: Partial<Loggable & Timeoutable>): Chainable<null>
+    screenshot(options?: Partial<Loggable & Timeoutable & ScreenshotOptions>): Chainable<null>
     /**
      * Take a screenshot of the application under test and the Cypress Command Log and save under given filename.
      *
@@ -1512,13 +1514,13 @@ declare namespace Cypress {
      *
      * @see https://on.cypress.io/wait
      */
-    wait(alias: string, options?: Partial<Loggable & Timeoutable>): Chainable<WaitXHR>
+    wait(alias: string, options?: Partial<Loggable & Timeoutable & TimeoutableXHR>): Chainable<WaitXHR>
     /**
      * Wait for list of XHR requests to complete.
      *
      * @see https://on.cypress.io/wait
      */
-    wait(alias: string[], options?: Partial<Loggable & Timeoutable>): Chainable<WaitXHR[]>
+    wait(alias: string[], options?: Partial<Loggable & Timeoutable & TimeoutableXHR>): Chainable<WaitXHR[]>
 
     /**
      * Get the window object of the page that is currently active.
@@ -1566,6 +1568,16 @@ declare namespace Cypress {
      *    })
      */
     wrap<E extends Node = HTMLElement>(element: E | JQuery<E>, options?: Partial<Loggable & Timeoutable>): Chainable<JQuery<E>>
+    /**
+     * Yield the element passed into `.wrap()` to the next command in the Cypress chain.
+     *
+     * @see https://on.cypress.io/wrap
+     * @example
+     *    cy.wrap(new Promise((resolve, reject) => {
+     *      setTimeout(resolve, 1000);
+     *    }).then(result => {})
+     */
+    wrap<F extends Promise<S>, S>(promise: F, options?: Partial<Loggable & Timeoutable>): Chainable<S>
     /**
      * Yields whatever is passed into `.wrap()` to the next command in the Cypress chain.
      *
@@ -1645,6 +1657,26 @@ declare namespace Cypress {
     timeout: number
   }
 
+  /**
+   * Options that control how long the Test Runner waits for an XHR request and response to succeed
+   */
+  interface TimeoutableXHR {
+    /**
+     * Time to wait for the request (ms)
+     *
+     * @default {@link Timeoutable#timeout}
+     * @see https://docs.cypress.io/guides/references/configuration.html#Timeouts
+     */
+    requestTimeout: number,
+    /**
+     * Time to wait for the response (ms)
+     *
+     * @default {@link Timeoutable#timeout}
+     * @see https://docs.cypress.io/guides/references/configuration.html#Timeouts
+     */
+    responseTimeout: number
+  }
+
   /**
    * Options to force an event, skipping Actionability check
    * @see https://docs.cypress.io/guides/core-concepts/interacting-with-elements.html#Actionability

package/types/moment.d.ts

@@ -0,0 +1,11 @@
+// Shim definition to export a namespace. Cypress is actually a global module
+// so import/export isn't allowed there. We import here and define a global module
+// so that Cypress can get and use the Moment type
+// tslint:disable-next-line:no-implicit-dependencies
+import * as moment from 'moment'
+export = Moment
+export as namespace Moment
+
+declare namespace Moment {
+  type MomentStatic = typeof moment
+}