mirror of
https://github.com/fluencelabs/js-libp2p-tcp
synced 2025-07-02 05:01:34 +00:00
Compare commits
32 Commits
Author | SHA1 | Date | |
---|---|---|---|
e9e1f56b87 | |||
dee839efa5 | |||
8ff9f607b0 | |||
f17525a9b2 | |||
b524848352 | |||
926a99caea | |||
d9f9912dac | |||
82b99076d0 | |||
6590651e97 | |||
5757c7ea11 | |||
562b3adf1f | |||
eac9129bc0 | |||
0fe0815514 | |||
2bc2b36050 | |||
f4f3e8529b | |||
3a127fca4c | |||
0c4269cdc2 | |||
40f4cb6bb7 | |||
62728769d3 | |||
86db568cd8 | |||
0c2d84e395 | |||
13fb6ba6e4 | |||
21f87476f6 | |||
657d3e6f4a | |||
162c605bf5 | |||
d76a1f27e7 | |||
7702646cfa | |||
7c977d3cb1 | |||
524acbe372 | |||
1b210e71c0 | |||
a385f0eb34 | |||
605ee279ae |
1
.gitignore
vendored
1
.gitignore
vendored
@ -2,3 +2,4 @@ node_modules
|
|||||||
package-lock.json
|
package-lock.json
|
||||||
coverage
|
coverage
|
||||||
.nyc_output
|
.nyc_output
|
||||||
|
docs
|
||||||
|
@ -27,7 +27,6 @@ jobs:
|
|||||||
- stage: check
|
- stage: check
|
||||||
os: linux
|
os: linux
|
||||||
script:
|
script:
|
||||||
- npx aegir build --bundlesize
|
|
||||||
- npx aegir dep-check
|
- npx aegir dep-check
|
||||||
- npm run lint
|
- npm run lint
|
||||||
|
|
||||||
|
86
CHANGELOG.md
86
CHANGELOG.md
@ -1,3 +1,89 @@
|
|||||||
|
<a name="0.15.1"></a>
|
||||||
|
## [0.15.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.15.0...v0.15.1) (2020-08-11)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="0.15.0"></a>
|
||||||
|
# [0.15.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.14.6...v0.15.0) (2020-08-07)
|
||||||
|
|
||||||
|
|
||||||
|
### Chores
|
||||||
|
|
||||||
|
* update deps ([#134](https://github.com/libp2p/js-libp2p-tcp/issues/134)) ([d9f9912](https://github.com/libp2p/js-libp2p-tcp/commit/d9f9912))
|
||||||
|
|
||||||
|
|
||||||
|
### BREAKING CHANGES
|
||||||
|
|
||||||
|
* - The multiaddr dep used by this module returns Uint8Arrays and may
|
||||||
|
not be compatible with previous versions
|
||||||
|
|
||||||
|
* chore: update utils
|
||||||
|
|
||||||
|
* chore: remove gh dep url
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="0.14.6"></a>
|
||||||
|
## [0.14.6](https://github.com/libp2p/js-libp2p-tcp/compare/v0.14.5...v0.14.6) (2020-07-17)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="0.14.5"></a>
|
||||||
|
## [0.14.5](https://github.com/libp2p/js-libp2p-tcp/compare/v0.14.4...v0.14.5) (2020-04-28)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* catch error from maConn.close ([#128](https://github.com/libp2p/js-libp2p-tcp/issues/128)) ([0fe0815](https://github.com/libp2p/js-libp2p-tcp/commit/0fe0815))
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="0.14.4"></a>
|
||||||
|
## [0.14.4](https://github.com/libp2p/js-libp2p-tcp/compare/v0.14.3...v0.14.4) (2020-02-24)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* catch thrown maConn errors in listener ([#122](https://github.com/libp2p/js-libp2p-tcp/issues/122)) ([86db568](https://github.com/libp2p/js-libp2p-tcp/commit/86db568)), closes [#121](https://github.com/libp2p/js-libp2p-tcp/issues/121)
|
||||||
|
* remove use of assert module ([#123](https://github.com/libp2p/js-libp2p-tcp/issues/123)) ([6272876](https://github.com/libp2p/js-libp2p-tcp/commit/6272876))
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="0.14.3"></a>
|
||||||
|
## [0.14.3](https://github.com/libp2p/js-libp2p-tcp/compare/v0.14.2...v0.14.3) (2019-12-20)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* transport should not handle connection if upgradeInbound throws ([#119](https://github.com/libp2p/js-libp2p-tcp/issues/119)) ([21f8747](https://github.com/libp2p/js-libp2p-tcp/commit/21f8747))
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="0.14.2"></a>
|
||||||
|
## [0.14.2](https://github.com/libp2p/js-libp2p-tcp/compare/v0.14.1...v0.14.2) (2019-12-06)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **log:** log the bound port and host ([#117](https://github.com/libp2p/js-libp2p-tcp/issues/117)) ([7702646](https://github.com/libp2p/js-libp2p-tcp/commit/7702646))
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* add path multiaddr support ([#118](https://github.com/libp2p/js-libp2p-tcp/issues/118)) ([d76a1f2](https://github.com/libp2p/js-libp2p-tcp/commit/d76a1f2))
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<a name="0.14.1"></a>
|
||||||
|
## [0.14.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.14.0...v0.14.1) (2019-09-20)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* ensure timeline.close is set ([#113](https://github.com/libp2p/js-libp2p-tcp/issues/113)) ([605ee27](https://github.com/libp2p/js-libp2p-tcp/commit/605ee27))
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<a name="0.14.0"></a>
|
<a name="0.14.0"></a>
|
||||||
# [0.14.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.13.1...v0.14.0) (2019-09-16)
|
# [0.14.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.13.1...v0.14.0) (2019-09-16)
|
||||||
|
|
||||||
|
@ -44,9 +44,13 @@ const multiaddr = require('multiaddr')
|
|||||||
const pipe = require('it-pipe')
|
const pipe = require('it-pipe')
|
||||||
const { collect } = require('streaming-iterables')
|
const { collect } = require('streaming-iterables')
|
||||||
|
|
||||||
const addr = multiaddr('/ip4/127.0.0.1/tcp/9090')
|
// A simple upgrader that just returns the MultiaddrConnection
|
||||||
|
const upgrader = {
|
||||||
|
upgradeInbound: maConn => maConn,
|
||||||
|
upgradeOutbound: maConn => maConn
|
||||||
|
}
|
||||||
|
|
||||||
const tcp = new TCP()
|
const tcp = new TCP({ upgrader })
|
||||||
|
|
||||||
const listener = tcp.createListener((socket) => {
|
const listener = tcp.createListener((socket) => {
|
||||||
console.log('new connection opened')
|
console.log('new connection opened')
|
||||||
@ -56,6 +60,7 @@ const listener = tcp.createListener((socket) => {
|
|||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
const addr = multiaddr('/ip4/127.0.0.1/tcp/9090')
|
||||||
await listener.listen(addr)
|
await listener.listen(addr)
|
||||||
console.log('listening')
|
console.log('listening')
|
||||||
|
|
||||||
|
44
package.json
44
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "libp2p-tcp",
|
"name": "libp2p-tcp",
|
||||||
"version": "0.14.0",
|
"version": "0.15.1",
|
||||||
"description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces",
|
"description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces",
|
||||||
"leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
|
"leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
|
||||||
"main": "src/index.js",
|
"main": "src/index.js",
|
||||||
@ -33,41 +33,39 @@
|
|||||||
"npm": ">=3.0.0"
|
"npm": ">=3.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"aegir": "^20.0.0",
|
"aegir": "^25.0.0",
|
||||||
"chai": "^4.2.0",
|
"it-pipe": "^1.1.0",
|
||||||
"dirty-chai": "^2.0.1",
|
"libp2p-interfaces": "^0.4.0",
|
||||||
"interface-transport": "^0.6.1",
|
"sinon": "^9.0.0",
|
||||||
"sinon": "^7.3.1"
|
"streaming-iterables": "^5.0.2"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"abortable-iterator": "^2.1.0",
|
"abortable-iterator": "^3.0.0",
|
||||||
"class-is": "^1.1.0",
|
"class-is": "^1.1.0",
|
||||||
"debug": "^4.1.1",
|
"debug": "^4.1.1",
|
||||||
"err-code": "^2.0.0",
|
"err-code": "^2.0.0",
|
||||||
"ip-address": "^6.1.0",
|
"libp2p-utils": "^0.2.0",
|
||||||
"mafmt": "^6.0.9",
|
"mafmt": "^8.0.0",
|
||||||
"multiaddr": "^7.1.0",
|
"multiaddr": "^8.0.0",
|
||||||
"stream-to-it": "^0.1.1"
|
"stream-to-it": "^0.2.2"
|
||||||
},
|
},
|
||||||
"contributors": [
|
"contributors": [
|
||||||
"Alan Shaw <alan.shaw@protocol.ai>",
|
|
||||||
"Alan Shaw <alan@tableflip.io>",
|
|
||||||
"David Dias <daviddias.p@gmail.com>",
|
"David Dias <daviddias.p@gmail.com>",
|
||||||
|
"Jacob Heun <jacobheun@gmail.com>",
|
||||||
|
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
||||||
|
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
|
||||||
|
"Alex Potsides <alex@achingbrain.net>",
|
||||||
|
"Vasco Santos <vasco.santos@moxy.studio>",
|
||||||
|
"Richard Littauer <richard.littauer@gmail.com>",
|
||||||
|
"Tom White <tomtinkerer@gmail.com>",
|
||||||
|
"Alan Shaw <alan@tableflip.io>",
|
||||||
|
"João Antunes <j.goncalo.antunes@gmail.com>",
|
||||||
"Diogo Silva <fsdiogo@gmail.com>",
|
"Diogo Silva <fsdiogo@gmail.com>",
|
||||||
"Dmitriy Ryajov <dryajov@gmail.com>",
|
"Dmitriy Ryajov <dryajov@gmail.com>",
|
||||||
"Drew Stone <drewstone329@gmail.com>",
|
"Drew Stone <drewstone329@gmail.com>",
|
||||||
"Evan Schwartz <evan.mark.schwartz@gmail.com>",
|
"Evan Schwartz <evan.mark.schwartz@gmail.com>",
|
||||||
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
|
|
||||||
"Greenkeeper <support@greenkeeper.io>",
|
|
||||||
"Jacob Heun <jacobheun@gmail.com>",
|
|
||||||
"Jacob Heun <jake@andyet.net>",
|
|
||||||
"João Antunes <j.goncalo.antunes@gmail.com>",
|
|
||||||
"Linus Unnebäck <linus@folkdatorn.se>",
|
"Linus Unnebäck <linus@folkdatorn.se>",
|
||||||
"Pedro Teixeira <i@pgte.me>",
|
"Pedro Teixeira <i@pgte.me>",
|
||||||
"Prashanth Chandra <coolshanth94@gmail.com>",
|
"Prashanth Chandra <coolshanth94@gmail.com>"
|
||||||
"Richard Littauer <richard.littauer@gmail.com>",
|
|
||||||
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
|
||||||
"TomCoded <tomtinkerer@gmail.com>",
|
|
||||||
"Vasco Santos <vasco.santos@moxy.studio>"
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
14
src/index.js
14
src/index.js
@ -7,9 +7,9 @@ const errCode = require('err-code')
|
|||||||
const log = require('debug')('libp2p:tcp')
|
const log = require('debug')('libp2p:tcp')
|
||||||
const toConnection = require('./socket-to-conn')
|
const toConnection = require('./socket-to-conn')
|
||||||
const createListener = require('./listener')
|
const createListener = require('./listener')
|
||||||
|
const { multiaddrToNetConfig } = require('./utils')
|
||||||
const { AbortError } = require('abortable-iterator')
|
const { AbortError } = require('abortable-iterator')
|
||||||
const { CODE_CIRCUIT, CODE_P2P } = require('./constants')
|
const { CODE_CIRCUIT, CODE_P2P } = require('./constants')
|
||||||
const assert = require('assert')
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @class TCP
|
* @class TCP
|
||||||
@ -21,7 +21,9 @@ class TCP {
|
|||||||
* @param {Upgrader} options.upgrader
|
* @param {Upgrader} options.upgrader
|
||||||
*/
|
*/
|
||||||
constructor ({ upgrader }) {
|
constructor ({ upgrader }) {
|
||||||
assert(upgrader, 'An upgrader must be provided. See https://github.com/libp2p/interface-transport#upgrader.')
|
if (!upgrader) {
|
||||||
|
throw new Error('An upgrader must be provided. See https://github.com/libp2p/interface-transport#upgrader.')
|
||||||
|
}
|
||||||
this._upgrader = upgrader
|
this._upgrader = upgrader
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -56,9 +58,9 @@ class TCP {
|
|||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
const start = Date.now()
|
const start = Date.now()
|
||||||
const cOpts = ma.toOptions()
|
const cOpts = multiaddrToNetConfig(ma)
|
||||||
|
|
||||||
log('dialing %s:%s', cOpts.host, cOpts.port)
|
log('dialing %j', cOpts)
|
||||||
const rawSocket = net.connect(cOpts)
|
const rawSocket = net.connect(cOpts)
|
||||||
|
|
||||||
const onError = err => {
|
const onError = err => {
|
||||||
@ -74,12 +76,12 @@ class TCP {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const onConnect = () => {
|
const onConnect = () => {
|
||||||
log('connection opened %s:%s', cOpts.host, cOpts.port)
|
log('connection opened %j', cOpts)
|
||||||
done()
|
done()
|
||||||
}
|
}
|
||||||
|
|
||||||
const onAbort = () => {
|
const onAbort = () => {
|
||||||
log('connection aborted %s:%s', cOpts.host, cOpts.port)
|
log('connection aborted %j', cOpts)
|
||||||
rawSocket.destroy()
|
rawSocket.destroy()
|
||||||
done(new AbortError())
|
done(new AbortError())
|
||||||
}
|
}
|
||||||
|
@ -1,30 +0,0 @@
|
|||||||
'use strict'
|
|
||||||
|
|
||||||
const multiaddr = require('multiaddr')
|
|
||||||
const { Address4, Address6 } = require('ip-address')
|
|
||||||
|
|
||||||
module.exports = (ip, port) => {
|
|
||||||
if (typeof ip !== 'string') {
|
|
||||||
throw new Error('invalid ip')
|
|
||||||
}
|
|
||||||
|
|
||||||
port = parseInt(port)
|
|
||||||
|
|
||||||
if (isNaN(port)) {
|
|
||||||
throw new Error('invalid port')
|
|
||||||
}
|
|
||||||
|
|
||||||
if (new Address4(ip).isValid()) {
|
|
||||||
return multiaddr(`/ip4/${ip}/tcp/${port}`)
|
|
||||||
}
|
|
||||||
|
|
||||||
const ip6 = new Address6(ip)
|
|
||||||
|
|
||||||
if (ip6.isValid()) {
|
|
||||||
return ip6.is4()
|
|
||||||
? multiaddr(`/ip4/${ip6.to4().correctForm()}/tcp/${port}`)
|
|
||||||
: multiaddr(`/ip6/${ip}/tcp/${port}`)
|
|
||||||
}
|
|
||||||
|
|
||||||
throw new Error('invalid ip')
|
|
||||||
}
|
|
@ -1,13 +1,30 @@
|
|||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const multiaddr = require('multiaddr')
|
|
||||||
const os = require('os')
|
|
||||||
const net = require('net')
|
const net = require('net')
|
||||||
const EventEmitter = require('events')
|
const EventEmitter = require('events')
|
||||||
const log = require('debug')('libp2p:tcp:listener')
|
const debug = require('debug')
|
||||||
|
const log = debug('libp2p:tcp:listener')
|
||||||
|
log.error = debug('libp2p:tcp:listener:error')
|
||||||
|
|
||||||
const toConnection = require('./socket-to-conn')
|
const toConnection = require('./socket-to-conn')
|
||||||
const { CODE_P2P } = require('./constants')
|
const { CODE_P2P } = require('./constants')
|
||||||
const ProtoFamily = { ip4: 'IPv4', ip6: 'IPv6' }
|
const {
|
||||||
|
getMultiaddrs,
|
||||||
|
multiaddrToNetConfig
|
||||||
|
} = require('./utils')
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Attempts to close the given maConn. If a failure occurs, it will be logged.
|
||||||
|
* @private
|
||||||
|
* @param {MultiaddrConnection} maConn
|
||||||
|
*/
|
||||||
|
async function attemptClose (maConn) {
|
||||||
|
try {
|
||||||
|
maConn && await maConn.close()
|
||||||
|
} catch (err) {
|
||||||
|
log.error('an error occurred closing the connection', err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
module.exports = ({ handler, upgrader }, options) => {
|
module.exports = ({ handler, upgrader }, options) => {
|
||||||
const listener = new EventEmitter()
|
const listener = new EventEmitter()
|
||||||
@ -16,10 +33,17 @@ module.exports = ({ handler, upgrader }, options) => {
|
|||||||
// Avoid uncaught errors caused by unstable connections
|
// Avoid uncaught errors caused by unstable connections
|
||||||
socket.on('error', err => log('socket error', err))
|
socket.on('error', err => log('socket error', err))
|
||||||
|
|
||||||
const maConn = toConnection(socket)
|
let maConn
|
||||||
log('new inbound connection %s', maConn.remoteAddr)
|
let conn
|
||||||
|
try {
|
||||||
|
maConn = toConnection(socket, { listeningAddr })
|
||||||
|
log('new inbound connection %s', maConn.remoteAddr)
|
||||||
|
conn = await upgrader.upgradeInbound(maConn)
|
||||||
|
} catch (err) {
|
||||||
|
log.error('inbound connection failed', err)
|
||||||
|
return attemptClose(maConn)
|
||||||
|
}
|
||||||
|
|
||||||
const conn = await upgrader.upgradeInbound(maConn)
|
|
||||||
log('inbound connection %s upgraded', maConn.remoteAddr)
|
log('inbound connection %s upgraded', maConn.remoteAddr)
|
||||||
|
|
||||||
trackConn(server, maConn)
|
trackConn(server, maConn)
|
||||||
@ -40,7 +64,7 @@ module.exports = ({ handler, upgrader }, options) => {
|
|||||||
if (!server.listening) return
|
if (!server.listening) return
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
server.__connections.forEach(maConn => maConn.close())
|
server.__connections.forEach(maConn => attemptClose(maConn))
|
||||||
server.close(err => err ? reject(err) : resolve())
|
server.close(err => err ? reject(err) : resolve())
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@ -56,10 +80,10 @@ module.exports = ({ handler, upgrader }, options) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return new Promise((resolve, reject) => {
|
return new Promise((resolve, reject) => {
|
||||||
const { host, port } = listeningAddr.toOptions()
|
const options = multiaddrToNetConfig(listeningAddr)
|
||||||
server.listen(port, host, err => {
|
server.listen(options, err => {
|
||||||
if (err) return reject(err)
|
if (err) return reject(err)
|
||||||
log('Listening on %s %s', port, host)
|
log('Listening on %s', server.address())
|
||||||
resolve()
|
resolve()
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
@ -76,9 +100,9 @@ module.exports = ({ handler, upgrader }, options) => {
|
|||||||
// Because TCP will only return the IPv6 version
|
// Because TCP will only return the IPv6 version
|
||||||
// we need to capture from the passed multiaddr
|
// we need to capture from the passed multiaddr
|
||||||
if (listeningAddr.toString().startsWith('/ip4')) {
|
if (listeningAddr.toString().startsWith('/ip4')) {
|
||||||
addrs = addrs.concat(getMulitaddrs('ip4', address.address, address.port))
|
addrs = addrs.concat(getMultiaddrs('ip4', address.address, address.port))
|
||||||
} else if (address.family === 'IPv6') {
|
} else if (address.family === 'IPv6') {
|
||||||
addrs = addrs.concat(getMulitaddrs('ip6', address.address, address.port))
|
addrs = addrs.concat(getMultiaddrs('ip6', address.address, address.port))
|
||||||
}
|
}
|
||||||
|
|
||||||
return addrs.map(ma => peerId ? ma.encapsulate(`/p2p/${peerId}`) : ma)
|
return addrs.map(ma => peerId ? ma.encapsulate(`/p2p/${peerId}`) : ma)
|
||||||
@ -87,30 +111,6 @@ module.exports = ({ handler, upgrader }, options) => {
|
|||||||
return listener
|
return listener
|
||||||
}
|
}
|
||||||
|
|
||||||
function getMulitaddrs (proto, ip, port) {
|
|
||||||
const toMa = ip => multiaddr(`/${proto}/${ip}/tcp/${port}`)
|
|
||||||
return (isAnyAddr(ip) ? getNetworkAddrs(ProtoFamily[proto]) : [ip]).map(toMa)
|
|
||||||
}
|
|
||||||
|
|
||||||
function isAnyAddr (ip) {
|
|
||||||
return ['0.0.0.0', '::'].includes(ip)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @private
|
|
||||||
* @param {string} family One of ['IPv6', 'IPv4']
|
|
||||||
* @returns {string[]} an array of ip address strings
|
|
||||||
*/
|
|
||||||
function getNetworkAddrs (family) {
|
|
||||||
return Object.values(os.networkInterfaces()).reduce((addresses, netAddrs) => {
|
|
||||||
netAddrs.forEach(netAddr => {
|
|
||||||
// Add the ip of each matching network interface
|
|
||||||
if (netAddr.family === family) addresses.push(netAddr.address)
|
|
||||||
})
|
|
||||||
return addresses
|
|
||||||
}, [])
|
|
||||||
}
|
|
||||||
|
|
||||||
function trackConn (server, maConn) {
|
function trackConn (server, maConn) {
|
||||||
server.__connections.push(maConn)
|
server.__connections.push(maConn)
|
||||||
|
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
const abortable = require('abortable-iterator')
|
const abortable = require('abortable-iterator')
|
||||||
const log = require('debug')('libp2p:tcp:socket')
|
const log = require('debug')('libp2p:tcp:socket')
|
||||||
const toIterable = require('stream-to-it')
|
const toIterable = require('stream-to-it')
|
||||||
const toMultiaddr = require('./ip-port-to-multiaddr')
|
const toMultiaddr = require('libp2p-utils/src/ip-port-to-multiaddr')
|
||||||
const { CLOSE_TIMEOUT } = require('./constants')
|
const { CLOSE_TIMEOUT } = require('./constants')
|
||||||
|
|
||||||
// Convert a socket into a MultiaddrConnection
|
// Convert a socket into a MultiaddrConnection
|
||||||
@ -11,6 +11,15 @@ const { CLOSE_TIMEOUT } = require('./constants')
|
|||||||
module.exports = (socket, options) => {
|
module.exports = (socket, options) => {
|
||||||
options = options || {}
|
options = options || {}
|
||||||
|
|
||||||
|
// Check if we are connected on a unix path
|
||||||
|
if (options.listeningAddr && options.listeningAddr.getPath()) {
|
||||||
|
options.remoteAddr = options.listeningAddr
|
||||||
|
}
|
||||||
|
|
||||||
|
if (options.remoteAddr && options.remoteAddr.getPath()) {
|
||||||
|
options.localAddr = options.remoteAddr
|
||||||
|
}
|
||||||
|
|
||||||
const { sink, source } = toIterable.duplex(socket)
|
const { sink, source } = toIterable.duplex(socket)
|
||||||
const maConn = {
|
const maConn = {
|
||||||
async sink (source) {
|
async sink (source) {
|
||||||
@ -40,7 +49,7 @@ module.exports = (socket, options) => {
|
|||||||
|
|
||||||
conn: socket,
|
conn: socket,
|
||||||
|
|
||||||
localAddr: toMultiaddr(socket.localAddress, socket.localPort),
|
localAddr: options.localAddr || toMultiaddr(socket.localAddress, socket.localPort),
|
||||||
|
|
||||||
// If the remote address was passed, use it - it may have the peer ID encapsulated
|
// If the remote address was passed, use it - it may have the peer ID encapsulated
|
||||||
remoteAddr: options.remoteAddr || toMultiaddr(socket.remoteAddress, socket.remotePort),
|
remoteAddr: options.remoteAddr || toMultiaddr(socket.remoteAddress, socket.remotePort),
|
||||||
@ -79,5 +88,14 @@ module.exports = (socket, options) => {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
socket.once('close', () => {
|
||||||
|
// In instances where `close` was not explicitly called,
|
||||||
|
// such as an iterable stream ending, ensure we have set the close
|
||||||
|
// timeline
|
||||||
|
if (!maConn.timeline.close) {
|
||||||
|
maConn.timeline.close = Date.now()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
return maConn
|
return maConn
|
||||||
}
|
}
|
||||||
|
46
src/utils.js
Normal file
46
src/utils.js
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
'use strict'
|
||||||
|
|
||||||
|
const multiaddr = require('multiaddr')
|
||||||
|
const os = require('os')
|
||||||
|
const { resolve } = require('path')
|
||||||
|
const ProtoFamily = { ip4: 'IPv4', ip6: 'IPv6' }
|
||||||
|
|
||||||
|
function multiaddrToNetConfig (addr) {
|
||||||
|
const listenPath = addr.getPath()
|
||||||
|
// unix socket listening
|
||||||
|
if (listenPath) {
|
||||||
|
return resolve(listenPath)
|
||||||
|
}
|
||||||
|
// tcp listening
|
||||||
|
return addr.toOptions()
|
||||||
|
}
|
||||||
|
|
||||||
|
function getMultiaddrs (proto, ip, port) {
|
||||||
|
const toMa = ip => multiaddr(`/${proto}/${ip}/tcp/${port}`)
|
||||||
|
return (isAnyAddr(ip) ? getNetworkAddrs(ProtoFamily[proto]) : [ip]).map(toMa)
|
||||||
|
}
|
||||||
|
|
||||||
|
function isAnyAddr (ip) {
|
||||||
|
return ['0.0.0.0', '::'].includes(ip)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @private
|
||||||
|
* @param {string} family One of ['IPv6', 'IPv4']
|
||||||
|
* @returns {string[]} an array of ip address strings
|
||||||
|
*/
|
||||||
|
function getNetworkAddrs (family) {
|
||||||
|
return Object.values(os.networkInterfaces()).reduce((addresses, netAddrs) => {
|
||||||
|
netAddrs.forEach(netAddr => {
|
||||||
|
// Add the ip of each matching network interface
|
||||||
|
if (netAddr.family === family) addresses.push(netAddr.address)
|
||||||
|
})
|
||||||
|
return addresses
|
||||||
|
}, [])
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
multiaddrToNetConfig,
|
||||||
|
isAnyAddr,
|
||||||
|
getMultiaddrs
|
||||||
|
}
|
@ -2,7 +2,7 @@
|
|||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const sinon = require('sinon')
|
const sinon = require('sinon')
|
||||||
const tests = require('interface-transport')
|
const tests = require('libp2p-interfaces/src/transport/tests')
|
||||||
const multiaddr = require('multiaddr')
|
const multiaddr = require('multiaddr')
|
||||||
const net = require('net')
|
const net = require('net')
|
||||||
const TCP = require('../src')
|
const TCP = require('../src')
|
||||||
@ -14,8 +14,7 @@ describe('interface-transport compliance', () => {
|
|||||||
const addrs = [
|
const addrs = [
|
||||||
multiaddr('/ip4/127.0.0.1/tcp/9091'),
|
multiaddr('/ip4/127.0.0.1/tcp/9091'),
|
||||||
multiaddr('/ip4/127.0.0.1/tcp/9092'),
|
multiaddr('/ip4/127.0.0.1/tcp/9092'),
|
||||||
multiaddr('/ip4/127.0.0.1/tcp/9093'),
|
multiaddr('/ip4/127.0.0.1/tcp/9093')
|
||||||
multiaddr('/dns4/ipfs.io')
|
|
||||||
]
|
]
|
||||||
|
|
||||||
// Used by the dial tests to simulate a delayed connect
|
// Used by the dial tests to simulate a delayed connect
|
||||||
|
@ -1,10 +1,7 @@
|
|||||||
/* eslint-env mocha */
|
/* eslint-env mocha */
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const chai = require('chai')
|
const { expect } = require('aegir/utils/chai')
|
||||||
const dirtyChai = require('dirty-chai')
|
|
||||||
const expect = chai.expect
|
|
||||||
chai.use(dirtyChai)
|
|
||||||
const TCP = require('../src')
|
const TCP = require('../src')
|
||||||
const multiaddr = require('multiaddr')
|
const multiaddr = require('multiaddr')
|
||||||
|
|
||||||
|
@ -1,10 +1,7 @@
|
|||||||
/* eslint-env mocha */
|
/* eslint-env mocha */
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const chai = require('chai')
|
const { expect } = require('aegir/utils/chai')
|
||||||
const dirtyChai = require('dirty-chai')
|
|
||||||
const expect = chai.expect
|
|
||||||
chai.use(dirtyChai)
|
|
||||||
const TCP = require('../src')
|
const TCP = require('../src')
|
||||||
const multiaddr = require('multiaddr')
|
const multiaddr = require('multiaddr')
|
||||||
|
|
||||||
|
@ -1,50 +0,0 @@
|
|||||||
/* eslint-env mocha */
|
|
||||||
'use strict'
|
|
||||||
|
|
||||||
const chai = require('chai')
|
|
||||||
const dirtyChai = require('dirty-chai')
|
|
||||||
const expect = chai.expect
|
|
||||||
chai.use(dirtyChai)
|
|
||||||
const toMultiaddr = require('../src/ip-port-to-multiaddr')
|
|
||||||
|
|
||||||
describe('IP and port to Multiaddr', () => {
|
|
||||||
it('creates multiaddr from valid IPv4 IP and port', () => {
|
|
||||||
const ip = '127.0.0.1'
|
|
||||||
const port = '9090'
|
|
||||||
expect(toMultiaddr(ip, port).toString()).to.equal(`/ip4/${ip}/tcp/${port}`)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('creates multiaddr from valid IPv4 IP and numeric port', () => {
|
|
||||||
const ip = '127.0.0.1'
|
|
||||||
const port = 9090
|
|
||||||
expect(toMultiaddr(ip, port).toString()).to.equal(`/ip4/${ip}/tcp/${port}`)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('creates multiaddr from valid IPv4 in IPv6 IP and port', () => {
|
|
||||||
const ip = '0:0:0:0:0:0:101.45.75.219'
|
|
||||||
const port = '9090'
|
|
||||||
expect(toMultiaddr(ip, port).toString()).to.equal(`/ip4/101.45.75.219/tcp/${port}`)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('creates multiaddr from valid IPv6 IP and port', () => {
|
|
||||||
const ip = '::1'
|
|
||||||
const port = '9090'
|
|
||||||
expect(toMultiaddr(ip, port).toString()).to.equal(`/ip6/${ip}/tcp/${port}`)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('throws for missing IP address', () => {
|
|
||||||
expect(() => toMultiaddr()).to.throw('invalid ip')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('throws for invalid IP address', () => {
|
|
||||||
const ip = 'aewmrn4awoew'
|
|
||||||
const port = '234'
|
|
||||||
expect(() => toMultiaddr(ip, port)).to.throw('invalid ip')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('throws for invalid port', () => {
|
|
||||||
const ip = '127.0.0.1'
|
|
||||||
const port = 'garbage'
|
|
||||||
expect(() => toMultiaddr(ip, port)).to.throw('invalid port')
|
|
||||||
})
|
|
||||||
})
|
|
@ -1,16 +1,18 @@
|
|||||||
/* eslint-env mocha */
|
/* eslint-env mocha */
|
||||||
'use strict'
|
'use strict'
|
||||||
|
|
||||||
const chai = require('chai')
|
const { expect } = require('aegir/utils/chai')
|
||||||
const dirtyChai = require('dirty-chai')
|
|
||||||
const expect = chai.expect
|
|
||||||
chai.use(dirtyChai)
|
|
||||||
const TCP = require('../src')
|
const TCP = require('../src')
|
||||||
const net = require('net')
|
const net = require('net')
|
||||||
|
const os = require('os')
|
||||||
|
const path = require('path')
|
||||||
const multiaddr = require('multiaddr')
|
const multiaddr = require('multiaddr')
|
||||||
const pipe = require('it-pipe')
|
const pipe = require('it-pipe')
|
||||||
const { collect, map } = require('streaming-iterables')
|
const { collect, map } = require('streaming-iterables')
|
||||||
const isCI = process.env.CI
|
const isCI = process.env.CI
|
||||||
|
const isWindows = os.platform() === 'win32'
|
||||||
|
|
||||||
|
const skipOnWindows = isWindows ? it.skip : it
|
||||||
|
|
||||||
describe('construction', () => {
|
describe('construction', () => {
|
||||||
it('requires an upgrader', () => {
|
it('requires an upgrader', () => {
|
||||||
@ -20,6 +22,7 @@ describe('construction', () => {
|
|||||||
|
|
||||||
describe('listen', () => {
|
describe('listen', () => {
|
||||||
let tcp
|
let tcp
|
||||||
|
let listener
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
tcp = new TCP({
|
tcp = new TCP({
|
||||||
@ -29,10 +32,13 @@ describe('listen', () => {
|
|||||||
}
|
}
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
afterEach(async () => {
|
||||||
|
listener && await listener.close()
|
||||||
|
})
|
||||||
|
|
||||||
it('close listener with connections, through timeout', async () => {
|
it('close listener with connections, through timeout', async () => {
|
||||||
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
|
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
|
||||||
const listener = tcp.createListener((conn) => {
|
listener = tcp.createListener((conn) => {
|
||||||
pipe(conn, conn)
|
pipe(conn, conn)
|
||||||
})
|
})
|
||||||
|
|
||||||
@ -54,11 +60,18 @@ describe('listen', () => {
|
|||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
// Windows doesn't support unix paths
|
||||||
|
skipOnWindows('listen on path', async () => {
|
||||||
|
const mh = multiaddr(`/unix${path.resolve(os.tmpdir(), '/tmp/p2pd.sock')}`)
|
||||||
|
|
||||||
|
listener = tcp.createListener((conn) => {})
|
||||||
|
await listener.listen(mh)
|
||||||
|
})
|
||||||
|
|
||||||
it('listen on port 0', async () => {
|
it('listen on port 0', async () => {
|
||||||
const mh = multiaddr('/ip4/127.0.0.1/tcp/0')
|
const mh = multiaddr('/ip4/127.0.0.1/tcp/0')
|
||||||
const listener = tcp.createListener((conn) => {})
|
listener = tcp.createListener((conn) => {})
|
||||||
await listener.listen(mh)
|
await listener.listen(mh)
|
||||||
await listener.close()
|
|
||||||
})
|
})
|
||||||
|
|
||||||
it('listen on IPv6 addr', async () => {
|
it('listen on IPv6 addr', async () => {
|
||||||
@ -66,75 +79,63 @@ describe('listen', () => {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
const mh = multiaddr('/ip6/::/tcp/9090')
|
const mh = multiaddr('/ip6/::/tcp/9090')
|
||||||
const listener = tcp.createListener((conn) => {})
|
listener = tcp.createListener((conn) => {})
|
||||||
await listener.listen(mh)
|
await listener.listen(mh)
|
||||||
await listener.close()
|
|
||||||
})
|
})
|
||||||
|
|
||||||
it('listen on any Interface', async () => {
|
it('listen on any Interface', async () => {
|
||||||
const mh = multiaddr('/ip4/0.0.0.0/tcp/9090')
|
const mh = multiaddr('/ip4/0.0.0.0/tcp/9090')
|
||||||
const listener = tcp.createListener((conn) => {})
|
listener = tcp.createListener((conn) => {})
|
||||||
await listener.listen(mh)
|
await listener.listen(mh)
|
||||||
await listener.close()
|
|
||||||
})
|
})
|
||||||
|
|
||||||
it('getAddrs', async () => {
|
it('getAddrs', async () => {
|
||||||
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090')
|
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090')
|
||||||
const listener = tcp.createListener((conn) => {})
|
listener = tcp.createListener((conn) => {})
|
||||||
await listener.listen(mh)
|
await listener.listen(mh)
|
||||||
|
|
||||||
const multiaddrs = listener.getAddrs()
|
const multiaddrs = listener.getAddrs()
|
||||||
expect(multiaddrs.length).to.equal(1)
|
expect(multiaddrs.length).to.equal(1)
|
||||||
expect(multiaddrs[0]).to.deep.equal(mh)
|
expect(multiaddrs[0]).to.deep.equal(mh)
|
||||||
|
|
||||||
await listener.close()
|
|
||||||
})
|
})
|
||||||
|
|
||||||
it('getAddrs on port 0 listen', async () => {
|
it('getAddrs on port 0 listen', async () => {
|
||||||
const mh = multiaddr('/ip4/127.0.0.1/tcp/0')
|
const mh = multiaddr('/ip4/127.0.0.1/tcp/0')
|
||||||
const listener = tcp.createListener((conn) => {})
|
listener = tcp.createListener((conn) => {})
|
||||||
await listener.listen(mh)
|
await listener.listen(mh)
|
||||||
|
|
||||||
const multiaddrs = listener.getAddrs()
|
const multiaddrs = listener.getAddrs()
|
||||||
expect(multiaddrs.length).to.equal(1)
|
expect(multiaddrs.length).to.equal(1)
|
||||||
|
|
||||||
await listener.close()
|
|
||||||
})
|
})
|
||||||
|
|
||||||
it('getAddrs from listening on 0.0.0.0', async () => {
|
it('getAddrs from listening on 0.0.0.0', async () => {
|
||||||
const mh = multiaddr('/ip4/0.0.0.0/tcp/9090')
|
const mh = multiaddr('/ip4/0.0.0.0/tcp/9090')
|
||||||
const listener = tcp.createListener((conn) => {})
|
listener = tcp.createListener((conn) => {})
|
||||||
await listener.listen(mh)
|
await listener.listen(mh)
|
||||||
|
|
||||||
const multiaddrs = listener.getAddrs()
|
const multiaddrs = listener.getAddrs()
|
||||||
expect(multiaddrs.length > 0).to.equal(true)
|
expect(multiaddrs.length > 0).to.equal(true)
|
||||||
expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1)
|
expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1)
|
||||||
|
|
||||||
await listener.close()
|
|
||||||
})
|
})
|
||||||
|
|
||||||
it('getAddrs from listening on 0.0.0.0 and port 0', async () => {
|
it('getAddrs from listening on 0.0.0.0 and port 0', async () => {
|
||||||
const mh = multiaddr('/ip4/0.0.0.0/tcp/0')
|
const mh = multiaddr('/ip4/0.0.0.0/tcp/0')
|
||||||
const listener = tcp.createListener((conn) => {})
|
listener = tcp.createListener((conn) => {})
|
||||||
await listener.listen(mh)
|
await listener.listen(mh)
|
||||||
|
|
||||||
const multiaddrs = listener.getAddrs()
|
const multiaddrs = listener.getAddrs()
|
||||||
expect(multiaddrs.length > 0).to.equal(true)
|
expect(multiaddrs.length > 0).to.equal(true)
|
||||||
expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1)
|
expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1)
|
||||||
|
|
||||||
await listener.close()
|
|
||||||
})
|
})
|
||||||
|
|
||||||
it('getAddrs preserves IPFS Id', async () => {
|
it('getAddrs preserves IPFS Id', async () => {
|
||||||
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
|
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
|
||||||
const listener = tcp.createListener((conn) => {})
|
listener = tcp.createListener((conn) => {})
|
||||||
await listener.listen(mh)
|
await listener.listen(mh)
|
||||||
|
|
||||||
const multiaddrs = listener.getAddrs()
|
const multiaddrs = listener.getAddrs()
|
||||||
expect(multiaddrs.length).to.equal(1)
|
expect(multiaddrs.length).to.equal(1)
|
||||||
expect(multiaddrs[0]).to.deep.equal(mh)
|
expect(multiaddrs[0]).to.deep.equal(mh)
|
||||||
|
|
||||||
await listener.close()
|
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
@ -192,6 +193,27 @@ describe('dial', () => {
|
|||||||
await listener.close()
|
await listener.close()
|
||||||
})
|
})
|
||||||
|
|
||||||
|
// Windows doesn't support unix paths
|
||||||
|
skipOnWindows('dial on path', async () => {
|
||||||
|
const ma = multiaddr(`/unix${path.resolve(os.tmpdir(), '/tmp/p2pd.sock')}`)
|
||||||
|
|
||||||
|
const listener = tcp.createListener((conn) => {
|
||||||
|
pipe(conn, conn)
|
||||||
|
})
|
||||||
|
await listener.listen(ma)
|
||||||
|
|
||||||
|
const connection = await tcp.dial(ma)
|
||||||
|
|
||||||
|
const values = await pipe(
|
||||||
|
['hey'],
|
||||||
|
connection,
|
||||||
|
collect
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(values).to.be.eql([Buffer.from('hey')])
|
||||||
|
await listener.close()
|
||||||
|
})
|
||||||
|
|
||||||
it('dial and destroy on listener', async () => {
|
it('dial and destroy on listener', async () => {
|
||||||
let handled
|
let handled
|
||||||
const handledPromise = new Promise((resolve) => {
|
const handledPromise = new Promise((resolve) => {
|
||||||
|
Reference in New Issue
Block a user