cypress 7.6.0 → 8.2.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/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/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,6 +1,6 @@
 {
   "name": "cypress",
-  "version": "7.6.0",
+  "version": "8.2.0",
   "main": "index.js",
   "scripts": {
     "postinstall": "node index.js --exec install",

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

@@ -64,6 +64,22 @@ declare namespace Cypress {
     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 {
@@ -242,6 +258,14 @@ declare namespace Cypress {
      */
     spec: Spec
 
+    /**
+     * Currently executing test runnable instance.
+     */
+    currentTest: {
+      title: string,
+      titlePath: string[]
+    }
+
     /**
      * Information about the browser currently running the tests
      */
@@ -341,15 +365,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
      */
@@ -550,6 +565,10 @@ declare namespace Cypress {
     onSpecWindow: (window: Window, specList: string[] | Array<() => Promise<void>>) => void
   }
 
+  interface SessionOptions {
+    validate?: () => false|void
+  }
+
   type CanReturnChainable = void | Chainable | Promise<unknown>
   type ThenReturn<S, R> =
     R extends void ? Chainable<S> :
@@ -848,7 +867,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.
      *
@@ -866,7 +885,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.
      *
@@ -875,7 +894,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.
@@ -945,6 +964,15 @@ declare namespace Cypress {
      */
     debug(options?: Partial<Loggable>): Chainable<Subject>
 
+   /**
+     * Save/Restore browser Cookies, LocalStorage, and SessionStorage data resulting from the supplied `setup` function.
+     *
+     * Only available if the `experimentalSessionSupport` config option is enabled.
+     *
+     * @see https://on.cypress.io/session
+     */
+    session(id: string|object, setup?: SessionOptions['validate'], options?: SessionOptions): Chainable<null>
+
     /**
      * Get the window.document of the page that is currently active.
      *
@@ -1654,7 +1682,7 @@ declare namespace Cypress {
      *    .shadow()
      *    .find('.my-button')
      *    .click()
-     * @see https://on.cypress.io/experimental
+     * @see https://on.cypress.io/shadow
      */
     shadow(): Chainable<Subject>
 
@@ -1833,6 +1861,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.
      *
@@ -1850,7 +1884,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.
      *
@@ -2641,12 +2675,10 @@ declare namespace Cypress {
      */
     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 }
+     * Enable experimental session support. See https://on.cypress.io/session
+     * @default false
      */
-    firefoxGcInterval: Nullable<number | { runMode: Nullable<number>, openMode: Nullable<number> }>
+    experimentalSessionSupport: boolean
     /**
      * Allows listening to the `before:run`, `after:run`, `before:spec`, and `after:spec` events in the plugins file during interactive mode.
      * @default false
@@ -2678,17 +2710,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>
   }
 
   /**
@@ -2701,10 +2762,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.
      */
@@ -2713,10 +2770,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.
      */
@@ -2736,22 +2789,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.
      */
@@ -2763,6 +2800,7 @@ declare namespace Cypress {
     clientRoute: string
     configFile: string
     cypressEnv: string
+    devServerPublicPathRoute: string
     isNewProject: boolean
     isTextTerminal: boolean
     morgan: boolean
@@ -2797,7 +2835,8 @@ declare namespace Cypress {
   /**
    * 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 {
     /**
@@ -5496,6 +5535,7 @@ declare namespace Cypress {
 
   interface Log {
     end(): Log
+    error(error: Error): Log
     finish(): void
     get<K extends keyof LogConfig>(attr: K): LogConfig[K]
     get(): LogConfig

package/types/net-stubbing.ts

@@ -267,9 +267,11 @@ interface RequestEvents {
  */
 export interface Interception {
   id: string
+  /* @internal */
+  browserRequestId?: string
   routeId: string
   /* @internal */
-  log?: any
+  setLogFlag: (flag: 'spied' | 'stubbed' | 'reqModified' | 'resModified') => void
   request: CyHttpMessages.IncomingRequest
   /**
    * Was `cy.wait()` used to wait on this request?