feat: libp2p async peerstore (#4018)

Refactors interfaces and classes used by `libp2p-interfaces` to use the async peer store from libp2p/js-libp2p#1058

Fixes memory leak in libp2p, discussion in linked issue above.

BREAKING CHANGE: peerstore methods are now all async, the repo is migrated to v12

Author: achingbrain

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 16
+          node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
         with:
           build: |
@@ -30,7 +30,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 16
+          node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
         with:
           build: |
@@ -41,7 +41,7 @@ jobs:
           npm run dep-check -- -- -- -- --unused
 
   test-node:
-    name: Unit tests ${{ matrix.project }} node ${{ matrix.node }} ${{ matrix.os }}
+    name: Unit tests node ${{ matrix.node }} ${{ matrix.os }}
     needs: build
     runs-on: ${{ matrix.os }}
     strategy:
@@ -62,11 +62,10 @@ jobs:
       - run: npm run test:node -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1
       - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
         with:
-          directory: '**/.nyc_output'
           flags: node
 
   test-chrome:
-    name: Unit tests ${{ matrix.project }} ${{ matrix.browser }} ${{ matrix.type }}
+    name: Unit tests chrome
     needs: build
     runs-on: ubuntu-latest
     steps:
@@ -83,21 +82,12 @@ jobs:
       - run: npm run test:chrome -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1
       - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
         with:
-          directory: '**/.nyc_output'
           flags: chrome
 
   test-chrome-webworker:
-    name: Unit tests ${{ matrix.project }} ${{ matrix.browser }} ${{ matrix.type }}
+    name: Unit tests chrome-webworker
     needs: build
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        browser:
-          - chromium
-          - firefox
-        type:
-          - browser
-          - webworker
     steps:
       - uses: actions/checkout@v2
         with:
@@ -112,11 +102,10 @@ jobs:
       - run: npm run test:chrome-webworker -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1
       - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
         with:
-          directory: '**/.nyc_output'
           flags: chrome-webworker
 
   test-firefox:
-    name: Unit tests ${{ matrix.project }} ${{ matrix.browser }} ${{ matrix.type }}
+    name: Unit tests firefox
     needs: build
     runs-on: ubuntu-latest
     steps:
@@ -133,21 +122,12 @@ jobs:
       - run: npm run test:firefox -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1
       - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
         with:
-          directory: '**/.nyc_output'
           flags: firefox
 
   test-firefox-webworker:
-    name: Unit tests ${{ matrix.project }} ${{ matrix.browser }} ${{ matrix.type }}
+    name: Unit tests firefox-webworker
     needs: build
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        browser:
-          - chromium
-          - firefox
-        type:
-          - browser
-          - webworker
     steps:
       - uses: actions/checkout@v2
         with:
@@ -159,10 +139,10 @@ jobs:
         with:
           build: |
             npm run link
+      - run: npx playwright install --with-deps
       - run: npm run test:firefox-webworker -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1
       - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
         with:
-          directory: '**/.nyc_output'
           flags: firefox-webworker
 
   test-electron-main:
@@ -175,7 +155,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
-          node-version: 16
+          node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
         with:
           build: |
@@ -185,7 +165,6 @@ jobs:
           run: npm run test:electron-main -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1 -- -- --bail
       - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
         with:
-          directory: '**/.nyc_output'
           flags: electron-main
 
   test-electron-renderer:
@@ -198,7 +177,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
-          node-version: 16
+          node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
         with:
           build: |
@@ -208,12 +187,10 @@ jobs:
           run: npm run test:electron-renderer -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1 -- -- --bail
       - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
         with:
-          directory: '**/.nyc_output'
           flags: electron-renderer
 
   test-interop:
     name: Interop tests ${{ matrix.project }} ${{ matrix.type }}
-    needs: build
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -228,20 +205,22 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
-          node-version: 16
+          node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
         with:
           build: |
             npm run link
-      - run: npm run test:interop -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1 -- -- -- -t ${{ matrix.type }}
+      - run: |
+          npm install
+          npm run build
+          npm run link
+          npm run test:interop -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1 -- -- -- -t ${{ matrix.type }}
       - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
         with:
-          directory: '**/.nyc_output'
           flags: interop-${{ matrix.type }}
 
   test-interface:
     name: Interface tests ${{ matrix.suite }} ${{ matrix.type }}
-    needs: build
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -261,15 +240,14 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
-          node-version: 16
-      - uses: ipfs/aegir/actions/cache-node-modules@master
-        with:
-          build: |
-            npm run link
-      - run: npm run ${{ matrix.suite }} -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1 -- -- -t ${{ matrix.type }}
+          node-version: lts/*
+      - run: |
+          npm install
+          npm run build
+          npm run link
+          npm run ${{ matrix.suite }} -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1 -- -- -t ${{ matrix.type }}
       - uses: codecov/codecov-action@f32b3a3741e1053eb607407145bc9619351dc93b # v2.1.0
         with:
-          directory: '**/.nyc_output'
           flags: interface-${{ matrix.type }}
 
   test-interface-message-port-client:
@@ -282,11 +260,12 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
-          node-version: 16
+          node-version: lts/*
       - uses: ipfs/aegir/actions/cache-node-modules@master
         with:
           build: |
             npm run link
+      - run: npx playwright install --with-deps
       - run: npm run test:interface:message-port-client -- --since ${{ github.event.pull_request.base.sha }} --concurrency 1
 
   release:
@@ -314,6 +293,8 @@ jobs:
           manifest-file: .release-please-manifest.json
           config-file: .release-please.json
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
           node-version: lts/*

README.md

@@ -36,10 +36,6 @@ We've come a long way, but this project is still in Alpha, lots of development i
 * See https://blog.ipfs.io for news and more
 * Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io
 
-## Lead Maintainer <!-- omit in toc -->
-
-[Alex Potsides](http://github.com/achingbrain)
-
 ## Table of Contents <!-- omit in toc -->
 
 - [Getting started](#getting-started)

packages/interface-ipfs-core/README.md

@@ -8,10 +8,6 @@
 
 > A test suite and interface you can use to implement an IPFS core interface.
 
-## Lead Maintainer <!-- omit in toc -->
-
-[Alex Potsides](http://github.com/achingbrain)
-
 ## Table of Contents <!-- omit in toc -->
 
 - [Background](#background)

packages/interface-ipfs-core/package.json

@@ -89,8 +89,9 @@
     "it-pushable": "^1.4.2",
     "it-tar": "^4.0.0",
     "it-to-buffer": "^2.0.0",
-    "libp2p-crypto": "^0.21.0",
+    "libp2p-crypto": "^0.21.1",
     "libp2p-websockets": "^0.16.2",
+    "merge-options": "^3.0.4",
     "multiaddr": "^10.0.0",
     "multiformats": "^9.4.13",
     "nanoid": "^3.1.23",

packages/interface-ipfs-core/src/miscellaneous/id.js

@@ -48,7 +48,7 @@ export function testId (factory, options) {
 
       expect(res).to.have.a.property('protocols').that.is.an('array')
 
-      expect(res.protocols).to.have.members([
+      expect(res.protocols).to.include.members([
         '/floodsub/1.0.0',
         '/ipfs/bitswap/1.0.0',
         '/ipfs/bitswap/1.1.0',

packages/interface-ipfs-core/src/miscellaneous/resolve.js

@@ -9,6 +9,7 @@ import { getDescribe, getIt } from '../utils/mocha.js'
 import all from 'it-all'
 import { isWebWorker } from 'ipfs-utils/src/env.js'
 import { ipfsOptionsWebsocketsFilterAll } from '../utils/ipfs-options-websockets-filter-all.js'
+import merge from 'merge-options'
 
 /**
  * @typedef {import('ipfsd-ctl').Factory} Factory
@@ -31,7 +32,16 @@ export function testResolve (factory, options) {
     let ipfsId
 
     before(async () => {
-      ipfs = (await factory.spawn({ type: 'proc', ipfsOptions })).api
+      ipfs = (await factory.spawn({
+        type: 'proc',
+        ipfsOptions: merge(ipfsOptions, {
+          config: {
+            Routing: {
+              Type: 'none'
+            }
+          }
+        })
+      })).api
       ipfsId = await ipfs.id()
     })
 
@@ -97,7 +107,16 @@ export function testResolve (factory, options) {
       // @ts-ignore this is mocha
       this.timeout(20 * 1000)
       // webworkers are not dialable because webrtc is not available
-      const node = (await factory.spawn({ type: isWebWorker ? 'go' : undefined })).api
+      const node = (await factory.spawn({
+        type: isWebWorker ? 'go' : undefined,
+        ipfsOptions: {
+          config: {
+            Routing: {
+              Type: 'none'
+            }
+          }
+        }
+      })).api
       const nodeId = await node.id()
       await ipfs.swarm.connect(nodeId.addresses[0])
       const { path } = await ipfs.add(uint8ArrayFromString('should resolve a record recursive === true'))
@@ -106,15 +125,24 @@ export function testResolve (factory, options) {
       await ipfs.name.publish(path, { allowOffline: true })
       await ipfs.name.publish(`/ipns/${ipfsId.id}`, { allowOffline: true, key: 'key-name', resolve: false })
 
-      return expect(await ipfs.resolve(`/ipns/${keyId}`))
-        .to.eq(`/ipfs/${path}`)
+      return expect(ipfs.resolve(`/ipns/${keyId}`))
+        .to.eventually.equal(`/ipfs/${path}`)
     })
 
     it('should resolve IPNS link non-recursively if recursive==false', async function () {
       // @ts-ignore this is mocha
       this.timeout(20 * 1000)
       // webworkers are not dialable because webrtc is not available
-      const node = (await factory.spawn({ type: isWebWorker ? 'go' : undefined })).api
+      const node = (await factory.spawn({
+        type: isWebWorker ? 'go' : undefined,
+        ipfsOptions: {
+          config: {
+            Routing: {
+              Type: 'none'
+            }
+          }
+        }
+      })).api
       const nodeId = await node.id()
       await ipfs.swarm.connect(nodeId.addresses[0])
       const { path } = await ipfs.add(uint8ArrayFromString('should resolve an IPNS key if recursive === false'))
@@ -123,8 +151,8 @@ export function testResolve (factory, options) {
       await ipfs.name.publish(path, { allowOffline: true })
       await ipfs.name.publish(`/ipns/${ipfsId.id}`, { allowOffline: true, key: 'new-key-name', resolve: false })
 
-      return expect(await ipfs.resolve(`/ipns/${keyId}`, { recursive: false }))
-        .to.eq(`/ipns/${ipfsId.id}`)
+      return expect(ipfs.resolve(`/ipns/${keyId}`, { recursive: false }))
+        .to.eventually.equal(`/ipns/${ipfsId.id}`)
     })
   })
 }

packages/interface-ipfs-core/src/name/publish.js

@@ -28,7 +28,15 @@ export function testPublish (factory, options) {
     let nodeId
 
     before(async () => {
-      ipfs = (await factory.spawn()).api
+      ipfs = (await factory.spawn({
+        ipfsOptions: {
+          config: {
+            Routing: {
+              Type: 'none'
+            }
+          }
+        }
+      })).api
       const peerInfo = await ipfs.id()
       nodeId = peerInfo.id
       await ipfs.add(fixture.data, { pin: false })

packages/interface-ipfs-core/src/name/resolve.js

@@ -28,7 +28,15 @@ export function testResolve (factory, options) {
     let nodeId
 
     before(async () => {
-      ipfs = (await factory.spawn()).api
+      ipfs = (await factory.spawn({
+        ipfsOptions: {
+          config: {
+            Routing: {
+              Type: 'none'
+            }
+          }
+        }
+      })).api
       const peerInfo = await ipfs.id()
       nodeId = peerInfo.id
     })

packages/ipfs-cli/README.md

@@ -2,10 +2,6 @@
 
 > The implementation of the js-IPFS CLI
 
-## Lead Maintainer <!-- omit in toc -->
-
-[Alex Potsides](http://github.com/achingbrain)
-
 ## Table of Contents <!-- omit in toc -->
 
 - [Install](#install)