Merge branch 'feature-multidomain' of github.com:cypress-io/cypress into feature-multidomain

Author: chrisbreiding

cli/types/cypress.d.ts

@@ -275,7 +275,7 @@ declare namespace Cypress {
      * Currently executing test runnable instance.
      */
     currentTest: {
-      title: string,
+      title: string
       titlePath: string[]
     }
 
@@ -5612,6 +5612,7 @@ declare namespace Cypress {
   }
 
   interface LogConfig extends Timeoutable {
+    id: number
     /** 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 '-' */

packages/driver/cypress/integration/e2e/multidomain_spec.ts

@@ -21,27 +21,25 @@ describe('multidomain', () => {
     cy.get('a').click()
   })
 
-  it('runs synchronous commands in secondary domain', (done) => {
-    expectTextMessage('From a secondary domain', done)
-
+  it('runs commands in secondary domain', () => {
     // @ts-ignore
     cy.switchToDomain('127.0.0.1:3501', () => {
-      // @ts-ignore
-      cy.now('get', '[data-cy="dom-check"]').then(($el) => {
-        top.postMessage({ host: location.host, actual: $el.text() }, '*')
-      })
+      cy
+      .get('[data-cy="dom-check"]')
+      .invoke('text')
+      .should('equal', 'From a secondary domain')
     })
-  })
 
-  it('sets up window.Cypress in secondary domain', (done) => {
-    expectTextMessage('Has window.Cypress', done)
+    cy.log('after switchToDomain')
+  })
 
+  it('sets up window.Cypress in secondary domain', () => {
     // @ts-ignore
     cy.switchToDomain('127.0.0.1:3501', () => {
-      // @ts-ignore
-      cy.now('get', '[data-cy="cypress-check"]').then(($el) => {
-        top.postMessage({ host: location.host, actual: $el.text() }, '*')
-      })
+      cy
+      .get('[data-cy="cypress-check"]')
+      .invoke('text')
+      .should('equal', 'Has window.Cypress')
     })
   })
 
@@ -55,10 +53,7 @@ describe('multidomain', () => {
           top.postMessage({ host: location.host, actual: 'form:submitted' }, '*')
         })
 
-        // @ts-ignore
-        cy.now('get', 'button[type=submit]').then(($el) => {
-          $el.trigger('click')
-        })
+        cy.get('form').submit()
       })
     })
 
@@ -71,8 +66,7 @@ describe('multidomain', () => {
           top.postMessage({ host: location.host, actual: 'window:before:unload' }, '*')
         })
 
-        // @ts-ignore
-        cy.now('window').then((window) => {
+        cy.window().then((window) => {
           window.location.href = '/fixtures/multidomain.html'
         })
       })
@@ -87,8 +81,7 @@ describe('multidomain', () => {
           top.postMessage({ host: location.host, actual: 'window:unload' }, '*')
         })
 
-        // @ts-ignore
-        cy.now('window').then((window) => {
+        cy.window().then((window) => {
           window.location.href = '/fixtures/multidomain.html'
         })
       })
@@ -103,8 +96,7 @@ describe('multidomain', () => {
           top.postMessage({ host: location.host, actual: 'navigation:changed' }, '*')
         })
 
-        // @ts-ignore
-        cy.now('window').then((window) => {
+        cy.window().then((window) => {
           window.location.hash = '#hashbrowns'
         })
       })
@@ -119,8 +111,7 @@ describe('multidomain', () => {
           top.postMessage({ host: location.host, actual: `window:alert ${text}` }, '*')
         })
 
-        // @ts-ignore
-        cy.now('get', '[data-cy="alert"]').then(($el) => {
+        cy.get('[data-cy="alert"]').then(($el) => {
           $el.trigger('click')
         })
       })
@@ -135,8 +126,7 @@ describe('multidomain', () => {
           top.postMessage({ host: location.host, actual: `window:confirm ${text}` }, '*')
         })
 
-        // @ts-ignore
-        cy.now('get', '[data-cy="confirm"]').then(($el) => {
+        cy.get('[data-cy="confirm"]').then(($el) => {
           $el.trigger('click')
         })
       })
@@ -157,7 +147,7 @@ describe('multidomain', () => {
         })
 
         // @ts-ignore
-        cy.now('get', '[data-cy="confirm"]').then(($el) => {
+        cy.get('[data-cy="confirm"]').then(($el) => {
           $el.trigger('click')
         })
       })
@@ -179,7 +169,7 @@ describe('multidomain', () => {
         Cypress.on('window:confirm', () => {})
 
         // @ts-ignore
-        cy.now('get', '[data-cy="confirm"]').then(($el) => {
+        cy.get('[data-cy="confirm"]').then(($el) => {
           $el.trigger('click')
         })
       })

packages/driver/src/cy/commands/navigation.ts

@@ -340,7 +340,9 @@ const stabilityChanged = (Cypress, state, config, stable) => {
     debug('waiting for window:load')
 
     return new Promise((resolve) => {
-      return cy.once('window:load', (e) => {
+      const onWindowLoad = (e) => {
+        cy.off('cross:domain:window:load', onCrossDomainWindowLoad)
+
         // this prevents a log occurring when we navigate to about:blank inbetween tests
         if (!state('duringUserTestExecution')) return
 
@@ -353,8 +355,19 @@ const stabilityChanged = (Cypress, state, config, stable) => {
           options._log.set('message', '--page loaded--').snapshot().end()
         }
 
-        return resolve()
-      })
+        resolve()
+      }
+
+      const onCrossDomainWindowLoad = () => {
+        cy.off('window:load', onWindowLoad)
+
+        options._log.set('message', '--page loaded--').snapshot().end()
+
+        resolve()
+      }
+
+      cy.once('window:load', onWindowLoad)
+      cy.once('cross:domain:window:load', onCrossDomainWindowLoad)
     })
   }
 

packages/driver/src/cy/listeners.ts

@@ -65,6 +65,10 @@ export default {
       callbacks.onBeforeUnload(e)
     })
 
+    addListener(contentWindow, 'load', (e) => {
+      callbacks.onLoad(e)
+    })
+
     addListener(contentWindow, 'unload', (e) => {
       // when we unload we need to remove all of the event listeners
       removeAllListeners()

packages/driver/src/cy/multidomain/index.ts

@@ -1,20 +1,39 @@
 import Bluebird from 'bluebird'
+import $Log from '../../cypress/log'
+import { createDeferred } from '../../util/deferred'
+
+const readiedDomains = {}
 
 export function addCommands (Commands, Cypress: Cypress.Cypress, cy: Cypress.cy, state: Cypress.State) {
   Commands.addAll({
+    // this is a stop-gap command temporarily in use until looking ahead for
+    // switchToDomain, etc is implemented
     anticipateMultidomain () {
+      const domain = '127.0.0.1:3501'
+
       state('anticipateMultidomain', true)
 
       return new Bluebird((resolve) => {
+        // the spec bridge iframe only loads once, and that's when it sends
+        // 'cross:domain:bridge:ready', so if we've already readied it,
+        // there's no need to wait
+        if (readiedDomains[domain]) {
+          return resolve()
+        }
+
         // @ts-ignore
         Cypress.once('cross:domain:bridge:ready', () => {
+          readiedDomains[domain] = true
+
           resolve()
         })
 
-        Cypress.action('cy:expect:domain', '127.0.0.1:3501')
+        Cypress.action('cy:expect:domain', domain)
       })
     },
 
+    // this isn't fully implemented, but in place to be able to test out
+    // the other parts of multidomain
     switchToDomain (domain, fn) {
       Cypress.log({
         name: 'switchToDomain',
@@ -23,7 +42,98 @@ export function addCommands (Commands, Cypress: Cypress.Cypress, cy: Cypress.cy,
         end: true,
       })
 
-      Cypress.action('cy:cross:domain:message', 'run:in:domain', fn.toString())
+      // these are proxy commands that represent real commands in a
+      // secondary domain. this way, the queue runs in the primary domain
+      // with all commands, making it possible to sync up timing for
+      // the reporter command log, etc
+      const commands = {}
+      const logs = {}
+
+      const addCommand = (attrs) => {
+        const deferred = createDeferred()
+
+        commands[attrs.id] = {
+          deferred,
+          name: attrs.name,
+        }
+
+        attrs.fn = () => {
+          // the real command running in the secondary domain handles its
+          // own timeout
+          // TODO: add a special, long timeout in case inter-domain
+          // communication breaks down somehow
+          // @ts-ignore
+          cy.clearTimeout()
+
+          Cypress.action('cy:cross:domain:message', {
+            message: 'run:command',
+          })
+
+          return deferred.promise
+        }
+
+        Cypress.action('cy:enqueue:command', attrs)
+      }
+
+      const updateCommand = (details) => {
+        if (details.logAdded) {
+          const attrs = details.logAdded
+
+          attrs.consoleProps = () => details.logAdded.consoleProps
+          attrs.renderProps = () => details.logAdded.renderProps
+
+          const log = Cypress.log(attrs)
+
+          logs[log.get('id')] = log
+
+          return
+        }
+
+        if (details.logChanged) {
+          const log = logs[details.logChanged.id]
+
+          if (log) {
+            log.set(details.logChanged)
+          }
+
+          return
+        }
+
+        if (details.end) {
+          const command = commands[details.id]
+
+          if (command) {
+            delete commands[details.id]
+            command.deferred.resolve()
+          }
+        }
+      }
+
+      // @ts-ignore
+      Cypress.on('cross:domain:command:enqueued', addCommand)
+      // @ts-ignore
+      Cypress.on('cross:domain:command:update', updateCommand)
+
+      return new Bluebird((resolve) => {
+        // @ts-ignore
+        Cypress.once('cross:domain:ran:domain:fn', () => {
+          resolve()
+        })
+
+        // @ts-ignore
+        Cypress.once('cross:domain:queue:finished', () => {
+          // @ts-ignore
+          Cypress.off('cross:domain:command:enqueued', addCommand)
+          // @ts-ignore
+          Cypress.off('cross:domain:command:update', updateCommand)
+        })
+
+        Cypress.action('cy:cross:domain:message', {
+          message: 'run:domain:fn',
+          logCounter: $Log.getCounter(),
+          fn: fn.toString(),
+        })
+      })
     },
   })
 }

packages/driver/src/cypress.ts

@@ -203,12 +203,8 @@ class $Cypress {
   // or parsed. we have not received any custom commands
   // at this point
   onSpecWindow (specWindow, scripts) {
-    const logFn = (...args) => {
-      return this.log.apply(this, args)
-    }
-
     // create cy and expose globally
-    this.cy = $Cy.create(specWindow, this, this.Cookies, this.state, this.config, logFn)
+    this.cy = $Cy.create(specWindow, this, this.Cookies, this.state, this.config)
     window.cy = this.cy
     this.isCy = this.cy.isCy
     this.log = $Log.create(this, this.cy, this.state, this.config)
@@ -474,6 +470,9 @@ class $Cypress {
       case 'cy:command:end':
         return this.emit('command:end', ...args)
 
+      case 'cy:skipped:command:end':
+        return this.emit('skipped:command:end', ...args)
+
       case 'cy:command:retry':
         return this.emit('command:retry', ...args)
 
@@ -486,6 +485,9 @@ class $Cypress {
       case 'cy:command:queue:end':
         return this.emit('command:queue:end')
 
+      case 'cy:enqueue:command':
+        return this.emit('enqueue:command', ...args)
+
       case 'cy:url:changed':
         return this.emit('url:changed', args[0])
 
@@ -554,6 +556,21 @@ class $Cypress {
       case 'runner:cross:domain:bridge:ready':
         return this.emit('cross:domain:bridge:ready')
 
+      case 'runner:cross:domain:window:load':
+        return this.emit('cross:domain:window:load')
+
+      case 'runner:cross:domain:ran:domain:fn':
+        return this.emit('cross:domain:ran:domain:fn')
+
+      case 'runner:cross:domain:queue:finished':
+        return this.emit('cross:domain:queue:finished')
+
+      case 'runner:cross:domain:command:enqueued':
+        return this.emit('cross:domain:command:enqueued', ...args)
+
+      case 'runner:cross:domain:command:update':
+        return this.emit('cross:domain:command:update', ...args)
+
       case 'cy:cross:domain:message':
         return this.emit('cross:domain:message', ...args)
 

packages/driver/src/cypress/chainer.ts

@@ -6,7 +6,10 @@ export class $Chainer {
   constructor (userInvocationStack, specWindow) {
     this.userInvocationStack = userInvocationStack
     this.specWindow = specWindow
-    this.chainerId = _.uniqueId('chainer')
+    // the id prefix needs to be unique per domain, so there are not
+    // collisions when chainers created in a secondary domain are passed
+    // to the primary domain for the command log, etc.
+    this.chainerId = _.uniqueId(`ch-${window.location.origin}-`)
     this.firstCall = true
   }