@libp2p/interface-compliance-tests 3.0.7-ea8a0637 → 3.0.7-eabf6f36

package/src/mocks/duplex.ts

@@ -0,0 +1,10 @@
+import type { Duplex, Source } from 'it-stream-types'
+
+export function mockDuplex (): Duplex<AsyncGenerator<Uint8Array>, Source<Uint8Array>, Promise<void>> {
+  return {
+    source: (async function * () {
+      yield * []
+    }()),
+    sink: async () => {}
+  }
+}

package/src/mocks/index.ts

@@ -0,0 +1,12 @@
+export { mockConnectionEncrypter } from './connection-encrypter.js'
+export { mockConnectionGater } from './connection-gater.js'
+export { mockConnectionManager, mockNetwork } from './connection-manager.js'
+export { mockConnection, mockStream, connectionPair } from './connection.js'
+export { mockMultiaddrConnection, mockMultiaddrConnPair } from './multiaddr-connection.js'
+export { mockMuxer } from './muxer.js'
+export { mockRegistrar } from './registrar.js'
+export { mockUpgrader } from './upgrader.js'
+export { mockDuplex } from './duplex.js'
+export { mockMetrics } from './metrics.js'
+export type { MockUpgraderInit } from './upgrader.js'
+export type { MockNetworkComponents } from './connection-manager.js'

package/src/mocks/metrics.ts

@@ -0,0 +1,162 @@
+import type { MultiaddrConnection, Stream, Connection } from '@libp2p/interface/connection'
+import type { Metric, MetricGroup, StopTimer, Metrics, CalculatedMetricOptions, MetricOptions } from '@libp2p/interface/metrics'
+
+class DefaultMetric implements Metric {
+  public value: number = 0
+
+  update (value: number): void {
+    this.value = value
+  }
+
+  increment (value: number = 1): void {
+    this.value += value
+  }
+
+  decrement (value: number = 1): void {
+    this.value -= value
+  }
+
+  reset (): void {
+    this.value = 0
+  }
+
+  timer (): StopTimer {
+    const start = Date.now()
+
+    return () => {
+      this.value = Date.now() - start
+    }
+  }
+}
+
+class DefaultGroupMetric implements MetricGroup {
+  public values: Record<string, number> = {}
+
+  update (values: Record<string, number>): void {
+    Object.entries(values).forEach(([key, value]) => {
+      this.values[key] = value
+    })
+  }
+
+  increment (values: Record<string, number | unknown>): void {
+    Object.entries(values).forEach(([key, value]) => {
+      this.values[key] = this.values[key] ?? 0
+      const inc = typeof value === 'number' ? value : 1
+
+      this.values[key] += Number(inc)
+    })
+  }
+
+  decrement (values: Record<string, number | unknown>): void {
+    Object.entries(values).forEach(([key, value]) => {
+      this.values[key] = this.values[key] ?? 0
+      const dec = typeof value === 'number' ? value : 1
+
+      this.values[key] -= Number(dec)
+    })
+  }
+
+  reset (): void {
+    this.values = {}
+  }
+
+  timer (key: string): StopTimer {
+    const start = Date.now()
+
+    return () => {
+      this.values[key] = Date.now() - start
+    }
+  }
+}
+
+class MockMetrics implements Metrics {
+  public metrics = new Map<string, any>()
+
+  trackMultiaddrConnection (maConn: MultiaddrConnection): void {
+
+  }
+
+  trackProtocolStream (stream: Stream, connection: Connection): void {
+
+  }
+
+  registerMetric (name: string, opts: CalculatedMetricOptions): void
+  registerMetric (name: string, opts?: MetricOptions): Metric
+  registerMetric (name: string, opts: any): any {
+    if (name == null ?? name.trim() === '') {
+      throw new Error('Metric name is required')
+    }
+
+    if (opts?.calculate != null) {
+      // calculated metric
+      this.metrics.set(name, opts.calculate)
+      return
+    }
+
+    const metric = new DefaultMetric()
+    this.metrics.set(name, metric)
+
+    return metric
+  }
+
+  registerCounter (name: string, opts: CalculatedMetricOptions): void
+  registerCounter (name: string, opts?: MetricOptions): Metric
+  registerCounter (name: string, opts: any): any {
+    if (name == null ?? name.trim() === '') {
+      throw new Error('Metric name is required')
+    }
+
+    if (opts?.calculate != null) {
+      // calculated metric
+      this.metrics.set(name, opts.calculate)
+      return
+    }
+
+    const metric = new DefaultMetric()
+    this.metrics.set(name, metric)
+
+    return metric
+  }
+
+  registerMetricGroup (name: string, opts: CalculatedMetricOptions<Record<string, number>>): void
+  registerMetricGroup (name: string, opts?: MetricOptions): MetricGroup
+  registerMetricGroup (name: string, opts: any): any {
+    if (name == null ?? name.trim() === '') {
+      throw new Error('Metric name is required')
+    }
+
+    if (opts?.calculate != null) {
+      // calculated metric
+      this.metrics.set(name, opts.calculate)
+      return
+    }
+
+    const metric = new DefaultGroupMetric()
+    this.metrics.set(name, metric)
+
+    return metric
+  }
+
+  registerCounterGroup (name: string, opts: CalculatedMetricOptions<Record<string, number>>): void
+  registerCounterGroup (name: string, opts?: MetricOptions): MetricGroup
+  registerCounterGroup (name: string, opts: any): any {
+    if (name == null ?? name.trim() === '') {
+      throw new Error('Metric name is required')
+    }
+
+    if (opts?.calculate != null) {
+      // calculated metric
+      this.metrics.set(name, opts.calculate)
+      return
+    }
+
+    const metric = new DefaultGroupMetric()
+    this.metrics.set(name, metric)
+
+    return metric
+  }
+}
+
+export function mockMetrics (): () => Metrics {
+  return () => new MockMetrics()
+}

package/src/mocks/multiaddr-connection.ts

@@ -0,0 +1,76 @@
+import { multiaddr } from '@multiformats/multiaddr'
+import { abortableSource } from 'abortable-iterator'
+import { duplexPair } from 'it-pair/duplex'
+import type { MultiaddrConnection } from '@libp2p/interface/connection'
+import type { PeerId } from '@libp2p/interface/peer-id'
+import type { Multiaddr } from '@multiformats/multiaddr'
+import type { Duplex } from 'it-stream-types'
+
+export function mockMultiaddrConnection (source: Duplex<AsyncGenerator<Uint8Array>> & Partial<MultiaddrConnection>, peerId: PeerId): MultiaddrConnection {
+  const maConn: MultiaddrConnection = {
+    async close () {
+
+    },
+    abort: () => {},
+    timeline: {
+      open: Date.now()
+    },
+    remoteAddr: multiaddr(`/ip4/127.0.0.1/tcp/4001/p2p/${peerId.toString()}`),
+    ...source
+  }
+
+  return maConn
+}
+
+export interface MockMultiaddrConnPairOptions {
+  addrs: Multiaddr[]
+  remotePeer: PeerId
+}
+
+/**
+ * Returns both sides of a mocked MultiaddrConnection
+ */
+export function mockMultiaddrConnPair (opts: MockMultiaddrConnPairOptions): { inbound: MultiaddrConnection, outbound: MultiaddrConnection } {
+  const { addrs, remotePeer } = opts
+  const controller = new AbortController()
+  const [localAddr, remoteAddr] = addrs
+  const [inboundStream, outboundStream] = duplexPair<Uint8Array>()
+
+  const outbound: MultiaddrConnection = {
+    ...outboundStream,
+    remoteAddr: remoteAddr.toString().includes(`/p2p/${remotePeer.toString()}`) ? remoteAddr : remoteAddr.encapsulate(`/p2p/${remotePeer.toString()}`),
+    timeline: {
+      open: Date.now()
+    },
+    close: async () => {
+      outbound.timeline.close = Date.now()
+      controller.abort()
+    },
+    abort: (err: Error) => {
+      outbound.timeline.close = Date.now()
+      controller.abort(err)
+    }
+  }
+
+  const inbound: MultiaddrConnection = {
+    ...inboundStream,
+    remoteAddr: localAddr,
+    timeline: {
+      open: Date.now()
+    },
+    close: async () => {
+      inbound.timeline.close = Date.now()
+      controller.abort()
+    },
+    abort: (err: Error) => {
+      outbound.timeline.close = Date.now()
+      controller.abort(err)
+    }
+  }
+
+  // Make the sources abortable so we can close them easily
+  inbound.source = abortableSource(inbound.source, controller.signal)
+  outbound.source = abortableSource(outbound.source, controller.signal)
+
+  return { inbound, outbound }
+}

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
+    }
+  }
+}