fix: await network start and stop (#415)

Starting/stopping network operations needs to be async

Author: achingbrain

package.json

@@ -199,7 +199,7 @@
     "iso-random-stream": "^2.0.0",
     "it-all": "^1.0.5",
     "it-drain": "^1.0.4",
-    "libp2p": "libp2p/js-libp2p#feat/async-peerstore",
+    "libp2p": "next",
     "libp2p-kad-dht": "^0.28.4",
     "libp2p-mplex": "^0.10.2",
     "libp2p-tcp": "^0.17.1",

src/bitswap.js

@@ -427,20 +427,20 @@ export class Bitswap extends BaseBlockstore {
   /**
    * Start the bitswap node
    */
-  start () {
+  async start () {
     this.wm.start()
-    this.network.start()
+    await this.network.start()
     this.engine.start()
     this.started = true
   }
 
   /**
    * Stop the bitswap node
    */
-  stop () {
+  async stop () {
     this._stats.stop()
     this.wm.stop()
-    this.network.stop()
+    await this.network.stop()
     this.engine.stop()
     this.started = false
   }

test/bitswap-mock-internals.js

@@ -59,7 +59,7 @@ describe('bitswap with mocks', function () {
   describe('receive message', () => {
     it('simple block message', async () => {
       const bs = new Bitswap(mockLibp2pNode(), blockstore)
-      bs.start()
+      await bs.start()
 
       const other = ids[1]
 
@@ -93,12 +93,12 @@ describe('bitswap with mocks', function () {
       expect(ledger.recv).to.equal(96)
       expect(ledger.exchanged).to.equal(2)
 
-      bs.stop()
+      await bs.stop()
     })
 
     it('simple want message', async () => {
       const bs = new Bitswap(mockLibp2pNode(), blockstore)
-      bs.start()
+      await bs.start()
 
       const other = ids[1]
       const b1 = blocks[0]
@@ -116,14 +116,14 @@ describe('bitswap with mocks', function () {
       expect(wl.has(b1.cid.toString(base58btc))).to.eql(true)
       expect(wl.has(b2.cid.toString(base58btc))).to.eql(true)
 
-      bs.stop()
+      await bs.stop()
     })
 
     it('multi peer', async function () {
       this.timeout(80 * 1000)
       const bs = new Bitswap(mockLibp2pNode(), blockstore)
 
-      bs.start()
+      await bs.start()
 
       const others = await makePeerIds(5)
       const blocks = await makeBlocks(10)
@@ -147,12 +147,12 @@ describe('bitswap with mocks', function () {
         await storeHasBlocks(msg, blockstore)
       }
 
-      bs.stop()
+      await bs.stop()
     })
 
     it('ignore unwanted blocks', async () => {
       const bs = new Bitswap(mockLibp2pNode(), blockstore)
-      bs.start()
+      await bs.start()
 
       const other = ids[1]
 
@@ -192,7 +192,7 @@ describe('bitswap with mocks', function () {
       expect(ledger.recv).to.equal(144)
       expect(ledger.exchanged).to.equal(3)
 
-      bs.stop()
+      await bs.stop()
     })
   })
 
@@ -256,7 +256,7 @@ describe('bitswap with mocks', function () {
       bs.network = net
       bs.wm.network = net
       bs.engine.network = net
-      bs.start()
+      await bs.start()
       const get = bs.get(block.cid)
 
       setTimeout(() => {
@@ -269,7 +269,7 @@ describe('bitswap with mocks', function () {
       finish(2)
 
       finish.assert()
-      bs.stop()
+      await bs.stop()
     })
 
     it('block is sent after local add', async () => {
@@ -348,12 +348,12 @@ describe('bitswap with mocks', function () {
       // Create and start bs1
       const bs1 = new Bitswap(mockLibp2pNode(), blockstore)
       applyNetwork(bs1, n1)
-      bs1.start()
+      await bs1.start()
 
       // Create and start bs2
       const bs2 = new Bitswap(mockLibp2pNode(), new MemoryBlockstore())
       applyNetwork(bs2, n2)
-      bs2.start()
+      await bs2.start()
 
       bs1._onPeerConnected(other)
       bs2._onPeerConnected(me)
@@ -365,8 +365,8 @@ describe('bitswap with mocks', function () {
       const b1 = await p1
       expect(b1).to.equalBytes(block.data)
 
-      bs1.stop()
-      bs2.stop()
+      await bs1.stop()
+      await bs2.stop()
     })
 
     it('double get', async () => {
@@ -472,7 +472,7 @@ describe('bitswap with mocks', function () {
   describe('unwant', () => {
     it('removes blocks that are wanted multiple times', async () => {
       const bs = new Bitswap(mockLibp2pNode(), blockstore)
-      bs.start()
+      await bs.start()
 
       const b = blocks[12]
       const p = Promise.all([
@@ -484,7 +484,7 @@ describe('bitswap with mocks', function () {
 
       await expect(p).to.eventually.be.rejected()
 
-      bs.stop()
+      await bs.stop()
     })
   })
 

test/bitswap-stats.js

@@ -69,7 +69,7 @@ describe('bitswap stats', () => {
     bs.wm.wantBlocks(blocks.map(b => b.cid))
 
     // start the first bitswap
-    bs.start()
+    await bs.start()
   })
 
   after(async () => {
@@ -170,7 +170,7 @@ describe('bitswap stats', () => {
 
     before(async () => {
       bs2 = bitswaps[1]
-      bs2.start()
+      await bs2.start()
 
       const ma = `${libp2pNodes[1].multiaddrs[0]}/p2p/${libp2pNodes[1].peerId.toB58String()}`
       await libp2pNodes[0].dial(ma)
@@ -180,8 +180,8 @@ describe('bitswap stats', () => {
       await bs.put(block.cid, block.data)
     })
 
-    after(() => {
-      bs2.stop()
+    after(async () => {
+      await bs2.stop()
     })
 
     it('updates stats on transfer', async () => {

test/bitswap.js

@@ -30,7 +30,7 @@ async function createThing (dht) {
     }
   })
   const bitswap = new Bitswap(libp2pNode, new MemoryBlockstore())
-  bitswap.start()
+  await bitswap.start()
   return { libp2pNode, bitswap }
 }
 
@@ -43,8 +43,8 @@ describe('start/stop', () => {
         register: () => {}
       },
       peerStore: {
-        peers: {
-          values: () => []
+        getPeers: async function * () {
+          yield * []
         }
       }
     }
@@ -53,11 +53,11 @@ describe('start/stop', () => {
 
     expect(bitswap.isStarted()).to.be.false()
 
-    bitswap.start()
+    await bitswap.start()
 
     expect(bitswap.isStarted()).to.be.true()
 
-    bitswap.stop()
+    await bitswap.stop()
 
     expect(bitswap.isStarted()).to.be.false()
   })

test/network/gen-bitswap-network.node.js

@@ -21,7 +21,7 @@ describe('gen Bitswap network', function () {
     }))
     expect(res).to.have.length(blocks.length)
 
-    node.bitswap.stop()
+    await node.bitswap.stop()
     await node.libp2p.stop()
   })
 
@@ -33,9 +33,9 @@ describe('gen Bitswap network', function () {
 
       // -- actual test
       await exchangeBlocks(nodeArr, blocksPerNode)
-      await Promise.all(nodeArr.map(node => {
-        node.bitswap.stop()
-        return node.libp2p.stop()
+      await Promise.all(nodeArr.map(async node => {
+        await node.bitswap.stop()
+        await node.libp2p.stop()
       }))
     })
   })
@@ -53,7 +53,7 @@ async function exchangeBlocks (nodes, blocksPerNode = 10) {
 
   // put blocksPerNode amount of blocks per node
   await Promise.all(nodes.map(async (node, i) => {
-    node.bitswap.start()
+    await node.bitswap.start()
 
     const data = new Array(blocksPerNode).fill(0).map((_, j) => {
       const index = i * blocksPerNode + j

test/network/network.node.js

@@ -76,15 +76,15 @@ describe('network', () => {
     // @ts-expect-error {} is not a real libp2p
     networkC = new Network(p2pC, bitswapMockC, new Stats({}), { b100Only: true })
 
-    networkA.start()
-    networkB.start()
-    networkC.start()
+    await networkA.start()
+    await networkB.start()
+    await networkC.start()
   })
 
-  afterEach(() => {
-    p2pA.stop()
-    p2pB.stop()
-    p2pC.stop()
+  afterEach(async () => {
+    await p2pA.stop()
+    await p2pB.stop()
+    await p2pC.stop()
   })
 
   it('connectTo fail', async () => {
@@ -146,14 +146,14 @@ describe('network', () => {
       p2pBConnected
     ])
 
-    networkA.stop()
-    networkB.stop()
+    await networkA.stop()
+    await networkB.stop()
 
     p2pAConnected = pDefer()
     p2pBConnected = pDefer()
 
-    networkA.start()
-    networkB.start()
+    await networkA.start()
+    await networkB.start()
 
     await Promise.all([
       p2pAConnected,
@@ -278,8 +278,8 @@ describe('network', () => {
     networkB = new Network(p2pB, bitswapMockB, new Stats({}))
     networkB._protocols = ['/ipfs/bitswap/1.2.0']
 
-    networkA.start()
-    networkB.start()
+    await networkA.start()
+    await networkB.start()
 
     // In a real network scenario, peers will be discovered and their addresses
     // will be added to the addressBook before bitswap kicks in
@@ -310,9 +310,11 @@ describe('network', () => {
       registrar: {
         register: sinon.stub()
       },
+      // @ts-expect-error incomplete implementation
       peerStore: {
-        // @ts-expect-error {} incomplete implementation
-        peers: new Map()
+        getPeers: async function * () {
+          yield * []
+        }
       },
       dial: mockDial,
       handle: sinon.stub()
@@ -336,7 +338,7 @@ describe('network', () => {
     mockDial.withArgs(provider1.id).returns(Promise.reject(new Error('Could not dial')))
     mockDial.withArgs(provider2.id).returns(Promise.resolve())
 
-    network.start()
+    await network.start()
 
     await network.findAndConnect(cid)
 

test/utils/create-bitswap.js

@@ -12,6 +12,6 @@ export const createBitswap = async () => {
     }
   })
   const bitswap = new Bitswap(libp2pNode, new MemoryBlockstore())
-  bitswap.start()
+  await bitswap.start()
   return { bitswap, libp2pNode }
 }