cypress 8.7.0 → 9.2.0

package/lib/cli.js

@@ -3,8 +3,6 @@
 // @ts-check
 const _ = require('lodash');
 
-const R = require('ramda');
-
 const commander = require('commander');
 
 const {
@@ -238,11 +236,18 @@ const castCypressRunOptions = opts => {
   // only properties that have type "string | false" in our TS definition
   // require special handling, because CLI parsing takes care of purely
   // boolean arguments
-  const result = R.evolve({
-    port: coerceAnyStringToInt,
-    configFile: coerceFalseOrString
-  })(opts);
-  return result;
+  const castOpts = { ...opts
+  };
+
+  if (_.has(opts, 'port')) {
+    castOpts.port = coerceAnyStringToInt(opts.port);
+  }
+
+  if (_.has(opts, 'configFile')) {
+    castOpts.configFile = coerceFalseOrString(opts.configFile);
+  }
+
+  return castOpts;
 };
 
 module.exports = {

package/lib/errors.js

@@ -7,10 +7,6 @@ const {
   stripIndents
 } = require('common-tags');
 
-const {
-  merge
-} = require('ramda');
-
 const la = require('lazy-ass');
 
 const is = require('check-more-types');
@@ -45,6 +41,12 @@ const invalidRunProjectPath = {
       ${chalk.blue(runDocumentationUrl)}
   `
 };
+const invalidOS = {
+  description: 'The Cypress App could not be installed. Your machine does not meet the operating system requirements.',
+  solution: stripIndent`
+
+  ${chalk.blue('https://on.cypress.io/guides/getting-started/installing-cypress#system-requirements')}`
+};
 const failedDownload = {
   description: 'The Cypress App could not be downloaded.',
   solution: stripIndent`
@@ -233,9 +235,9 @@ const CYPRESS_RUN_BINARY = {
 
 function addPlatformInformation(info) {
   return util.getPlatformInfo().then(platform => {
-    return merge(info, {
+    return { ...info,
       platform
-    });
+    };
   });
 }
 /**
@@ -374,6 +376,7 @@ module.exports = {
     missingApp,
     notInstalledCI,
     missingDependency,
+    invalidOS,
     invalidSmokeTestDisplayError,
     versionMismatch,
     binaryNotExecutable,

package/lib/exec/info.js

@@ -13,9 +13,7 @@ const chalk = require('chalk');
 
 const prettyBytes = require('pretty-bytes');
 
-const _ = require('lodash');
-
-const R = require('ramda'); // color for numbers and show values
+const _ = require('lodash'); // color for numbers and show values
 
 
 const g = chalk.green; // color for paths
@@ -30,14 +28,21 @@ methods.findProxyEnvironmentVariables = () => {
   return _.pick(process.env, ['HTTP_PROXY', 'HTTPS_PROXY', 'NO_PROXY']);
 };
 
-const maskSensitiveVariables = R.evolve({
-  CYPRESS_RECORD_KEY: R.always('<redacted>')
-});
+const maskSensitiveVariables = obj => {
+  const masked = { ...obj
+  };
+
+  if (masked.CYPRESS_RECORD_KEY) {
+    masked.CYPRESS_RECORD_KEY = '<redacted>';
+  }
+
+  return masked;
+};
 
 methods.findCypressEnvironmentVariables = () => {
   const isCyVariable = (val, key) => key.startsWith('CYPRESS_');
 
-  return R.pickBy(isCyVariable)(process.env);
+  return _.pickBy(process.env, isCyVariable);
 };
 
 const formatCypressVariables = () => {

package/lib/exec/spawn.js

@@ -86,7 +86,7 @@ module.exports = {
       args = [args];
     }
 
-    args = [...args, '--cwd', process.cwd()];
+    args = [...args, '--cwd', process.cwd(), '--userNodePath', process.execPath, '--userNodeVersion', process.versions.node];
 
     _.defaults(options, {
       dev: false,

package/lib/logger.js

@@ -1,7 +1,5 @@
 "use strict";
 
-const R = require('ramda');
-
 const chalk = require('chalk');
 
 let logs = [];
@@ -36,7 +34,10 @@ const always = (...messages) => {
 
 const logLines = text => {
   const lines = text.split('\n');
-  R.forEach(log, lines);
+
+  for (const line of lines) {
+    log(line);
+  }
 };
 
 const print = () => {

package/lib/tasks/download.js

@@ -41,19 +41,6 @@ const getProxyForUrlWithNpmConfig = url => {
   return getProxyForUrl(url) || process.env.npm_config_https_proxy || process.env.npm_config_proxy || null;
 };
 
-const getRealOsArch = () => {
-  // os.arch() returns the arch for which this node was compiled
-  // we want the operating system's arch instead: x64 or x86
-  const osArch = arch();
-
-  if (osArch === 'x86') {
-    // match process.platform output
-    return 'ia32';
-  }
-
-  return osArch;
-};
-
 const getBaseUrl = () => {
   if (util.getEnv('CYPRESS_DOWNLOAD_MIRROR')) {
     let baseUrl = util.getEnv('CYPRESS_DOWNLOAD_MIRROR');
@@ -91,8 +78,7 @@ const getCA = () => {
 const prepend = urlPath => {
   const endpoint = url.resolve(getBaseUrl(), urlPath);
   const platform = os.platform();
-  const arch = getRealOsArch();
-  return `${endpoint}?platform=${platform}&arch=${arch}`;
+  return `${endpoint}?platform=${platform}&arch=${arch()}`;
 };
 
 const getUrl = version => {

package/lib/tasks/install.js

@@ -64,6 +64,10 @@ const getNpmArgv = () => {
 const getVersionSpecifier = (startDir = path.resolve(__dirname, '../..')) => {
   const argv = getNpmArgv();
 
+  if ((process.env.npm_package_resolved || '').endsWith('cypress.tgz')) {
+    return process.env.npm_package_resolved;
+  }
+
   if (argv) {
     const tgz = _.find(argv, t => t.endsWith('cypress.tgz'));
 
@@ -104,7 +108,7 @@ const getVersionSpecifier = (startDir = path.resolve(__dirname, '../..')) => {
   });
 };
 
-const betaNpmUrlRe = /^\/beta\/npm\/(?<version>[0-9.]+)\/(?<artifactSlug>[^/]+)\/cypress\.tgz$/; // convert a prerelease NPM package .tgz URL to the corresponding binary .zip URL
+const betaNpmUrlRe = /^\/beta\/npm\/(?<version>[0-9.]+)\/(?<artifactSlug>.+?)\/cypress\.tgz$/; // convert a prerelease NPM package .tgz URL to the corresponding binary .zip URL
 
 const getBinaryUrlFromPrereleaseNpmUrl = npmUrl => {
   let parsed;
@@ -226,6 +230,12 @@ const downloadAndUnzip = ({
   return Promise.resolve(tasks.run());
 };
 
+const validateOS = () => {
+  return util.getPlatformInfo().then(platformInfo => {
+    return platformInfo.match(/(darwin|linux|win32)-x64/);
+  });
+};
+
 const start = (options = {}) => {
   debug('installing with options %j', options);
 
@@ -269,7 +279,13 @@ const start = (options = {}) => {
   const installDir = state.getVersionDir(pkgVersion);
   const cacheDir = state.getCacheDir();
   const binaryDir = state.getBinaryDir(pkgVersion);
-  return fs.ensureDirAsync(cacheDir).catch({
+  return validateOS().then(isValid => {
+    if (!isValid) {
+      return throwFormErrorText(errors.invalidOS)();
+    }
+  }).then(() => {
+    return fs.ensureDirAsync(cacheDir);
+  }).catch({
     code: 'EACCES'
   }, err => {
     return throwFormErrorText(errors.invalidCacheDirectory)(stripIndent`

package/lib/tasks/state.js

@@ -8,8 +8,6 @@ const path = require('path');
 
 const untildify = require('untildify');
 
-const R = require('ramda');
-
 const debug = require('debug')('cypress:cli');
 
 const fs = require('../fs');
@@ -203,9 +201,12 @@ const getBinaryPkgAsync = binaryDir => {
   });
 };
 
-const getBinaryPkgVersion = R.propOr(null, 'version');
-const getBinaryElectronVersion = R.propOr(null, 'electronVersion');
-const getBinaryElectronNodeVersion = R.propOr(null, 'electronNodeVersion');
+const getBinaryPkgVersion = o => _.get(o, 'version', null);
+
+const getBinaryElectronVersion = o => _.get(o, 'electronVersion', null);
+
+const getBinaryElectronNodeVersion = o => _.get(o, 'electronNodeVersion', null);
+
 module.exports = {
   getPathToExecutable,
   getPlatformExecutable,

package/lib/tasks/verify.js

@@ -37,7 +37,7 @@ const xvfb = require('../exec/xvfb');
 
 const state = require('./state');
 
-const VERIFY_TEST_RUNNER_TIMEOUT_MS = 30000;
+const VERIFY_TEST_RUNNER_TIMEOUT_MS = process.env.CYPRESS_VERIFY_TIMEOUT || 30000;
 
 const checkExecutable = binaryDir => {
   const executable = state.getPathToExecutable(binaryDir);

package/lib/util.js

@@ -2,7 +2,7 @@
 
 const _ = require('lodash');
 
-const R = require('ramda');
+const arch = require('arch');
 
 const os = require('os');
 
@@ -133,9 +133,8 @@ const logBrokenGtkDisplayWarning = () => {
 };
 
 function stdoutLineMatches(expectedLine, stdout) {
-  const lines = stdout.split('\n').map(R.trim);
-  const lineMatches = R.equals(expectedLine);
-  return lines.some(lineMatches);
+  const lines = stdout.split('\n').map(val => val.trim());
+  return lines.some(line => line === expectedLine);
 }
 /**
  * Confirms if given value is a valid CYPRESS_INTERNAL_ENV value. Undefined values
@@ -220,11 +219,16 @@ const parseOpts = opts => {
   // remove double quotes from certain options
 
 
-  const removeQuotes = {
-    group: dequote,
-    ciBuildId: dequote
+  const cleanOpts = { ...opts
   };
-  const cleanOpts = R.evolve(removeQuotes, opts);
+  const toDequote = ['group', 'ciBuildId'];
+
+  for (const prop of toDequote) {
+    if (_.has(opts, prop)) {
+      cleanOpts[prop] = dequote(opts[prop]);
+    }
+  }
+
   debug('parsed cli options %o', cleanOpts);
   return cleanOpts;
 };
@@ -404,8 +408,14 @@ const util = {
 
   getPlatformInfo() {
     return util.getOsVersionAsync().then(version => {
+      let osArch = arch();
+
+      if (osArch === 'x86') {
+        osArch = 'ia32';
+      }
+
       return stripIndent`
-        Platform: ${os.platform()} (${version})
+        Platform: ${os.platform()}-${osArch} (${version})
         Cypress Version: ${util.pkgVersion()}
       `;
     });

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "cypress",
-  "version": "8.7.0",
+  "version": "9.2.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/request": "^2.88.6",
+    "@cypress/request": "^2.88.10",
     "@cypress/xvfb": "^1.2.4",
     "@types/node": "^14.14.31",
     "@types/sinonjs__fake-timers": "^6.0.2",
     "@types/sizzle": "^2.3.2",
     "arch": "^2.2.0",
     "blob-util": "^2.0.2",
-    "bluebird": "^3.7.2",
+    "bluebird": "3.7.2",
     "cachedir": "^2.3.0",
     "chalk": "^4.1.0",
     "check-more-types": "^2.24.0",
@@ -42,7 +42,6 @@
     "ospath": "^1.2.2",
     "pretty-bytes": "^5.6.0",
     "proxy-from-env": "1.0.0",
-    "ramda": "~0.27.1",
     "request-progress": "^3.0.0",
     "supports-color": "^8.1.1",
     "tmp": "~0.2.1",

package/types/cypress.d.ts

@@ -7,13 +7,38 @@ declare namespace Cypress {
   type HttpMethod = string
   type RequestBody = string | object
   type ViewportOrientation = 'portrait' | 'landscape'
-  type PrevSubject = 'optional' | 'element' | 'document' | 'window'
+  type PrevSubject = keyof PrevSubjectMap
   type TestingType = 'e2e' | 'component'
   type PluginConfig = (on: PluginEvents, config: PluginConfigOptions) => void | ConfigOptions | Promise<ConfigOptions>
 
+  interface PrevSubjectMap<O = unknown> {
+    optional: O
+    element: JQuery
+    document: Document
+    window: Window
+  }
+
   interface CommandOptions {
     prevSubject: boolean | PrevSubject | PrevSubject[]
   }
+  interface CommandFn<T extends keyof ChainableMethods> {
+    (this: Mocha.Context, ...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]> | void
+  }
+  interface CommandFnWithSubject<T extends keyof ChainableMethods, S> {
+    (this: Mocha.Context, prevSubject: S, ...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]> | void
+  }
+  interface CommandOriginalFn<T extends keyof ChainableMethods> extends CallableFunction {
+    (...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]>
+  }
+  interface CommandOriginalFnWithSubject<T extends keyof ChainableMethods, S> extends CallableFunction {
+    (prevSubject: S, ...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]>
+  }
+  interface CommandFnWithOriginalFn<T extends keyof Chainable> {
+    (this: Mocha.Context, originalFn: CommandOriginalFn<T>, ...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]> | void
+  }
+  interface CommandFnWithOriginalFnAndSubject<T extends keyof Chainable, S> {
+    (this: Mocha.Context, originalFn: CommandOriginalFnWithSubject<T, S>, prevSubject: S, ...args: Parameters<ChainableMethods[T]>): ReturnType<ChainableMethods[T]> | void
+  }
   interface ObjectLike {
     [key: string]: any
   }
@@ -280,7 +305,7 @@ declare namespace Cypress {
      * Currently executing test runnable instance.
      */
     currentTest: {
-      title: string,
+      title: string
       titlePath: string[]
     }
 
@@ -294,6 +319,11 @@ declare namespace Cypress {
      */
     LocalStorage: LocalStorage
 
+    /**
+     * Internal class for session management.
+     */
+    session: Session
+
     /**
      * Current testing type, determined by the Test Runner chosen to run.
      */
@@ -328,7 +358,7 @@ declare namespace Cypress {
     // 60000
     ```
      */
-    config<K extends keyof ConfigOptions>(key: K): ResolvedConfigOptions[K]
+    config<K extends keyof Config>(key: K): Config[K]
     /**
      * Sets one configuration value.
      * @see https://on.cypress.io/config
@@ -337,7 +367,7 @@ declare namespace Cypress {
     Cypress.config('viewportWidth', 800)
     ```
      */
-    config<K extends keyof ConfigOptions>(key: K, value: ResolvedConfigOptions[K]): void
+    config<K extends keyof TestConfigOverrides>(key: K, value: TestConfigOverrides[K]): void
     /**
      * Sets multiple configuration values at once.
      * @see https://on.cypress.io/config
@@ -420,9 +450,16 @@ declare namespace Cypress {
      * @see https://on.cypress.io/api/commands
      */
     Commands: {
-      add(name: string, fn: (...args: any[]) => CanReturnChainable): void
-      add(name: string, options: CommandOptions, fn: (...args: any[]) => CanReturnChainable): void
-      overwrite(name: string, fn: (...args: any[]) => CanReturnChainable): void
+      add<T extends keyof Chainable>(name: T, fn: CommandFn<T>): void
+      add<T extends keyof Chainable>(name: T, options: CommandOptions & {prevSubject: false}, fn: CommandFn<T>): void
+      add<T extends keyof Chainable, S extends PrevSubject>(
+          name: T, options: CommandOptions & { prevSubject: true | S | ['optional'] }, fn: CommandFnWithSubject<T, PrevSubjectMap[S]>,
+      ): void
+      add<T extends keyof Chainable, S extends PrevSubject>(
+          name: T, options: CommandOptions & { prevSubject: S[] }, fn: CommandFnWithSubject<T, PrevSubjectMap<void>[S]>,
+      ): void
+      overwrite<T extends keyof Chainable>(name: T, fn: CommandFnWithOriginalFn<T>): void
+      overwrite<T extends keyof Chainable, S extends PrevSubject>(name: T, fn: CommandFnWithOriginalFnAndSubject<T, PrevSubjectMap[S]>): void
     }
 
     /**
@@ -2209,12 +2246,9 @@ declare namespace Cypress {
      * @see https://on.cypress.io/writefile
     ```
     cy.writeFile('path/to/message.txt', 'Hello World')
-      .then((text) => {
-        expect(text).to.equal('Hello World') // true
-      })
     ```
      */
-    writeFile<C extends FileContents>(filePath: string, contents: C, encoding: Encodings): Chainable<C>
+    writeFile(filePath: string, contents: FileContents, encoding: Encodings): Chainable<null>
     /**
      * Write to a file with the specified encoding and contents.
      *
@@ -2223,12 +2257,10 @@ declare namespace Cypress {
     cy.writeFile('path/to/ascii.txt', 'Hello World', {
       flag: 'a+',
       encoding: 'ascii'
-    }).then((text) => {
-      expect(text).to.equal('Hello World') // true
     })
     ```
      */
-    writeFile<C extends FileContents>(filePath: string, contents: C, options?: Partial<WriteFileOptions>): Chainable<C>
+    writeFile(filePath: string, contents: FileContents, options?: Partial<WriteFileOptions & Timeoutable>): Chainable<null>
     /**
      * Write to a file with the specified encoding and contents.
      *
@@ -2238,12 +2270,10 @@ declare namespace Cypress {
     ```
     cy.writeFile('path/to/ascii.txt', 'Hello World', 'utf8', {
       flag: 'a+',
-    }).then((text) => {
-      expect(text).to.equal('Hello World') // true
     })
     ```
      */
-    writeFile<C extends FileContents>(filePath: string, contents: C, encoding: Encodings, options?: Partial<WriteFileOptions>): Chainable<C>
+    writeFile(filePath: string, contents: FileContents, encoding: Encodings, options?: Partial<WriteFileOptions & Timeoutable>): Chainable<null>
 
     /**
      * jQuery library bound to the AUT
@@ -2255,6 +2285,12 @@ declare namespace Cypress {
     $$<TElement extends Element = HTMLElement>(selector: JQuery.Selector, context?: Element | Document | JQuery): JQuery<TElement>
   }
 
+  type ChainableMethods<Subject = any> = {
+    [P in keyof Chainable<Subject>]: Chainable<Subject>[P] extends ((...args: any[]) => any)
+        ? Chainable<Subject>[P]
+        : never
+  }
+
   interface SinonSpyAgent<A extends sinon.SinonSpy> {
     log(shouldOutput?: boolean): Omit<A, 'withArgs'> & Agent<A>
 
@@ -2886,7 +2922,7 @@ declare namespace Cypress {
     xhrUrl: string
   }
 
-  interface TestConfigOverrides extends Partial<Pick<ConfigOptions, 'animationDistanceThreshold' | 'baseUrl' | 'defaultCommandTimeout' | 'env' | 'execTimeout' | 'includeShadowDom' | 'requestTimeout' | 'responseTimeout' | 'retries' | 'scrollBehavior' | 'taskTimeout' | 'viewportHeight' | 'viewportWidth' | 'waitForAnimations'>> {
+  interface TestConfigOverrides extends Partial<Pick<ConfigOptions, 'animationDistanceThreshold' | 'baseUrl' | 'blockHosts' | 'defaultCommandTimeout' | 'env' | 'execTimeout' | 'includeShadowDom' | 'numTestsKeptInMemory' | 'pageLoadTimeout' | 'redirectionLimit' | 'requestTimeout' | 'responseTimeout' | 'retries' | 'screenshotOnRunFailure' | 'slowTestThreshold' | 'scrollBehavior' | 'taskTimeout' | 'viewportHeight' | 'viewportWidth' | 'waitForAnimations'>> {
     browser?: IsBrowserMatcher | IsBrowserMatcher[]
     keystrokeDelay?: number
   }
@@ -3086,6 +3122,11 @@ declare namespace Cypress {
     onAnyAbort(route: RouteOptions, proxy: any): void
   }
 
+  interface Session {
+    // Clear all saved sessions and re-run the current spec file.
+    clearAllSavedSessions: () => Promise<void>
+  }
+
   type SameSiteStatus = 'no_restriction' | 'strict' | 'lax'
 
   interface SetCookieOptions extends Loggable, Timeoutable {
@@ -5677,7 +5718,7 @@ declare namespace Cypress {
     xhr: XMLHttpRequest
   }
 
-  type Encodings = 'ascii' | 'base64' | 'binary' | 'hex' | 'latin1' | 'utf8' | 'utf-8' | 'ucs2' | 'ucs-2' | 'utf16le' | 'utf-16le'
+  type Encodings = 'ascii' | 'base64' | 'binary' | 'hex' | 'latin1' | 'utf8' | 'utf-8' | 'ucs2' | 'ucs-2' | 'utf16le' | 'utf-16le' | null
   type PositionType = 'topLeft' | 'top' | 'topRight' | 'left' | 'center' | 'right' | 'bottomLeft' | 'bottom' | 'bottomRight'
   type ViewportPreset = 'macbook-16' | 'macbook-15' | 'macbook-13' | 'macbook-11' | 'ipad-2' | 'ipad-mini' | 'iphone-xr' | 'iphone-x' | 'iphone-6+' | 'iphone-se2' | 'iphone-8' | 'iphone-7' | 'iphone-6' | 'iphone-5' | 'iphone-4' | 'iphone-3' | 'samsung-s10' | 'samsung-note9'
   interface Offset {