teletype-client-modified/test/router.test.js

I have modified the library developed by Atom to make it compatible with non-browser facility. I am using it only for experimentation purposes. I will remove this package post my experiment and raise a PR at Atom to finally merge this package so that this

require('./setup')
const assert = require('assert')
const deepEqual = require('deep-equal')
const {startTestServer} = require('@atom/teletype-server')
const condition = require('./helpers/condition')
const {buildPeerPool, clearPeerPools} = require('./helpers/peer-pools')
const buildStarNetwork = require('./helpers/build-star-network')
const Router = require('../lib/router')

suite('Router', () => {
  let server

  suiteSetup(async () => {
    server = await startTestServer()
  })

  suiteTeardown(() => {
    return server.stop()
  })

  setup(() => {
    return server.reset()
  })

  teardown(() => {
    clearPeerPools()
  })

  test('notifications', async () => {
    const hub = buildStarNetwork('some-network-id', await buildPeerPool('hub', server), {isHub: true})
    const spoke1 = buildStarNetwork('some-network-id', await buildPeerPool('spoke-1', server), {isHub: false})
    const spoke2 = buildStarNetwork('some-network-id', await buildPeerPool('spoke-2', server), {isHub: false})
    await spoke1.connectTo('hub')
    await spoke2.connectTo('hub')

    const hubRouter = new Router(hub)
    const spoke1Router = new Router(spoke1)
    const spoke2Router = new Router(spoke2)
    recordNotifications(hubRouter, ['channel-1'])
    recordNotifications(spoke1Router, ['channel-1', 'channel-2'])
    recordNotifications(spoke2Router, ['channel-1', 'channel-2'])

    hubRouter.notify({channelId: 'channel-2', body: 'from-hub'})
    spoke1Router.notify({channelId: 'channel-1', body: 'from-spoke-1'})
    spoke2Router.notify({channelId: 'channel-2', body: 'from-spoke-2'})

    await condition(() => deepEqual(hubRouter.testInbox, {
      'channel-1': [{senderId: 'spoke-1', body: 'from-spoke-1'}]
    }))
    await condition(() => deepEqual(spoke1Router.testInbox, {
      'channel-2': [
        {senderId: 'hub', body: 'from-hub'},
        {senderId: 'spoke-2', body: 'from-spoke-2'}
      ]
    }))
    await condition(() => deepEqual(spoke2Router.testInbox, {
      'channel-1': [{senderId: 'spoke-1', body: 'from-spoke-1'}],
      'channel-2': [{senderId: 'hub', body: 'from-hub'}]
    }))

    hubRouter.testInbox = []
    spoke1Router.testInbox = []
    spoke2Router.testInbox = []
    spoke2Router.notify({recipientId: 'spoke-1', channelId: 'channel-1', body: 'direct-notification-from-spoke-2'})

    await condition(() => deepEqual(spoke1Router.testInbox, {
      'channel-1': [{senderId: 'spoke-2', body: 'direct-notification-from-spoke-2'}]
    }))
    assert.deepEqual(hubRouter.testInbox, [])
    assert.deepEqual(spoke2Router.testInbox, [])
  })

  test('request/response', async () => {
    const hub = buildStarNetwork('some-network-id', await buildPeerPool('hub', server), {isHub: true})
    const spoke1 = buildStarNetwork('some-network-id', await buildPeerPool('spoke-1', server), {isHub: false})
    const spoke2 = buildStarNetwork('some-network-id', await buildPeerPool('spoke-2', server), {isHub: false})
    await spoke1.connectTo('hub')
    await spoke2.connectTo('hub')

    const spoke1Router = new Router(spoke1)
    const spoke2Router = new Router(spoke2)

    spoke2Router.onRequest('channel-1', ({senderId, requestId, body}) => {
      assert.equal(body.toString(), 'request from spoke 1 on channel 1')
      spoke2Router.respond({requestId, body: 'response from spoke 2 on channel 1'})
    })
    spoke2Router.onRequest('channel-2', ({senderId, requestId, body}) => {
      assert.equal(body.toString(), 'request from spoke 1 on channel 2')
      spoke2Router.respond({requestId, body: 'response from spoke 2 on channel 2'})
    })

    {
      const response = await spoke1Router.request({
        recipientId: 'spoke-2',
        channelId: 'channel-1',
        body: 'request from spoke 1 on channel 1'
      })
      assert(response.ok)
      assert.equal(response.body.toString(), 'response from spoke 2 on channel 1')
    }

    {
      const response = await spoke1Router.request({
        recipientId: 'spoke-2',
        channelId: 'channel-2',
        body: 'request from spoke 1 on channel 2'
      })
      assert(response.ok)
      assert.equal(response.body.toString(), 'response from spoke 2 on channel 2')
    }

    // Ensure requests to nonexistent routes receive a failure response.
    {
      const response = await spoke1Router.request({
        recipientId: 'spoke-2',
        channelId: 'nonexistent',
        body: 'request from spoke 1 on nonexistent channel'
      })
      assert(!response.ok)
      assert.equal(response.body.length, 0)
    }

    // Ensure requests and responses with no body are allowed
    {
      spoke2Router.onRequest('channel-3', ({senderId, requestId, body}) => {
        assert.equal(body.length, 0)
        spoke2Router.respond({requestId})
      })
      const response = await spoke1Router.request({recipientId: 'spoke-2', channelId: 'channel-3'})
      assert(response.ok)
      assert.equal(response.body.length, 0)
    }

    // Ensure that multiple responses are disallowed
    {
      spoke2Router.onRequest('channel-4', ({senderId, requestId, body}) => {
        spoke2Router.respond({requestId, body: 'response from spoke 2 on channel 4'})
        assert.throws(
          () => spoke2Router.respond({requestId, body: 'duplicate response'}),
          'Multiple responses to the same request are not allowed'
        )
      })

      await spoke1Router.request({
        recipientId: 'spoke-2',
        channelId: 'channel-4',
        body: 'request from spoke 1 on channel 3'
      })
    }
  })

  test('async notification and request handlers', async () => {
    const hub = buildStarNetwork('some-network-id', await buildPeerPool('hub', server), {isHub: true})
    const spoke = buildStarNetwork('some-network-id', await buildPeerPool('spoke', server), {isHub: false})
    await spoke.connectTo('hub')

    const hubRouter = new Router(hub)
    const spokeRouter = new Router(spoke)
    const spokeInbox = []

    spokeRouter.onNotification('notification-channel-1', async ({body}) => {
      await timeout(Math.random() * 50)
      spokeInbox.push(body.toString())
    })
    spokeRouter.onNotification('notification-channel-2', async ({body}) => {
      await timeout(Math.random() * 50)
      spokeInbox.push(body.toString())
    })
    spokeRouter.onRequest('request-channel-1', async ({body}) => {
      await timeout(Math.random() * 50)
      spokeInbox.push(body.toString())
    })
    spokeRouter.onRequest('request-channel-2', async ({body}) => {
      await timeout(Math.random() * 50)
      spokeInbox.push(body.toString())
    })

    hubRouter.notify({channelId: 'notification-channel-1', body: '1'})
    hubRouter.notify({channelId: 'notification-channel-2', body: '2'})
    hubRouter.request({recipientId: 'spoke', channelId: 'request-channel-1', body: '3'})
    hubRouter.request({recipientId: 'spoke', channelId: 'request-channel-2', body: '4'})

    await condition(() => deepEqual(spokeInbox, ['1', '2', '3', '4']))
  })
})

function recordNotifications (router, channelIds) {
  if (!router.testInbox) router.testInbox = {}
  channelIds.forEach((channelId) => {
    router.onNotification(channelId, ({senderId, body}) => {
      if (!router.testInbox[channelId]) router.testInbox[channelId] = []
      router.testInbox[channelId].push({
        senderId, body: body.toString()
      })
      router.testInbox[channelId].sort((a, b) => a.senderId.localeCompare(b.senderId))
    })
  })
}

function timeout (ms) {
  return new Promise((resolve) => setTimeout(resolve, ms))
}