cypress 7.3.0 → 7.7.0

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/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/tasks/install.js

@@ -12,9 +12,9 @@ const chalk = require('chalk');
 
 const debug = require('debug')('cypress:cli');
 
-const Listr = require('listr');
-
-const verbose = require('@cypress/listr-verbose-renderer');
+const {
+  Listr
+} = require('listr2');
 
 const Promise = require('bluebird');
 
@@ -41,6 +41,8 @@ const {
   errors
 } = require('../errors');
 
+const verbose = require('../VerboseRenderer');
+
 const getNpmArgv = () => {
   const json = process.env.npm_config_argv;
 
@@ -179,7 +181,9 @@ const downloadAndUnzip = ({
   logger.log(`Installing Cypress ${chalk.gray(`(version: ${version})`)}`);
   logger.log();
   const tasks = new Listr([{
-    title: util.titleize('Downloading Cypress'),
+    options: {
+      title: util.titleize('Downloading Cypress')
+    },
     task: (ctx, task) => {
       // as our download progresses indicate the status
       progress.onProgress = progessify(task, 'Downloading Cypress');
@@ -201,7 +205,9 @@ const downloadAndUnzip = ({
     installDir,
     rendererOptions
   }), {
-    title: util.titleize('Finishing Installation'),
+    options: {
+      title: util.titleize('Finishing Installation')
+    },
     task: (ctx, task) => {
       const cleanup = () => {
         debug('removing zip file %s', downloadDestination);
@@ -213,7 +219,9 @@ const downloadAndUnzip = ({
         util.setTaskTitle(task, util.titleize(chalk.green('Finished Installation'), chalk.gray(installDir)), rendererOptions.renderer);
       });
     }
-  }], rendererOptions); // start the tasks!
+  }], {
+    rendererOptions
+  }); // start the tasks!
 
   return Promise.resolve(tasks.run());
 };
@@ -361,7 +369,9 @@ const start = (options = {}) => {
           zipFilePath: absolutePath,
           installDir,
           rendererOptions
-        })], rendererOptions).run();
+        })], {
+          rendererOptions
+        }).run();
       }
 
       if (options.force) {
@@ -396,7 +406,9 @@ const unzipTask = ({
   rendererOptions
 }) => {
   return {
-    title: util.titleize('Unzipping Cypress'),
+    options: {
+      title: util.titleize('Unzipping Cypress')
+    },
     task: (ctx, task) => {
       // as our unzip progresses indicate the status
       progress.onProgress = progessify(task, 'Unzipping Cypress');

package/lib/tasks/unzip.js

@@ -78,23 +78,20 @@ const unzip = ({
 
         const unzipWithNode = () => {
           debug('unzipping with node.js (slow)');
-
-          const endFn = err => {
-            if (err) {
-              debug('error %s', err.message);
-              return reject(err);
-            }
-
-            debug('node unzip finished');
-            return resolve();
-          };
-
           const opts = {
             dir: installDir,
             onEntry: tick
           };
           debug('calling Node extract tool %s %o', zipFilePath, opts);
-          return unzipTools.extract(zipFilePath, opts, endFn);
+          return unzipTools.extract(zipFilePath, opts).then(() => {
+            debug('node unzip finished');
+            return resolve();
+          }).catch(err => {
+            if (err) {
+              debug('error %s', err.message);
+              return reject(err);
+            }
+          });
         };
 
         const unzipFallback = _.once(unzipWithNode);

package/lib/tasks/verify.js

@@ -4,12 +4,12 @@ const _ = require('lodash');
 
 const chalk = require('chalk');
 
-const Listr = require('listr');
+const {
+  Listr
+} = require('listr2');
 
 const debug = require('debug')('cypress:cli');
 
-const verbose = require('@cypress/listr-verbose-renderer');
-
 const {
   stripIndent
 } = require('common-tags');
@@ -22,6 +22,8 @@ const path = require('path');
 
 const os = require('os');
 
+const verbose = require('../VerboseRenderer');
+
 const {
   throwFormErrorText,
   errors
@@ -184,7 +186,9 @@ function testBinary(version, binaryDir, options) {
     renderer
   };
   const tasks = new Listr([{
-    title: util.titleize('Verifying Cypress can run', chalk.gray(binaryDir)),
+    options: {
+      title: util.titleize('Verifying Cypress can run', chalk.gray(binaryDir))
+    },
     task: (ctx, task) => {
       debug('clearing out the verified version');
       return state.clearBinaryStateAsync(binaryDir).then(() => {
@@ -197,7 +201,9 @@ function testBinary(version, binaryDir, options) {
         util.setTaskTitle(task, util.titleize(chalk.green('Verified Cypress!'), chalk.gray(binaryDir)), rendererOptions.renderer);
       });
     }
-  }], rendererOptions);
+  }], {
+    rendererOptions
+  });
   return tasks.run();
 }
 

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "cypress",
-  "version": "7.3.0",
+  "version": "7.7.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,21 +18,24 @@
     "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": "^1.7.0",
+    "extract-zip": "2.0.1",
+    "figures": "^3.2.0",
     "fs-extra": "^9.1.0",
     "getos": "^3.2.1",
     "is-ci": "^3.0.0",
     "is-installed-globally": "~0.4.0",
     "lazy-ass": "^1.6.0",
-    "listr": "^0.14.3",
+    "listr2": "^3.8.3",
     "lodash": "^4.17.21",
     "log-symbols": "^4.0.0",
     "minimist": "^1.2.5",
@@ -62,7 +64,6 @@
   },
   "types": "types",
   "description": "Cypress.io end to end testing tool",
-  "author": "Brian Mann",
   "homepage": "https://github.com/cypress-io/cypress",
   "license": "MIT",
   "bugs": {

package/types/chai/index.d.ts

@@ -1949,6 +1949,8 @@ declare module "chai" {
     export = chai;
 }
 
-interface Object {
-    should: Chai.Assertion;
-}
+// const a = 1; a.should(1); doesn't work with Cypress
+// https://github.com/cypress-io/cypress/issues/16548
+// interface Object {
+//     should: Chai.Assertion;
+// }

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

@@ -160,7 +160,7 @@ declare namespace CypressCommandLine {
      * Specify the type of tests to execute.
      * @default "e2e"
      */
-    testingType: 'e2e' | 'component'
+    testingType: Cypress.TestingType
   }
 
   // small utility types to better express meaning of other types

package/types/cypress.d.ts

@@ -8,6 +8,7 @@ declare namespace Cypress {
   type RequestBody = string | object
   type ViewportOrientation = 'portrait' | 'landscape'
   type PrevSubject = 'optional' | 'element' | 'document' | 'window'
+  type TestingType = 'e2e' | 'component'
   type PluginConfig = (on: PluginEvents, config: PluginConfigOptions) => void | ConfigOptions | Promise<ConfigOptions>
 
   interface CommandOptions {
@@ -59,7 +60,7 @@ declare namespace Cypress {
      */
     displayName: string
     version: string
-    majorVersion: number
+    majorVersion: number | string
     path: string
     isHeaded: boolean
     isHeadless: boolean
@@ -251,6 +252,11 @@ declare namespace Cypress {
      */
     LocalStorage: LocalStorage
 
+    /**
+     * Current testing type, determined by the Test Runner chosen to run.
+     */
+    testingType: TestingType
+
     /**
      * Fire automation:request event for internal use.
      */
@@ -484,6 +490,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
      */
@@ -835,7 +848,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.
      *
@@ -853,7 +866,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.
      *
@@ -862,7 +875,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.
@@ -1464,7 +1477,7 @@ declare namespace Cypress {
      * @example
      *    cy.request('http://dev.local/seed')
      */
-    request(url: string, body?: RequestBody): Chainable<Response>
+    request<T = any>(url: string, body?: RequestBody): Chainable<Response<T>>
     /**
      * Make an HTTP request with specific method.
      *
@@ -1472,7 +1485,7 @@ declare namespace Cypress {
      * @example
      *    cy.request('POST', 'http://localhost:8888/users', {name: 'Jane'})
      */
-    request(method: HttpMethod, url: string, body?: RequestBody): Chainable<Response>
+    request<T = any>(method: HttpMethod, url: string, body?: RequestBody): Chainable<Response<T>>
     /**
      * Make an HTTP request with specific behavior.
      *
@@ -1483,7 +1496,7 @@ declare namespace Cypress {
      *      followRedirect: false // turn off following redirects
      *    })
      */
-    request(options: Partial<RequestOptions>): Chainable<Response>
+    request<T = any>(options: Partial<RequestOptions>): Chainable<Response<T>>
 
     /**
      * Get the root DOM element.
@@ -2750,8 +2763,6 @@ declare namespace Cypress {
     clientRoute: string
     configFile: string
     cypressEnv: string
-    integrationExampleName: string
-    integrationExamplePath: string
     isNewProject: boolean
     isTextTerminal: boolean
     morgan: boolean
@@ -2780,6 +2791,7 @@ 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
   }
 
   /**
@@ -2799,7 +2811,7 @@ declare namespace Cypress {
     /**
      * Type of test and associated runner that was launched.
      */
-    testingType: 'e2e' | 'component'
+    testingType: TestingType
     /**
      * Cypress version.
      */
@@ -2830,6 +2842,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
    */
@@ -5496,9 +5520,9 @@ declare namespace Cypress {
     consoleProps(): ObjectLike
   }
 
-  interface Response {
+  interface Response<T> {
     allRequestResponses: any[]
-    body: any
+    body: T
     duration: number
     headers: { [key: string]: string | string[] }
     isOkStatusCode: boolean

package/types/minimatch/index.d.ts

@@ -175,37 +175,27 @@ declare namespace M {
         matchOne(files: string[], pattern: string[], partial: boolean): boolean;
 
         /**
-         * Deprecated. For internal use.
-         *
-         * @private
+         * @deprecated. For internal use.
          */
         debug(): void;
 
         /**
-         * Deprecated. For internal use.
-         *
-         * @private
+         * @deprecated. For internal use.
          */
         make(): void;
 
         /**
-         * Deprecated. For internal use.
-         *
-         * @private
+         * @deprecated. For internal use.
          */
         parseNegate(): void;
 
         /**
-         * Deprecated. For internal use.
-         *
-         * @private
+         * @deprecated. For internal use.
          */
         braceExpand(pattern: string, options: IOptions): void;
 
         /**
-         * Deprecated. For internal use.
-         *
-         * @private
+         * @deprecated. For internal use.
          */
         parse(pattern: string, isSub?: boolean): void;
     }

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`.