@libp2p/interface-compliance-tests 6.5.0 → 7.0.0-049bfa0fa

package/src/mocks/connection.ts

@@ -1,309 +0,0 @@
-import { ConnectionClosedError } from '@libp2p/interface'
-import { defaultLogger, logger } from '@libp2p/logger'
-import * as mss from '@libp2p/multistream-select'
-import { peerIdFromString } from '@libp2p/peer-id'
-import { closeSource } from '@libp2p/utils/close-source'
-import { duplexPair } from 'it-pair/duplex'
-import { pipe } from 'it-pipe'
-import { Uint8ArrayList } from 'uint8arraylist'
-import { mockMultiaddrConnection } from './multiaddr-connection.js'
-import { mockMuxer } from './muxer.js'
-import { mockRegistrar } from './registrar.js'
-import type { AbortOptions, ComponentLogger, Logger, MultiaddrConnection, Connection, Stream, Direction, ConnectionTimeline, ConnectionStatus, PeerId, StreamMuxer, StreamMuxerFactory, NewStreamOptions, ConnectionLimits } from '@libp2p/interface'
-import type { Registrar } from '@libp2p/interface-internal'
-import type { Multiaddr } from '@multiformats/multiaddr'
-import type { Duplex, Source } from 'it-stream-types'
-
-export interface MockConnectionOptions {
-  direction?: Direction
-  registrar?: Registrar
-  muxerFactory?: StreamMuxerFactory
-  logger?: ComponentLogger
-}
-
-interface MockConnectionInit {
-  remoteAddr: Multiaddr
-  remotePeer: PeerId
-  direction: Direction
-  maConn: MultiaddrConnection
-  muxer: StreamMuxer
-  logger: ComponentLogger
-}
-
-class MockConnection implements Connection {
-  public id: string
-  public remoteAddr: Multiaddr
-  public remotePeer: PeerId
-  public direction: Direction
-  public timeline: ConnectionTimeline
-  public multiplexer?: string
-  public encryption?: string
-  public status: ConnectionStatus
-  public streams: Stream[]
-  public tags: string[]
-  public limits?: ConnectionLimits
-  public log: Logger
-
-  private readonly muxer: StreamMuxer
-  private readonly maConn: MultiaddrConnection
-  private readonly logger: ComponentLogger
-
-  constructor (init: MockConnectionInit) {
-    const { remoteAddr, remotePeer, direction, maConn, muxer, logger } = init
-
-    this.id = `mock-connection-${Math.random()}`
-    this.remoteAddr = remoteAddr
-    this.remotePeer = remotePeer
-    this.direction = direction
-    this.status = 'open'
-    this.direction = direction
-    this.timeline = maConn.timeline
-    this.multiplexer = 'test-multiplexer'
-    this.encryption = 'yes-yes-very-secure'
-    this.streams = []
-    this.tags = []
-    this.muxer = muxer
-    this.maConn = maConn
-    this.logger = logger
-    this.log = logger.forComponent(this.id)
-  }
-
-  async newStream (protocols: string | string[], options?: NewStreamOptions): Promise<Stream> {
-    if (!Array.isArray(protocols)) {
-      protocols = [protocols]
-    }
-
-    if (protocols.length === 0) {
-      throw new Error('protocols must have a length')
-    }
-
-    if (this.status !== 'open') {
-      throw new ConnectionClosedError('connection must be open to create streams')
-    }
-
-    options?.signal?.throwIfAborted()
-
-    const id = `${Math.random()}`
-    const stream = await this.muxer.newStream(id)
-    const result = await mss.select(stream, protocols, {
-      ...options,
-      log: this.logger.forComponent('libp2p:mock-connection:stream:mss:select')
-    })
-
-    stream.protocol = result.protocol
-    stream.direction = 'outbound'
-    stream.sink = result.stream.sink
-    stream.source = result.stream.source
-
-    this.streams.push(stream)
-
-    return stream
-  }
-
-  async close (options?: AbortOptions): Promise<void> {
-    this.status = 'closing'
-    await Promise.all(
-      this.streams.map(async s => s.close(options))
-    )
-    await this.maConn.close()
-    this.status = 'closed'
-    this.timeline.close = Date.now()
-  }
-
-  abort (err: Error): void {
-    this.status = 'closing'
-    this.streams.forEach(s => {
-      s.abort(err)
-    })
-    this.maConn.abort(err)
-    this.status = 'closed'
-    this.timeline.close = Date.now()
-  }
-}
-
-export function mockConnection (maConn: MultiaddrConnection, opts: MockConnectionOptions = {}): Connection {
-  const remoteAddr = maConn.remoteAddr
-  const remotePeerIdStr = remoteAddr.getPeerId() ?? '12D3KooWCrhmFM1BCPGBkNzbPfDk4cjYmtAYSpZwUBC69Qg2kZyq'
-  const logger = opts.logger ?? defaultLogger()
-
-  if (remotePeerIdStr == null) {
-    throw new Error('Remote multiaddr must contain a peer id')
-  }
-
-  const remotePeer = peerIdFromString(remotePeerIdStr)
-  const direction = opts.direction ?? 'inbound'
-  const registrar = opts.registrar ?? mockRegistrar()
-  const muxerFactory = opts.muxerFactory ?? mockMuxer()
-  const log = logger.forComponent('libp2p:mock-muxer')
-
-  const muxer = muxerFactory.createStreamMuxer({
-    log,
-    direction,
-    onIncomingStream: (muxedStream) => {
-      try {
-        mss.handle(muxedStream, registrar.getProtocols(), {
-          log
-        })
-          .then(async ({ stream, protocol }) => {
-            log('%s: incoming stream opened on %s', direction, protocol)
-            muxedStream.protocol = protocol
-            muxedStream.sink = stream.sink
-            muxedStream.source = stream.source
-
-            connection.streams.push(muxedStream)
-            const { handler } = registrar.getHandler(protocol)
-
-            await handler({ connection, stream: muxedStream })
-          }).catch(err => {
-            log.error(err)
-            muxedStream.abort(err)
-          })
-      } catch (err: any) {
-        log.error(err)
-      }
-    },
-    onStreamEnd: (muxedStream) => {
-      connection.streams = connection.streams.filter(stream => stream.id !== muxedStream.id)
-    }
-  })
-
-  void pipe(
-    maConn, muxer, maConn
-  )
-
-  const connection = new MockConnection({
-    remoteAddr,
-    remotePeer,
-    direction,
-    maConn,
-    muxer,
-    logger
-  })
-
-  return connection
-}
-
-export interface StreamInit {
-  direction?: Direction
-  protocol?: string
-  id?: string
-}
-
-export function mockStream (stream: Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList | Uint8Array>, Promise<void>>, init: StreamInit = {}): Stream {
-  const id = `stream-${Date.now()}`
-  const log = logger(`libp2p:mock-stream:${id}`)
-
-  // ensure stream output is `Uint8ArrayList` as it would be from an actual
-  // Stream where everything is length-varint encoded
-  const originalSource = stream.source
-  stream.source = (async function * (): AsyncGenerator<Uint8ArrayList, any, unknown> {
-    for await (const buf of originalSource) {
-      if (buf instanceof Uint8Array) {
-        yield new Uint8ArrayList(buf)
-      } else {
-        yield buf
-      }
-    }
-  })()
-
-  const abortSinkController = new AbortController()
-  const originalSink = stream.sink.bind(stream)
-  stream.sink = async (source) => {
-    abortSinkController.signal.addEventListener('abort', () => {
-      closeSource(source, log)
-    })
-
-    await originalSink(source)
-  }
-
-  const mockStream: Stream = {
-    ...stream,
-    close: async (options) => {
-      await mockStream.closeRead(options)
-      await mockStream.closeWrite(options)
-    },
-    closeRead: async () => {
-      closeSource(originalSource, log)
-      mockStream.timeline.closeRead = Date.now()
-
-      if (mockStream.timeline.closeWrite != null) {
-        mockStream.timeline.close = Date.now()
-      }
-    },
-    closeWrite: async () => {
-      abortSinkController.abort()
-      mockStream.timeline.closeWrite = Date.now()
-
-      if (mockStream.timeline.closeRead != null) {
-        mockStream.timeline.close = Date.now()
-      }
-    },
-    abort: () => {
-      closeSource(originalSource, log)
-      mockStream.timeline.closeWrite = Date.now()
-      mockStream.timeline.closeRead = Date.now()
-      mockStream.timeline.close = Date.now()
-    },
-    direction: 'outbound',
-    protocol: '/foo/1.0.0',
-    timeline: {
-      open: Date.now()
-    },
-    metadata: {},
-    id: `stream-${Date.now()}`,
-    status: 'open',
-    readStatus: 'ready',
-    writeStatus: 'ready',
-    log: logger('mock-stream'),
-    ...init
-  }
-
-  return mockStream
-}
-
-export interface StreamPairInit {
-  duplex: Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList | Uint8Array>, Promise<void>>
-  init?: StreamInit
-}
-
-export function streamPair (a: StreamPairInit, b: StreamPairInit, init: StreamInit = {}): [Stream, Stream] {
-  return [
-    mockStream(a.duplex, {
-      direction: 'outbound',
-      ...init,
-      ...(a.init ?? {})
-    }),
-    mockStream(b.duplex, {
-      direction: 'inbound',
-      ...init,
-      ...(b.init ?? {})
-    })
-  ]
-}
-
-export interface Peer {
-  peerId: PeerId
-  registrar: Registrar
-}
-
-export function multiaddrConnectionPair (a: { peerId: PeerId, registrar: Registrar }, b: { peerId: PeerId, registrar: Registrar }): [ MultiaddrConnection, MultiaddrConnection ] {
-  const [peerBtoPeerA, peerAtoPeerB] = duplexPair<Uint8Array | Uint8ArrayList>()
-
-  return [
-    mockMultiaddrConnection(peerAtoPeerB, b.peerId),
-    mockMultiaddrConnection(peerBtoPeerA, a.peerId)
-  ]
-}
-
-export function connectionPair (a: { peerId: PeerId, registrar: Registrar }, b: { peerId: PeerId, registrar: Registrar }): [ Connection, Connection ] {
-  const [peerBtoPeerA, peerAtoPeerB] = multiaddrConnectionPair(a, b)
-
-  return [
-    mockConnection(peerBtoPeerA, {
-      registrar: a.registrar
-    }),
-    mockConnection(peerAtoPeerB, {
-      registrar: b.registrar
-    })
-  ]
-}

package/src/mocks/duplex.ts

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

package/src/mocks/index.ts

@@ -1,11 +0,0 @@
-export { mockConnectionManager, mockNetwork } from './connection-manager.js'
-export { mockConnection, mockStream, streamPair, 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 type { MockUpgraderInit } from './upgrader.js'
-export type { MockNetworkComponents, MockConnectionManagerComponents, MockNetwork } from './connection-manager.js'
-export type { MockConnectionOptions, StreamInit, StreamPairInit } from './connection.js'
-export type { MockMultiaddrConnPairOptions } from './multiaddr-connection.js'

package/src/mocks/multiaddr-connection.ts

@@ -1,80 +0,0 @@
-import { logger } from '@libp2p/logger'
-import { multiaddr } from '@multiformats/multiaddr'
-import { abortableSource } from 'abortable-iterator'
-import { duplexPair } from 'it-pair/duplex'
-import type { MultiaddrConnection, PeerId } from '@libp2p/interface'
-import type { Multiaddr } from '@multiformats/multiaddr'
-import type { Duplex } from 'it-stream-types'
-import type { Uint8ArrayList } from 'uint8arraylist'
-
-export function mockMultiaddrConnection (source: Duplex<AsyncGenerator<Uint8Array | Uint8ArrayList>> & 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()}`),
-    log: logger('mock-maconn'),
-    ...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 | Uint8ArrayList>()
-
-  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)
-    },
-    log: logger('mock-maconn-outbound')
-  }
-
-  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)
-    },
-    log: logger('mock-maconn-inbound')
-  }
-
-  // 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 }
-}