Configuration and events overhaul (v6.0)

.eslintignore

@@ -1,5 +1,5 @@
 __snapshots__
-packages/server/lib/scaffold/plugins/index.js
+packages/server/lib/scaffold/background/index.js
 packages/server/lib/scaffold/support/index.js
 packages/server/lib/scaffold/support/commands.js
 packages/server/test/fixtures

cli/schema/cypress.schema.json

@@ -84,10 +84,10 @@
       "default": "cypress/integration",
       "description": "Path to folder containing integration test files"
     },
-    "pluginsFile": {
+    "backgroundFile": {
       "type": ["string", "boolean"],
-      "default": "cypress/plugins/index.js",
-      "description": "Path to plugins file. (Pass false to disable)"
+      "default": "cypress/background/index.js",
+      "description": "Path to background file. (Pass false to disable)"
     },
     "screenshotsFolder": {
       "type": "string",

cli/test/lib/logger_spec.js

@@ -1,7 +1,7 @@
 require('../spec_helper')
 
 const la = require('lazy-ass')
-const {stripIndent, stripIndents} = require('common-tags')
+const { stripIndent, stripIndents } = require('common-tags')
 const snapshot = require('../support/snapshot')
 
 describe('stripIndent', () => {
@@ -12,6 +12,7 @@ describe('stripIndent', () => {
           third line
       last line
     `
+
     // should preserve the structure of the text
     snapshot(removed)
   })
@@ -21,7 +22,8 @@ describe('stripIndent', () => {
     const removed = stripIndent(text)
     // removed 1 level of indentation and trimmed the string
     const expected = 'foo\n  bar'
-    la(removed === expected, 'removed indent is\n' + removed)
+
+    la(removed === expected, `removed indent is\n${removed}`)
   })
 
   it('can be used with nested message', () => {
@@ -33,6 +35,7 @@ describe('stripIndent', () => {
 
       last line
     `
+
     // should have NO indents
     // first line
     //

cli/types/index.d.ts

@@ -1995,10 +1995,10 @@ declare namespace Cypress {
      */
     integrationFolder: string
     /**
-     * Path to plugins file. (Pass false to disable)
-     * @default "cypress/plugins/index.js"
+     * Path to background file. (Pass false to disable)
+     * @default "cypress/background/index.js"
      */
-    pluginsFile: string
+    backgroundFile: string
     /**
      * Path to folder where screenshots will be saved from [cy.screenshot()](https://on.cypress.io/screenshot) command or after a headless or CI run’s test failure
      * @default "cypress/screenshots"
@@ -2266,14 +2266,14 @@ declare namespace Cypress {
      *
      * @param {Window} contentWindow the remote page's window object
      */
-    onBeforeLoad(win: Window): void
+    onStart(win: Window): void
 
     /**
      * Called once your page has fired its load event.
      *
      * @param {Window} contentWindow the remote page's window object
      */
-    onLoad(win: Window): void
+    onReady(win: Window): void
 
     /**
      * Cypress will automatically apply the right authorization headers
@@ -3931,7 +3931,17 @@ declare namespace Cypress {
     (fn: (currentSubject: Subject) => void): Chainable<Subject>
   }
 
-  // for just a few events like "window:alert" it makes sense to allow passing cy.stub() or
+  /**
+   * Page details included with actions like 'page:start'
+   */
+  interface PageDetails {
+    win: Window
+    url: string
+    statusCode?: number
+    headers?: { [key: string]: string }
+  }
+
+  // for just a few events like "page:alert" it makes sense to allow passing cy.stub() or
   // a user callback function. Others probably only need a callback function.
 
   /**
@@ -3959,7 +3969,7 @@ declare namespace Cypress {
       // stub "window.alert" in a single test
       it('shows alert', () => {
         const stub = cy.stub()
-        cy.on('window:alert', stub)
+        cy.on('page:alert', stub)
         // trigger application code that calls alert(...)
         .then(() => {
           expect(stub).to.have.been.calledOnce
@@ -3974,20 +3984,20 @@ declare namespace Cypress {
      * @see https://on.cypress.io/catalog-of-events#App-Events
      * @example
     ```
-    cy.on('window:confirm', (str) => {
+    cy.on('page:confirm', (str) => {
       console.log(str)
       return false // simulate "Cancel"
     })
     ```
      */
-    (action: 'window:confirm', fn: ((text: string) => false | void) | SinonSpyAgent<sinon.SinonSpy> | SinonSpyAgent<sinon.SinonStub>): void
+    (action: 'page:confirm', fn: ((text: string) => false | void) | SinonSpyAgent<sinon.SinonSpy> | SinonSpyAgent<sinon.SinonStub>): void
     /**
      * Fires when your app calls the global `window.alert()` method.
      * Cypress will auto accept alerts. You cannot change this behavior.
      * @example
     ```
     const stub = cy.stub()
-    cy.on('window:alert', stub)
+    cy.on('page:alert', stub)
     // assume the button calls window.alert()
     cy.get('.my-button')
       .click()
@@ -3997,87 +4007,87 @@ declare namespace Cypress {
     ```
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'window:alert', fn: ((text: string) => void) | SinonSpyAgent<sinon.SinonSpy> | SinonSpyAgent<sinon.SinonStub>): void
+    (action: 'page:alert', fn: ((text: string) => void) | SinonSpyAgent<sinon.SinonSpy> | SinonSpyAgent<sinon.SinonStub>): void
     /**
-     * Fires as the page begins to load, but before any of your applications JavaScript has executed. This fires at the exact same time as `cy.visit()` `onBeforeLoad` callback. Useful to modify the window on a page transition.
+     * Fires as the page begins to load, but before any of your applications JavaScript has executed. This fires at the exact same time as `cy.visit()` `onStart` callback. Useful to modify the window on a page transition.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'window:before:load', fn: (win: Window) => void): void
+    (action: 'page:start', fn: (details: PageDetails) => void): void
     /**
-     * Fires after all your resources have finished loading after a page transition. This fires at the exact same time as a `cy.visit()` `onLoad` callback.
+     * Fires after all your resources have finished loading after a page transition. This fires at the exact same time as a `cy.visit()` `onReady` callback.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'window:load', fn: (win: Window) => void): void
+    (action: 'page:ready', fn: (details: PageDetails) => void): void
     /**
-     * Fires when your application is about to navigate away. The real event object is provided to you. Your app may have set a `returnValue` on the event, which is useful to assert on.
+     * Fires when your application is has unloaded and is navigating away. The real event object is provided to you. This event is not cancelable.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'window:before:unload', fn: (event: BeforeUnloadEvent) => void): void
+    (action: 'page:end', fn: (details: PageDetails) => void): void
     /**
-     * Fires when your application is has unloaded and is navigating away. The real event object is provided to you. This event is not cancelable.
+     * Fires when your application is about to navigate away. The real event object is provided to you. Your app may have set a `returnValue` on the event, which is useful to assert on.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'window:unload', fn: (event: Event) => void): void
+    (action: 'before:window:unload', fn: (event: BeforeUnloadEvent) => void): void
     /**
      * Fires whenever Cypress detects that your application's URL has changed.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'url:changed', fn: (url: string) => void): void
+    (action: 'page:url:changed', fn: (url: string) => void): void
     /**
      * Fires when the test has failed. It is technically possible to prevent the test from actually failing by binding to this event and invoking an async `done` callback. However this is **strongly discouraged**. Tests should never legitimately fail. This event exists because it's extremely useful for debugging purposes.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'fail', fn: (error: Error, mocha: Mocha.IRunnable) => void): void
+    (action: 'test:fail', fn: (error: Error, mocha: Mocha.IRunnable) => void): void
     /**
      * Fires whenever the viewport changes via a `cy.viewport()` or naturally when Cypress resets the viewport to the default between tests. Useful for debugging purposes.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'viewport:changed', fn: (viewport: Viewport) => void): void
+    (action: 'viewport:change', fn: (viewport: Viewport) => void): void
     /**
      * Fires whenever **Cypress** is scrolling your application. This event is fired when Cypress is {% url 'waiting for and calculating actionability' interacting-with-elements %}. It will scroll to 'uncover' elements currently being covered. This event is extremely useful to debug why Cypress may think an element is not interactive.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'scrolled', fn: ($el: JQuery) => void): void
+    (action: 'internal:scrolled', fn: ($el: JQuery) => void): void
     /**
      * Fires when a cy command is first invoked and enqueued to be run later. Useful for debugging purposes if you're confused about the order in which commands will execute.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'command:enqueued', fn: (command: EnqueuedCommand) => void): void
+    (action: 'internal:commandEnqueue', fn: (command: EnqueuedCommand) => void): void
     /**
      * Fires when cy begins actually running and executing your command. Useful for debugging and understanding how the command queue is async.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'command:start', fn: (command: CommandQueue) => void): void
+    (action: 'internal:commandStart', fn: (command: CommandQueue) => void): void
     /**
      * Fires when cy finishes running and executing your command. Useful for debugging and understanding how commands are handled.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'command:end', fn: (command: CommandQueue) => void): void
+    (action: 'internal:commandEnd', fn: (command: CommandQueue) => void): void
     /**
      * Fires whenever a command begins its retrying routines. This is called on the trailing edge after Cypress has internally waited for the retry interval. Useful to understand **why** a command is retrying, and generally includes the actual error causing the retry to happen. When commands fail the final error is the one that actually bubbles up to fail the test. This event is essentially to debug why Cypress is failing.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'command:retry', fn: (command: CommandQueue) => void): void
+    (action: 'internal:commandRetry', fn: (command: CommandQueue) => void): void
     /**
      * Fires whenever a command emits this event so it can be displayed in the Command Log. Useful to see how internal cypress commands utilize the {% url 'Cypress.log()' cypress-log %} API.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'log:added', fn: (log: any, interactive: boolean) => void): void
+    (action: 'internal:log', fn: (log: any, interactive: boolean) => void): void
     /**
      * Fires whenever a command's attributes changes. This event is debounced to prevent it from firing too quickly and too often. Useful to see how internal cypress commands utilize the {% url 'Cypress.log()' cypress-log %} API.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'log:changed', fn: (log: any, interactive: boolean) => void): void
+    (action: 'internal:logChange', fn: (log: any, interactive: boolean) => void): void
     /**
      * Fires before the test and all **before** and **beforeEach** hooks run.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'test:before:run', fn: (attributes: ObjectLike, test: Mocha.ITest) => void): void
+    (action: 'test:start', fn: (attributes: ObjectLike, test: Mocha.ITest) => void): void
     /**
      * Fires after the test and all **afterEach** and **after** hooks run.
      * @see https://on.cypress.io/catalog-of-events#App-Events
      */
-    (action: 'test:after:run', fn: (attributes: ObjectLike, test: Mocha.ITest) => void): void
+    (action: 'test:end', fn: (attributes: ObjectLike, test: Mocha.ITest) => void): void
   }
 
   // $CommandQueue from `command_queue.coffee` - a lot to type. Might be more useful if it was written in TS

cli/types/tests/actions.ts

@@ -3,77 +3,77 @@ Cypress.on('uncaught:exception', (error, runnable) => {
   runnable // $ExpectType IRunnable
 })
 
-Cypress.on('window:confirm', (text) => {
+Cypress.on('page:confirm', (text) => {
   text // $ExpectType string
 })
 
-Cypress.on('window:alert', (text) => {
+Cypress.on('page:alert', (text) => {
   text // $ExpectType string
 })
 
-Cypress.on('window:before:load', (win) => {
-  win // $ExpectType Window
+Cypress.on('page:start', (details) => {
+  details // $ExpectType PageDetails
 })
 
-Cypress.on('window:load', (win) => {
-  win // $ExpectType Window
+Cypress.on('page:ready', (details) => {
+  details // $ExpectType PageDetails
 })
 
-Cypress.on('window:before:unload', (event) => {
-  event // $ExpectType BeforeUnloadEvent
+Cypress.on('page:end', (details) => {
+  details // $ExpectType PageDetails
 })
 
-Cypress.on('window:unload', (event) => {
-  event // $ExpectType Event
+Cypress.on('before:window:unload', (event) => {
+  event // $ExpectType BeforeUnloadEvent
 })
 
-Cypress.on('url:changed', (url) => {
+Cypress.on('page:url:changed', (url) => {
   url // $ExpectType string
 })
 
-Cypress.on('fail', (error, mocha) => {
+Cypress.on('test:fail', (error, mocha) => {
   error // $ExpectType Error
   mocha // $ExpectType IRunnable
 })
 
-Cypress.on('viewport:changed', (viewport) => {
+Cypress.on('viewport:change', (viewport) => {
   viewport // $ExpectType Viewport
 })
 
-Cypress.on('scrolled', ($el) => {
+Cypress.on('internal:scrolled', ($el) => {
   $el // $ExpectType JQuery<HTMLElement>
 })
 
-Cypress.on('command:enqueued', (command) => {
+Cypress.on('internal:commandEnqueue', (command) => {
   command // $ExpectType EnqueuedCommand
 })
 
-Cypress.on('command:start', (command) => {
+Cypress.on('internal:commandStart', (command) => {
   command // $ExpectType CommandQueue
 })
 
-Cypress.on('command:end', (command) => {
+Cypress.on('internal:commandEnd', (command) => {
   command // $ExpectType CommandQueue
 })
 
-Cypress.on('command:retry', (command) => {
+Cypress.on('internal:commandRetry', (command) => {
   command // $ExpectType CommandQueue
 })
 
-Cypress.on('log:added', (log, interactive: boolean) => {
+Cypress.on('internal:log', (log, interactive: boolean) => {
   log // $ExpectTyped any
 })
 
-Cypress.on('log:changed', (log, interactive: boolean) => {
+Cypress.on('internal:logChange', (log, interactive: boolean) => {
   log // $ExpectTyped any
 })
 
-Cypress.on('test:before:run', (attributes , test) => {
+Cypress.on('test:start', (attributes , test) => {
   attributes // $ExpectType ObjectLike
   test // $ExpectType ITest
 })
 
-Cypress.on('test:after:run', (attributes , test) => {
+Cypress.on('test:end', (attributes , test) => {
   attributes // $ExpectType ObjectLike
   test // $ExpectType ITest
 })

cli/types/tests/kitchen-sink.ts

@@ -48,21 +48,21 @@ Cypress.browser // $ExpectType Browser
 
 // stubbing window.alert type on "Cypress" should
 // work with plain function or with a Sinon stub
-Cypress.on('window:alert', () => { })
-Cypress.on('window:alert', cy.spy())
-Cypress.on('window:alert', cy.stub())
+Cypress.on('page:alert', () => { })
+Cypress.on('page:alert', cy.spy())
+Cypress.on('page:alert', cy.stub())
 // same for a single test
-cy.on('window:alert', () => { })
-cy.on('window:alert', cy.spy())
-cy.on('window:alert', cy.stub())
+cy.on('page:alert', () => { })
+cy.on('page:alert', cy.spy())
+cy.on('page:alert', cy.stub())
 
 // window:confirm stubbing
-Cypress.on('window:confirm', () => { })
-Cypress.on('window:confirm', cy.spy())
-Cypress.on('window:confirm', cy.stub())
-cy.on('window:confirm', () => { })
-cy.on('window:confirm', cy.spy())
-cy.on('window:confirm', cy.stub())
+Cypress.on('page:confirm', () => { })
+Cypress.on('page:confirm', cy.spy())
+Cypress.on('page:confirm', cy.stub())
+cy.on('page:confirm', () => { })
+cy.on('page:confirm', cy.spy())
+cy.on('page:confirm', cy.stub())
 
 // specifying HTTP method directly in the options object
 cy.request({

packages/desktop-gui/cypress.json

@@ -1,6 +1,6 @@
 {
   "projectId": "ypt4pf",
-  "pluginsFile": false,
+  "backgroundFile": false,
   "viewportWidth": 800,
   "viewportHeight": 550
 }

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

@@ -159,7 +159,7 @@
           ]
         },
         {
-          "name": "plugins",
+          "name": "background",
           "children": [
             {
               "name": "index.js"