cypress 7.1.0 → 7.5.0

package/lib/cli.js

@@ -330,15 +330,15 @@ module.exports = {
     program.command('open-ct').usage('[options]').description('Opens Cypress component testing interactive mode.').option('-b, --browser <browser-path>', text('browserOpenMode')).option('-c, --config <config>', text('config')).option('-C, --config-file <config-file>', text('configFile')).option('-d, --detached [bool]', text('detached'), coerceFalse).option('-e, --env <env>', text('env')).option('--global', text('global')).option('-p, --port <port>', text('port')).option('-P, --project <project-path>', text('project')).option('--dev', text('dev'), coerceFalse).action(opts => {
       debug('opening Cypress');
 
-      require('./exec/open').start(util.parseOpts(opts), {
-        isComponentTesting: true
+      require('./exec/open').start({ ...util.parseOpts(opts),
+        testingType: 'component'
       }).catch(util.logErrorExit1);
     });
     program.command('run-ct').usage('[options]').description('Runs all Cypress Component Testing suites').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).action(opts => {
       debug('running Cypress run-ct');
 
-      require('./exec/run').start(util.parseOpts(opts), {
-        isComponentTesting: true
+      require('./exec/run').start({ ...util.parseOpts(opts),
+        testingType: 'component'
       }).then(util.exit).catch(util.logErrorExit1);
     });
     program.command('install').usage('[options]').description('Installs the Cypress executable matching this package\'s version').option('-f, --force', text('forceInstall')).action(opts => {

package/lib/errors.js

@@ -210,6 +210,10 @@ const invalidCypressEnv = {
   solution: chalk.red('Unset the "CYPRESS_INTERNAL_ENV" environment variable and run Cypress again.'),
   exitCode: 11
 };
+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
@@ -390,6 +394,7 @@ module.exports = {
     smokeTestFailure,
     childProcessKilled,
     incompatibleHeadlessFlags,
-    invalidRunProjectPath
+    invalidRunProjectPath,
+    invalidTestingType
   }
 };

package/lib/exec/open.js

@@ -8,12 +8,12 @@ const spawn = require('./spawn');
 
 const verify = require('../tasks/verify');
 
+const {
+  processTestingType
+} = require('./shared');
+
 module.exports = {
-  start(options = {}, {
-    isComponentTesting
-  } = {
-    isComponentTesting: false
-  }) {
+  start(options = {}) {
     if (!util.isInstalledGlobally() && !options.global && !options.project) {
       options.project = process.cwd();
     }
@@ -44,10 +44,7 @@ module.exports = {
       args.push('--project', options.project);
     }
 
-    if (isComponentTesting) {
-      args.push('--testing-type', 'component');
-    }
-
+    args.push(...processTestingType(options.testingType));
     debug('opening from options %j', options);
     debug('command line arguments %j', args);
 

package/lib/exec/run.js

@@ -14,24 +14,11 @@ const {
   exitWithError,
   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
-
 
-  const err = new Error();
-  err.details = details;
-  throw err;
-};
+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,
@@ -166,6 +153,7 @@ const processRunOptions = (options = {}) => {
     args.push('--tag', options.tag);
   }
 
+  args.push(...processTestingType(options.testingType));
   return args;
 };
 
@@ -174,11 +162,7 @@ module.exports = {
   isValidProject,
 
   // resolves with the number of failed tests
-  start(options = {}, {
-    isComponentTesting
-  } = {
-    isComponentTesting: false
-  }) {
+  start(options = {}) {
     _.defaults(options, {
       key: null,
       spec: null,
@@ -200,10 +184,6 @@ module.exports = {
         throw err;
       }
 
-      if (isComponentTesting) {
-        args.push('--testing-type', 'component');
-      }
-
       debug('run to spawn.start args %j', args);
       return spawn.start(args, {
         dev: options.dev

package/lib/exec/shared.js

@@ -0,0 +1,50 @@
+"use strict";
+
+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
+
+
+  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 = testingType => {
+  if (testingType) {
+    if (testingType === 'e2e') {
+      return ['--testing-type', 'e2e'];
+    }
+
+    if (testingType === 'component') {
+      return ['--testing-type', 'component'];
+    }
+
+    return throwInvalidOptionError(errors.invalidTestingType);
+  }
+
+  return [];
+};
+
+module.exports = {
+  throwInvalidOptionError,
+  processTestingType
+};

package/lib/tasks/download.js

@@ -66,6 +66,26 @@ const getBaseUrl = () => {
   return defaultBaseUrl;
 };
 
+const getCA = () => {
+  return new Promise(resolve => {
+    if (!util.getEnv('CYPRESS_DOWNLOAD_USE_CA')) {
+      resolve();
+    }
+
+    if (process.env.npm_config_ca) {
+      resolve(process.env.npm_config_ca);
+    } else if (process.env.npm_config_cafile) {
+      fs.readFile(process.env.npm_config_cafile, 'utf8').then(cafileContent => {
+        resolve(cafileContent);
+      }).catch(() => {
+        resolve();
+      });
+    } else {
+      resolve();
+    }
+  });
+};
+
 const prepend = urlPath => {
   const endpoint = url.resolve(getBaseUrl(), urlPath);
   const platform = os.platform();
@@ -174,7 +194,8 @@ const verifyDownloadedFile = (filename, expectedSize, expectedChecksum) => {
 const downloadFromUrl = ({
   url,
   downloadDestination,
-  progress
+  progress,
+  ca
 }) => {
   return new Promise((resolve, reject) => {
     const proxy = getProxyUrl();
@@ -184,7 +205,7 @@ const downloadFromUrl = ({
       downloadDestination
     });
     let redirectVersion;
-    const req = request({
+    const reqOptions = {
       url,
       proxy,
 
@@ -203,7 +224,16 @@ const downloadFromUrl = ({
         return true;
       }
 
-    }); // closure
+    };
+
+    if (ca) {
+      debug('using custom CA details from npm config');
+      reqOptions.agentOptions = {
+        ca
+      };
+    }
+
+    const req = request(reqOptions); // closure
 
     let started = null;
     let expectedSize;
@@ -292,10 +322,13 @@ const start = opts => {
   debug(`downloading cypress.zip to "${downloadDestination}"`); // ensure download dir exists
 
   return fs.ensureDirAsync(path.dirname(downloadDestination)).then(() => {
+    return getCA();
+  }).then(ca => {
     return downloadFromUrl({
       url,
       downloadDestination,
-      progress
+      progress,
+      ca
     });
   }).catch(err => {
     return prettyDownloadErr(err, version);
@@ -305,5 +338,6 @@ const start = opts => {
 module.exports = {
   start,
   getUrl,
-  getProxyUrl
+  getProxyUrl,
+  getCA
 };

package/lib/tasks/install.js

@@ -12,7 +12,9 @@ const chalk = require('chalk');
 
 const debug = require('debug')('cypress:cli');
 
-const Listr = require('listr');
+const {
+  Listr
+} = require('listr2');
 
 const verbose = require('@cypress/listr-verbose-renderer');
 
@@ -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,7 +4,9 @@ const _ = require('lodash');
 
 const chalk = require('chalk');
 
-const Listr = require('listr');
+const {
+  Listr
+} = require('listr2');
 
 const debug = require('debug')('cypress:cli');
 
@@ -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,6 +1,6 @@
 {
   "name": "cypress",
-  "version": "7.1.0",
+  "version": "7.5.0",
   "main": "index.js",
   "scripts": {
     "postinstall": "node index.js --exec install",
@@ -27,13 +27,13 @@
     "eventemitter2": "^6.4.3",
     "execa": "4.1.0",
     "executable": "^4.1.1",
-    "extract-zip": "^1.7.0",
+    "extract-zip": "2.0.1",
     "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 +62,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

@@ -156,6 +156,11 @@ declare namespace CypressCommandLine {
      * Path to a specific project
      */
     project: string
+    /**
+     * Specify the type of tests to execute.
+     * @default "e2e"
+     */
+    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 {
@@ -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.
      */
@@ -392,7 +398,7 @@ declare namespace Cypress {
     Cookies: {
       debug(enabled: boolean, options?: Partial<DebugOptions>): void
       preserveOnce(...names: string[]): void
-      defaults(options: Partial<CookieDefaults>): void
+      defaults(options: Partial<CookieDefaults>): CookieDefaults
     }
 
     /**
@@ -498,6 +504,14 @@ declare namespace Cypress {
       defaults(options: Partial<ScreenshotDefaultsOptions>): void
     }
 
+    /**
+     * @see https://on.cypress.io/selector-playground-api
+     */
+    SelectorPlayground: {
+      defaults(options: Partial<SelectorPlaygroundDefaultsOptions>): void
+      getSelector($el: JQuery): JQuery.Selector
+    }
+
     /**
      * These events come from Cypress as it issues commands and reacts to their state. These are all useful to listen to for debugging purposes.
      * @see https://on.cypress.io/catalog-of-events#App-Events
@@ -1456,7 +1470,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.
      *
@@ -1464,7 +1478,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.
      *
@@ -1475,7 +1489,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.
@@ -1818,6 +1832,12 @@ declare namespace Cypress {
      * @see https://on.cypress.io/then
      */
     then<S extends HTMLElement>(fn: (this: ObjectLike, currentSubject: Subject) => S): Chainable<JQuery<S>>
+    /**
+     * Enables you to work with the subject yielded from the previous command / promise.
+     *
+     * @see https://on.cypress.io/then
+     */
+    then<S extends ArrayLike<HTMLElement>>(fn: (this: ObjectLike, currentSubject: Subject) => S): Chainable<JQuery<S extends ArrayLike<infer T> ? T : never>>
     /**
      * Enables you to work with the subject yielded from the previous command / promise.
      *
@@ -1836,6 +1856,12 @@ declare namespace Cypress {
      * @see https://on.cypress.io/then
      */
      then<S extends HTMLElement>(options: Partial<Timeoutable>, fn: (this: ObjectLike, currentSubject: Subject) => S): Chainable<JQuery<S>>
+     /**
+      * Enables you to work with the subject yielded from the previous command / promise.
+      *
+      * @see https://on.cypress.io/then
+      */
+      then<S extends ArrayLike<HTMLElement>>(options: Partial<Timeoutable>, fn: (this: ObjectLike, currentSubject: Subject) => S): Chainable<JQuery<S extends ArrayLike<infer T> ? T : never>>
     /**
      * Enables you to work with the subject yielded from the previous command / promise.
      *
@@ -2779,7 +2805,7 @@ declare namespace Cypress {
     /**
      * Type of test and associated runner that was launched.
      */
-    testingType: 'e2e' | 'component'
+    testingType: TestingType
     /**
      * Cypress version.
      */
@@ -2882,6 +2908,11 @@ declare namespace Cypress {
     screenshotOnRunFailure: boolean
   }
 
+  interface SelectorPlaygroundDefaultsOptions {
+    selectorPriority: string[]
+    onElement: ($el: JQuery) => string | null | undefined
+  }
+
   interface ScrollToOptions extends Loggable, Timeoutable {
     /**
      * Scrolls over the duration (in ms)
@@ -5458,6 +5489,8 @@ declare namespace Cypress {
   interface LogConfig extends Timeoutable {
     /** The JQuery element for the command. This will highlight the command in the main window when debugging */
     $el: JQuery
+    /** The scope of the log entry. If child, will appear nested below parents, prefixed with '-' */
+    type: 'parent' | 'child'
     /** Allows the name of the command to be overwritten */
     name: string
     /** Override *name* for display purposes only */
@@ -5469,9 +5502,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