diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..d437a13 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,33 @@ +name: ci +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - run: npm install + - run: npx aegir lint + - run: npx aegir dep-check -- -i wrtc -i electron-webrtc + test-node: + needs: check + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [windows-latest, ubuntu-latest, macos-latest] + node: [14, 15] + fail-fast: true + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v1 + with: + node-version: ${{ matrix.node }} + - run: npm install + - run: npx nyc --reporter=lcov aegir test -t node -- --bail + - uses: codecov/codecov-action@v1 \ No newline at end of file diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index c021036..0000000 --- a/.travis.yml +++ /dev/null @@ -1,34 +0,0 @@ -language: node_js -cache: npm -sudo: false - -stages: - - check - - test - - cov - -node_js: - - '10' - - '12' - -os: - - linux - - osx - - windows - -before_script: - - if [ "$TRAVIS_OS_NAME" = "linux" ]; then sudo sh -c 'echo 0 > /proc/sys/net/ipv6/conf/all/disable_ipv6'; fi - -script: npx nyc -s npm run test:node -- --bail -after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov - -jobs: - include: - - stage: check - os: linux - script: - - npx aegir dep-check - - npm run lint - -notifications: - email: false diff --git a/package.json b/package.json index adceebc..1b13650 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,13 @@ "url": "https://github.com/libp2p/js-libp2p-tcp.git" }, "keywords": [ - "IPFS" + "libp2p", + "network", + "p2p", + "peer", + "peer-to-peer", + "IPFS", + "TCP" ], "license": "MIT", "bugs": { @@ -29,24 +35,23 @@ }, "homepage": "https://github.com/libp2p/js-libp2p-tcp", "engines": { - "node": ">=6.0.0", - "npm": ">=3.0.0" + "node": ">=14.0.0" }, "devDependencies": { - "aegir": "^25.0.0", + "aegir": "^33.0.0", "it-pipe": "^1.1.0", - "libp2p-interfaces": "^0.4.0", - "sinon": "^9.0.0", + "libp2p-interfaces": "^0.9.0", + "sinon": "^10.0.1", "streaming-iterables": "^5.0.2" }, "dependencies": { "abortable-iterator": "^3.0.0", "class-is": "^1.1.0", - "debug": "^4.1.1", - "err-code": "^2.0.0", - "libp2p-utils": "^0.2.0", - "mafmt": "^8.0.0", - "multiaddr": "^8.0.0", + "debug": "^4.3.1", + "err-code": "^3.0.1", + "libp2p-utils": "^0.3.0", + "mafmt": "^9.0.0", + "multiaddr": "^9.0.1", "stream-to-it": "^0.2.2" }, "contributors": [ diff --git a/src/index.js b/src/index.js index b7f7ac7..5a1f069 100644 --- a/src/index.js +++ b/src/index.js @@ -12,11 +12,13 @@ const { AbortError } = require('abortable-iterator') const { CODE_CIRCUIT, CODE_P2P } = require('./constants') /** - * @class TCP + * @typedef {import('multiaddr').Multiaddr} Multiaddr + * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection */ + class TCP { /** - * @constructor + * @class * @param {object} options * @param {Upgrader} options.upgrader */ @@ -31,7 +33,7 @@ class TCP { * @async * @param {Multiaddr} ma * @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 */ async dial (ma, options) { @@ -48,7 +50,7 @@ class TCP { * @private * @param {Multiaddr} ma * @param {object} options - * @param {AbortSignal} options.signal Used to abort dial requests + * @param {AbortSignal} options.signal - Used to abort dial requests * @returns {Promise} Resolves a TCP Socket */ _connect (ma, options = {}) { @@ -107,6 +109,7 @@ class TCP { * Creates a TCP listener. The provided `handler` function will be called * anytime a new incoming Connection has been successfully upgraded via * `upgrader.upgradeInbound`. + * * @param {*} [options] * @param {function(Connection)} handler * @returns {Listener} A TCP listener @@ -122,6 +125,7 @@ class TCP { /** * Takes a list of `Multiaddr`s and returns only valid TCP addresses + * * @param {Multiaddr[]} multiaddrs * @returns {Multiaddr[]} Valid TCP multiaddrs */ diff --git a/src/listener.js b/src/listener.js index 9216aed..a7297ba 100644 --- a/src/listener.js +++ b/src/listener.js @@ -15,8 +15,9 @@ const { /** * Attempts to close the given maConn. If a failure occurs, it will be logged. + * * @private - * @param {MultiaddrConnection} maConn + * @param {import('libp2p-interfaces/src/transport/types').MultiaddrConnection} maConn */ async function attemptClose (maConn) { try { diff --git a/src/utils.js b/src/utils.js index 3e45430..abb4394 100644 --- a/src/utils.js +++ b/src/utils.js @@ -1,6 +1,6 @@ 'use strict' -const multiaddr = require('multiaddr') +const { Multiaddr } = require('multiaddr') const os = require('os') const { resolve } = require('path') const ProtoFamily = { ip4: 'IPv4', ip6: 'IPv6' } @@ -16,7 +16,7 @@ function multiaddrToNetConfig (addr) { } 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) } @@ -26,7 +26,7 @@ function isAnyAddr (ip) { /** * @private - * @param {string} family One of ['IPv6', 'IPv4'] + * @param {string} family - One of ['IPv6', 'IPv4'] * @returns {string[]} an array of ip address strings */ const networks = os.networkInterfaces() diff --git a/test/compliance.spec.js b/test/compliance.spec.js index 2ed7818..44ec277 100644 --- a/test/compliance.spec.js +++ b/test/compliance.spec.js @@ -3,7 +3,7 @@ const sinon = require('sinon') const tests = require('libp2p-interfaces/src/transport/tests') -const multiaddr = require('multiaddr') +const { Multiaddr } = require('multiaddr') const net = require('net') const TCP = require('../src') @@ -12,9 +12,9 @@ describe('interface-transport compliance', () => { setup ({ upgrader }) { const tcp = new TCP({ upgrader }) 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') + new Multiaddr('/ip4/127.0.0.1/tcp/9091'), + new Multiaddr('/ip4/127.0.0.1/tcp/9092'), + new Multiaddr('/ip4/127.0.0.1/tcp/9093') ] // Used by the dial tests to simulate a delayed connect diff --git a/test/connection.spec.js b/test/connection.spec.js index 445beb5..baf5739 100644 --- a/test/connection.spec.js +++ b/test/connection.spec.js @@ -3,7 +3,7 @@ const { expect } = require('aegir/utils/chai') const TCP = require('../src') -const multiaddr = require('multiaddr') +const { Multiaddr } = require('multiaddr') describe('valid localAddr and remoteAddr', () => { let tcp @@ -17,7 +17,7 @@ describe('valid localAddr and remoteAddr', () => { 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 () => { // 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 await handlerPromise - // Close the listener with two simultaneous calls to `close` + // Close the dialer with two simultaneous calls to `close` await Promise.race([ new Promise((resolve, reject) => setTimeout(() => reject(new Error('Timed out waiting for connection close')), 500)), await Promise.all([ @@ -81,5 +81,7 @@ describe('valid localAddr and remoteAddr', () => { dialerConn.close() ]) ]) + + await listener.close() }) }) diff --git a/test/filter.spec.js b/test/filter.spec.js index 2eb81d9..c4a7553 100644 --- a/test/filter.spec.js +++ b/test/filter.spec.js @@ -3,7 +3,7 @@ const { expect } = require('aegir/utils/chai') const TCP = require('../src') -const multiaddr = require('multiaddr') +const { Multiaddr } = require('multiaddr') describe('filter addrs', () => { const base = '/ip4/127.0.0.1' @@ -16,14 +16,14 @@ describe('filter addrs', () => { }) it('filter valid addrs for this transport', () => { - const ma1 = multiaddr(base + '/tcp/9090') - const ma2 = multiaddr(base + '/udp/9090') - const ma3 = multiaddr(base + '/tcp/9090/http') - 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 ma1 = new Multiaddr(base + '/tcp/9090') + const ma2 = new Multiaddr(base + '/udp/9090') + const ma3 = new Multiaddr(base + '/tcp/9090/http') + const ma4 = new Multiaddr(base + '/tcp/9090/ipfs/Qmb6owHp6eaWArVbcJJbQSyifyJBttMMjYV76N2hMbf5Vw') + const ma5 = new Multiaddr(base + '/tcp/9090/http' + ipfs) + const ma6 = new Multiaddr('/ip4/127.0.0.1/tcp/9090/p2p-circuit' + ipfs) + const ma7 = new Multiaddr('/dns4/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]) expect(valid.length).to.equal(4) @@ -32,7 +32,7 @@ describe('filter addrs', () => { }) 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) expect(valid.length).to.equal(1) diff --git a/test/listen-dial.spec.js b/test/listen-dial.spec.js index 4e48171..8af2a91 100644 --- a/test/listen-dial.spec.js +++ b/test/listen-dial.spec.js @@ -6,7 +6,7 @@ const TCP = require('../src') 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 { collect, map } = require('streaming-iterables') const isCI = process.env.CI @@ -37,7 +37,7 @@ describe('listen', () => { }) 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) => { pipe(conn, conn) }) @@ -62,14 +62,14 @@ describe('listen', () => { // Windows doesn't support unix paths 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) => {}) await listener.listen(mh) }) 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) => {}) await listener.listen(mh) }) @@ -78,19 +78,19 @@ describe('listen', () => { if (isCI) { return } - const mh = multiaddr('/ip6/::/tcp/9090') + const mh = new Multiaddr('/ip6/::/tcp/9090') listener = tcp.createListener((conn) => {}) await listener.listen(mh) }) 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) => {}) await listener.listen(mh) }) 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) => {}) await listener.listen(mh) @@ -100,7 +100,7 @@ describe('listen', () => { }) 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) => {}) await listener.listen(mh) @@ -109,7 +109,7 @@ describe('listen', () => { }) 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) => {}) await listener.listen(mh) @@ -119,7 +119,7 @@ describe('listen', () => { }) 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) => {}) await listener.listen(mh) @@ -129,7 +129,7 @@ describe('listen', () => { }) 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) => {}) await listener.listen(mh) @@ -142,7 +142,7 @@ describe('listen', () => { describe('dial', () => { let tcp 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 () => { tcp = new TCP({ @@ -177,7 +177,7 @@ describe('dial', () => { return } - const ma = multiaddr('/ip6/::/tcp/9066') + const ma = new Multiaddr('/ip6/::/tcp/9066') const listener = tcp.createListener((conn) => { pipe(conn, conn) }) @@ -195,7 +195,7 @@ describe('dial', () => { // Windows doesn't support unix paths 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) => { pipe(conn, conn) @@ -220,7 +220,7 @@ describe('dial', () => { handled = resolve }) - const ma = multiaddr('/ip6/::/tcp/0') + const ma = new Multiaddr('/ip6/::/tcp/0') const listener = tcp.createListener(async (conn) => { await pipe( @@ -248,7 +248,7 @@ describe('dial', () => { handled = resolve }) - const ma = multiaddr('/ip6/::/tcp/0') + const ma = new Multiaddr('/ip6/::/tcp/0') const listener = tcp.createListener(async (conn) => { // pull(conn, pull.onEnd(destroyed)) @@ -265,7 +265,7 @@ describe('dial', () => { }) 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 res = await pipe(