cypress 9.1.0 → 9.3.0

package/README.md

@@ -1,25 +1,25 @@
-# Cypress
-
-Fast, easy and reliable testing for anything that runs in a browser.
-
-## What is this?
-
-[Cypress](https://www.cypress.io/) comes packaged as an `npm` module, which is all you need to get started testing.
-
-After installing you'll be able to:
-
-- Open Cypress from the CLI
-- Run Cypress from the CLI
-- `require` Cypress as a module
-
-## Install
-
-Please check our [system requirements](https://on.cypress.io/installing-cypress).
-
-```sh
-npm install --save-dev cypress
-```
-
-## Documentation
-
-Please [visit our documentation](https://on.cypress.io/cli) for a full list of commands and examples.
+# Cypress
+
+Fast, easy and reliable testing for anything that runs in a browser.
+
+## What is this?
+
+[Cypress](https://www.cypress.io/) comes packaged as an `npm` module, which is all you need to get started testing.
+
+After installing you'll be able to:
+
+- Open Cypress from the CLI
+- Run Cypress from the CLI
+- `require` Cypress as a module
+
+## Install
+
+Please check our [system requirements](https://on.cypress.io/installing-cypress).
+
+```sh
+npm install --save-dev cypress
+```
+
+## Documentation
+
+Please [visit our documentation](https://on.cypress.io/cli) for a full list of commands and examples.

package/bin/cypress

@@ -1,3 +1,3 @@
-#!/usr/bin/env node
-
-require('../lib/cli').init()
+#!/usr/bin/env node
+
+require('../lib/cli').init()

package/lib/cli.js

@@ -223,12 +223,12 @@ const createProgram = () => {
 const addCypressRunCommand = program => {
   return program.command('run').usage('[options]').description('Runs Cypress tests from the CLI without the GUI').option('-b, --browser <browser-name-or-path>', text('browserRunMode')).option('--ci-build-id <id>', text('ciBuildId')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-e, --env <env>', text('env')).option('--group <name>', text('group')).option('-k, --key <record-key>', text('key')).option('--headed', text('headed')).option('--headless', text('headless')).option('--no-exit', text('exit')).option('--parallel', text('parallel')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('-q, --quiet', text('quiet')).option('--record [bool]', text('record'), coerceFalse).option('-r, --reporter <reporter>', text('reporter')).option('-o, --reporter-options <reporter-options>', text('reporterOptions')).option('-s, --spec <spec>', text('spec')).option('-t, --tag <tag>', text('tag')).option('--dev', text('dev'), coerceFalse);
 };
-/**
- * Casts known command line options for "cypress run" to their intended type.
- * For example if the user passes "--port 5005" the ".port" property should be
- * a number 5005 and not a string "5005".
- *
- * Returns a clone of the original object.
+/**
+ * Casts known command line options for "cypress run" to their intended type.
+ * For example if the user passes "--port 5005" the ".port" property should be
+ * a number 5005 and not a string "5005".
+ *
+ * Returns a clone of the original object.
  */
 
 
@@ -251,12 +251,12 @@ const castCypressRunOptions = opts => {
 };
 
 module.exports = {
-  /**
-   * Parses `cypress run` command line option array into an object
-   * with options that you can feed into a `cypress.run()` module API call.
-   * @example
-   *  const options = parseRunCommand(['cypress', 'run', '--browser', 'chrome'])
-   *  // options is {browser: 'chrome'}
+  /**
+   * Parses `cypress run` command line option array into an object
+   * with options that you can feed into a `cypress.run()` module API call.
+   * @example
+   *  const options = parseRunCommand(['cypress', 'run', '--browser', 'chrome'])
+   *  // options is {browser: 'chrome'}
    */
   parseRunCommand(args) {
     return new Promise((resolve, reject) => {
@@ -284,8 +284,8 @@ module.exports = {
     });
   },
 
-  /**
-   * Parses the command line and kicks off Cypress process.
+  /**
+   * Parses the command line and kicks off Cypress process.
    */
   init(args) {
     if (!args) {

package/lib/cypress.js

@@ -16,18 +16,18 @@ const util = require('./util');
 const cli = require('./cli');
 
 const cypressModuleApi = {
-  /**
-   * Opens Cypress GUI
-   * @see https://on.cypress.io/module-api#cypress-open
+  /**
+   * Opens Cypress GUI
+   * @see https://on.cypress.io/module-api#cypress-open
    */
   open(options = {}) {
     options = util.normalizeModuleOptions(options);
     return open.start(options);
   },
 
-  /**
-   * Runs Cypress tests in the current project
-   * @see https://on.cypress.io/module-api#cypress-run
+  /**
+   * Runs Cypress tests in the current project
+   * @see https://on.cypress.io/module-api#cypress-run
    */
   run(options = {}) {
     if (!run.isValidProject(options.project)) {
@@ -56,15 +56,15 @@ const cypressModuleApi = {
   },
 
   cli: {
-    /**
-     * Parses CLI arguments into an object that you can pass to "cypress.run"
-     * @example
-     *  const cypress = require('cypress')
-     *  const cli = ['cypress', 'run', '--browser', 'firefox']
-     *  const options = await cypress.cli.parseRunArguments(cli)
-     *  // options is {browser: 'firefox'}
-     *  await cypress.run(options)
-     * @see https://on.cypress.io/module-api
+    /**
+     * Parses CLI arguments into an object that you can pass to "cypress.run"
+     * @example
+     *  const cypress = require('cypress')
+     *  const cli = ['cypress', 'run', '--browser', 'firefox']
+     *  const options = await cypress.cli.parseRunArguments(cli)
+     *  // options is {browser: 'firefox'}
+     *  await cypress.run(options)
+     * @see https://on.cypress.io/module-api
      */
     parseRunArguments(args) {
       return cli.parseRunCommand(args);
@@ -72,18 +72,18 @@ const cypressModuleApi = {
 
   },
 
-  /**
-   * Provides automatic code completion for configuration in many popular code editors.
-   * While it's not strictly necessary for Cypress to parse your configuration, we
-   * recommend wrapping your config object with `defineConfig()`
-   * @example
-   * module.exports = defineConfig({
-   *   viewportWith: 400
-   * })
-   *
-   * @see ../types/cypress-npm-api.d.ts
-   * @param {Cypress.ConfigOptions} config
-   * @returns {Cypress.ConfigOptions} the configuration passed in parameter
+  /**
+   * Provides automatic code completion for configuration in many popular code editors.
+   * While it's not strictly necessary for Cypress to parse your configuration, we
+   * recommend wrapping your config object with `defineConfig()`
+   * @example
+   * module.exports = defineConfig({
+   *   viewportWith: 400
+   * })
+   *
+   * @see ../types/cypress-npm-api.d.ts
+   * @param {Cypress.ConfigOptions} config
+   * @returns {Cypress.ConfigOptions} the configuration passed in parameter
    */
   defineConfig(config) {
     return config;

package/lib/errors.js

@@ -208,12 +208,12 @@ const invalidTestingType = {
   description: 'Invalid testingType',
   solution: `Please provide a valid testingType. Valid test types are ${chalk.cyan('\'e2e\'')} and ${chalk.cyan('\'component\'')}.`
 };
-/**
- * This error happens when CLI detects that the child Test Runner process
- * was killed with a signal, like SIGBUS
- * @see https://github.com/cypress-io/cypress/issues/5808
- * @param {'close'|'event'} eventName Child close event name
- * @param {string} signal Signal that closed the child process, like "SIGBUS"
+/**
+ * This error happens when CLI detects that the child Test Runner process
+ * was killed with a signal, like SIGBUS
+ * @see https://github.com/cypress-io/cypress/issues/5808
+ * @param {'close'|'event'} eventName Child close event name
+ * @param {string} signal Signal that closed the child process, like "SIGBUS"
 */
 
 const childProcessKilled = (eventName, signal) => {
@@ -240,17 +240,17 @@ function addPlatformInformation(info) {
     };
   });
 }
-/**
- * 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.
- * @param {object} errorObject
- * @returns {Promise<Error>} resolves with an Error
- * @example
-  ```js
-  // inside a Promise with "resolve" and "reject"
-  const errorObject = childProcessKilled('exit', 'SIGKILL')
-  return getError(errorObject).then(reject)
-  ```
+/**
+ * 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.
+ * @param {object} errorObject
+ * @returns {Promise<Error>} resolves with an Error
+ * @example
+  ```js
+  // inside a Promise with "resolve" and "reject"
+  const errorObject = childProcessKilled('exit', 'SIGKILL')
+  return getError(errorObject).then(reject)
+  ```
  */
 
 
@@ -261,9 +261,9 @@ 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.
+/**
+ * Forms nice error message with error and platform information,
+ * and if possible a way to solve it. Resolves with a string.
  */
 
 
@@ -343,11 +343,11 @@ const throwFormErrorText = info => {
     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')
+/**
+ * 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')
  */
 
 

package/lib/exec/run.js

@@ -19,11 +19,11 @@ const {
   processTestingType,
   throwInvalidOptionError
 } = 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.
+/**
+ * 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.
  */
 
 
@@ -38,14 +38,14 @@ const isValidProject = v => {
 
   return true;
 };
-/**
- * Maps options collected by the CLI
- * and forms list of CLI arguments to the server.
- *
- * Note: there is lightweight validation, with errors
- * thrown synchronously.
- *
- * @returns {string[]} list of CLI arguments
+/**
+ * Maps options collected by the CLI
+ * and forms list of CLI arguments to the server.
+ *
+ * Note: there is lightweight validation, with errors
+ * thrown synchronously.
+ *
+ * @returns {string[]} list of CLI arguments
  */
 
 

package/lib/exec/shared.js

@@ -3,10 +3,10 @@
 const {
   errors
 } = require('../errors');
-/**
- * Throws an error with "details" property from
- * "errors" object.
- * @param {Object} details - Error details
+/**
+ * Throws an error with "details" property from
+ * "errors" object.
+ * @param {Object} details - Error details
  */
 
 
@@ -21,10 +21,10 @@ const throwInvalidOptionError = details => {
   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
+/**
+ * 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
  */
 
 

package/lib/tasks/cache.js

@@ -72,9 +72,9 @@ const prune = () => {
 const fileSizeInMB = size => {
   return `${(size / 1024 / 1024).toFixed(1)}MB`;
 };
-/**
- * Collects all cached versions, finds when each was used
- * and prints a table with results to the terminal
+/**
+ * Collects all cached versions, finds when each was used
+ * and prints a table with results to the terminal
  */
 
 

package/lib/tasks/download.js

@@ -8,7 +8,7 @@ const is = require('check-more-types');
 
 const os = require('os');
 
-const url = require('url');
+const Url = require('url');
 
 const path = require('path');
 
@@ -36,6 +36,7 @@ const fs = require('../fs');
 const util = require('../util');
 
 const defaultBaseUrl = 'https://download.cypress.io/';
+const defaultMaxRedirects = 10;
 
 const getProxyForUrlWithNpmConfig = url => {
   return getProxyForUrl(url) || process.env.npm_config_https_proxy || process.env.npm_config_proxy || null;
@@ -76,9 +77,10 @@ const getCA = () => {
 };
 
 const prepend = urlPath => {
-  const endpoint = url.resolve(getBaseUrl(), urlPath);
+  const endpoint = Url.resolve(getBaseUrl(), urlPath);
   const platform = os.platform();
-  return `${endpoint}?platform=${platform}&arch=${arch()}`;
+  const pathTemplate = util.getEnv('CYPRESS_DOWNLOAD_PATH_TEMPLATE');
+  return pathTemplate ? pathTemplate.replace('${endpoint}', endpoint).replace('${platform}', platform).replace('${arch}', arch()) : `${endpoint}?platform=${platform}&arch=${arch()}`;
 };
 
 const getUrl = version => {
@@ -102,9 +104,9 @@ const prettyDownloadErr = (err, version) => {
   debug(msg);
   return throwFormErrorText(errors.failedDownload)(msg);
 };
-/**
- * Checks checksum and file size for the given file. Allows both
- * values or just one of them to be checked.
+/**
+ * Checks checksum and file size for the given file. Allows both
+ * values or just one of them to be checked.
  */
 
 
@@ -183,8 +185,18 @@ const downloadFromUrl = ({
   url,
   downloadDestination,
   progress,
-  ca
+  ca,
+  version,
+  redirectTTL = defaultMaxRedirects
 }) => {
+  if (redirectTTL <= 0) {
+    return Promise.reject(new Error(stripIndent`
+          Failed downloading the Cypress binary.
+          There were too many redirects. The default allowance is ${defaultMaxRedirects}.
+          Maybe you got stuck in a redirect loop?
+        `));
+  }
+
   return new Promise((resolve, reject) => {
     const proxy = getProxyForUrlWithNpmConfig(url);
     debug('Downloading package', {
@@ -192,35 +204,24 @@ const downloadFromUrl = ({
       proxy,
       downloadDestination
     });
-    let redirectVersion;
-    const reqOptions = {
-      url,
-      proxy,
-
-      followRedirect(response) {
-        const version = response.headers['x-version'];
-        debug('redirect version:', version);
-
-        if (version) {
-          // set the version in options if we have one.
-          // this insulates us from potential redirect
-          // problems where version would be set to undefined.
-          redirectVersion = version;
-        } // yes redirect
-
-
-        return true;
-      }
-
-    };
 
     if (ca) {
       debug('using custom CA details from npm config');
-      reqOptions.agentOptions = {
-        ca
-      };
     }
 
+    const reqOptions = {
+      uri: url,
+      ...(proxy ? {
+        proxy
+      } : {}),
+      ...(ca ? {
+        agentOptions: {
+          ca
+        }
+      } : {}),
+      method: 'GET',
+      followRedirect: false
+    };
     const req = request(reqOptions); // closure
 
     let started = null;
@@ -248,18 +249,46 @@ const downloadFromUrl = ({
       // response headers
 
 
-      started = new Date(); // if our status code does not start with 200
-
-      if (!/^2/.test(response.statusCode)) {
+      started = new Date();
+
+      if (/^3/.test(response.statusCode)) {
+        const redirectVersion = response.headers['x-version'];
+        const redirectUrl = response.headers.location;
+        debug('redirect version:', redirectVersion);
+        debug('redirect url:', redirectUrl);
+        downloadFromUrl({
+          url: redirectUrl,
+          progress,
+          ca,
+          downloadDestination,
+          version: redirectVersion,
+          redirectTTL: redirectTTL - 1
+        }).then(resolve).catch(reject); // if our status code does not start with 200
+      } else if (!/^2/.test(response.statusCode)) {
         debug('response code %d', response.statusCode);
         const err = new Error(stripIndent`
           Failed downloading the Cypress binary.
           Response code: ${response.statusCode}
           Response message: ${response.statusMessage}
         `);
-        reject(err);
+        reject(err); // status codes here are all 2xx
+      } else {
+        // We only enable this pipe connection when we know we've got a successful return
+        // and handle the completion with verify and resolve
+        // there was a possible race condition between end of request and close of writeStream
+        // that is made ordered with this Promise.all
+        Promise.all([new Promise(r => {
+          return response.pipe(fs.createWriteStream(downloadDestination).on('close', r));
+        }), new Promise(r => response.on('end', r))]).then(() => {
+          debug('downloading finished');
+          verifyDownloadedFile(downloadDestination, expectedSize, expectedChecksum).then(() => debug('verified')).then(() => resolve(version)).catch(reject);
+        });
       }
-    }).on('error', reject).on('progress', state => {
+    }).on('error', e => {
+      if (e.code === 'ECONNRESET') return; // sometimes proxies give ECONNRESET but we don't care
+
+      reject(e);
+    }).on('progress', state => {
       // total time we've elapsed
       // starting on our first progress notification
       const elapsed = new Date() - started; // request-progress sends a value between 0 and 1
@@ -268,19 +297,13 @@ const downloadFromUrl = ({
       const eta = util.calculateEta(percentage, elapsed); // send up our percent and seconds remaining
 
       progress.onProgress(percentage, util.secsRemaining(eta));
-    }) // save this download here
-    .pipe(fs.createWriteStream(downloadDestination)).on('finish', () => {
-      debug('downloading finished');
-      verifyDownloadedFile(downloadDestination, expectedSize, expectedChecksum).then(() => {
-        return resolve(redirectVersion);
-      }, reject);
     });
   });
 };
-/**
- * Download Cypress.zip from external url to local file.
- * @param [string] version Could be "3.3.0" or full URL
- * @param [string] downloadDestination Local filename to save as
+/**
+ * Download Cypress.zip from external url to local file.
+ * @param [string] version Could be "3.3.0" or full URL
+ * @param [string] downloadDestination Local filename to save as
  */
 
 
@@ -288,7 +311,8 @@ const start = opts => {
   let {
     version,
     downloadDestination,
-    progress
+    progress,
+    redirectTTL
   } = opts;
 
   if (!downloadDestination) {
@@ -316,7 +340,11 @@ const start = opts => {
       url,
       downloadDestination,
       progress,
-      ca
+      ca,
+      version,
+      ...(redirectTTL ? {
+        redirectTTL
+      } : {})
     });
   }).catch(err => {
     return prettyDownloadErr(err, version);

package/lib/tasks/get-folder-size.js

@@ -7,14 +7,14 @@ const {
 } = require('path');
 
 const Bluebird = require('bluebird');
-/**
- * Get the size of a folder or a file.
- *
- * This function returns the actual file size of the folder (size), not the allocated space on disk (size on disk).
- * For more details between the difference, check this link:
- * https://www.howtogeek.com/180369/why-is-there-a-big-difference-between-size-and-size-on-disk/
- *
- * @param {string} path path to the file or the folder.
+/**
+ * Get the size of a folder or a file.
+ *
+ * This function returns the actual file size of the folder (size), not the allocated space on disk (size on disk).
+ * For more details between the difference, check this link:
+ * https://www.howtogeek.com/180369/why-is-there-a-big-difference-between-size-and-size-on-disk/
+ *
+ * @param {string} path path to the file or the folder.
  */
 
 

package/lib/tasks/state.js

@@ -70,8 +70,8 @@ const getBinaryPkgPath = binaryDir => {
       throw new Error(`Platform: "${platform}" is not supported.`);
   }
 };
-/**
- * Get path to binary directory
+/**
+ * Get path to binary directory
 */
 
 
@@ -82,9 +82,9 @@ const getBinaryDir = (version = util.pkgVersion()) => {
 const getVersionDir = (version = util.pkgVersion()) => {
   return path.join(getCacheDir(), version);
 };
-/**
- * When executing "npm postinstall" hook, the working directory is set to
- * "<current folder>/node_modules/cypress", which can be surprising when using relative paths.
+/**
+ * When executing "npm postinstall" hook, the working directory is set to
+ * "<current folder>/node_modules/cypress", which can be surprising when using relative paths.
  */
 
 
@@ -134,10 +134,10 @@ const parseRealPlatformBinaryFolderAsync = binaryPath => {
 const getDistDir = () => {
   return path.join(__dirname, '..', '..', 'dist');
 };
-/**
- * Returns full filename to the file that keeps the Test Runner verification state as JSON text.
- * Note: the binary state file will be stored one level up from the given binary folder.
- * @param {string} binaryDir - full path to the folder holding the binary.
+/**
+ * Returns full filename to the file that keeps the Test Runner verification state as JSON text.
+ * Note: the binary state file will be stored one level up from the given binary folder.
+ * @param {string} binaryDir - full path to the folder holding the binary.
  */
 
 
@@ -162,11 +162,11 @@ const getBinaryVerifiedAsync = binaryDir => {
 const clearBinaryStateAsync = binaryDir => {
   return fs.removeAsync(getBinaryStatePath(binaryDir));
 };
-/**
- * Writes the new binary status.
- * @param {boolean} verified The new test runner state after smoke test
- * @param {string} binaryDir Folder holding the binary
- * @returns {Promise<void>} returns a promise
+/**
+ * Writes the new binary status.
+ * @param {boolean} verified The new test runner state after smoke test
+ * @param {string} binaryDir Folder holding the binary
+ * @returns {Promise<void>} returns a promise
  */
 
 
@@ -183,9 +183,9 @@ const writeBinaryVerifiedAsync = (verified, binaryDir) => {
 const getPathToExecutable = binaryDir => {
   return path.join(binaryDir, getPlatformExecutable());
 };
-/**
- * Resolves with an object read from the binary app package.json file.
- * If the file does not exist resolves with null
+/**
+ * Resolves with an object read from the binary app package.json file.
+ * If the file does not exist resolves with null
  */