chore: run node tests in ci (#1057)

Looks like this project stopped running the `test:node` npm script when it was migrated to gh actions.

Re-enable it and fix all the related test failures.

Author: achingbrain

.github/workflows/main.yml

@@ -37,7 +37,7 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
       - run: npm install
-      - run: npx aegir test -t node --cov --bail
+      - run: npm run test:node -- --cov --bail
       - uses: codecov/codecov-action@v1
   test-chrome:
     needs: check
@@ -48,7 +48,7 @@ jobs:
         with:
           node-version: lts/*
       - run: npm install
-      - run: npx aegir test -t browser -t webworker --bail
+      - run: npm run test:browser -- -t browser -t webworker --bail
   test-firefox:
     needs: check
     runs-on: ubuntu-latest
@@ -58,7 +58,7 @@ jobs:
         with:
           node-version: lts/*
       - run: npm install
-      - run: npx aegir test -t browser -t webworker --bail -- --browser firefox
+      - run: npm run test:browser -- -t browser -t webworker --bail -- --browser firefox
   test-ts:
     needs: check
     runs-on: ubuntu-latest

package.json

@@ -151,7 +151,7 @@
     "libp2p": ".",
     "libp2p-bootstrap": "^0.14.0",
     "libp2p-delegated-content-routing": "^0.11.0",
-    "libp2p-delegated-peer-routing": "^0.11.0",
+    "libp2p-delegated-peer-routing": "^0.11.1",
     "libp2p-floodsub": "^0.27.0",
     "libp2p-gossipsub": "^0.12.1",
     "libp2p-interfaces-compliance-tests": "^2.0.1",

src/circuit/index.js

@@ -4,7 +4,7 @@ const debug = require('debug')
 const log = Object.assign(debug('libp2p:relay'), {
   error: debug('libp2p:relay:err')
 })
-
+const { codes } = require('./../errors')
 const {
   setDelayedInterval,
   clearDelayedInterval
@@ -88,7 +88,7 @@ class Relay {
       const cid = await namespaceToCid(RELAY_RENDEZVOUS_NS)
       await this._libp2p.contentRouting.provide(cid)
     } catch (/** @type {any} */ err) {
-      if (err.code === 'NO_ROUTERS_AVAILABLE') {
+      if (err.code === codes.ERR_NO_ROUTERS_AVAILABLE) {
         log.error('a content router, such as a DHT, must be provided in order to advertise the relay service', err)
         // Stop the advertise
         this.stop()

src/config.js

@@ -60,13 +60,7 @@ const DefaultConfig = {
     protocolPrefix: 'ipfs',
     dht: {
       enabled: false,
-      kBucketSize: 20,
-      randomWalk: {
-        enabled: false, // disabled waiting for https://github.com/libp2p/js-libp2p-kad-dht/issues/86
-        queriesPerPeriod: 1,
-        interval: 300e3,
-        timeout: 10e3
-      }
+      kBucketSize: 20
     },
     nat: {
       enabled: true,

src/content-routing/index.js

@@ -54,7 +54,7 @@ class ContentRouting {
    */
   async * findProviders (key, options = {}) {
     if (!this.routers.length) {
-      throw errCode(new Error('No content this.routers available'), 'NO_ROUTERS_AVAILABLE')
+      throw errCode(new Error('No content this.routers available'), codes.ERR_NO_ROUTERS_AVAILABLE)
     }
 
     yield * pipe(
@@ -77,7 +77,7 @@ class ContentRouting {
    */
   async provide (key) {
     if (!this.routers.length) {
-      throw errCode(new Error('No content routers available'), 'NO_ROUTERS_AVAILABLE')
+      throw errCode(new Error('No content routers available'), codes.ERR_NO_ROUTERS_AVAILABLE)
     }
 
     await Promise.all(this.routers.map((router) => router.provide(key)))

src/dht/dht-peer-routing.js

@@ -27,8 +27,12 @@ class DHTPeerRouting {
    */
   async findPeer (peerId, options = {}) {
     for await (const event of this._dht.findPeer(peerId, options)) {
-      if (event.name === 'FINAL_PEER') {
-        return event.peer
+      if (event.name === 'PEER_RESPONSE') {
+        const peer = event.closer.find(peerData => peerData.id.equals(peerId))
+
+        if (peer) {
+          return peer
+        }
       }
     }
 

src/errors.js

@@ -38,7 +38,7 @@ exports.codes = {
   ERR_INVALID_MULTIADDR: 'ERR_INVALID_MULTIADDR',
   ERR_SIGNATURE_NOT_VALID: 'ERR_SIGNATURE_NOT_VALID',
   ERR_FIND_SELF: 'ERR_FIND_SELF',
-  ERR_NO_ROUTERS: 'ERR_NO_ROUTERS',
+  ERR_NO_ROUTERS_AVAILABLE: 'ERR_NO_ROUTERS_AVAILABLE',
   ERR_CONNECTION_NOT_MULTIPLEXED: 'ERR_CONNECTION_NOT_MULTIPLEXED',
   ERR_NO_DIAL_TOKENS: 'ERR_NO_DIAL_TOKENS',
   ERR_KEYCHAIN_REQUIRED: 'ERR_KEYCHAIN_REQUIRED',

src/index.js

@@ -56,16 +56,9 @@ const { updateSelfPeerRecord } = require('./record/utils')
  * @property {MuxedStream} stream
  * @property {string} protocol
  *
- * @typedef {Object} RandomWalkOptions
- * @property {boolean} [enabled = false]
- * @property {number} [queriesPerPeriod = 1]
- * @property {number} [interval = 300e3]
- * @property {number} [timeout = 10e3]
- *
  * @typedef {Object} DhtOptions
  * @property {boolean} [enabled = false]
  * @property {number} [kBucketSize = 20]
- * @property {RandomWalkOptions} [randomWalk]
  * @property {boolean} [clientMode]
  * @property {import('libp2p-interfaces/src/types').DhtSelectors} [selectors]
  * @property {import('libp2p-interfaces/src/types').DhtValidators} [validators]

src/peer-routing.js

@@ -105,7 +105,7 @@ class PeerRouting {
    */
   async findPeer (id, options) { // eslint-disable-line require-await
     if (!this._routers.length) {
-      throw errCode(new Error('No peer routers available'), errors.codes.ERR_NO_ROUTERS)
+      throw errCode(new Error('No peer routers available'), errors.codes.ERR_NO_ROUTERS_AVAILABLE)
     }
 
     if (id.toB58String() === this._peerId.toB58String()) {
@@ -145,7 +145,7 @@ class PeerRouting {
    */
   async * getClosestPeers (key, options = { timeout: 30e3 }) {
     if (!this._routers.length) {
-      throw errCode(new Error('No peer routers available'), errors.codes.ERR_NO_ROUTERS)
+      throw errCode(new Error('No peer routers available'), errors.codes.ERR_NO_ROUTERS_AVAILABLE)
     }
 
     if (options.timeout) {

test/content-routing/content-routing.node.js

@@ -36,14 +36,14 @@ describe('content-routing', () => {
         throw new Error('.findProviders should return an error')
       } catch (/** @type {any} */ err) {
         expect(err).to.exist()
-        expect(err.code).to.equal('NO_ROUTERS_AVAILABLE')
+        expect(err.code).to.equal('ERR_NO_ROUTERS_AVAILABLE')
       }
     })
 
     it('.provide should return an error', async () => {
       await expect(node.contentRouting.provide('a cid'))
         .to.eventually.be.rejected()
-        .and.to.have.property('code', 'NO_ROUTERS_AVAILABLE')
+        .and.to.have.property('code', 'ERR_NO_ROUTERS_AVAILABLE')
     })
   })
 
@@ -87,8 +87,11 @@ describe('content-routing', () => {
       sinon.stub(nodes[0]._dht, 'findProviders').callsFake(function * () {
         deferred.resolve()
         yield {
-          id: providerPeerId,
-          multiaddrs: []
+          name: 'PROVIDER',
+          providers: [{
+            id: providerPeerId,
+            multiaddrs: []
+          }]
         }
       })
 
@@ -361,7 +364,12 @@ describe('content-routing', () => {
       }
 
       sinon.stub(node._dht, 'findProviders').callsFake(async function * () {
-        yield result1
+        yield {
+          name: 'PROVIDER',
+          providers: [
+            result1
+          ]
+        }
       })
       sinon.stub(delegate, 'findProviders').callsFake(async function * () {
         yield result2
@@ -382,7 +390,8 @@ describe('content-routing', () => {
       const dhtDeferred = pDefer()
       const delegatedDeferred = pDefer()
 
-      sinon.stub(node._dht, 'provide').callsFake(() => {
+      sinon.stub(node._dht, 'provide').callsFake(async function * () {
+        yield
         dhtDeferred.resolve()
       })
 
@@ -406,7 +415,12 @@ describe('content-routing', () => {
       }]
 
       sinon.stub(node._dht, 'findProviders').callsFake(function * () {
-        yield results[0]
+        yield {
+          name: 'PROVIDER',
+          providers: [
+            results[0]
+          ]
+        }
       })
 
       sinon.stub(delegate, 'findProviders').callsFake(function * () { // eslint-disable-line require-yield

test/content-routing/dht/configuration.node.js

@@ -38,13 +38,13 @@ describe('DHT subsystem is configurable', () => {
     })
 
     libp2p = await create(customOptions)
-    expect(libp2p._dht.isStarted).to.equal(false)
+    expect(libp2p._dht.isStarted()).to.equal(false)
 
     await libp2p.start()
-    expect(libp2p._dht.isStarted).to.equal(true)
+    expect(libp2p._dht.isStarted()).to.equal(true)
 
     await libp2p.stop()
-    expect(libp2p._dht.isStarted).to.equal(false)
+    expect(libp2p._dht.isStarted()).to.equal(false)
   })
 
   it('should not start if disabled once libp2p starts', async () => {
@@ -63,10 +63,10 @@ describe('DHT subsystem is configurable', () => {
     })
 
     libp2p = await create(customOptions)
-    expect(libp2p._dht.isStarted).to.equal(false)
+    expect(libp2p._dht.isStarted()).to.equal(false)
 
     await libp2p.start()
-    expect(libp2p._dht.isStarted).to.equal(false)
+    expect(libp2p._dht.isStarted()).to.equal(false)
   })
 
   it('should allow a manual start', async () => {
@@ -86,9 +86,9 @@ describe('DHT subsystem is configurable', () => {
 
     libp2p = await create(customOptions)
     await libp2p.start()
-    expect(libp2p._dht.isStarted).to.equal(false)
+    expect(libp2p._dht.isStarted()).to.equal(false)
 
     await libp2p._dht.start()
-    expect(libp2p._dht.isStarted).to.equal(true)
+    expect(libp2p._dht.isStarted()).to.equal(true)
   })
 })

test/content-routing/dht/operation.node.js

@@ -60,8 +60,8 @@ describe('DHT subsystem operates correctly', () => {
       expect(connection).to.exist()
 
       return Promise.all([
-        pWaitFor(() => libp2p._dht.routingTable.size === 1),
-        pWaitFor(() => remoteLibp2p._dht.routingTable.size === 1)
+        pWaitFor(() => libp2p._dht._lan._routingTable.size === 1),
+        pWaitFor(() => remoteLibp2p._dht._lan._routingTable.size === 1)
       ])
     })
 
@@ -71,14 +71,14 @@ describe('DHT subsystem operates correctly', () => {
 
       await libp2p.dialProtocol(remAddr, subsystemMulticodecs)
       await Promise.all([
-        pWaitFor(() => libp2p._dht.routingTable.size === 1),
-        pWaitFor(() => remoteLibp2p._dht.routingTable.size === 1)
+        pWaitFor(() => libp2p._dht._lan._routingTable.size === 1),
+        pWaitFor(() => remoteLibp2p._dht._lan._routingTable.size === 1)
       ])
 
       await libp2p.contentRouting.put(key, value)
-      const fetchedValue = await remoteLibp2p.contentRouting.get(key)
 
-      expect(fetchedValue).to.eql(value)
+      const fetchedValue = await remoteLibp2p.contentRouting.get(key)
+      expect(fetchedValue).to.have.property('val').that.equalBytes(value)
     })
   })
 
@@ -119,11 +119,13 @@ describe('DHT subsystem operates correctly', () => {
       const connection = await libp2p.dial(remAddr)
 
       expect(connection).to.exist()
-      expect(libp2p._dht.routingTable.size).to.be.eql(0)
-      expect(remoteLibp2p._dht.routingTable.size).to.be.eql(0)
+      expect(libp2p._dht._lan._routingTable.size).to.be.eql(0)
 
       await remoteLibp2p._dht.start()
-      return pWaitFor(() => libp2p._dht.routingTable.size === 1)
+      // should be 0 directly after start - TODO this may be susceptible to timing bugs, we should have
+      // the ability to report stats on the DHT routing table instead of reaching into it's heart like this
+      expect(remoteLibp2p._dht._lan._routingTable.size).to.be.eql(0)
+      return pWaitFor(() => libp2p._dht._lan._routingTable.size === 1)
     })
 
     it('should put on a peer and get from the other', async () => {
@@ -133,12 +135,12 @@ describe('DHT subsystem operates correctly', () => {
       const value = uint8ArrayFromString('world')
 
       await remoteLibp2p._dht.start()
-      await pWaitFor(() => libp2p._dht.routingTable.size === 1)
+      await pWaitFor(() => libp2p._dht._lan._routingTable.size === 1)
 
       await libp2p.contentRouting.put(key, value)
 
       const fetchedValue = await remoteLibp2p.contentRouting.get(key)
-      expect(fetchedValue).to.eql(value)
+      expect(fetchedValue).to.have.property('val').that.equalBytes(value)
     })
   })
 })

test/content-routing/dht/utils.js

@@ -1,7 +1,6 @@
 'use strict'
 
 const KadDht = require('libp2p-kad-dht')
-const { multicodec } = require('libp2p-kad-dht')
 const Crypto = require('../../../src/insecure/plaintext')
 const Muxer = require('libp2p-mplex')
 const Transport = require('libp2p-tcp')
@@ -25,13 +24,12 @@ const subsystemOptions = mergeOptions(baseOptions, {
   config: {
     dht: {
       kBucketSize: 20,
-      randomWalk: {
-        enabled: true
-      },
       enabled: true
     }
   }
 })
 
 module.exports.subsystemOptions = subsystemOptions
-module.exports.subsystemMulticodecs = [multicodec]
+module.exports.subsystemMulticodecs = [
+  '/ipfs/lan/kad/1.0.0'
+]

test/content-routing/utils.js

@@ -13,9 +13,6 @@ const routingOptions = mergeOptions(baseOptions, {
   config: {
     dht: {
       kBucketSize: 20,
-      randomWalk: {
-        enabled: true
-      },
       enabled: true
     }
   }

test/nat-manager/nat-manager.node.js

@@ -244,6 +244,10 @@ describe('Nat Manager (TCP)', () => {
   })
 
   it('shuts the nat api down when stopping', async function () {
+    if (process.env.CI) {
+      return this.skip('CI environments will not let us map external ports')
+    }
+
     function findRoutableAddress () {
       const interfaces = networkInterfaces()
 
@@ -261,7 +265,7 @@ describe('Nat Manager (TCP)', () => {
 
     if (!addr) {
       // skip test if no non-loopback address is found
-      this.skip()
+      return this.skip()
     }
 
     const {

test/peer-discovery/index.node.js

@@ -161,20 +161,13 @@ describe('peer discovery scenarios', () => {
           autoDial: false
         },
         dht: {
-          randomWalk: {
-            enabled: false,
-            delay: 1000, // start the first query quickly
-            interval: 10000,
-            timeout: 5000
-          },
           enabled: true
         }
       }
     })
 
     const localConfig = getConfig(peerId)
-    // Only run random walk on our local node
-    localConfig.config.dht.randomWalk.enabled = true
+
     libp2p = new Libp2p(localConfig)
 
     const remoteLibp2p1 = new Libp2p(getConfig(remotePeerId1))