fluencelabs/js-libp2p-tcp
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-tcp synced 2025-04-26 16:42:35 +00:00
Code Issues Projects Releases Wiki Activity

chore: update deps

Browse Source
This commit is contained in:
Vasco Santos 2021-04-09 10:19:09 +02:00
parent d39ad01e96
commit 578276bd40
8 changed files with 67 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
package.json
View File

@ -21,7 +21,13 @@
"url": "https://github.com/libp2p/js-libp2p-tcp.git" "url": "https://github.com/libp2p/js-libp2p-tcp.git"
}, },
"keywords": [ "keywords": [
"IPFS" "libp2p",
"network",
"p2p",
"peer",
"peer-to-peer",
"IPFS",
"TCP"
], ],
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
@ -29,24 +35,23 @@
}, },
"homepage": "https://github.com/libp2p/js-libp2p-tcp", "homepage": "https://github.com/libp2p/js-libp2p-tcp",
"engines": { "engines": {
"node": ">=6.0.0", "node": ">=14.0.0"
"npm": ">=3.0.0"
}, },
"devDependencies": { "devDependencies": {
"aegir": "^25.0.0", "aegir": "^33.0.0",
"it-pipe": "^1.1.0", "it-pipe": "^1.1.0",
"libp2p-interfaces": "^0.4.0", "libp2p-interfaces": "^0.9.0",
"sinon": "^9.0.0", "sinon": "^10.0.1",
"streaming-iterables": "^5.0.2" "streaming-iterables": "^5.0.2"
}, },
"dependencies": { "dependencies": {
"abortable-iterator": "^3.0.0", "abortable-iterator": "^3.0.0",
"class-is": "^1.1.0", "class-is": "^1.1.0",
"debug": "^4.1.1", "debug": "^4.3.1",
"err-code": "^2.0.0", "err-code": "^3.0.1",
"libp2p-utils": "^0.2.0", "libp2p-utils": "^0.3.0",
"mafmt": "^8.0.0", "mafmt": "^8.0.4",
"multiaddr": "^8.0.0", "multiaddr": "^9.0.1",
"stream-to-it": "^0.2.2" "stream-to-it": "^0.2.2"
}, },
"contributors": [ "contributors": [

13
src/index.js
View File

@ -11,12 +11,17 @@ 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')
/**
* @typedef {import('multiaddr').Multiaddr} Multiaddr
* @typedef {import('libp2p-interfaces/src/connection').Connection} Connection
*/
/** /**
* @class TCP * @class TCP
*/ */
class TCP { class TCP {
/** /**
* @constructor * @class
* @param {object} options * @param {object} options
* @param {Upgrader} options.upgrader * @param {Upgrader} options.upgrader
*/ */
@ -31,7 +36,7 @@ class TCP {
* @async * @async
* @param {Multiaddr} ma * @param {Multiaddr} ma
* @param {object} options * @param {object} options
* @param {AbortSignal} options.signal Used to abort dial requests * @param {AbortSignal} options.signal - Used to abort dial requests
* @returns {Connection} An upgraded Connection * @returns {Connection} An upgraded Connection
*/ */
async dial (ma, options) { async dial (ma, options) {
@ -48,7 +53,7 @@ class TCP {
* @private * @private
* @param {Multiaddr} ma * @param {Multiaddr} ma
* @param {object} options * @param {object} options
* @param {AbortSignal} options.signal Used to abort dial requests * @param {AbortSignal} options.signal - Used to abort dial requests
* @returns {Promise<Socket>} Resolves a TCP Socket * @returns {Promise<Socket>} Resolves a TCP Socket
*/ */
_connect (ma, options = {}) { _connect (ma, options = {}) {
@ -107,6 +112,7 @@ class TCP {
* Creates a TCP listener. The provided `handler` function will be called * Creates a TCP listener. The provided `handler` function will be called
* anytime a new incoming Connection has been successfully upgraded via * anytime a new incoming Connection has been successfully upgraded via
* `upgrader.upgradeInbound`. * `upgrader.upgradeInbound`.
*
* @param {*} [options] * @param {*} [options]
* @param {function(Connection)} handler * @param {function(Connection)} handler
* @returns {Listener} A TCP listener * @returns {Listener} A TCP listener
@ -122,6 +128,7 @@ class TCP {
/** /**
* Takes a list of `Multiaddr`s and returns only valid TCP addresses * Takes a list of `Multiaddr`s and returns only valid TCP addresses
*
* @param {Multiaddr[]} multiaddrs * @param {Multiaddr[]} multiaddrs
* @returns {Multiaddr[]} Valid TCP multiaddrs * @returns {Multiaddr[]} Valid TCP multiaddrs
*/ */

3
src/listener.js
View File

@ -15,8 +15,9 @@ const {
/** /**
* Attempts to close the given maConn. If a failure occurs, it will be logged. * Attempts to close the given maConn. If a failure occurs, it will be logged.
*
* @private * @private
* @param {MultiaddrConnection} maConn * @param {import('libp2p-interfaces/src/transport/types').MultiaddrConnection} maConn
*/ */
async function attemptClose (maConn) { async function attemptClose (maConn) {
try { try {

6
src/utils.js
View File

@ -1,6 +1,6 @@
'use strict' 'use strict'
const multiaddr = require('multiaddr') const { Multiaddr } = require('multiaddr')
const os = require('os') const os = require('os')
const { resolve } = require('path') const { resolve } = require('path')
const ProtoFamily = { ip4: 'IPv4', ip6: 'IPv6' } const ProtoFamily = { ip4: 'IPv4', ip6: 'IPv6' }
@ -16,7 +16,7 @@ function multiaddrToNetConfig (addr) {
} }
function getMultiaddrs (proto, ip, port) { function getMultiaddrs (proto, ip, port) {
const toMa = ip => multiaddr(`/${proto}/${ip}/tcp/${port}`) const toMa = ip => new Multiaddr(`/${proto}/${ip}/tcp/${port}`)
return (isAnyAddr(ip) ? getNetworkAddrs(ProtoFamily[proto]) : [ip]).map(toMa) return (isAnyAddr(ip) ? getNetworkAddrs(ProtoFamily[proto]) : [ip]).map(toMa)
} }
@ -26,7 +26,7 @@ function isAnyAddr (ip) {
/** /**
* @private * @private
* @param {string} family One of ['IPv6', 'IPv4'] * @param {string} family - One of ['IPv6', 'IPv4']
* @returns {string[]} an array of ip address strings * @returns {string[]} an array of ip address strings
*/ */
const networks = os.networkInterfaces() const networks = os.networkInterfaces()

8
test/compliance.spec.js
View File

@ -3,7 +3,7 @@
const sinon = require('sinon') const sinon = require('sinon')
const tests = require('libp2p-interfaces/src/transport/tests') 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')
@ -12,9 +12,9 @@ describe('interface-transport compliance', () => {
setup ({ upgrader }) { setup ({ upgrader }) {
const tcp = new TCP({ upgrader }) const tcp = new TCP({ upgrader })
const addrs = [ const addrs = [
multiaddr('/ip4/127.0.0.1/tcp/9091'), new Multiaddr('/ip4/127.0.0.1/tcp/9091'),
multiaddr('/ip4/127.0.0.1/tcp/9092'), new Multiaddr('/ip4/127.0.0.1/tcp/9092'),
multiaddr('/ip4/127.0.0.1/tcp/9093') new Multiaddr('/ip4/127.0.0.1/tcp/9093')
] ]
// Used by the dial tests to simulate a delayed connect // Used by the dial tests to simulate a delayed connect

8
test/connection.spec.js
View File

@ -3,7 +3,7 @@
const { expect } = require('aegir/utils/chai') const { expect } = require('aegir/utils/chai')
const TCP = require('../src') const TCP = require('../src')
const multiaddr = require('multiaddr') const { Multiaddr } = require('multiaddr')
describe('valid localAddr and remoteAddr', () => { describe('valid localAddr and remoteAddr', () => {
let tcp let tcp
@ -17,7 +17,7 @@ describe('valid localAddr and remoteAddr', () => {
tcp = new TCP({ upgrader: mockUpgrader }) tcp = new TCP({ upgrader: mockUpgrader })
}) })
const ma = multiaddr('/ip4/127.0.0.1/tcp/0') const ma = new Multiaddr('/ip4/127.0.0.1/tcp/0')
it('should resolve port 0', async () => { it('should resolve port 0', async () => {
// Create a Promise that resolves when a connection is handled // Create a Promise that resolves when a connection is handled
@ -73,7 +73,7 @@ describe('valid localAddr and remoteAddr', () => {
// Wait for the incoming dial to be handled // Wait for the incoming dial to be handled
await handlerPromise await handlerPromise
// Close the listener with two simultaneous calls to `close` // Close the dialer with two simultaneous calls to `close`
await Promise.race([ await Promise.race([
new Promise((resolve, reject) => setTimeout(() => reject(new Error('Timed out waiting for connection close')), 500)), new Promise((resolve, reject) => setTimeout(() => reject(new Error('Timed out waiting for connection close')), 500)),
await Promise.all([ await Promise.all([
@ -81,5 +81,7 @@ describe('valid localAddr and remoteAddr', () => {
dialerConn.close() dialerConn.close()
]) ])
]) ])
await listener.close()
}) })
}) })

20
test/filter.spec.js
View File

@ -3,7 +3,7 @@
const { expect } = require('aegir/utils/chai') const { expect } = require('aegir/utils/chai')
const TCP = require('../src') const TCP = require('../src')
const multiaddr = require('multiaddr') const { Multiaddr } = require('multiaddr')
describe('filter addrs', () => { describe('filter addrs', () => {
const base = '/ip4/127.0.0.1' const base = '/ip4/127.0.0.1'
@ -16,14 +16,14 @@ describe('filter addrs', () => {
}) })
it('filter valid addrs for this transport', () => { it('filter valid addrs for this transport', () => {
const ma1 = multiaddr(base + '/tcp/9090') const ma1 = new Multiaddr(base + '/tcp/9090')
const ma2 = multiaddr(base + '/udp/9090') const ma2 = new Multiaddr(base + '/udp/9090')
const ma3 = multiaddr(base + '/tcp/9090/http') const ma3 = new Multiaddr(base + '/tcp/9090/http')
const ma4 = multiaddr(base + '/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw') const ma4 = new Multiaddr(base + '/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const ma5 = multiaddr(base + '/tcp/9090/http' + ipfs) const ma5 = new Multiaddr(base + '/tcp/9090/http' + ipfs)
const ma6 = multiaddr('/ip4/127.0.0.1/tcp/9090/p2p-circuit' + ipfs) const ma6 = new Multiaddr('/ip4/127.0.0.1/tcp/9090/p2p-circuit' + ipfs)
const ma7 = multiaddr('/dns4/libp2p.io/tcp/9090') const ma7 = new Multiaddr('/dns4/libp2p.io/tcp/9090')
const ma8 = multiaddr('/dnsaddr/libp2p.io/tcp/9090') const ma8 = new Multiaddr('/dnsaddr/libp2p.io/tcp/9090')
const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6, ma7, ma8]) const valid = tcp.filter([ma1, ma2, ma3, ma4, ma5, ma6, ma7, ma8])
expect(valid.length).to.equal(4) expect(valid.length).to.equal(4)
@ -32,7 +32,7 @@ describe('filter addrs', () => {
}) })
it('filter a single addr for this transport', () => { it('filter a single addr for this transport', () => {
const ma1 = multiaddr(base + '/tcp/9090') const ma1 = new Multiaddr(base + '/tcp/9090')
const valid = tcp.filter(ma1) const valid = tcp.filter(ma1)
expect(valid.length).to.equal(1) expect(valid.length).to.equal(1)

34
test/listen-dial.spec.js
View File

@ -6,7 +6,7 @@ const TCP = require('../src')
const net = require('net') const net = require('net')
const os = require('os') const os = require('os')
const path = require('path') 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
@ -37,7 +37,7 @@ describe('listen', () => {
}) })
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 = new Multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
listener = tcp.createListener((conn) => { listener = tcp.createListener((conn) => {
pipe(conn, conn) pipe(conn, conn)
}) })
@ -62,14 +62,14 @@ describe('listen', () => {
// Windows doesn't support unix paths // Windows doesn't support unix paths
skipOnWindows('listen on path', async () => { skipOnWindows('listen on path', async () => {
const mh = multiaddr(`/unix${path.resolve(os.tmpdir(), '/tmp/p2pd.sock')}`) const mh = new Multiaddr(`/unix${path.resolve(os.tmpdir(), '/tmp/p2pd.sock')}`)
listener = tcp.createListener((conn) => {}) listener = tcp.createListener((conn) => {})
await listener.listen(mh) 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 = new Multiaddr('/ip4/127.0.0.1/tcp/0')
listener = tcp.createListener((conn) => {}) listener = tcp.createListener((conn) => {})
await listener.listen(mh) await listener.listen(mh)
}) })
@ -78,19 +78,19 @@ describe('listen', () => {
if (isCI) { if (isCI) {
return return
} }
const mh = multiaddr('/ip6/::/tcp/9090') const mh = new Multiaddr('/ip6/::/tcp/9090')
listener = tcp.createListener((conn) => {}) listener = tcp.createListener((conn) => {})
await listener.listen(mh) await listener.listen(mh)
}) })
it('listen on any Interface', async () => { it('listen on any Interface', async () => {
const mh = multiaddr('/ip4/0.0.0.0/tcp/9090') const mh = new Multiaddr('/ip4/0.0.0.0/tcp/9090')
listener = tcp.createListener((conn) => {}) listener = tcp.createListener((conn) => {})
await listener.listen(mh) await listener.listen(mh)
}) })
it('getAddrs', async () => { it('getAddrs', async () => {
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090') const mh = new Multiaddr('/ip4/127.0.0.1/tcp/9090')
listener = tcp.createListener((conn) => {}) listener = tcp.createListener((conn) => {})
await listener.listen(mh) await listener.listen(mh)
@ -100,7 +100,7 @@ describe('listen', () => {
}) })
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 = new Multiaddr('/ip4/127.0.0.1/tcp/0')
listener = tcp.createListener((conn) => {}) listener = tcp.createListener((conn) => {})
await listener.listen(mh) await listener.listen(mh)
@ -109,7 +109,7 @@ describe('listen', () => {
}) })
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 = new Multiaddr('/ip4/0.0.0.0/tcp/9090')
listener = tcp.createListener((conn) => {}) listener = tcp.createListener((conn) => {})
await listener.listen(mh) await listener.listen(mh)
@ -119,7 +119,7 @@ describe('listen', () => {
}) })
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 = new Multiaddr('/ip4/0.0.0.0/tcp/0')
listener = tcp.createListener((conn) => {}) listener = tcp.createListener((conn) => {})
await listener.listen(mh) await listener.listen(mh)
@ -129,7 +129,7 @@ describe('listen', () => {
}) })
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 = new Multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
listener = tcp.createListener((conn) => {}) listener = tcp.createListener((conn) => {})
await listener.listen(mh) await listener.listen(mh)
@ -142,7 +142,7 @@ describe('listen', () => {
describe('dial', () => { describe('dial', () => {
let tcp let tcp
let listener let listener
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090') const ma = new Multiaddr('/ip4/127.0.0.1/tcp/9090')
beforeEach(async () => { beforeEach(async () => {
tcp = new TCP({ tcp = new TCP({
@ -177,7 +177,7 @@ describe('dial', () => {
return return
} }
const ma = multiaddr('/ip6/::/tcp/9066') const ma = new Multiaddr('/ip6/::/tcp/9066')
const listener = tcp.createListener((conn) => { const listener = tcp.createListener((conn) => {
pipe(conn, conn) pipe(conn, conn)
}) })
@ -195,7 +195,7 @@ describe('dial', () => {
// Windows doesn't support unix paths // Windows doesn't support unix paths
skipOnWindows('dial on path', async () => { skipOnWindows('dial on path', async () => {
const ma = multiaddr(`/unix${path.resolve(os.tmpdir(), '/tmp/p2pd.sock')}`) const ma = new Multiaddr(`/unix${path.resolve(os.tmpdir(), '/tmp/p2pd.sock')}`)
const listener = tcp.createListener((conn) => { const listener = tcp.createListener((conn) => {
pipe(conn, conn) pipe(conn, conn)
@ -220,7 +220,7 @@ describe('dial', () => {
handled = resolve handled = resolve
}) })
const ma = multiaddr('/ip6/::/tcp/0') const ma = new Multiaddr('/ip6/::/tcp/0')
const listener = tcp.createListener(async (conn) => { const listener = tcp.createListener(async (conn) => {
await pipe( await pipe(
@ -248,7 +248,7 @@ describe('dial', () => {
handled = resolve handled = resolve
}) })
const ma = multiaddr('/ip6/::/tcp/0') const ma = new Multiaddr('/ip6/::/tcp/0')
const listener = tcp.createListener(async (conn) => { const listener = tcp.createListener(async (conn) => {
// pull(conn, pull.onEnd(destroyed)) // pull(conn, pull.onEnd(destroyed))
@ -265,7 +265,7 @@ describe('dial', () => {
}) })
it('dial on IPv4 with IPFS Id', async () => { it('dial on IPv4 with IPFS Id', async () => {
const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw') const ma = new Multiaddr('/ip4/127.0.0.1/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw')
const conn = await tcp.dial(ma) const conn = await tcp.dial(ma)
const res = await pipe( const res = await pipe(