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

require('../spec_helper')

const _ = require('lodash')
const Promise = require('bluebird')
const appData = require(`../../lib/util/app_data`)
const logger = require(`../../lib/logger`)
const exception = require(`../../lib/exception`)

describe('lib/logger', () => {
  beforeEach(() => {
    return logger.clearLogs()
  })

  afterEach(() => {
    return logger.removeAllListeners('logging')
  })

  after(() => {
    return appData.remove()
  })

  it('has 1 transport', () => {
    expect(logger.transports).to.include.keys('all')
  })

  it('logs to all', (done) => {
    done = _.once(done)

    logger.on('logging', (transport, level, msg, data) => {
      expect(level).to.eq('info')
      expect(msg).to.eq('foo!')
      expect(data).to.deep.eq({ foo: 'bar', type: 'server' })

      return done()
    })

    return logger.info('foo!', { foo: 'bar' })
  })

  describe('#onLog', () => {
    it('calls back with log', (done) => {
      logger.onLog((log) => {
        expect(log.level).to.eq('info')
        expect(log.message).to.eq('foo')
        expect(log.data).to.deep.eq({ foo: 'bar' })

        return done()
      })

      return logger.info('foo', { foo: 'bar' })
    })

    it('slices type out of data', (done) => {
      logger.onLog((log) => {
        expect(log.level).to.eq('info')
        expect(log.message).to.eq('foo')
        expect(log.data).to.deep.eq({ foo: 'bar' })
        expect(log.type).to.eq('native')

        return done()
      })

      return logger.info('foo', { foo: 'bar', type: 'native' })
    })
  })

  describe('#getLogs', () => {
    beforeEach((done) => {
      logger.onLog((log) => {
        return done()
      })

      return logger.info('foo', { foo: 'bar' })
    })

    it('resolves with logs', () => {
      return logger.getLogs('all').then((logs) => {
        expect(logs).to.have.length(1)
      })
    })
  })

  describe('#getData', () => {
    it('nests data object in each log', () => {
      const obj = { level: 'info', message: 'foo', type: 'native', foo: 'bar' }

      expect(logger.getData(obj)).to.deep.eq({
        level: 'info',
        message: 'foo',
        type: 'native',
        data: {
          foo: 'bar',
        },
      })
    })
  })

  describe('#exitOnError', () => {
    it('invokes logger.defaultErrorHandler', () => {
      const err = new Error()
      const defaultErrorHandler = sinon.stub(logger, 'defaultErrorHandler')

      logger.exitOnError(err)

      expect(defaultErrorHandler).to.be.calledWith(err)
    })
  })

  describe('#defaultErrorHandler', () => {
    beforeEach(function () {
      logger.unsetSettings()

      this.err = new Error()
      this.exit = sinon.stub(process, 'exit')
      this.create = sinon.stub(exception, 'create').resolves()
    })

    afterEach(() => {
      return logger.unsetSettings()
    })

    it('calls exception.create(err)', function () {
      logger.defaultErrorHandler(this.err)

      expect(this.create).to.be.calledWith(this.err, undefined)
    })

    it('calls exception.create(err, {})', function () {
      logger.setSettings({ foo: 'bar' })
      logger.defaultErrorHandler(this.err)

      expect(this.create).to.be.calledWith(this.err, { foo: 'bar' })
    })

    it('returns false', function () {
      expect(logger.defaultErrorHandler(this.err)).to.be.false
    })

    context('handleErr', () => {
      it('is called after resolving', function () {
        logger.defaultErrorHandler(this.err)

        return Promise.delay(50).then(() => {
          expect(this.exit).to.be.called
        })
      })

      it('is called after rejecting', function () {
        this.create.rejects(new Error())
        logger.defaultErrorHandler(this.err)

        return Promise.delay(50).then(() => {
          expect(this.exit).to.be.called
        })
      })

      it('calls process.exit(1)', function () {
        logger.defaultErrorHandler(this.err)

        return Promise.delay(50).then(() => {
          expect(this.exit).to.be.calledWith(1)
        })
      })

      it('calls Log#errorhandler', function () {
        const fn = sinon.spy()

        logger.setErrorHandler(fn)
        logger.defaultErrorHandler(this.err)

        return Promise.delay(50).then(() => {
          expect(fn).to.be.called
        })
      })

      it('calls exit if Log#errorhandler returns true', function () {
        logger.setErrorHandler(() => {
          return true
        })

        logger.defaultErrorHandler(this.err)

        return Promise.delay(50).then(() => {
          expect(this.exit).to.be.called
        })
      })
    })
  })

  describe('unhandledRejection', () => {
    it('passes error to defaultErrorHandler', () => {
      sinon.stub(logger, 'defaultErrorHandler')

      const handlers = process.listeners('unhandledRejection')

      expect(handlers.length).to.eq(1)

      const err = new Error('foo')

      return handlers[0](err)
    })

    it('catches unhandled rejections', () => {
      const defaultErrorHandler = sinon.stub(logger, 'defaultErrorHandler')

      Promise
      .resolve('')
      .throw(new Error('foo'))

      return Promise.delay(50).then(() => {
        expect(defaultErrorHandler).to.be.calledOnce

        expect(defaultErrorHandler.getCall(0).args[0].message).to.eq('foo')
      })
    })
  })
})

// expect(defaultErrorHandler).to.be.calledWith(err)
// it "logs to error", (done) ->
//   # debugger
//   process.listeners("uncaughtException").pop()
//   err = (new Error)

//   logger.on "logging", (transport, level, msg, data) ->
//     debugger
//     if transport.name is "error"
//       expect(level).to.eq("error")
//       expect(msg).to.eq("err")
//       expect(data).to.eq(err)
//       done()

//   process.on "uncaughtException", (err) ->
//     debugger

//   throw err