refactor(async): update transports subsystem (#461)

* test: remove all tests for a clean slate

The refactor will require a large number of updates to the tests. In order
to ensure we have done a decent deduplication, and have a cleaner suite of tests
we've removed all tests. This will also allow us to more easily see tests
for the refactored systems.

We have a record of the latest test suites in master, so we are not losing any history.

* chore: update tcp and websockets
* chore: remove other transports until they are converted
* chore: use mafmt and multiaddr async versions
* chore: add and fix dependencies
* chore: clean up travis file
* feat: add new transport manager
* docs: add constructor jsdocs
* refactor(config): check that transports exist
This also removes the other logic, it can be added when those subsystems are refactored

* chore(deps): use async peer-id and peer-info
* feat: wire up the transport manager with libp2p
* chore: remove superstruct dep

Author: jacobheun

.aegir.js

@@ -1,130 +1,23 @@
 'use strict'
 
-const pull = require('pull-stream')
-const WebSocketStarRendezvous = require('libp2p-websocket-star-rendezvous')
-const sigServer = require('libp2p-webrtc-star/src/sig-server')
-const promisify = require('promisify-es6')
-const mplex = require('pull-mplex')
-const spdy = require('libp2p-spdy')
-const PeerBook = require('peer-book')
-const PeerId = require('peer-id')
-const PeerInfo = require('peer-info')
-const path = require('path')
-const Switch = require('./src/switch')
-const WebSockets = require('libp2p-websockets')
-
-const Node = require('./test/utils/bundle-nodejs.js')
-const {
-  getPeerRelay,
-  WRTC_RENDEZVOUS_MULTIADDR,
-  WS_RENDEZVOUS_MULTIADDR
-} = require('./test/utils/constants')
-
-let wrtcRendezvous
-let wsRendezvous
-let node
-let peerInfo
-let switchA
-let switchB
-
-function echo (protocol, conn) { pull(conn, conn) }
-function idJSON (id) {
-  const p = path.join(__dirname, `./test/switch/test-data/id-${id}.json`)
-  return require(p)
-}
+const TransportManager = require('./src/transport-manager')
+const mockUpgrader = require('./test/utils/mockUpgrader')
+const { MULTIADDRS_WEBSOCKETS } = require('./test/fixtures/browser')
+let tm
 
-function createSwitchA () {
-  return new Promise((resolve, reject) => {
-    PeerId.createFromJSON(idJSON(1), (err, id) => {
-      if (err) { return reject(err) }
-
-      const peerA = new PeerInfo(id)
-      const maA = '/ip4/127.0.0.1/tcp/15337/ws'
-
-      peerA.multiaddrs.add(maA)
-      const sw = new Switch(peerA, new PeerBook())
-
-      sw.transport.add('ws', new WebSockets())
-      sw.start((err) => {
-        if (err) { return reject(err) }
-        resolve(sw)
-      })
-    })
-  })
-}
-
-function createSwitchB () {
-  return new Promise((resolve, reject) => {
-    PeerId.createFromJSON(idJSON(2), (err, id) => {
-      if (err) { return reject(err) }
-
-      const peerB = new PeerInfo(id)
-      const maB = '/ip4/127.0.0.1/tcp/15347/ws'
-
-      peerB.multiaddrs.add(maB)
-      const sw = new Switch(peerB, new PeerBook())
-
-      sw.transport.add('ws', new WebSockets())
-      sw.connection.addStreamMuxer(mplex)
-      sw.connection.addStreamMuxer(spdy)
-      sw.connection.reuse()
-      sw.handle('/echo/1.0.0', echo)
-      sw.start((err) => {
-        if (err) { return reject(err) }
-        resolve(sw)
-      })
-    })
-  })
-}
+const WebSockets = require('libp2p-websockets')
 
 const before = async () => {
-  [
-    wrtcRendezvous,
-    wsRendezvous,
-    peerInfo,
-    switchA,
-    switchB
-  ] = await Promise.all([
-    sigServer.start({
-      port: WRTC_RENDEZVOUS_MULTIADDR.nodeAddress().port
-      // cryptoChallenge: true TODO: needs https://github.com/libp2p/js-libp2p-webrtc-star/issues/128
-    }),
-    WebSocketStarRendezvous.start({
-      port: WS_RENDEZVOUS_MULTIADDR.nodeAddress().port,
-      refreshPeerListIntervalMS: 1000,
-      strictMultiaddr: false,
-      cryptoChallenge: true
-    }),
-    getPeerRelay(),
-    createSwitchA(),
-    createSwitchB()
-  ])
-
-  node = new Node({
-    peerInfo,
-    config: {
-      relay: {
-        enabled: true,
-        hop: {
-          enabled: true,
-          active: true
-        }
-      }
-    }
+  tm = new TransportManager({
+    upgrader: mockUpgrader,
+    onConnection: () => {}
   })
-
-  node.handle('/echo/1.0.0', (protocol, conn) => pull(conn, conn))
-  await node.start()
+  tm.add(WebSockets.prototype[Symbol.toStringTag], WebSockets)
+  await tm.listen(MULTIADDRS_WEBSOCKETS)
 }
 
-const after = () => {
-  return Promise.all([
-    wrtcRendezvous.stop(),
-    wsRendezvous.stop(),
-    node.stop(),
-    promisify(switchA.stop, { context: switchA })(),
-    promisify(switchB.stop, { context: switchB })()
-  ])
+const after = async () => {
+  await tm.close()
 }
 
 module.exports = {

.travis.yml

@@ -29,16 +29,14 @@ jobs:
       addons:
         chrome: stable
       script:
-        - npx aegir test -t browser
-        - npx aegir test -t webworker
+        - npx aegir test -t browser -t webworker
 
     - stage: test
       name: firefox
       addons:
         firefox: latest
       script:
-        - npx aegir test -t browser -- --browsers FirefoxHeadless
-        - npx aegir test -t webworker -- --browsers FirefoxHeadless
+        - npx aegir test -t browser -t webworker -- --browsers FirefoxHeadless
 
 notifications:
   email: false

package.json

@@ -36,9 +36,6 @@
   },
   "homepage": "https://libp2p.io",
   "license": "MIT",
-  "browser": {
-    "./test/utils/bundle-nodejs": "./test/utils/bundle-browser"
-  },
   "engines": {
     "node": ">=10.0.0",
     "npm": ">=6.0.0"
@@ -54,25 +51,24 @@
     "interface-connection": "~0.3.3",
     "latency-monitor": "~0.2.1",
     "libp2p-crypto": "^0.16.2",
-    "libp2p-websockets": "^0.12.2",
-    "mafmt": "^6.0.7",
+    "mafmt": "^7.0.0",
     "merge-options": "^1.0.1",
     "moving-average": "^1.0.0",
-    "multiaddr": "^6.1.0",
+    "multiaddr": "^7.1.0",
     "multistream-select": "~0.14.6",
     "once": "^1.4.0",
+    "p-settle": "^3.1.0",
     "peer-book": "^0.9.1",
-    "peer-id": "^0.12.2",
-    "peer-info": "~0.15.1",
+    "peer-id": "^0.13.3",
+    "peer-info": "^0.17.0",
+    "promisify-es6": "^1.0.3",
+    "protons": "^1.0.1",
     "pull-cat": "^1.1.11",
     "pull-defer": "~0.2.3",
     "pull-handshake": "^1.1.4",
     "pull-reader": "^1.3.1",
     "pull-stream": "^3.6.9",
-    "promisify-es6": "^1.0.3",
-    "protons": "^1.0.1",
     "retimer": "^2.0.0",
-    "superstruct": "^0.6.0",
     "xsalsa20": "^1.0.2"
   },
   "devDependencies": {
@@ -96,10 +92,8 @@
     "libp2p-pnet": "~0.1.0",
     "libp2p-secio": "^0.11.1",
     "libp2p-spdy": "^0.13.2",
-    "libp2p-tcp": "^0.13.0",
-    "libp2p-webrtc-star": "^0.16.1",
-    "libp2p-websocket-star": "~0.10.2",
-    "libp2p-websocket-star-rendezvous": "~0.4.1",
+    "libp2p-tcp": "^0.14.1",
+    "libp2p-websockets": "^0.13.0",
     "lodash.times": "^4.3.2",
     "nock": "^10.0.6",
     "portfinder": "^1.0.20",

src/config.js

@@ -1,8 +1,6 @@
 'use strict'
 
 const mergeOptions = require('merge-options')
-const { struct, superstruct } = require('superstruct')
-const { optional, list } = struct
 
 const DefaultConfig = {
   connectionManager: {
@@ -38,67 +36,10 @@ const DefaultConfig = {
   }
 }
 
-// Define custom types
-const s = superstruct({
-  types: {
-    transport: value => {
-      if (value.length === 0) return 'ERROR_EMPTY'
-      value.forEach(i => {
-        if (!i.dial) return 'ERR_NOT_A_TRANSPORT'
-      })
-      return true
-    },
-    protector: value => {
-      if (!value.protect) return 'ERR_NOT_A_PROTECTOR'
-      return true
-    }
-  }
-})
-
-const modulesSchema = s({
-  connEncryption: optional(list([s('object|function')])),
-  // this is hacky to simulate optional because interface doesnt work correctly with it
-  // change to optional when fixed upstream
-  connProtector: s('undefined|protector'),
-  contentRouting: optional(list(['object'])),
-  dht: optional(s('null|function|object')),
-  pubsub: optional(s('null|function|object')),
-  peerDiscovery: optional(list([s('object|function')])),
-  peerRouting: optional(list(['object'])),
-  streamMuxer: optional(list([s('object|function')])),
-  transport: 'transport'
-})
-
-const configSchema = s({
-  peerDiscovery: 'object?',
-  relay: 'object?',
-  dht: 'object?',
-  pubsub: 'object?'
-})
-
-const optionsSchema = s({
-  switch: 'object?',
-  connectionManager: 'object?',
-  datastore: 'object?',
-  peerInfo: 'object',
-  peerBook: 'object?',
-  modules: modulesSchema,
-  config: configSchema
-})
-
 module.exports.validate = (opts) => {
   opts = mergeOptions(DefaultConfig, opts)
-  const [error, options] = optionsSchema.validate(opts)
 
-  // Improve errors throwed, reduce stack by throwing here and add reason to the message
-  if (error) {
-    throw new Error(`${error.message}${error.reason ? ' - ' + error.reason : ''}`)
-  } else {
-    // Throw when dht is enabled but no dht module provided
-    if (options.config.dht.enabled) {
-      s('function|object')(options.modules.dht)
-    }
-  }
+  if (opts.modules.transport.length < 1) throw new Error("'options.modules.transport' must contain at least 1 transport")
 
-  return options
+  return opts
 }

src/errors.js

@@ -9,5 +9,9 @@ exports.codes = {
   DHT_DISABLED: 'ERR_DHT_DISABLED',
   PUBSUB_NOT_STARTED: 'ERR_PUBSUB_NOT_STARTED',
   ERR_NODE_NOT_STARTED: 'ERR_NODE_NOT_STARTED',
-  ERR_DISCOVERED_SELF: 'ERR_DISCOVERED_SELF'
+  ERR_NO_VALID_ADDRESSES: 'ERR_NO_VALID_ADDRESSES',
+  ERR_DISCOVERED_SELF: 'ERR_DISCOVERED_SELF',
+  ERR_DUPLICATE_TRANSPORT: 'ERR_DUPLICATE_TRANSPORT',
+  ERR_INVALID_KEY: 'ERR_INVALID_KEY',
+  ERR_TRANSPORT_UNAVAILABLE: 'ERR_TRANSPORT_UNAVAILABLE'
 }