chore: release version v0.27.1

When connecting to go-IPFS from a webworker, the stream opened by
the ping protocol is never closed.

The change here uses `take` to only receive one buffer from the
remote node before closing the stream.

CHANGELOG.md

@@ -1,3 +1,13 @@
+<a name="0.27.1"></a>
+## [0.27.1](https://github.com/libp2p/js-libp2p/compare/v0.27.0...v0.27.1) (2020-02-03)
+
+
+### Bug Fixes
+
+* stop stream after first pong received ([#545](https://github.com/libp2p/js-libp2p/issues/545)) ([be8fc9d](https://github.com/libp2p/js-libp2p/commit/be8fc9d))
+
+
+
 <a name="0.27.0"></a>
 # [0.27.0](https://github.com/libp2p/js-libp2p/compare/v0.26.2...v0.27.0) (2020-01-28)
 

README.md

@@ -30,6 +30,9 @@
 
 We've come a long way, but this project is still in Alpha, lots of development is happening, API might change, beware of the Dragons 🐉..
 
+The documentation in the master branch may contain changes from a pre-release.
+If you are looking for the documentation of the latest release, you can view the latest release on [**npm**](https://www.npmjs.com/package/libp2p), or select the tag in github that matches the version you are looking for.
+
 **Want to get started?** Check our [examples folder](/examples).
 
 [**`Weekly Core Dev Calls`**](https://github.com/ipfs/pm/issues/650)

doc/API.md

@@ -51,7 +51,7 @@ Creates an instance of Libp2p.
 | [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` | libp2p Dialer configuration
 | [options.metrics] | `Object` | libp2p Metrics configuration
-| [options.peerInfo] | [PeerInfo](https://github.com/libp2p/js-peer-info) | peerInfo instance (it will be created if not provided) |
+| [options.peerInfo] | [`PeerInfo`][peer-info] | peerInfo instance (it will be created if not provided) |
 
 For Libp2p configurations and modules details read the [Configuration Document](./CONFIGURATION.md).
 
@@ -73,7 +73,7 @@ const options = {}
 const libp2p = await Libp2p.create(options)
 ```
 
-Note: The `PeerInfo` option is not required and will be generated if it is not provided.
+Note: The [`PeerInfo`][peer-info] option is not required and will be generated if it is not provided.
 
 <details><summary>Alternative</summary>
 As an alternative, it is possible to create a Libp2p instance with the constructor:
@@ -92,7 +92,7 @@ const libp2p = new Libp2p(options)
 
 Required keys in the `options` object:
 
-- `peerInfo`: instance of [PeerInfo][] that contains the [PeerId][], Keys and [multiaddrs][multiaddr] of the libp2p Node (optional when using `.create`).
+- `peerInfo`: instance of [`PeerInfo`][peer-info] that contains the [`PeerId`][peer-id], Keys and [multiaddrs][multiaddr] of the libp2p Node (optional when using `.create`).
 - `modules.transport`: An array that must include at least 1 compliant transport. See [modules that implement the transport interface](https://github.com/libp2p/js-interfaces/tree/master/src/transport#modules-that-implement-the-interface).
 
 </details>
@@ -182,7 +182,7 @@ Dials to another peer in the network and establishes the connection.
 
 | Name | Type | Description |
 |------|------|-------------|
-| peer | [PeerInfo](https://github.com/libp2p/js-peer-info), [PeerId][peer-id], [multiaddr](https://github.com/multiformats/js-multiaddr), `string` | peer to dial |
+| peer | [`PeerInfo`][peer-info]\|[`PeerId`][peer-id]\|[`Multiaddr`][multiaddr]\|`string` | peer to dial |
 | [options] | `Object` | dial options |
 | [options.signal] | [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) | An `AbortSignal` instance obtained from an [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) that can be used to abort the connection before it completes |
 
@@ -217,7 +217,7 @@ Dials to another peer in the network and selects a protocol to communicate with
 
 | Name | Type | Description |
 |------|------|-------------|
-| peer | [PeerInfo](https://github.com/libp2p/js-peer-info), [PeerId][peer-id], [multiaddr](https://github.com/multiformats/js-multiaddr), `string` | peer to dial |
+| peer | [`PeerInfo`][peer-info]\|[`PeerId`][peer-id]\|[`Multiaddr`][multiaddr]\|`string` | peer to dial |
 | protocols | `String|Array<String>` |  A list of protocols (or single protocol) to negotiate with. Protocols are attempted in order until a match is made. (e.g '/ipfs/bitswap/1.1.0') |
 | [options] | `Object` | dial options |
 | [options.signal] | [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) | An `AbortSignal` instance obtained from an [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController) that can be used to abort the connection before it completes |
@@ -250,7 +250,7 @@ Attempts to gracefully close an open connection to the given peer. If the connec
 
 | Name | Type | Description |
 |------|------|-------------|
-| peer | [PeerInfo](https://github.com/libp2p/js-peer-info), [PeerId][peer-id], [multiaddr](https://github.com/multiformats/js-multiaddr), `string` | peer to hang up |
+| peer | [`PeerInfo`][peer-info]\|[`PeerId`][peer-id]\|[`Multiaddr`][multiaddr]\|`string` | peer to hang up |
 
 #### Returns
 
@@ -321,7 +321,7 @@ Pings a given peer and get the operation's latency.
 
 | Name | Type | Description |
 |------|------|-------------|
-| peer | `PeerInfo|PeerId|Multiaddr|string` | peer to ping |
+| peer | [`PeerInfo`][peer-info]\|[`PeerId`][peer-id]\|[`Multiaddr`][multiaddr]\|`string` | peer to ping |
 
 #### Returns
 
@@ -374,7 +374,7 @@ Once a content router succeeds, the iteration will stop. If the DHT is enabled,
 
 | Name | Type | Description |
 |------|------|-------------|
-| cid | [`CID`](https://github.com/multiformats/js-cid) | cid to find |
+| cid | [`CID`][cid] | cid to find |
 | options | `Object` | operation options |
 | options.timeout | `number` | maximum time the query should run |
 | options.maxNumProviders | `number` | maximum number of providers to find |
@@ -383,7 +383,7 @@ Once a content router succeeds, the iteration will stop. If the DHT is enabled,
 
 | Type | Description |
 |------|-------------|
-| `AsyncIterator<PeerInfo>` |  Async iterator for [`PeerInfo`](https://github.com/libp2p/js-peer-info) |
+| `AsyncIterator<PeerInfo>` |  Async iterator for [`PeerInfo`][peer-info] |
 
 #### Example
 
@@ -404,7 +404,7 @@ Iterates over all content routers in parallel, in order to notify it is a provid
 
 | Name | Type | Description |
 |------|------|-------------|
-| cid | [`CID`](https://github.com/multiformats/js-cid) | cid to provide |
+| cid | [`CID`][cid] | cid to provide |
 
 #### Returns
 
@@ -649,7 +649,7 @@ Enables users to change the value of certain peers in a range of 0 to 1. Peers w
 
 | Name | Type | Description |
 |------|------|-------------|
-| peerId | `PeerId` | The peer to set the value for |
+| peerId | [`PeerId`][peer-id] | The peer to set the value for |
 | value | `number` | The value of the peer from 0 to 1 |
 
 #### Returns
@@ -677,7 +677,7 @@ const peerIdStrings = libp2p.metrics.peers
 
 ### metrics.peers
 
-An array of `PeerId` strings of each peer currently being tracked.
+An array of [`PeerId`][peer-id] strings of each peer currently being tracked.
 
 #### Example
 
@@ -697,7 +697,7 @@ const protocols = libp2p.metrics.protocols
 
 ### metrics.forPeer
 
-Returns the [`Stats`](#stats) object for a given `PeerId` if it is being tracked.
+Returns the [`Stats`](#stats) object for a given [`PeerId`][peer-id] if it is being tracked.
 
 `libp2p.metrics.forPeer(peerId)`
 
@@ -705,7 +705,7 @@ Returns the [`Stats`](#stats) object for a given `PeerId` if it is being tracked
 
 | Name | Type | Description |
 |------|------|-------------|
-| peerId | `PeerId` | The peer to get stats for |
+| peerId | [`PeerId`][peer-id] | The peer to get stats for |
 
 #### Returns
 
@@ -762,7 +762,7 @@ Once you have a libp2p instance, you can listen to several events it emits, so t
 If `autoDial` option is `true`, applications should **not** attempt to connect to the peer
 unless they are performing a specific action. See [peer discovery and auto dial](./PEER_DISCOVERY.md) for more information.
 
-- `peer`: instance of [PeerInfo][https://github.com/libp2p/js-peer-info]
+- `peer`: instance of [`PeerInfo`][peer-info]
 
 #### A new connection to a peer has been opened
 
@@ -770,7 +770,7 @@ This event will be triggered anytime a new Connection is established to another
 
 `libp2p.on('peer:connect', (peer) => {})`
 
-- `peer`: instance of [PeerInfo][https://github.com/libp2p/js-peer-info]
+- `peer`: instance of [`PeerInfo`][peer-info]
 
 #### An existing connection to a peer has been closed
 
@@ -778,7 +778,7 @@ This event will be triggered anytime we are disconnected from another peer, rega
 
 `libp2p.on('peer:disconnect', (peer) => {})`
 
-- `peer`: instance of [PeerInfo][https://github.com/libp2p/js-peer-info]
+- `peer`: instance of [`PeerInfo`][peer-info]
 
 ## Types
 
@@ -800,5 +800,8 @@ This event will be triggered anytime we are disconnected from another peer, rega
     - `['300000']<MovingAverage>`: The [MovingAverage](https://www.npmjs.com/package/moving-averages) at a 5 minute interval.
     - `['900000']<MovingAverage>`: The [MovingAverage](https://www.npmjs.com/package/moving-averages) at a 15 minute interval.
 
+[cid]: https://github.com/multiformats/js-cid
 [connection]: https://github.com/libp2p/js-interfaces/tree/master/src/connection
+[multiaddr]: https://github.com/multiformats/js-multiaddr
 [peer-id]: https://github.com/libp2p/js-peer-id
+[peer-info]: https://github.com/libp2p/js-peer-info

doc/migrations/v0.26-v0.27.md

@@ -0,0 +1,178 @@
+# Migrating to the new API
+
+A migration guide for refactoring your application code from libp2p v0.26.x to v0.27.0.
+
+## Table of Contents
+
+- [Migrating from callbacks](#migrating-from-callbacks)
+- [Pull Streams to Streaming Iterables](#pull-streams-to-streaming-iterables)
+- [Sample API Migrations](#sample-api-migrations)
+  - [Registering Protocol Handlers](#registering-protocol-handlers)
+  - [Dialing and Sending Data](#dialing-and-sending-data)
+  - [Checking if a peer is connected](#checking-if-a-peer-is-connected)
+  - [Pinging another peer](#pinging-another-peer)
+  - [Pubsub](#pubsub)
+    - [Getting subscribers](#getting-subscribers)
+    - [Getting subscribed topics](#getting-subscribed-topics)
+
+## Migrating from callbacks
+
+Callbacks are no longer supported in the libp2p API, as the API has now fully moved to async / await. You can see a full list of the available methods in the [API readme][api]
+
+**Before**
+```js
+libp2p.start((err) => {
+  if (err) throw err
+  console.log('libp2p started')
+})
+```
+
+**After**
+```js
+await libp2p.start()
+console.log('libp2p started')
+```
+
+## Pull Streams to Streaming Iterables
+
+The libp2p API no longer supports Pull Streams and has migrated to [Streaming Iterables][streaming_iterable]. If you would like to continue using Pull Streams in your application code, or need additional time to migrate your code base, you can leverage the conversion modules [async-iterator-to-pull-stream](https://github.com/alanshaw/async-iterator-to-pull-stream) and [pull-stream-to-async-iterator](https://github.com/alanshaw/pull-stream-to-async-iterator).
+
+For a growing list of async iterator modules, you should follow the [it-awesome repo][it_awesome].
+
+## Sample API Migrations
+
+### Registering Protocol Handlers
+
+Protocol registration is very similar to how it previously was, however, the handler now takes a single parameter containing the incoming stream and its protocol. Additionally, you can now pass an array of protocols to `.handle`, but a single string is still supported.
+
+**Before**
+```js
+const pull = require('pull-stream')
+libp2p.handle('/echo/1.0.0', (protocol, conn) => pull(conn, conn))
+```
+
+**After**
+```js
+const pipe = require('it-pipe')
+libp2p.handle(['/echo/1.0.0'], ({ protocol, stream }) => pipe(stream, stream))
+```
+
+### Dialing and Sending Data
+
+`dialProtocol` no longer takes a callback, and will now return a [Streaming Iterable][streaming_iterable] and the protocol that was successfully negotiated. The new stream can be used with async iterator modules, see [it-awesome][it_awesome], instead of pull streams.
+
+**Before**
+```js
+const pull = require('pull-stream')
+libp2p.dialProtocol(peerInfo, '/echo/1.0.0', (err, conn) => {
+  if (err) { throw err }
+  pull(
+    pull.values(['hey']),
+    conn,
+    pull.drain((data) => {
+      console.log('received echo:', data.toString())
+    }, (err) => {
+      if (err) { throw err }
+    })
+  )
+})
+```
+
+**After**
+```js
+const pipe = require('it-pipe')
+const { protocol, stream } = await libp2p.dialProtocol(peerInfo, '/echo/1.0.0')
+await pipe(
+  ['hey'],
+  stream,
+  async function (source) {
+    for await (const data of source) {
+      console.log('received echo:', data.toString())
+    }
+  }
+)
+```
+
+### Checking if a peer is connected
+
+`peerInfo.isConnected` has been deprecated. libp2p now tracks all connections centrally and will no longer update the state of `peerInfo.isConnected`. Consumers should switch to using `libp2p.registrar.getConnection(peerInfo)`, which will return an open connection to that peer if one exists.
+
+**Before**
+```js
+if (peerInfo.isConnected()) {
+  // ...do something if connected
+}
+```
+
+**After**
+```js
+const connection = libp2p.registrar.getConnection(peerInfo)
+if (connection) {
+  // ...do something if connected
+}
+```
+
+### Pinging another peer
+
+`libp2p.ping` will no longer callback with a `Ping` event emitter. The internal logic has been simplified to give more flexibility to the API. `libp2p.ping` will now execute a single ping and return the latency.
+
+**Before**
+```js
+libp2p.ping(peerInfo, (err, ping) => {
+  if (err) throw err
+  ping.once('ping', (latency) => {
+    console.log('Latency is %s ms', latency)
+    ping.stop()
+  })
+
+  ping.start()
+})
+```
+
+**After**
+```js
+const latency = await libp2p.ping(peerInfo)
+console.log('Latency is %s ms', latency)
+```
+
+### Pubsub
+
+#### Getting subscribers
+
+`libp2p.pubsub.peers()` is now `libp2p.pubsub.getSubscribers()` and is no longer an asynchronous action.
+
+**Before**
+```js
+libp2p.pubsub.peers(topic, (err, subscribers) => {
+  if (err) throw err
+  console.log('Subscribers:', subscribers)
+})
+```
+
+**After**
+```js
+const subscribers = libp2p.pubsub.getSubscribers(topic)
+console.log('Subscribers:', subscribers)
+```
+
+#### Getting subscribed topics
+
+`libp2p.pubsub.ls()` is now `libp2p.pubsub.getTopics()` and is no longer an asynchronous action.
+
+**Before**
+```js
+libp2p.pubsub.ls((err, topics) => {
+  if (err) throw err
+  console.log('Topics:', topics)
+})
+```
+
+**After**
+```js
+const topics = libp2p.pubsub.getTopics()
+console.log('Topics:', topics)
+```
+
+[api]: ../API.md
+[it_awesome]: https://github.com/alanshaw/it-awesome
+[streaming_iterable]: ../STREAMING_ITERABLES.md

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p",
-  "version": "0.27.0",
+  "version": "0.27.1",
   "description": "JavaScript implementation of libp2p, a modular peer to peer network stack",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -112,6 +112,7 @@
     "Alan Shaw <alan@tableflip.io>",
     "Alex Potsides <alex@achingbrain.net>",
     "Andrew Nesbitt <andrewnez@gmail.com>",
+    "Cayman <caymannava@gmail.com>",
     "Chris Bratlien <chrisbratlien@gmail.com>",
     "Chris Dostert <chrisdostert@users.noreply.github.com>",
     "Daijiro Wachi <daijiro.wachi@gmail.com>",
@@ -159,6 +160,7 @@
     "isan_rivkin <isanrivkin@gmail.com>",
     "mayerwin <mayerwin@users.noreply.github.com>",
     "phillmac <phillmac@users.noreply.github.com>",
+    "shresthagrawal <34920931+shresthagrawal@users.noreply.github.com>",
     "swedneck <40505480+swedneck@users.noreply.github.com>",
     "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ <victorbjelkholm@gmail.com>"
   ]

src/ping/index.js

@@ -8,7 +8,7 @@ const errCode = require('err-code')
 const crypto = require('libp2p-crypto')
 const pipe = require('it-pipe')
 const { toBuffer } = require('it-buffer')
-const { collect } = require('streaming-iterables')
+const { collect, take } = require('streaming-iterables')
 
 const { PROTOCOL, PING_LENGTH } = require('./constants')
 
@@ -29,6 +29,7 @@ async function ping (node, peer) {
   const [result] = await pipe(
     [data],
     stream,
+    stream => take(1, stream),
     toBuffer,
     collect
   )

test/core/ping.node.js

@@ -6,9 +6,11 @@ chai.use(require('dirty-chai'))
 const { expect } = chai
 
 const pTimes = require('p-times')
+const pipe = require('it-pipe')
 
 const peerUtils = require('../utils/creators/peer')
 const baseOptions = require('../utils/base-options')
+const { PROTOCOL } = require('../../src/ping/constants')
 
 describe('ping', () => {
   let nodes
@@ -32,4 +34,40 @@ describe('ping', () => {
     const averageLatency = latencies.reduce((p, c) => p + c, 0) / latencies.length
     expect(averageLatency).to.be.a('Number')
   })
+
+  it('only waits for the first response to arrive', async () => {
+    nodes[1].handle(PROTOCOL, async ({ connection, stream }) => {
+      let firstInvocation = true
+
+      await pipe(
+        stream,
+        function (stream) {
+          const output = {
+            [Symbol.asyncIterator]: () => output,
+            next: async () => {
+              if (firstInvocation) {
+                firstInvocation = false
+
+                for await (const data of stream) {
+                  return {
+                    value: data,
+                    done: false
+                  }
+                }
+              } else {
+                return new Promise() // never resolve
+              }
+            }
+          }
+
+          return output
+        },
+        stream
+      )
+    })
+
+    const latency = await nodes[0].ping(nodes[1].peerInfo)
+
+    expect(latency).to.be.a('Number')
+  })
 })