@libp2p/interface-compliance-tests 3.0.7 → 4.0.0

package/src/mocks/muxer.ts

@@ -0,0 +1,303 @@
+import { AbstractStream, type AbstractStreamInit } from '@libp2p/interface/stream-muxer/stream'
+import { type Logger, logger } from '@libp2p/logger'
+import { abortableSource } from 'abortable-iterator'
+import map from 'it-map'
+import * as ndjson from 'it-ndjson'
+import { pipe } from 'it-pipe'
+import { type Pushable, pushable } from 'it-pushable'
+import { Uint8ArrayList } from 'uint8arraylist'
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
+import type { AbortOptions } from '@libp2p/interface'
+import type { Direction, Stream } from '@libp2p/interface/connection'
+import type { StreamMuxer, StreamMuxerFactory, StreamMuxerInit } from '@libp2p/interface/stream-muxer'
+import type { Source } from 'it-stream-types'
+
+let muxers = 0
+let streams = 0
+
+interface DataMessage {
+  id: string
+  type: 'data'
+  direction: Direction
+  chunk: string
+}
+
+interface ResetMessage {
+  id: string
+  type: 'reset'
+  direction: Direction
+}
+
+interface CloseMessage {
+  id: string
+  type: 'close'
+  direction: Direction
+}
+
+interface CreateMessage {
+  id: string
+  type: 'create'
+  direction: 'outbound'
+}
+
+type StreamMessage = DataMessage | ResetMessage | CloseMessage | CreateMessage
+
+export interface MockMuxedStreamInit extends AbstractStreamInit {
+  push: Pushable<StreamMessage>
+}
+
+class MuxedStream extends AbstractStream {
+  private readonly push: Pushable<StreamMessage>
+
+  constructor (init: MockMuxedStreamInit) {
+    super(init)
+
+    this.push = init.push
+  }
+
+  sendNewStream (): void {
+    // If initiator, open a new stream
+    const createMsg: CreateMessage = {
+      id: this.id,
+      type: 'create',
+      direction: 'outbound'
+    }
+    this.push.push(createMsg)
+  }
+
+  sendData (data: Uint8ArrayList): void {
+    const dataMsg: DataMessage = {
+      id: this.id,
+      type: 'data',
+      chunk: uint8ArrayToString(data.subarray(), 'base64pad'),
+      direction: this.direction
+    }
+    this.push.push(dataMsg)
+  }
+
+  sendReset (): void {
+    const resetMsg: ResetMessage = {
+      id: this.id,
+      type: 'reset',
+      direction: this.direction
+    }
+    this.push.push(resetMsg)
+  }
+
+  sendCloseWrite (): void {
+    const closeMsg: CloseMessage = {
+      id: this.id,
+      type: 'close',
+      direction: this.direction
+    }
+    this.push.push(closeMsg)
+  }
+
+  sendCloseRead (): void {
+    // does not support close read, only close write
+  }
+}
+
+class MockMuxer implements StreamMuxer {
+  public source: AsyncGenerator<Uint8Array>
+  public input: Pushable<Uint8Array>
+  public streamInput: Pushable<StreamMessage>
+  public name: string
+  public protocol: string = '/mock-muxer/1.0.0'
+
+  private readonly closeController: AbortController
+  private readonly registryInitiatorStreams: Map<string, MuxedStream>
+  private readonly registryRecipientStreams: Map<string, MuxedStream>
+  private readonly options: StreamMuxerInit
+
+  private readonly log: Logger
+
+  constructor (init?: StreamMuxerInit) {
+    this.name = `muxer:${muxers++}`
+    this.log = logger(`libp2p:mock-muxer:${this.name}`)
+    this.registryInitiatorStreams = new Map()
+    this.registryRecipientStreams = new Map()
+    this.log('create muxer')
+    this.options = init ?? { direction: 'inbound' }
+    this.closeController = new AbortController()
+    // receives data from the muxer at the other end of the stream
+    this.source = this.input = pushable({
+      onEnd: () => {
+        for (const stream of this.registryInitiatorStreams.values()) {
+          stream.destroy()
+        }
+
+        for (const stream of this.registryRecipientStreams.values()) {
+          stream.destroy()
+        }
+      }
+    })
+
+    // receives messages from all of the muxed streams
+    this.streamInput = pushable<StreamMessage>({
+      objectMode: true
+    })
+  }
+
+  // receive incoming messages
+  async sink (source: Source<Uint8ArrayList | Uint8Array>): Promise<void> {
+    try {
+      await pipe(
+        abortableSource(source, this.closeController.signal),
+        (source) => map(source, buf => uint8ArrayToString(buf.subarray())),
+        ndjson.parse<StreamMessage>,
+        async (source) => {
+          for await (const message of source) {
+            this.log.trace('-> %s %s %s', message.type, message.direction, message.id)
+            this.handleMessage(message)
+          }
+        }
+      )
+
+      this.log('muxed stream ended')
+      this.input.end()
+    } catch (err: any) {
+      this.log('muxed stream errored', err)
+      this.input.end(err)
+    }
+  }
+
+  handleMessage (message: StreamMessage): void {
+    let muxedStream: MuxedStream | undefined
+
+    const registry = message.direction === 'outbound' ? this.registryRecipientStreams : this.registryInitiatorStreams
+
+    if (message.type === 'create') {
+      if (registry.has(message.id)) {
+        throw new Error(`Already had stream for ${message.id}`)
+      }
+
+      muxedStream = this.createStream(message.id, 'inbound')
+      registry.set(muxedStream.id, muxedStream)
+
+      if (this.options.onIncomingStream != null) {
+        this.options.onIncomingStream(muxedStream)
+      }
+    }
+
+    muxedStream = registry.get(message.id)
+
+    if (muxedStream == null) {
+      this.log.error(`No stream found for ${message.id}`)
+
+      return
+    }
+
+    if (message.type === 'data') {
+      muxedStream.sourcePush(new Uint8ArrayList(uint8ArrayFromString(message.chunk, 'base64pad')))
+    } else if (message.type === 'reset') {
+      this.log('-> reset stream %s %s', muxedStream.direction, muxedStream.id)
+      muxedStream.reset()
+    } else if (message.type === 'close') {
+      this.log('-> closing stream %s %s', muxedStream.direction, muxedStream.id)
+      muxedStream.remoteCloseWrite()
+    }
+  }
+
+  get streams (): Stream[] {
+    return Array.from(this.registryRecipientStreams.values())
+      .concat(Array.from(this.registryInitiatorStreams.values()))
+  }
+
+  newStream (name?: string): Stream {
+    if (this.closeController.signal.aborted) {
+      throw new Error('Muxer already closed')
+    }
+    this.log('newStream %s', name)
+    const storedStream = this.createStream(name, 'outbound')
+    this.registryInitiatorStreams.set(storedStream.id, storedStream)
+
+    return storedStream
+  }
+
+  createStream (name?: string, direction: Direction = 'outbound'): MuxedStream {
+    const id = name ?? `${streams++}`
+
+    this.log('createStream %s %s', direction, id)
+
+    const muxedStream: MuxedStream = new MuxedStream({
+      id,
+      direction,
+      push: this.streamInput,
+      onEnd: () => {
+        this.log('stream ended')
+
+        if (direction === 'outbound') {
+          this.registryInitiatorStreams.delete(muxedStream.id)
+        } else {
+          this.registryRecipientStreams.delete(muxedStream.id)
+        }
+
+        if (this.options.onStreamEnd != null) {
+          this.options.onStreamEnd(muxedStream)
+        }
+      },
+      log: logger(`libp2p:mock-muxer:stream:${direction}:${id}`)
+    })
+
+    return muxedStream
+  }
+
+  async close (options?: AbortOptions): Promise<void> {
+    if (this.closeController.signal.aborted) {
+      return
+    }
+
+    this.log('closing muxed streams')
+
+    await Promise.all(
+      this.streams.map(async s => s.close())
+    )
+
+    this.closeController.abort()
+    this.input.end()
+  }
+
+  abort (err: Error): void {
+    if (this.closeController.signal.aborted) {
+      return
+    }
+
+    this.log('aborting muxed streams')
+
+    this.streams.forEach(s => {
+      s.abort(err)
+    })
+
+    this.closeController.abort(err)
+    this.input.end(err)
+  }
+}
+
+class MockMuxerFactory implements StreamMuxerFactory {
+  public protocol: string = '/mock-muxer/1.0.0'
+
+  createStreamMuxer (init?: StreamMuxerInit): StreamMuxer {
+    const mockMuxer = new MockMuxer(init)
+
+    void Promise.resolve().then(async () => {
+      void pipe(
+        mockMuxer.streamInput,
+        ndjson.stringify,
+        (source) => map(source, str => new Uint8ArrayList(uint8ArrayFromString(str))),
+        async (source) => {
+          for await (const buf of source) {
+            mockMuxer.input.push(buf.subarray())
+          }
+        }
+      )
+    })
+
+    return mockMuxer
+  }
+}
+
+export function mockMuxer (): MockMuxerFactory {
+  return new MockMuxerFactory()
+}

package/src/mocks/peer-discovery.ts

@@ -0,0 +1,60 @@
+import { EventEmitter } from '@libp2p/interface/events'
+import { peerDiscovery } from '@libp2p/interface/peer-discovery'
+import * as PeerIdFactory from '@libp2p/peer-id-factory'
+import { multiaddr } from '@multiformats/multiaddr'
+import type { PeerDiscovery, PeerDiscoveryEvents } from '@libp2p/interface/peer-discovery'
+import type { PeerInfo } from '@libp2p/interface/peer-info'
+
+interface MockDiscoveryInit {
+  discoveryDelay?: number
+}
+
+/**
+ * Emits 'peer' events on discovery.
+ */
+export class MockDiscovery extends EventEmitter<PeerDiscoveryEvents> implements PeerDiscovery {
+  public readonly options: MockDiscoveryInit
+  private _isRunning: boolean
+  private _timer: any
+
+  constructor (init = {}) {
+    super()
+
+    this.options = init
+    this._isRunning = false
+  }
+
+  readonly [peerDiscovery] = this
+
+  start (): void {
+    this._isRunning = true
+    this._discoverPeer()
+  }
+
+  stop (): void {
+    clearTimeout(this._timer)
+    this._isRunning = false
+  }
+
+  isStarted (): boolean {
+    return this._isRunning
+  }
+
+  _discoverPeer (): void {
+    if (!this._isRunning) return
+
+    PeerIdFactory.createEd25519PeerId()
+      .then(peerId => {
+        this._timer = setTimeout(() => {
+          this.safeDispatchEvent<PeerInfo>('peer', {
+            detail: {
+              id: peerId,
+              multiaddrs: [multiaddr('/ip4/127.0.0.1/tcp/8000')],
+              protocols: []
+            }
+          })
+        }, this.options.discoveryDelay ?? 1000)
+      })
+      .catch(() => {})
+  }
+}

package/src/mocks/registrar.ts

@@ -0,0 +1,88 @@
+import merge from 'merge-options'
+import type { Connection } from '@libp2p/interface/connection'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { Topology } from '@libp2p/interface/topology'
+import type { IncomingStreamData, Registrar, StreamHandler, StreamHandlerOptions, StreamHandlerRecord } from '@libp2p/interface-internal/registrar'
+
+export class MockRegistrar implements Registrar {
+  private readonly topologies = new Map<string, Array<{ id: string, topology: Topology }>>()
+  private readonly handlers = new Map<string, StreamHandlerRecord>()
+
+  getProtocols (): string[] {
+    return Array.from(this.handlers.keys()).sort()
+  }
+
+  async handle (protocol: string, handler: StreamHandler, opts?: StreamHandlerOptions): Promise<void> {
+    const options = merge.bind({ ignoreUndefined: true })({
+      maxInboundStreams: 1,
+      maxOutboundStreams: 1
+    }, opts)
+
+    if (this.handlers.has(protocol)) {
+      throw new Error(`Handler already registered for protocol ${protocol}`)
+    }
+
+    this.handlers.set(protocol, {
+      handler,
+      options
+    })
+  }
+
+  async unhandle (protocol: string): Promise<void> {
+    this.handlers.delete(protocol)
+  }
+
+  getHandler (protocol: string): StreamHandlerRecord {
+    const handler = this.handlers.get(protocol)
+
+    if (handler == null) {
+      throw new Error(`No handler registered for protocol ${protocol}`)
+    }
+
+    return handler
+  }
+
+  async register (protocol: string, topology: Topology): Promise<string> {
+    const id = `topology-id-${Math.random()}`
+    let topologies = this.topologies.get(protocol)
+
+    if (topologies == null) {
+      topologies = []
+    }
+
+    topologies.push({
+      id,
+      topology
+    })
+
+    this.topologies.set(protocol, topologies)
+
+    return id
+  }
+
+  unregister (id: string | string[]): void {
+    if (!Array.isArray(id)) {
+      id = [id]
+    }
+
+    id.forEach(id => this.topologies.delete(id))
+  }
+
+  getTopologies (protocol: string): Topology[] {
+    return (this.topologies.get(protocol) ?? []).map(t => t.topology)
+  }
+}
+
+export function mockRegistrar (): Registrar {
+  return new MockRegistrar()
+}
+
+export async function mockIncomingStreamEvent (protocol: string, conn: Connection, remotePeer: PeerId): Promise<IncomingStreamData> {
+  return {
+    ...await conn.newStream([protocol]),
+    // @ts-expect-error incomplete implementation
+    connection: {
+      remotePeer
+    }
+  }
+}

package/src/mocks/upgrader.ts

@@ -0,0 +1,49 @@
+import { mockConnection } from './connection.js'
+import type { Libp2pEvents } from '@libp2p/interface'
+import type { Connection, MultiaddrConnection } from '@libp2p/interface/connection'
+import type { EventEmitter } from '@libp2p/interface/events'
+import type { Upgrader, UpgraderOptions } from '@libp2p/interface/transport'
+import type { Registrar } from '@libp2p/interface-internal/registrar'
+
+export interface MockUpgraderInit {
+  registrar?: Registrar
+  events?: EventEmitter<Libp2pEvents>
+}
+
+class MockUpgrader implements Upgrader {
+  private readonly registrar?: Registrar
+  private readonly events?: EventEmitter<Libp2pEvents>
+
+  constructor (init: MockUpgraderInit) {
+    this.registrar = init.registrar
+    this.events = init.events
+  }
+
+  async upgradeOutbound (multiaddrConnection: MultiaddrConnection, opts: UpgraderOptions = {}): Promise<Connection> {
+    const connection = mockConnection(multiaddrConnection, {
+      direction: 'outbound',
+      registrar: this.registrar,
+      ...opts
+    })
+
+    this.events?.safeDispatchEvent('connection:open', { detail: connection })
+
+    return connection
+  }
+
+  async upgradeInbound (multiaddrConnection: MultiaddrConnection, opts: UpgraderOptions = {}): Promise<Connection> {
+    const connection = mockConnection(multiaddrConnection, {
+      direction: 'inbound',
+      registrar: this.registrar,
+      ...opts
+    })
+
+    this.events?.safeDispatchEvent('connection:open', { detail: connection })
+
+    return connection
+  }
+}
+
+export function mockUpgrader (init: MockUpgraderInit = {}): Upgrader {
+  return new MockUpgrader(init)
+}

package/src/peer-discovery/index.ts

@@ -0,0 +1,90 @@
+import { start, stop } from '@libp2p/interface/startable'
+import { isMultiaddr } from '@multiformats/multiaddr'
+import { expect } from 'aegir/chai'
+import delay from 'delay'
+import pDefer from 'p-defer'
+import type { TestSetup } from '../index.js'
+import type { PeerDiscovery } from '@libp2p/interface/peer-discovery'
+
+export default (common: TestSetup<PeerDiscovery>): void => {
+  describe('interface-peer-discovery compliance tests', () => {
+    let discovery: PeerDiscovery
+
+    beforeEach(async () => {
+      discovery = await common.setup()
+    })
+
+    afterEach('ensure discovery was stopped', async () => {
+      await stop(discovery)
+
+      await common.teardown()
+    })
+
+    it('can start the service', async () => {
+      await start(discovery)
+    })
+
+    it('can start and stop the service', async () => {
+      await start(discovery)
+      await stop(discovery)
+    })
+
+    it('should not fail to stop the service if it was not started', async () => {
+      await stop(discovery)
+    })
+
+    it('should not fail to start the service if it is already started', async () => {
+      await start(discovery)
+      await start(discovery)
+    })
+
+    it('should emit a peer event after start', async () => {
+      const defer = pDefer()
+
+      discovery.addEventListener('peer', (evt) => {
+        const { id, multiaddrs } = evt.detail
+        expect(id).to.exist()
+        expect(id)
+          .to.have.property('type')
+          .that.is.oneOf(['RSA', 'Ed25519', 'secp256k1'])
+        expect(multiaddrs).to.exist()
+
+        multiaddrs.forEach((m) => expect(isMultiaddr(m)).to.eql(true))
+
+        defer.resolve()
+      })
+
+      await start(discovery)
+
+      await defer.promise
+    })
+
+    it('should not receive a peer event before start', async () => {
+      discovery.addEventListener('peer', () => {
+        throw new Error('should not receive a peer event before start')
+      })
+
+      await delay(2000)
+    })
+
+    it('should not receive a peer event after stop', async () => {
+      const deferStart = pDefer()
+
+      discovery.addEventListener('peer', () => {
+        deferStart.resolve()
+      })
+
+      await start(discovery)
+
+      await deferStart.promise
+
+      await stop(discovery)
+
+      discovery.addEventListener('peer', () => {
+        throw new Error('should not receive a peer event after stop')
+      })
+
+      await delay(2000)
+    })
+  })
+}

package/src/pubsub/api.ts

@@ -0,0 +1,114 @@
+import { isStartable, start, stop } from '@libp2p/interface/startable'
+import { expect } from 'aegir/chai'
+import delay from 'delay'
+import pDefer from 'p-defer'
+import pWaitFor from 'p-wait-for'
+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')
+
+export default (common: TestSetup<PubSub, PubSubArgs>): void => {
+  describe('pubsub api', () => {
+    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
+        }
+      })
+    })
+
+    afterEach(async () => {
+      sinon.restore()
+      await stop(...Object.values(components))
+      await common.teardown()
+      mockNetwork.reset()
+    })
+
+    it('can start correctly', async () => {
+      if (!isStartable(pubsub)) {
+        return
+      }
+
+      sinon.spy(components.registrar, 'register')
+
+      await start(...Object.values(components))
+
+      expect(pubsub.isStarted()).to.equal(true)
+      expect(components.registrar.register).to.have.property('callCount', 1)
+    })
+
+    it('can stop correctly', async () => {
+      if (!isStartable(pubsub)) {
+        return
+      }
+
+      sinon.spy(components.registrar, 'unregister')
+
+      await start(...Object.values(components))
+      await stop(...Object.values(components))
+
+      expect(pubsub.isStarted()).to.equal(false)
+      expect(components.registrar.unregister).to.have.property('callCount', 1)
+    })
+
+    it('can subscribe and unsubscribe correctly', async () => {
+      const handler = (): void => {
+        throw new Error('a message should not be received')
+      }
+
+      await start(...Object.values(components))
+      pubsub.subscribe(topic)
+      pubsub.addEventListener('message', handler)
+
+      await pWaitFor(() => {
+        const topics = pubsub.getTopics()
+        return topics.length === 1 && topics[0] === topic
+      })
+
+      pubsub.removeEventListener('message', handler)
+      pubsub.unsubscribe(topic)
+
+      await pWaitFor(() => pubsub.getTopics().length === 0)
+
+      // Publish to guarantee the handler is not called
+      await pubsub.publish(topic, data)
+
+      // handlers are called async
+      await delay(100)
+
+      await stop(...Object.values(components))
+    })
+
+    it('can subscribe and publish correctly', async () => {
+      const defer = pDefer()
+
+      await start(...Object.values(components))
+
+      pubsub.subscribe(topic)
+      pubsub.addEventListener('message', (evt) => {
+        expect(evt).to.have.nested.property('detail.topic', topic)
+        expect(evt).to.have.deep.nested.property('detail.data', data)
+        defer.resolve()
+      })
+      await pubsub.publish(topic, data)
+      await defer.promise
+
+      await stop(...Object.values(components))
+    })
+  })
+}