chore: add osx back

License: MIT
Signed-off-by: Jacob Heun <jacobheun@gmail.com>

.gitignore

@@ -12,7 +12,6 @@ logs
 *.log
 
 coverage
-.nyc_output
 
 # Runtime data
 pids

.travis.yml

@@ -1,6 +1,5 @@
 language: node_js
 cache: npm
-sudo: false
 
 stages:
   - check
@@ -9,24 +8,27 @@ stages:
 
 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:
+    - os: linux
+      sudo: false
+      before_script: sudo sh -c 'echo 0 > /proc/sys/net/ipv6/conf/all/disable_ipv6'
+
+    - os: windows
+      filter_secrets: false
+      cache: false
+
+    - os: osx
+
     - stage: check
       os: linux
       script:
         - npx aegir build --bundlesize
+        - npx aegir commitlint --travis
         - npx aegir dep-check
         - npm run lint
 

CHANGELOG.md

@@ -1,8 +1,3 @@
-<a name="0.13.1"></a>
-## [0.13.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.13.0...v0.13.1) (2019-08-08)
-
-
-
 <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)
 

README.md

@@ -1,13 +1,13 @@
 # js-libp2p-tcp
 
-[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
-[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
-[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
-[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
-[![](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-tcp)
-[![](https://img.shields.io/travis/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://travis-ci.com/libp2p/js-libp2p-tcp)
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
+[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
+[![Build Status](https://travis-ci.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://travis-ci.org/libp2p/js-libp2p-tcp)
+[![Coverage Status](https://coveralls.io/repos/github/libp2p/js-libp2p-tcp/badge.svg?branch=master)](https://coveralls.io/github/libp2p/js-libp2p-tcp?branch=master)
 [![Dependency Status](https://david-dm.org/libp2p/js-libp2p-tcp.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-tcp)
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
+![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
+![](https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square)
 
 [![](https://raw.githubusercontent.com/libp2p/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
 [![](https://raw.githubusercontent.com/libp2p/interface-connection/master/img/badge.png)](https://github.com/libp2p/interface-connection)
@@ -56,7 +56,7 @@ const listener = tcp.createListener((socket) => {
   )
 })
 
-await listener.listen(addr)
+await listener.listen([addr])
 console.log('listening')
 
 const socket = await tcp.dial(addr)

appveyor.yml

@@ -0,0 +1,29 @@
+# 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.
+version: "{build}"
+
+environment:
+  matrix:
+    - nodejs_version: "6"
+    - nodejs_version: "8"
+
+matrix:
+  fast_finish: true
+
+install:
+  # Install Node.js
+  - ps: Install-Product node $env:nodejs_version
+
+  # Upgrade npm
+  - npm install -g npm
+
+  # Output our current versions for debugging
+  - node --version
+  - npm --version
+
+  # Install our package dependencies
+  - npm install
+
+test_script:
+  - npm run test:node
+
+build: off

ci/Jenkinsfile

@@ -0,0 +1,2 @@
+// 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.
+javascript()

circle.yml

@@ -0,0 +1,15 @@
+# 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.
+machine:
+  node:
+    version: stable
+
+dependencies:
+  pre:
+    - google-chrome --version
+    - curl -L -o google-chrome.deb https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
+    - sudo dpkg -i google-chrome.deb || true
+    - sudo apt-get update
+    - sudo apt-get install -f
+    - sudo apt-get install --only-upgrade lsb-base
+    - sudo dpkg -i google-chrome.deb
+    - google-chrome --version

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p-tcp",
-  "version": "0.13.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",
@@ -10,13 +10,15 @@
     "test:node": "aegir test -t node",
     "build": "aegir build",
     "docs": "aegir docs",
-    "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",
-    "coverage": "nyc --reporter=text --reporter=lcov npm run test:node"
+    "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 publish"
   },
   "pre-push": [
-    "lint"
+    "lint",
+    "test"
   ],
   "repository": {
     "type": "git",
@@ -35,25 +37,26 @@
     "npm": ">=3.0.0"
   },
   "devDependencies": {
-    "aegir": "^20.0.0",
-    "chai": "^4.2.0",
+    "aegir": "^18.1.1",
+    "chai": "^4.1.2",
     "dirty-chai": "^2.0.1",
+    "lodash.isfunction": "^3.0.9",
     "pull-stream": "^3.6.9",
-    "sinon": "^7.4.1"
+    "sinon": "^7.3.1"
   },
   "dependencies": {
-    "abortable-iterator": "^2.1.0",
+    "abort-controller": "^3.0.0",
     "class-is": "^1.1.0",
     "debug": "^4.1.1",
     "err-code": "^1.1.2",
     "interface-connection": "~0.3.3",
-    "interface-transport": "~0.5.2",
-    "ip-address": "^6.1.0",
-    "it-pipe": "^1.0.1",
+    "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.8",
-    "multiaddr": "^6.1.0",
+    "mafmt": "^6.0.7",
+    "multiaddr": "^6.0.6",
     "streaming-iterables": "^4.1.0"
   },
   "contributors": [
@@ -68,12 +71,10 @@
     "Jacob Heun <jacobheun@gmail.com>",
     "Jacob Heun <jake@andyet.net>",
     "João Antunes <j.goncalo.antunes@gmail.com>",
-    "Linus Unnebäck <linus@folkdatorn.se>",
     "Pedro Teixeira <i@pgte.me>",
     "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>"
+    "TomCoded <tomtinkerer@gmail.com>"
   ]
 }

src/index.js

@@ -18,7 +18,7 @@ function noop () {}
 class TCP {
   async dial (ma, options) {
     const cOpts = ma.toOptions()
-    log('Dialing %s:%s', cOpts.host, cOpts.port)
+    log('Connecting to %s:%s', cOpts.host, cOpts.port)
 
     const rawSocket = await this._connect(cOpts, options)
     return new Libp2pSocket(rawSocket, ma, options)
@@ -34,14 +34,13 @@ class TCP {
       const rawSocket = net.connect(cOpts)
 
       const onError = (err) => {
-        const msg = `Error dialing ${cOpts.host}:${cOpts.port}: ${err.message}`
+        const msg = `Error connecting to ${cOpts.host}:${cOpts.port}: ${err.message}`
         done(errcode(msg, err.code))
       }
 
       const onTimeout = () => {
-        log('Timeout dialing %s:%s', cOpts.host, cOpts.port)
+        log('Timeout connecting to %s:%s', cOpts.host, cOpts.port)
         const err = errcode(`Timeout after ${Date.now() - start}ms`, 'ETIMEDOUT')
-        // Note: this will result in onError() being called
         rawSocket.emit('error', err)
       }
 
@@ -51,7 +50,7 @@ class TCP {
       }
 
       const onAbort = () => {
-        log('Dial to %s:%s aborted', cOpts.host, cOpts.port)
+        log('Connect to %s:%s aborted', cOpts.host, cOpts.port)
         rawSocket.destroy()
         done(new AbortError())
       }
@@ -60,8 +59,7 @@ class TCP {
         rawSocket.removeListener('error', onError)
         rawSocket.removeListener('timeout', onTimeout)
         rawSocket.removeListener('connect', onConnect)
-
-        options.signal && options.signal.removeEventListener('abort', onAbort)
+        options.signal && options.signal.removeEventListener(onAbort)
 
         err ? reject(err) : resolve(res)
       }
@@ -80,7 +78,7 @@ class TCP {
     }
 
     handler = handler || noop
-    return createListener(handler)
+    return createListener(options, handler)
   }
 
   filter (multiaddrs) {

src/listener.js

@@ -2,25 +2,173 @@
 
 const multiaddr = require('multiaddr')
 const os = require('os')
-const includes = require('lodash.includes')
 const net = require('net')
 const EventEmitter = require('events').EventEmitter
+const { AllListenersFailedError } = require('interface-transport')
 const debug = require('debug')
 const log = debug('libp2p:tcp:listen')
-const logError = debug('libp2p:tcp:listen:error')
+log.error = debug('libp2p:tcp:listen:error')
 
 const Libp2pSocket = require('./socket')
 const getMultiaddr = require('./get-multiaddr')
 const c = require('./constants')
 
-module.exports = (handler) => {
-  const listener = new EventEmitter()
+function noop () {}
 
-  const server = net.createServer((socket) => {
-    // Avoid uncaught errors caused by unstable connections
-    socket.on('error', (err) => {
-      logError('Error emitted by server handler socket: ' + err.message)
+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()
+  }
+
+  /**
+   * 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)
     if (!addr) {
@@ -35,124 +183,30 @@ module.exports = (handler) => {
     log('new connection', addr.toString())
 
     const s = new Libp2pSocket(socket, addr)
-    trackSocket(server, socket)
 
-    handler && handler(s)
-    listener.emit('connection', s)
-  })
-
-  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 = {}) => {
-    if (!server.listening) {
-      return
-    }
-
-    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)
-        Object.keys(server.__connections).forEach((key) => {
-          log('destroying %s', key)
-          server.__connections[key].destroy()
-        })
-        resolve()
-      }, options.timeout || c.CLOSE_TIMEOUT)
-
-      server.once('close', () => clearTimeout(timeout))
-
-      server.close((err) => err ? reject(err) : resolve())
+    // 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) => {
-    listeningAddr = ma
-    if (includes(ma.protoNames(), 'ipfs')) {
-      ipfsId = getIpfsId(ma)
-      listeningAddr = ma.decapsulate('ipfs')
-    }
-
-    const lOpts = listeningAddr.toOptions()
-    return new Promise((resolve, reject) => {
-      server.listen(lOpts.port, lOpts.host, (err) => {
-        if (err) {
-          return reject(err)
-        }
-
-        log('Listening on %s %s', lOpts.port, lOpts.host)
-        resolve()
-      })
-    })
-  }
-
-  listener.getAddrs = () => {
-    const multiaddrs = []
-    const address = server.address()
-
-    if (!address) {
-      throw 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)
-    }
-
-    return multiaddrs
-  }
-
-  return listener
 }
 
-function getIpfsId (ma) {
-  return ma.stringTuples().filter((tuple) => {
-    return tuple[0] === c.IPFS_MA_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.once('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()]
 }

src/socket.js

@@ -1,47 +1,27 @@
 'use strict'
 
-const abortable = require('abortable-iterator')
 const debug = require('debug')
 const log = debug('libp2p:tcp:socket')
 
 const c = require('./constants')
 
 class Libp2pSocket {
-  constructor (rawSocket, ma, opts = {}) {
+  constructor (rawSocket, ma, opts) {
     this._rawSocket = rawSocket
     this._ma = ma
 
     this.sink = this._sink(opts)
-    this.source = opts.signal ? abortable(rawSocket, opts.signal) : rawSocket
+    this.source = rawSocket
   }
 
-  _sink (opts) {
+  _sink (opts = {}) {
     // By default, close when the source is exhausted
     const closeOnEnd = opts.closeOnEnd !== false
-
-    return async (source) => {
-      try {
-        const src = opts.signal ? abortable(source, opts.signal) : source
-        await this._write(src, closeOnEnd)
-      } catch (err) {
-        // If the connection is aborted just close the socket
-        if (err.type === 'aborted') {
-          return this.close()
-        }
-
-        throw err
-      }
-    }
+    return (source) => this._write(source, closeOnEnd)
   }
 
   async _write (source, closeOnEnd) {
     for await (const data of source) {
-      if (this._rawSocket.destroyed) {
-        const cOpts = this._ma.toOptions()
-        throw new Error('Cannot write %d bytes to destroyed socket %s:%s',
-          data.length, cOpts.host, cOpts.port)
-      }
-
       const flushed = this._rawSocket.write(data)
       if (!flushed) {
         await new Promise((resolve) => this._rawSocket.once('drain', resolve))

test/adapter/listen-dial.spec.js

@@ -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)
       })
     })

test/listen-dial.spec.js

@@ -38,7 +38,7 @@ describe('listen', () => {
 
     await new Promise((resolve) => {
       socket1.on('connect', async () => {
-        await listener.close({ timeout: 100 })
+        await listener.close()
         resolve()
       })
     })
@@ -115,14 +115,14 @@ describe('listen', () => {
     await listener.close()
   })
 
-  it('getAddrs preserves IPFS Id', async () => {
+  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)
+    expect(multiaddrs[0]).to.deep.equal(mh.decapsulate('ipfs'))
 
     await listener.close()
   })
@@ -221,7 +221,7 @@ describe('dial', () => {
 
     await listener.listen(ma)
     const addrs = listener.getAddrs()
-    await pipe(await tcp.dial(addrs[0]))
+    await pipe([], await tcp.dial(addrs[0]))
 
     await handledPromise
     await listener.close()