Merge pull request #16831 from cypress-io/8.0-release

BREAKING CHANGE: 8.0 release

Author: flotwig

cli/__snapshots__/cli_spec.js

@@ -69,8 +69,8 @@ exports['shows help for run --foo 1'] = `
     -e, --env <env>                            sets environment variables. separate multiple values with a comma. overrides any value in cypress.json or cypress.env.json
     --group <name>                             a named group for recorded runs in the Cypress Dashboard
     -k, --key <record-key>                     your secret Record Key. you can omit this if you set a CYPRESS_RECORD_KEY environment variable.
-    --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)
     --no-exit                                  keep the browser open after tests finish
     --parallel                                 enables concurrent runs and automatic load balancing of specs across multiple machines or processes
     -p, --port <port>                          runs Cypress on a specific port. overrides any value in cypress.json.

cli/lib/cli.js

@@ -115,8 +115,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.',

cli/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.
      *

cli/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 {
@@ -341,15 +357,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
      */
@@ -1833,6 +1840,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 +1863,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.
      *
@@ -2640,13 +2653,6 @@ declare namespace Cypress {
      * @default 'top'
      */
     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 }
-     */
-    firefoxGcInterval: Nullable<number | { runMode: Nullable<number>, openMode: Nullable<number> }>
     /**
      * 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 +2684,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, 'e2e' | 'component'>
 
     /**
      * Override default config options for E2E Testing runner.
      * @default {}
      */
-    e2e: ResolvedConfigOptions
+    e2e: Omit<ResolvedConfigOptions, 'e2e' | 'component'>
   }
 
   /**
@@ -2701,10 +2736,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 +2744,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 +2763,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.
      */
@@ -2798,7 +2809,8 @@ declare namespace Cypress {
   /**
    * All configuration items are optional.
    */
-  type ConfigOptions = Partial<ResolvedConfigOptions>
+  type CoreConfigOptions = Partial<Omit<ResolvedConfigOptions, 'e2e' | 'component'>>
+  type ConfigOptions = CoreConfigOptions & {e2e?: CoreConfigOptions, component?: CoreConfigOptions }
 
   interface PluginConfigOptions extends ResolvedConfigOptions {
     /**

cli/types/tests/cypress-tests.ts

@@ -257,6 +257,15 @@ describe('then', () => {
       $p // $ExpectType JQuery<HTMLParagraphElement>
     })
   })
+
+  // https://github.com/cypress-io/cypress/issues/16669
+  it('any as default', () => {
+    cy.get('body')
+    .then(() => ({} as any))
+    .then(v => {
+      v // $ExpectType any
+    })
+  })
 })
 
 cy.wait(['@foo', '@bar'])

packages/desktop-gui/cypress/fixtures/config.json

@@ -83,7 +83,8 @@
       "channel": "stable",
       "version": "69.0.1",
       "path": "/Applications/Firefox/Contents/MacOS/Firefox",
-      "majorVersion": "69"
+      "majorVersion": "69",
+      "unsupportedVersion": true
     },
     {
       "name": "firefox",

packages/desktop-gui/cypress/integration/project_nav_spec.js

@@ -204,6 +204,20 @@ describe('Project Nav', function () {
           })
         })
 
+        it('has unsupportedVersions styled and unselectable', function () {
+          cy.get('.browsers-list .dropdown-chosen').click()
+
+          cy.get('.browsers-list').find('.dropdown-menu')
+          .find('li').should('have.length', this.config.browsers.length - 1)
+          .contains('span', 'Firefox 69')
+          .should('have.class', 'unsupported-version')
+          .click()
+
+          cy.get('.browsers-list .dropdown-menu').should('be.visible')
+
+          cy.get('.browsers-list .dropdown-chosen').contains('Chromium')
+        })
+
         it('saves chosen browser in local storage', () => {
           expect(localStorage.getItem('chosenBrowser')).to.eq(JSON.stringify({ name: 'chromium', channel: 'stable' }))
         })
@@ -255,7 +269,7 @@ describe('Project Nav', function () {
           const browserArg = this.ipc.launchBrowser.getCall(0).args[0].browser
 
           expect(browserArg).to.have.keys([
-            'family', 'name', 'path', 'profilePath', 'version', 'majorVersion', 'displayName', 'info', 'isChosen', 'custom', 'warning', 'channel',
+            'family', 'name', 'path', 'profilePath', 'version', 'majorVersion', 'displayName', 'info', 'isChosen', 'custom', 'warning', 'channel', 'unsupportedVersion',
           ])
 
           expect(browserArg.path).to.include('/')
@@ -364,6 +378,22 @@ describe('Project Nav', function () {
       })
     })
 
+    describe('when browser saved in local storage has an unsupported version', function () {
+      beforeEach(function () {
+        localStorage.setItem('chosenBrowser', JSON.stringify({ name: 'firefox', channel: 'stable' }))
+
+        // sanity check: saved browser should be found in the config
+        expect(this.config.browsers.find((b) => b.name === 'firefox' && b.channel === 'stable' && b.unsupportedVersion)).to.exist
+
+        this.openProject.resolve(this.config)
+      })
+
+      it('defaults to first browser', () => {
+        cy.get('.browsers-list .dropdown-chosen')
+        .should('contain', 'Chrome')
+      })
+    })
+
     describe('only one browser available', function () {
       beforeEach(function () {
         this.config.browsers = [{

packages/desktop-gui/src/app/nav.scss

@@ -236,6 +236,13 @@
   li {
     padding: 9px 15px;
     white-space: nowrap;
+
+    .unsupported-version {
+      color: #888;
+      img {
+        filter: opacity(0.5);
+      }
+    }
   }
 
   .dropdown-chosen {

packages/desktop-gui/src/lib/browser-model.js

@@ -12,6 +12,7 @@ export default class Browser {
   @observable info
   @observable custom
   @observable warning
+  @observable unsupportedVersion
   @observable isChosen = false
 
   constructor (browser) {
@@ -26,5 +27,6 @@ export default class Browser {
     this.info = browser.info
     this.custom = browser.custom
     this.warning = browser.warning
+    this.unsupportedVersion = browser.unsupportedVersion
   }
 }

packages/desktop-gui/src/project-nav/browsers.jsx

@@ -1,5 +1,6 @@
 import React, { Component } from 'react'
 import { observer } from 'mobx-react'
+import cs from 'classnames'
 import Tooltip from '@cypress/react-tooltip'
 import { BrowserIcon, Dropdown } from '@packages/ui-components'
 
@@ -49,6 +50,8 @@ export default class Browsers extends Component {
   }
 
   _onSelect = (browser) => {
+    if (browser.unsupportedVersion) return true
+
     this.props.project.setChosenBrowser(browser)
   }
 
@@ -69,14 +72,14 @@ export default class Browsers extends Component {
     }
 
     return (
-      <>
+      <span className={cs({ 'unsupported-version': browser.unsupportedVersion })}>
         {icon}{' '}
         {prefixText}{' '}
         {browser.displayName}{' '}
         {browser.majorVersion}
         {this._info(browser)}
         {this._warn(browser)}
-      </>
+      </span>
     )
   }
 

packages/desktop-gui/src/project/project-model.js

@@ -119,12 +119,16 @@ export default class Project {
     return _.filter(this.browsers, { isChosen: false })
   }
 
+  @computed get supportedBrowsers () {
+    return _.filter(this.browsers, (browser) => !browser.unsupportedVersion)
+  }
+
   @computed get chosenBrowser () {
     return _.find(this.browsers, { isChosen: true })
   }
 
   @computed get defaultBrowser () {
-    return this.browsers[0]
+    return this.supportedBrowsers[0]
   }
 
   @computed get warnings () {
@@ -173,7 +177,7 @@ export default class Project {
       // use a custom browser if one is supplied. or, if they already have
       // a browser chosen that's been saved in localStorage, then select that
       // otherwise just do the default.
-      const customBrowser = _.find(this.browsers, { custom: true })
+      const customBrowser = _.find(this.supportedBrowsers, { custom: true })
 
       if (customBrowser) {
         return this.setChosenBrowser(customBrowser, { save: false })
@@ -260,7 +264,7 @@ export default class Project {
       filter.name = ls
     }
 
-    const browser = _.find(this.browsers, filter) || this.defaultBrowser
+    const browser = _.find(this.supportedBrowsers, filter) || this.defaultBrowser
 
     this.setChosenBrowser(browser)
   }