cypress 9.1.1 → 9.3.1

package/lib/tasks/download.js

@@ -8,7 +8,7 @@ const is = require('check-more-types');
 
 const os = require('os');
 
-const url = require('url');
+const Url = require('url');
 
 const path = require('path');
 
@@ -36,6 +36,7 @@ const fs = require('../fs');
 const util = require('../util');
 
 const defaultBaseUrl = 'https://download.cypress.io/';
+const defaultMaxRedirects = 10;
 
 const getProxyForUrlWithNpmConfig = url => {
   return getProxyForUrl(url) || process.env.npm_config_https_proxy || process.env.npm_config_proxy || null;
@@ -76,9 +77,10 @@ const getCA = () => {
 };
 
 const prepend = urlPath => {
-  const endpoint = url.resolve(getBaseUrl(), urlPath);
+  const endpoint = Url.resolve(getBaseUrl(), urlPath);
   const platform = os.platform();
-  return `${endpoint}?platform=${platform}&arch=${arch()}`;
+  const pathTemplate = util.getEnv('CYPRESS_DOWNLOAD_PATH_TEMPLATE');
+  return pathTemplate ? pathTemplate.replace('${endpoint}', endpoint).replace('${platform}', platform).replace('${arch}', arch()) : `${endpoint}?platform=${platform}&arch=${arch()}`;
 };
 
 const getUrl = version => {
@@ -183,8 +185,18 @@ const downloadFromUrl = ({
   url,
   downloadDestination,
   progress,
-  ca
+  ca,
+  version,
+  redirectTTL = defaultMaxRedirects
 }) => {
+  if (redirectTTL <= 0) {
+    return Promise.reject(new Error(stripIndent`
+          Failed downloading the Cypress binary.
+          There were too many redirects. The default allowance is ${defaultMaxRedirects}.
+          Maybe you got stuck in a redirect loop?
+        `));
+  }
+
   return new Promise((resolve, reject) => {
     const proxy = getProxyForUrlWithNpmConfig(url);
     debug('Downloading package', {
@@ -192,35 +204,24 @@ const downloadFromUrl = ({
       proxy,
       downloadDestination
     });
-    let redirectVersion;
-    const reqOptions = {
-      url,
-      proxy,
-
-      followRedirect(response) {
-        const version = response.headers['x-version'];
-        debug('redirect version:', version);
-
-        if (version) {
-          // set the version in options if we have one.
-          // this insulates us from potential redirect
-          // problems where version would be set to undefined.
-          redirectVersion = version;
-        } // yes redirect
-
-
-        return true;
-      }
-
-    };
 
     if (ca) {
       debug('using custom CA details from npm config');
-      reqOptions.agentOptions = {
-        ca
-      };
     }
 
+    const reqOptions = {
+      uri: url,
+      ...(proxy ? {
+        proxy
+      } : {}),
+      ...(ca ? {
+        agentOptions: {
+          ca
+        }
+      } : {}),
+      method: 'GET',
+      followRedirect: false
+    };
     const req = request(reqOptions); // closure
 
     let started = null;
@@ -248,18 +249,46 @@ const downloadFromUrl = ({
       // response headers
 
 
-      started = new Date(); // if our status code does not start with 200
-
-      if (!/^2/.test(response.statusCode)) {
+      started = new Date();
+
+      if (/^3/.test(response.statusCode)) {
+        const redirectVersion = response.headers['x-version'];
+        const redirectUrl = response.headers.location;
+        debug('redirect version:', redirectVersion);
+        debug('redirect url:', redirectUrl);
+        downloadFromUrl({
+          url: redirectUrl,
+          progress,
+          ca,
+          downloadDestination,
+          version: redirectVersion,
+          redirectTTL: redirectTTL - 1
+        }).then(resolve).catch(reject); // if our status code does not start with 200
+      } else if (!/^2/.test(response.statusCode)) {
         debug('response code %d', response.statusCode);
         const err = new Error(stripIndent`
           Failed downloading the Cypress binary.
           Response code: ${response.statusCode}
           Response message: ${response.statusMessage}
         `);
-        reject(err);
+        reject(err); // status codes here are all 2xx
+      } else {
+        // We only enable this pipe connection when we know we've got a successful return
+        // and handle the completion with verify and resolve
+        // there was a possible race condition between end of request and close of writeStream
+        // that is made ordered with this Promise.all
+        Promise.all([new Promise(r => {
+          return response.pipe(fs.createWriteStream(downloadDestination).on('close', r));
+        }), new Promise(r => response.on('end', r))]).then(() => {
+          debug('downloading finished');
+          verifyDownloadedFile(downloadDestination, expectedSize, expectedChecksum).then(() => debug('verified')).then(() => resolve(version)).catch(reject);
+        });
       }
-    }).on('error', reject).on('progress', state => {
+    }).on('error', e => {
+      if (e.code === 'ECONNRESET') return; // sometimes proxies give ECONNRESET but we don't care
+
+      reject(e);
+    }).on('progress', state => {
       // total time we've elapsed
       // starting on our first progress notification
       const elapsed = new Date() - started; // request-progress sends a value between 0 and 1
@@ -268,12 +297,6 @@ const downloadFromUrl = ({
       const eta = util.calculateEta(percentage, elapsed); // send up our percent and seconds remaining
 
       progress.onProgress(percentage, util.secsRemaining(eta));
-    }) // save this download here
-    .pipe(fs.createWriteStream(downloadDestination)).on('finish', () => {
-      debug('downloading finished');
-      verifyDownloadedFile(downloadDestination, expectedSize, expectedChecksum).then(() => {
-        return resolve(redirectVersion);
-      }, reject);
     });
   });
 };
@@ -288,7 +311,8 @@ const start = opts => {
   let {
     version,
     downloadDestination,
-    progress
+    progress,
+    redirectTTL
   } = opts;
 
   if (!downloadDestination) {
@@ -316,7 +340,11 @@ const start = opts => {
       url,
       downloadDestination,
       progress,
-      ca
+      ca,
+      version,
+      ...(redirectTTL ? {
+        redirectTTL
+      } : {})
     });
   }).catch(err => {
     return prettyDownloadErr(err, version);

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 = +util.getEnv('CYPRESS_VERIFY_TIMEOUT') || 30000;
 
 const checkExecutable = binaryDir => {
   const executable = state.getPathToExecutable(binaryDir);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cypress",
-  "version": "9.1.1",
+  "version": "9.3.1",
   "main": "index.js",
   "scripts": {
     "postinstall": "node index.js --exec install",
@@ -10,16 +10,17 @@
     "@cypress/request": "^2.88.10",
     "@cypress/xvfb": "^1.2.4",
     "@types/node": "^14.14.31",
-    "@types/sinonjs__fake-timers": "^6.0.2",
+    "@types/sinonjs__fake-timers": "8.1.1",
     "@types/sizzle": "^2.3.2",
     "arch": "^2.2.0",
     "blob-util": "^2.0.2",
-    "bluebird": "3.7.2",
+    "bluebird": "^3.7.2",
+    "buffer": "^5.6.0",
     "cachedir": "^2.3.0",
     "chalk": "^4.1.0",
     "check-more-types": "^2.24.0",
     "cli-cursor": "^3.1.0",
-    "cli-table3": "~0.6.0",
+    "cli-table3": "~0.6.1",
     "commander": "^5.1.0",
     "common-tags": "^1.8.0",
     "dayjs": "^1.10.4",

package/types/cypress-eventemitter.d.ts

@@ -27,3 +27,7 @@ interface NodeEventEmitter {
   prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this
   eventNames(): Array<string | symbol>
 }
+
+// We use the Buffer class for dealing with binary data, especially around the
+// selectFile interface.
+type BufferType = import("buffer/").Buffer

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
   }
@@ -206,6 +231,15 @@ declare namespace Cypress {
      *    Cypress.Blob.method()
      */
     Blob: BlobUtil.BlobUtilStatic
+    /**
+     * Cypress automatically includes a Buffer library and exposes it as Cypress.Buffer.
+     *
+     * @see https://on.cypress.io/buffer
+     * @see https://github.com/feross/buffer
+     * @example
+     *    Cypress.Buffer.method()
+     */
+    Buffer: BufferType
     /**
      * Cypress automatically includes minimatch and exposes it as Cypress.minimatch.
      *
@@ -294,6 +328,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 +367,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 +376,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 +459,16 @@ declare namespace Cypress {
      * @see https://on.cypress.io/api/commands
      */
     Commands: {
-      add<T extends keyof Chainable>(name: T, fn: Chainable[T]): void
-      add<T extends keyof Chainable>(name: T, options: CommandOptions, fn: Chainable[T]): void
-      overwrite<T extends keyof Chainable>(name: T, fn: Chainable[T]): 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
     }
 
     /**
@@ -625,6 +671,20 @@ declare namespace Cypress {
      */
     as(alias: string): Chainable<Subject>
 
+    /**
+     * Select a file with the given <input> element, or drag and drop a file over any DOM subject.
+     *
+     * @param {FileReference} files - The file(s) to select or drag onto this element.
+     * @see https://on.cypress.io/selectfile
+     * @example
+     *    cy.get('input[type=file]').selectFile(Cypress.Buffer.from('text'))
+     *    cy.get('input[type=file]').selectFile({
+     *      fileName: 'users.json',
+     *      fileContents: [{name: 'John Doe'}]
+     *    })
+     */
+    selectFile(files: FileReference | FileReference[], options?: Partial<SelectFileOptions>): Chainable<Subject>
+
     /**
      * Blur a focused element. This element must currently be in focus.
      * If you want to ensure an element is focused before blurring,
@@ -2209,12 +2269,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 +2280,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 +2293,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 +2308,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>
 
@@ -2430,6 +2489,17 @@ declare namespace Cypress {
     scrollBehavior: scrollBehaviorOptions
   }
 
+  interface SelectFileOptions extends Loggable, Timeoutable, ActionableOptions {
+    /**
+     * Which user action to perform. `select` matches selecting a file while
+     * `drag-drop` matches dragging files from the operating system into the
+     * document.
+     *
+     * @default 'select'
+     */
+    action: 'select' | 'drag-drop'
+  }
+
   interface BlurOptions extends Loggable, Forceable { }
 
   interface CheckOptions extends Loggable, Timeoutable, ActionableOptions {
@@ -2886,7 +2956,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 +3156,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 {
@@ -5600,6 +5675,17 @@ declare namespace Cypress {
     stderr: string
   }
 
+  type FileReference = string | BufferType | FileReferenceObject
+  interface FileReferenceObject {
+    /*
+     * Buffers will be used as-is, while strings will be interpreted as an alias or a file path.
+     * All other types will have `Buffer.from(JSON.stringify())` applied.
+     */
+    contents: any
+    fileName?: string
+    lastModified?: number
+  }
+
   interface LogAttrs {
     url: string
     consoleProps: ObjectLike