chore: release version v0.2.8

CHANGELOG.md

@@ -1,3 +1,8 @@
+<a name="0.2.8"></a>
+## [0.2.8](https://github.com/libp2p/js-interfaces/compare/v0.2.7...v0.2.8) (2020-04-21)
+
+
+
 <a name="0.2.7"></a>
 ## [0.2.7](https://github.com/libp2p/js-interfaces/compare/v0.2.6...v0.2.7) (2020-03-20)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p-interfaces",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "description": "Interfaces for JS Libp2p",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -35,11 +35,10 @@
   "dependencies": {
     "abort-controller": "^3.0.0",
     "abortable-iterator": "^3.0.0",
-    "buffer": "^5.5.0",
+    "buffer": "^5.6.0",
     "chai": "^4.2.0",
     "chai-checkmark": "^1.0.1",
     "class-is": "^1.1.0",
-    "delay": "^4.3.0",
     "detect-node": "^2.0.4",
     "dirty-chai": "^2.0.1",
     "err-code": "^2.0.0",
@@ -47,17 +46,16 @@
     "it-pair": "^1.0.0",
     "it-pipe": "^1.0.1",
     "libp2p-tcp": "^0.14.1",
-    "multiaddr": "^7.1.0",
+    "multiaddr": "^7.4.3",
-    "p-defer": "^3.0.0",
+    "p-limit": "^2.3.0",
-    "p-limit": "^2.2.2",
     "p-wait-for": "^3.1.0",
-    "peer-id": "^0.13.3",
+    "peer-id": "^0.13.11",
     "peer-info": "^0.17.0",
-    "sinon": "^9.0.0",
+    "sinon": "^9.0.2",
     "streaming-iterables": "^4.1.0"
   },
   "devDependencies": {
-    "aegir": "^21.0.2",
+    "aegir": "^21.9.0",
     "it-handshake": "^1.0.1"
   },
   "contributors": [

src/peer-discovery/README.md

@@ -70,9 +70,6 @@ It returns a `Promise`
 
 ### discoverying peers
 
-- `discovery.on('peer', (peerData) => {})`
+- `discovery.on('peer', (peerInfo) => {})`
 
-Every time a peer is discovered by a discovery service, it emits a `peer` event with the discovered peer's information, which must contain the following properties:
+Everytime a peer is discovered by a discovery service, it emmits a `peer` event with the discover peer's [PeerInfo](https://github.com/libp2p/js-peer-info).
-
-- `<`[`PeerId`](https://github.com/libp2p/js-peer-id)`>` `peerData.id`
-- `<Array<`[`Multiaddr`](https://github.com/multiformats/js-multiaddr)`>>` `peerData.multiaddrs`

src/peer-discovery/tests/index.js

@@ -1,31 +1,17 @@
 /* eslint-env mocha */
 'use strict'
 
-const chai = require('chai')
-const expect = chai.expect
-chai.use(require('dirty-chai'))
-
-const multiaddr = require('multiaddr')
-const PeerId = require('peer-id')
-
-const delay = require('delay')
-const pDefer = require('p-defer')
-
 module.exports = (common) => {
   describe('interface-peer-discovery', () => {
     let discovery
 
-    beforeEach(async () => {
+    before(async () => {
       discovery = await common.setup()
     })
 
-    afterEach('ensure discovery was stopped', async () => {
+    after(() => common.teardown && common.teardown())
-      await discovery.stop()
 
-      discovery.removeAllListeners()
+    afterEach('ensure discovery was stopped', () => discovery.stop())
-
-      common.teardown && common.teardown()
-    })
 
     it('can start the service', async () => {
       await discovery.start()
@@ -44,49 +30,5 @@ module.exports = (common) => {
       await discovery.start()
       await discovery.start()
     })
-
-    it('should emit a peer event after start', async () => {
-      const defer = pDefer()
-      await discovery.start()
-
-      discovery.once('peer', ({ id, multiaddrs }) => {
-        expect(id).to.exist()
-        expect(PeerId.isPeerId(id)).to.eql(true)
-        expect(multiaddrs).to.exist()
-
-        multiaddrs.forEach((m) => expect(multiaddr.isMultiaddr(m)).to.eql(true))
-
-        defer.resolve()
-      })
-
-      await defer.promise
-    })
-
-    it('should not receive a peer event before start', async () => {
-      discovery.once('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()
-
-      await discovery.start()
-
-      discovery.once('peer', () => {
-        deferStart.resolve()
-      })
-
-      await deferStart.promise
-      await discovery.stop()
-
-      discovery.once('peer', () => {
-        throw new Error('should not receive a peer event after stop')
-      })
-
-      await delay(2000)
-    })
   })
 }

src/transport/tests/dial-test.js

@@ -31,8 +31,7 @@ module.exports = (common) => {
     }
   }
 
-  describe('dial', function () {
+  describe('dial', () => {
-    this.timeout(20 * 1000)
     let addrs
     let transport
     let connector
@@ -130,7 +129,7 @@ module.exports = (common) => {
       expect.fail('Did not throw error with code ' + AbortError.code)
     })
 
-    it.skip('abort while reading throws AbortError', async () => {
+    it('abort while reading throws AbortError', async () => {
       // Add a delay to the response from the server
       async function * delayedResponse (source) {
         for await (const val of source) {

src/transport/tests/listen-test.js

@@ -31,8 +31,7 @@ module.exports = (common) => {
     }
   }
 
-  describe('listen', function () {
+  describe('listen', () => {
-    this.timeout(20 * 1000)
     let addrs
     let transport
 
@@ -52,7 +51,7 @@ module.exports = (common) => {
       await listener.close()
     })
 
-    it.skip('close listener with connections, through timeout', async () => {
+    it('close listener with connections, through timeout', async () => {
       const upgradeSpy = sinon.spy(upgrader, 'upgradeInbound')
       const listenerConns = []
 

test/peer-discovery/compliance.spec.js

@@ -5,20 +5,13 @@ const tests = require('../../src/peer-discovery/tests')
 const MockDiscovery = require('./mock-discovery')
 
 describe('compliance tests', () => {
-  let intervalId
-
   tests({
-    setup () {
+    async setup () {
-      const mockDiscovery = new MockDiscovery({
+      await new Promise(resolve => setTimeout(resolve, 10))
-        discoveryDelay: 1
+      return new MockDiscovery()
-      })
-
-      intervalId = setInterval(mockDiscovery._discoverPeer, 1000)
-
-      return mockDiscovery
     },
-    teardown () {
+    async teardown () {
-      clearInterval(intervalId)
+      await new Promise(resolve => setTimeout(resolve, 10))
     }
   })
 })

test/peer-discovery/mock-discovery.js

@@ -2,8 +2,8 @@
 
 const { EventEmitter } = require('events')
 
-const multiaddr = require('multiaddr')
 const PeerId = require('peer-id')
+const PeerInfo = require('peer-info')
 
 /**
  * Emits 'peer' events on discovery.
@@ -37,12 +37,10 @@ class MockDiscovery extends EventEmitter {
     if (!this._isRunning) return
 
     const peerId = await PeerId.create({ bits: 512 })
+    const peerInfo = new PeerInfo(peerId)
 
     this._timer = setTimeout(() => {
-      this.emit('peer', {
+      this.emit('peer', peerInfo)
-        id: peerId,
-        multiaddrs: [multiaddr('/ip4/127.0.0.1/tcp/8000')]
-      })
     }, this.options.discoveryDelay || 1000)
   }
 }