cypress 7.5.0 → 8.1.0

package/README.md

@@ -1,8 +1,10 @@
 # Cypress
 
+Fast, easy and reliable testing for anything that runs in a browser.
+
 ## What is this?
 
-Cypress comes packaged as an `npm` module, which is all you need to get started.
+[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:
 
@@ -12,7 +14,7 @@ After installing you'll be able to:
 
 ## Install
 
-Requires Node version >= 10.0.0
+Please check our [system requirements](https://on.cypress.io/installing-cypress).
 
 ```sh
 npm install --save-dev cypress

package/lib/VerboseRenderer.js

@@ -0,0 +1,72 @@
+"use strict";
+
+// Vendored from @cypress/listr-verbose-renderer
+const figures = require('figures');
+
+const cliCursor = require('cli-cursor');
+
+const chalk = require('chalk');
+
+const dayjs = require('dayjs');
+
+const formattedLog = (options, output) => {
+  const timestamp = dayjs().format(options.dateFormat); // eslint-disable-next-line no-console
+
+  console.log(`${chalk.dim(`[${timestamp}]`)} ${output}`);
+};
+
+const renderHelper = (task, event, options) => {
+  const log = formattedLog.bind(undefined, options);
+
+  if (event.type === 'STATE') {
+    const message = task.isPending() ? 'started' : task.state;
+    log(`${task.title} [${message}]`);
+
+    if (task.isSkipped() && task.output) {
+      log(`${figures.arrowRight} ${task.output}`);
+    }
+  } else if (event.type === 'TITLE') {
+    log(`${task.title} [title changed]`);
+  }
+};
+
+const render = (tasks, options) => {
+  for (const task of tasks) {
+    task.subscribe(event => {
+      if (event.type === 'SUBTASKS') {
+        render(task.subtasks, options);
+        return;
+      }
+
+      renderHelper(task, event, options);
+    }, err => {
+      // eslint-disable-next-line no-console
+      console.log(err);
+    });
+  }
+};
+
+class VerboseRenderer {
+  constructor(tasks, options) {
+    this._tasks = tasks;
+    this._options = Object.assign({
+      dateFormat: 'HH:mm:ss'
+    }, options);
+  }
+
+  static get nonTTY() {
+    return true;
+  }
+
+  render() {
+    cliCursor.hide();
+    render(this._tasks, this._options);
+  }
+
+  end() {
+    cliCursor.show();
+  }
+
+}
+
+module.exports = VerboseRenderer;

package/lib/cli.js

@@ -129,8 +129,8 @@ const descriptions = {
   forceInstall: 'force install the Cypress binary',
   global: 'force Cypress into global mode as if its globally installed',
   group: 'a named group for recorded runs in the Cypress Dashboard',
-  headed: 'displays the browser instead of running headlessly (defaults to true for Firefox and Chromium-family browsers)',
-  headless: 'hide the browser instead of running headed (defaults to true for Electron)',
+  headed: 'displays the browser instead of running headlessly',
+  headless: 'hide the browser instead of running headed (default for cypress run)',
   key: 'your secret Record Key. you can omit this if you set a CYPRESS_RECORD_KEY environment variable.',
   parallel: 'enables concurrent runs and automatic load balancing of specs across multiple machines or processes',
   port: 'runs Cypress on a specific port. overrides any value in cypress.json.',

package/lib/errors.js

@@ -151,13 +151,9 @@ const invalidSmokeTestDisplayError = {
 
       ${hr}
 
-      This is usually caused by a missing library or dependency.
+      This may be due to a missing library or dependency. ${chalk.blue(requiredDependenciesUrl)}
 
-      The error above should indicate which dependency is missing.
-
-        ${chalk.blue(requiredDependenciesUrl)}
-
-      If you are using Docker, we provide containers with all required dependencies installed.
+      Please refer to the error above for more detail.
     `;
   }
 
@@ -166,13 +162,9 @@ const missingDependency = {
   description: 'Cypress failed to start.',
   // this message is too Linux specific
   solution: stripIndent`
-    This is usually caused by a missing library or dependency.
-
-    The error below should indicate which dependency is missing.
+    This may be due to a missing library or dependency. ${chalk.blue(requiredDependenciesUrl)}
 
-      ${chalk.blue(requiredDependenciesUrl)}
-
-    If you are using Docker, we provide containers with all required dependencies installed.
+    Please refer to the error below for more details.
   `
 };
 const invalidCacheDirectory = {

package/lib/exec/spawn.js

@@ -76,15 +76,17 @@ module.exports = {
       executable = path.resolve(util.getEnv('CYPRESS_RUN_BINARY'));
     }
 
-    debug('needs to start own Xvfb?', needsXvfb); // 1. Start arguments with "--" so Electron knows these are OUR
-    // arguments and does not try to sanitize them. Otherwise on Windows
-    // an url in one of the arguments crashes it :(
-    // https://github.com/cypress-io/cypress/issues/5466
-    // 2. Always push cwd into the args
+    debug('needs to start own Xvfb?', needsXvfb); // Always push cwd into the args
     // which additionally acts as a signal to the
     // binary that it was invoked through the NPM module
 
-    args = ['--'].concat(args, '--cwd', process.cwd());
+    args = args || [];
+
+    if (typeof args === 'string') {
+      args = [args];
+    }
+
+    args = [...args, '--cwd', process.cwd()];
 
     _.defaults(options, {
       dev: false,
@@ -100,28 +102,24 @@ module.exports = {
           electronLogging: false
         });
 
-        if (options.dev) {
-          // if we're in dev then reset
-          // the launch cmd to be 'npm run dev'
-          executable = 'node';
-          args.unshift(path.resolve(__dirname, '..', '..', '..', 'scripts', 'start.js'));
-          debug('in dev mode the args became %o', args);
-        }
-
         const {
           onStderrData,
           electronLogging
         } = overrides;
         const envOverrides = util.getEnvOverrides(options);
-
-        const electronArgs = _.clone(args);
-
+        const electronArgs = [];
         const node11WindowsFix = isPlatform('win32');
 
+        if (options.dev) {
+          // if we're in dev then reset
+          // the launch cmd to be 'npm run dev'
+          executable = 'node';
+          electronArgs.unshift(path.resolve(__dirname, '..', '..', '..', 'scripts', 'start.js'));
+          debug('in dev mode the args became %o', args);
+        }
+
         if (!options.dev && verify.needsSandbox()) {
-          // this is one of the Electron's command line switches
-          // thus it needs to be before "--" separator
-          electronArgs.unshift('--no-sandbox');
+          electronArgs.push('--no-sandbox');
         } // strip dev out of child process options
 
 
@@ -148,9 +146,21 @@ module.exports = {
           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.
+          const serverEntryPoint = path.join(state.getBinaryPkgPath(path.dirname(executable)), '..', 'index.js');
+          args = [serverEntryPoint, ...args];
+        } else {
+          // Start arguments with "--" so Electron knows these are OUR
+          // arguments and does not try to sanitize them. Otherwise on Windows
+          // an url in one of the arguments crashes it :(
+          // https://github.com/cypress-io/cypress/issues/5466
+          args = [...electronArgs, '--', ...args];
+        }
+
         debug('spawning Cypress with executable: %s', executable);
-        debug('spawn args %o %o', electronArgs, _.omit(stdioOptions, 'env'));
-        const child = cp.spawn(executable, electronArgs, stdioOptions);
+        debug('spawn args %o %o', args, _.omit(stdioOptions, 'env'));
+        const child = cp.spawn(executable, args, stdioOptions);
 
         function resolveOn(event) {
           return function (code, signal) {

package/lib/exec/xvfb.js

@@ -65,6 +65,11 @@ module.exports = {
   },
 
   isNeeded() {
+    if (process.env.ELECTRON_RUN_AS_NODE) {
+      debug('Environment variable ELECTRON_RUN_AS_NODE detected, xvfb is not needed');
+      return false; // xvfb required for electron processes only.
+    }
+
     if (os.platform() !== 'linux') {
       return false;
     }

package/lib/tasks/install.js

@@ -16,8 +16,6 @@ const {
   Listr
 } = require('listr2');
 
-const verbose = require('@cypress/listr-verbose-renderer');
-
 const Promise = require('bluebird');
 
 const logSymbols = require('log-symbols');
@@ -43,6 +41,8 @@ const {
   errors
 } = require('../errors');
 
+const verbose = require('../VerboseRenderer');
+
 const getNpmArgv = () => {
   const json = process.env.npm_config_argv;
 

package/lib/tasks/verify.js

@@ -10,8 +10,6 @@ const {
 
 const debug = require('debug')('cypress:cli');
 
-const verbose = require('@cypress/listr-verbose-renderer');
-
 const {
   stripIndent
 } = require('common-tags');
@@ -24,6 +22,8 @@ const path = require('path');
 
 const os = require('os');
 
+const verbose = require('../VerboseRenderer');
+
 const {
   throwFormErrorText,
   errors

package/lib/util.js

@@ -263,7 +263,17 @@ const util = {
     .mapValues(value => {
       // stringify to 1 or 0
       return value ? '1' : '0';
-    }).value();
+    }).extend(util.getOriginalNodeOptions(options)).value();
+  },
+
+  getOriginalNodeOptions(options) {
+    if (process.env.NODE_OPTIONS) {
+      return {
+        ORIGINAL_NODE_OPTIONS: process.env.NODE_OPTIONS
+      };
+    }
+
+    return {};
   },
 
   getForceTty() {

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "cypress",
-  "version": "7.5.0",
+  "version": "8.1.0",
   "main": "index.js",
   "scripts": {
     "postinstall": "node index.js --exec install",
     "size": "t=\"$(npm pack .)\"; wc -c \"${t}\"; tar tvf \"${t}\"; rm \"${t}\";"
   },
   "dependencies": {
-    "@cypress/listr-verbose-renderer": "^0.4.1",
     "@cypress/request": "^2.88.5",
     "@cypress/xvfb": "^1.2.4",
     "@types/node": "^14.14.31",
@@ -19,15 +18,18 @@
     "cachedir": "^2.3.0",
     "chalk": "^4.1.0",
     "check-more-types": "^2.24.0",
+    "cli-cursor": "^3.1.0",
     "cli-table3": "~0.6.0",
     "commander": "^5.1.0",
     "common-tags": "^1.8.0",
     "dayjs": "^1.10.4",
-    "debug": "4.3.2",
+    "debug": "^4.3.2",
+    "enquirer": "^2.3.6",
     "eventemitter2": "^6.4.3",
     "execa": "4.1.0",
     "executable": "^4.1.1",
     "extract-zip": "2.0.1",
+    "figures": "^3.2.0",
     "fs-extra": "^9.1.0",
     "getos": "^3.2.1",
     "is-ci": "^3.0.0",

package/types/cypress-npm-api.d.ts

@@ -138,7 +138,7 @@ declare namespace CypressCommandLine {
     /**
      * Specify configuration
      */
-    config: Partial<Cypress.ResolvedConfigOptions>
+    config: Cypress.ConfigOptions
     /**
      * Path to the config file to be used.
      *

package/types/cypress.d.ts

@@ -60,10 +60,26 @@ declare namespace Cypress {
      */
     displayName: string
     version: string
-    majorVersion: number
+    majorVersion: number | string
     path: string
     isHeaded: boolean
     isHeadless: boolean
+    /**
+     * Informational text to accompany this browser. Shown in desktop-gui.
+     */
+    info?: string
+    /**
+     * Warning text to accompany this browser. Shown in desktop-gui.
+     */
+    warning?: string
+    /**
+     * The minimum majorVersion of this browser supported by Cypress.
+     */
+    minSupportedVersion?: number
+    /**
+     * If `true`, this browser is too old to be supported by Cypress.
+     */
+    unsupportedVersion?: boolean
   }
 
   interface LocalStorage {
@@ -341,15 +357,6 @@ declare namespace Cypress {
      */
     env(object: ObjectLike): void
 
-    /**
-     * Firefox only: Get the current number of tests that will run between forced garbage collections.
-     *
-     * Returns undefined if not in Firefox, returns a null or 0 if forced GC is disabled.
-     *
-     * @see https://on.cypress.io/firefox-gc-issue
-     */
-    getFirefoxGcInterval(): number | null | undefined
-
     /**
      * @returns the number of test retries currently enabled for the run
      */
@@ -490,6 +497,13 @@ declare namespace Cypress {
       getElementCoordinatesByPositionRelativeToXY(element: JQuery | HTMLElement, x: number, y: number): ElementPositioning
     }
 
+    /**
+     * @see https://on.cypress.io/keyboard-api
+     */
+     Keyboard: {
+      defaults(options: Partial<KeyboardDefaultsOptions>): void
+    }
+
     /**
      * @see https://on.cypress.io/api/api-server
      */
@@ -841,7 +855,7 @@ declare namespace Cypress {
      *    // tries to find the given text for up to 1 second
      *    cy.contains('my text to find', {timeout: 1000})
      */
-    contains(content: string | number | RegExp, options?: Partial<Loggable & Timeoutable & CaseMatchable>): Chainable<Subject>
+    contains(content: string | number | RegExp, options?: Partial<Loggable & Timeoutable & CaseMatchable & Shadow>): Chainable<Subject>
     /**
      * Get the child DOM element that contains given text.
      *
@@ -859,7 +873,7 @@ declare namespace Cypress {
      *    // yields <ul>...</ul>
      *    cy.contains('ul', 'apples')
      */
-    contains<K extends keyof HTMLElementTagNameMap>(selector: K, text: string | number | RegExp, options?: Partial<Loggable & Timeoutable & CaseMatchable>): Chainable<JQuery<HTMLElementTagNameMap[K]>>
+    contains<K extends keyof HTMLElementTagNameMap>(selector: K, text: string | number | RegExp, options?: Partial<Loggable & Timeoutable & CaseMatchable & Shadow>): Chainable<JQuery<HTMLElementTagNameMap[K]>>
     /**
      * Get the DOM element using CSS "selector" containing the text or regular expression.
      *
@@ -868,7 +882,7 @@ declare namespace Cypress {
      *    // yields <... class="foo">... apples ...</...>
      *    cy.contains('.foo', 'apples')
      */
-    contains<E extends Node = HTMLElement>(selector: string, text: string | number | RegExp, options?: Partial<Loggable & Timeoutable & CaseMatchable>): Chainable<JQuery<E>>
+    contains<E extends Node = HTMLElement>(selector: string, text: string | number | RegExp, options?: Partial<Loggable & Timeoutable & CaseMatchable & Shadow>): Chainable<JQuery<E>>
 
     /**
      * Double-click a DOM element.
@@ -1647,7 +1661,7 @@ declare namespace Cypress {
      *    .shadow()
      *    .find('.my-button')
      *    .click()
-     * @see https://on.cypress.io/experimental
+     * @see https://on.cypress.io/shadow
      */
     shadow(): Chainable<Subject>
 
@@ -1826,6 +1840,12 @@ declare namespace Cypress {
      * @see https://on.cypress.io/then
      */
     then<S>(options: Partial<Timeoutable>, fn: (this: ObjectLike, currentSubject: Subject) => PromiseLike<S>): Chainable<S>
+    /**
+     * Enables you to work with the subject yielded from the previous command / promise.
+     *
+     * @see https://on.cypress.io/then
+     */
+    then<S extends string | number | boolean>(fn: (this: ObjectLike, currentSubject: Subject) => S): Chainable<S>
     /**
      * Enables you to work with the subject yielded from the previous command / promise.
      *
@@ -1843,7 +1863,7 @@ declare namespace Cypress {
      *
      * @see https://on.cypress.io/then
      */
-    then<S extends object | any[] | string | number | boolean>(fn: (this: ObjectLike, currentSubject: Subject) => S): Chainable<S>
+    then<S extends any[] | object>(fn: (this: ObjectLike, currentSubject: Subject) => S): Chainable<S>
     /**
      * Enables you to work with the subject yielded from the previous command / promise.
      *
@@ -2633,13 +2653,6 @@ declare namespace Cypress {
      * @default 'top'
      */
     scrollBehavior: scrollBehaviorOptions
-    /**
-     * Firefox version 79 and below only: The number of tests that will run between forced garbage collections.
-     * If a number is supplied, it will apply to `run` mode and `open` mode.
-     * Set the interval to `null` or 0 to disable forced garbage collections.
-     * @default { runMode: 1, openMode: null }
-     */
-    firefoxGcInterval: Nullable<number | { runMode: Nullable<number>, openMode: Nullable<number> }>
     /**
      * Allows listening to the `before:run`, `after:run`, `before:spec`, and `after:spec` events in the plugins file during interactive mode.
      * @default false
@@ -2671,17 +2684,46 @@ declare namespace Cypress {
      */
     includeShadowDom: boolean
 
+    /**
+     * The list of hosts to be blocked
+     */
+    blockHosts: null | string | string[]
+    /**
+     * Path to folder containing component test files.
+     */
+    componentFolder: false | string
+    /**
+     * A unique ID for the project used for recording
+     */
+    projectId: null | string
+    /**
+     * Path to the support folder.
+     */
+    supportFolder: string
+    /**
+     * Glob pattern to determine what test files to load.
+     */
+    testFiles: string | string[]
+    /**
+     * The user agent the browser sends in all request headers.
+     */
+    userAgent: null | string
+    /**
+     * Polyfills `window.fetch` to enable Network spying and stubbing
+     */
+    experimentalFetchPolyfill: boolean
+
     /**
      * Override default config options for Component Testing runner.
      * @default {}
      */
-    component: ResolvedConfigOptions
+    component: Omit<ResolvedConfigOptions, TestingType>
 
     /**
      * Override default config options for E2E Testing runner.
      * @default {}
      */
-    e2e: ResolvedConfigOptions
+    e2e: Omit<ResolvedConfigOptions, TestingType>
   }
 
   /**
@@ -2694,10 +2736,6 @@ declare namespace Cypress {
      * @see https://nodejs.org/api/os.html#os_os_arch
      */
     arch: string
-    /**
-     * The list of hosts to be blocked
-     */
-    blockHosts: null | string | string[]
     /**
      * The browser Cypress is running on.
      */
@@ -2706,10 +2744,6 @@ declare namespace Cypress {
      * Available browsers found on your system.
      */
     browsers: Browser[]
-    /**
-     * Path to folder containing component test files.
-     */
-    componentFolder: string
     /**
      * Hosts mappings to IP addresses.
      */
@@ -2729,22 +2763,6 @@ declare namespace Cypress {
      * The platform Cypress is running on.
      */
     platform: 'linux' | 'darwin' | 'win32'
-    /**
-     * A unique ID for the project used for recording
-     */
-    projectId: null | string
-    /**
-     * Path to the support folder.
-     */
-    supportFolder: string
-    /**
-     * Glob pattern to determine what test files to load.
-     */
-    testFiles: string
-    /**
-     * The user agent the browser sends in all request headers.
-     */
-    userAgent: null | string
     /**
      * The Cypress version being used.
      */
@@ -2756,8 +2774,7 @@ declare namespace Cypress {
     clientRoute: string
     configFile: string
     cypressEnv: string
-    integrationExampleName: string
-    integrationExamplePath: string
+    devServerPublicPathRoute: string
     isNewProject: boolean
     isTextTerminal: boolean
     morgan: boolean
@@ -2786,12 +2803,14 @@ declare namespace Cypress {
 
   interface TestConfigOverrides extends Partial<Pick<ConfigOptions, 'animationDistanceThreshold' | 'baseUrl' | 'defaultCommandTimeout' | 'env' | 'execTimeout' | 'includeShadowDom' | 'requestTimeout' | 'responseTimeout' | 'retries' | 'scrollBehavior' | 'taskTimeout' | 'viewportHeight' | 'viewportWidth' | 'waitForAnimations'>> {
     browser?: IsBrowserMatcher | IsBrowserMatcher[]
+    keystrokeDelay?: number
   }
 
   /**
    * All configuration items are optional.
    */
-  type ConfigOptions = Partial<ResolvedConfigOptions>
+  type CoreConfigOptions = Partial<Omit<ResolvedConfigOptions, TestingType>>
+  type ConfigOptions = CoreConfigOptions & {e2e?: CoreConfigOptions, component?: CoreConfigOptions }
 
   interface PluginConfigOptions extends ResolvedConfigOptions {
     /**
@@ -2836,6 +2855,18 @@ declare namespace Cypress {
     env: object
   }
 
+  /**
+   * Options for Cypress.Keyboard.defaults()
+   */
+  interface KeyboardDefaultsOptions {
+    /**
+    * Time, in milliseconds, between each keystroke when typing. (Pass 0 to disable)
+    *
+    * @default 10
+    */
+    keystrokeDelay: number
+  }
+
   /**
    * Full set of possible options for cy.request call
    */

package/types/net-stubbing.ts

@@ -79,7 +79,7 @@ export namespace CyHttpMessages {
     /**
      * The headers of the HTTP message.
      */
-    headers: { [key: string]: string }
+    headers: { [key: string]: string | string[] }
   }
 
   export type IncomingResponse = BaseMessage & {
@@ -131,6 +131,10 @@ export namespace CyHttpMessages {
      * Request URL.
      */
     url: string
+    /**
+     * URL query string as object.
+     */
+    query: Record<string, string|number>
     /**
      * The HTTP version used in the request. Read only.
      */
@@ -383,7 +387,7 @@ export type RouteHandler = string | StaticResponse | RouteHandlerController | ob
 /**
  * Describes a response that will be sent back to the browser to fulfill the request.
  */
-export type StaticResponse = GenericStaticResponse<string, string | object | boolean | null> & {
+export type StaticResponse = GenericStaticResponse<string, string | object | boolean | ArrayBuffer | null> & {
   /**
    * Milliseconds to delay before the response is sent.
    * @deprecated Use `delay` instead of `delayMs`.