feat: interface pubsub (#60)

* feat: interface pubsub * chore: pubsub router tests * chore: move pubsub abstractions from gossipsub * chore: address review * chore: revamp docs * chore: add emit self tests to interface * chore: refactor base tests * chore: publish should only accept one topic per api call * chore: normalize msg before emit * chore: do not reset inbound stream * chore: apply suggestions from code review Co-authored-by: Jacob Heun <jacobheun@gmail.com> * chore: address review * fix: remove subscribe handler * chore: remove bits from create peerId Co-authored-by: Jacob Heun <jacobheun@gmail.com> * chore: remove delay from topic validators tests * chore: add event emitter information * fix: topic validator docs Co-authored-by: Jacob Heun <jacobheun@gmail.com>
2025-06-17 02:41:41 +00:00 · 2020-08-25 13:05:58 +02:00
parent c4be5eed4b
commit ba15a48dd9
26 changed files with 3377 additions and 0 deletions
--- a/test/pubsub/topic-validators.spec.js
+++ b/test/pubsub/topic-validators.spec.js
@ -0,0 +1,110 @@
+/* eslint-env mocha */
+'use strict'
+
+const { expect } = require('aegir/utils/chai')
+const sinon = require('sinon')
+const pWaitFor = require('p-wait-for')
+const errCode = require('err-code')
+
+const PeerId = require('peer-id')
+const uint8ArrayEquals = require('uint8arrays/equals')
+const uint8ArrayFromString = require('uint8arrays/from-string')
+
+const { utils } = require('../../src/pubsub')
+const PeerStreams = require('../../src/pubsub/peer-streams')
+
+const {
+  createPeerId,
+  mockRegistrar,
+  PubsubImplementation
+} = require('./utils')
+
+const protocol = '/pubsub/1.0.0'
+
+describe('topic validators', () => {
+  let pubsub
+
+  beforeEach(async () => {
+    const peerId = await createPeerId()
+
+    pubsub = new PubsubImplementation(protocol, {
+      peerId: peerId,
+      registrar: mockRegistrar
+    })
+
+    pubsub.start()
+  })
+
+  afterEach(() => {
+    sinon.restore()
+  })
+
+  it('should filter messages by topic validator', async () => {
+    // use _publish.callCount() to see if a message is valid or not
+    sinon.spy(pubsub, '_publish')
+    // Disable strict signing
+    sinon.stub(pubsub, 'strictSigning').value(false)
+    sinon.stub(pubsub.peers, 'get').returns({})
+    const filteredTopic = 't'
+    const peer = new PeerStreams({ id: await PeerId.create() })
+
+    // Set a trivial topic validator
+    pubsub.topicValidators.set(filteredTopic, (topic, message) => {
+      if (!uint8ArrayEquals(message.data, uint8ArrayFromString('a message'))) {
+        throw errCode(new Error(), 'ERR_TOPIC_VALIDATOR_REJECT')
+      }
+    })
+
+    // valid case
+    const validRpc = {
+      subscriptions: [],
+      msgs: [{
+        from: peer.id.toBytes(),
+        data: uint8ArrayFromString('a message'),
+        seqno: utils.randomSeqno(),
+        topicIDs: [filteredTopic]
+      }]
+    }
+
+    // process valid message
+    pubsub.subscribe(filteredTopic)
+    pubsub._processRpc(peer.id.toB58String(), peer, validRpc)
+
+    await pWaitFor(() => pubsub._publish.callCount === 1)
+
+    // invalid case
+    const invalidRpc = {
+      subscriptions: [],
+      msgs: [{
+        from: peer.id.toBytes(),
+        data: uint8ArrayFromString('a different message'),
+        seqno: utils.randomSeqno(),
+        topicIDs: [filteredTopic]
+      }]
+    }
+
+    // process invalid message
+    pubsub._processRpc(peer.id.toB58String(), peer, invalidRpc)
+    expect(pubsub._publish.callCount).to.eql(1)
+
+    // remove topic validator
+    pubsub.topicValidators.delete(filteredTopic)
+
+    // another invalid case
+    const invalidRpc2 = {
+      subscriptions: [],
+      msgs: [{
+        from: peer.id.toB58String(),
+        data: uint8ArrayFromString('a different message'),
+        seqno: utils.randomSeqno(),
+        topicIDs: [filteredTopic]
+      }]
+    }
+
+    // process previously invalid message, now is valid
+    pubsub._processRpc(peer.id.toB58String(), peer, invalidRpc2)
+    pubsub.unsubscribe(filteredTopic)
+
+    await pWaitFor(() => pubsub._publish.callCount === 2)
+  })
+})