@revoloo/cypress6/packages/server/lib/plugins/dev-server.js

Cypress.io end to end testing tool

require('../cwd')

const EE = require('events')
const debug = require('debug')('cypress:ct:dev-server')
const plugins = require('../plugins')

const baseEmitter = new EE()

plugins.registerHandler((ipc) => {
  baseEmitter.on('dev-server:specs:changed', (specs) => {
    ipc.send('dev-server:specs:changed', specs)
  })

  ipc.on('dev-server:compile:error', (error) => {
    baseEmitter.emit('dev-server:compile:error', error)
  })

  ipc.on('dev-server:compile:success', () => {
    allowToRequest = true,
    baseEmitter.emit('dev-server:compile:success')
  })

  return baseEmitter.on('dev-server:close', () => {
    debug('base emitter plugin close event')

    return ipc.send('dev-server:close')
  })
})

// for simpler stubbing from unit tests
const API = {
  emitter: baseEmitter,

  start ({ specs, config }) {
    if (!plugins.has('dev-server:start')) {
      // TODO: add link to the documentation in the error message
      throw new Error('It is required to register dev-server plugin that implements `dev-server:start` event for component testing.')
    }

    return plugins.execute('dev-server:start', { specs, config })
  },

  updateSpecs (specs) {
    return baseEmitter.emit('dev-server:specs:changed', specs)
  },

  close () {
    debug('close dev-server')
    baseEmitter.emit('close')

    return baseEmitter.removeAllListeners()
  },
}

module.exports = API