cypress 12.1.0 → 12.2.0

package/lib/errors.js

@@ -1,23 +1,19 @@
 "use strict";
 
 const chalk = require('chalk');
-
 const {
   stripIndent,
   stripIndents
 } = require('common-tags');
-
 const la = require('lazy-ass');
-
 const is = require('check-more-types');
-
 const util = require('./util');
-
 const state = require('./tasks/state');
-
 const docsUrl = 'https://on.cypress.io';
 const requiredDependenciesUrl = `${docsUrl}/required-dependencies`;
-const runDocumentationUrl = `${docsUrl}/cypress-run`; // TODO it would be nice if all error objects could be enforced via types
+const runDocumentationUrl = `${docsUrl}/cypress-run`;
+
+// TODO it would be nice if all error objects could be enforced via types
 // to only have description + solution properties
 
 const hr = '----------';
@@ -25,8 +21,9 @@ const genericErrorSolution = stripIndent`
   Search for an existing issue or open a GitHub issue at
 
     ${chalk.blue(util.issuesUrl)}
-`; // common errors Cypress application can encounter
+`;
 
+// common errors Cypress application can encounter
 const unknownError = {
   description: 'Unknown Cypress CLI error',
   solution: genericErrorSolution
@@ -64,7 +61,6 @@ const failedUnzipWindowsMaxPathLength = {
 
   Read here for solutions to this problem: https://on.cypress.io/win-max-path-length-error`
 };
-
 const missingApp = binaryDir => {
   return {
     description: `No version of Cypress is installed in: ${chalk.cyan(binaryDir)}`,
@@ -73,7 +69,6 @@ const missingApp = binaryDir => {
   `
   };
 };
-
 const binaryNotExecutable = executable => {
   return {
     description: `Cypress cannot run because this binary file does not have executable permissions here:\n\n${executable}`,
@@ -89,7 +84,6 @@ const binaryNotExecutable = executable => {
   `
   };
 };
-
 const notInstalledCI = executable => {
   return {
     description: 'The cypress npm package is installed, but the Cypress binary is missing.',
@@ -109,7 +103,6 @@ const notInstalledCI = executable => {
   `
   };
 };
-
 const nonZeroExitCodeXvfb = {
   description: 'Xvfb exited with a non zero exit code.',
   solution: stripIndent`
@@ -130,7 +123,6 @@ const missingXvfb = {
     If you are using Docker, we provide containers with all required dependencies installed.
     `
 };
-
 const smokeTestFailure = (smokeTestCommand, timedOut) => {
   return {
     description: `Cypress verification ${timedOut ? 'timed out' : 'failed'}.`,
@@ -142,11 +134,9 @@ const smokeTestFailure = (smokeTestCommand, timedOut) => {
     `
   };
 };
-
 const invalidSmokeTestDisplayError = {
   code: 'INVALID_SMOKE_TEST_DISPLAY_ERROR',
   description: 'Cypress verification failed.',
-
   solution(msg) {
     return stripIndent`
       Cypress failed to start after spawning a new Xvfb server.
@@ -164,7 +154,6 @@ const invalidSmokeTestDisplayError = {
       Please refer to the error above for more detail.
     `;
   }
-
 };
 const missingDependency = {
   description: 'Cypress failed to start.',
@@ -226,6 +215,7 @@ const invalidConfigFile = {
   description: '`--config-file` cannot be false.',
   solution: 'Either pass a relative path to a valid Cypress config file or remove this option.'
 };
+
 /**
  * This error happens when CLI detects that the child Test Runner process
  * was killed with a signal, like SIGBUS
@@ -233,14 +223,12 @@ const invalidConfigFile = {
  * @param {'close'|'event'} eventName Child close event name
  * @param {string} signal Signal that closed the child process, like "SIGBUS"
 */
-
 const childProcessKilled = (eventName, signal) => {
   return {
     description: `The Test Runner unexpectedly exited via a ${chalk.cyan(eventName)} event with signal ${chalk.cyan(signal)}`,
     solution: solutionUnknown
   };
 };
-
 const CYPRESS_RUN_BINARY = {
   notValid: value => {
     const properFormat = `**/${state.getPlatformExecutable()}`;
@@ -250,14 +238,15 @@ const CYPRESS_RUN_BINARY = {
     };
   }
 };
-
 function addPlatformInformation(info) {
   return util.getPlatformInfo().then(platform => {
-    return { ...info,
+    return {
+      ...info,
       platform
     };
   });
 }
+
 /**
  * Given an error object (see the errors above), forms error message text with details,
  * then resolves with Error instance you can throw or reject with.
@@ -270,8 +259,6 @@ function addPlatformInformation(info) {
   return getError(errorObject).then(reject)
   ```
  */
-
-
 function getError(errorObject) {
   return formErrorText(errorObject).then(errorMessage => {
     const err = new Error(errorMessage);
@@ -279,23 +266,21 @@ function getError(errorObject) {
     return err;
   });
 }
+
 /**
  * Forms nice error message with error and platform information,
  * and if possible a way to solve it. Resolves with a string.
  */
-
-
 function formErrorText(info, msg, prevMessage) {
   return addPlatformInformation(info).then(obj => {
     const formatted = [];
-
     function add(msg) {
       formatted.push(stripIndents(msg));
     }
+    la(is.unemptyString(obj.description), 'expected error description to be text', obj.description);
 
-    la(is.unemptyString(obj.description), 'expected error description to be text', obj.description); // assuming that if there the solution is a function it will handle
+    // assuming that if there the solution is a function it will handle
     // error message and (optional previous error message)
-
     if (is.fn(obj.solution)) {
       const text = obj.solution(msg, prevMessage);
       la(is.unemptyString(text), 'expected solution to be text', text);
@@ -313,7 +298,6 @@ function formErrorText(info, msg, prevMessage) {
         ${obj.solution}
 
       `);
-
       if (msg) {
         add(`
           ${hr}
@@ -323,13 +307,11 @@ function formErrorText(info, msg, prevMessage) {
         `);
       }
     }
-
     add(`
       ${hr}
 
       ${obj.platform}
     `);
-
     if (obj.footer) {
       add(`
 
@@ -338,37 +320,31 @@ function formErrorText(info, msg, prevMessage) {
         ${obj.footer}
       `);
     }
-
     return formatted.join('\n\n');
   });
 }
-
 const raise = info => {
   return text => {
     const err = new Error(text);
-
     if (info.code) {
       err.code = info.code;
     }
-
     err.known = true;
     throw err;
   };
 };
-
 const throwFormErrorText = info => {
   return (msg, prevMessage) => {
     return formErrorText(info, msg, prevMessage).then(raise(info));
   };
 };
+
 /**
  * Forms full error message with error and OS details, prints to the error output
  * and then exits the process.
  * @param {ErrorInformation} info Error information {description, solution}
  * @example return exitWithError(errors.invalidCypressEnv)('foo')
  */
-
-
 const exitWithError = info => {
   return msg => {
     return formErrorText(info, msg).then(text => {
@@ -378,7 +354,6 @@ const exitWithError = info => {
     });
   };
 };
-
 module.exports = {
   raise,
   exitWithError,

package/lib/exec/info.js

@@ -2,55 +2,43 @@
 
 /* eslint-disable no-console */
 const spawn = require('./spawn');
-
 const util = require('../util');
-
 const state = require('../tasks/state');
-
 const os = require('os');
-
 const chalk = require('chalk');
-
 const prettyBytes = require('pretty-bytes');
+const _ = require('lodash');
 
-const _ = require('lodash'); // color for numbers and show values
-
-
-const g = chalk.green; // color for paths
-
+// color for numbers and show values
+const g = chalk.green;
+// color for paths
 const p = chalk.cyan;
-const red = chalk.red; // urls
-
-const link = chalk.blue.underline; // to be exported
+const red = chalk.red;
+// urls
+const link = chalk.blue.underline;
 
+// to be exported
 const methods = {};
-
 methods.findProxyEnvironmentVariables = () => {
   return _.pick(process.env, ['HTTP_PROXY', 'HTTPS_PROXY', 'NO_PROXY']);
 };
-
 const maskSensitiveVariables = obj => {
-  const masked = { ...obj
+  const masked = {
+    ...obj
   };
-
   if (masked.CYPRESS_RECORD_KEY) {
     masked.CYPRESS_RECORD_KEY = '<redacted>';
   }
-
   return masked;
 };
-
 methods.findCypressEnvironmentVariables = () => {
   const isCyVariable = (val, key) => key.startsWith('CYPRESS_');
-
   return _.pickBy(process.env, isCyVariable);
 };
-
 const formatCypressVariables = () => {
   const vars = methods.findCypressEnvironmentVariables();
   return maskSensitiveVariables(vars);
 };
-
 methods.start = async (options = {}) => {
   const args = ['--mode=info'];
   await spawn.start(args, {
@@ -58,33 +46,26 @@ methods.start = async (options = {}) => {
   });
   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();
   }
-
   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')));
@@ -96,7 +77,6 @@ methods.start = async (options = {}) => {
   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.');
@@ -109,5 +89,4 @@ methods.start = async (options = {}) => {
     console.log('  Commit Date:', g(buildInfo.commitDate));
   }
 };
-
 module.exports = methods;

package/lib/exec/open.js

@@ -1,21 +1,17 @@
 "use strict";
 
 const debug = require('debug')('cypress:cli');
-
 const util = require('../util');
-
 const spawn = require('./spawn');
-
 const verify = require('../tasks/verify');
-
 const {
   processTestingType,
   checkConfigFile
 } = require('./shared');
-
 const {
   exitWithError
 } = require('../errors');
+
 /**
  * Maps options collected by the CLI
  * and forms list of CLI arguments to the server.
@@ -25,8 +21,6 @@ const {
  *
  * @returns {string[]} list of CLI arguments
  */
-
-
 const processOpenOptions = (options = {}) => {
   // In addition to setting the project directory, setting the project option
   // here ultimately decides whether cypress is run in global mode or not.
@@ -37,55 +31,42 @@ const processOpenOptions = (options = {}) => {
   if (!util.isInstalledGlobally() && !options.global && !options.project) {
     options.project = process.cwd();
   }
-
   const args = [];
-
   if (options.config) {
     args.push('--config', options.config);
   }
-
   if (options.configFile !== undefined) {
     checkConfigFile(options);
     args.push('--config-file', options.configFile);
   }
-
   if (options.browser) {
     args.push('--browser', options.browser);
   }
-
   if (options.env) {
     args.push('--env', options.env);
   }
-
   if (options.port) {
     args.push('--port', options.port);
   }
-
   if (options.project) {
     args.push('--project', options.project);
   }
-
   if (options.global) {
     args.push('--global', options.global);
   }
-
   if (options.inspect) {
     args.push('--inspect');
   }
-
   if (options.inspectBrk) {
     args.push('--inspectBrk');
   }
-
   args.push(...processTestingType(options));
   debug('opening from options %j', options);
   debug('command line arguments %j', args);
   return args;
 };
-
 module.exports = {
   processOpenOptions,
-
   start(options = {}) {
     function open() {
       try {
@@ -98,16 +79,12 @@ module.exports = {
         if (err.details) {
           return exitWithError(err.details)();
         }
-
         throw err;
       }
     }
-
     if (options.dev) {
       return open();
     }
-
     return verify.start().then(open);
   }
-
 };

package/lib/exec/run.js

@@ -1,44 +1,36 @@
 "use strict";
 
 const _ = require('lodash');
-
 const debug = require('debug')('cypress:cli:run');
-
 const util = require('../util');
-
 const spawn = require('./spawn');
-
 const verify = require('../tasks/verify');
-
 const {
   exitWithError,
   errors
 } = require('../errors');
-
 const {
   processTestingType,
   throwInvalidOptionError,
   checkConfigFile
 } = require('./shared');
+
 /**
  * Typically a user passes a string path to the project.
  * But "cypress open" allows using `false` to open in global mode,
  * and the user can accidentally execute `cypress run --project false`
  * which should be invalid.
  */
-
-
 const isValidProject = v => {
   if (typeof v === 'boolean') {
     return false;
   }
-
   if (v === '' || v === 'false' || v === 'true') {
     return false;
   }
-
   return true;
 };
+
 /**
  * Maps options collected by the CLI
  * and forms list of CLI arguments to the server.
@@ -48,129 +40,105 @@ const isValidProject = v => {
  *
  * @returns {string[]} list of CLI arguments
  */
-
-
 const processRunOptions = (options = {}) => {
   debug('processing run options %o', options);
-
   if (!isValidProject(options.project)) {
     debug('invalid project option %o', {
       project: options.project
     });
     return throwInvalidOptionError(errors.invalidRunProjectPath);
   }
-
   const args = ['--run-project', options.project];
-
   if (options.browser) {
     args.push('--browser', options.browser);
   }
-
   if (options.ciBuildId) {
     args.push('--ci-build-id', options.ciBuildId);
   }
-
   if (options.config) {
     args.push('--config', options.config);
   }
-
   if (options.configFile !== undefined) {
     checkConfigFile(options);
     args.push('--config-file', options.configFile);
   }
-
   if (options.env) {
     args.push('--env', options.env);
   }
-
   if (options.exit === false) {
     args.push('--no-exit');
   }
-
   if (options.group) {
     args.push('--group', options.group);
   }
-
   if (options.headed) {
     args.push('--headed', options.headed);
   }
-
   if (options.headless) {
     if (options.headed) {
       return throwInvalidOptionError(errors.incompatibleHeadlessFlags);
     }
-
     args.push('--headed', !options.headless);
-  } // if key is set use that - else attempt to find it by environment variable
-
+  }
 
+  // if key is set use that - else attempt to find it by environment variable
   if (options.key == null) {
     debug('--key is not set, looking up environment variable CYPRESS_RECORD_KEY');
     options.key = util.getEnv('CYPRESS_RECORD_KEY');
-  } // if we have a key assume we're in record mode
-
+  }
 
+  // if we have a key assume we're in record mode
   if (options.key) {
     args.push('--key', options.key);
   }
-
   if (options.outputPath) {
     args.push('--output-path', options.outputPath);
   }
-
   if (options.parallel) {
     args.push('--parallel');
   }
-
   if (options.port) {
     args.push('--port', options.port);
   }
-
   if (options.quiet) {
     args.push('--quiet');
-  } // if record is defined and we're not
-  // already in ci mode, then send it up
-
+  }
 
+  // if record is defined and we're not
+  // already in ci mode, then send it up
   if (options.record != null) {
     args.push('--record', options.record);
-  } // if we have a specific reporter push that into the args
-
+  }
 
+  // if we have a specific reporter push that into the args
   if (options.reporter) {
     args.push('--reporter', options.reporter);
-  } // if we have a specific reporter push that into the args
-
+  }
 
+  // if we have a specific reporter push that into the args
   if (options.reporterOptions) {
     args.push('--reporter-options', options.reporterOptions);
-  } // if we have specific spec(s) push that into the args
-
+  }
 
+  // if we have specific spec(s) push that into the args
   if (options.spec) {
     args.push('--spec', options.spec);
   }
-
   if (options.tag) {
     args.push('--tag', options.tag);
   }
-
   if (options.inspect) {
     args.push('--inspect');
   }
-
   if (options.inspectBrk) {
     args.push('--inspectBrk');
   }
-
   args.push(...processTestingType(options));
   return args;
 };
-
 module.exports = {
   processRunOptions,
   isValidProject,
-
   // resolves with the number of failed tests
   start(options = {}) {
     _.defaults(options, {
@@ -180,7 +148,6 @@ module.exports = {
       reporterOptions: null,
       project: process.cwd()
     });
-
     function run() {
       try {
         const args = processRunOptions(options);
@@ -192,16 +159,12 @@ module.exports = {
         if (err.details) {
           return exitWithError(err.details)();
         }
-
         throw err;
       }
     }
-
     if (options.dev) {
       return run();
     }
-
     return verify.start().then(run);
   }
-
 };