fix: return empty array when no multiaddrs are known

Returning `undefined` makes the address length check in [dialler/index.js](https://github.com/libp2p/js-libp2p/blob/master/src/dialer/index.js#L73-L75)
fail with `cannot read property length of undefined` so the change
here is to always return an array, but it might be empty if we don't
know any multiaddrs for the given peer.

CHANGELOG.md

@@ -1,23 +1,3 @@
-<a name="0.28.9"></a>
-## [0.28.9](https://github.com/libp2p/js-libp2p/compare/v0.28.8...v0.28.9) (2020-07-27)
-
-
-### Bug Fixes
-
-* ping multiaddr from peer not previously stored in peerstore ([#719](https://github.com/libp2p/js-libp2p/issues/719)) ([2440c87](https://github.com/libp2p/js-libp2p/commit/2440c87))
-
-
-
-<a name="0.28.8"></a>
-## [0.28.8](https://github.com/libp2p/js-libp2p/compare/v0.28.7...v0.28.8) (2020-07-20)
-
-
-### Bug Fixes
-
-* create dial target for peer with no known addrs ([#715](https://github.com/libp2p/js-libp2p/issues/715)) ([7da9ad4](https://github.com/libp2p/js-libp2p/commit/7da9ad4))
-
-
-
 <a name="0.28.7"></a>
 ## [0.28.7](https://github.com/libp2p/js-libp2p/compare/v0.28.6...v0.28.7) (2020-07-14)
 

doc/API.md

@@ -760,7 +760,7 @@ Get the known [`Addresses`][address] of a provided peer.
 
 | Type | Description |
 |------|-------------|
-| `Array<Address>|undefined` | Array of peer's [`Addresses`][address] containing the multiaddr and its metadata if available, otherwise undefined |
+| `Array<Address>` | Array of peer's [`Addresses`][address] containing the multiaddr and its metadata |
 
 #### Example
 
@@ -797,7 +797,7 @@ Get the known `Multiaddr` of a provided peer. All returned multiaddrs will inclu
 
 | Type | Description |
 |------|-------------|
-| `Array<Multiaddr>|undefined` | Array of peer's multiaddr if available, otherwise undefined |
+| `Array<Multiaddr>` | Array of peer's multiaddr |
 
 #### Example
 

doc/CONFIGURATION.md

@@ -304,7 +304,7 @@ const node = await Libp2p.create({
   },
   config: {
     peerDiscovery: {
-      [WebRTCStar.tag]: {
+      webRTCStar: {
         enabled: true
       }
     }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "libp2p",
-  "version": "0.28.9",
+  "version": "0.28.7",
   "description": "JavaScript implementation of libp2p, a modular peer to peer network stack",
   "leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
   "main": "src/index.js",
@@ -58,7 +58,7 @@
     "it-length-prefixed": "^3.0.1",
     "it-pipe": "^1.1.0",
     "it-protocol-buffers": "^0.2.0",
-    "libp2p-crypto": "^0.17.8",
+    "libp2p-crypto": "^0.17.6",
     "libp2p-interfaces": "^0.3.1",
     "libp2p-utils": "^0.1.2",
     "mafmt": "^7.0.0",

src/dialer/index.js

@@ -112,7 +112,7 @@ class Dialer {
       this.peerStore.addressBook.add(id, multiaddrs)
     }
 
-    let addrs = this.peerStore.addressBook.getMultiaddrsForPeer(id) || []
+    let addrs = this.peerStore.addressBook.getMultiaddrsForPeer(id)
 
     // If received a multiaddr to dial, it should be the first to use
     // But, if we know other multiaddrs for the peer, we should try them too.

src/index.js

@@ -324,7 +324,7 @@ class Libp2p extends EventEmitter {
    * @returns {Promise<Connection|*>}
    */
   async dialProtocol (peer, protocols, options) {
-    const { id, multiaddrs } = getPeer(peer)
+    const { id, multiaddrs } = getPeer(peer, this.peerStore)
     let connection = this.connectionManager.get(id)
 
     if (!connection) {
@@ -396,12 +396,7 @@ class Libp2p extends EventEmitter {
    * @returns {Promise<number>}
    */
   ping (peer) {
-    const { id, multiaddrs } = getPeer(peer)
-
-    // If received multiaddr, ping it
-    if (multiaddrs) {
-      return ping(this, multiaddrs[0])
-    }
+    const { id } = getPeer(peer)
 
     return ping(this, id)
   }

src/peer-store/address-book.js

@@ -168,9 +168,8 @@ class AddressBook extends Book {
   /**
    * Get the known multiaddrs for a given peer. All returned multiaddrs
    * will include the encapsulated `PeerId` of the peer.
-   * Returns `undefined` if there are no known multiaddrs for the given peer.
    * @param {PeerId} peerId
-   * @returns {Array<Multiaddr>|undefined}
+   * @returns {Array<Multiaddr>}
    */
   getMultiaddrsForPeer (peerId) {
     if (!PeerId.isPeerId(peerId)) {
@@ -180,7 +179,7 @@ class AddressBook extends Book {
     const record = this.data.get(peerId.toB58String())
 
     if (!record) {
-      return undefined
+      return []
     }
 
     return record.map((address) => {

src/peer-store/book.js

@@ -77,9 +77,8 @@ class Book {
 
   /**
    * Get the known data of a provided peer.
-   * Returns `undefined` if there is no available data for the given peer.
    * @param {PeerId} peerId
-   * @returns {Array<Data>|undefined}
+   * @returns {Array<Data>}
    */
   get (peerId) {
     if (!PeerId.isPeerId(peerId)) {

src/ping/index.js

@@ -15,11 +15,11 @@ const { PROTOCOL, PING_LENGTH } = require('./constants')
 /**
  * Ping a given peer and wait for its response, getting the operation latency.
  * @param {Libp2p} node
- * @param {PeerId|multiaddr} peer
+ * @param {PeerId} peer
  * @returns {Promise<Number>}
  */
 async function ping (node, peer) {
-  log('dialing %s to %s', PROTOCOL, peer.toB58String ? peer.toB58String() : peer)
+  log('dialing %s to %s', PROTOCOL, peer.toB58String())
 
   const { stream } = await node.dialProtocol(peer, PROTOCOL)
 

test/core/ping.node.js

@@ -17,7 +17,7 @@ describe('ping', () => {
 
   beforeEach(async () => {
     nodes = await peerUtils.createPeer({
-      number: 3,
+      number: 2,
       config: baseOptions
     })
 
@@ -25,14 +25,7 @@ describe('ping', () => {
     nodes[1].peerStore.addressBook.set(nodes[0].peerId, nodes[0].multiaddrs)
   })
 
-  it('ping once from peer0 to peer1 using a multiaddr', async () => {
-    const ma = `${nodes[2].multiaddrs[0]}/p2p/${nodes[2].peerId.toB58String()}`
-    const latency = await nodes[0].ping(ma)
-
-    expect(latency).to.be.a('Number')
-  })
-
-  it('ping once from peer0 to peer1 using a peerId', async () => {
+  it('ping once from peer0 to peer1', async () => {
     const latency = await nodes[0].ping(nodes[1].peerId)
 
     expect(latency).to.be.a('Number')

test/dialing/direct.node.js

@@ -96,15 +96,6 @@ describe('Dialing (direct, TCP)', () => {
       .and.to.have.nested.property('._errors[0].code', ErrorCodes.ERR_TRANSPORT_UNAVAILABLE)
   })
 
-  it('should fail to connect if peer has no known addresses', async () => {
-    const dialer = new Dialer({ transportManager: localTM, peerStore })
-    const peerId = await PeerId.createFromJSON(Peers[1])
-
-    await expect(dialer.connectToPeer(peerId))
-      .to.eventually.be.rejectedWith(Error)
-      .and.to.have.nested.property('.code', ErrorCodes.ERR_NO_VALID_ADDRESSES)
-  })
-
   it('should be able to connect to a given peer id', async () => {
     const peerStore = new PeerStore()
     const dialer = new Dialer({

test/peer-store/address-book.spec.js

@@ -323,10 +323,10 @@ describe('addressBook', () => {
       throw new Error('invalid peerId should throw error')
     })
 
-    it('returns undefined if no multiaddrs are known for the provided peer', () => {
+    it('returns empty array if no multiaddrs are known for the provided peer', () => {
       const addresses = ab.getMultiaddrsForPeer(peerId)
 
-      expect(addresses).to.not.exist()
+      expect(addresses).to.be.empty()
     })
 
     it('returns the multiaddrs stored', () => {