cypress/packages/server/test/unit/errors_spec.js

require('../spec_helper')

const style = require('ansi-styles')
const chalk = require('chalk')
const errors = require(`../../lib/errors`)
const logger = require(`../../lib/logger`)
const snapshot = require('snap-shot-it')

describe('lib/errors', () => {
  beforeEach(() => {
    return sinon.spy(console, 'log')
  })

  context('.log', () => {
    it('uses red by default', () => {
      const err = errors.get('NOT_LOGGED_IN')

      const ret = errors.log(err)

      expect(ret).to.be.undefined

      const {
        red,
      } = style

      expect(console.log).to.be.calledWithMatch(red.open)

      expect(console.log).to.be.calledWithMatch(red.close)
    })

    it('can change the color', () => {
      const err = errors.get('NOT_LOGGED_IN')

      const ret = errors.log(err, 'yellow')

      expect(ret).to.be.undefined

      const {
        yellow,
      } = style

      expect(console.log).to.be.calledWithMatch(yellow.open)

      expect(console.log).to.be.calledWithMatch(yellow.close)
    })

    it('logs err.message', () => {
      const err = errors.get('NO_PROJECT_ID', 'foo/bar/baz')

      const ret = errors.log(err)

      expect(ret).to.be.undefined

      expect(console.log).to.be.calledWithMatch('foo/bar/baz')
    })

    it('converts markdown links in err.message', () => {
      const err = errors.get('NO_PROJECT_ID', `
        This line has [linked text](https://on.cypress.io) in it. There's a period in the middle.

        This line has [linked text at the end](https://on.cypress.io).

        This line has [linked text](https://on.cypress.io) with no period
      `)

      errors.log(err)

      expect(console.log).to.be.calledWithMatch('This line has linked text in it. There\'s a period in the middle: https://on.cypress.io')
      expect(console.log).to.be.calledWithMatch('This line has linked text at the end: https://on.cypress.io')
      expect(console.log).to.be.calledWithMatch('This line has linked text with no period: https://on.cypress.io')
    })

    it('logs err.details', () => {
      const err = errors.get('PLUGINS_FUNCTION_ERROR', 'foo/bar/baz', 'details huh')

      const ret = errors.log(err)

      expect(ret).to.be.undefined

      expect(console.log).to.be.calledWithMatch('foo/bar/baz')

      expect(console.log).to.be.calledWithMatch('\n', 'details huh')
    })

    it('logs err.stack in development', () => {
      process.env.CYPRESS_INTERNAL_ENV = 'development'

      const err = new Error('foo')

      const ret = errors.log(err)

      expect(ret).to.eq(err)

      expect(console.log).to.be.calledWith(chalk.red(err.stack))
    })
  })

  context('.logException', () => {
    it('calls logger.createException with unknown error', () => {
      sinon.stub(logger, 'createException').resolves()
      sinon.stub(process.env, 'CYPRESS_INTERNAL_ENV').value('production')

      const err = new Error('foo')

      return errors.logException(err)
      .then(() => {
        expect(console.log).to.be.calledWith(chalk.red(err.stack))

        expect(logger.createException).to.be.calledWith(err)
      })
    })

    it('does not call logger.createException when known error', () => {
      sinon.stub(logger, 'createException').resolves()
      sinon.stub(process.env, 'CYPRESS_INTERNAL_ENV').value('production')

      const err = errors.get('NOT_LOGGED_IN')

      return errors.logException(err)
      .then(() => {
        expect(console.log).not.to.be.calledWith(err.stack)

        expect(logger.createException).not.to.be.called
      })
    })

    it('does not call logger.createException when not in production env', () => {
      sinon.stub(logger, 'createException').resolves()
      sinon.stub(process.env, 'CYPRESS_INTERNAL_ENV').value('development')

      const err = new Error('foo')

      return errors.logException(err)
      .then(() => {
        expect(console.log).not.to.be.calledWith(err.stack)

        expect(logger.createException).not.to.be.called
      })
    })

    it('swallows creating exception errors', () => {
      sinon.stub(logger, 'createException').rejects(new Error('foo'))
      sinon.stub(process.env, 'CYPRESS_INTERNAL_ENV').value('production')

      const err = errors.get('NOT_LOGGED_IN')

      return errors.logException(err)
      .then((ret) => {
        expect(ret).to.be.undefined
      })
    })
  })

  context('.clone', () => {
    it('converts err.message from ansi to html with span classes when html true', () => {
      const err = new Error(`foo${chalk.blue('bar')}${chalk.yellow('baz')}`)
      const obj = errors.clone(err, { html: true })

      expect(obj.message).to.eq('foo<span class="ansi-blue-fg">bar</span><span class="ansi-yellow-fg">baz</span>')
    })

    it('does not convert err.message from ansi to html when no html option', () => {
      const err = new Error(`foo${chalk.blue('bar')}${chalk.yellow('baz')}`)
      const obj = errors.clone(err)

      expect(obj.message).to.eq('foo\u001b[34mbar\u001b[39m\u001b[33mbaz\u001b[39m')
    })
  })

  context('.displayFlags', () => {
    it('returns string formatted from selected keys', () => {
      const options = {
        tags: 'nightly,staging',
        name: 'my tests',
        unused: 'some other value',
      }
      // we are only interested in showig tags and name values
      // and prepending them with custom prefixes
      const mapping = {
        tags: '--tag',
        name: '--name',
      }
      const text = errors.displayFlags(options, mapping)

      return snapshot('tags and name only', text)
    })
  })
})