cypress 5.4.0 → 5.5.0

package/lib/exec/info.js

@@ -1,67 +1,64 @@
 "use strict";
 
 /* eslint-disable no-console */
-var spawn = require('./spawn');
+const spawn = require('./spawn');
 
-var util = require('../util');
+const util = require('../util');
 
-var state = require('../tasks/state');
+const state = require('../tasks/state');
 
-var os = require('os');
+const os = require('os');
 
-var chalk = require('chalk');
+const chalk = require('chalk');
 
-var prettyBytes = require('pretty-bytes');
+const prettyBytes = require('pretty-bytes');
 
-var _ = require('lodash');
+const _ = require('lodash');
 
-var R = require('ramda'); // color for numbers and show values
+const R = require('ramda'); // color for numbers and show values
 
 
-var g = chalk.green; // color for paths
+const g = chalk.green; // color for paths
 
-var p = chalk.cyan; // urls
+const p = chalk.cyan; // urls
 
-var link = chalk.blue.underline; // to be exported
+const link = chalk.blue.underline; // to be exported
 
-var methods = {};
+const methods = {};
 
-methods.findProxyEnvironmentVariables = function () {
+methods.findProxyEnvironmentVariables = () => {
   return _.pick(process.env, ['HTTP_PROXY', 'HTTPS_PROXY', 'NO_PROXY']);
 };
 
-var maskSensitiveVariables = R.evolve({
+const maskSensitiveVariables = R.evolve({
   CYPRESS_RECORD_KEY: R.always('<redacted>')
 });
 
-methods.findCypressEnvironmentVariables = function () {
-  var isCyVariable = function isCyVariable(val, key) {
-    return key.startsWith('CYPRESS_');
-  };
+methods.findCypressEnvironmentVariables = () => {
+  const isCyVariable = (val, key) => key.startsWith('CYPRESS_');
 
   return R.pickBy(isCyVariable)(process.env);
 };
 
-var formatCypressVariables = function formatCypressVariables() {
-  var vars = methods.findCypressEnvironmentVariables();
+const formatCypressVariables = () => {
+  const vars = methods.findCypressEnvironmentVariables();
   return maskSensitiveVariables(vars);
 };
 
-methods.start = function () {
-  var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var args = ['--mode=info'];
+methods.start = (options = {}) => {
+  const args = ['--mode=info'];
   return spawn.start(args, {
     dev: options.dev
-  }).then(function () {
+  }).then(() => {
     console.log();
-    var proxyVars = methods.findProxyEnvironmentVariables();
+    const proxyVars = methods.findProxyEnvironmentVariables();
 
     if (_.isEmpty(proxyVars)) {
       console.log('Proxy Settings: none detected');
     } else {
       console.log('Proxy Settings:');
 
-      _.forEach(proxyVars, function (value, key) {
+      _.forEach(proxyVars, (value, key) => {
         console.log('%s: %s', key, g(value));
       });
 
@@ -69,26 +66,26 @@ methods.start = function () {
       console.log('Learn More: %s', link('https://on.cypress.io/proxy-configuration'));
       console.log();
     }
-  }).then(function () {
-    var cyVars = formatCypressVariables();
+  }).then(() => {
+    const cyVars = formatCypressVariables();
 
     if (_.isEmpty(cyVars)) {
       console.log('Environment Variables: none detected');
     } else {
       console.log('Environment Variables:');
 
-      _.forEach(cyVars, function (value, key) {
+      _.forEach(cyVars, (value, key) => {
         console.log('%s: %s', key, g(value));
       });
     }
-  }).then(function () {
+  }).then(() => {
     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(function () {
+  }).then(() => {
     console.log();
-    return util.getOsVersionAsync().then(function (osVersion) {
+    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())));

package/lib/exec/open.js

@@ -1,22 +1,20 @@
 "use strict";
 
-var debug = require('debug')('cypress:cli');
+const debug = require('debug')('cypress:cli');
 
-var util = require('../util');
+const util = require('../util');
 
-var spawn = require('./spawn');
+const spawn = require('./spawn');
 
-var verify = require('../tasks/verify');
+const verify = require('../tasks/verify');
 
 module.exports = {
-  start: function start() {
-    var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
+  start(options = {}) {
     if (!util.isInstalledGlobally() && !options.global && !options.project) {
       options.project = process.cwd();
     }
 
-    var args = [];
+    const args = [];
 
     if (options.config) {
       args.push('--config', options.config);
@@ -59,4 +57,5 @@ module.exports = {
 
     return verify.start().then(open);
   }
+
 };

package/lib/exec/run.js

@@ -1,18 +1,19 @@
 "use strict";
 
-var _ = require('lodash');
+const _ = require('lodash');
 
-var debug = require('debug')('cypress:cli:run');
+const debug = require('debug')('cypress:cli:run');
 
-var util = require('../util');
+const util = require('../util');
 
-var spawn = require('./spawn');
+const spawn = require('./spawn');
 
-var verify = require('../tasks/verify');
+const verify = require('../tasks/verify');
 
-var _require = require('../errors'),
-    exitWithError = _require.exitWithError,
-    errors = _require.errors;
+const {
+  exitWithError,
+  errors
+} = require('../errors');
 /**
  * Throws an error with "details" property from
  * "errors" object.
@@ -20,14 +21,14 @@ var _require = require('../errors'),
  */
 
 
-var throwInvalidOptionError = function throwInvalidOptionError(details) {
+const throwInvalidOptionError = details => {
   if (!details) {
     details = errors.unknownError;
   } // throw this error synchronously, it will be caught later on and
   // the details will be propagated to the promise chain
 
 
-  var err = new Error();
+  const err = new Error();
   err.details = details;
   throw err;
 };
@@ -39,7 +40,7 @@ var throwInvalidOptionError = function throwInvalidOptionError(details) {
  */
 
 
-var isValidProject = function isValidProject(v) {
+const isValidProject = v => {
   if (typeof v === 'boolean') {
     return false;
   }
@@ -61,8 +62,7 @@ var isValidProject = function isValidProject(v) {
  */
 
 
-var processRunOptions = function processRunOptions() {
-  var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+const processRunOptions = (options = {}) => {
   debug('processing run options %o', options);
 
   if (!isValidProject(options.project)) {
@@ -72,7 +72,7 @@ var processRunOptions = function processRunOptions() {
     return throwInvalidOptionError(errors.invalidRunProjectPath);
   }
 
-  var args = ['--run-project', options.project];
+  const args = ['--run-project', options.project];
 
   if (options.browser) {
     args.push('--browser', options.browser);
@@ -177,12 +177,11 @@ var processRunOptions = function processRunOptions() {
 };
 
 module.exports = {
-  processRunOptions: processRunOptions,
-  isValidProject: isValidProject,
-  // resolves with the number of failed tests
-  start: function start() {
-    var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  processRunOptions,
+  isValidProject,
 
+  // resolves with the number of failed tests
+  start(options = {}) {
     _.defaults(options, {
       key: null,
       spec: null,
@@ -192,7 +191,7 @@ module.exports = {
     });
 
     function run() {
-      var args;
+      let args;
 
       try {
         args = processRunOptions(options);
@@ -216,4 +215,5 @@ module.exports = {
 
     return verify.start().then(run);
   }
+
 };

package/lib/exec/spawn.js

@@ -1,36 +1,36 @@
 "use strict";
 
-var _ = require('lodash');
+const _ = require('lodash');
 
-var os = require('os');
+const os = require('os');
 
-var cp = require('child_process');
+const cp = require('child_process');
 
-var path = require('path');
+const path = require('path');
 
-var Promise = require('bluebird');
+const Promise = require('bluebird');
 
-var debug = require('debug')('cypress:cli');
+const debug = require('debug')('cypress:cli');
 
-var debugElectron = require('debug')('cypress:electron');
+const debugElectron = require('debug')('cypress:electron');
 
-var util = require('../util');
+const util = require('../util');
 
-var state = require('../tasks/state');
+const state = require('../tasks/state');
 
-var xvfb = require('./xvfb');
+const xvfb = require('./xvfb');
 
-var verify = require('../tasks/verify');
+const verify = require('../tasks/verify');
 
-var errors = require('../errors');
+const errors = require('../errors');
 
-var isXlibOrLibudevRe = /^(?:Xlib|libudev)/;
-var isHighSierraWarningRe = /\*\*\* WARNING/;
-var isRenderWorkerRe = /\.RenderWorker-/;
-var GARBAGE_WARNINGS = [isXlibOrLibudevRe, isHighSierraWarningRe, isRenderWorkerRe];
+const isXlibOrLibudevRe = /^(?:Xlib|libudev)/;
+const isHighSierraWarningRe = /\*\*\* WARNING/;
+const isRenderWorkerRe = /\.RenderWorker-/;
+const GARBAGE_WARNINGS = [isXlibOrLibudevRe, isHighSierraWarningRe, isRenderWorkerRe];
 
-var isGarbageLineWarning = function isGarbageLineWarning(str) {
-  return _.some(GARBAGE_WARNINGS, function (re) {
+const isGarbageLineWarning = str => {
+  return _.some(GARBAGE_WARNINGS, re => {
     return re.test(str);
   });
 };
@@ -66,11 +66,11 @@ function getStdio(needsXvfb) {
 }
 
 module.exports = {
-  isGarbageLineWarning: isGarbageLineWarning,
-  start: function start(args) {
-    var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    var needsXvfb = xvfb.isNeeded();
-    var executable = state.getPathToExecutable(state.getBinaryDir());
+  isGarbageLineWarning,
+
+  start(args, options = {}) {
+    const needsXvfb = xvfb.isNeeded();
+    let executable = state.getPathToExecutable(state.getBinaryDir());
 
     if (util.getEnv('CYPRESS_RUN_BINARY')) {
       executable = path.resolve(util.getEnv('CYPRESS_RUN_BINARY'));
@@ -93,9 +93,8 @@ module.exports = {
       stdio: getStdio(needsXvfb)
     });
 
-    var spawn = function spawn() {
-      var overrides = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-      return new Promise(function (resolve, reject) {
+    const spawn = (overrides = {}) => {
+      return new Promise((resolve, reject) => {
         _.defaults(overrides, {
           onStderrData: false,
           electronLogging: false
@@ -109,13 +108,15 @@ module.exports = {
           debug('in dev mode the args became %o', args);
         }
 
-        var onStderrData = overrides.onStderrData,
-            electronLogging = overrides.electronLogging;
-        var envOverrides = util.getEnvOverrides(options);
+        const {
+          onStderrData,
+          electronLogging
+        } = overrides;
+        const envOverrides = util.getEnvOverrides(options);
 
-        var electronArgs = _.clone(args);
+        const electronArgs = _.clone(args);
 
-        var node11WindowsFix = isPlatform('win32');
+        const node11WindowsFix = isPlatform('win32');
 
         if (!options.dev && verify.needsSandbox()) {
           // this is one of the Electron's command line switches
@@ -124,7 +125,7 @@ module.exports = {
         } // strip dev out of child process options
 
 
-        var stdioOptions = _.pick(options, 'env', 'detached', 'stdio'); // figure out if we're going to be force enabling or disabling colors.
+        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
         // it is a tty as opposed to a pipe.
 
@@ -149,18 +150,18 @@ module.exports = {
 
         debug('spawning Cypress with executable: %s', executable);
         debug('spawn args %o %o', electronArgs, _.omit(stdioOptions, 'env'));
-        var child = cp.spawn(executable, electronArgs, stdioOptions);
+        const child = cp.spawn(executable, electronArgs, stdioOptions);
 
         function resolveOn(event) {
           return function (code, signal) {
             debug('child event fired %o', {
-              event: event,
-              code: code,
-              signal: signal
+              event,
+              code,
+              signal
             });
 
             if (code === null) {
-              var errorObject = errors.errors.childProcessKilled(event, signal);
+              const errorObject = errors.errors.childProcessKilled(event, signal);
               return errors.getError(errorObject).then(reject);
             }
 
@@ -190,8 +191,8 @@ module.exports = {
 
         if (child.stderr) {
           debug('piping child STDERR to process STDERR');
-          child.stderr.on('data', function (data) {
-            var str = data.toString(); // bail if this is warning line garbage
+          child.stderr.on('data', data => {
+            const str = data.toString(); // bail if this is warning line garbage
 
             if (isGarbageLineWarning(str)) {
               return;
@@ -215,7 +216,7 @@ module.exports = {
         // error here and not doing anything.
 
 
-        process.stdin.on('error', function (err) {
+        process.stdin.on('error', err => {
           if (['EPIPE', 'ENOTCONN'].includes(err.code)) {
             return;
           }
@@ -229,19 +230,20 @@ module.exports = {
       });
     };
 
-    var spawnInXvfb = function spawnInXvfb() {
-      return xvfb.start().then(userFriendlySpawn)["finally"](xvfb.stop);
+    const spawnInXvfb = () => {
+      return xvfb.start().then(userFriendlySpawn).finally(xvfb.stop);
     };
 
-    var userFriendlySpawn = function userFriendlySpawn(linuxWithDisplayEnv) {
+    const userFriendlySpawn = linuxWithDisplayEnv => {
       debug('spawning, should retry on display problem?', Boolean(linuxWithDisplayEnv));
-      var brokenGtkDisplay;
-      var overrides = {};
+      let brokenGtkDisplay;
+      const overrides = {};
 
       if (linuxWithDisplayEnv) {
         _.extend(overrides, {
           electronLogging: true,
-          onStderrData: function onStderrData(str) {
+
+          onStderrData(str) {
             // if we receive a broken pipe anywhere
             // then we know that's why cypress exited early
             if (util.isBrokenGtkDisplay(str)) {
@@ -255,10 +257,11 @@ module.exports = {
               return false;
             }
           }
+
         });
       }
 
-      return spawn(overrides).then(function (code) {
+      return spawn(overrides).then(code => {
         if (code !== 0 && brokenGtkDisplay) {
           util.logBrokenGtkDisplayWarning();
           return spawnInXvfb();
@@ -267,7 +270,7 @@ module.exports = {
         return code;
       }) // we can format and handle an error message from the code above
       // prevent wrapping error again by using "known: undefined" filter
-      ["catch"]({
+      .catch({
         known: undefined
       }, errors.throwFormErrorText(errors.errors.unexpected));
     };
@@ -279,7 +282,8 @@ module.exports = {
     // spawning our own Xvfb server
 
 
-    var linuxWithDisplayEnv = util.isPossibleLinuxWithIncorrectDisplay();
+    const linuxWithDisplayEnv = util.isPossibleLinuxWithIncorrectDisplay();
     return userFriendlySpawn(linuxWithDisplayEnv);
   }
+
 };

package/lib/exec/versions.js

@@ -1,46 +1,47 @@
 "use strict";
 
-var Promise = require('bluebird');
+const Promise = require('bluebird');
 
-var debug = require('debug')('cypress:cli');
+const debug = require('debug')('cypress:cli');
 
-var path = require('path');
+const path = require('path');
 
-var util = require('../util');
+const util = require('../util');
 
-var state = require('../tasks/state');
+const state = require('../tasks/state');
 
-var _require = require('../errors'),
-    throwFormErrorText = _require.throwFormErrorText,
-    errors = _require.errors;
+const {
+  throwFormErrorText,
+  errors
+} = require('../errors');
 
-var getVersions = function getVersions() {
-  return Promise["try"](function () {
+const getVersions = () => {
+  return Promise.try(() => {
     if (util.getEnv('CYPRESS_RUN_BINARY')) {
-      var envBinaryPath = path.resolve(util.getEnv('CYPRESS_RUN_BINARY'));
-      return state.parseRealPlatformBinaryFolderAsync(envBinaryPath).then(function (envBinaryDir) {
+      let envBinaryPath = path.resolve(util.getEnv('CYPRESS_RUN_BINARY'));
+      return state.parseRealPlatformBinaryFolderAsync(envBinaryPath).then(envBinaryDir => {
         if (!envBinaryDir) {
           return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))();
         }
 
         debug('CYPRESS_RUN_BINARY has binaryDir:', envBinaryDir);
         return envBinaryDir;
-      })["catch"]({
+      }).catch({
         code: 'ENOENT'
-      }, function (err) {
+      }, err => {
         return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))(err.message);
       });
     }
 
     return state.getBinaryDir();
-  }).then(state.getBinaryPkgVersionAsync).then(function (binaryVersion) {
+  }).then(state.getBinaryPkgVersionAsync).then(binaryVersion => {
     return {
-      "package": util.pkgVersion(),
+      package: util.pkgVersion(),
       binary: binaryVersion || 'not installed'
     };
   });
 };
 
 module.exports = {
-  getVersions: getVersions
+  getVersions
 };

package/lib/exec/xvfb.js

@@ -1,61 +1,54 @@
 "use strict";
 
-function _templateObject() {
-  var data = _taggedTemplateLiteral(["\n        DISPLAY environment variable is set to ", " on Linux\n        Assuming this DISPLAY points at working X11 server,\n        Cypress will not spawn own Xvfb\n\n        NOTE: if the X11 server is NOT working, Cypress will exit without explanation,\n          see ", "\n        Solution: Unset the DISPLAY variable and try again:\n          DISPLAY= npx cypress run ...\n      "]);
+const os = require('os');
 
-  _templateObject = function _templateObject() {
-    return data;
-  };
+const Promise = require('bluebird');
 
-  return data;
-}
+const Xvfb = require('@cypress/xvfb');
 
-function _taggedTemplateLiteral(strings, raw) { if (!raw) { raw = strings.slice(0); } return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
+const {
+  stripIndent
+} = require('common-tags');
 
-var os = require('os');
+const debug = require('debug')('cypress:cli');
 
-var Promise = require('bluebird');
+const debugXvfb = require('debug')('cypress:xvfb');
 
-var Xvfb = require('@cypress/xvfb');
+const {
+  throwFormErrorText,
+  errors
+} = require('../errors');
 
-var _require = require('common-tags'),
-    stripIndent = _require.stripIndent;
+const util = require('../util');
 
-var debug = require('debug')('cypress:cli');
-
-var debugXvfb = require('debug')('cypress:xvfb');
-
-var _require2 = require('../errors'),
-    throwFormErrorText = _require2.throwFormErrorText,
-    errors = _require2.errors;
-
-var util = require('../util');
-
-var xvfbOptions = {
+const xvfbOptions = {
   timeout: 30000,
   // milliseconds
   // need to explicitly define screen otherwise electron will crash
   // https://github.com/cypress-io/cypress/issues/6184
   xvfb_args: ['-screen', '0', '1280x1024x24'],
-  onStderrData: function onStderrData(data) {
+
+  onStderrData(data) {
     if (debugXvfb.enabled) {
       debugXvfb(data.toString());
     }
   }
+
 };
-var xvfb = Promise.promisifyAll(new Xvfb(xvfbOptions));
+const xvfb = Promise.promisifyAll(new Xvfb(xvfbOptions));
 module.exports = {
   _debugXvfb: debugXvfb,
   // expose for testing
   _xvfb: xvfb,
   // expose for testing
   _xvfbOptions: xvfbOptions,
+
   // expose for testing
-  start: function start() {
+  start() {
     debug('Starting Xvfb');
-    return xvfb.startAsync()["return"](null)["catch"]({
+    return xvfb.startAsync().return(null).catch({
       nonZeroExitCode: true
-    }, throwFormErrorText(errors.nonZeroExitCodeXvfb))["catch"](function (err) {
+    }, throwFormErrorText(errors.nonZeroExitCodeXvfb)).catch(err => {
       if (err.known) {
         throw err;
       }
@@ -63,19 +56,30 @@ module.exports = {
       return throwFormErrorText(errors.missingXvfb)(err);
     });
   },
-  stop: function stop() {
+
+  stop() {
     debug('Stopping Xvfb');
-    return xvfb.stopAsync()["return"](null)["catch"](function () {// noop
+    return xvfb.stopAsync().return(null).catch(() => {// noop
     });
   },
-  isNeeded: function isNeeded() {
+
+  isNeeded() {
     if (os.platform() !== 'linux') {
       return false;
     }
 
     if (process.env.DISPLAY) {
-      var issueUrl = util.getGitHubIssueUrl(4034);
-      var message = stripIndent(_templateObject(), process.env.DISPLAY, issueUrl);
+      const issueUrl = util.getGitHubIssueUrl(4034);
+      const message = stripIndent`
+        DISPLAY environment variable is set to ${process.env.DISPLAY} on Linux
+        Assuming this DISPLAY points at working X11 server,
+        Cypress will not spawn own Xvfb
+
+        NOTE: if the X11 server is NOT working, Cypress will exit without explanation,
+          see ${issueUrl}
+        Solution: Unset the DISPLAY variable and try again:
+          DISPLAY= npx cypress run ...
+      `;
       debug(message);
       return false;
     }
@@ -84,11 +88,13 @@ module.exports = {
     debug('Cypress will spawn its own Xvfb');
     return true;
   },
+
   // async method, resolved with Boolean
-  verify: function verify() {
-    return xvfb.startAsync()["return"](true)["catch"](function (err) {
+  verify() {
+    return xvfb.startAsync().return(true).catch(err => {
       debug('Could not verify xvfb: %s', err.message);
       return false;
-    })["finally"](xvfb.stopAsync);
+    }).finally(xvfb.stopAsync);
   }
+
 };