chore: release version v0.28.3

* fix: catch pipe errors

There were some pipe errors not being caught. This can result in unhandled exceptions being thrown

* fix: catch pipe errors in identify push handler

CHANGELOG.md

@@ -1,3 +1,23 @@
+<a name="0.28.3"></a>
+## [0.28.3](https://github.com/libp2p/js-libp2p/compare/v0.28.2...v0.28.3) (2020-06-18)
+
+
+### Bug Fixes
+
+* catch pipe errors ([#678](https://github.com/libp2p/js-libp2p/issues/678)) ([a8219e6](https://github.com/libp2p/js-libp2p/commit/a8219e6))
+
+
+
+<a name="0.28.2"></a>
+## [0.28.2](https://github.com/libp2p/js-libp2p/compare/v0.28.1...v0.28.2) (2020-06-15)
+
+
+### Reverts
+
+* "fix: throw if no conn encryption module provided ([#665](https://github.com/libp2p/js-libp2p/issues/665))" ([b621fbd](https://github.com/libp2p/js-libp2p/commit/b621fbd))
+
+
+
 <a name="0.28.1"></a>
 ## [0.28.1](https://github.com/libp2p/js-libp2p/compare/v0.28.0...v0.28.1) (2020-06-12)
 

RELEASE.md

@@ -26,6 +26,7 @@
 - Documentation
   - [ ] Ensure that README.md is up to date
   - [ ] Ensure that all the examples run
+  - [ ] Ensure that [libp2p/docs](https://github.com/libp2p/docs) is updated
 - Communication
   - [ ] Create the release issue
   - [ ] Take a snapshot between of everyone that has contributed to this release (including its subdeps in IPFS, libp2p, IPLD and multiformats) using [`name-your-contributors`](https://www.npmjs.com/package/name-your-contributors). Generate a nice markdown list with [this script](https://gist.github.com/jacobheun/d2ff479ca991733c13cdcf688a1317e5)

doc/API.md

@@ -85,17 +85,17 @@ Creates an instance of Libp2p.
 | Name | Type | Description |
 |------|------|-------------|
 | options | `object` | libp2p options |
-| options.modules | [`Array<object>`](./CONFIGURATION.md#modules) | libp2p [modules](./CONFIGURATION.md#modules) to use |
+| options.modules | [`Array<object>`](./CONFIGURATION.md#modules) | libp2p modules to use |
 | [options.addresses] | `{ listen: Array<string>, announce: Array<string>, noAnnounce: Array<string> }` | Addresses for transport listening and to advertise to the network |
 | [options.config] | `object` | libp2p modules configuration and core configuration |
-| [options.connectionManager] | [`object`](./CONFIGURATION.md#configuring-connection-manager) | libp2p Connection Manager [configuration](./CONFIGURATION.md#configuring-connection-manager) |
-| [options.transportManager] | [`object`](./CONFIGURATION.md#configuring-transport-manager) | libp2p transport manager [configuration]((./CONFIGURATION.md#configuring-transport-manager)) |
+| [options.connectionManager] | [`object`](./CONFIGURATION.md#configuring-connection-manager) | libp2p Connection Manager configuration |
+| [options.transportManager] | [`object`](./CONFIGURATION.md#configuring-transport-manager) | libp2p transport manager configuration |
 | [options.datastore] | `object` | must implement [ipfs/interface-datastore](https://github.com/ipfs/interface-datastore) (in memory datastore will be used if not provided) |
-| [options.dialer] | [`object`](./CONFIGURATION.md#configuring-dialing) | libp2p Dialer [configuration]((./CONFIGURATION.md#configuring-dialing))
-| [options.keychain] | [`object`](./CONFIGURATION.md#setup-with-keychain) | keychain [configuration]((./CONFIGURATION.md#setup-with-keychain)) |
-| [options.metrics] | [`object`](./CONFIGURATION.md#configuring-metrics) | libp2p Metrics [configuration]((./CONFIGURATION.md#configuring-metrics)) |
+| [options.dialer] | [`object`](./CONFIGURATION.md#configuring-dialing) | libp2p Dialer configuration
+| [options.keychain] | [`object`](./CONFIGURATION.md#setup-with-keychain) | keychain configuration |
+| [options.metrics] | [`object`](./CONFIGURATION.md#configuring-metrics) | libp2p Metrics configuration
 | [options.peerId] | [`PeerId`][peer-id] | peerId instance (it will be created if not provided) |
-| [options.peerStore] | [`object`](./CONFIGURATION.md#configuring-peerstore) | libp2p PeerStore [configuration]((./CONFIGURATION.md#configuring-peerstore)) |
+| [options.peerStore] | [`object`](./CONFIGURATION.md#configuring-peerstore) | libp2p PeerStore configuration |
 
 For Libp2p configurations and modules details read the [Configuration Document](./CONFIGURATION.md).
 

doc/CONFIGURATION.md

@@ -52,7 +52,7 @@ The libp2p ecosystem contains at least one module for each of these subsystems.
 
 After selecting the modules to use, it is also possible to configure each one according to your needs.
 
-Bear in mind that a **transport** and **connection encryption** are **required**, while all the other subsystems are optional.
+Bear in mind that only a **transport** and **connection encryption** are required, while all the other subsystems are optional.
 
 ### Transport
 

examples/discovery-mechanisms/2.js

@@ -21,7 +21,7 @@ const createNode = async () => {
     },
     config: {
       peerDiscovery: {
-        [MulticastDNS.tag]: {
+        mdns: {
           interval: 20e3,
           enabled: true
         }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p",
-  "version": "0.28.1",
+  "version": "0.28.3",
   "description": "JavaScript implementation of libp2p, a modular peer to peer network stack",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",

src/errors.js

@@ -2,15 +2,13 @@
 
 exports.messages = {
   NOT_STARTED_YET: 'The libp2p node is not started yet',
-  DHT_DISABLED: 'DHT is not available',
-  CONN_ENCRYPTION_REQUIRED: 'At least one connection encryption module is required'
+  DHT_DISABLED: 'DHT is not available'
 }
 
 exports.codes = {
   DHT_DISABLED: 'ERR_DHT_DISABLED',
   PUBSUB_NOT_STARTED: 'ERR_PUBSUB_NOT_STARTED',
   DHT_NOT_STARTED: 'ERR_DHT_NOT_STARTED',
-  CONN_ENCRYPTION_REQUIRED: 'ERR_CONN_ENCRYPTION_REQUIRED',
   ERR_CONNECTION_ENDED: 'ERR_CONNECTION_ENDED',
   ERR_CONNECTION_FAILED: 'ERR_CONNECTION_FAILED',
   ERR_NODE_NOT_STARTED: 'ERR_NODE_NOT_STARTED',

src/identify/index.js

@@ -208,7 +208,7 @@ class IdentifyService {
    * @param {*} options.stream
    * @param {Connection} options.connection
    */
-  _handleIdentify ({ connection, stream }) {
+  async _handleIdentify ({ connection, stream }) {
     let publicKey = Buffer.alloc(0)
     if (this.peerId.pubKey) {
       publicKey = this.peerId.pubKey.bytes
@@ -223,12 +223,16 @@ class IdentifyService {
       protocols: Array.from(this._protocols.keys())
     })
 
-    pipe(
-      [message],
-      lp.encode(),
-      stream,
-      consume
-    )
+    try {
+      await pipe(
+        [message],
+        lp.encode(),
+        stream,
+        consume
+      )
+    } catch (err) {
+      log.error('could not respond to identify request', err)
+    }
   }
 
   /**
@@ -239,17 +243,16 @@ class IdentifyService {
    * @param {Connection} options.connection
    */
   async _handlePush ({ connection, stream }) {
-    const [data] = await pipe(
-      [],
-      stream,
-      lp.decode(),
-      take(1),
-      toBuffer,
-      collect
-    )
-
     let message
     try {
+      const [data] = await pipe(
+        [],
+        stream,
+        lp.decode(),
+        take(1),
+        toBuffer,
+        collect
+      )
       message = Message.decode(data)
     } catch (err) {
       return log.error('received invalid message', err)

src/index.js

@@ -6,7 +6,6 @@ const globalThis = require('ipfs-utils/src/globalthis')
 const log = debug('libp2p')
 log.error = debug('libp2p:error')
 
-const errCode = require('err-code')
 const PeerId = require('peer-id')
 
 const peerRouting = require('./peer-routing')
@@ -14,7 +13,7 @@ const contentRouting = require('./content-routing')
 const pubsub = require('./pubsub')
 const getPeer = require('./get-peer')
 const { validate: validateConfig } = require('./config')
-const { codes, messages } = require('./errors')
+const { codes } = require('./errors')
 
 const AddressManager = require('./address-manager')
 const ConnectionManager = require('./connection-manager')
@@ -116,13 +115,12 @@ class Libp2p extends EventEmitter {
     this.registrar.handle = this.handle
 
     // Attach crypto channels
-    if (!this._modules.connEncryption || !this._modules.connEncryption.length) {
-      throw errCode(new Error(messages.CONN_ENCRYPTION_REQUIRED), codes.CONN_ENCRYPTION_REQUIRED)
+    if (this._modules.connEncryption) {
+      const cryptos = this._modules.connEncryption
+      cryptos.forEach((crypto) => {
+        this.upgrader.cryptos.set(crypto.protocol, crypto)
+      })
     }
-    const cryptos = this._modules.connEncryption
-    cryptos.forEach((crypto) => {
-      this.upgrader.cryptos.set(crypto.protocol, crypto)
-    })
 
     this.dialer = new Dialer({
       transportManager: this.transportManager,

src/metrics/index.js

@@ -215,7 +215,7 @@ class Metrics {
 
     const _sink = stream.sink
     stream.sink = source => {
-      pipe(
+      return pipe(
         source,
         tap(chunk => metrics._onMessage({
           remotePeer,

src/pnet/index.js

@@ -17,7 +17,7 @@ const handshake = require('it-handshake')
 const { NONCE_LENGTH } = require('./key-generator')
 const debug = require('debug')
 const log = debug('libp2p:pnet')
-log.err = debug('libp2p:pnet:err')
+log.error = debug('libp2p:pnet:err')
 
 /**
  * Takes a Private Shared Key (psk) and provides a `protect` method
@@ -69,7 +69,7 @@ class Protector {
       // Decrypt all inbound traffic
       createUnboxStream(remoteNonce, this.psk),
       external
-    )
+    ).catch(log.error)
 
     return internal
   }

src/upgrader.js

@@ -258,7 +258,7 @@ class Upgrader {
       }
 
       // Pipe all data through the muxer
-      pipe(upgradedConn, muxer, upgradedConn)
+      pipe(upgradedConn, muxer, upgradedConn).catch(log.error)
     }
 
     const _timeline = maConn.timeline

test/core/encryption.spec.js

@@ -1,57 +0,0 @@
-'use strict'
-/* eslint-env mocha */
-
-const chai = require('chai')
-chai.use(require('dirty-chai'))
-chai.use(require('chai-as-promised'))
-const { expect } = chai
-
-const Transport = require('libp2p-websockets')
-const { NOISE: Crypto } = require('libp2p-noise')
-
-const Libp2p = require('../../src')
-const { codes: ErrorCodes } = require('../../src/errors')
-const { createPeerId } = require('../utils/creators/peer')
-
-describe('Connection encryption configuration', () => {
-  let peerId
-
-  before(async () => {
-    [peerId] = await createPeerId()
-  })
-
-  it('is required', async () => {
-    const config = {
-      peerId,
-      modules: {
-        transport: [Transport]
-      }
-    }
-
-    await expect(Libp2p.create(config)).to.eventually.be.rejected()
-      .and.to.have.property('code', ErrorCodes.CONN_ENCRYPTION_REQUIRED)
-  })
-
-  it('is required and needs at least one module', async () => {
-    const config = {
-      peerId,
-      modules: {
-        transport: [Transport],
-        connEncryption: []
-      }
-    }
-    await expect(Libp2p.create(config)).to.eventually.be.rejected()
-      .and.to.have.property('code', ErrorCodes.CONN_ENCRYPTION_REQUIRED)
-  })
-
-  it('can be created', async () => {
-    const config = {
-      peerId,
-      modules: {
-        transport: [Transport],
-        connEncryption: [Crypto]
-      }
-    }
-    await Libp2p.create(config)
-  })
-})

test/core/listening.node.js

@@ -6,7 +6,6 @@ chai.use(require('dirty-chai'))
 const { expect } = chai
 
 const Transport = require('libp2p-tcp')
-const { NOISE: Crypto } = require('libp2p-noise')
 
 const { create } = require('../../src')
 const peerUtils = require('../utils/creators/peer')
@@ -32,8 +31,7 @@ describe('Listening', () => {
         listen: [listenAddr]
       },
       modules: {
-        transport: [Transport],
-        connEncryption: [Crypto]
+        transport: [Transport]
       }
     })
 

test/transports/transport-manager.spec.js

@@ -9,7 +9,6 @@ const sinon = require('sinon')
 
 const multiaddr = require('multiaddr')
 const Transport = require('libp2p-websockets')
-const { NOISE: Crypto } = require('libp2p-noise')
 const AddressManager = require('../../src/address-manager')
 const TransportManager = require('../../src/transport-manager')
 const mockUpgrader = require('../utils/mockUpgrader')
@@ -111,8 +110,7 @@ describe('libp2p.transportManager', () => {
     libp2p = new Libp2p({
       peerId,
       modules: {
-        transport: [Transport],
-        connEncryption: [Crypto]
+        transport: [Transport]
       }
     })
 
@@ -130,8 +128,7 @@ describe('libp2p.transportManager', () => {
     libp2p = new Libp2p({
       peerId,
       modules: {
-        transport: [spy],
-        connEncryption: [Crypto]
+        transport: [spy]
       },
       config: {
         transport: {
@@ -155,8 +152,7 @@ describe('libp2p.transportManager', () => {
     libp2p = new Libp2p({
       peerId,
       modules: {
-        transport: [Transport],
-        connEncryption: [Crypto]
+        transport: [Transport]
       }
     })
 
@@ -192,8 +188,7 @@ describe('libp2p.transportManager (dial only)', () => {
         listen: [multiaddr('/ip4/127.0.0.1/tcp/0')]
       },
       modules: {
-        transport: [Transport],
-        connEncryption: [Crypto]
+        transport: [Transport]
       }
     })
 
@@ -217,8 +212,7 @@ describe('libp2p.transportManager (dial only)', () => {
         faultTolerance: FaultTolerance.NO_FATAL
       },
       modules: {
-        transport: [Transport],
-        connEncryption: [Crypto]
+        transport: [Transport]
       }
     })