chore: apply suggestions from code review

Co-authored-by: Jacob Heun <jacobheun@gmail.com>

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

@@ -7,7 +7,6 @@ chai.use(require('chai-bytes'))
 const { expect } = chai
 const sinon = require('sinon')
 
-const PeerId = require('peer-id')
 const PeerStore = require('../../src/peer-store')
 
 const peerUtils = require('../utils/creators/peer')
@@ -24,7 +23,7 @@ describe('keyBook', () => {
     kb = peerStore.keyBook
   })
 
-  it('throwns invalid parameters error if invalid PeerId is provided', () => {
+  it('throwns invalid parameters error if invalid PeerId is provided in set', () => {
     try {
       kb.set('invalid peerId')
     } catch (err) {
@@ -34,9 +33,19 @@ describe('keyBook', () => {
     throw new Error('invalid peerId should throw error')
   })
 
+  it('throwns invalid parameters error if invalid PeerId is provided in get', () => {
+    try {
+      kb.get('invalid peerId')
+    } catch (err) {
+      expect(err.code).to.equal(ERR_INVALID_PARAMETERS)
+      return
+    }
+    throw new Error('invalid peerId should throw error')
+  })
+
   it('stores the peerId in the book and returns the public key', () => {
     // Set PeerId
-    kb.set(peerId)
+    kb.set(peerId, peerId.pubKey)
 
     // Get public key
     const pubKey = kb.get(peerId)
@@ -47,22 +56,9 @@ describe('keyBook', () => {
     const spy = sinon.spy(kb, '_setData')
 
     // Set PeerId
-    kb.set(peerId)
-    kb.set(peerId)
+    kb.set(peerId, peerId.pubKey)
+    kb.set(peerId, peerId.pubKey)
 
     expect(spy).to.have.property('callCount', 1)
   })
-
-  it('stores if already stored but there was no public key stored', () => {
-    const spy = sinon.spy(kb, '_setData')
-
-    // Set PeerId without public key
-    const p = PeerId.createFromB58String(peerId.toB58String())
-    kb.set(p)
-
-    // Set complete peerId
-    kb.set(peerId)
-
-    expect(spy).to.have.property('callCount', 2)
-  })
 })

test/peer-store/peer-store.node.js

@@ -0,0 +1,34 @@
+'use strict'
+/* eslint-env mocha */
+
+const chai = require('chai')
+chai.use(require('dirty-chai'))
+chai.use(require('chai-as-promised'))
+const { expect } = chai
+const sinon = require('sinon')
+
+const baseOptions = require('../utils/base-options')
+const peerUtils = require('../utils/creators/peer')
+
+describe('libp2p.peerStore', () => {
+  let libp2p, remoteLibp2p
+
+  beforeEach(async () => {
+    [libp2p, remoteLibp2p] = await peerUtils.createPeer({
+      number: 2,
+      populateAddressBooks: false,
+      config: {
+        ...baseOptions
+      }
+    })
+  })
+
+  it('adds peer address to AddressBook when establishing connection', async () => {
+    const spyAddressBook = sinon.spy(libp2p.peerStore.addressBook, 'add')
+    const remoteMultiaddr = `${remoteLibp2p.multiaddrs[0]}/p2p/${remoteLibp2p.peerId.toB58String()}`
+    const conn = await libp2p.dial(remoteMultiaddr)
+
+    expect(conn).to.exist()
+    expect(spyAddressBook).to.have.property('callCount', 1)
+  })
+})

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

@@ -4,7 +4,6 @@
 const chai = require('chai')
 chai.use(require('dirty-chai'))
 const { expect } = chai
-const sinon = require('sinon')
 
 const PeerStore = require('../../src/peer-store')
 const multiaddr = require('multiaddr')
@@ -50,25 +49,11 @@ describe('peer-store', () => {
       expect(peer).to.not.exist()
     })
 
-    it('sets the peer to the KeyBook when added to the AddressBook', () => {
-      const spyPeerStore = sinon.spy(peerStore.keyBook, 'set')
+    it('sets the peer\'s public key to the KeyBook', () => {
+      peerStore.keyBook.set(peerIds[0], peerIds[0].pubKey)
 
-      peerStore.addressBook.set(peerIds[0], [addr1, addr2])
-      expect(spyPeerStore).to.have.property('callCount', 1)
-    })
-
-    it('sets the peer to the KeyBook when added to the ProtoBook', () => {
-      const spyPeerStore = sinon.spy(peerStore.keyBook, 'set')
-
-      peerStore.protoBook.set(peerIds[0], [proto1])
-      expect(spyPeerStore).to.have.property('callCount', 1)
-    })
-
-    it('does not re-set the to the KeyBook when directly added to it', () => {
-      const spyPeerStore = sinon.spy(peerStore.keyBook, 'set')
-
-      peerStore.keyBook.set(peerIds[0])
-      expect(spyPeerStore).to.have.property('callCount', 1)
+      const pubKey = peerStore.keyBook.get(peerIds[0])
+      expect(pubKey).to.exist()
     })
   })
 

test/peer-store/persisted-peer-store.spec.js

@@ -68,14 +68,14 @@ describe('Persisted PeerStore', () => {
       // AddressBook
       peerStore.addressBook.set(peer, multiaddrs)
 
-      expect(spyDirty).to.have.property('callCount', 2) // Address + PeerId
-      expect(spyDs).to.have.property('callCount', 2)
+      expect(spyDirty).to.have.property('callCount', 1) // Address
+      expect(spyDs).to.have.property('callCount', 1)
 
       // ProtoBook
       peerStore.protoBook.set(peer, protocols)
 
-      expect(spyDirty).to.have.property('callCount', 3) // Protocol
-      expect(spyDs).to.have.property('callCount', 3)
+      expect(spyDirty).to.have.property('callCount', 2) // Protocol
+      expect(spyDs).to.have.property('callCount', 2)
 
       // Should have three peer records stored in the datastore
       const queryParams = {
@@ -86,7 +86,7 @@ describe('Persisted PeerStore', () => {
       for await (const _ of datastore.query(queryParams)) { // eslint-disable-line
         count++
       }
-      expect(count).to.equal(3)
+      expect(count).to.equal(2)
 
       // Validate data
       const storedPeer = peerStore.get(peer)
@@ -110,11 +110,15 @@ describe('Persisted PeerStore', () => {
       peerStore.addressBook.set(peers[0], [multiaddrs[0]])
       peerStore.addressBook.set(peers[1], [multiaddrs[1]])
 
+      // KeyBook
+      peerStore.keyBook.set(peers[0], peers[0].pubKey)
+      peerStore.keyBook.set(peers[1], peers[1].pubKey)
+
       // ProtoBook
       peerStore.protoBook.set(peers[0], protocols)
       peerStore.protoBook.set(peers[1], protocols)
 
-      expect(spyDs).to.have.property('callCount', 6) // 2 AddressBook + 2 ProtoBook + 2 KeyBook
+      expect(spyDs).to.have.property('callCount', 6) // 2 AddressBook + 2 KeyBook + 2 ProtoBook
       expect(peerStore.peers.size).to.equal(2)
 
       await peerStore.stop()
@@ -127,11 +131,12 @@ describe('Persisted PeerStore', () => {
 
       await peerStore.start()
 
-      expect(spy).to.have.property('callCount', 6) // 6 datastore entries
-      expect(spyDs).to.have.property('callCount', 6) // 6 previous operations
+      expect(spy).to.have.property('callCount', 6)
+      expect(spyDs).to.have.property('callCount', 6)
 
       expect(peerStore.peers.size).to.equal(2)
       expect(peerStore.addressBook.data.size).to.equal(2)
+      expect(peerStore.keyBook.data.size).to.equal(2)
       expect(peerStore.protoBook.data.size).to.equal(2)
     })
 
@@ -159,7 +164,7 @@ describe('Persisted PeerStore', () => {
       expect(spyAddressBook).to.have.property('callCount', 1)
       expect(spyKeyBook).to.have.property('callCount', 1)
       expect(spyProtoBook).to.have.property('callCount', 1)
-      expect(spyDs).to.have.property('callCount', 3)
+      expect(spyDs).to.have.property('callCount', 2)
 
       // Should have zero peer records stored in the datastore
       const queryParams = {
@@ -201,7 +206,7 @@ describe('Persisted PeerStore', () => {
       // Remove data from the same Peer
       peerStore.addressBook.delete(peers[0])
 
-      expect(spyDirty).to.have.property('callCount', 4) // 2 AddrBook ops, 1 ProtoBook op, 1 KeyBook op
+      expect(spyDirty).to.have.property('callCount', 3) // 2 AddrBook ops, 1 ProtoBook op
       expect(peerStore._dirtyPeers.size).to.equal(1)
       expect(spyDs).to.have.property('callCount', 0)
 
@@ -215,7 +220,7 @@ describe('Persisted PeerStore', () => {
       // Add data for second book
       peerStore.addressBook.set(peers[1], multiaddrs)
 
-      expect(spyDirty).to.have.property('callCount', 6)
+      expect(spyDirty).to.have.property('callCount', 4)
       expect(spyDs).to.have.property('callCount', 1)
 
       // Should have two peer records stored in the datastore
@@ -223,7 +228,7 @@ describe('Persisted PeerStore', () => {
       for await (const _ of datastore.query(queryParams)) { // eslint-disable-line
         count++
       }
-      expect(count).to.equal(4)
+      expect(count).to.equal(2)
       expect(peerStore.peers.size).to.equal(2)
     })
 
@@ -240,7 +245,7 @@ describe('Persisted PeerStore', () => {
       peerStore.protoBook.set(peer, protocols)
 
       expect(spyDs).to.have.property('callCount', 0)
-      expect(spyDirty).to.have.property('callCount', 2) // ProtoBook + KeyBook
+      expect(spyDirty).to.have.property('callCount', 1) // ProtoBook
       expect(peerStore._dirtyPeers.size).to.equal(1)
 
       const queryParams = {
@@ -252,7 +257,7 @@ describe('Persisted PeerStore', () => {
 
       await peerStore.stop()
 
-      expect(spyDirty).to.have.property('callCount', 2)
+      expect(spyDirty).to.have.property('callCount', 1)
       expect(spyDs).to.have.property('callCount', 1)
       expect(peerStore._dirtyPeers.size).to.equal(0) // Reset
 
@@ -261,7 +266,7 @@ describe('Persisted PeerStore', () => {
       for await (const _ of datastore.query(queryParams)) { // eslint-disable-line
         count++
       }
-      expect(count).to.equal(2)
+      expect(count).to.equal(1)
       expect(peerStore.peers.size).to.equal(1)
     })
   })
@@ -354,7 +359,7 @@ describe('libp2p.peerStore (Persisted)', () => {
 
       await newNode.start()
 
-      expect(spy).to.have.property('callCount', 6) // 6 datastore entries
+      expect(spy).to.have.property('callCount', 4) // 4 datastore entries
 
       expect(newNode.peerStore.peers.size).to.equal(2)