mirror of
https://github.com/fluencelabs/js-libp2p-interfaces
synced 2025-07-07 17:41:43 +00:00
Compare commits
17 Commits
chore/skip
...
v0.3.1
Author | SHA1 | Date | |
---|---|---|---|
4adedcc4bf | |||
0628d708c4 | |||
e10a1545c8 | |||
9fbf9d0331 | |||
aa996d2054 | |||
507013a724 | |||
a55c7c454a | |||
87e2e89791 | |||
5bcfc966f7 | |||
c8c249de6e | |||
5b138ef0a0 | |||
bdd2502ef6 | |||
1bef8d5d78 | |||
9a8f375d40 | |||
afc2aa6891 | |||
424a0c081e | |||
e824b15032 |
58
CHANGELOG.md
58
CHANGELOG.md
@ -1,3 +1,61 @@
|
|||||||
|
<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)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.2.7"></a>
|
<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)
|
## [0.2.7](https://github.com/libp2p/js-interfaces/compare/v0.2.6...v0.2.7) (2020-03-20)
|
||||||
|
|
||||||
|
14
package.json
14
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "libp2p-interfaces",
|
"name": "libp2p-interfaces",
|
||||||
"version": "0.2.7",
|
"version": "0.3.1",
|
||||||
"description": "Interfaces for JS Libp2p",
|
"description": "Interfaces for JS Libp2p",
|
||||||
"leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
|
"leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
|
||||||
"main": "src/index.js",
|
"main": "src/index.js",
|
||||||
@ -35,7 +35,7 @@
|
|||||||
"dependencies": {
|
"dependencies": {
|
||||||
"abort-controller": "^3.0.0",
|
"abort-controller": "^3.0.0",
|
||||||
"abortable-iterator": "^3.0.0",
|
"abortable-iterator": "^3.0.0",
|
||||||
"buffer": "^5.5.0",
|
"buffer": "^5.6.0",
|
||||||
"chai": "^4.2.0",
|
"chai": "^4.2.0",
|
||||||
"chai-checkmark": "^1.0.1",
|
"chai-checkmark": "^1.0.1",
|
||||||
"class-is": "^1.1.0",
|
"class-is": "^1.1.0",
|
||||||
@ -47,17 +47,17 @@
|
|||||||
"it-pair": "^1.0.0",
|
"it-pair": "^1.0.0",
|
||||||
"it-pipe": "^1.0.1",
|
"it-pipe": "^1.0.1",
|
||||||
"libp2p-tcp": "^0.14.1",
|
"libp2p-tcp": "^0.14.1",
|
||||||
"multiaddr": "^7.1.0",
|
"multiaddr": "^7.4.3",
|
||||||
"p-defer": "^3.0.0",
|
"p-defer": "^3.0.0",
|
||||||
"p-limit": "^2.2.2",
|
"p-limit": "^2.3.0",
|
||||||
"p-wait-for": "^3.1.0",
|
"p-wait-for": "^3.1.0",
|
||||||
"peer-id": "^0.13.3",
|
"peer-id": "^0.13.11",
|
||||||
"peer-info": "^0.17.0",
|
"peer-info": "^0.17.0",
|
||||||
"sinon": "^9.0.0",
|
"sinon": "^9.0.2",
|
||||||
"streaming-iterables": "^4.1.0"
|
"streaming-iterables": "^4.1.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"aegir": "^21.0.2",
|
"aegir": "^22.0.0",
|
||||||
"it-handshake": "^1.0.1"
|
"it-handshake": "^1.0.1"
|
||||||
},
|
},
|
||||||
"contributors": [
|
"contributors": [
|
||||||
|
@ -30,6 +30,32 @@ TBD
|
|||||||
|
|
||||||
A valid (read: that follows this abstraction) Content Routing module must implement the following API.
|
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>`
|
||||||
|
@ -49,7 +49,7 @@ module.exports = (common) => {
|
|||||||
const defer = pDefer()
|
const defer = pDefer()
|
||||||
await discovery.start()
|
await discovery.start()
|
||||||
|
|
||||||
discovery.once('peer', ({ id, multiaddrs }) => {
|
discovery.on('peer', ({ id, multiaddrs }) => {
|
||||||
expect(id).to.exist()
|
expect(id).to.exist()
|
||||||
expect(PeerId.isPeerId(id)).to.eql(true)
|
expect(PeerId.isPeerId(id)).to.eql(true)
|
||||||
expect(multiaddrs).to.exist()
|
expect(multiaddrs).to.exist()
|
||||||
@ -63,7 +63,7 @@ module.exports = (common) => {
|
|||||||
})
|
})
|
||||||
|
|
||||||
it('should not receive a peer event before start', async () => {
|
it('should not receive a peer event before start', async () => {
|
||||||
discovery.once('peer', () => {
|
discovery.on('peer', () => {
|
||||||
throw new Error('should not receive a peer event before start')
|
throw new Error('should not receive a peer event before start')
|
||||||
})
|
})
|
||||||
|
|
||||||
@ -75,14 +75,14 @@ module.exports = (common) => {
|
|||||||
|
|
||||||
await discovery.start()
|
await discovery.start()
|
||||||
|
|
||||||
discovery.once('peer', () => {
|
discovery.on('peer', () => {
|
||||||
deferStart.resolve()
|
deferStart.resolve()
|
||||||
})
|
})
|
||||||
|
|
||||||
await deferStart.promise
|
await deferStart.promise
|
||||||
await discovery.stop()
|
await discovery.stop()
|
||||||
|
|
||||||
discovery.once('peer', () => {
|
discovery.on('peer', () => {
|
||||||
throw new Error('should not receive a peer event after stop')
|
throw new Error('should not receive a peer event after stop')
|
||||||
})
|
})
|
||||||
|
|
||||||
|
@ -30,12 +30,17 @@ TBD
|
|||||||
|
|
||||||
A valid (read: that follows this abstraction) Peer Routing module must implement the following API.
|
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[] }>`
|
||||||
|
@ -56,8 +56,8 @@ const toplogy = new MulticodecTopology({
|
|||||||
max: 50,
|
max: 50,
|
||||||
multicodecs: ['/echo/1.0.0'],
|
multicodecs: ['/echo/1.0.0'],
|
||||||
handlers: {
|
handlers: {
|
||||||
onConnect: (peerInfo, conn) => {},
|
onConnect: (peerId, conn) => {},
|
||||||
onDisconnect: (peerInfo) => {}
|
onDisconnect: (peerId) => {}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
@ -69,8 +69,8 @@ The `MulticodecTopology` extends the `Topology`, which makes the `Topology` API
|
|||||||
### Topology
|
### Topology
|
||||||
|
|
||||||
- `Topology`
|
- `Topology`
|
||||||
- `peers<Map<string, PeerInfo>>`: A Map of peers belonging to the topology.
|
- `peers<Map<string, PeerId>>`: A Map of peers belonging to the topology.
|
||||||
- `disconnect<function(PeerInfo)>`: Called when a peer has been disconnected
|
- `disconnect<function(PeerId)>`: Called when a peer has been disconnected
|
||||||
|
|
||||||
#### Constructor
|
#### Constructor
|
||||||
|
|
||||||
@ -79,8 +79,8 @@ const toplogy = new Topology({
|
|||||||
min: 0,
|
min: 0,
|
||||||
max: 50,
|
max: 50,
|
||||||
handlers: {
|
handlers: {
|
||||||
onConnect: (peerInfo, conn) => {},
|
onConnect: (peerId, conn) => {},
|
||||||
onDisconnect: (peerInfo) => {}
|
onDisconnect: (peerId) => {}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
```
|
```
|
||||||
@ -95,27 +95,27 @@ const toplogy = new Topology({
|
|||||||
|
|
||||||
#### Set a peer
|
#### Set a peer
|
||||||
|
|
||||||
- `topology.peers.set(id, peerInfo)`
|
- `topology.peers.set(id, peerId)`
|
||||||
|
|
||||||
Add a peer to the topology.
|
Add a peer to the topology.
|
||||||
|
|
||||||
**Parameters**
|
**Parameters**
|
||||||
- `id` is the `string` that identifies the peer to add.
|
- `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
|
#### Notify about a peer disconnected event
|
||||||
|
|
||||||
- `topology.disconnect(peerInfo)`
|
- `topology.disconnect(peerId)`
|
||||||
|
|
||||||
**Parameters**
|
**Parameters**
|
||||||
- `peerInfo` is the [PeerInfo][peer-info] of the peer disconnected.
|
- `peerId` is the [PeerId][peer-id] of the peer disconnected.
|
||||||
|
|
||||||
### Multicodec Topology
|
### Multicodec Topology
|
||||||
|
|
||||||
- `MulticodecTopology`
|
- `MulticodecTopology`
|
||||||
- `registrar<Registrar>`: The `Registrar` of the topology. This is set by the `Registrar` during registration.
|
- `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
|
- `peers<Map<string, PeerId>>`: The Map of peers that belong to the topology
|
||||||
- `disconnect<function(PeerInfo)>`: Disconnects a peer from the topology.
|
- `disconnect<function(PeerId)>`: Disconnects a peer from the topology.
|
||||||
|
|
||||||
#### Constructor
|
#### Constructor
|
||||||
|
|
||||||
@ -125,8 +125,8 @@ const toplogy = new MulticodecTopology({
|
|||||||
max: 50,
|
max: 50,
|
||||||
multicodecs: ['/echo/1.0.0'],
|
multicodecs: ['/echo/1.0.0'],
|
||||||
handlers: {
|
handlers: {
|
||||||
onConnect: (peerInfo, conn) => {},
|
onConnect: (peerId, conn) => {},
|
||||||
onDisconnect: (peerInfo) => {}
|
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.
|
- `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.
|
- `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.
|
- `onDisconnect` is a `function` called everytime a peer is disconnected in the topology context.
|
||||||
|
|
||||||
|
[peer-id]: https://github.com/libp2p/js-peer-id
|
||||||
|
@ -26,7 +26,11 @@ class Topology {
|
|||||||
this._onConnect = handlers.onConnect || noop
|
this._onConnect = handlers.onConnect || noop
|
||||||
this._onDisconnect = handlers.onDisconnect || 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) {
|
set registrar (registrar) {
|
||||||
@ -35,11 +39,11 @@ class Topology {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Notify about peer disconnected event.
|
* Notify about peer disconnected event.
|
||||||
* @param {PeerInfo} peerInfo
|
* @param {PeerId} peerId
|
||||||
* @returns {void}
|
* @returns {void}
|
||||||
*/
|
*/
|
||||||
disconnect (peerInfo) {
|
disconnect (peerId) {
|
||||||
this._onDisconnect(peerInfo)
|
this._onDisconnect(peerId)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -43,11 +43,13 @@ class MulticodecTopology extends Topology {
|
|||||||
this._registrar = undefined
|
this._registrar = undefined
|
||||||
|
|
||||||
this._onProtocolChange = this._onProtocolChange.bind(this)
|
this._onProtocolChange = this._onProtocolChange.bind(this)
|
||||||
|
this._onPeerConnect = this._onPeerConnect.bind(this)
|
||||||
}
|
}
|
||||||
|
|
||||||
set registrar (registrar) {
|
set registrar (registrar) {
|
||||||
this._registrar = registrar
|
this._registrar = registrar
|
||||||
this._registrar.peerStore.on('change:protocols', this._onProtocolChange)
|
this._registrar.peerStore.on('change:protocols', this._onProtocolChange)
|
||||||
|
this._registrar.connectionManager.on('peer:connect', this._onPeerConnect)
|
||||||
|
|
||||||
// Update topology peers
|
// Update topology peers
|
||||||
this._updatePeers(this._registrar.peerStore.peers.values())
|
this._updatePeers(this._registrar.peerStore.peers.values())
|
||||||
@ -55,20 +57,20 @@ class MulticodecTopology extends Topology {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Update topology.
|
* Update topology.
|
||||||
* @param {Array<PeerInfo>} peerInfoIterable
|
* @param {Array<{id: PeerId, multiaddrs: Array<Multiaddr>, protocols: Array<string>}>} peerDataIterable
|
||||||
* @returns {void}
|
* @returns {void}
|
||||||
*/
|
*/
|
||||||
_updatePeers (peerInfoIterable) {
|
_updatePeers (peerDataIterable) {
|
||||||
for (const peerInfo of peerInfoIterable) {
|
for (const { id, protocols } of peerDataIterable) {
|
||||||
if (this.multicodecs.filter(multicodec => peerInfo.protocols.has(multicodec)).length) {
|
if (this.multicodecs.filter(multicodec => protocols.includes(multicodec)).length) {
|
||||||
// Add the peer regardless of whether or not there is currently a connection
|
// 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
|
// If there is a connection, call _onConnect
|
||||||
const connection = this._registrar.getConnection(peerInfo)
|
const connection = this._registrar.getConnection(id)
|
||||||
connection && this._onConnect(peerInfo, connection)
|
connection && this._onConnect(id, connection)
|
||||||
} else {
|
} else {
|
||||||
// Remove any peers we might be tracking that are no longer of value to us
|
// 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.
|
* Check if a new peer support the multicodecs for this topology.
|
||||||
* @param {Object} props
|
* @param {Object} props
|
||||||
* @param {PeerInfo} props.peerInfo
|
* @param {PeerId} props.peerId
|
||||||
* @param {Array<string>} props.protocols
|
* @param {Array<string>} props.protocols
|
||||||
*/
|
*/
|
||||||
_onProtocolChange ({ peerInfo, protocols }) {
|
_onProtocolChange ({ peerId, protocols }) {
|
||||||
const existingPeer = this.peers.get(peerInfo.id.toB58String())
|
const hadPeer = this.peers.has(peerId.toB58String())
|
||||||
const hasProtocol = protocols.filter(protocol => this.multicodecs.includes(protocol))
|
const hasProtocol = protocols.filter(protocol => this.multicodecs.includes(protocol))
|
||||||
|
|
||||||
// Not supporting the protocol anymore?
|
// Not supporting the protocol anymore?
|
||||||
if (existingPeer && hasProtocol.length === 0) {
|
if (hadPeer && hasProtocol.length === 0) {
|
||||||
this._onDisconnect(peerInfo)
|
this._onDisconnect(peerId)
|
||||||
}
|
}
|
||||||
|
|
||||||
// New to protocol support
|
// New to protocol support
|
||||||
for (const protocol of protocols) {
|
for (const protocol of protocols) {
|
||||||
if (this.multicodecs.includes(protocol)) {
|
if (this.multicodecs.includes(protocol)) {
|
||||||
this._updatePeers([peerInfo])
|
const peerData = this._registrar.peerStore.get(peerId)
|
||||||
|
this._updatePeers([peerData])
|
||||||
return
|
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' })
|
module.exports = withIs(MulticodecTopology, { className: 'MulticodecTopology', symbolName: '@libp2p/js-interfaces/topology/multicodec-topology' })
|
||||||
|
@ -8,19 +8,18 @@ chai.use(require('dirty-chai'))
|
|||||||
const sinon = require('sinon')
|
const sinon = require('sinon')
|
||||||
|
|
||||||
const PeerId = require('peer-id')
|
const PeerId = require('peer-id')
|
||||||
const PeerInfo = require('peer-info')
|
|
||||||
const peers = require('../../utils/peers')
|
const peers = require('../../utils/peers')
|
||||||
|
|
||||||
module.exports = (test) => {
|
module.exports = (test) => {
|
||||||
describe('multicodec topology', () => {
|
describe('multicodec topology', () => {
|
||||||
let topology, peer
|
let topology, id
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
topology = await test.setup()
|
topology = await test.setup()
|
||||||
if (!topology) throw new Error('missing multicodec topology')
|
if (!topology) throw new Error('missing multicodec topology')
|
||||||
|
|
||||||
const id = await PeerId.createFromJSON(peers[0])
|
id = await PeerId.createFromJSON(peers[0])
|
||||||
peer = await PeerInfo.create(id)
|
|
||||||
})
|
})
|
||||||
|
|
||||||
afterEach(async () => {
|
afterEach(async () => {
|
||||||
@ -38,7 +37,7 @@ module.exports = (test) => {
|
|||||||
|
|
||||||
it('should trigger "onDisconnect" on peer disconnected', () => {
|
it('should trigger "onDisconnect" on peer disconnected', () => {
|
||||||
sinon.spy(topology, '_onDisconnect')
|
sinon.spy(topology, '_onDisconnect')
|
||||||
topology.disconnect(peer)
|
topology.disconnect(id)
|
||||||
|
|
||||||
expect(topology._onDisconnect.callCount).to.equal(1)
|
expect(topology._onDisconnect.callCount).to.equal(1)
|
||||||
})
|
})
|
||||||
@ -47,13 +46,16 @@ module.exports = (test) => {
|
|||||||
sinon.spy(topology, '_updatePeers')
|
sinon.spy(topology, '_updatePeers')
|
||||||
expect(topology.peers.size).to.eql(0)
|
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 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', {
|
peerStore.emit('change:protocols', {
|
||||||
peerInfo: peer2,
|
peerId: id2,
|
||||||
protocols: Array.from(topology.multicodecs)
|
protocols: Array.from(topology.multicodecs)
|
||||||
})
|
})
|
||||||
|
|
||||||
@ -65,28 +67,67 @@ module.exports = (test) => {
|
|||||||
sinon.spy(topology, '_onDisconnect')
|
sinon.spy(topology, '_onDisconnect')
|
||||||
expect(topology.peers.size).to.eql(0)
|
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 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', {
|
peerStore.emit('change:protocols', {
|
||||||
peerInfo: peer2,
|
peerId: id2,
|
||||||
protocols: Array.from(topology.multicodecs)
|
protocols: Array.from(topology.multicodecs)
|
||||||
})
|
})
|
||||||
|
|
||||||
expect(topology.peers.size).to.eql(1)
|
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
|
// Peer does not support the protocol anymore
|
||||||
peerStore.emit('change:protocols', {
|
peerStore.emit('change:protocols', {
|
||||||
peerInfo: peer2,
|
peerId: id2,
|
||||||
protocols: []
|
protocols: []
|
||||||
})
|
})
|
||||||
|
|
||||||
expect(topology.peers.size).to.eql(1)
|
expect(topology.peers.size).to.eql(1)
|
||||||
expect(topology._onDisconnect.callCount).to.equal(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)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
@ -8,19 +8,17 @@ chai.use(require('dirty-chai'))
|
|||||||
const sinon = require('sinon')
|
const sinon = require('sinon')
|
||||||
|
|
||||||
const PeerId = require('peer-id')
|
const PeerId = require('peer-id')
|
||||||
const PeerInfo = require('peer-info')
|
|
||||||
const peers = require('../../utils/peers')
|
const peers = require('../../utils/peers')
|
||||||
|
|
||||||
module.exports = (test) => {
|
module.exports = (test) => {
|
||||||
describe('topology', () => {
|
describe('topology', () => {
|
||||||
let topology, peer
|
let topology, id
|
||||||
|
|
||||||
beforeEach(async () => {
|
beforeEach(async () => {
|
||||||
topology = await test.setup()
|
topology = await test.setup()
|
||||||
if (!topology) throw new Error('missing multicodec topology')
|
if (!topology) throw new Error('missing multicodec topology')
|
||||||
|
|
||||||
const id = await PeerId.createFromJSON(peers[0])
|
id = await PeerId.createFromJSON(peers[0])
|
||||||
peer = await PeerInfo.create(id)
|
|
||||||
})
|
})
|
||||||
|
|
||||||
afterEach(async () => {
|
afterEach(async () => {
|
||||||
@ -38,7 +36,7 @@ module.exports = (test) => {
|
|||||||
|
|
||||||
it('should trigger "onDisconnect" on peer disconnected', () => {
|
it('should trigger "onDisconnect" on peer disconnected', () => {
|
||||||
sinon.spy(topology, '_onDisconnect')
|
sinon.spy(topology, '_onDisconnect')
|
||||||
topology.disconnect(peer)
|
topology.disconnect(id)
|
||||||
|
|
||||||
expect(topology._onDisconnect.callCount).to.equal(1)
|
expect(topology._onDisconnect.callCount).to.equal(1)
|
||||||
})
|
})
|
||||||
|
@ -31,8 +31,7 @@ module.exports = (common) => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
describe('dial', function () {
|
describe('dial', () => {
|
||||||
this.timeout(20 * 1000)
|
|
||||||
let addrs
|
let addrs
|
||||||
let transport
|
let transport
|
||||||
let connector
|
let connector
|
||||||
@ -130,7 +129,7 @@ module.exports = (common) => {
|
|||||||
expect.fail('Did not throw error with code ' + AbortError.code)
|
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
|
// Add a delay to the response from the server
|
||||||
async function * delayedResponse (source) {
|
async function * delayedResponse (source) {
|
||||||
for await (const val of source) {
|
for await (const val of source) {
|
||||||
|
@ -31,8 +31,7 @@ module.exports = (common) => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
describe('listen', function () {
|
describe('listen', () => {
|
||||||
this.timeout(20 * 1000)
|
|
||||||
let addrs
|
let addrs
|
||||||
let transport
|
let transport
|
||||||
|
|
||||||
@ -52,7 +51,7 @@ module.exports = (common) => {
|
|||||||
await listener.close()
|
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 upgradeSpy = sinon.spy(upgrader, 'upgradeInbound')
|
||||||
const listenerConns = []
|
const listenerConns = []
|
||||||
|
|
||||||
|
@ -6,6 +6,13 @@ class MockPeerStore extends EventEmitter {
|
|||||||
constructor (peers) {
|
constructor (peers) {
|
||||||
super()
|
super()
|
||||||
this.peers = peers
|
this.peers = peers
|
||||||
|
this.protoBook = {
|
||||||
|
get: () => {}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
get (peerId) {
|
||||||
|
return this.peers.get(peerId.toB58String())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,6 +1,8 @@
|
|||||||
/* eslint-env mocha */
|
/* eslint-env mocha */
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
|
const { EventEmitter } = require('events')
|
||||||
|
|
||||||
const tests = require('../../src/topology/tests/multicodec-topology')
|
const tests = require('../../src/topology/tests/multicodec-topology')
|
||||||
const MulticodecTopology = require('../../src/topology/multicodec-topology')
|
const MulticodecTopology = require('../../src/topology/multicodec-topology')
|
||||||
const MockPeerStore = require('./mock-peer-store')
|
const MockPeerStore = require('./mock-peer-store')
|
||||||
@ -21,10 +23,13 @@ describe('multicodec topology compliance tests', () => {
|
|||||||
})
|
})
|
||||||
|
|
||||||
if (!registrar) {
|
if (!registrar) {
|
||||||
const peerStore = new MockPeerStore([])
|
const peers = new Map()
|
||||||
|
const peerStore = new MockPeerStore(peers)
|
||||||
|
const connectionManager = new EventEmitter()
|
||||||
|
|
||||||
registrar = {
|
registrar = {
|
||||||
peerStore,
|
peerStore,
|
||||||
|
connectionManager,
|
||||||
getConnection: () => { }
|
getConnection: () => { }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user