Merge branch 'feature-multidomain' into md-todos-fixmes

Author: mjhenkes

packages/driver/cypress/integration/e2e/multi-domain/navigation_spec.ts

@@ -209,7 +209,7 @@ describe('event timing', () => {
       cy.log('inside cy.origin foobar')
     })
 
-    // This command is run from localhost against the cross origin aut. Updating href is one of the few allowed commands. See https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy#location
+    // This command is run from localhost against the cross-origin aut. Updating href is one of the few allowed commands. See https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy#location
     cy.window().then((win) => {
       win.location.href = 'http://www.idp.com:3500/fixtures/multi-domain.html'
     })
@@ -265,11 +265,10 @@ describe('errors', () => {
     cy.on('fail', (err) => {
       expect(err.message).to.include(`Timed out after waiting \`5000ms\` for your remote page to load on origin(s):`)
       expect(err.message).to.include(`\n- \`http://localhost:3500\`\n`)
-      expect(err.message).to.include(`Your page did not fire its \`load\` event within \`5000ms\`.`)
-      expect(err.message).to.include(`A cross origin request for \`http://www.foobar.com:3500/fixtures/auth/idp.html?redirect=http%3A%2F%2Flocalhost%3A3500%2Ffixtures%2Fauth%2Findex.html\` was detected.`)
-      expect(err.message).to.include(`A command that triggers cross origin navigation must be immediately followed by a \`cy.origin()\` command:`)
+      expect(err.message).to.include(`A cross-origin request for \`http://www.foobar.com:3500/fixtures/auth/idp.html?redirect=http%3A%2F%2Flocalhost%3A3500%2Ffixtures%2Fauth%2Findex.html\` was detected.`)
+      expect(err.message).to.include(`A command that triggers cross-origin navigation must be immediately followed by a \`cy.origin()\` command:`)
       expect(err.message).to.include(`\`\ncy.origin(\'http://foobar.com:3500\', () => {\n  <commands targeting http://www.foobar.com:3500 go here>\n})\n\``)
-      expect(err.message).to.include(`If the cross origin request was an intermediary state, you can try increasing the \`pageLoadTimeout\` value in \`cypress.json\` to wait longer`)
+      expect(err.message).to.include(`If the cross-origin request was an intermediary state, you can try increasing the \`pageLoadTimeout\` value in \`cypress.json\` to wait longer`)
 
       expect(err.message).not.to.include(`The following error originated from your test code, not from Cypress`)
       expect(err.message).not.to.include(`The following error originated from your application code, not from Cypress`)
@@ -281,10 +280,11 @@ describe('errors', () => {
     cy.get('[data-cy="login-foobar"]')
   })
 
-  it('never redirects to the cross origin', { defaultCommandTimeout: 50 }, (done) => {
+  it('never redirects to the cross-origin', { defaultCommandTimeout: 50 }, (done) => {
     cy.on('fail', (err) => {
       expect(err.message).to.include(`Timed out retrying after 50ms: Expected to find element: \`[data-cy="username"]\`, but never found it`)
-      expect(err.message).to.include(`The command was expected to run against origin: \`http://idp.com:3500\` but the application is at origin: \`http://localhost:3500\`.`)
+      expect(err.message).to.include(`The command was expected to run against origin \`http://idp.com:3500\` but the application is at origin \`http://localhost:3500\`.`)
+      expect(err.message).to.include(`This commonly happens when you have either not navigated to the expected origin or have navigated away unexpectedly.`)
       //  make sure that the secondary origin failures do NOT show up as spec failures or AUT failures
       expect(err.message).not.to.include(`The following error originated from your test code, not from Cypress`)
       expect(err.message).not.to.include(`The following error originated from your application code, not from Cypress`)
@@ -303,11 +303,11 @@ describe('errors', () => {
     .should('equal', 'Welcome BJohnson')
   })
 
-  it('redirects to the wrong cross origin', { pageLoadTimeout: 5000 }, (done) => {
+  it('redirects to the wrong cross-origin', { pageLoadTimeout: 5000 }, (done) => {
     cy.on('fail', (err) => {
       expect(err.message).to.include(`Timed out after waiting \`5000ms\` for your remote page to load on origin(s):`)
       expect(err.message).to.include(`\n- \`http://idp.com:3500\`\n`)
-      expect(err.message).to.include(`A cross origin request for \`http://www.foobar.com:3500/fixtures/auth/idp.html?redirect=http%3A%2F%2Flocalhost%3A3500%2Ffixtures%2Fauth%2Findex.html\` was detected.`)
+      expect(err.message).to.include(`A cross-origin request for \`http://www.foobar.com:3500/fixtures/auth/idp.html?redirect=http%3A%2F%2Flocalhost%3A3500%2Ffixtures%2Fauth%2Findex.html\` was detected.`)
       expect(err.message).to.include(`\`\ncy.origin(\'http://foobar.com:3500\', () => {\n  <commands targeting http://www.foobar.com:3500 go here>\n})\n\``)
 
       expect(err.message).not.to.include(`The following error originated from your test code, not from Cypress`)
@@ -331,7 +331,7 @@ describe('errors', () => {
   it('never returns to the primary origin', { defaultCommandTimeout: 50 }, (done) => {
     cy.on('fail', (err) => {
       expect(err.message).to.include(`Timed out retrying after 50ms: Expected to find element: \`[data-cy="welcome"]\`, but never found it`)
-      expect(err.message).to.include(`The command was expected to run against origin: \`http://localhost:3500\` but the application is at origin: \`http://idp.com:3500\`.`)
+      expect(err.message).to.include(`The command was expected to run against origin \`http://localhost:3500\` but the application is at origin \`http://idp.com:3500\`.`)
       //  make sure that the secondary origin failures do NOT show up as spec failures or AUT failures
       expect(err.message).not.to.include(`The following error originated from your test code, not from Cypress`)
       expect(err.message).not.to.include(`The following error originated from your application code, not from Cypress`)
@@ -350,11 +350,11 @@ describe('errors', () => {
     .should('equal', 'Welcome BJohnson')
   })
 
-  it('redirects to an unexpected cross origin', { pageLoadTimeout: 5000 }, (done) => {
+  it('redirects to an unexpected cross-origin', { pageLoadTimeout: 5000 }, (done) => {
     cy.on('fail', (err) => {
       expect(err.message).to.include(`Timed out after waiting \`5000ms\` for your remote page to load on origin(s):`)
       expect(err.message).to.include(`\n- \`http://localhost:3500\`\n`)
-      expect(err.message).to.include(`A cross origin request for \`http://www.foobar.com:3500/fixtures/auth/index.html\` was detected.`)
+      expect(err.message).to.include(`A cross-origin request for \`http://www.foobar.com:3500/fixtures/auth/index.html\` was detected.`)
       expect(err.message).to.include(`\`\ncy.origin(\'http://foobar.com:3500\', () => {\n  <commands targeting http://www.foobar.com:3500 go here>\n})\n\``)
 
       expect(err.message).not.to.include(`The following error originated from your test code, not from Cypress`)
@@ -377,11 +377,11 @@ describe('errors', () => {
     .should('equal', 'Welcome BJohnson')
   })
 
-  it('redirects to an unexpected cross origin and calls another command in the cy.origin command', { pageLoadTimeout: 5000 }, (done) => {
+  it('redirects to an unexpected cross-origin and calls another command in the cy.origin command', { pageLoadTimeout: 5000 }, (done) => {
     cy.on('fail', (err) => {
       expect(err.message).to.include(`Timed out after waiting \`5000ms\` for your remote page to load on origin(s):`)
       expect(err.message).to.include(`\n- \`http://idp.com:3500\`\n`)
-      expect(err.message).to.include(`A cross origin request for \`http://www.foobar.com:3500/fixtures/auth/index.html\` was detected.`)
+      expect(err.message).to.include(`A cross-origin request for \`http://www.foobar.com:3500/fixtures/auth/index.html\` was detected.`)
       expect(err.message).to.include(`\`\ncy.origin(\'http://foobar.com:3500\', () => {\n  <commands targeting http://www.foobar.com:3500 go here>\n})\n\``)
 
       expect(err.message).not.to.include(`The following error originated from your test code, not from Cypress`)
@@ -409,7 +409,7 @@ describe('errors', () => {
   it('fails in cy.origin when a command is run after we return to localhost', { defaultCommandTimeout: 50 }, (done) => {
     cy.on('fail', (err) => {
       expect(err.message).to.include(`Timed out retrying after 50ms: Expected to find element: \`[data-cy="cannot_find"]\`, but never found it`)
-      expect(err.message).to.include(`The command was expected to run against origin: \`http://idp.com:3500\` but the application is at origin: \`http://localhost:3500\`.`)
+      expect(err.message).to.include(`The command was expected to run against origin \`http://idp.com:3500\` but the application is at origin \`http://localhost:3500\`.`)
       //  make sure that the secondary origin failures do NOT show up as spec failures or AUT failures
       expect(err.message).not.to.include(`The following error originated from your test code, not from Cypress`)
       expect(err.message).not.to.include(`The following error originated from your application code, not from Cypress`)
@@ -454,7 +454,7 @@ describe('errors', () => {
       cy.on('fail', (err) => {
         expect(err.message).to.include(`Timed out after waiting \`5000ms\` for your remote page to load on origin(s):`)
         expect(err.message).to.include(`\n- \`http://localhost:3500\`\n`)
-        expect(err.message).to.include(`A cross origin request for \`http://www.foobar.com:3500/fixtures/auth/index.html\` was detected.`)
+        expect(err.message).to.include(`A cross-origin request for \`http://www.foobar.com:3500/fixtures/auth/index.html\` was detected.`)
         expect(err.message).to.include(`\`\ncy.origin(\'http://foobar.com:3500\', () => {\n  <commands targeting http://www.foobar.com:3500 go here>\n})\n\``)
 
         expect(err.message).not.to.include(`The following error originated from your test code, not from Cypress`)
@@ -503,7 +503,7 @@ describe('errors', () => {
       cy.on('fail', (err) => {
         expect(err.message).to.include(`Timed out after waiting \`5000ms\` for your remote page to load on origin(s):`)
         expect(err.message).to.include(`\n- \`http://localhost:3500\`\n`)
-        expect(err.message).to.include(`A cross origin request for \`http://www.foobar.com:3500/fixtures/auth/index.html\` was detected.`)
+        expect(err.message).to.include(`A cross-origin request for \`http://www.foobar.com:3500/fixtures/auth/index.html\` was detected.`)
         expect(err.message).to.include(`\`\ncy.origin(\'http://foobar.com:3500\', () => {\n  <commands targeting http://www.foobar.com:3500 go here>\n})\n\``)
 
         expect(err.message).not.to.include(`The following error originated from your test code, not from Cypress`)

packages/driver/src/cypress/error_messages.ts

@@ -895,7 +895,10 @@ export default {
       return `Timed out retrying after ${ms}ms: `
     },
     cross_origin_command ({ commandOrigin, autOrigin }) {
-      return `The command was expected to run against origin: \`${commandOrigin }\` but the application is at origin: \`${autOrigin}\`.`
+      return stripIndent`\
+        The command was expected to run against origin \`${commandOrigin }\` but the application is at origin \`${autOrigin}\`.
+
+        This commonly happens when you have either not navigated to the expected origin or have navigated away unexpectedly.`
     },
   },
 
@@ -989,29 +992,29 @@ export default {
         If so, increase \`redirectionLimit\` value in configuration.`
     },
     cross_origin_load_timed_out ({ ms, configFile, crossOriginUrl, originPolicies }) {
-      return stripIndent`\
-
-        Timed out after waiting \`${ms}ms\` for your remote page to load on origin(s):
-
-        - ${originPolicies.map((originPolicy) => `\`${originPolicy}\``).join('\n       -')}
+      return {
+        message: stripIndent`\
+          Timed out after waiting \`${ms}ms\` for your remote page to load on origin(s):
 
-        Your page did not fire its \`load\` event within \`${ms}ms\`.
+          - ${originPolicies.map((originPolicy) => `\`${originPolicy}\``).join('\n       -')}
 
-        A cross origin request for \`${crossOriginUrl.href}\` was detected.
+          A cross-origin request for \`${crossOriginUrl.href}\` was detected.
 
-        A command that triggers cross origin navigation must be immediately followed by a ${cmd('origin')} command:
+          A command that triggers cross-origin navigation must be immediately followed by a ${cmd('origin')} command:
 
-        \`\`\`
-        cy.origin('${crossOriginUrl.originPolicy}', () => {
-          <commands targeting ${crossOriginUrl.origin} go here>
-        })
-        \`\`\`
+          \`\`\`
+          cy.origin('${crossOriginUrl.originPolicy}', () => {
+            <commands targeting ${crossOriginUrl.origin} go here>
+          })
+          \`\`\`
 
-        If the cross origin request was an intermediary state, you can try increasing the \`pageLoadTimeout\` value in ${formatConfigFile(configFile)} to wait longer.
+          If the cross-origin request was an intermediary state, you can try increasing the \`pageLoadTimeout\` value in ${formatConfigFile(configFile)} to wait longer.
 
-        Browsers will not fire the \`load\` event until all stylesheets and scripts are done downloading.
+          Browsers will not fire the \`load\` event until all stylesheets and scripts are done downloading.
 
-        When this \`load\` event occurs, Cypress will continue running commands.`
+          When this \`load\` event occurs, Cypress will continue running commands.`,
+        docsUrl: 'https://on.cypress.io/origin',
+      }
     },
   },