Compare commits

..

22 Commits

Author SHA1 Message Date
82ed140b42 chore: skip abort while reading for webrtc 2020-08-11 15:18:43 +02:00
13aa6cbfa0 chore: release version v0.4.0 2020-08-10 12:36:11 +02:00
a8ba13da4b chore: update contributors 2020-08-10 12:36:11 +02:00
75f6777d89 chore: update deps (#57)
* chore: update deps

Pulls in latest peer id with Uint8Arrays

BREAKING CHANGES:

- The peer id dep of this module has replaced node Buffers with Uint8Arrays

* chore: update gh deps
2020-08-10 12:23:45 +02:00
71b813ad3b chore: release version v0.3.2 2020-07-15 12:57:26 +02:00
46589ce3d0 chore: update contributors 2020-07-15 12:57:25 +02:00
f2a18818f2 chore: update deps (#55)
* chore: update deps

* chore: remove unused peer-info dep
2020-07-15 12:56:37 +02:00
1cc943e1b2 feat: record interface (#52)
* feat: record interface

* chore: add readme reference

* chore: address review
2020-07-15 12:29:36 +02:00
4adedcc4bf chore: release version v0.3.1 2020-07-03 15:51:41 +02:00
0628d708c4 chore: update contributors 2020-07-03 15:51:41 +02:00
e10a1545c8 fix: reconnect should trigger topology on connect if protocol stored (#54)
* fix: reconnect should trigger topology on connect if protocol stored

* chore: address review
2020-07-03 15:48:12 +02:00
9fbf9d0331 fix: content and peer routing multiaddrs property (#49) 2020-06-05 16:12:33 +02:00
aa996d2054 chore: release version v0.3.0 2020-06-05 16:12:33 +02:00
507013a724 chore: update contributors 2020-06-05 16:12:33 +02:00
a55c7c454a chore: remove peer-info usage on topology (#42)
* chore: remove peer-info usage on topology

BREAKING CHANGE: topology api now uses peer-id instead of peer-info
2020-06-05 16:12:33 +02:00
87e2e89791 chore: update content and peer routing interfaces removing peer-info (#43)
* chore: update content and peer routing interfaces removing peer-info

BREAKING CHANGE: content-routing and peer-routing APIs return an object with relevant properties instead of peer-info
2020-06-05 16:12:33 +02:00
5bcfc966f7 chore: discovery should not use once (#45) 2020-06-05 16:12:33 +02:00
c8c249de6e chore: apply suggestions from code review
Co-Authored-By: Jacob Heun <jacobheun@gmail.com>
2020-06-05 16:12:33 +02:00
5b138ef0a0 chore: add tests for peer-discovery 2020-06-05 16:12:33 +02:00
bdd2502ef6 feat: peer-discovery not using peer-info
BREAKING CHANGE: peer-discovery emits object with id and multiaddrs properties
2020-06-05 16:12:33 +02:00
1bef8d5d78 chore(deps-dev): bump aegir from 21.10.2 to 22.0.0 (#50)
Bumps [aegir](https://github.com/ipfs/aegir) from 21.10.2 to 22.0.0.
- [Release notes](https://github.com/ipfs/aegir/releases)
- [Changelog](https://github.com/ipfs/aegir/blob/master/CHANGELOG.md)
- [Commits](https://github.com/ipfs/aegir/compare/v21.10.2...v22.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
2020-05-08 10:52:10 +02:00
9a8f375d40 fix: peer-routing typo (#47) 2020-04-22 15:30:59 +02:00
21 changed files with 498 additions and 89 deletions

View File

@ -1,3 +1,83 @@
<a name="0.4.0"></a>
# [0.4.0](https://github.com/libp2p/js-interfaces/compare/v0.3.2...v0.4.0) (2020-08-10)
### Chores
* update deps ([#57](https://github.com/libp2p/js-interfaces/issues/57)) ([75f6777](https://github.com/libp2p/js-interfaces/commit/75f6777))
### BREAKING CHANGES
* - The peer id dep of this module has replaced node Buffers with Uint8Arrays
* chore: update gh deps
<a name="0.3.2"></a>
## [0.3.2](https://github.com/libp2p/js-interfaces/compare/v0.3.1...v0.3.2) (2020-07-15)
### Features
* record interface ([#52](https://github.com/libp2p/js-interfaces/issues/52)) ([1cc943e](https://github.com/libp2p/js-interfaces/commit/1cc943e))
<a name="0.3.1"></a>
## [0.3.1](https://github.com/libp2p/js-interfaces/compare/v0.2.8...v0.3.1) (2020-07-03)
### Bug Fixes
* content and peer routing multiaddrs property ([#49](https://github.com/libp2p/js-interfaces/issues/49)) ([9fbf9d0](https://github.com/libp2p/js-interfaces/commit/9fbf9d0))
* peer-routing typo ([#47](https://github.com/libp2p/js-interfaces/issues/47)) ([9a8f375](https://github.com/libp2p/js-interfaces/commit/9a8f375))
* reconnect should trigger topology on connect if protocol stored ([#54](https://github.com/libp2p/js-interfaces/issues/54)) ([e10a154](https://github.com/libp2p/js-interfaces/commit/e10a154))
### Chores
* remove peer-info usage on topology ([#42](https://github.com/libp2p/js-interfaces/issues/42)) ([a55c7c4](https://github.com/libp2p/js-interfaces/commit/a55c7c4))
* update content and peer routing interfaces removing peer-info ([#43](https://github.com/libp2p/js-interfaces/issues/43)) ([87e2e89](https://github.com/libp2p/js-interfaces/commit/87e2e89))
### Features
* peer-discovery not using peer-info ([bdd2502](https://github.com/libp2p/js-interfaces/commit/bdd2502))
### BREAKING CHANGES
* topology api now uses peer-id instead of peer-info
* content-routing and peer-routing APIs return an object with relevant properties instead of peer-info
* peer-discovery emits object with id and multiaddrs properties
<a name="0.3.0"></a>
# [0.3.0](https://github.com/libp2p/js-interfaces/compare/v0.2.8...v0.3.0) (2020-04-21)
### Chores
* remove peer-info usage on topology ([#42](https://github.com/libp2p/js-interfaces/issues/42)) ([79a7843](https://github.com/libp2p/js-interfaces/commit/79a7843))
* update content and peer routing interfaces removing peer-info ([#43](https://github.com/libp2p/js-interfaces/issues/43)) ([d2032e6](https://github.com/libp2p/js-interfaces/commit/d2032e6))
### Features
* peer-discovery not using peer-info ([5792b13](https://github.com/libp2p/js-interfaces/commit/5792b13))
### BREAKING CHANGES
* topology api now uses peer-id instead of peer-info
* content-routing and peer-routing APIs return an object with relevant properties instead of peer-info
* peer-discovery emits object with id and multiaddrs properties
<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)

View File

@ -18,6 +18,7 @@
- [Crypto](./src/crypto)
- [Peer Discovery](./src/peer-discovery)
- [Peer Routing](./src/peer-routing)
- [Record](./src/record)
- [Stream Muxer](./src/stream-muxer)
- [Topology](./src/topology)
- [Transport](./src/transport)

View File

@ -1,6 +1,6 @@
{
"name": "libp2p-interfaces",
"version": "0.2.8",
"version": "0.4.0",
"description": "Interfaces for JS Libp2p",
"leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
"main": "src/index.js",
@ -39,23 +39,24 @@
"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",
"it-goodbye": "^2.0.1",
"it-pair": "^1.0.0",
"it-pipe": "^1.0.1",
"libp2p-tcp": "^0.14.1",
"multiaddr": "^7.4.3",
"it-pipe": "^1.1.0",
"libp2p-tcp": "^0.14.5",
"multiaddr": "^8.0.0",
"p-defer": "^3.0.0",
"p-limit": "^2.3.0",
"p-wait-for": "^3.1.0",
"peer-id": "^0.13.11",
"peer-info": "^0.17.0",
"peer-id": "^0.14.0",
"sinon": "^9.0.2",
"streaming-iterables": "^4.1.0"
"streaming-iterables": "^5.0.2"
},
"devDependencies": {
"aegir": "^21.9.0",
"aegir": "^25.0.0",
"it-handshake": "^1.0.1"
},
"contributors": [

View File

@ -30,6 +30,32 @@ TBD
A valid (read: that follows this abstraction) Content Routing module must implement the following API.
### `.findProviders`
### findProviders
### `.provide`
- `findProviders(cid)`
Find peers in the network that can provide a specific value, given a key.
**Parameters**
- [CID](https://github.com/multiformats/js-cid)
**Returns**
It returns an `AsyncIterable` containing the identification and addresses of the peers providing the given key, as follows:
`AsyncIterable<{ id: PeerId, multiaddrs: Multiaddr[] }>`
### provide
- `provide(cid)`
Announce to the network that we are providing the given value.
**Parameters**
- [CID](https://github.com/multiformats/js-cid)
**Returns**
It returns a promise that is resolved on the success of the operation.
`Promise<void>`

View File

@ -70,6 +70,9 @@ It returns a `Promise`
### discoverying peers
- `discovery.on('peer', (peerInfo) => {})`
- `discovery.on('peer', (peerData) => {})`
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).
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:
- `<`[`PeerId`](https://github.com/libp2p/js-peer-id)`>` `peerData.id`
- `<Array<`[`Multiaddr`](https://github.com/multiformats/js-multiaddr)`>>` `peerData.multiaddrs`

View File

@ -1,17 +1,31 @@
/* 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
before(async () => {
beforeEach(async () => {
discovery = await common.setup()
})
after(() => common.teardown && common.teardown())
afterEach('ensure discovery was stopped', async () => {
await discovery.stop()
afterEach('ensure discovery was stopped', () => discovery.stop())
discovery.removeAllListeners()
common.teardown && common.teardown()
})
it('can start the service', async () => {
await discovery.start()
@ -30,5 +44,49 @@ 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.on('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.on('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.on('peer', () => {
deferStart.resolve()
})
await deferStart.promise
await discovery.stop()
discovery.on('peer', () => {
throw new Error('should not receive a peer event after stop')
})
await delay(2000)
})
})
}

View File

@ -30,12 +30,17 @@ TBD
A valid (read: that follows this abstraction) Peer Routing module must implement the following API.
### `.findPeers` - Find peers 'responsible' or 'closest' to a given key
### findPeer
- `Node.js` peerRouting.findPeers(key, function (err, peersPriorityQueue) {})
- `findPeer(peerId)`
In a peer to peer context, the concept of 'responsability' or 'closeness' for a given key translates to having a way to find deterministically or that at least there is a significant overlap between searches, the same group of peers when searching for the same given key.
Query the network for all multiaddresses associated with a `PeerId`.
This method will query the network (route it) and return a Priority Queue datastructe with a list of PeerInfo objects, ordered by 'closeness'.
**Parameters**
- [peerId](https://github.com/libp2p/js-peer-id).
key is a multihash
**Returns**
It returns the [peerId](https://github.com/libp2p/js-peer-id) together with the known peers [multiaddrs](https://github.com/multiformats/js-multiaddr), as follows:
`Promise<{ id: PeerId, multiaddrs: Multiaddr[] }>`

75
src/record/README.md Normal file
View File

@ -0,0 +1,75 @@
interface-record
==================
A libp2p node needs to store data in a public location (e.g. a DHT), or rely on potentially untrustworthy intermediaries to relay information. Libp2p provides an all-purpose data container called **envelope**, which includes a signature of the data, so that it its authenticity can be verified.
The record represents the data that will be stored inside the **envelope** when distributing records across the network. The `interface-record` aims to guarantee that any type of record created is compliant with the libp2p **envelope**.
Taking into account that a record might be used in different contexts, an **envelope** signature made for a specific purpose **must not** be considered valid for a different purpose. Accordingly, each record has a short and descriptive string representing the record use case, known as **domain**. The data to be signed will be prepended with the domain string, in order to create a domain signature.
A record can also contain a Buffer codec (ideally registered as a [multicodec](https://github.com/multiformats/multicodec)). This codec will prefix the record data in the **envelope** , so that it can be deserialized deterministically.
## Usage
```js
const tests = require('libp2p-interfaces/src/record/tests')
describe('your record', () => {
tests({
async setup () {
return YourRecord
},
async teardown () {
// cleanup resources created by setup()
}
})
})
```
## Create Record
```js
const multicodec = require('multicodec')
const Record = require('libp2p-interfaces/src/record')
// const Protobuf = require('./record.proto')
const ENVELOPE_DOMAIN_PEER_RECORD = 'libp2p-peer-record'
const ENVELOPE_PAYLOAD_TYPE_PEER_RECORD = Buffer.from('0301', 'hex')
class PeerRecord extends Record {
constructor (peerId, multiaddrs, seqNumber) {
super (ENVELOPE_DOMAIN_PEER_RECORD, ENVELOPE_PAYLOAD_TYPE_PEER_RECORD)
}
marshal () {
// Implement and return using Protobuf
}
equals (other) {
// Verify
}
}
```
## API
### marshal
- `record.marshal()`
Marshal a record to be used in a libp2p envelope.
**Returns**
It returns a `Protobuf` containing the record data.
### equals
- `record.equals(other)`
Verifies if the other Record is identical to this one.
**Parameters**
- other is a `Record` to compare with the current instance.
**Returns**
- `boolean`

35
src/record/index.js Normal file
View File

@ -0,0 +1,35 @@
'use strict'
const errcode = require('err-code')
/**
* Record is the base implementation of a record that can be used as the payload of a libp2p envelope.
*/
class Record {
/**
* @constructor
* @param {String} domain signature domain
* @param {Buffer} codec identifier of the type of record
*/
constructor (domain, codec) {
this.domain = domain
this.codec = codec
}
/**
* Marshal a record to be used in an envelope.
*/
marshal () {
throw errcode(new Error('marshal must be implemented by the subclass'), 'ERR_NOT_IMPLEMENTED')
}
/**
* Verifies if the other provided Record is identical to this one.
* @param {Record} other
*/
equals (other) {
throw errcode(new Error('equals must be implemented by the subclass'), 'ERR_NOT_IMPLEMENTED')
}
}
module.exports = Record

35
src/record/tests/index.js Normal file
View File

@ -0,0 +1,35 @@
/* eslint-env mocha */
'use strict'
const chai = require('chai')
const expect = chai.expect
chai.use(require('dirty-chai'))
module.exports = (test) => {
describe('record', () => {
let record
beforeEach(async () => {
record = await test.setup()
if (!record) throw new Error('missing record')
})
afterEach(() => test.teardown())
it('has domain and codec', () => {
expect(record.domain).to.exist()
expect(record.codec).to.exist()
})
it('is able to marshal', () => {
const rawData = record.marshal()
expect(Buffer.isBuffer(rawData)).to.eql(true)
})
it('is able to compare two records', () => {
const equals = record.equals(record)
expect(equals).to.eql(true)
})
})
}

View File

@ -56,8 +56,8 @@ const toplogy = new MulticodecTopology({
max: 50,
multicodecs: ['/echo/1.0.0'],
handlers: {
onConnect: (peerInfo, conn) => {},
onDisconnect: (peerInfo) => {}
onConnect: (peerId, conn) => {},
onDisconnect: (peerId) => {}
}
})
```
@ -69,8 +69,8 @@ The `MulticodecTopology` extends the `Topology`, which makes the `Topology` API
### Topology
- `Topology`
- `peers<Map<string, PeerInfo>>`: A Map of peers belonging to the topology.
- `disconnect<function(PeerInfo)>`: Called when a peer has been disconnected
- `peers<Map<string, PeerId>>`: A Map of peers belonging to the topology.
- `disconnect<function(PeerId)>`: Called when a peer has been disconnected
#### Constructor
@ -79,8 +79,8 @@ const toplogy = new Topology({
min: 0,
max: 50,
handlers: {
onConnect: (peerInfo, conn) => {},
onDisconnect: (peerInfo) => {}
onConnect: (peerId, conn) => {},
onDisconnect: (peerId) => {}
}
})
```
@ -95,27 +95,27 @@ const toplogy = new Topology({
#### Set a peer
- `topology.peers.set(id, peerInfo)`
- `topology.peers.set(id, peerId)`
Add a peer to the topology.
**Parameters**
- `id` is the `string` that identifies the peer to add.
- `peerInfo` is the [PeerInfo][peer-info] of the peer to add.
- `peerId` is the [PeerId][peer-id] of the peer to add.
#### Notify about a peer disconnected event
- `topology.disconnect(peerInfo)`
- `topology.disconnect(peerId)`
**Parameters**
- `peerInfo` is the [PeerInfo][peer-info] of the peer disconnected.
- `peerId` is the [PeerId][peer-id] of the peer disconnected.
### Multicodec Topology
- `MulticodecTopology`
- `registrar<Registrar>`: The `Registrar` of the topology. This is set by the `Registrar` during registration.
- `peers<Map<string, PeerInfo>>`: The Map of peers that belong to the topology
- `disconnect<function(PeerInfo)>`: Disconnects a peer from the topology.
- `peers<Map<string, PeerId>>`: The Map of peers that belong to the topology
- `disconnect<function(PeerId)>`: Disconnects a peer from the topology.
#### Constructor
@ -125,8 +125,8 @@ const toplogy = new MulticodecTopology({
max: 50,
multicodecs: ['/echo/1.0.0'],
handlers: {
onConnect: (peerInfo, conn) => {},
onDisconnect: (peerInfo) => {}
onConnect: (peerId, conn) => {},
onDisconnect: (peerId) => {}
}
})
```
@ -139,3 +139,5 @@ const toplogy = new MulticodecTopology({
- `handlers` is an optional `Object` containing the handler called when a peer is connected or disconnected.
- `onConnect` is a `function` called everytime a peer is connected in the topology context.
- `onDisconnect` is a `function` called everytime a peer is disconnected in the topology context.
[peer-id]: https://github.com/libp2p/js-peer-id

View File

@ -26,7 +26,11 @@ class Topology {
this._onConnect = handlers.onConnect || noop
this._onDisconnect = handlers.onDisconnect || noop
this.peers = new Map()
/**
* Set of peers that support the protocol.
* @type {Set<string>}
*/
this.peers = new Set()
}
set registrar (registrar) {
@ -35,11 +39,11 @@ class Topology {
/**
* Notify about peer disconnected event.
* @param {PeerInfo} peerInfo
* @param {PeerId} peerId
* @returns {void}
*/
disconnect (peerInfo) {
this._onDisconnect(peerInfo)
disconnect (peerId) {
this._onDisconnect(peerId)
}
}

View File

@ -43,11 +43,13 @@ class MulticodecTopology extends Topology {
this._registrar = undefined
this._onProtocolChange = this._onProtocolChange.bind(this)
this._onPeerConnect = this._onPeerConnect.bind(this)
}
set registrar (registrar) {
this._registrar = registrar
this._registrar.peerStore.on('change:protocols', this._onProtocolChange)
this._registrar.connectionManager.on('peer:connect', this._onPeerConnect)
// Update topology peers
this._updatePeers(this._registrar.peerStore.peers.values())
@ -55,20 +57,20 @@ class MulticodecTopology extends Topology {
/**
* Update topology.
* @param {Array<PeerInfo>} peerInfoIterable
* @param {Array<{id: PeerId, multiaddrs: Array<Multiaddr>, protocols: Array<string>}>} peerDataIterable
* @returns {void}
*/
_updatePeers (peerInfoIterable) {
for (const peerInfo of peerInfoIterable) {
if (this.multicodecs.filter(multicodec => peerInfo.protocols.has(multicodec)).length) {
_updatePeers (peerDataIterable) {
for (const { id, protocols } of peerDataIterable) {
if (this.multicodecs.filter(multicodec => protocols.includes(multicodec)).length) {
// Add the peer regardless of whether or not there is currently a connection
this.peers.set(peerInfo.id.toB58String(), peerInfo)
this.peers.add(id.toB58String())
// If there is a connection, call _onConnect
const connection = this._registrar.getConnection(peerInfo)
connection && this._onConnect(peerInfo, connection)
const connection = this._registrar.getConnection(id)
connection && this._onConnect(id, connection)
} else {
// Remove any peers we might be tracking that are no longer of value to us
this.peers.delete(peerInfo.id.toB58String())
this.peers.delete(id.toB58String())
}
}
}
@ -76,26 +78,46 @@ class MulticodecTopology extends Topology {
/**
* Check if a new peer support the multicodecs for this topology.
* @param {Object} props
* @param {PeerInfo} props.peerInfo
* @param {PeerId} props.peerId
* @param {Array<string>} props.protocols
*/
_onProtocolChange ({ peerInfo, protocols }) {
const existingPeer = this.peers.get(peerInfo.id.toB58String())
_onProtocolChange ({ peerId, protocols }) {
const hadPeer = this.peers.has(peerId.toB58String())
const hasProtocol = protocols.filter(protocol => this.multicodecs.includes(protocol))
// Not supporting the protocol anymore?
if (existingPeer && hasProtocol.length === 0) {
this._onDisconnect(peerInfo)
if (hadPeer && hasProtocol.length === 0) {
this._onDisconnect(peerId)
}
// New to protocol support
for (const protocol of protocols) {
if (this.multicodecs.includes(protocol)) {
this._updatePeers([peerInfo])
const peerData = this._registrar.peerStore.get(peerId)
this._updatePeers([peerData])
return
}
}
}
/**
* Verify if a new connected peer has a topology multicodec and call _onConnect.
* @param {Connection} connection
* @returns {void}
*/
_onPeerConnect (connection) {
const peerId = connection.remotePeer
const protocols = this._registrar.peerStore.protoBook.get(peerId)
if (!protocols) {
return
}
if (this.multicodecs.find(multicodec => protocols.includes(multicodec))) {
this.peers.add(peerId.toB58String())
this._onConnect(peerId, connection)
}
}
}
module.exports = withIs(MulticodecTopology, { className: 'MulticodecTopology', symbolName: '@libp2p/js-interfaces/topology/multicodec-topology' })

View File

@ -8,19 +8,18 @@ chai.use(require('dirty-chai'))
const sinon = require('sinon')
const PeerId = require('peer-id')
const PeerInfo = require('peer-info')
const peers = require('../../utils/peers')
module.exports = (test) => {
describe('multicodec topology', () => {
let topology, peer
let topology, id
beforeEach(async () => {
topology = await test.setup()
if (!topology) throw new Error('missing multicodec topology')
const id = await PeerId.createFromJSON(peers[0])
peer = await PeerInfo.create(id)
id = await PeerId.createFromJSON(peers[0])
})
afterEach(async () => {
@ -38,7 +37,7 @@ module.exports = (test) => {
it('should trigger "onDisconnect" on peer disconnected', () => {
sinon.spy(topology, '_onDisconnect')
topology.disconnect(peer)
topology.disconnect(id)
expect(topology._onDisconnect.callCount).to.equal(1)
})
@ -47,13 +46,16 @@ module.exports = (test) => {
sinon.spy(topology, '_updatePeers')
expect(topology.peers.size).to.eql(0)
const id2 = await PeerId.createFromJSON(peers[1])
const peer2 = await PeerInfo.create(id2)
topology.multicodecs.forEach((m) => peer2.protocols.add(m))
const peerStore = topology._registrar.peerStore
const id2 = await PeerId.createFromJSON(peers[1])
peerStore.peers.set(id2.toB58String(), {
id: id2,
protocols: Array.from(topology.multicodecs)
})
peerStore.emit('change:protocols', {
peerInfo: peer2,
peerId: id2,
protocols: Array.from(topology.multicodecs)
})
@ -65,28 +67,67 @@ module.exports = (test) => {
sinon.spy(topology, '_onDisconnect')
expect(topology.peers.size).to.eql(0)
const id2 = await PeerId.createFromJSON(peers[1])
const peer2 = await PeerInfo.create(id2)
topology.multicodecs.forEach((m) => peer2.protocols.add(m))
const peerStore = topology._registrar.peerStore
const id2 = await PeerId.createFromJSON(peers[1])
peerStore.peers.set(id2.toB58String(), {
id: id2,
protocols: Array.from(topology.multicodecs)
})
peerStore.emit('change:protocols', {
peerInfo: peer2,
peerId: id2,
protocols: Array.from(topology.multicodecs)
})
expect(topology.peers.size).to.eql(1)
topology.multicodecs.forEach((m) => peer2.protocols.delete(m))
peerStore.peers.set(id2.toB58String(), {
id: id2,
protocols: []
})
// Peer does not support the protocol anymore
peerStore.emit('change:protocols', {
peerInfo: peer2,
peerId: id2,
protocols: []
})
expect(topology.peers.size).to.eql(1)
expect(topology._onDisconnect.callCount).to.equal(1)
expect(topology._onDisconnect.calledWith(peer2)).to.equal(true)
expect(topology._onDisconnect.calledWith(id2)).to.equal(true)
})
it('should trigger "onConnect" when a peer connects and has one of the topology multicodecs in its known protocols', () => {
sinon.spy(topology, '_onConnect')
sinon.stub(topology._registrar.peerStore.protoBook, 'get').returns(topology.multicodecs)
topology._registrar.connectionManager.emit('peer:connect', {
remotePeer: id
})
expect(topology._onConnect.callCount).to.equal(1)
})
it('should not trigger "onConnect" when a peer connects and has none of the topology multicodecs in its known protocols', () => {
sinon.spy(topology, '_onConnect')
sinon.stub(topology._registrar.peerStore.protoBook, 'get').returns([])
topology._registrar.connectionManager.emit('peer:connect', {
remotePeer: id
})
expect(topology._onConnect.callCount).to.equal(0)
})
it('should not trigger "onConnect" when a peer connects and its protocols are not known', () => {
sinon.spy(topology, '_onConnect')
sinon.stub(topology._registrar.peerStore.protoBook, 'get').returns(undefined)
topology._registrar.connectionManager.emit('peer:connect', {
remotePeer: id
})
expect(topology._onConnect.callCount).to.equal(0)
})
})
}

View File

@ -8,19 +8,17 @@ chai.use(require('dirty-chai'))
const sinon = require('sinon')
const PeerId = require('peer-id')
const PeerInfo = require('peer-info')
const peers = require('../../utils/peers')
module.exports = (test) => {
describe('topology', () => {
let topology, peer
let topology, id
beforeEach(async () => {
topology = await test.setup()
if (!topology) throw new Error('missing multicodec topology')
const id = await PeerId.createFromJSON(peers[0])
peer = await PeerInfo.create(id)
id = await PeerId.createFromJSON(peers[0])
})
afterEach(async () => {
@ -38,7 +36,7 @@ module.exports = (test) => {
it('should trigger "onDisconnect" on peer disconnected', () => {
sinon.spy(topology, '_onDisconnect')
topology.disconnect(peer)
topology.disconnect(id)
expect(topology._onDisconnect.callCount).to.equal(1)
})

View File

@ -31,7 +31,8 @@ module.exports = (common) => {
}
}
describe('dial', () => {
describe('dial', function () {
this.timeout(20 * 1000)
let addrs
let transport
let connector
@ -129,7 +130,7 @@ module.exports = (common) => {
expect.fail('Did not throw error with code ' + AbortError.code)
})
it('abort while reading throws AbortError', async () => {
it.skip('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) {

View File

@ -31,7 +31,8 @@ module.exports = (common) => {
}
}
describe('listen', () => {
describe('listen', function () {
this.timeout(20 * 1000)
let addrs
let transport
@ -51,7 +52,7 @@ module.exports = (common) => {
await listener.close()
})
it('close listener with connections, through timeout', async () => {
it.skip('close listener with connections, through timeout', async () => {
const upgradeSpy = sinon.spy(upgrader, 'upgradeInbound')
const listenerConns = []
@ -94,7 +95,7 @@ module.exports = (common) => {
expect(upgradeSpy.callCount).to.equal(2)
})
it('should not handle connection if upgradeInbound throws', async () => {
it.skip('should not handle connection if upgradeInbound throws', async () => {
sinon.stub(upgrader, 'upgradeInbound').throws()
const listener = transport.createListener(() => {

View File

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

View File

@ -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,10 +37,12 @@ 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', peerInfo)
this.emit('peer', {
id: peerId,
multiaddrs: [multiaddr('/ip4/127.0.0.1/tcp/8000')]
})
}, this.options.discoveryDelay || 1000)
}
}

View File

@ -6,6 +6,13 @@ class MockPeerStore extends EventEmitter {
constructor (peers) {
super()
this.peers = peers
this.protoBook = {
get: () => {}
}
}
get (peerId) {
return this.peers.get(peerId.toB58String())
}
}

View File

@ -1,6 +1,8 @@
/* eslint-env mocha */
'use strict'
const { EventEmitter } = require('events')
const tests = require('../../src/topology/tests/multicodec-topology')
const MulticodecTopology = require('../../src/topology/multicodec-topology')
const MockPeerStore = require('./mock-peer-store')
@ -21,10 +23,13 @@ describe('multicodec topology compliance tests', () => {
})
if (!registrar) {
const peerStore = new MockPeerStore([])
const peers = new Map()
const peerStore = new MockPeerStore(peers)
const connectionManager = new EventEmitter()
registrar = {
peerStore,
connectionManager,
getConnection: () => { }
}
}