chore: Refactor multi-domain communication lifecycle

packages/driver/cypress/integration/e2e/multi-domain/commands/multi_domain_actions.spec.ts

@@ -41,43 +41,61 @@ context('multi-domain actions', { experimentalSessionSupport: true, experimental
     })
   })
 
-  it('.submit()', (done) => {
+  it('.submit()', () => {
     cy.get('a[data-cy="dom-link"]').click()
 
-    cy.switchToDomain('foobar.com', done, () => {
-      Cypress.once('form:submitted', () => done())
+    cy.switchToDomain('foobar.com', () => {
+      const afterFormSubmitted = new Promise<void>((resolve) => {
+        cy.once('form:submitted', resolve)
+      })
 
       cy.get('#input-type-submit').submit()
+      cy.wrap(afterFormSubmitted)
     })
   })
 
-  it('.click()', (done) => {
+  it('.click()', () => {
     cy.get('a[data-cy="dom-link"]').click()
 
-    cy.switchToDomain('foobar.com', done, () => {
-      cy.get('#button').then((btn) => {
-        btn.on('click', () => done())
-      }).click()
+    cy.switchToDomain('foobar.com', () => {
+      cy.get('#button').then(($btn) => {
+        const onClick = new Promise<void>((resolve) => {
+          $btn.on('click', () => resolve())
+        })
+
+        cy.wrap($btn).click()
+        cy.wrap(onClick)
+      })
     })
   })
 
-  it('.dblclick()', (done) => {
+  it('.dblclick()', () => {
     cy.get('a[data-cy="dom-link"]').click()
 
-    cy.switchToDomain('foobar.com', done, () => {
-      cy.get('#button').then((btn) => {
-        btn.on('dblclick', () => done())
-      }).dblclick()
+    cy.switchToDomain('foobar.com', () => {
+      cy.get('#button').then(($btn) => {
+        const afterDblClick = new Promise<void>((resolve) => {
+          $btn.on('dblclick', () => resolve())
+        })
+
+        cy.wrap($btn).dblclick()
+        cy.wrap(afterDblClick)
+      })
     })
   })
 
-  it('.rightclick()', (done) => {
+  it('.rightclick()', () => {
     cy.get('a[data-cy="dom-link"]').click()
 
-    cy.switchToDomain('foobar.com', done, () => {
-      cy.get('#button').then((btn) => {
-        btn.on('contextmenu', () => done())
-      }).rightclick()
+    cy.switchToDomain('foobar.com', () => {
+      cy.get('#button').then(($btn) => {
+        const afterContextmenu = new Promise<void>((resolve) => {
+          $btn.on('contextmenu', () => resolve())
+        })
+
+        cy.wrap($btn).rightclick()
+        cy.wrap(afterContextmenu)
+      })
     })
   })
 
@@ -129,13 +147,18 @@ context('multi-domain actions', { experimentalSessionSupport: true, experimental
     })
   })
 
-  it('.trigger()', (done) => {
+  it('.trigger()', () => {
     cy.get('a[data-cy="dom-link"]').click()
 
-    cy.switchToDomain('foobar.com', done, () => {
-      cy.get('#button').then((btn) => {
-        btn.on('click', () => done())
-      }).trigger('click')
+    cy.switchToDomain('foobar.com', () => {
+      cy.get('#button').then(($btn) => {
+        const afterClick = new Promise<void>((resolve) => {
+          $btn.on('click', () => resolve())
+        })
+
+        cy.wrap($btn).trigger('click')
+        cy.wrap(afterClick)
+      })
     })
   })
 

packages/driver/cypress/integration/e2e/multi-domain/commands/multi_domain_misc.spec.ts

@@ -7,18 +7,35 @@ context('multi-domain misc', { experimentalSessionSupport: true, experimentalMul
 
   it('verifies number of cy commands', () => {
     // @ts-ignore
-    expect(Object.keys(cy.commandFns)).to.deep.equal(
-      [
-        'check', 'uncheck', 'click', 'dblclick', 'rightclick', 'focus', 'blur', 'hover', 'scrollIntoView', 'scrollTo', 'select',
-        'selectFile', 'submit', 'type', 'clear', 'trigger', 'as', 'ng', 'should', 'and', 'clock', 'tick', 'spread', 'each', 'then',
-        'invoke', 'its', 'getCookie', 'getCookies', 'setCookie', 'clearCookie', 'clearCookies', 'pause', 'debug', 'exec', 'readFile',
-        'writeFile', 'fixture', 'clearLocalStorage', 'url', 'hash', 'location', 'end', 'noop', 'log', 'wrap', 'reload', 'go', 'visit',
-        'focused', 'get', 'contains', 'shadow', 'root', 'within', 'request', 'session', 'screenshot', 'task', 'find', 'filter', 'not',
-        'children', 'eq', 'closest', 'first', 'last', 'next', 'nextAll', 'nextUntil', 'parent', 'parents', 'parentsUntil', 'prev',
-        'prevAll', 'prevUntil', 'siblings', 'wait', 'title', 'window', 'document', 'viewport', 'server', 'route', 'intercept', 'switchToDomain',
-      ],
-      'The number of cy commands has changed. Please ensure any newly added commands are also tested in multi-domain.',
-    )
+    const actualCommands = Object.keys(cy.commandFns)
+    const expectedCommands = [
+      'check', 'uncheck', 'click', 'dblclick', 'rightclick', 'focus', 'blur', 'hover', 'scrollIntoView', 'scrollTo', 'select',
+      'selectFile', 'submit', 'type', 'clear', 'trigger', 'as', 'ng', 'should', 'and', 'clock', 'tick', 'spread', 'each', 'then',
+      'invoke', 'its', 'getCookie', 'getCookies', 'setCookie', 'clearCookie', 'clearCookies', 'pause', 'debug', 'exec', 'readFile',
+      'writeFile', 'fixture', 'clearLocalStorage', 'url', 'hash', 'location', 'end', 'noop', 'log', 'wrap', 'reload', 'go', 'visit',
+      'focused', 'get', 'contains', 'root', 'shadow', 'within', 'request', 'session', 'screenshot', 'task', 'find', 'filter', 'not',
+      'children', 'eq', 'closest', 'first', 'last', 'next', 'nextAll', 'nextUntil', 'parent', 'parents', 'parentsUntil', 'prev',
+      'prevAll', 'prevUntil', 'siblings', 'wait', 'title', 'window', 'document', 'viewport', 'server', 'route', 'intercept', 'switchToDomain',
+    ]
+    const addedCommands = Cypress._.difference(actualCommands, expectedCommands)
+    const removedCommands = Cypress._.difference(expectedCommands, actualCommands)
+
+    if (addedCommands.length && removedCommands.length) {
+      throw new Error(`Commands have been added to and removed from Cypress.
+
+        The following command(s) were added: ${addedCommands.join(', ')}
+        The following command(s) were removed: ${removedCommands.join(', ')}
+
+        Update this test accordingly.`)
+    }
+
+    if (addedCommands.length) {
+      throw new Error(`The following command(s) have been added to Cypress: ${addedCommands.join(', ')}. Please add the command(s) to this test.`)
+    }
+
+    if (removedCommands.length) {
+      throw new Error(`The following command(s) have been removed from Cypress: ${removedCommands.join(', ')}. Please remove the command(s) from this test.`)
+    }
   })
 
   it('.end()', () => {
@@ -51,24 +68,30 @@ context('multi-domain misc', { experimentalSessionSupport: true, experimentalMul
     })
   })
 
-  it('.log()', (done) => {
-    cy.switchToDomain('foobar.com', done, () => {
-      Cypress.once('log:added', () => {
-        done()
+  it('.log()', () => {
+    cy.switchToDomain('foobar.com', () => {
+      const afterLogAdded = new Promise<void>((resolve) => {
+        cy.once('log:added', () => {
+          resolve()
+        })
       })
 
       cy.log('test log in multi-domain')
+      cy.wrap(afterLogAdded)
     })
   })
 
-  it('.pause()', (done) => {
-    cy.switchToDomain('foobar.com', done, () => {
-      Cypress.once('paused', () => {
-        Cypress.emit('resume:all')
-        done()
+  it('.pause()', () => {
+    cy.switchToDomain('foobar.com', () => {
+      const afterPaused = new Promise<void>((resolve) => {
+        cy.once('paused', () => {
+          Cypress.emit('resume:all')
+          resolve()
+        })
       })
 
       cy.pause()
+      cy.wrap(afterPaused)
     })
   })
 

packages/driver/cypress/integration/e2e/multi-domain/commands/multi_domain_screenshot.spec.ts

@@ -1,5 +1,5 @@
 // @ts-ignore / session support is needed for visiting about:blank between tests
-context('screenshot specs', { experimentalSessionSupport: true, experimentalMultiDomain: true }, () => {
+context('multi-domain screenshot', { experimentalSessionSupport: true, experimentalMultiDomain: true }, () => {
   beforeEach(() => {
     this.serverResult = {
       path: '/path/to/screenshot',
@@ -68,7 +68,7 @@ context('screenshot specs', { experimentalSessionSupport: true, experimentalMult
 
       cy.screenshot()
       .then(() => {
-        expect(automationStub.args[0][1].titles).to.deep.equal(['screenshot specs', 'supports multiple titles'])
+        expect(automationStub.args[0][1].titles).to.deep.equal(['multi-domain screenshot', 'supports multiple titles'])
       })
     })
   })