@libp2p/interface-compliance-tests 6.1.8 → 6.1.9

package/src/mocks/metrics.ts

@@ -1,385 +0,0 @@
-import { TDigest } from 'tdigest'
-import type { MultiaddrConnection, Stream, Connection, Metric, MetricGroup, StopTimer, Metrics, CalculatedMetricOptions, MetricOptions, Histogram, HistogramOptions, HistogramGroup, Summary, SummaryOptions, SummaryGroup, CalculatedHistogramOptions, CalculatedSummaryOptions } from '@libp2p/interface'
-
-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 DefaultHistogram implements Histogram {
-  public bucketValues = new Map<number, number>()
-  public countValue: number = 0
-  public sumValue: number = 0
-
-  constructor (opts: HistogramOptions) {
-    const buckets = [
-      ...(opts.buckets ?? [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10]),
-      Infinity
-    ]
-    for (const bucket of buckets) {
-      this.bucketValues.set(bucket, 0)
-    }
-  }
-
-  observe (value: number): void {
-    this.countValue++
-    this.sumValue += value
-
-    for (const [bucket, count] of this.bucketValues.entries()) {
-      if (value <= bucket) {
-        this.bucketValues.set(bucket, count + 1)
-      }
-    }
-  }
-
-  reset (): void {
-    this.countValue = 0
-    this.sumValue = 0
-    for (const bucket of this.bucketValues.keys()) {
-      this.bucketValues.set(bucket, 0)
-    }
-  }
-
-  timer (): StopTimer {
-    const start = Date.now()
-
-    return () => {
-      this.observe(Date.now() - start)
-    }
-  }
-}
-
-class DefaultHistogramGroup implements HistogramGroup {
-  public histograms: Record<string, DefaultHistogram> = {}
-
-  constructor (opts: HistogramOptions) {
-    this.histograms = {}
-  }
-
-  observe (values: Partial<Record<string, number>>): void {
-    for (const [key, value] of Object.entries(values) as Array<[string, number]>) {
-      if (this.histograms[key] === undefined) {
-        this.histograms[key] = new DefaultHistogram({})
-      }
-
-      this.histograms[key].observe(value)
-    }
-  }
-
-  reset (): void {
-    for (const histogram of Object.values(this.histograms)) {
-      histogram.reset()
-    }
-  }
-
-  timer (key: string): StopTimer {
-    const start = Date.now()
-
-    return () => {
-      this.observe({ [key]: Date.now() - start })
-    }
-  }
-}
-
-class DefaultSummary implements Summary {
-  public sumValue: number = 0
-  public countValue: number = 0
-  public percentiles: number[]
-  public tdigest = new TDigest(0.01)
-  private readonly compressCount: number
-
-  constructor (opts: SummaryOptions) {
-    this.percentiles = opts.percentiles ?? [0.01, 0.05, 0.5, 0.9, 0.95, 0.99, 0.999]
-    this.compressCount = opts.compressCount ?? 1000
-  }
-
-  observe (value: number): void {
-    this.sumValue += value
-    this.countValue++
-
-    this.tdigest.push(value)
-    if (this.tdigest.size() > this.compressCount) {
-      this.tdigest.compress()
-    }
-  }
-
-  reset (): void {
-    this.sumValue = 0
-    this.countValue = 0
-
-    this.tdigest.reset()
-  }
-
-  timer (): StopTimer {
-    const start = Date.now()
-
-    return () => {
-      this.observe(Date.now() - start)
-    }
-  }
-}
-
-class DefaultSummaryGroup implements SummaryGroup {
-  public summaries: Record<string, DefaultSummary> = {}
-  private readonly opts: SummaryOptions
-
-  constructor (opts: SummaryOptions) {
-    this.summaries = {}
-    this.opts = opts
-  }
-
-  observe (values: Record<string, number>): void {
-    for (const [key, value] of Object.entries(values)) {
-      if (this.summaries[key] === undefined) {
-        this.summaries[key] = new DefaultSummary(this.opts)
-      }
-
-      this.summaries[key].observe(value)
-    }
-  }
-
-  reset (): void {
-    for (const summary of Object.values(this.summaries)) {
-      summary.reset()
-    }
-  }
-
-  timer (key: string): StopTimer {
-    const start = Date.now()
-
-    return () => {
-      this.observe({ [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
-  }
-
-  registerHistogram (name: string, opts: CalculatedHistogramOptions): void
-  registerHistogram (name: string, opts?: HistogramOptions): Histogram
-  registerHistogram (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 DefaultHistogram(opts)
-    this.metrics.set(name, metric)
-
-    return metric
-  }
-
-  registerHistogramGroup (name: string, opts: CalculatedHistogramOptions<Record<string, number>>): void
-  registerHistogramGroup (name: string, opts?: HistogramOptions): HistogramGroup
-  registerHistogramGroup (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 DefaultHistogramGroup(opts)
-    this.metrics.set(name, metric)
-
-    return metric
-  }
-
-  registerSummary (name: string, opts: CalculatedSummaryOptions): void
-  registerSummary (name: string, opts?: SummaryOptions): Summary
-  registerSummary (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 DefaultSummary(opts)
-    this.metrics.set(name, metric)
-
-    return metric
-  }
-
-  registerSummaryGroup (name: string, opts: CalculatedSummaryOptions<Record<string, number>>): void
-  registerSummaryGroup (name: string, opts?: SummaryOptions): SummaryGroup
-  registerSummaryGroup (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 DefaultSummaryGroup(opts)
-    this.metrics.set(name, metric)
-
-    return metric
-  }
-}
-
-export function mockMetrics (): () => Metrics {
-  return () => new MockMetrics()
-}

package/src/mocks/peer-discovery.ts

@@ -1,59 +0,0 @@
-import { generateKeyPair } from '@libp2p/crypto/keys'
-import { TypedEventEmitter, peerDiscoverySymbol } from '@libp2p/interface'
-import { peerIdFromPrivateKey } from '@libp2p/peer-id'
-import { multiaddr } from '@multiformats/multiaddr'
-import type { PeerDiscovery, PeerDiscoveryEvents, PeerInfo } from '@libp2p/interface'
-
-interface MockDiscoveryInit {
-  discoveryDelay?: number
-}
-
-/**
- * Emits 'peer' events on discovery.
- */
-export class MockDiscovery extends TypedEventEmitter<PeerDiscoveryEvents> implements PeerDiscovery {
-  public readonly options: MockDiscoveryInit
-  private _isRunning: boolean
-  private _timer: any
-
-  constructor (init = {}) {
-    super()
-
-    this.options = init
-    this._isRunning = false
-  }
-
-  readonly [peerDiscoverySymbol] = 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
-
-    generateKeyPair('Ed25519')
-      .then(key => {
-        const peerId = peerIdFromPrivateKey(key)
-        this._timer = setTimeout(() => {
-          this.safeDispatchEvent<PeerInfo>('peer', {
-            detail: {
-              id: peerId,
-              multiaddrs: [multiaddr('/ip4/127.0.0.1/tcp/8000')]
-            }
-          })
-        }, this.options.discoveryDelay ?? 1000)
-      })
-      .catch(() => {})
-  }
-}

package/src/transport/dial-test.ts

@@ -1,125 +0,0 @@
-import { TypedEventEmitter } from '@libp2p/interface'
-import { expect } from 'aegir/chai'
-import all from 'it-all'
-import drain from 'it-drain'
-import { pipe } from 'it-pipe'
-import sinon from 'sinon'
-import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import { isValidTick } from '../is-valid-tick.js'
-import { mockUpgrader, mockRegistrar } from '../mocks/index.js'
-import type { TransportTestFixtures, Connector } from './index.js'
-import type { TestSetup } from '../index.js'
-import type { Listener, Transport, Upgrader } from '@libp2p/interface'
-import type { Registrar } from '@libp2p/interface-internal'
-import type { Multiaddr } from '@multiformats/multiaddr'
-
-export default (common: TestSetup<TransportTestFixtures>): void => {
-  describe('dial', () => {
-    let upgrader: Upgrader
-    let registrar: Registrar
-    let listenAddrs: Multiaddr[]
-    let dialAddrs: Multiaddr[]
-    let dialer: Transport
-    let listener: Transport
-    let connector: Connector
-    let listen: Listener
-
-    before(async () => {
-      registrar = mockRegistrar()
-      upgrader = mockUpgrader({
-        registrar,
-        events: new TypedEventEmitter()
-      });
-
-      ({ listenAddrs, dialAddrs, dialer, listener, connector } = await common.setup())
-    })
-
-    after(async () => {
-      await common.teardown()
-    })
-
-    beforeEach(async () => {
-      listen = listener.createListener({
-        upgrader
-      })
-      await listen.listen(listenAddrs[0])
-    })
-
-    afterEach(async () => {
-      sinon.restore()
-      connector.restore()
-      await listen.close()
-    })
-
-    it('simple', async () => {
-      const protocol = '/hello/1.0.0'
-      void registrar.handle(protocol, (data) => {
-        void pipe([
-          uint8ArrayFromString('hey')
-        ],
-        data.stream,
-        drain
-        )
-      })
-
-      const upgradeSpy = sinon.spy(upgrader, 'upgradeOutbound')
-      const conn = await dialer.dial(dialAddrs[0], {
-        upgrader
-      })
-
-      const stream = await conn.newStream([protocol])
-      const result = await all(stream.source)
-
-      expect(upgradeSpy.callCount).to.equal(1)
-      await expect(upgradeSpy.getCall(0).returnValue).to.eventually.equal(conn)
-      expect(result.length).to.equal(1)
-      expect(result[0].subarray()).to.equalBytes(uint8ArrayFromString('hey'))
-      await conn.close()
-    })
-
-    it('can close connections', async () => {
-      const upgradeSpy = sinon.spy(upgrader, 'upgradeOutbound')
-      const conn = await dialer.dial(dialAddrs[0], {
-        upgrader
-      })
-
-      expect(upgradeSpy.callCount).to.equal(1)
-      await expect(upgradeSpy.getCall(0).returnValue).to.eventually.equal(conn)
-      await conn.close()
-      expect(isValidTick(conn.timeline.close)).to.equal(true)
-    })
-
-    it('to non existent listener', async () => {
-      const upgradeSpy = sinon.spy(upgrader, 'upgradeOutbound')
-
-      await expect(dialer.dial(dialAddrs[1], {
-        upgrader
-      })).to.eventually.be.rejected()
-      expect(upgradeSpy.callCount).to.equal(0)
-    })
-
-    it('abort before dialing throws AbortError', async () => {
-      const upgradeSpy = sinon.spy(upgrader, 'upgradeOutbound')
-      const controller = new AbortController()
-      controller.abort()
-      const conn = dialer.dial(dialAddrs[0], { signal: controller.signal, upgrader })
-
-      await expect(conn).to.eventually.be.rejected().with.property('name', 'AbortError')
-      expect(upgradeSpy.callCount).to.equal(0)
-    })
-
-    it('abort while dialing throws AbortError', async () => {
-      const upgradeSpy = sinon.spy(upgrader, 'upgradeOutbound')
-      // Add a delay to connect() so that we can abort while the dial is in
-      // progress
-      connector.delay(100)
-
-      const controller = new AbortController()
-      const conn = dialer.dial(dialAddrs[0], { signal: controller.signal, upgrader })
-      setTimeout(() => { controller.abort() }, 50)
-
-      await expect(conn).to.eventually.be.rejected().with.property('name', 'AbortError')
-      expect(upgradeSpy.callCount).to.equal(0)
-    })
-  })
-}

package/src/transport/filter-test.ts

@@ -1,32 +0,0 @@
-import { expect } from 'aegir/chai'
-import type { TransportTestFixtures } from './index.js'
-import type { TestSetup } from '../index.js'
-import type { Transport } from '@libp2p/interface'
-import type { Multiaddr } from '@multiformats/multiaddr'
-
-export default (common: TestSetup<TransportTestFixtures>): void => {
-  describe('filter', () => {
-    let listenAddrs: Multiaddr[]
-    let dialAddrs: Multiaddr[]
-    let dialer: Transport
-    let listener: Transport
-
-    before(async () => {
-      ({ listenAddrs, dialAddrs, dialer, listener } = await common.setup())
-    })
-
-    after(async () => {
-      await common.teardown()
-    })
-
-    it('filters listen addresses', () => {
-      const filteredAddrs = listener.listenFilter(listenAddrs)
-      expect(filteredAddrs).to.eql(listenAddrs)
-    })
-
-    it('filters dial addresses', () => {
-      const filteredAddrs = dialer.dialFilter(dialAddrs)
-      expect(filteredAddrs).to.eql(dialAddrs)
-    })
-  })
-}