upstream-hocuspocus/tests/server/beforeHandleMessage.ts

import test from 'ava'
import { newHocuspocus, newHocuspocusProvider } from '../utils/index.ts'
import { retryableAssertion } from '../utils/retryableAssertion.ts'

test('beforeHandleMessage gets called in proper order', async t => {
  await new Promise(async resolve => {
    const mockContext = {
      user: 123,
    }

    const expectedValuesByCallNumber = [
      undefined, // syncstep1
      undefined, // syncstep2
      'foo', // sync finished, value should be there now
    ]
    let callNumber = 0

    const server = await newHocuspocus(t, {
      async onConnect() {
        return mockContext
      },
      async beforeHandleMessage({ document, context }) {
        t.deepEqual(context, mockContext)

        const value = document.getArray('foo').get(0)

        t.is(value, expectedValuesByCallNumber[callNumber])
        callNumber += 1

        if (callNumber === expectedValuesByCallNumber.length - 1) {
          resolve('done')
        }
      },
      async onChange({ context, document }) {
        t.deepEqual(context, mockContext)

        const value = document.getArray('foo').get(0)

        t.is(value, expectedValuesByCallNumber[2])
      },
    })

    const provider = newHocuspocusProvider(t, server, {
      onSynced() {
        provider.document.getArray('foo').insert(0, ['bar'])
      },
    })
  })
})

test('beforeHandleMessage callback is called for every new client', async t => {
  let onConnectCount = 0
  let beforeHandleMessageCount = 0

  await new Promise(async resolve => {
    const server = await newHocuspocus(t, {
      async onConnect() {
        onConnectCount += 1
      },
      async beforeHandleMessage() {
        beforeHandleMessageCount += 1
      },
    })

    newHocuspocusProvider(t, server, {
      onClose() {
        t.fail()
      },
    })
    newHocuspocusProvider(t, server, {
      onClose() {
        t.fail()
      },
    })

    resolve('done')
  })

  await retryableAssertion(t, tt => {
    tt.is(onConnectCount, 2)
    tt.is(beforeHandleMessageCount, 6) // 2x awareness per conn, 2x sync per conn (step 1 + 2)
  })

})

test('an exception thrown in beforeHandleMessage closes the connection and discards queued messages', async t => {
  let beforeHandleMessageCount = 0

  await new Promise(async resolve => {
    const server = await newHocuspocus(t, {
      async beforeHandleMessage({ connection, update }) {
        beforeHandleMessageCount += 1

        if (beforeHandleMessageCount === 1) {
          connection.handleMessage(update)
        }

        throw new Error()
      },
    })

    newHocuspocusProvider(t, server, {
      onClose() {
        t.pass()
        resolve('done')
      },
    })
  })

  t.is(beforeHandleMessageCount, 1)
})