Compare commits

...

16 Commits

Author SHA1 Message Date
b38b57bdca chore: add osx back
License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>
2019-04-19 14:25:53 +02:00
fde9cd40d3 chore: test travis file change
License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>
2019-04-19 14:23:25 +02:00
09e5752cb4 chore: test travis change
License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>
2019-04-19 14:13:11 +02:00
1eca9d656e test: use port 0
docs: add some more jsdocs

License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>
2019-04-19 11:00:51 +02:00
330853f470 docs: update readme for array listen
License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>
2019-04-19 10:47:18 +02:00
9d5ccd17a2 chore: update interface version
License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>
2019-04-19 10:40:13 +02:00
6bc505d73a chore: fix missing deps
License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>
2019-04-18 15:38:54 +02:00
431219db93 feat: support listen on array
License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>
2019-04-18 15:32:00 +02:00
1ffd549dab chore: update README 2019-04-12 15:53:33 +08:00
776a5246b5 test: add async/await tests 2019-04-12 15:53:17 +08:00
65c1888f54 feat: cancel dials with AbortController 2019-04-12 11:41:36 +08:00
6cf8f71d10 chore: callbacks -> async / await
BREAKING CHANGE: All places in the API that used callbacks are now replaced with async/await
2019-04-04 09:12:00 -04:00
3ab43a3604 chore: prefer const over let (#99)
Prefer const over let when the binding is static, in order to comply with an upcoming Standard rule.
2018-10-31 08:35:55 +00:00
3aad2ed243 chore: release version v0.13.0
License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>
2018-09-12 19:40:49 +02:00
01cfbda2e7 chore: update contributors 2018-09-12 19:40:49 +02:00
eba0b48744 feat: add support for dialing over dns
License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>
2018-09-12 19:38:02 +02:00
16 changed files with 810 additions and 312 deletions

View File

@ -1,32 +1,36 @@
# Warning: This file is automatically synced from https://github.com/ipfs/ci-sync so if you want to change it, please change it there and ask someone to sync all repositories.
sudo: false
language: node_js
cache: npm
matrix:
stages:
- check
- test
- cov
node_js:
- '10'
script: npx nyc -s npm run test:node -- --bail
after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov
jobs:
include:
- node_js: 6
env: CXX=g++-4.8
- node_js: 8
env: CXX=g++-4.8
# - node_js: stable
# env: CXX=g++-4.8
- os: linux
sudo: false
before_script: sudo sh -c 'echo 0 > /proc/sys/net/ipv6/conf/all/disable_ipv6'
script:
- npm run lint
- npm run test
- npm run coverage
- os: windows
filter_secrets: false
cache: false
before_script:
- export DISPLAY=:99.0
- sh -e /etc/init.d/xvfb start
- os: osx
after_success:
- npm run coverage-publish
- stage: check
os: linux
script:
- npx aegir build --bundlesize
- npx aegir commitlint --travis
- npx aegir dep-check
- npm run lint
addons:
firefox: 'latest'
apt:
sources:
- ubuntu-toolchain-r-test
packages:
- g++-4.8
notifications:
email: false

View File

@ -1,3 +1,13 @@
<a name="0.13.0"></a>
# [0.13.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.12.1...v0.13.0) (2018-09-12)
### Features
* add support for dialing over dns ([eba0b48](https://github.com/libp2p/js-libp2p-tcp/commit/eba0b48))
<a name="0.12.1"></a>
## [0.12.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.12.0...v0.12.1) (2018-07-31)

View File

@ -13,7 +13,7 @@
[![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)
> JavaScript implementation of the TCP module for libp2p. It exposes the [interface-transport](https://github.com/libp2p/interface-connection) for dial/listen. `libp2p-tcp` is a very thin shim that adds support for dialing to a `multiaddr`. This small shim will enable libp2p to use other different transports.
> JavaScript implementation of the TCP module for libp2p. It exposes the [interface-transport](https://github.com/libp2p/interface-connection) for dial/listen. `libp2p-tcp` is a very thin shim that adds support for dialing to a `multiaddr`. This small shim will enable libp2p to use other transports.
## Lead Maintainer
@ -41,37 +41,33 @@
```js
const TCP = require('libp2p-tcp')
const multiaddr = require('multiaddr')
const pull = require('pull-stream')
const pipe = require('it-pipe')
const { collect } = require('streaming-iterables')
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090')
const addr = multiaddr('/ip4/127.0.0.1/tcp/9090')
const tcp = new TCP()
const listener = tcp.createListener((socket) => {
console.log('new connection opened')
pull(
pull.values(['hello']),
pipe(
['hello'],
socket
)
})
listener.listen(mh, () => {
console.log('listening')
await listener.listen([addr])
console.log('listening')
pull(
tcp.dial(mh),
pull.collect((err, values) => {
if (!err) {
console.log(`Value: ${values.toString()}`)
} else {
console.log(`Error: ${err}`)
}
const socket = await tcp.dial(addr)
const values = await pipe(
socket,
collect
)
console.log(`Value: ${values.toString()}`)
// Close connection after reading
listener.close()
}),
)
})
// Close connection after reading
await listener.close()
```
Outputs:
@ -88,12 +84,12 @@ Value: hello
[![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
`libp2p-tcp` accepts TCP addresses both IPFS and non IPFS encapsulated addresses, i.e:
`libp2p-tcp` accepts TCP addresses as both IPFS and non IPFS encapsulated addresses, i.e:
`/ip4/127.0.0.1/tcp/4001`
`/ip4/127.0.0.1/tcp/4001/ipfs/QmHash`
Both for dialing and listening.
(both for dialing and listening)
### Connection

View File

@ -1,17 +1,20 @@
{
"name": "libp2p-tcp",
"version": "0.12.1",
"version": "0.13.0",
"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>",
"main": "src/index.js",
"scripts": {
"lint": "aegir lint",
"test": "aegir test -t node -f test/**/*.js",
"release": "aegir release -t node --no-build",
"release-minor": "aegir release -t node --type minor --no-build",
"release-major": "aegir-release -t node --type major --no-build",
"test": "aegir test -t node",
"test:node": "aegir test -t node",
"build": "aegir build",
"docs": "aegir docs",
"release": "aegir release --docs -t node",
"release-minor": "aegir release --type minor --docs -t node",
"release-major": "aegir release --type major --docs -t node",
"coverage": "aegir coverage",
"coverage-publish": "aegir coverage --provider coveralls"
"coverage-publish": "aegir-coverage publish"
},
"pre-push": [
"lint",
@ -34,24 +37,27 @@
"npm": ">=3.0.0"
},
"devDependencies": {
"aegir": "^15.1.0",
"aegir": "^18.1.1",
"chai": "^4.1.2",
"dirty-chai": "^2.0.1",
"interface-transport": "~0.3.6",
"lodash.isfunction": "^3.0.9",
"pull-stream": "^3.6.7"
"pull-stream": "^3.6.9",
"sinon": "^7.3.1"
},
"dependencies": {
"abort-controller": "^3.0.0",
"class-is": "^1.1.0",
"debug": "^3.1.0",
"interface-connection": "~0.3.2",
"debug": "^4.1.1",
"err-code": "^1.1.2",
"interface-connection": "~0.3.3",
"interface-transport": "~0.4.0",
"ip-address": "^5.8.9",
"it-pipe": "^1.0.0",
"lodash.includes": "^4.3.0",
"lodash.isfunction": "^3.0.9",
"mafmt": "^6.0.0",
"multiaddr": "^4.0.0",
"once": "^1.4.0",
"stream-to-pull-stream": "^1.7.2"
"mafmt": "^6.0.7",
"multiaddr": "^6.0.6",
"streaming-iterables": "^4.1.0"
},
"contributors": [
"Alan Shaw <alan@tableflip.io>",

17
src/adapter.js Normal file
View File

@ -0,0 +1,17 @@
'use strict'
const { Adapter } = require('interface-transport')
const withIs = require('class-is')
const TCP = require('.')
// Legacy adapter to old transport & connection interface
class TcpAdapter extends Adapter {
constructor () {
super(new TCP())
}
}
module.exports = withIs(TcpAdapter, {
className: 'TCP',
symbolName: '@libp2p/js-libp2p-tcp/tcp'
})

8
src/constants.js Normal file
View File

@ -0,0 +1,8 @@
'use strict'
// IPFS multi-address code
module.exports.IPFS_MA_CODE = 421
// Time to wait for a connection to close gracefully before destroying it
// manually
module.exports.CLOSE_TIMEOUT = 2000

View File

@ -1,55 +1,74 @@
'use strict'
const net = require('net')
const toPull = require('stream-to-pull-stream')
const mafmt = require('mafmt')
const withIs = require('class-is')
const includes = require('lodash.includes')
const isFunction = require('lodash.isfunction')
const Connection = require('interface-connection').Connection
const once = require('once')
const errcode = require('err-code')
const debug = require('debug')
const log = debug('libp2p:tcp:dial')
const Libp2pSocket = require('./socket')
const createListener = require('./listener')
const { AbortError } = require('interface-transport')
function noop () {}
class TCP {
dial (ma, options, callback) {
if (isFunction(options)) {
callback = options
options = {}
}
callback = once(callback || noop)
async dial (ma, options) {
const cOpts = ma.toOptions()
log('Connecting to %s %s', cOpts.port, cOpts.host)
log('Connecting to %s:%s', cOpts.host, cOpts.port)
const rawSocket = net.connect(cOpts)
const rawSocket = await this._connect(cOpts, options)
return new Libp2pSocket(rawSocket, ma, options)
}
rawSocket.once('timeout', () => {
log('timeout')
rawSocket.emit('error', new Error('Timeout'))
_connect (cOpts, options = {}) {
return new Promise((resolve, reject) => {
if ((options.signal || {}).aborted) {
return reject(new AbortError())
}
const start = Date.now()
const rawSocket = net.connect(cOpts)
const onError = (err) => {
const msg = `Error connecting to ${cOpts.host}:${cOpts.port}: ${err.message}`
done(errcode(msg, err.code))
}
const onTimeout = () => {
log('Timeout connecting to %s:%s', cOpts.host, cOpts.port)
const err = errcode(`Timeout after ${Date.now() - start}ms`, 'ETIMEDOUT')
rawSocket.emit('error', err)
}
const onConnect = () => {
log('Connected to %s:%s', cOpts.host, cOpts.port)
done(null, rawSocket)
}
const onAbort = () => {
log('Connect to %s:%s aborted', cOpts.host, cOpts.port)
rawSocket.destroy()
done(new AbortError())
}
const done = (err, res) => {
rawSocket.removeListener('error', onError)
rawSocket.removeListener('timeout', onTimeout)
rawSocket.removeListener('connect', onConnect)
options.signal && options.signal.removeEventListener(onAbort)
err ? reject(err) : resolve(res)
}
rawSocket.once('error', onError)
rawSocket.once('timeout', onTimeout)
rawSocket.once('connect', onConnect)
options.signal && options.signal.addEventListener('abort', onAbort)
})
rawSocket.once('error', callback)
rawSocket.once('connect', () => {
rawSocket.removeListener('error', callback)
callback()
})
const socket = toPull.duplex(rawSocket)
const conn = new Connection(socket)
conn.getObservedAddrs = (callback) => {
return callback(null, [ma])
}
return conn
}
createListener (options, handler) {
@ -59,8 +78,7 @@ class TCP {
}
handler = handler || noop
return createListener(handler)
return createListener(options, handler)
}
filter (multiaddrs) {

View File

@ -1,27 +1,173 @@
'use strict'
const multiaddr = require('multiaddr')
const Connection = require('interface-connection').Connection
const os = require('os')
const includes = require('lodash.includes')
const net = require('net')
const toPull = require('stream-to-pull-stream')
const EventEmitter = require('events').EventEmitter
const { AllListenersFailedError } = require('interface-transport')
const debug = require('debug')
const log = debug('libp2p:tcp:listen')
log.error = debug('libp2p:tcp:listen:error')
const Libp2pSocket = require('./socket')
const getMultiaddr = require('./get-multiaddr')
const IPFS_CODE = 421
const CLOSE_TIMEOUT = 2000
const c = require('./constants')
function noop () {}
module.exports = (handler) => {
const listener = new EventEmitter()
class Listener extends EventEmitter {
/**
*
* @param {object} options
* @param {function(Connection)} handler
*/
constructor (options, handler) {
super()
this._options = options
this._connectionHandler = handler
this._servers = new Set()
this.__connections = new Map()
}
const server = net.createServer((socket) => {
// Avoid uncaught errors cause by unstable connections
/**
* Closes all open servers
* @param {object} options
* @param {number} options.timeout how long before closure is forced, defaults to 2000 ms
* @returns {Promise}
*/
close (options = {}) {
if ([...this._servers].filter(server => server.listening).length === 0) {
return
}
// Close all running servers in parallel
return Promise.all(
[...this._servers].map(server => {
return new Promise((resolve, reject) => {
const start = Date.now()
// Attempt to stop the server. If it takes longer than the timeout,
// destroy all the underlying sockets manually.
const timeout = setTimeout(() => {
log('Timeout closing server after %dms, destroying connections manually', Date.now() - start)
resolve()
}, options.timeout || c.CLOSE_TIMEOUT)
server.once('close', () => {
clearTimeout(timeout)
this._servers.delete(server)
})
server.close((err) => err ? reject(err) : resolve())
})
})
).then(() => {
this.__connections.forEach((connection, key) => {
log('destroying %s', key)
connection.destroy()
})
this.__connections.clear()
this._servers.clear()
})
}
/**
* Creates servers listening on the given `addrs`
* @async
* @param {Array<Multiaddr>} addrs
*/
async listen (addrs) {
addrs = Array.isArray(addrs) ? addrs : [addrs]
let listeners = []
let errors = []
// Filter out duplicate ports, unless it's port 0
addrs = uniqueBy(addrs, (addr) => {
const port = Number(addr.toOptions().port)
return isNaN(port) || port === 0 ? addr.toString() : port
})
for (const ma of addrs) {
const lOpts = ma.toOptions()
listeners.push(
new Promise((resolve) => {
const server = net.createServer(this._onSocket.bind(this))
this._servers.add(server)
// TODO: clean these up
server.on('listening', () => this.emit('listening'))
server.on('close', () => this.emit('close'))
server.on('error', (err) => this.emit('error', err))
server.listen(lOpts.port, lOpts.host, (err) => {
if (err) {
errors.push(err)
return resolve()
}
log('Listening on %s %s', lOpts.port, lOpts.host)
resolve()
})
})
)
}
return Promise.all(listeners)
.then(() => {
errors.forEach((err) => {
log.error('received an error while attempting to listen', err)
})
// All servers failed to listen, throw an error
if (errors.length === listeners.length) {
throw new AllListenersFailedError()
}
})
}
/**
* Return the addresses we are listening on
* @returns {Array<Multiaddr>}
*/
getAddrs () {
const multiaddrs = []
this._servers.forEach(server => {
const address = server.address()
if (address.address === '0.0.0.0') {
const netInterfaces = os.networkInterfaces()
Object.keys(netInterfaces).forEach((niKey) => {
netInterfaces[niKey].forEach((ni) => {
if (ni.internal === false && ni.family === address.family) {
multiaddrs.push(
multiaddr.fromNodeAddress({
...address,
address: ni.address
}, 'tcp')
)
}
})
})
// TODO: handle IPv6 wildcard
} else {
multiaddrs.push(multiaddr.fromNodeAddress(address, 'tcp'))
}
})
if (multiaddrs.length === 0) {
throw new Error('Listener is not ready yet')
}
return multiaddrs
}
/**
* Handler for new sockets from `net.createServer`
* @param {net.Socket} socket
*/
_onSocket (socket) {
// Avoid uncaught errors caused by unstable connections
socket.on('error', noop)
const addr = getMultiaddr(socket)
@ -36,121 +182,31 @@ module.exports = (handler) => {
log('new connection', addr.toString())
const s = toPull.duplex(socket)
const s = new Libp2pSocket(socket, addr)
s.getObservedAddrs = (cb) => {
cb(null, [addr])
}
trackSocket(server, socket)
const conn = new Connection(s)
handler(conn)
listener.emit('connection', conn)
})
server.on('listening', () => listener.emit('listening'))
server.on('error', (err) => listener.emit('error', err))
server.on('close', () => listener.emit('close'))
// Keep track of open connections to destroy in case of timeout
server.__connections = {}
listener.close = (options, callback) => {
if (typeof options === 'function') {
callback = options
options = {}
}
callback = callback || noop
options = options || {}
const timeout = setTimeout(() => {
log('unable to close graciously, destroying conns')
Object.keys(server.__connections).forEach((key) => {
log('destroying %s', key)
server.__connections[key].destroy()
})
}, options.timeout || CLOSE_TIMEOUT)
server.close(callback)
server.once('close', () => {
clearTimeout(timeout)
// Track the connection
const key = `${socket.remoteAddress}:${socket.remotePort}`
this.__connections.set(key, socket)
socket.once('close', () => {
this.__connections.delete(key)
})
this._connectionHandler(s)
this.emit('connection', s)
}
let ipfsId
let listeningAddr
listener.listen = (ma, callback) => {
listeningAddr = ma
if (includes(ma.protoNames(), 'ipfs')) {
ipfsId = getIpfsId(ma)
listeningAddr = ma.decapsulate('ipfs')
}
const lOpts = listeningAddr.toOptions()
log('Listening on %s %s', lOpts.port, lOpts.host)
return server.listen(lOpts.port, lOpts.host, callback)
}
listener.getAddrs = (callback) => {
const multiaddrs = []
const address = server.address()
if (!address) {
return callback(new Error('Listener is not ready yet'))
}
// Because TCP will only return the IPv6 version
// we need to capture from the passed multiaddr
if (listeningAddr.toString().indexOf('ip4') !== -1) {
let m = listeningAddr.decapsulate('tcp')
m = m.encapsulate('/tcp/' + address.port)
if (ipfsId) {
m = m.encapsulate('/ipfs/' + ipfsId)
}
if (m.toString().indexOf('0.0.0.0') !== -1) {
const netInterfaces = os.networkInterfaces()
Object.keys(netInterfaces).forEach((niKey) => {
netInterfaces[niKey].forEach((ni) => {
if (ni.family === 'IPv4') {
multiaddrs.push(multiaddr(m.toString().replace('0.0.0.0', ni.address)))
}
})
})
} else {
multiaddrs.push(m)
}
}
if (address.family === 'IPv6') {
let ma = multiaddr('/ip6/' + address.address + '/tcp/' + address.port)
if (ipfsId) {
ma = ma.encapsulate('/ipfs/' + ipfsId)
}
multiaddrs.push(ma)
}
callback(null, multiaddrs)
}
return listener
}
function getIpfsId (ma) {
return ma.stringTuples().filter((tuple) => {
return tuple[0] === IPFS_CODE
})[0][1]
module.exports = (options, handler) => {
return new Listener(options, handler)
}
function trackSocket (server, socket) {
const key = `${socket.remoteAddress}:${socket.remotePort}`
server.__connections[key] = socket
socket.on('close', () => {
delete server.__connections[key]
})
/**
* Get unique values from `arr` using `getValue` to determine
* what is used for uniqueness
* @param {Array} arr The array to get unique values for
* @param {function(value)} getValue The function to determine what is compared
* @returns {Array}
*/
function uniqueBy (arr, getValue) {
return [...new Map(arr.map((i) => [getValue(i), i])).values()]
}

65
src/socket.js Normal file
View File

@ -0,0 +1,65 @@
'use strict'
const debug = require('debug')
const log = debug('libp2p:tcp:socket')
const c = require('./constants')
class Libp2pSocket {
constructor (rawSocket, ma, opts) {
this._rawSocket = rawSocket
this._ma = ma
this.sink = this._sink(opts)
this.source = rawSocket
}
_sink (opts = {}) {
// By default, close when the source is exhausted
const closeOnEnd = opts.closeOnEnd !== false
return (source) => this._write(source, closeOnEnd)
}
async _write (source, closeOnEnd) {
for await (const data of source) {
const flushed = this._rawSocket.write(data)
if (!flushed) {
await new Promise((resolve) => this._rawSocket.once('drain', resolve))
}
}
if (closeOnEnd) {
await this.close()
}
}
close (opts = {}) {
if (this._rawSocket.pending || this._rawSocket.destroyed) {
return
}
return new Promise((resolve, reject) => {
const start = Date.now()
// Attempt to end the socket. If it takes longer to close than the
// timeout, destroy it manually.
const timeout = setTimeout(() => {
const cOpts = this._ma.toOptions()
log('Timeout closing socket to %s:%s after %dms, destroying it manually',
cOpts.host, cOpts.port, Date.now() - start)
this._rawSocket.destroy()
resolve()
}, opts.timeout || c.CLOSE_TIMEOUT)
this._rawSocket.once('close', () => clearTimeout(timeout))
this._rawSocket.end((err) => err ? reject(err) : resolve())
})
}
getObservedAddrs () {
return [this._ma]
}
}
module.exports = Libp2pSocket

View File

@ -6,7 +6,7 @@ const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const TCP = require('../src')
const TCP = require('../../src/adapter')
const multiaddr = require('multiaddr')
const Connection = require('interface-connection').Connection

View File

@ -0,0 +1,111 @@
/* eslint-env mocha */
'use strict'
const pull = require('pull-stream')
const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const TCP = require('../../src/adapter')
const multiaddr = require('multiaddr')
describe('valid Connection', () => {
let tcp
beforeEach(() => {
tcp = new TCP()
})
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090')
it('get observed addrs', (done) => {
let dialerObsAddrs
const listener = tcp.createListener((conn) => {
expect(conn).to.exist()
conn.getObservedAddrs((err, addrs) => {
expect(err).to.not.exist()
dialerObsAddrs = addrs
pull(pull.empty(), conn)
})
})
listener.listen(ma, () => {
const conn = tcp.dial(ma)
pull(
conn,
pull.onEnd(endHandler)
)
function endHandler () {
conn.getObservedAddrs((err, addrs) => {
expect(err).to.not.exist()
pull(pull.empty(), conn)
closeAndAssert(listener, addrs)
})
}
function closeAndAssert (listener, addrs) {
listener.close(() => {
expect(addrs[0]).to.deep.equal(ma)
expect(dialerObsAddrs.length).to.equal(1)
done()
})
}
})
})
it('get Peer Info', (done) => {
const listener = tcp.createListener((conn) => {
expect(conn).to.exist()
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.exist()
expect(peerInfo).to.not.exist()
pull(pull.empty(), conn)
})
})
listener.listen(ma, () => {
const conn = tcp.dial(ma)
pull(conn, pull.onEnd(endHandler))
function endHandler () {
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.exist()
expect(peerInfo).to.not.exist()
listener.close(done)
})
}
})
})
it('set Peer Info', (done) => {
const listener = tcp.createListener((conn) => {
expect(conn).to.exist()
conn.setPeerInfo('batatas')
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist()
expect(peerInfo).to.equal('batatas')
pull(pull.empty(), conn)
})
})
listener.listen(ma, () => {
const conn = tcp.dial(ma)
pull(conn, pull.onEnd(endHandler))
function endHandler () {
conn.setPeerInfo('arroz')
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist()
expect(peerInfo).to.equal('arroz')
listener.close(done)
})
}
})
})
})

View File

@ -6,7 +6,7 @@ const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const TCP = require('../src')
const TCP = require('../../src/adapter')
const net = require('net')
const multiaddr = require('multiaddr')
const isCI = process.env.CI
@ -114,14 +114,14 @@ describe('listen', () => {
})
})
it('getAddrs preserves IPFS Id', (done) => {
it('getAddrs does not preserve IPFS Id', (done) => {
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const listener = tcp.createListener((conn) => {})
listener.listen(mh, () => {
listener.getAddrs((err, multiaddrs) => {
expect(err).to.not.exist()
expect(multiaddrs.length).to.equal(1)
expect(multiaddrs[0]).to.deep.equal(mh)
expect(multiaddrs[0]).to.deep.equal(mh.decapsulate('ipfs'))
listener.close(done)
})
})

View File

@ -1,23 +1,43 @@
/* eslint-env mocha */
'use strict'
const sinon = require('sinon')
const tests = require('interface-transport')
const multiaddr = require('multiaddr')
const net = require('net')
const TCP = require('../src')
describe('interface-transport compliance', () => {
tests({
setup (cb) {
let tcp = new TCP()
setup () {
const tcp = new TCP()
const addrs = [
multiaddr('/ip4/127.0.0.1/tcp/9091'),
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')
]
cb(null, tcp, addrs)
},
teardown (cb) {
cb()
// Used by the dial tests to simulate a delayed connect
const connector = {
delay (delayMs) {
const netConnect = net.connect
sinon.replace(net, 'connect', (opts) => {
const socket = netConnect(opts)
const socketEmit = socket.emit.bind(socket)
sinon.replace(socket, 'emit', (...args) => {
const time = args[0] === 'connect' ? delayMs : 0
setTimeout(() => socketEmit(...args), time)
})
return socket
})
},
restore () {
sinon.restore()
}
}
return { transport: tcp, addrs, connector }
}
})
})

View File

@ -1,7 +1,6 @@
/* eslint-env mocha */
'use strict'
const pull = require('pull-stream')
const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
@ -18,94 +17,39 @@ describe('valid Connection', () => {
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090')
it('get observed addrs', (done) => {
let dialerObsAddrs
it('get observed addrs', async () => {
// Create a Promise that resolves when a connection is handled
let handled
const handlerPromise = new Promise((resolve) => {
handled = resolve
})
const listener = tcp.createListener((conn) => {
const handler = async (conn) => {
expect(conn).to.exist()
conn.getObservedAddrs((err, addrs) => {
expect(err).to.not.exist()
dialerObsAddrs = addrs
pull(pull.empty(), conn)
})
})
const dialerObsAddrs = await conn.getObservedAddrs()
handled(dialerObsAddrs)
}
listener.listen(ma, () => {
const conn = tcp.dial(ma)
pull(
conn,
pull.onEnd(endHandler)
)
// Create a listener with the handler
const listener = tcp.createListener(handler)
function endHandler () {
conn.getObservedAddrs((err, addrs) => {
expect(err).to.not.exist()
pull(pull.empty(), conn)
closeAndAssert(listener, addrs)
})
}
// Listen on the multi-address
await listener.listen(ma)
function closeAndAssert (listener, addrs) {
listener.close(() => {
expect(addrs[0]).to.deep.equal(ma)
expect(dialerObsAddrs.length).to.equal(1)
done()
})
}
})
})
// Dial to that same address
const conn = await tcp.dial(ma)
const addrs = await conn.getObservedAddrs()
it('get Peer Info', (done) => {
const listener = tcp.createListener((conn) => {
expect(conn).to.exist()
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.exist()
expect(peerInfo).to.not.exist()
pull(pull.empty(), conn)
})
})
// Wait for the incoming dial to be handled
const dialerObsAddrs = await handlerPromise
listener.listen(ma, () => {
const conn = tcp.dial(ma)
// Close the listener
await listener.close()
pull(conn, pull.onEnd(endHandler))
function endHandler () {
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.exist()
expect(peerInfo).to.not.exist()
listener.close(done)
})
}
})
})
it('set Peer Info', (done) => {
const listener = tcp.createListener((conn) => {
expect(conn).to.exist()
conn.setPeerInfo('batatas')
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist()
expect(peerInfo).to.equal('batatas')
pull(pull.empty(), conn)
})
})
listener.listen(ma, () => {
const conn = tcp.dial(ma)
pull(conn, pull.onEnd(endHandler))
function endHandler () {
conn.setPeerInfo('arroz')
conn.getPeerInfo((err, peerInfo) => {
expect(err).to.not.exist()
expect(peerInfo).to.equal('arroz')
listener.close(done)
})
}
})
// The addresses should match
expect(addrs.length).to.equal(1)
expect(addrs[0]).to.deep.equal(ma)
expect(dialerObsAddrs.length).to.equal(1)
expect(dialerObsAddrs[0]).to.exist()
})
})

View File

@ -25,9 +25,11 @@ describe('filter addrs', () => {
const ma4 = multiaddr(base + '/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma5 = multiaddr(base + '/tcp/9090/http' + ipfs)
const ma6 = multiaddr('/ip4/127.0.0.1/tcp/9090/p2p-circuit' + ipfs)
const ma7 = multiaddr('/dns4/libp2p.io/tcp/9090')
const ma8 = multiaddr('/dnsaddr/libp2p.io/tcp/9090')
const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6])
expect(valid.length).to.equal(2)
const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6, ma7, ma8])
expect(valid.length).to.equal(4)
expect(valid[0]).to.deep.equal(ma1)
expect(valid[1]).to.deep.equal(ma4)
})

241
test/listen-dial.spec.js Normal file
View File

@ -0,0 +1,241 @@
/* eslint-env mocha */
'use strict'
const chai = require('chai')
const dirtyChai = require('dirty-chai')
const expect = chai.expect
chai.use(dirtyChai)
const TCP = require('../src')
const net = require('net')
const multiaddr = require('multiaddr')
const pipe = require('it-pipe')
const { collect, map } = require('streaming-iterables')
const isCI = process.env.CI
describe('listen', () => {
let tcp
beforeEach(() => {
tcp = new TCP()
})
it('close listener with connections, through timeout', async () => {
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const listener = tcp.createListener((conn) => {
pipe(conn, conn)
})
await listener.listen(mh)
const socket1 = net.connect(9090)
const socket2 = net.connect(9090)
socket1.write('Some data that is never handled')
socket1.end()
socket1.on('error', () => {})
socket2.on('error', () => {})
await new Promise((resolve) => {
socket1.on('connect', async () => {
await listener.close()
resolve()
})
})
})
it('listen on port 0', async () => {
const mh = multiaddr('/ip4/127.0.0.1/tcp/0')
const listener = tcp.createListener((conn) => {})
await listener.listen(mh)
await listener.close()
})
it('listen on IPv6 addr', async () => {
if (isCI) {
return
}
const mh = multiaddr('/ip6/::/tcp/9090')
const listener = tcp.createListener((conn) => {})
await listener.listen(mh)
await listener.close()
})
it('listen on any Interface', async () => {
const mh = multiaddr('/ip4/0.0.0.0/tcp/9090')
const listener = tcp.createListener((conn) => {})
await listener.listen(mh)
await listener.close()
})
it('getAddrs', async () => {
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090')
const listener = tcp.createListener((conn) => {})
await listener.listen(mh)
const multiaddrs = listener.getAddrs()
expect(multiaddrs.length).to.equal(1)
expect(multiaddrs[0]).to.deep.equal(mh)
await listener.close()
})
it('getAddrs on port 0 listen', async () => {
const mh = multiaddr('/ip4/127.0.0.1/tcp/0')
const listener = tcp.createListener((conn) => {})
await listener.listen(mh)
const multiaddrs = listener.getAddrs()
expect(multiaddrs.length).to.equal(1)
await listener.close()
})
it('getAddrs from listening on 0.0.0.0', async () => {
const mh = multiaddr('/ip4/0.0.0.0/tcp/9090')
const listener = tcp.createListener((conn) => {})
await listener.listen(mh)
const multiaddrs = listener.getAddrs()
expect(multiaddrs.length > 0).to.equal(true)
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 () => {
const mh = multiaddr('/ip4/0.0.0.0/tcp/0')
const listener = tcp.createListener((conn) => {})
await listener.listen(mh)
const multiaddrs = listener.getAddrs()
expect(multiaddrs.length > 0).to.equal(true)
expect(multiaddrs[0].toString().indexOf('0.0.0.0')).to.equal(-1)
await listener.close()
})
it('getAddrs does not preserve IPFS Id', async () => {
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const listener = tcp.createListener((conn) => {})
await listener.listen(mh)
const multiaddrs = listener.getAddrs()
expect(multiaddrs.length).to.equal(1)
expect(multiaddrs[0]).to.deep.equal(mh.decapsulate('ipfs'))
await listener.close()
})
})
describe('dial', () => {
let tcp
let listener
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090')
beforeEach(async () => {
tcp = new TCP()
listener = tcp.createListener((conn) => {
pipe(
conn,
map((x) => Buffer.from(x.toString() + '!')),
conn
)
})
await listener.listen(ma)
})
afterEach(() => listener.close())
it('dial on IPv4', async () => {
const values = await pipe(
['hey'],
await tcp.dial(ma),
collect
)
expect(values).to.eql([Buffer.from('hey!')])
})
it('dial on IPv6', async () => {
if (isCI) {
return
}
const ma = multiaddr('/ip6/::/tcp/9066')
const listener = tcp.createListener((conn) => {
pipe(conn, conn)
})
await listener.listen(ma)
const values = await pipe(
['hey'],
await tcp.dial(ma),
collect
)
expect(values).to.be.eql([Buffer.from('hey')])
await listener.close()
})
it('dial and destroy on listener', async () => {
let handled
const handledPromise = new Promise((resolve) => {
handled = resolve
})
const ma = multiaddr('/ip6/::/tcp/0')
const listener = tcp.createListener(async (conn) => {
await pipe(
[],
conn
)
handled()
})
await listener.listen(ma)
const addrs = listener.getAddrs()
await pipe(await tcp.dial(addrs[0]))
await handledPromise
await listener.close()
})
it('dial and destroy on dialer', async () => {
if (isCI) {
return
}
let handled
const handledPromise = new Promise((resolve) => {
handled = resolve
})
const ma = multiaddr('/ip6/::/tcp/0')
const listener = tcp.createListener(async (conn) => {
// pull(conn, pull.onEnd(destroyed))
await pipe(conn)
handled()
})
await listener.listen(ma)
const addrs = listener.getAddrs()
await pipe([], await tcp.dial(addrs[0]))
await handledPromise
await listener.close()
})
it('dial on IPv4 with IPFS Id', async () => {
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const conn = await tcp.dial(ma)
const res = await pipe(
['hey'],
conn,
collect
)
expect(res).to.be.eql([Buffer.from('hey!')])
})
})