@libp2p/interface-compliance-tests 3.0.7 → 4.0.0-5ffa7a74

package/src/pubsub/connection-handlers.ts

@@ -0,0 +1,413 @@
+import { start, stop } from '@libp2p/interface/startable'
+import { expect } from 'aegir/chai'
+import pDefer from 'p-defer'
+import { pEvent } from 'p-event'
+import pWaitFor from 'p-wait-for'
+import sinon from 'sinon'
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
+import { mockNetwork } from '../mocks/index.js'
+import { createComponents } from './utils.js'
+import type { PubSubArgs } from './index.js'
+import type { TestSetup } from '../index.js'
+import type { MockNetworkComponents } from '../mocks/index.js'
+import type { Message, PubSub } from '@libp2p/interface/pubsub'
+
+export default (common: TestSetup<PubSub, PubSubArgs>): void => {
+  describe('pubsub connection handlers', () => {
+    let psA: PubSub
+    let psB: PubSub
+    let componentsA: MockNetworkComponents
+    let componentsB: MockNetworkComponents
+
+    describe('nodes send state on connection', () => {
+      // Create pubsub nodes and connect them
+      beforeEach(async () => {
+        mockNetwork.reset()
+
+        componentsA = await createComponents()
+        componentsB = await createComponents()
+
+        psA = componentsA.pubsub = await common.setup({
+          components: componentsA,
+          init: {}
+        })
+
+        psB = componentsB.pubsub = await common.setup({
+          components: componentsB,
+          init: {}
+        })
+
+        // Start pubsub
+        await start(...Object.values(componentsA), ...Object.values(componentsB))
+
+        expect(psA.getPeers()).to.be.empty()
+        expect(psB.getPeers()).to.be.empty()
+
+        // Make subscriptions prior to nodes connected
+        psA.subscribe('Za')
+        psB.subscribe('Zb')
+
+        expect(psA.getPeers()).to.be.empty()
+        expect(psA.getTopics()).to.deep.equal(['Za'])
+        expect(psB.getPeers()).to.be.empty()
+        expect(psB.getTopics()).to.deep.equal(['Zb'])
+      })
+
+      afterEach(async () => {
+        sinon.restore()
+        await stop(...Object.values(componentsA), ...Object.values(componentsB))
+        await common.teardown()
+        mockNetwork.reset()
+      })
+
+      it('existing subscriptions are sent upon peer connection', async function () {
+        const subscriptionsChanged = Promise.all([
+          pEvent(psA, 'subscription-change'),
+          pEvent(psB, 'subscription-change')
+        ])
+
+        await componentsA.connectionManager.openConnection(componentsB.peerId)
+
+        await subscriptionsChanged
+
+        expect(psA.getPeers()).to.have.lengthOf(1)
+        expect(psB.getPeers()).to.have.lengthOf(1)
+
+        expect(psA.getTopics()).to.deep.equal(['Za'])
+        expect(psB.getTopics()).to.deep.equal(['Zb'])
+
+        expect(psA.getSubscribers('Zb').map(p => p.toString())).to.deep.equal([componentsB.peerId.toString()])
+        expect(psB.getSubscribers('Za').map(p => p.toString())).to.deep.equal([componentsA.peerId.toString()])
+      })
+    })
+
+    describe('pubsub started before connect', () => {
+      let psA: PubSub
+      let psB: PubSub
+      let componentsA: MockNetworkComponents
+      let componentsB: MockNetworkComponents
+
+      // Create pubsub nodes and start them
+      beforeEach(async () => {
+        mockNetwork.reset()
+        componentsA = await createComponents()
+        componentsB = await createComponents()
+
+        psA = componentsA.pubsub = await common.setup({
+          components: componentsA,
+          init: {}
+        })
+        psB = componentsB.pubsub = await common.setup({
+          components: componentsB,
+          init: {}
+        })
+
+        await start(...Object.values(componentsA), ...Object.values(componentsB))
+      })
+
+      afterEach(async () => {
+        sinon.restore()
+        await stop(...Object.values(componentsA), ...Object.values(componentsB))
+        await common.teardown()
+        mockNetwork.reset()
+      })
+
+      it('should get notified of connected peers on dial', async () => {
+        await componentsA.connectionManager.openConnection(componentsB.peerId)
+
+        return Promise.all([
+          pWaitFor(() => psA.getPeers().length === 1),
+          pWaitFor(() => psB.getPeers().length === 1)
+        ])
+      })
+
+      it('should receive pubsub messages', async () => {
+        const defer = pDefer()
+        const topic = 'test-topic'
+        const data = uint8ArrayFromString('hey!')
+
+        await componentsA.connectionManager.openConnection(componentsB.peerId)
+
+        let subscribedTopics = psA.getTopics()
+        expect(subscribedTopics).to.not.include(topic)
+
+        psA.subscribe(topic)
+        psA.addEventListener('message', (evt) => {
+          if (evt.detail.topic === topic) {
+            const msg = evt.detail
+            expect(msg.data).to.equalBytes(data)
+            defer.resolve()
+          }
+        })
+        psA.subscribe(topic)
+
+        subscribedTopics = psA.getTopics()
+        expect(subscribedTopics).to.include(topic)
+
+        // wait for psB to know about psA subscription
+        await pWaitFor(() => {
+          const subscribedPeers = psB.getSubscribers(topic)
+          return subscribedPeers.map(p => p.toString()).includes(componentsA.peerId.toString()) // eslint-disable-line max-nested-callbacks
+        })
+        await psB.publish(topic, data)
+
+        await defer.promise
+      })
+    })
+
+    describe('pubsub started after connect', () => {
+      let psA: PubSub
+      let psB: PubSub
+      let componentsA: MockNetworkComponents
+      let componentsB: MockNetworkComponents
+
+      // Create pubsub nodes
+      beforeEach(async () => {
+        mockNetwork.reset()
+        componentsA = await createComponents()
+        componentsB = await createComponents()
+
+        psA = componentsA.pubsub = await common.setup({
+          components: componentsA,
+          init: {}
+        })
+        psB = componentsB.pubsub = await common.setup({
+          components: componentsB,
+          init: {}
+        })
+      })
+
+      afterEach(async () => {
+        sinon.restore()
+        await stop(...Object.values(componentsA), ...Object.values(componentsB))
+        await common.teardown()
+        mockNetwork.reset()
+      })
+
+      it('should get notified of connected peers after starting', async () => {
+        await start(...Object.values(componentsA), ...Object.values(componentsB))
+
+        await componentsA.connectionManager.openConnection(componentsB.peerId)
+
+        return Promise.all([
+          pWaitFor(() => psA.getPeers().length === 1),
+          pWaitFor(() => psB.getPeers().length === 1)
+        ])
+      })
+
+      it('should receive pubsub messages', async () => {
+        const defer = pDefer()
+        const topic = 'test-topic'
+        const data = uint8ArrayFromString('hey!')
+
+        await start(...Object.values(componentsA), ...Object.values(componentsB))
+
+        await componentsA.connectionManager.openConnection(componentsB.peerId)
+
+        await Promise.all([
+          pWaitFor(() => psA.getPeers().length === 1),
+          pWaitFor(() => psB.getPeers().length === 1)
+        ])
+
+        let subscribedTopics = psA.getTopics()
+        expect(subscribedTopics).to.not.include(topic)
+
+        psA.subscribe(topic)
+        psA.addEventListener('message', (evt) => {
+          if (evt.detail.topic === topic) {
+            const msg = evt.detail
+            expect(msg.data).to.equalBytes(data)
+            defer.resolve()
+          }
+        })
+        psA.subscribe(topic)
+
+        subscribedTopics = psA.getTopics()
+        expect(subscribedTopics).to.include(topic)
+
+        // wait for psB to know about psA subscription
+        await pWaitFor(() => {
+          const subscribedPeers = psB.getSubscribers(topic)
+          return subscribedPeers.map(p => p.toString()).includes(componentsA.peerId.toString()) // eslint-disable-line max-nested-callbacks
+        })
+        await psB.publish(topic, data)
+
+        await defer.promise
+      })
+    })
+
+    describe('pubsub with intermittent connections', () => {
+      let psA: PubSub
+      let psB: PubSub
+      let componentsA: MockNetworkComponents
+      let componentsB: MockNetworkComponents
+
+      // Create pubsub nodes and start them
+      beforeEach(async () => {
+        mockNetwork.reset()
+        componentsA = await createComponents()
+        componentsB = await createComponents()
+
+        psA = componentsA.pubsub = await common.setup({
+          components: componentsA,
+          init: {}
+        })
+        psB = componentsB.pubsub = await common.setup({
+          components: componentsB,
+          init: {}
+        })
+
+        await start(...Object.values(componentsA), ...Object.values(componentsB))
+      })
+
+      afterEach(async () => {
+        sinon.restore()
+        await stop(...Object.values(componentsA), ...Object.values(componentsB))
+        await common.teardown()
+        mockNetwork.reset()
+      })
+
+      it.skip('should receive pubsub messages after a node restart', async function () {
+        const topic = 'test-topic'
+        const data = uint8ArrayFromString('hey!')
+
+        let counter = 0
+        const defer1 = pDefer()
+        const defer2 = pDefer()
+
+        await componentsA.connectionManager.openConnection(componentsB.peerId)
+
+        let subscribedTopics = psA.getTopics()
+        expect(subscribedTopics).to.not.include(topic)
+
+        psA.subscribe(topic)
+        psA.addEventListener('message', (evt) => {
+          if (evt.detail.topic === topic) {
+            const msg = evt.detail
+            expect(msg.data).to.equalBytes(data)
+            counter++
+            counter === 1 ? defer1.resolve() : defer2.resolve()
+          }
+        })
+        psA.subscribe(topic)
+
+        subscribedTopics = psA.getTopics()
+        expect(subscribedTopics).to.include(topic)
+
+        // wait for psB to know about psA subscription
+        await pWaitFor(() => {
+          const subscribedPeers = psB.getSubscribers(topic)
+          return subscribedPeers.map(p => p.toString()).includes(componentsA.peerId.toString()) // eslint-disable-line max-nested-callbacks
+        })
+        await psB.publish(topic, data)
+
+        await defer1.promise
+
+        await stop(psB)
+        await pWaitFor(() => {
+          // @ts-expect-error protected fields
+          const aHasConnectionToB = psA._libp2p.connectionManager.get(psB.peerId)
+          // @ts-expect-error protected fields
+          const bHasConnectionToA = psB._libp2p.connectionManager.get(psA.peerId)
+
+          return aHasConnectionToB != null && bHasConnectionToA != null
+        })
+        await start(psB)
+
+        await componentsA.connectionManager.openConnection(componentsB.peerId)
+
+        // wait for remoteLibp2p to know about libp2p subscription
+        await pWaitFor(() => {
+          const subscribedPeers = psB.getSubscribers(topic)
+          return subscribedPeers.toString().includes(componentsA.peerId.toString())
+        })
+
+        await psB.publish(topic, data)
+
+        await defer2.promise
+      })
+
+      it.skip('should handle quick reconnects with a delayed disconnect', async () => {
+        // Subscribe on both
+        let aReceivedFirstMessageFromB = false
+        let aReceivedSecondMessageFromB = false
+        let bReceivedFirstMessageFromA = false
+        let bReceivedSecondMessageFromA = false
+        const topic = 'reconnect-channel'
+
+        const handlerSpyA = (evt: CustomEvent<Message>): void => {
+          if (evt.detail.topic !== topic) {
+            return
+          }
+
+          const message = evt.detail
+          const data = uint8ArrayToString(message.data)
+
+          if (data === 'message-from-b-1') {
+            aReceivedFirstMessageFromB = true
+          }
+
+          if (data === 'message-from-b-2') {
+            aReceivedSecondMessageFromB = true
+          }
+        }
+        const handlerSpyB = (evt: CustomEvent<Message>): void => {
+          if (evt.detail.topic !== topic) {
+            return
+          }
+
+          const message = evt.detail
+          const data = uint8ArrayToString(message.data)
+
+          if (data === 'message-from-a-1') {
+            bReceivedFirstMessageFromA = true
+          }
+
+          if (data === 'message-from-a-2') {
+            bReceivedSecondMessageFromA = true
+          }
+        }
+
+        psA.addEventListener('message', handlerSpyA)
+        psB.addEventListener('message', handlerSpyB)
+        psA.subscribe(topic)
+        psB.subscribe(topic)
+
+        // Create two connections to the remote peer
+        // @ts-expect-error protected fields
+        const originalConnection = await psA._libp2p.dialer.connectToPeer(psB.peerId)
+
+        // second connection
+        await componentsA.connectionManager.openConnection(componentsB.peerId)
+
+        // Wait for subscriptions to occur
+        await pWaitFor(() => {
+          return psA.getSubscribers(topic).map(p => p.toString()).includes(componentsB.peerId.toString()) &&
+            psB.getSubscribers(topic).map(p => p.toString()).includes(componentsA.peerId.toString())
+        })
+
+        // Verify messages go both ways
+        await psA.publish(topic, uint8ArrayFromString('message-from-a-1'))
+        await psB.publish(topic, uint8ArrayFromString('message-from-b-1'))
+        await pWaitFor(() => {
+          return aReceivedFirstMessageFromB && bReceivedFirstMessageFromA
+        })
+
+        // Disconnect the first connection (this acts as a delayed reconnect)
+        // @ts-expect-error protected fields
+        const psAConnUpdateSpy = sinon.spy(psA._libp2p.connectionManager.connections, 'set')
+
+        await originalConnection.close()
+        await pWaitFor(() => psAConnUpdateSpy.callCount === 1)
+
+        // Verify messages go both ways after the disconnect
+        await psA.publish(topic, uint8ArrayFromString('message-from-a-2'))
+        await psB.publish(topic, uint8ArrayFromString('message-from-b-2'))
+        await pWaitFor(() => {
+          return aReceivedSecondMessageFromB && bReceivedSecondMessageFromA
+        })
+      })
+    })
+  })
+}

package/src/pubsub/emit-self.ts

@@ -0,0 +1,99 @@
+import { start, stop } from '@libp2p/interface/startable'
+import { expect } from 'aegir/chai'
+import sinon from 'sinon'
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
+import { mockNetwork } from '../mocks/index.js'
+import { createComponents } from './utils.js'
+import type { PubSubArgs, PubSubComponents } from './index.js'
+import type { TestSetup } from '../index.js'
+import type { PubSub } from '@libp2p/interface/pubsub'
+
+const topic = 'foo'
+const data = uint8ArrayFromString('bar')
+const shouldNotHappen = (): void => expect.fail()
+
+export default (common: TestSetup<PubSub, PubSubArgs>): void => {
+  describe('emit self', () => {
+    describe('enabled', () => {
+      let pubsub: PubSub
+      let components: PubSubComponents
+
+      before(async () => {
+        mockNetwork.reset()
+        components = await createComponents()
+
+        pubsub = components.pubsub = await common.setup({
+          components,
+          init: {
+            emitSelf: true
+          }
+        })
+
+        await start(...Object.values(components))
+        pubsub.subscribe(topic)
+      })
+
+      after(async () => {
+        sinon.restore()
+        await stop(...Object.values(components))
+        await common.teardown()
+        mockNetwork.reset()
+      })
+
+      it('should emit to self on publish', async () => {
+        const promise = new Promise<void>((resolve) => {
+          pubsub.addEventListener('message', (evt) => {
+            if (evt.detail.topic === topic) {
+              resolve()
+            }
+          }, {
+            once: true
+          })
+        })
+
+        const result = await pubsub.publish(topic, data)
+
+        await promise
+
+        expect(result).to.have.property('recipients').with.lengthOf(1)
+      })
+    })
+
+    describe('disabled', () => {
+      let pubsub: PubSub
+      let components: PubSubComponents
+
+      before(async () => {
+        mockNetwork.reset()
+        components = await createComponents()
+        pubsub = components.pubsub = await common.setup({
+          components,
+          init: {
+            emitSelf: false
+          }
+        })
+
+        await start(...Object.values(components))
+        pubsub.subscribe(topic)
+      })
+
+      after(async () => {
+        sinon.restore()
+        await stop(...Object.values(components))
+        await common.teardown()
+        mockNetwork.reset()
+      })
+
+      it('should not emit to self on publish', async () => {
+        pubsub.addEventListener('message', shouldNotHappen, {
+          once: true
+        })
+
+        await pubsub.publish(topic, data)
+
+        // Wait 1 second to guarantee that self is not noticed
+        await new Promise((resolve) => setTimeout(resolve, 1000))
+      })
+    })
+  })
+}

package/src/pubsub/index.ts

@@ -0,0 +1,34 @@
+import apiTest from './api.js'
+import connectionHandlersTest from './connection-handlers.js'
+import emitSelfTest from './emit-self.js'
+import messagesTest from './messages.js'
+import multipleNodesTest from './multiple-nodes.js'
+import twoNodesTest from './two-nodes.js'
+import type { TestSetup } from '../index.js'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { PubSub, PubSubInit } from '@libp2p/interface/pubsub'
+import type { ConnectionManager } from '@libp2p/interface-internal/connection-manager'
+import type { Registrar } from '@libp2p/interface-internal/registrar'
+
+export interface PubSubComponents {
+  peerId: PeerId
+  registrar: Registrar
+  connectionManager: ConnectionManager
+  pubsub?: PubSub
+}
+
+export interface PubSubArgs {
+  components: PubSubComponents
+  init: PubSubInit
+}
+
+export default (common: TestSetup<PubSub, PubSubArgs>): void => {
+  describe('interface-pubsub compliance tests', () => {
+    apiTest(common)
+    emitSelfTest(common)
+    messagesTest(common)
+    connectionHandlersTest(common)
+    twoNodesTest(common)
+    multipleNodesTest(common)
+  })
+}

package/src/pubsub/messages.ts

@@ -0,0 +1,59 @@
+import { start, stop } from '@libp2p/interface/startable'
+import { expect } from 'aegir/chai'
+import { pEvent } from 'p-event'
+import sinon from 'sinon'
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
+import { mockNetwork } from '../mocks/index.js'
+import { createComponents } from './utils.js'
+import type { PubSubArgs, PubSubComponents } from './index.js'
+import type { TestSetup } from '../index.js'
+import type { Message, PubSub } from '@libp2p/interface/pubsub'
+
+const topic = 'foo'
+const data = uint8ArrayFromString('bar')
+
+export default (common: TestSetup<PubSub, PubSubArgs>): void => {
+  describe('messages', () => {
+    let pubsub: PubSub
+    let components: PubSubComponents
+
+    // Create pubsub router
+    beforeEach(async () => {
+      mockNetwork.reset()
+      components = await createComponents()
+
+      pubsub = components.pubsub = await common.setup({
+        components,
+        init: {
+          emitSelf: true
+        }
+      })
+      await start(...Object.values(components))
+    })
+
+    afterEach(async () => {
+      sinon.restore()
+      await stop(...Object.values(components))
+      await common.teardown()
+      mockNetwork.reset()
+    })
+
+    it('should emit normalized signed messages on publish', async () => {
+      const eventPromise = pEvent<'message', CustomEvent<Message>>(pubsub, 'message')
+
+      pubsub.globalSignaturePolicy = 'StrictSign'
+      pubsub.subscribe(topic)
+      await pubsub.publish(topic, data)
+
+      const event = await eventPromise
+      const message = event.detail
+
+      if (message.type === 'signed') {
+        expect(message.from.toString()).to.equal(components.peerId.toString())
+        expect(message.sequenceNumber).to.not.eql(undefined)
+        expect(message.key).to.not.eql(undefined)
+        expect(message.signature).to.not.eql(undefined)
+      }
+    })
+  })
+}