cq-websocket/test/events/events.test.js

A Node SDK for developing QQ chatbots based on WebSocket, which is depending on CoolQ and CQHTTP API plugin.

const EMIT_DELAY = 100

// stuffs of stubbing
const { spy } = require('sinon')

const { CQWebsocket } = require('../fixture/connect-success')()
const CQEvent = CQWebsocket.CQEvent
const { test } = require('ava')

function emitEvent (t, msgObj = {}) {
  setTimeout(function () {
    t.context.sock.onMessage(JSON.stringify(msgObj))
  }, EMIT_DELAY)
}

function macro (t, event, { rawMessage } = {}) {
  // @deprecated
  const atMe = event.endsWith('.@me') || event.endsWith('.@.me')
  let postfix = ''
  if (atMe) {
    const matched = event.match(/^(message\.(discuss|group))(\.@\.?me)$/)
    event = matched[1]
    postfix = matched[3]
  }

  const arrEvent = event.split('.')
  const [ majorType, minorType, subType ] = arrEvent

  if (!minorType) {
    t.fail('Invalid minor type')
    t.end()
    return
  }

  const msgObj = {
    post_type: majorType
  }

  if (subType) {
    msgObj.sub_type = subType
  }

  switch (majorType) {
    case 'message':
      msgObj.message_type = minorType
      msgObj.raw_message = rawMessage || `${atMe ? `[CQ:at,qq=${t.context.bot._qq}]` : ''} test`
      break
    case 'notice':
      msgObj.notice_type = minorType
      break
    case 'request':
      msgObj.request_type = minorType
      break
    case 'meta_event':
      msgObj.meta_event_type = minorType
      break
    default:
      t.fail('Invalid major type')
      t.end()
      return
  }

  /**
   * @type {sinon.SinonSpy[]}
   */
  let spies = []
  for (let i = 0; i < arrEvent.length; i++) {
    const _spy = spy()
    spies.push(_spy)

    const prefix = i > 0 ? arrEvent[i - 1] + '.' : ''
    arrEvent[i] = prefix + arrEvent[i]
    t.context.bot.on(arrEvent[i], _spy)
  }

  if (atMe) {
    if (postfix === '.@.me') {
      const _spy1 = spy()
      const _spy2 = spy()
      spies.push(_spy1)
      spies.push(_spy2)
      t.context.bot.on(arrEvent[arrEvent.length - 1] + '.@', _spy1)
      t.context.bot.on(arrEvent[arrEvent.length - 1] + '.@.me', _spy2)
    } else {
      const _spy = spy()
      spies.push(_spy)
      t.context.bot.on(arrEvent[arrEvent.length - 1] + '.@me', _spy)
    }
  }

  t.plan(spies.length * (majorType === 'message' ? 4 : 3) - 1)

  // Assertion after root event has been emitted
  t.context.bot.on(arrEvent[0], function () {
    // 相關母子事件均被觸發過
    spies.forEach((_spy, i) => {
      t.true(_spy.calledOnce)
    })

    // 觸發參數
    if (majorType === 'message') {
      spies.forEach((_spy, i) => {
        if (_spy.firstCall === null) {
          // console.log(i)
        }
        t.true(_spy.firstCall.args[0] instanceof CQEvent)
        t.deepEqual(_spy.firstCall.args[1], msgObj)
      })
    } else {
      spies.forEach(_spy => {
        t.deepEqual(_spy.firstCall.args[0], msgObj)
      })
    }

    // 觸發順序
    spies.forEach((_spy, i) => {
      if (i < spies.length - 1) {
        t.true(_spy.calledAfter(spies[i + 1]))
      }
    })

    t.end()
  })

  emitEvent(t, msgObj)
}

test.beforeEach.cb(function (t) {
  t.context.bot = new CQWebsocket()
    .on('ready', function () {
      t.context.sock = t.context.bot._eventSock
      t.end()
    })
    .connect()
})

/**
 * @type {string[]}
 */
const eventlist = require('./events')
eventlist.forEach(function (event) {
  test.cb(`Event [${event}]`, macro, event)
})

const extraMsgEvents = [ 'message.discuss.@', 'message.group.@' ]
extraMsgEvents.forEach(function (event) {
  test.cb(`Event [${event}]: someone @-ed but not bot`, macro, event, { rawMessage: '[CQ:at,qq=987654321]' })
})

function invalidEventMacro (t, msgObj) {
  t.plan(2)

  const _spy = spy()
  t.context.bot
    .on('error', _spy)
    .on('error', (err) => {
      t.true(err instanceof Error)
      t.true(_spy.calledOnce)
      t.end()
    })

  emitEvent(t, msgObj)
}

test.cb(`Event [fake event]`, invalidEventMacro, {
  post_type: 'fake'
})

test.cb(`Event [invalid message]`, invalidEventMacro, {
  post_type: 'message',
  message_type: 'fake'
})

test.cb(`Event [invalid notice]`, invalidEventMacro, {
  post_type: 'notice',
  notice_type: 'fake'
})

test.cb(`Event [invalid notice:group_admin]`, invalidEventMacro, {
  post_type: 'notice',
  notice_type: 'group_admin'
})

test.cb(`Event [invalid notice:group_increase]`, invalidEventMacro, {
  post_type: 'notice',
  notice_type: 'group_increase'
})

test.cb(`Event [invalid notice:group_decrease]`, invalidEventMacro, {
  post_type: 'notice',
  notice_type: 'group_decrease'
})

test.cb(`Event [invalid request]`, invalidEventMacro, {
  post_type: 'request',
  request_type: 'fake'
})

test.cb(`Event [invalid request:group]`, invalidEventMacro, {
  post_type: 'request',
  request_type: 'group'
})

test.cb(`Event [invalid meta_event]`, invalidEventMacro, {
  post_type: 'meta_event',
  meta_event_type: 'fake'
})