@libp2p/interface-compliance-tests 2.0.3 → 3.0.0

package/src/transport/dial-test.ts

@@ -1,123 +0,0 @@
-import { expect } from 'aegir/chai'
-import { isValidTick } from '../utils/is-valid-tick.js'
-import { mockUpgrader } from '../mocks/upgrader.js'
-import { mockRegistrar } from '../mocks/registrar.js'
-import all from 'it-all'
-import { pipe } from 'it-pipe'
-import { AbortError } from '@libp2p/interfaces/errors'
-import sinon from 'sinon'
-import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import drain from 'it-drain'
-import type { TestSetup } from '../index.js'
-import type { Transport, Listener, Upgrader } from '@libp2p/interfaces/transport'
-import type { TransportTestFixtures, Connector } from './index.js'
-import type { Multiaddr } from '@multiformats/multiaddr'
-import type { Registrar } from '@libp2p/interfaces/registrar'
-
-export default (common: TestSetup<TransportTestFixtures>) => {
-  describe('dial', () => {
-    let upgrader: Upgrader
-    let registrar: Registrar
-    let addrs: Multiaddr[]
-    let transport: Transport
-    let connector: Connector
-    let listener: Listener
-
-    before(async () => {
-      registrar = mockRegistrar()
-      upgrader = mockUpgrader({
-        registrar
-      });
-
-      ({ addrs, transport, connector } = await common.setup())
-    })
-
-    after(async () => {
-      await common.teardown()
-    })
-
-    beforeEach(async () => {
-      listener = transport.createListener({
-        upgrader
-      })
-      return await listener.listen(addrs[0])
-    })
-
-    afterEach(async () => {
-      sinon.restore()
-      connector.restore()
-      return await listener.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 transport.dial(addrs[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]).to.equalBytes(uint8ArrayFromString('hey'))
-      await conn.close()
-    })
-
-    it('can close connections', async () => {
-      const upgradeSpy = sinon.spy(upgrader, 'upgradeOutbound')
-      const conn = await transport.dial(addrs[0], {
-        upgrader
-      })
-
-      expect(upgradeSpy.callCount).to.equal(1)
-      await expect(upgradeSpy.getCall(0).returnValue).to.eventually.equal(conn)
-      await conn.close()
-      expect(isValidTick(conn.stat.timeline.close)).to.equal(true)
-    })
-
-    it('to non existent listener', async () => {
-      const upgradeSpy = sinon.spy(upgrader, 'upgradeOutbound')
-
-      await expect(transport.dial(addrs[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 = transport.dial(addrs[0], { signal: controller.signal, upgrader })
-
-      await expect(conn).to.eventually.be.rejected().with.property('code', AbortError.code)
-      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 = transport.dial(addrs[0], { signal: controller.signal, upgrader })
-      setTimeout(() => controller.abort(), 50)
-
-      await expect(conn).to.eventually.be.rejected().with.property('code', AbortError.code)
-      expect(upgradeSpy.callCount).to.equal(0)
-    })
-  })
-}

package/src/transport/filter-test.ts

@@ -1,25 +0,0 @@
-import { expect } from 'aegir/chai'
-import type { TestSetup } from '../index.js'
-import type { Transport } from '@libp2p/interfaces/transport'
-import type { TransportTestFixtures } from './index.js'
-import type { Multiaddr } from '@multiformats/multiaddr'
-
-export default (common: TestSetup<TransportTestFixtures>) => {
-  describe('filter', () => {
-    let addrs: Multiaddr[]
-    let transport: Transport
-
-    before(async () => {
-      ({ addrs, transport } = await common.setup())
-    })
-
-    after(async () => {
-      await common.teardown()
-    })
-
-    it('filters addresses', () => {
-      const filteredAddrs = transport.filter(addrs)
-      expect(filteredAddrs).to.eql(addrs)
-    })
-  })
-}

package/src/transport/index.ts

@@ -1,25 +0,0 @@
-import dial from './dial-test.js'
-import listen from './listen-test.js'
-import filter from './filter-test.js'
-import type { TestSetup } from '../index.js'
-import type { Transport } from '@libp2p/interfaces/transport'
-import type { Multiaddr } from '@multiformats/multiaddr'
-
-export interface Connector {
-  delay: (ms: number) => void
-  restore: () => void
-}
-
-export interface TransportTestFixtures {
-  addrs: Multiaddr[]
-  transport: Transport
-  connector: Connector
-}
-
-export default (common: TestSetup<TransportTestFixtures>) => {
-  describe('interface-transport', () => {
-    dial(common)
-    listen(common)
-    filter(common)
-  })
-}

package/src/transport/listen-test.ts

@@ -1,191 +0,0 @@
-/* eslint max-nested-callbacks: ["error", 8] */
-import { expect } from 'aegir/chai'
-import sinon from 'sinon'
-import pWaitFor from 'p-wait-for'
-import { pipe } from 'it-pipe'
-import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import { isValidTick } from '../utils/is-valid-tick.js'
-import { mockUpgrader } from '../mocks/upgrader.js'
-import defer from 'p-defer'
-import { mockRegistrar } from '../mocks/registrar.js'
-import drain from 'it-drain'
-import { CustomEvent } from '@libp2p/interfaces/events'
-import type { TestSetup } from '../index.js'
-import type { Transport, Upgrader } from '@libp2p/interfaces/transport'
-import type { TransportTestFixtures } from './index.js'
-import type { Multiaddr } from '@multiformats/multiaddr'
-import type { Connection } from '@libp2p/interfaces/connection'
-import type { Registrar } from '@libp2p/interfaces/registrar'
-
-export default (common: TestSetup<TransportTestFixtures>) => {
-  describe('listen', () => {
-    let upgrader: Upgrader
-    let addrs: Multiaddr[]
-    let transport: Transport
-    let registrar: Registrar
-
-    before(async () => {
-      registrar = mockRegistrar()
-      upgrader = mockUpgrader({
-        registrar
-      });
-
-      ({ transport, addrs } = await common.setup())
-    })
-
-    after(async () => {
-      await common.teardown()
-    })
-
-    afterEach(() => {
-      sinon.restore()
-    })
-
-    it('simple', async () => {
-      const listener = transport.createListener({
-        upgrader
-      })
-      await listener.listen(addrs[0])
-      await listener.close()
-    })
-
-    it('close listener with connections, through timeout', async () => {
-      const upgradeSpy = sinon.spy(upgrader, 'upgradeInbound')
-      const listenerConns: Connection[] = []
-
-      const protocol = '/test/protocol'
-      void registrar.handle(protocol, (data) => {
-        void drain(data.stream.source)
-      })
-
-      const listener = transport.createListener({
-        upgrader,
-        handler: (conn) => {
-          listenerConns.push(conn)
-        }
-      })
-
-      // Listen
-      await listener.listen(addrs[0])
-
-      // Create two connections to the listener
-      const [conn1] = await Promise.all([
-        transport.dial(addrs[0], {
-          upgrader
-        }),
-        transport.dial(addrs[0], {
-          upgrader
-        })
-      ])
-
-      // Give the listener a chance to finish its upgrade
-      await pWaitFor(() => listenerConns.length === 2)
-
-      const { stream: stream1 } = await conn1.newStream([protocol])
-
-      // Wait for the data send and close to finish
-      await Promise.all([
-        pipe(
-          [uint8ArrayFromString('Some data that is never handled')],
-          stream1
-        ),
-        // Closer the listener (will take a couple of seconds to time out)
-        listener.close()
-      ])
-
-      await stream1.close()
-      await conn1.close()
-
-      expect(isValidTick(conn1.stat.timeline.close)).to.equal(true)
-      listenerConns.forEach(conn => {
-        expect(isValidTick(conn.stat.timeline.close)).to.equal(true)
-      })
-
-      // 2 dials = 2 connections upgraded
-      expect(upgradeSpy.callCount).to.equal(2)
-    })
-
-    it('should not handle connection if upgradeInbound throws', async () => {
-      sinon.stub(upgrader, 'upgradeInbound').throws()
-
-      const listener = transport.createListener({
-        upgrader
-      })
-
-      // Listen
-      await listener.listen(addrs[0])
-
-      // Create a connection to the listener
-      const conn = await transport.dial(addrs[0], {
-        upgrader
-      })
-
-      await pWaitFor(() => typeof conn.stat.timeline.close === 'number')
-      await listener.close()
-    })
-
-    describe('events', () => {
-      it('connection', async () => {
-        const upgradeSpy = sinon.spy(upgrader, 'upgradeInbound')
-        const listener = transport.createListener({
-          upgrader
-        })
-        const deferred = defer()
-        let conn
-
-        listener.addEventListener('connection', (evt) => {
-          conn = evt.detail
-          deferred.resolve()
-        })
-
-        void (async () => {
-          await listener.listen(addrs[0])
-          await transport.dial(addrs[0], {
-            upgrader
-          })
-        })()
-
-        await deferred.promise
-
-        await expect(upgradeSpy.getCall(0).returnValue).to.eventually.equal(conn)
-        expect(upgradeSpy.callCount).to.equal(1)
-        await listener.close()
-      })
-
-      it('listening', (done) => {
-        const listener = transport.createListener({
-          upgrader
-        })
-        listener.addEventListener('listening', () => {
-          listener.close().then(done, done)
-        })
-        void listener.listen(addrs[0])
-      })
-
-      it('error', (done) => {
-        const listener = transport.createListener({
-          upgrader
-        })
-        listener.addEventListener('error', (evt) => {
-          expect(evt.detail).to.be.an.instanceOf(Error)
-          listener.close().then(done, done)
-        })
-        listener.dispatchEvent(new CustomEvent('error', {
-          detail: new Error('my err')
-        }))
-      })
-
-      it('close', (done) => {
-        const listener = transport.createListener({
-          upgrader
-        })
-        listener.addEventListener('close', () => done())
-
-        void (async () => {
-          await listener.listen(addrs[0])
-          await listener.close()
-        })()
-      })
-    })
-  })
-}