fix: error regression - strip ansi colors out of cy.fixture() error m…

…essage (#20335) * fix cy.fixture regression - strip ansi colors out of fixture error message * empty commit to appease the semantic release gods * fix 2nd regression formatting when setting invalid config values - remove extra backtick * increase webpack dev server timeout values
cypress-io · Feb 28, 2022 · e0bd6ac · e0bd6ac · cypress-bot · Feb 28, 2022
1 parent ffd3627
commit e0bd6ac
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 37 deletions.
diff --git a/npm/webpack-dev-server/test/e2e.spec.ts b/npm/webpack-dev-server/test/e2e.spec.ts
@@ -187,3 +187,4 @@ describe('#startDevServer', () => {
     })
   })
 })
+.timeout(5000)
diff --git a/packages/driver/cypress/integration/commands/fixtures_spec.js b/packages/driver/cypress/integration/commands/fixtures_spec.js
@@ -1,3 +1,5 @@
+const stripAnsi = require('strip-ansi')
+
 const { assertLogLength } = require('../../support/utils')
 const { Promise } = Cypress
 
@@ -130,6 +132,10 @@ describe('src/cy/commands/fixtures', () => {
           expect(err.message).to.include('A fixture file could not be found')
           expect(err.message).to.include('cypress/fixtures/err')
 
+          // ensure ansi color codes are not embedded in the error msg
+          // https://github.com/cypress-io/cypress/issues/20208
+          expect(err.message).to.eq(stripAnsi(err.message))
+
           done()
         })
 

diff --git a/packages/driver/cypress/integration/e2e/testConfigOverrides_spec.js b/packages/driver/cypress/integration/e2e/testConfigOverrides_spec.js
@@ -243,7 +243,7 @@ describe('per-test config', () => {
     })
   })
 
-  describe('in mulitple nested suites', {
+  describe('in multiple nested suites', {
     foo: false,
   }, () => {
     describe('config in suite', {

diff --git a/packages/driver/src/cypress.ts b/packages/driver/src/cypress.ts
@@ -251,7 +251,7 @@ class $Cypress {
         // and those leak out into the stdout formatting.
         const errMsg = _.isString(errResult)
           ? errResult
-          : `Expected ${format(errResult.key)} to be ${errResult.type}.\n\nInstead the value was: ${stringify(errResult.value)}\``
+          : `Expected ${format(errResult.key)} to be ${errResult.type}.\n\nInstead the value was: ${stringify(errResult.value)}`
 
         throw new this.state('specWindow').Error(errMsg)
       })

diff --git a/packages/server/lib/fixture.js b/packages/server/lib/fixture.js
@@ -4,6 +4,8 @@ const debug = require('debug')('cypress:server:fixture')
 const coffee = require('coffeescript')
 const Promise = require('bluebird')
 const jsonlint = require('jsonlint')
+const stripAnsi = require('strip-ansi')
+
 const errors = require('./errors')
 const { fs } = require('./util/fs')
 const glob = require('./util/glob')
@@ -60,7 +62,14 @@ module.exports = {
         if (matches.length === 0) {
           const relativePath = path.relative('.', p)
 
-          errors.throw('FIXTURE_NOT_FOUND', relativePath, extensions)
+          // TODO: there's no reason this error should be in
+          // the @packages/error list, it should be written in
+          // the driver since this error can only occur within
+          // driver commands and not outside of the test runner
+          const err = errors.get('FIXTURE_NOT_FOUND', relativePath, extensions)
+
+          err.message = stripAnsi(err.message)
+          throw err
         }
 
         debug('fixture matches found, using the first', matches)

diff --git a/system-tests/__snapshots__/testConfigOverrides_spec.ts.js b/system-tests/__snapshots__/testConfigOverrides_spec.ts.js
@@ -182,13 +182,13 @@ exports['testConfigOverrides / fails when passing invalid config values - [chrom
   1) inline test config override throws error:
      Error: Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`""\`\`
+Instead the value was: \`""\`
       [stack trace lines]
 
   2) inline test config override throws error when executed within cy cmd:
      Error: Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`"null"\`\`
+Instead the value was: \`"null"\`
       [stack trace lines]
 
   3) context config overrides throws error
@@ -197,7 +197,7 @@ Instead the value was: \`"null"\`\`
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
   Error
@@ -209,7 +209,7 @@ https://on.cypress.io/config
 
 Expected \`defaultCommandTimeout\` to be a number.
 
-Instead the value was: \`"500"\`\`
+Instead the value was: \`"500"\`
 
 https://on.cypress.io/config
   Error
@@ -221,7 +221,7 @@ https://on.cypress.io/config
 
 Expected \`defaultCommandTimeout\` to be a number.
 
-Instead the value was: \`"500"\`\`
+Instead the value was: \`"500"\`
 
 https://on.cypress.io/config
   Error
@@ -234,7 +234,7 @@ https://on.cypress.io/config
 
 Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`"not_an_http_url"\`\`
+Instead the value was: \`"not_an_http_url"\`
 
 https://on.cypress.io/config
   Error
@@ -246,7 +246,7 @@ https://on.cypress.io/config
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
 
@@ -260,7 +260,7 @@ Because this error occurred during a \`before all\` hook we are skipping the rem
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
   Error
@@ -350,14 +350,14 @@ exports['testConfigOverrides / fails when passing invalid config values with bef
        inline test config override throws error:
      Error: Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`""\`\`
+Instead the value was: \`""\`
       [stack trace lines]
 
   2) runs all tests
        inline test config override throws error when executed within cy cmd:
      Error: Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`"null"\`\`
+Instead the value was: \`"null"\`
       [stack trace lines]
 
   3) runs all tests
@@ -367,7 +367,7 @@ Instead the value was: \`"null"\`\`
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
   Error
@@ -380,7 +380,7 @@ https://on.cypress.io/config
 
 Expected \`defaultCommandTimeout\` to be a number.
 
-Instead the value was: \`"500"\`\`
+Instead the value was: \`"500"\`
 
 https://on.cypress.io/config
   Error
@@ -393,7 +393,7 @@ https://on.cypress.io/config
 
 Expected \`defaultCommandTimeout\` to be a number.
 
-Instead the value was: \`"500"\`\`
+Instead the value was: \`"500"\`
 
 https://on.cypress.io/config
   Error
@@ -407,7 +407,7 @@ https://on.cypress.io/config
 
 Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`"not_an_http_url"\`\`
+Instead the value was: \`"not_an_http_url"\`
 
 https://on.cypress.io/config
   Error
@@ -420,7 +420,7 @@ https://on.cypress.io/config
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
 
@@ -435,7 +435,7 @@ Because this error occurred during a \`before all\` hook we are skipping the rem
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
   Error
@@ -517,7 +517,7 @@ exports['testConfigOverrides / correctly fails when invalid config values for it
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
   Error
@@ -601,13 +601,13 @@ exports['testConfigOverrides / fails when passing invalid config values - [firef
   1) inline test config override throws error:
      Error: Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`""\`\`
+Instead the value was: \`""\`
       [stack trace lines]
 
   2) inline test config override throws error when executed within cy cmd:
      Error: Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`"null"\`\`
+Instead the value was: \`"null"\`
       [stack trace lines]
 
   3) context config overrides throws error
@@ -616,7 +616,7 @@ Instead the value was: \`"null"\`\`
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
       [stack trace lines]
@@ -627,7 +627,7 @@ https://on.cypress.io/config
 
 Expected \`defaultCommandTimeout\` to be a number.
 
-Instead the value was: \`"500"\`\`
+Instead the value was: \`"500"\`
 
 https://on.cypress.io/config
       [stack trace lines]
@@ -638,7 +638,7 @@ https://on.cypress.io/config
 
 Expected \`defaultCommandTimeout\` to be a number.
 
-Instead the value was: \`"500"\`\`
+Instead the value was: \`"500"\`
 
 https://on.cypress.io/config
       [stack trace lines]
@@ -650,7 +650,7 @@ https://on.cypress.io/config
 
 Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`"not_an_http_url"\`\`
+Instead the value was: \`"not_an_http_url"\`
 
 https://on.cypress.io/config
       [stack trace lines]
@@ -661,7 +661,7 @@ https://on.cypress.io/config
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
 
@@ -674,7 +674,7 @@ Because this error occurred during a \`before all\` hook we are skipping the rem
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
       [stack trace lines]
@@ -763,14 +763,14 @@ exports['testConfigOverrides / fails when passing invalid config values with bef
        inline test config override throws error:
      Error: Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`""\`\`
+Instead the value was: \`""\`
       [stack trace lines]
 
   2) runs all tests
        inline test config override throws error when executed within cy cmd:
      Error: Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`"null"\`\`
+Instead the value was: \`"null"\`
       [stack trace lines]
 
   3) runs all tests
@@ -780,7 +780,7 @@ Instead the value was: \`"null"\`\`
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
       [stack trace lines]
@@ -792,7 +792,7 @@ https://on.cypress.io/config
 
 Expected \`defaultCommandTimeout\` to be a number.
 
-Instead the value was: \`"500"\`\`
+Instead the value was: \`"500"\`
 
 https://on.cypress.io/config
       [stack trace lines]
@@ -804,7 +804,7 @@ https://on.cypress.io/config
 
 Expected \`defaultCommandTimeout\` to be a number.
 
-Instead the value was: \`"500"\`\`
+Instead the value was: \`"500"\`
 
 https://on.cypress.io/config
       [stack trace lines]
@@ -817,7 +817,7 @@ https://on.cypress.io/config
 
 Expected \`baseUrl\` to be a fully qualified URL (starting with \`http://\` or \`https://\`).
 
-Instead the value was: \`"not_an_http_url"\`\`
+Instead the value was: \`"not_an_http_url"\`
 
 https://on.cypress.io/config
       [stack trace lines]
@@ -829,7 +829,7 @@ https://on.cypress.io/config
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
 
@@ -843,7 +843,7 @@ Because this error occurred during a \`before all\` hook we are skipping the rem
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
       [stack trace lines]
@@ -924,7 +924,7 @@ exports['testConfigOverrides / correctly fails when invalid config values for it
 
 Expected \`retries\` to be a positive number or null or an object with keys "openMode" and "runMode" with values of numbers or nulls.
 
-Instead the value was: \`"1"\`\`
+Instead the value was: \`"1"\`
 
 https://on.cypress.io/config
       [stack trace lines]