cypress 12.1.0 → 12.2.0

package/lib/exec/shared.js

@@ -3,67 +3,58 @@
 const {
   errors
 } = require('../errors');
+
 /**
  * Throws an error with "details" property from
  * "errors" object.
  * @param {Object} details - Error 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
-
+  }
 
+  // throw this error synchronously, it will be caught later on and
+  // the details will be propagated to the promise chain
   const err = new Error();
   err.details = details;
   throw err;
 };
+
 /**
  * Selects exec args based on the configured `testingType`
  * @param {string} testingType The type of tests being executed
  * @returns {string[]} The array of new exec arguments
  */
-
-
 const processTestingType = options => {
   if (options.e2e && options.component) {
     return throwInvalidOptionError(errors.incompatibleTestTypeFlags);
   }
-
   if (options.testingType && (options.component || options.e2e)) {
     return throwInvalidOptionError(errors.incompatibleTestTypeFlags);
   }
-
   if (options.testingType === 'component' || options.component || options.ct) {
     return ['--testing-type', 'component'];
   }
-
   if (options.testingType === 'e2e' || options.e2e) {
     return ['--testing-type', 'e2e'];
   }
-
   if (options.testingType) {
     return throwInvalidOptionError(errors.invalidTestingType);
   }
-
   return [];
 };
+
 /**
  * Throws an error if configFile is string 'false' or boolean false
  * @param {*} options
  */
-
-
 const checkConfigFile = options => {
   // CLI will parse as string, module API can pass in boolean
   if (options.configFile === 'false' || options.configFile === false) {
     throwInvalidOptionError(errors.invalidConfigFile);
   }
 };
-
 module.exports = {
   throwInvalidOptionError,
   processTestingType,

package/lib/exec/spawn.js

@@ -1,129 +1,109 @@
 "use strict";
 
 const _ = require('lodash');
-
 const os = require('os');
-
 const cp = require('child_process');
-
 const path = require('path');
-
 const Promise = require('bluebird');
-
 const debug = require('debug')('cypress:cli');
-
 const debugElectron = require('debug')('cypress:electron');
-
 const util = require('../util');
-
 const state = require('../tasks/state');
-
 const xvfb = require('./xvfb');
-
 const verify = require('../tasks/verify');
-
 const errors = require('../errors');
-
 const isXlibOrLibudevRe = /^(?:Xlib|libudev)/;
 const isHighSierraWarningRe = /\*\*\* WARNING/;
-const isRenderWorkerRe = /\.RenderWorker-/; // Chromium (which Electron uses) always makes several attempts to connect to the system dbus.
+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 isDbusWarning = /Failed to connect to the bus:/; // Electron began logging these on self-signed certs with 17.0.0-alpha.4.
+// Electron began logging these on self-signed certs with 17.0.0-alpha.4.
 // Once this is fixed upstream this regex can be removed: https://github.com/electron/electron/issues/34583
 // Sample:
 // [3801:0606/152837.383892:ERROR:cert_verify_proc_builtin.cc(681)] CertVerifyProcBuiltin for www.googletagmanager.com failed:
 // ----- Certificate i=0 (OU=Cypress Proxy Server Certificate,O=Cypress Proxy CA,L=Internet,ST=Internet,C=Internet,CN=www.googletagmanager.com) -----
 // ERROR: No matching issuer found
+const isCertVerifyProcBuiltin = /(^\[.*ERROR:cert_verify_proc_builtin\.cc|^----- Certificate i=0 \(OU=Cypress Proxy|^ERROR: No matching issuer found$)/;
 
-const isCertVerifyProcBuiltin = /(^\[.*ERROR:cert_verify_proc_builtin\.cc|^----- Certificate i=0 \(OU=Cypress Proxy|^ERROR: No matching issuer found$)/; // Electron logs a benign warning about WebSwapCGLLayer on MacOS v12 and Electron v18 due to a naming collision in shared libraries.
+// Electron logs a benign warning about WebSwapCGLLayer on MacOS v12 and Electron v18 due to a naming collision in shared libraries.
 // Once this is fixed upstream this regex can be removed: https://github.com/electron/electron/issues/33685
 // Sample:
 // objc[60540]: Class WebSwapCGLLayer is implemented in both /System/Library/Frameworks/WebKit.framework/Versions/A/Frameworks/WebCore.framework/Versions/A/Frameworks/libANGLE-shared.dylib (0x7ffa5a006318) and /{path/to/app}/node_modules/electron/dist/Electron.app/Contents/Frameworks/Electron Framework.framework/Versions/A/Libraries/libGLESv2.dylib (0x10f8a89c8). One of the two will be used. Which one is undefined.
-
 const isMacOSElectronWebSwapCGLLayerWarning = /^objc\[\d+\]: Class WebSwapCGLLayer is implemented in both.*Which one is undefined\./;
 const GARBAGE_WARNINGS = [isXlibOrLibudevRe, isHighSierraWarningRe, isRenderWorkerRe, isDbusWarning, isCertVerifyProcBuiltin, isMacOSElectronWebSwapCGLLayerWarning];
-
 const isGarbageLineWarning = str => {
   return _.some(GARBAGE_WARNINGS, re => {
     return re.test(str);
   });
 };
-
 function isPlatform(platform) {
   return os.platform() === platform;
 }
-
 function needsStderrPiped(needsXvfb) {
   return _.some([isPlatform('darwin'), needsXvfb && isPlatform('linux'), util.isPossibleLinuxWithIncorrectDisplay()]);
 }
-
 function needsEverythingPipedDirectly() {
   return isPlatform('win32');
 }
-
 function getStdio(needsXvfb) {
   if (needsEverythingPipedDirectly()) {
     return 'pipe';
-  } // https://github.com/cypress-io/cypress/issues/921
+  }
+
+  // https://github.com/cypress-io/cypress/issues/921
   // https://github.com/cypress-io/cypress/issues/1143
   // https://github.com/cypress-io/cypress/issues/1745
-
-
   if (needsStderrPiped(needsXvfb)) {
     // returning pipe here so we can massage stderr
     // and remove garbage from Xlib and libuv
     // due to starting the Xvfb process on linux
     return ['inherit', 'inherit', 'pipe'];
   }
-
   return 'inherit';
 }
-
 module.exports = {
   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'));
     }
+    debug('needs to start own Xvfb?', needsXvfb);
 
-    debug('needs to start own Xvfb?', needsXvfb); // Always push cwd into the args
+    // Always push cwd into the args
     // which additionally acts as a signal to the
     // binary that it was invoked through the NPM module
-
     args = args || [];
-
     if (typeof args === 'string') {
       args = [args];
     }
-
     args = [...args, '--cwd', process.cwd(), '--userNodePath', process.execPath, '--userNodeVersion', process.versions.node];
-
     _.defaults(options, {
       dev: false,
       env: process.env,
       detached: false,
       stdio: getStdio(needsXvfb)
     });
-
     const spawn = (overrides = {}) => {
       return new Promise((resolve, reject) => {
         _.defaults(overrides, {
           onStderrData: false,
           electronLogging: false
         });
-
         const {
           onStderrData,
           electronLogging
@@ -132,46 +112,39 @@ module.exports = {
         const electronArgs = [];
         const node11WindowsFix = isPlatform('win32');
         let startScriptPath;
-
         if (options.dev) {
-          executable = 'node'; // if we're in dev then reset
+          executable = 'node';
+          // if we're in dev then reset
           // the launch cmd to be 'npm run dev'
-
           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
+        }
 
+        // strip dev out of child process options
         /**
          * @type {import('child_process').ForkOptions}
          */
+        let stdioOptions = _.pick(options, 'env', 'detached', 'stdio');
 
-
-        let stdioOptions = _.pick(options, 'env', 'detached', 'stdio'); // figure out if we're going to be force enabling or disabling colors.
+        // 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.
-
-
         stdioOptions.env = _.extend({}, stdioOptions.env, envOverrides);
-
         if (node11WindowsFix) {
           stdioOptions = _.extend({}, stdioOptions, {
             windowsHide: false
           });
         }
-
         if (electronLogging) {
           stdioOptions.env.ELECTRON_ENABLE_LOGGING = true;
         }
-
         if (util.isPossibleLinuxWithIncorrectDisplay()) {
           // make sure we use the latest DISPLAY variable if any
           debug('passing DISPLAY', process.env.DISPLAY);
           stdioOptions.env.DISPLAY = process.env.DISPLAY;
         }
-
         if (stdioOptions.env.ELECTRON_RUN_AS_NODE) {
           // Since we are running electron as node, we need to add an entry point file.
           startScriptPath = path.join(state.getBinaryPkgPath(path.dirname(executable)), '..', 'index.js');
@@ -182,19 +155,15 @@ module.exports = {
           // https://github.com/cypress-io/cypress/issues/5466
           args = [...electronArgs, '--', ...args];
         }
-
         if (startScriptPath) {
           args.unshift(startScriptPath);
         }
-
         if (process.env.CYPRESS_INTERNAL_DEV_DEBUG) {
           args.unshift(process.env.CYPRESS_INTERNAL_DEV_DEBUG);
         }
-
         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) {
           return function (code, signal) {
             debug('child event fired %o', {
@@ -202,131 +171,119 @@ module.exports = {
               code,
               signal
             });
-
             if (code === null) {
               const errorObject = errors.errors.childProcessKilled(event, signal);
               return errors.getError(errorObject).then(reject);
             }
-
             resolve(code);
           };
         }
-
         child.on('close', resolveOn('close'));
         child.on('exit', resolveOn('exit'));
-        child.on('error', reject); // if stdio options is set to 'pipe', then
+        child.on('error', reject);
+
+        // if stdio options is set to 'pipe', then
         //   we should set up pipes:
         //  process STDIN (read stream) => child STDIN (writeable)
         //  child STDOUT => process STDOUT
         //  child STDERR => process STDERR with additional filtering
-
         if (child.stdin) {
           debug('piping process STDIN into child STDIN');
           process.stdin.pipe(child.stdin);
         }
-
         if (child.stdout) {
           debug('piping child STDOUT to process STDOUT');
           child.stdout.pipe(process.stdout);
-        } // if this is defined then we are manually piping for linux
-        // to filter out the garbage
-
+        }
 
+        // if this is defined then we are manually piping for linux
+        // to filter out the garbage
         if (child.stderr) {
           debug('piping child STDERR to process STDERR');
           child.stderr.on('data', data => {
-            const str = data.toString(); // bail if this is warning line garbage
+            const str = data.toString();
 
+            // bail if this is warning line garbage
             if (isGarbageLineWarning(str)) {
               return;
-            } // if we have a callback and this explictly returns
-            // false then bail
-
+            }
 
+            // if we have a callback and this explictly returns
+            // false then bail
             if (onStderrData && onStderrData(str) === false) {
               return;
-            } // else pass it along!
-
+            }
 
+            // else pass it along!
             process.stderr.write(data);
           });
-        } // https://github.com/cypress-io/cypress/issues/1841
+        }
+
+        // https://github.com/cypress-io/cypress/issues/1841
         // https://github.com/cypress-io/cypress/issues/5241
         // In some versions of node, it will throw on windows
         // when you close the parent process after piping
         // into the child process. unpiping does not seem
         // to have any effect. so we're just catching the
         // error here and not doing anything.
-
-
         process.stdin.on('error', err => {
           if (['EPIPE', 'ENOTCONN'].includes(err.code)) {
             return;
           }
-
           throw err;
         });
-
         if (stdioOptions.detached) {
           child.unref();
         }
       });
     };
-
     const spawnInXvfb = () => {
       return xvfb.start().then(userFriendlySpawn).finally(xvfb.stop);
     };
-
     const userFriendlySpawn = linuxWithDisplayEnv => {
       debug('spawning, should retry on display problem?', Boolean(linuxWithDisplayEnv));
       let brokenGtkDisplay;
       const overrides = {};
-
       if (linuxWithDisplayEnv) {
         _.extend(overrides, {
           electronLogging: true,
-
           onStderrData(str) {
             // if we receive a broken pipe anywhere
             // then we know that's why cypress exited early
             if (util.isBrokenGtkDisplay(str)) {
               brokenGtkDisplay = true;
-            } // we should attempt to always slurp up
+            }
+
+            // we should attempt to always slurp up
             // the stderr logs unless we've explicitly
             // enabled the electron debug logging
-
-
             if (!debugElectron.enabled) {
               return false;
             }
           }
-
         });
       }
-
       return spawn(overrides).then(code => {
         if (code !== 0 && brokenGtkDisplay) {
           util.logBrokenGtkDisplayWarning();
           return spawnInXvfb();
         }
-
         return code;
-      }) // we can format and handle an error message from the code above
+      })
+      // we can format and handle an error message from the code above
       // prevent wrapping error again by using "known: undefined" filter
       .catch({
         known: undefined
       }, errors.throwFormErrorText(errors.errors.unexpected));
     };
-
     if (needsXvfb) {
       return spawnInXvfb();
-    } // if we are on linux and there's already a DISPLAY
+    }
+
+    // if we are on linux and there's already a DISPLAY
     // set, then we may need to rerun cypress after
     // spawning our own Xvfb server
-
-
     const linuxWithDisplayEnv = util.isPossibleLinuxWithIncorrectDisplay();
     return userFriendlySpawn(linuxWithDisplayEnv);
   }
-
 };

package/lib/exec/versions.js

@@ -1,20 +1,14 @@
 "use strict";
 
 const Promise = require('bluebird');
-
 const debug = require('debug')('cypress:cli');
-
 const path = require('path');
-
 const util = require('../util');
-
 const state = require('../tasks/state');
-
 const {
   throwFormErrorText,
   errors
 } = require('../errors');
-
 const getVersions = () => {
   return Promise.try(() => {
     if (util.getEnv('CYPRESS_RUN_BINARY')) {
@@ -23,7 +17,6 @@ const getVersions = () => {
         if (!envBinaryDir) {
           return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))();
         }
-
         debug('CYPRESS_RUN_BINARY has binaryDir:', envBinaryDir);
         return envBinaryDir;
       }).catch({
@@ -32,7 +25,6 @@ const getVersions = () => {
         return throwFormErrorText(errors.CYPRESS_RUN_BINARY.notValid(envBinaryPath))(err.message);
       });
     }
-
     return state.getBinaryDir();
   }).then(state.getBinaryPkgAsync).then(pkg => {
     const versions = {
@@ -56,7 +48,6 @@ const getVersions = () => {
     return versions;
   });
 };
-
 module.exports = {
   getVersions
 };

package/lib/exec/xvfb.js

@@ -1,24 +1,17 @@
 "use strict";
 
 const os = require('os');
-
 const Promise = require('bluebird');
-
 const Xvfb = require('@cypress/xvfb');
-
 const {
   stripIndent
 } = require('common-tags');
-
 const Debug = require('debug');
-
 const {
   throwFormErrorText,
   errors
 } = require('../errors');
-
 const util = require('../util');
-
 const debug = Debug('cypress:cli');
 const debugXvfb = Debug('cypress:xvfb');
 debug.Debug = debugXvfb.Debug = Debug;
@@ -29,23 +22,23 @@ const xvfbOptions = {
   // need to explicitly define screen otherwise electron will crash
   // https://github.com/cypress-io/cypress/issues/6184
   xvfb_args: ['-screen', '0', '1280x1024x24'],
-
   onStderrData(data) {
     if (debugXvfb.enabled) {
       debugXvfb(data.toString());
     }
   }
-
 };
 const xvfb = Promise.promisifyAll(new Xvfb(xvfbOptions));
 module.exports = {
   _debugXvfb: debugXvfb,
   // expose for testing
+
   _xvfb: xvfb,
   // expose for testing
-  _xvfbOptions: xvfbOptions,
 
+  _xvfbOptions: xvfbOptions,
   // expose for testing
+
   start() {
     debug('Starting Xvfb');
     return xvfb.startAsync().return(null).catch({
@@ -54,17 +47,15 @@ module.exports = {
       if (err.known) {
         throw err;
       }
-
       return throwFormErrorText(errors.missingXvfb)(err);
     });
   },
-
   stop() {
     debug('Stopping Xvfb');
-    return xvfb.stopAsync().return(null).catch(() => {// noop
+    return xvfb.stopAsync().return(null).catch(() => {
+      // noop
     });
   },
-
   isNeeded() {
     if (process.env.ELECTRON_RUN_AS_NODE) {
       debug('Environment variable ELECTRON_RUN_AS_NODE detected, xvfb is not needed');
@@ -74,7 +65,6 @@ module.exports = {
     if (os.platform() !== 'linux') {
       return false;
     }
-
     if (process.env.DISPLAY) {
       const issueUrl = util.getGitHubIssueUrl(4034);
       const message = stripIndent`
@@ -90,12 +80,10 @@ module.exports = {
       debug(message);
       return false;
     }
-
     debug('undefined DISPLAY environment variable');
     debug('Cypress will spawn its own Xvfb');
     return true;
   },
-
   // async method, resolved with Boolean
   verify() {
     return xvfb.startAsync().return(true).catch(err => {
@@ -103,5 +91,4 @@ module.exports = {
       return false;
     }).finally(xvfb.stopAsync);
   }
-
 };

package/lib/fs.js

@@ -1,5 +1,4 @@
 "use strict";
 
 const Promise = require('bluebird');
-
 module.exports = Promise.promisifyAll(require('fs-extra'));

package/lib/logger.js

@@ -1,13 +1,10 @@
 "use strict";
 
 const chalk = require('chalk');
-
 let logs = [];
-
 const logLevel = () => {
   return process.env.npm_config_loglevel || 'notice';
 };
-
 const error = (...messages) => {
   logs.push(messages.join(' '));
   console.log(chalk.red(...messages)); // eslint-disable-line no-console
@@ -28,26 +25,22 @@ const log = (...messages) => {
 const always = (...messages) => {
   logs.push(messages.join(' '));
   console.log(...messages); // eslint-disable-line no-console
-}; // splits long text into lines and calls log()
-// on each one to allow easy unit testing for specific message
-
+};
 
+// splits long text into lines and calls log()
+// on each one to allow easy unit testing for specific message
 const logLines = text => {
   const lines = text.split('\n');
-
   for (const line of lines) {
     log(line);
   }
 };
-
 const print = () => {
   return logs.join('\n');
 };
-
 const reset = () => {
   logs = [];
 };
-
 module.exports = {
   log,
   warn,