diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml index 36173f4f8a..0e46e95155 100644 --- a/.github/workflows/examples.yml +++ b/.github/workflows/examples.yml @@ -8,17 +8,59 @@ on: - '**' jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: 16 + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i check: + needs: build runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i - run: npx aegir lint - run: npx aegir ts -p check - - run: npx aegir build test-auto-relay-example: needs: check runs-on: ubuntu-latest @@ -27,8 +69,25 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install - - run: cd examples && npm i && npm run test -- auto-relay + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- auto-relay test-chat-example: needs: check runs-on: ubuntu-latest @@ -37,8 +96,25 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install - - run: cd examples && npm i && npm run test -- chat + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- chat test-connection-encryption-example: needs: check runs-on: ubuntu-latest @@ -47,8 +123,25 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install - - run: cd examples && npm i && npm run test -- connection-encryption + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- connection-encryption test-discovery-mechanisms-example: needs: check runs-on: macos-latest @@ -57,8 +150,25 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install - - run: cd examples && npm i && npm run test -- discovery-mechanisms + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- discovery-mechanisms test-echo-example: needs: check runs-on: ubuntu-latest @@ -67,8 +177,25 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install - - run: cd examples && npm i && npm run test -- echo + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- echo test-libp2p-in-the-browser-example: needs: check runs-on: macos-latest @@ -77,8 +204,25 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install - - run: cd examples && npm i && npm run test -- libp2p-in-the-browser + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- libp2p-in-the-browser test-peer-and-content-routing-example: needs: check runs-on: ubuntu-latest @@ -87,8 +231,25 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install - - run: cd examples && npm i && npm run test -- peer-and-content-routing + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- peer-and-content-routing test-pnet-example: needs: check runs-on: ubuntu-latest @@ -97,8 +258,25 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install - - run: cd examples && npm i && npm run test -- pnet + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- pnet test-protocol-and-stream-muxing-example: needs: check runs-on: ubuntu-latest @@ -107,8 +285,25 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install - - run: cd examples && npm i && npm run test -- protocol-and-stream-muxing + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- protocol-and-stream-muxing test-pubsub-example: needs: check runs-on: ubuntu-latest @@ -117,8 +312,25 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install - - run: cd examples && npm i && npm run test -- pubsub + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- pubsub test-transports-example: needs: check runs-on: ubuntu-latest @@ -127,8 +339,25 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install - - run: cd examples && npm i && npm run test -- transports + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- transports test-webrtc-direct-example: needs: check runs-on: ubuntu-latest @@ -137,5 +366,22 @@ jobs: - uses: actions/setup-node@v2 with: node-version: 16 - - run: npm install -g @mapbox/node-pre-gyp && npm install - - run: cd examples && npm i && npm run test -- webrtc-direct \ No newline at end of file + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + ./examples/node_modules + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + cd examples && npm i + - run: cd examples && npm run test -- webrtc-direct diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 69cd85eb3d..e92a69b7b4 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -8,63 +8,194 @@ on: - '**' jobs: + build: + runs-on: ${{ matrix.os }} + strategy: + matrix: + os: [ubuntu-latest, macos-latest] + node: [16] + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: 16 + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + check: + needs: build runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v2 with: - node-version: 14 - - run: npm install + node-version: 16 + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build - run: npx aegir lint - - uses: gozala/typescript-error-reporter-action@v1.0.8 - - run: npx aegir build - run: npx aegir dep-check - - uses: ipfs/aegir/actions/bundle-size@v32.1.0 + - uses: ipfs/aegir/actions/bundle-size@master name: size with: github_token: ${{ secrets.GITHUB_TOKEN }} + test-node: needs: check runs-on: ${{ matrix.os }} strategy: matrix: os: [windows-latest, ubuntu-latest, macos-latest] - node: [14, 16] + node: [16] fail-fast: true steps: - uses: actions/checkout@v2 - uses: actions/setup-node@v2 with: node-version: ${{ matrix.node }} - - run: npm install - - run: npx aegir test -t node --cov --bail + - uses: actions/cache@v2 + id: cache + if: matrix.os != 'windows-latest' + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + - run: npm run test:node -- --cov --bail - uses: codecov/codecov-action@v1 test-chrome: needs: check runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - run: npm install - - run: npx aegir test -t browser -t webworker --bail + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + - run: npm run test:browser -- -t browser -t webworker --bail test-firefox: needs: check runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - run: npm install - - run: npx aegir test -t browser -t webworker --bail -- --browser firefox + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + - run: npm run test:browser -- -t browser -t webworker --bail -- --browser firefox test-ts: needs: check runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - run: npm install + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build - run: npm run test:ts test-interop: needs: check runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - run: npm install - - run: cd node_modules/interop-libp2p && yarn && LIBP2P_JS=${GITHUB_WORKSPACE}/src/index.js npx aegir test -t node --bail -- --exit + - uses: actions/setup-node@v2 + with: + node-version: lts/* + - uses: actions/cache@v2 + id: cache + env: + CACHE_NAME: cache-node-modules + with: + path: | + ~/.cache + ~/.npm + ./node_modules + ./dist + key: ${{ runner.os }}-build-${{ env.CACHE_NAME }}-${{ github.event.pull_request.head.sha }} + - name: Install Dependencies + if: steps.cache.outputs.cache-hit != 'true' + run: | + npm install + npm run build + - run: npm run test:interop -- --bail -- --exit diff --git a/CHANGELOG.md b/CHANGELOG.md index ec0b71a3e3..7ee66cfe9c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,143 @@ +## [0.35.8](https://github.com/libp2p/js-libp2p/compare/v0.35.7...v0.35.8) (2021-12-29) + + +### Bug Fixes + +* do not wait for autodial start ([#1089](https://github.com/libp2p/js-libp2p/issues/1089)) ([79b3cfc](https://github.com/libp2p/js-libp2p/commit/79b3cfc6ad02ecc76fe23a3c3ff2d0b32a0ae4a8)) +* increase listeners on any-signal ([#1084](https://github.com/libp2p/js-libp2p/issues/1084)) ([f18fc80](https://github.com/libp2p/js-libp2p/commit/f18fc80b70bf7b6b26fffa70b0a8d0502a6c4801)) +* look for final peer event instead of peer response ([#1092](https://github.com/libp2p/js-libp2p/issues/1092)) ([d2b7ec0](https://github.com/libp2p/js-libp2p/commit/d2b7ec0f6be0ee80f2c963279a8ec2385059a889)) +* record tracked map clears ([#1085](https://github.com/libp2p/js-libp2p/issues/1085)) ([b4b4324](https://github.com/libp2p/js-libp2p/commit/b4b432406ebc08ef2fc3a1922c64cde7c9060cae)) + + + +## [0.35.7](https://github.com/libp2p/js-libp2p/compare/v0.35.2...v0.35.7) (2021-12-24) + + +### Bug Fixes + +* add tracked map ([#1069](https://github.com/libp2p/js-libp2p/issues/1069)) ([b425fa1](https://github.com/libp2p/js-libp2p/commit/b425fa12304def2a007d43a0aa445c28b766ed02)) +* clean up pending dial targets ([#1059](https://github.com/libp2p/js-libp2p/issues/1059)) ([bdc9f16](https://github.com/libp2p/js-libp2p/commit/bdc9f16d0cbe56ccf26822f11068e7795bcef046)) +* fix uncaught promise rejection when finding peers ([#1044](https://github.com/libp2p/js-libp2p/issues/1044)) ([3b683e7](https://github.com/libp2p/js-libp2p/commit/3b683e715686163e229b7b5c3a892327dfd4fc63)) +* increase the maxlisteners for timeout controllers ([#1065](https://github.com/libp2p/js-libp2p/issues/1065)) ([09a0f94](https://github.com/libp2p/js-libp2p/commit/09a0f940df7fdb4ece34604e85693709df5c213e)) +* main ci ([#1079](https://github.com/libp2p/js-libp2p/issues/1079)) ([d1c48dc](https://github.com/libp2p/js-libp2p/commit/d1c48dcbeded828f2dd3044cc9aed3f17f02846d)) +* make error codes consistent ([#1054](https://github.com/libp2p/js-libp2p/issues/1054)) ([b25e0fe](https://github.com/libp2p/js-libp2p/commit/b25e0fe5312db58a06c39500ae84c50fed3a93bd)) +* type definitions for big dialrequest and persistent peerstore ([#1078](https://github.com/libp2p/js-libp2p/issues/1078)) ([cb0d7d6](https://github.com/libp2p/js-libp2p/commit/cb0d7d6c99d179498f04e76df76e70e4f7d41c4c)) + + +### Features + +* allow per-component metrics to be collected ([#1061](https://github.com/libp2p/js-libp2p/issues/1061)) ([2f0b311](https://github.com/libp2p/js-libp2p/commit/2f0b311df7127aa44512c2008142d4ca30268986)), closes [#1060](https://github.com/libp2p/js-libp2p/issues/1060) + + + +## [0.35.6](https://github.com/libp2p/js-libp2p/compare/v0.35.5...v0.35.6) (2021-12-18) + + +### Bug Fixes + +* increase the maxlisteners for timeout controllers ([#1065](https://github.com/libp2p/js-libp2p/issues/1065)) ([09a0f94](https://github.com/libp2p/js-libp2p/commit/09a0f940df7fdb4ece34604e85693709df5c213e)) + + + +## [0.35.5](https://github.com/libp2p/js-libp2p/compare/v0.35.4...v0.35.5) (2021-12-15) + + + +## [0.35.4](https://github.com/libp2p/js-libp2p/compare/v0.35.3...v0.35.4) (2021-12-15) + + +### Features + +* allow per-component metrics to be collected ([#1061](https://github.com/libp2p/js-libp2p/issues/1061)) ([2f0b311](https://github.com/libp2p/js-libp2p/commit/2f0b311df7127aa44512c2008142d4ca30268986)), closes [#1060](https://github.com/libp2p/js-libp2p/issues/1060) + + + +## [0.35.3](https://github.com/libp2p/js-libp2p/compare/v0.35.2...v0.35.3) (2021-12-13) + + +### Bug Fixes + +* clean up pending dial targets ([#1059](https://github.com/libp2p/js-libp2p/issues/1059)) ([bdc9f16](https://github.com/libp2p/js-libp2p/commit/bdc9f16d0cbe56ccf26822f11068e7795bcef046)) +* fix uncaught promise rejection when finding peers ([#1044](https://github.com/libp2p/js-libp2p/issues/1044)) ([3b683e7](https://github.com/libp2p/js-libp2p/commit/3b683e715686163e229b7b5c3a892327dfd4fc63)) +* make error codes consistent ([#1054](https://github.com/libp2p/js-libp2p/issues/1054)) ([b25e0fe](https://github.com/libp2p/js-libp2p/commit/b25e0fe5312db58a06c39500ae84c50fed3a93bd)) + + + +## [0.35.2](https://github.com/libp2p/js-libp2p/compare/v0.33.0...v0.35.2) (2021-12-06) + + +### Bug Fixes + +* do not let closest peers run forever ([#1047](https://github.com/libp2p/js-libp2p/issues/1047)) ([91c2ec9](https://github.com/libp2p/js-libp2p/commit/91c2ec9856a3e972b7b2c9c4d9a4eda1d431c7ef)) +* increase maxlisteners on event target ([#1050](https://github.com/libp2p/js-libp2p/issues/1050)) ([b70fb43](https://github.com/libp2p/js-libp2p/commit/b70fb43427b47df079b55929ec8956f69cbda966)), closes [#900](https://github.com/libp2p/js-libp2p/issues/900) +* private ip ts compile has no call signatures ([#1020](https://github.com/libp2p/js-libp2p/issues/1020)) ([77d7cb8](https://github.com/libp2p/js-libp2p/commit/77d7cb8f0815f2cdd3bfdfa8b641a7a186fe9520)) +* stop dht before connection manager ([#1041](https://github.com/libp2p/js-libp2p/issues/1041)) ([3a9d5f6](https://github.com/libp2p/js-libp2p/commit/3a9d5f64d96719ebb4d3b083c4f5832db4fa0816)), closes [#1039](https://github.com/libp2p/js-libp2p/issues/1039) + + +### chore + +* update peer id and libp2p crypto ([#1042](https://github.com/libp2p/js-libp2p/issues/1042)) ([9cbf36f](https://github.com/libp2p/js-libp2p/commit/9cbf36fcb54099e6fed35ceccc4a2376f0926c1f)) + + +### Features + +* update dht ([#1009](https://github.com/libp2p/js-libp2p/issues/1009)) ([2f598eb](https://github.com/libp2p/js-libp2p/commit/2f598eba09cff4301474af08196158065e3602d8)) + + +### BREAKING CHANGES + +* requires node 15+ +* libp2p-kad-dht has a new event-based API which is exposed as `_dht` + + + +## [0.35.1](https://github.com/libp2p/js-libp2p/compare/v0.35.0...v0.35.1) (2021-12-03) + + +### Bug Fixes + +* do not let closest peers run forever ([#1047](https://github.com/libp2p/js-libp2p/issues/1047)) ([91c2ec9](https://github.com/libp2p/js-libp2p/commit/91c2ec9856a3e972b7b2c9c4d9a4eda1d431c7ef)) + + + +# [0.35.0](https://github.com/libp2p/js-libp2p/compare/v0.34.0...v0.35.0) (2021-12-02) + + +### Bug Fixes + +* stop dht before connection manager ([#1041](https://github.com/libp2p/js-libp2p/issues/1041)) ([3a9d5f6](https://github.com/libp2p/js-libp2p/commit/3a9d5f64d96719ebb4d3b083c4f5832db4fa0816)), closes [#1039](https://github.com/libp2p/js-libp2p/issues/1039) + + +### chore + +* update peer id and libp2p crypto ([#1042](https://github.com/libp2p/js-libp2p/issues/1042)) ([9cbf36f](https://github.com/libp2p/js-libp2p/commit/9cbf36fcb54099e6fed35ceccc4a2376f0926c1f)) + + +### BREAKING CHANGES + +* requires node 15+ + + + +# [0.34.0](https://github.com/libp2p/js-libp2p/compare/v0.33.0...v0.34.0) (2021-11-25) + + +### Bug Fixes + +* private ip ts compile has no call signatures ([#1020](https://github.com/libp2p/js-libp2p/issues/1020)) ([77d7cb8](https://github.com/libp2p/js-libp2p/commit/77d7cb8f0815f2cdd3bfdfa8b641a7a186fe9520)) + + +### Features + +* update dht ([#1009](https://github.com/libp2p/js-libp2p/issues/1009)) ([2f598eb](https://github.com/libp2p/js-libp2p/commit/2f598eba09cff4301474af08196158065e3602d8)) + + +### BREAKING CHANGES + +* libp2p-kad-dht has a new event-based API which is exposed as `_dht` + + + # [0.33.0](https://github.com/libp2p/js-libp2p/compare/v0.32.5...v0.33.0) (2021-09-24) diff --git a/README.md b/README.md index d5c901252f..90f3ac9f24 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,8 @@ - - + +

diff --git a/doc/CONFIGURATION.md b/doc/CONFIGURATION.md index b9b24fd04d..89d9197340 100644 --- a/doc/CONFIGURATION.md +++ b/doc/CONFIGURATION.md @@ -1,37 +1,37 @@ -# - -- [Configuration](#configuration) - - [Overview](#overview) - - [Modules](#modules) - - [Transport](#transport) - - [Stream Multiplexing](#stream-multiplexing) - - [Connection Encryption](#connection-encryption) - - [Peer Discovery](#peer-discovery) - - [Content Routing](#content-routing) - - [Peer Routing](#peer-routing) - - [DHT](#dht) - - [Pubsub](#pubsub) - - [Customizing libp2p](#customizing-libp2p) - - [Examples](#examples) - - [Basic setup](#basic-setup) - - [Customizing Peer Discovery](#customizing-peer-discovery) - - [Setup webrtc transport and discovery](#setup-webrtc-transport-and-discovery) - - [Customizing Pubsub](#customizing-pubsub) - - [Customizing DHT](#customizing-dht) - - [Setup with Content and Peer Routing](#setup-with-content-and-peer-routing) - - [Setup with Relay](#setup-with-relay) - - [Setup with Auto Relay](#setup-with-auto-relay) - - [Setup with Keychain](#setup-with-keychain) - - [Configuring Dialing](#configuring-dialing) - - [Configuring Connection Manager](#configuring-connection-manager) - - [Configuring Transport Manager](#configuring-transport-manager) - - [Configuring Metrics](#configuring-metrics) - - [Configuring PeerStore](#configuring-peerstore) - - [Customizing Transports](#customizing-transports) - - [Configuring the NAT Manager](#configuring-the-nat-manager) - - [Browser support](#browser-support) - - [UPnP and NAT-PMP](#upnp-and-nat-pmp) - - [Configuration examples](#configuration-examples) +# + +- [Overview](#overview) +- [Modules](#modules) + - [Transport](#transport) + - [Stream Multiplexing](#stream-multiplexing) + - [Connection Encryption](#connection-encryption) + - [Peer Discovery](#peer-discovery) + - [Content Routing](#content-routing) + - [Peer Routing](#peer-routing) + - [DHT](#dht) + - [Pubsub](#pubsub) +- [Customizing libp2p](#customizing-libp2p) + - [Examples](#examples) + - [Basic setup](#basic-setup) + - [Customizing Peer Discovery](#customizing-peer-discovery) + - [Setup webrtc transport and discovery](#setup-webrtc-transport-and-discovery) + - [Customizing Pubsub](#customizing-pubsub) + - [Customizing DHT](#customizing-dht) + - [Setup with Content and Peer Routing](#setup-with-content-and-peer-routing) + - [Setup with Relay](#setup-with-relay) + - [Setup with Auto Relay](#setup-with-auto-relay) + - [Setup with Keychain](#setup-with-keychain) + - [Configuring Dialing](#configuring-dialing) + - [Configuring Connection Manager](#configuring-connection-manager) + - [Configuring Transport Manager](#configuring-transport-manager) + - [Configuring Metrics](#configuring-metrics) + - [Configuring PeerStore](#configuring-peerstore) + - [Customizing Transports](#customizing-transports) + - [Configuring the NAT Manager](#configuring-the-nat-manager) + - [Browser support](#browser-support) + - [UPnP and NAT-PMP](#upnp-and-nat-pmp) + - [Configuring protocol name](#configuring-protocol-name) +- [Configuration examples](#configuration-examples) ## Overview @@ -374,11 +374,7 @@ const node = await Libp2p.create({ dht: { // The DHT options (and defaults) can be found in its documentation kBucketSize: 20, enabled: true, // This flag is required for DHT to run (disabled by default) - randomWalk: { - enabled: true, // Allows to disable discovery (enabled by default) - interval: 300e3, - timeout: 10e3 - } + clientMode: false // Whether to run the WAN DHT in client or server mode (default: client mode) } } }) @@ -501,9 +497,9 @@ const Libp2p = require('libp2p') const TCP = require('libp2p-tcp') const MPLEX = require('libp2p-mplex') const { NOISE } = require('libp2p-noise') -const LevelStore = require('datastore-level') +const LevelDatastore = require('datastore-level') -const datastore = new LevelStore('path/to/store') +const datastore = new LevelDatastore('path/to/store') await datastore.open() const node = await Libp2p.create({ @@ -676,18 +672,18 @@ const Libp2p = require('libp2p') const TCP = require('libp2p-tcp') const MPLEX = require('libp2p-mplex') const { NOISE } = require('libp2p-noise') -const LevelStore = require('datastore-level') +const LevelDatastore = require('datastore-level') -const datastore = new LevelStore('path/to/store') -const dsInstant = await datastore.open() +const datastore = new LevelDatastore('path/to/store') +await datastore.open() // level database must be ready before node boot const node = await Libp2p.create({ + datastore, // pass the opened datastore modules: { transport: [TCP], streamMuxer: [MPLEX], connEncryption: [NOISE] }, - datastore: dsInstant, peerStore: { persistence: true, threshold: 5 @@ -788,7 +784,7 @@ By default under nodejs libp2p will attempt to use [UPnP](https://en.wikipedia.o #### Configuring protocol name -Changing the protocol name prefix can isolate default public network (IPFS) for custom purposes. +Changing the protocol name prefix can isolate default public network (IPFS) for custom purposes. ```js const node = await Libp2p.create({ @@ -810,8 +806,8 @@ protocols: [ As libp2p is designed to be a modular networking library, its usage will vary based on individual project needs. We've included links to some existing project configurations for your reference, in case you wish to replicate their configuration: -- [libp2p-ipfs-nodejs](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/src/core/runtime/libp2p-nodejs.js) - libp2p configuration used by js-ipfs when running in Node.js -- [libp2p-ipfs-browser](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs/src/core/runtime/libp2p-browser.js) - libp2p configuration used by js-ipfs when running in a Browser (that supports WebRTC) +- [libp2p-ipfs-nodejs](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core-config/src/libp2p.js) - libp2p configuration used by js-ipfs when running in Node.js +- [libp2p-ipfs-browser](https://github.com/ipfs/js-ipfs/blob/master/packages/ipfs-core-config/src/libp2p.browser.js) - libp2p configuration used by js-ipfs when running in a Browser (that supports WebRTC) If you have developed a project using `js-libp2p`, please consider submitting your configuration to this list so that it can be found easily by other users. diff --git a/examples/delegated-routing/package.json b/examples/delegated-routing/package.json index 164e0d3c54..76a06b46ed 100644 --- a/examples/delegated-routing/package.json +++ b/examples/delegated-routing/package.json @@ -7,7 +7,7 @@ "libp2p": "github:libp2p/js-libp2p#master", "libp2p-delegated-content-routing": "~0.2.2", "libp2p-delegated-peer-routing": "~0.2.2", - "libp2p-kad-dht": "~0.14.12", + "libp2p-kad-dht": "^0.26.5", "libp2p-mplex": "~0.8.5", "libp2p-secio": "~0.11.1", "libp2p-webrtc-star": "~0.15.8", diff --git a/examples/libp2p-in-the-browser/package.json b/examples/libp2p-in-the-browser/package.json index cf2fdc7dee..9a45c90d51 100644 --- a/examples/libp2p-in-the-browser/package.json +++ b/examples/libp2p-in-the-browser/package.json @@ -28,6 +28,6 @@ "babel-plugin-syntax-async-functions": "^6.13.0", "babel-plugin-transform-regenerator": "^6.26.0", "babel-polyfill": "^6.26.0", - "parcel": "next" + "parcel": "^2.0.1" } } diff --git a/examples/pubsub/1.js b/examples/pubsub/1.js index c4eed3d0c5..f1f60eb9ac 100644 --- a/examples/pubsub/1.js +++ b/examples/pubsub/1.js @@ -41,13 +41,13 @@ const createNode = async () => { node1.pubsub.on(topic, (msg) => { console.log(`node1 received: ${uint8ArrayToString(msg.data)}`) }) - await node1.pubsub.subscribe(topic) + node1.pubsub.subscribe(topic) // Will not receive own published messages by default node2.pubsub.on(topic, (msg) => { console.log(`node2 received: ${uint8ArrayToString(msg.data)}`) }) - await node2.pubsub.subscribe(topic) + node2.pubsub.subscribe(topic) // node2 publishes "news" every second setInterval(() => { diff --git a/examples/transports/README.md b/examples/transports/README.md index 8c9d23b908..18f5975bc7 100644 --- a/examples/transports/README.md +++ b/examples/transports/README.md @@ -91,7 +91,7 @@ const concat = require('it-concat') const MPLEX = require('libp2p-mplex') ``` -We are going to reuse the `createNode` function from step 1, but this time add a stream multiplexer from `libp2p-mplex`. +We are going to reuse the `createNode` function from step 1, but this time add a stream multiplexer from `libp2p-mplex`. ```js const createNode = async () => { const node = await Libp2p.create({ diff --git a/examples/webrtc-direct/index.html b/examples/webrtc-direct/index.html index a29b43bf3a..3fcf9c35d7 100644 --- a/examples/webrtc-direct/index.html +++ b/examples/webrtc-direct/index.html @@ -12,6 +12,6 @@

Starting libp2p...


   
- + diff --git a/examples/webrtc-direct/package.json b/examples/webrtc-direct/package.json index a1ef5448e9..a77ab6faee 100644 --- a/examples/webrtc-direct/package.json +++ b/examples/webrtc-direct/package.json @@ -3,7 +3,6 @@ "version": "0.0.1", "private": true, "description": "", - "main": "dist/index.html", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "build": "parcel build index.html", @@ -13,10 +12,11 @@ "devDependencies": { "@babel/cli": "^7.13.10", "@babel/core": "^7.13.10", + "@mapbox/node-pre-gyp": "^1.0.8", "babel-plugin-syntax-async-functions": "^6.13.0", "babel-plugin-transform-regenerator": "^6.26.0", "babel-polyfill": "^6.26.0", - "parcel-bundler": "1.12.3", + "parcel": "^2.0.1", "util": "^0.12.3" }, "dependencies": { @@ -25,7 +25,7 @@ "libp2p-mplex": "^0.10.4", "@chainsafe/libp2p-noise": "^4.1.0", "libp2p-webrtc-direct": "^0.7.0", - "peer-id": "^0.15.0" + "peer-id": "^0.16.0" }, "browser": { "ipfs": "ipfs/dist/index.min.js" diff --git a/package.json b/package.json index 90fd102943..9551a59db7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "libp2p", - "version": "0.33.0", + "version": "0.35.8", "description": "JavaScript implementation of libp2p, a modular peer to peer network stack", "leadMaintainer": "Jacob Heun ", "main": "src/index.js", @@ -43,6 +43,7 @@ "test:node": "aegir test -t node -f \"./test/**/*.{node,spec}.js\"", "test:browser": "aegir test -t browser", "test:examples": "cd examples && npm run test:all", + "test:interop": "LIBP2P_JS=$PWD npx aegir test -t node -f ./node_modules/libp2p-interop/test/*", "prepare": "aegir build --no-bundle", "release": "aegir release -t node -t browser", "release-minor": "aegir release --type minor -t node -t browser", @@ -67,10 +68,10 @@ "homepage": "https://libp2p.io", "license": "MIT", "engines": { - "node": ">=14.0.0" + "node": ">=15.0.0" }, "browser": { - "@motrix/nat-api": false + "nat-api": false }, "eslintConfig": { "extends": "ipfs", @@ -81,10 +82,9 @@ ] }, "dependencies": { - "abortable-iterator": "^3.0.0", - "@motrix/nat-api": "^0.3.1", "@vascosantos/moving-average": "^1.1.0", "abort-controller": "^3.0.0", + "abortable-iterator": "^3.0.0", "aggregate-error": "^3.1.0", "any-signal": "^2.1.1", "bignumber.js": "^9.0.1", @@ -106,8 +106,8 @@ "it-merge": "^1.0.0", "it-pipe": "^1.1.0", "it-take": "^1.0.0", - "libp2p-crypto": "^0.19.4", - "libp2p-interfaces": "^1.0.0", + "libp2p-crypto": "^0.21.0", + "libp2p-interfaces": "^2.0.1", "libp2p-utils": "^0.4.0", "mafmt": "^10.0.0", "merge-options": "^3.0.4", @@ -115,26 +115,27 @@ "multiformats": "^9.0.0", "multistream-select": "^2.0.0", "mutable-proxy": "^1.0.0", + "nat-api": "^0.3.1", "node-forge": "^0.10.0", "p-any": "^3.0.0", "p-fifo": "^1.0.0", "p-retry": "^4.4.0", "p-settle": "^4.1.1", - "peer-id": "^0.15.0", + "peer-id": "^0.16.0", "private-ip": "^2.1.0", "protobufjs": "^6.10.2", "retimer": "^3.0.0", "sanitize-filename": "^1.6.3", "set-delayed-interval": "^1.0.0", "streaming-iterables": "^6.0.0", - "timeout-abort-controller": "^1.1.1", + "timeout-abort-controller": "^2.0.0", "uint8arrays": "^3.0.0", "varint": "^6.0.0", "wherearewe": "^1.0.0", "xsalsa20": "^1.1.0" }, "devDependencies": { - "@chainsafe/libp2p-noise": "^4.0.0", + "@chainsafe/libp2p-noise": "^5.0.0", "@nodeutils/defaults-deep": "^1.1.0", "@types/es6-promisify": "^6.0.0", "@types/node": "^16.0.1", @@ -144,31 +145,29 @@ "buffer": "^6.0.3", "datastore-core": "^6.0.7", "delay": "^5.0.0", - "interop-libp2p": "^0.4.0", - "into-stream": "^7.0.0", - "ipfs-http-client": "^52.0.2", + "into-stream": "^6.0.0", + "ipfs-http-client": "^54.0.2", "it-concat": "^2.0.0", "it-pair": "^1.0.0", "it-pushable": "^1.4.0", "libp2p": ".", - "libp2p-bootstrap": "^0.13.0", + "libp2p-bootstrap": "^0.14.0", "libp2p-delegated-content-routing": "^0.11.0", - "libp2p-delegated-peer-routing": "^0.10.0", - "libp2p-floodsub": "^0.27.0", - "libp2p-gossipsub": "^0.11.0", - "libp2p-interfaces-compliance-tests": "^1.0.0", - "libp2p-kad-dht": "^0.24.2", - "libp2p-mdns": "^0.17.0", + "libp2p-delegated-peer-routing": "^0.11.1", + "libp2p-interfaces-compliance-tests": "^2.0.1", + "libp2p-interop": "^0.6.0", + "libp2p-kad-dht": "^0.27.1", + "libp2p-mdns": "^0.18.0", "libp2p-mplex": "^0.10.1", "libp2p-tcp": "^0.17.0", - "libp2p-webrtc-star": "^0.23.0", + "libp2p-webrtc-star": "^0.25.0", "libp2p-websockets": "^0.16.0", "nock": "^13.0.3", "p-defer": "^3.0.0", "p-times": "^3.0.0", "p-wait-for": "^3.2.0", "rimraf": "^3.0.2", - "sinon": "^11.1.1", + "sinon": "^12.0.1", "util": "^0.12.3" }, "contributors": [ @@ -182,42 +181,45 @@ "Friedel Ziegelmayer ", "Maciej Krüger ", "Hugo Dias ", - "Chris Dostert ", "dirkmc ", "Volker Mische ", + "Chris Dostert ", "zeim839 <50573884+zeim839@users.noreply.github.com>", + "Robert Kiel ", "Richard Littauer ", "a1300 ", "Ryan Bell ", "ᴠɪᴄᴛᴏʀ ʙᴊᴇʟᴋʜᴏʟᴍ ", + "Andrew Nesbitt ", "Franck Royer ", "Thomas Eizinger ", + "Vít Habada ", "Giovanni T. Parra ", "acolytec3 <17355484+acolytec3@users.noreply.github.com>", + "Alan Smithee ", "Elven ", - "Andrew Nesbitt ", "Samlior ", "Didrik Nordström ", - "RasmusErik Voel Jensen ", - "Robert Kiel ", - "Smite Chow ", - "Soeren ", - "Sönke Hahn ", + "Aditya Bose <13054902+adbose@users.noreply.github.com>", "TJKoury ", + "TheStarBoys <41286328+TheStarBoys@users.noreply.github.com>", "Tiago Alves ", + "Tim Daubenschütz ", "XiaoZhang ", "Yusef Napora ", "Zane Starr ", "ebinks ", - "Aditya Bose <13054902+adbose@users.noreply.github.com>", + "greenSnot ", "isan_rivkin ", "mayerwin ", "mcclure ", + "patrickwoodhead <91056047+patrickwoodhead@users.noreply.github.com>", "phillmac ", "robertkiel ", "shresthagrawal <34920931+shresthagrawal@users.noreply.github.com>", "swedneck <40505480+swedneck@users.noreply.github.com>", - "greenSnot ", + "tuyennhv ", + "Sönke Hahn ", "Aleksei ", "Bernd Strehl ", "Chris Bratlien ", @@ -242,9 +244,13 @@ "Lars Gierth ", "Leask Wong ", "Marcin Tojek ", + "Marston Connell <34043723+TheMarstonConnell@users.noreply.github.com>", "Michael Burns <5170+mburns@users.noreply.github.com>", "Miguel Mota ", "Nuno Nogueira ", - "Philipp Muens " + "Philipp Muens ", + "RasmusErik Voel Jensen ", + "Smite Chow ", + "Soeren " ] } diff --git a/src/circuit/index.js b/src/circuit/index.js index 4d180b6edd..06d4107a1d 100644 --- a/src/circuit/index.js +++ b/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() diff --git a/src/config.js b/src/config.js index 9542c70036..0d9bbc4a84 100644 --- a/src/config.js +++ b/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, diff --git a/src/connection-manager/auto-dialler.js b/src/connection-manager/auto-dialler.js new file mode 100644 index 0000000000..5e71d7edcb --- /dev/null +++ b/src/connection-manager/auto-dialler.js @@ -0,0 +1,120 @@ +'use strict' + +const debug = require('debug') +const mergeOptions = require('merge-options') +// @ts-ignore retimer does not have types +const retimer = require('retimer') + +const log = Object.assign(debug('libp2p:connection-manager:auto-dialler'), { + error: debug('libp2p:connection-manager:auto-dialler:err') +}) + +const defaultOptions = { + enabled: true, + minConnections: 0, + autoDialInterval: 10000 +} + +/** + * @typedef {import('../index')} Libp2p + * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection + */ + +/** + * @typedef {Object} AutoDiallerOptions + * @property {boolean} [enabled = true] - Should preemptively guarantee connections are above the low watermark + * @property {number} [minConnections = 0] - The minimum number of connections to avoid pruning + * @property {number} [autoDialInterval = 10000] - How often, in milliseconds, it should preemptively guarantee connections are above the low watermark + */ + +class AutoDialler { + /** + * Proactively tries to connect to known peers stored in the PeerStore. + * It will keep the number of connections below the upper limit and sort + * the peers to connect based on wether we know their keys and protocols. + * + * @class + * @param {Libp2p} libp2p + * @param {AutoDiallerOptions} options + */ + constructor (libp2p, options = {}) { + this._options = mergeOptions.call({ ignoreUndefined: true }, defaultOptions, options) + this._libp2p = libp2p + this._running = false + this._autoDialTimeout = null + this._autoDial = this._autoDial.bind(this) + + log('options: %j', this._options) + } + + /** + * Starts the auto dialer + */ + start () { + if (!this._options.enabled) { + log('not enabled') + return + } + + this._running = true + this._autoDial().catch(err => { + log.error('could start autodial', err) + }) + log('started') + } + + /** + * Stops the auto dialler + */ + async stop () { + if (!this._options.enabled) { + log('not enabled') + return + } + + this._running = false + this._autoDialTimeout && this._autoDialTimeout.clear() + log('stopped') + } + + async _autoDial () { + const minConnections = this._options.minConnections + + // Already has enough connections + if (this._libp2p.connections.size >= minConnections) { + this._autoDialTimeout = retimer(this._autoDial, this._options.autoDialInterval) + return + } + + // Sort peers on wether we know protocols of public keys for them + const peers = Array.from(this._libp2p.peerStore.peers.values()) + .sort((a, b) => { + if (b.protocols && b.protocols.length && (!a.protocols || !a.protocols.length)) { + return 1 + } else if (b.id.pubKey && !a.id.pubKey) { + return 1 + } + return -1 + }) + + for (let i = 0; this._running && i < peers.length && this._libp2p.connections.size < minConnections; i++) { + if (!this._libp2p.connectionManager.get(peers[i].id)) { + log('connecting to a peerStore stored peer %s', peers[i].id.toB58String()) + try { + await this._libp2p.dialer.connectToPeer(peers[i].id) + } catch (/** @type {any} */ err) { + log.error('could not connect to peerStore stored peer', err) + } + } + } + + // Connection Manager was stopped + if (!this._running) { + return + } + + this._autoDialTimeout = retimer(this._autoDial, this._options.autoDialInterval) + } +} + +module.exports = AutoDialler diff --git a/src/connection-manager/index.js b/src/connection-manager/index.js index 802c9fe65d..ebdab62335 100644 --- a/src/connection-manager/index.js +++ b/src/connection-manager/index.js @@ -12,7 +12,7 @@ const LatencyMonitor = require('./latency-monitor') const retimer = require('retimer') const { EventEmitter } = require('events') - +const trackedMap = require('../metrics/tracked-map') const PeerId = require('peer-id') const { @@ -32,6 +32,10 @@ const defaultOptions = { defaultPeerValue: 1 } +const METRICS_COMPONENT = 'connection-manager' +const METRICS_PEER_CONNECTIONS = 'peer-connections' +const METRICS_PEER_VALUES = 'peer-values' + /** * @typedef {import('../')} Libp2p * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection @@ -83,20 +87,18 @@ class ConnectionManager extends EventEmitter { * * @type {Map} */ - this._peerValues = new Map() + this._peerValues = trackedMap(METRICS_COMPONENT, METRICS_PEER_VALUES, this._libp2p.metrics) /** * Map of connections per peer * * @type {Map} */ - this.connections = new Map() + this.connections = trackedMap(METRICS_COMPONENT, METRICS_PEER_CONNECTIONS, this._libp2p.metrics) this._started = false this._timer = null - this._autoDialTimeout = null this._checkMetrics = this._checkMetrics.bind(this) - this._autoDial = this._autoDial.bind(this) this._latencyMonitor = new LatencyMonitor({ latencyCheckIntervalMs: this._options.pollInterval, @@ -128,8 +130,6 @@ class ConnectionManager extends EventEmitter { this._started = true log('started') - - this._options.autoDial && this._autoDial() } /** @@ -138,7 +138,6 @@ class ConnectionManager extends EventEmitter { * @async */ async stop () { - this._autoDialTimeout && this._autoDialTimeout.clear() this._timer && this._timer.clear() this._latencyMonitor.removeListener('data', this._onLatencyMeasure) @@ -216,6 +215,7 @@ class ConnectionManager extends EventEmitter { const storedConn = this.connections.get(peerIdStr) this.emit('peer:connect', connection) + if (storedConn) { storedConn.push(connection) } else { @@ -248,6 +248,8 @@ class ConnectionManager extends EventEmitter { this.connections.delete(peerId) this._peerValues.delete(connection.remotePeer.toB58String()) this.emit('peer:disconnect', connection) + + this._libp2p.metrics && this._libp2p.metrics.onPeerDisconnected(connection.remotePeer) } } @@ -312,53 +314,6 @@ class ConnectionManager extends EventEmitter { } } - /** - * Proactively tries to connect to known peers stored in the PeerStore. - * It will keep the number of connections below the upper limit and sort - * the peers to connect based on wether we know their keys and protocols. - * - * @async - * @private - */ - async _autoDial () { - const minConnections = this._options.minConnections - - // Already has enough connections - if (this.size >= minConnections) { - this._autoDialTimeout = retimer(this._autoDial, this._options.autoDialInterval) - return - } - - // Sort peers on wether we know protocols of public keys for them - const peers = Array.from(this._libp2p.peerStore.peers.values()) - .sort((a, b) => { - if (b.protocols && b.protocols.length && (!a.protocols || !a.protocols.length)) { - return 1 - } else if (b.id.pubKey && !a.id.pubKey) { - return 1 - } - return -1 - }) - - for (let i = 0; i < peers.length && this.size < minConnections; i++) { - if (!this.get(peers[i].id)) { - log('connecting to a peerStore stored peer %s', peers[i].id.toB58String()) - try { - await this._libp2p.dialer.connectToPeer(peers[i].id) - - // Connection Manager was stopped - if (!this._started) { - return - } - } catch (/** @type {any} */ err) { - log.error('could not connect to peerStore stored peer', err) - } - } - } - - this._autoDialTimeout = retimer(this._autoDial, this._options.autoDialInterval) - } - /** * If we have more connections than our maximum, close a connection * to the lowest valued peer. diff --git a/src/content-routing/index.js b/src/content-routing/index.js index 7fc4b4fb5c..df04225d7c 100644 --- a/src/content-routing/index.js +++ b/src/content-routing/index.js @@ -8,9 +8,10 @@ const { requirePeers, maybeLimitSource } = require('./utils') - +const drain = require('it-drain') const merge = require('it-merge') const { pipe } = require('it-pipe') +const { DHTContentRouting } = require('../dht/dht-content-routing') /** * @typedef {import('peer-id')} PeerId @@ -38,7 +39,7 @@ class ContentRouting { // If we have the dht, add it to the available content routers if (this.dht && libp2p._config.dht.enabled) { - this.routers.push(this.dht) + this.routers.push(new DHTContentRouting(this.dht)) } } @@ -53,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( @@ -76,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))) @@ -91,12 +92,12 @@ class ContentRouting { * @param {number} [options.minPeers] - minimum number of peers required to successfully put * @returns {Promise} */ - put (key, value, options) { + async put (key, value, options) { if (!this.libp2p.isStarted() || !this.dht.isStarted) { throw errCode(new Error(messages.NOT_STARTED_YET), codes.DHT_NOT_STARTED) } - return this.dht.put(key, value, options) + await drain(this.dht.put(key, value, options)) } /** @@ -108,12 +109,18 @@ class ContentRouting { * @param {number} [options.timeout] - optional timeout (default: 60000) * @returns {Promise} */ - get (key, options) { + async get (key, options) { if (!this.libp2p.isStarted() || !this.dht.isStarted) { throw errCode(new Error(messages.NOT_STARTED_YET), codes.DHT_NOT_STARTED) } - return this.dht.get(key, options) + for await (const event of this.dht.get(key, options)) { + if (event.name === 'VALUE') { + return { from: event.peerId, val: event.value } + } + } + + throw errCode(new Error(messages.NOT_FOUND), codes.ERR_NOT_FOUND) } /** @@ -123,14 +130,33 @@ class ContentRouting { * @param {number} nVals * @param {Object} [options] - get options * @param {number} [options.timeout] - optional timeout (default: 60000) - * @returns {Promise} */ - async getMany (key, nVals, options) { // eslint-disable-line require-await + async * getMany (key, nVals, options) { // eslint-disable-line require-await if (!this.libp2p.isStarted() || !this.dht.isStarted) { throw errCode(new Error(messages.NOT_STARTED_YET), codes.DHT_NOT_STARTED) } - return this.dht.getMany(key, nVals, options) + if (!nVals) { + return + } + + let gotValues = 0 + + for await (const event of this.dht.get(key, options)) { + if (event.name === 'VALUE') { + yield { from: event.peerId, val: event.value } + + gotValues++ + + if (gotValues === nVals) { + break + } + } + } + + if (gotValues === 0) { + throw errCode(new Error(messages.NOT_FOUND), codes.ERR_NOT_FOUND) + } } } diff --git a/src/dht/dht-content-routing.js b/src/dht/dht-content-routing.js new file mode 100644 index 0000000000..ead668f3d4 --- /dev/null +++ b/src/dht/dht-content-routing.js @@ -0,0 +1,44 @@ +'use strict' + +const drain = require('it-drain') + +/** + * @typedef {import('peer-id')} PeerId + * @typedef {import('libp2p-interfaces/src/content-routing/types').ContentRouting} ContentRoutingModule + * @typedef {import('multiformats/cid').CID} CID + */ + +/** + * Wrapper class to convert events into returned values + * + * @implements {ContentRoutingModule} + */ +class DHTContentRouting { + /** + * @param {import('libp2p-kad-dht').DHT} dht + */ + constructor (dht) { + this._dht = dht + } + + /** + * @param {CID} cid + */ + async provide (cid) { + await drain(this._dht.provide(cid)) + } + + /** + * @param {CID} cid + * @param {*} options + */ + async * findProviders (cid, options) { + for await (const event of this._dht.findProviders(cid, options)) { + if (event.name === 'PROVIDER') { + yield * event.providers + } + } + } +} + +module.exports = { DHTContentRouting } diff --git a/src/dht/dht-peer-routing.js b/src/dht/dht-peer-routing.js new file mode 100644 index 0000000000..762abc80fa --- /dev/null +++ b/src/dht/dht-peer-routing.js @@ -0,0 +1,51 @@ +'use strict' + +const errCode = require('err-code') +const { messages, codes } = require('../errors') + +/** + * @typedef {import('peer-id')} PeerId + * @typedef {import('libp2p-interfaces/src/peer-routing/types').PeerRouting} PeerRoutingModule + */ + +/** + * Wrapper class to convert events into returned values + * + * @implements {PeerRoutingModule} + */ +class DHTPeerRouting { + /** + * @param {import('libp2p-kad-dht').DHT} dht + */ + constructor (dht) { + this._dht = dht + } + + /** + * @param {PeerId} peerId + * @param {any} options + */ + async findPeer (peerId, options = {}) { + for await (const event of this._dht.findPeer(peerId, options)) { + if (event.name === 'FINAL_PEER') { + return event.peer + } + } + + throw errCode(new Error(messages.NOT_FOUND), codes.ERR_NOT_FOUND) + } + + /** + * @param {Uint8Array} key + * @param {any} options + */ + async * getClosestPeers (key, options = {}) { + for await (const event of this._dht.getClosestPeers(key, options)) { + if (event.name === 'PEER_RESPONSE') { + yield * event.closer + } + } + } +} + +module.exports = { DHTPeerRouting } diff --git a/src/dialer/dial-request.js b/src/dialer/dial-request.js index 3f6fc18ae1..397fc784c4 100644 --- a/src/dialer/dial-request.js +++ b/src/dialer/dial-request.js @@ -1,11 +1,13 @@ 'use strict' const errCode = require('err-code') -const AbortController = require('abort-controller').default const { anySignal } = require('any-signal') // @ts-ignore p-fifo does not export types const FIFO = require('p-fifo') const pAny = require('p-any') +// @ts-expect-error setMaxListeners is missing from the types +const { setMaxListeners } = require('events') +const { codes } = require('../errors') /** * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection @@ -54,12 +56,17 @@ class DialRequest { const tokens = this.dialer.getTokens(this.addrs.length) // If no tokens are available, throw if (tokens.length < 1) { - throw errCode(new Error('No dial tokens available'), 'ERR_NO_DIAL_TOKENS') + throw errCode(new Error('No dial tokens available'), codes.ERR_NO_DIAL_TOKENS) } const tokenHolder = new FIFO() tokens.forEach(token => tokenHolder.push(token)) - const dialAbortControllers = this.addrs.map(() => new AbortController()) + const dialAbortControllers = this.addrs.map(() => { + const controller = new AbortController() + setMaxListeners && setMaxListeners(Infinity, controller.signal) + + return controller + }) let completedDials = 0 try { diff --git a/src/dialer/index.js b/src/dialer/index.js index 630e9c50b2..e6f3a0d020 100644 --- a/src/dialer/index.js +++ b/src/dialer/index.js @@ -6,15 +6,15 @@ const log = Object.assign(debug('libp2p:dialer'), { }) const errCode = require('err-code') const { Multiaddr } = require('multiaddr') -// @ts-ignore timeout-abourt-controles does not export types -const TimeoutController = require('timeout-abort-controller') +const { TimeoutController } = require('timeout-abort-controller') const { AbortError } = require('abortable-iterator') const { anySignal } = require('any-signal') - +// @ts-expect-error setMaxListeners is missing from the types +const { setMaxListeners } = require('events') const DialRequest = require('./dial-request') const { publicAddressesFirst } = require('libp2p-utils/src/address-sort') const getPeer = require('../get-peer') - +const trackedMap = require('../metrics/tracked-map') const { codes } = require('../errors') const { DIAL_TIMEOUT, @@ -23,6 +23,10 @@ const { MAX_ADDRS_TO_DIAL } = require('../constants') +const METRICS_COMPONENT = 'dialler' +const METRICS_PENDING_DIALS = 'pending-dials' +const METRICS_PENDING_DIAL_TARGETS = 'pending-dial-targets' + /** * @typedef {import('libp2p-interfaces/src/connection').Connection} Connection * @typedef {import('peer-id')} PeerId @@ -45,14 +49,15 @@ const { * @property {number} [maxDialsPerPeer = MAX_PER_PEER_DIALS] - Number of max concurrent dials per peer. * @property {number} [dialTimeout = DIAL_TIMEOUT] - How long a dial attempt is allowed to take. * @property {Record} [resolvers = {}] - multiaddr resolvers to use when dialing + * @property {import('../metrics')} [metrics] * * @typedef DialTarget * @property {string} id * @property {Multiaddr[]} addrs * * @typedef PendingDial - * @property {DialRequest} dialRequest - * @property {TimeoutController} controller + * @property {import('./dial-request')} dialRequest + * @property {import('timeout-abort-controller').TimeoutController} controller * @property {Promise} promise * @property {function():void} destroy */ @@ -70,7 +75,8 @@ class Dialer { maxAddrsToDial = MAX_ADDRS_TO_DIAL, dialTimeout = DIAL_TIMEOUT, maxDialsPerPeer = MAX_PER_PEER_DIALS, - resolvers = {} + resolvers = {}, + metrics }) { this.transportManager = transportManager this.peerStore = peerStore @@ -80,8 +86,12 @@ class Dialer { this.timeout = dialTimeout this.maxDialsPerPeer = maxDialsPerPeer this.tokens = [...new Array(maxParallelDials)].map((_, index) => index) - this._pendingDials = new Map() - this._pendingDialTargets = new Map() + + /** @type {Map} */ + this._pendingDials = trackedMap(METRICS_COMPONENT, METRICS_PENDING_DIALS, metrics) + + /** @type {Map void, reject: (err: Error) => void}>} */ + this._pendingDialTargets = trackedMap(METRICS_COMPONENT, METRICS_PENDING_DIAL_TARGETS, metrics) for (const [key, value] of Object.entries(resolvers)) { Multiaddr.resolvers.set(key, value) @@ -156,14 +166,16 @@ class Dialer { this._pendingDialTargets.set(id, { resolve, reject }) }) - const dialTarget = await Promise.race([ - this._createDialTarget(peer), - cancellablePromise - ]) - - this._pendingDialTargets.delete(id) + try { + const dialTarget = await Promise.race([ + this._createDialTarget(peer), + cancellablePromise + ]) - return dialTarget + return dialTarget + } finally { + this._pendingDialTargets.delete(id) + } } /** @@ -240,10 +252,15 @@ class Dialer { // Combine the timeout signal and options.signal, if provided const timeoutController = new TimeoutController(this.timeout) + const signals = [timeoutController.signal] options.signal && signals.push(options.signal) const signal = anySignal(signals) + // this signal will potentially be used while dialing lots of + // peers so prevent MaxListenersExceededWarning appearing in the console + setMaxListeners && setMaxListeners(Infinity, signal) + const pendingDial = { dialRequest, controller: timeoutController, @@ -254,6 +271,7 @@ class Dialer { } } this._pendingDials.set(dialTarget.id, pendingDial) + return pendingDial } diff --git a/src/errors.js b/src/errors.js index 5b4d070fb2..61f308667e 100644 --- a/src/errors.js +++ b/src/errors.js @@ -3,7 +3,8 @@ exports.messages = { NOT_STARTED_YET: 'The libp2p node is not started yet', DHT_DISABLED: 'DHT is not available', - CONN_ENCRYPTION_REQUIRED: 'At least one connection encryption module is required' + CONN_ENCRYPTION_REQUIRED: 'At least one connection encryption module is required', + NOT_FOUND: 'Not found' } exports.codes = { @@ -29,10 +30,35 @@ exports.codes = { ERR_INVALID_PARAMETERS: 'ERR_INVALID_PARAMETERS', ERR_INVALID_PEER: 'ERR_INVALID_PEER', ERR_MUXER_UNAVAILABLE: 'ERR_MUXER_UNAVAILABLE', + ERR_NOT_FOUND: 'ERR_NOT_FOUND', ERR_TIMEOUT: 'ERR_TIMEOUT', ERR_TRANSPORT_UNAVAILABLE: 'ERR_TRANSPORT_UNAVAILABLE', ERR_TRANSPORT_DIAL_FAILED: 'ERR_TRANSPORT_DIAL_FAILED', ERR_UNSUPPORTED_PROTOCOL: 'ERR_UNSUPPORTED_PROTOCOL', ERR_INVALID_MULTIADDR: 'ERR_INVALID_MULTIADDR', - ERR_SIGNATURE_NOT_VALID: 'ERR_SIGNATURE_NOT_VALID' + ERR_SIGNATURE_NOT_VALID: 'ERR_SIGNATURE_NOT_VALID', + ERR_FIND_SELF: 'ERR_FIND_SELF', + 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', + ERR_INVALID_CMS: 'ERR_INVALID_CMS', + ERR_MISSING_KEYS: 'ERR_MISSING_KEYS', + ERR_NO_KEY: 'ERR_NO_KEY', + ERR_INVALID_KEY_NAME: 'ERR_INVALID_KEY_NAME', + ERR_INVALID_KEY_TYPE: 'ERR_INVALID_KEY_TYPE', + ERR_KEY_ALREADY_EXISTS: 'ERR_KEY_ALREADY_EXISTS', + ERR_INVALID_KEY_SIZE: 'ERR_INVALID_KEY_SIZE', + ERR_KEY_NOT_FOUND: 'ERR_KEY_NOT_FOUND', + ERR_OLD_KEY_NAME_INVALID: 'ERR_OLD_KEY_NAME_INVALID', + ERR_NEW_KEY_NAME_INVALID: 'ERR_NEW_KEY_NAME_INVALID', + ERR_PASSWORD_REQUIRED: 'ERR_PASSWORD_REQUIRED', + ERR_PEM_REQUIRED: 'ERR_PEM_REQUIRED', + ERR_CANNOT_READ_KEY: 'ERR_CANNOT_READ_KEY', + ERR_MISSING_PRIVATE_KEY: 'ERR_MISSING_PRIVATE_KEY', + ERR_INVALID_OLD_PASS_TYPE: 'ERR_INVALID_OLD_PASS_TYPE', + ERR_INVALID_NEW_PASS_TYPE: 'ERR_INVALID_NEW_PASS_TYPE', + ERR_INVALID_PASS_LENGTH: 'ERR_INVALID_PASS_LENGTH', + ERR_NOT_IMPLEMENTED: 'ERR_NOT_IMPLEMENTED', + ERR_WRONG_PING_ACK: 'ERR_WRONG_PING_ACK' } diff --git a/src/index.js b/src/index.js index b06393bd3d..f9f2b6c37f 100644 --- a/src/index.js +++ b/src/index.js @@ -18,6 +18,7 @@ const { codes, messages } = require('./errors') const AddressManager = require('./address-manager') const ConnectionManager = require('./connection-manager') +const AutoDialler = require('./connection-manager/auto-dialler') const Circuit = require('./circuit/transport') const Relay = require('./circuit') const Dialer = require('./dialer') @@ -47,6 +48,8 @@ const { updateSelfPeerRecord } = require('./record/utils') * @typedef {import('libp2p-interfaces/src/pubsub').PubsubOptions} PubsubOptions * @typedef {import('interface-datastore').Datastore} Datastore * @typedef {import('./pnet')} Protector + * @typedef {Object} PersistentPeerStoreOptions + * @property {number} [threshold] */ /** @@ -55,16 +58,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] @@ -116,7 +112,7 @@ const { updateSelfPeerRecord } = require('./record/utils') * @property {KeychainOptions & import('./keychain/index').KeychainOptions} [keychain] * @property {MetricsOptions & import('./metrics').MetricsOptions} [metrics] * @property {import('./peer-routing').PeerRoutingOptions} [peerRouting] - * @property {PeerStoreOptions & import('./peer-store/persistent').PersistentPeerStoreOptions} [peerStore] + * @property {PeerStoreOptions & PersistentPeerStoreOptions} [peerStore] * @property {import('./transport-manager').TransportManagerOptions} [transportManager] * @property {Libp2pConfig} [config] * @@ -167,6 +163,15 @@ class Libp2p extends EventEmitter { this.peerId = this._options.peerId this.datastore = this._options.datastore + // Create Metrics + if (this._options.metrics.enabled) { + const metrics = new Metrics({ + ...this._options.metrics + }) + + this.metrics = metrics + } + this.peerStore = (this.datastore && this._options.peerStore.persistence) ? new PersistentPeerStore({ peerId: this.peerId, @@ -193,17 +198,13 @@ class Libp2p extends EventEmitter { // Create the Connection Manager this.connectionManager = new ConnectionManager(this, { - autoDial: this._config.peerDiscovery.autoDial, ...this._options.connectionManager }) - - // Create Metrics - if (this._options.metrics.enabled) { - this.metrics = new Metrics({ - ...this._options.metrics, - connectionManager: this.connectionManager - }) - } + this._autodialler = new AutoDialler(this, { + enabled: this._config.peerDiscovery.autoDial, + minConnections: this._options.connectionManager.minConnections, + autoDialInterval: this._options.connectionManager.autoDialInterval + }) // Create keychain if (this._options.keychain && this._options.keychain.datastore) { @@ -264,6 +265,7 @@ class Libp2p extends EventEmitter { this.dialer = new Dialer({ transportManager: this.transportManager, peerStore: this.peerStore, + metrics: this.metrics, ...this._options.dialer }) @@ -301,14 +303,9 @@ class Libp2p extends EventEmitter { // dht provided components (peerRouting, contentRouting, dht) if (this._modules.dht) { const DHT = this._modules.dht - // @ts-ignore Object is not constructable - this._dht = new DHT({ + // @ts-ignore TODO: types need fixing - DHT is an `object` which has no `create` method + this._dht = DHT.create({ libp2p: this, - dialer: this.dialer, - peerId: this.peerId, - peerStore: this.peerStore, - registrar: this.registrar, - datastore: this.datastore, ...this._config.dht }) } @@ -385,6 +382,8 @@ class Libp2p extends EventEmitter { this.relay && this.relay.stop() this.peerRouting.stop() + this._autodialler.stop() + await (this._dht && this._dht.stop()) for (const service of this._discovery.values()) { service.removeListener('peer', this._onDiscoveryPeer) @@ -399,7 +398,6 @@ class Libp2p extends EventEmitter { await Promise.all([ this.pubsub && this.pubsub.stop(), - this._dht && this._dht.stop(), this.metrics && this.metrics.stop() ]) @@ -624,7 +622,7 @@ class Libp2p extends EventEmitter { // DHT subsystem if (this._config.dht.enabled) { - this._dht && this._dht.start() + this._dht && await this._dht.start() // TODO: this should be modified once random-walk is used as // the other discovery modules @@ -655,6 +653,7 @@ class Libp2p extends EventEmitter { } this.connectionManager.start() + this._autodialler.start() // Peer discovery await this._setupPeerDiscovery() diff --git a/src/keychain/cms.js b/src/keychain/cms.js index e9361882df..f929cb4e71 100644 --- a/src/keychain/cms.js +++ b/src/keychain/cms.js @@ -10,6 +10,7 @@ const { certificateForKey, findAsync } = require('./util') const errcode = require('err-code') const { fromString: uint8ArrayFromString } = require('uint8arrays/from-string') const { toString: uint8ArrayToString } = require('uint8arrays/to-string') +const { codes } = require('../errors') const privates = new WeakMap() @@ -31,7 +32,7 @@ class CMS { */ constructor (keychain, dek) { if (!keychain) { - throw errcode(new Error('keychain is required'), 'ERR_KEYCHAIN_REQUIRED') + throw errcode(new Error('keychain is required'), codes.ERR_KEYCHAIN_REQUIRED) } this.keychain = keychain @@ -49,7 +50,7 @@ class CMS { */ async encrypt (name, plain) { if (!(plain instanceof Uint8Array)) { - throw errcode(new Error('Plain data must be a Uint8Array'), 'ERR_INVALID_PARAMS') + throw errcode(new Error('Plain data must be a Uint8Array'), codes.ERR_INVALID_PARAMETERS) } const key = await this.keychain.findKeyByName(name) @@ -81,7 +82,7 @@ class CMS { */ async decrypt (cmsData) { if (!(cmsData instanceof Uint8Array)) { - throw errcode(new Error('CMS data is required'), 'ERR_INVALID_PARAMS') + throw errcode(new Error('CMS data is required'), codes.ERR_INVALID_PARAMETERS) } let cms @@ -91,7 +92,7 @@ class CMS { // @ts-ignore not defined cms = forge.pkcs7.messageFromAsn1(obj) } catch (/** @type {any} */ err) { - throw errcode(new Error('Invalid CMS: ' + err.message), 'ERR_INVALID_CMS') + throw errcode(new Error('Invalid CMS: ' + err.message), codes.ERR_INVALID_CMS) } // Find a recipient whose key we hold. We only deal with recipient certs @@ -123,7 +124,7 @@ class CMS { if (!r) { // @ts-ignore cms types not defined const missingKeys = recipients.map(r => r.keyId) - throw errcode(new Error('Decryption needs one of the key(s): ' + missingKeys.join(', ')), 'ERR_MISSING_KEYS', { + throw errcode(new Error('Decryption needs one of the key(s): ' + missingKeys.join(', ')), codes.ERR_MISSING_KEYS, { missingKeys }) } @@ -131,7 +132,7 @@ class CMS { const key = await this.keychain.findKeyById(r.keyId) if (!key) { - throw errcode(new Error('No key available to decrypto'), 'ERR_NO_KEY') + throw errcode(new Error('No key available to decrypto'), codes.ERR_NO_KEY) } const pem = await this.keychain._getPrivateKey(key.name) diff --git a/src/keychain/index.js b/src/keychain/index.js index b25be5a854..f6a17ab62e 100644 --- a/src/keychain/index.js +++ b/src/keychain/index.js @@ -10,6 +10,7 @@ const crypto = require('libp2p-crypto') const { Key } = require('interface-datastore/key') const CMS = require('./cms') const errcode = require('err-code') +const { codes } = require('../errors') const { toString: uint8ArrayToString } = require('uint8arrays/to-string') const { fromString: uint8ArrayFromString } = require('uint8arrays/from-string') @@ -210,21 +211,21 @@ class Keychain { const self = this if (!validateKeyName(name) || name === 'self') { - return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), 'ERR_INVALID_KEY_NAME')) + return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), codes.ERR_INVALID_KEY_NAME)) } if (typeof type !== 'string') { - return throwDelayed(errcode(new Error(`Invalid key type '${type}'`), 'ERR_INVALID_KEY_TYPE')) + return throwDelayed(errcode(new Error(`Invalid key type '${type}'`), codes.ERR_INVALID_KEY_TYPE)) } const dsname = DsName(name) const exists = await self.store.has(dsname) - if (exists) return throwDelayed(errcode(new Error(`Key '${name}' already exists`), 'ERR_KEY_ALREADY_EXISTS')) + if (exists) return throwDelayed(errcode(new Error(`Key '${name}' already exists`), codes.ERR_KEY_ALREADY_EXISTS)) switch (type.toLowerCase()) { case 'rsa': if (!Number.isSafeInteger(size) || size < 2048) { - return throwDelayed(errcode(new Error(`Invalid RSA key size ${size}`), 'ERR_INVALID_KEY_SIZE')) + return throwDelayed(errcode(new Error(`Invalid RSA key size ${size}`), codes.ERR_INVALID_KEY_SIZE)) } break default: @@ -297,7 +298,7 @@ class Keychain { */ async findKeyByName (name) { if (!validateKeyName(name)) { - return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), 'ERR_INVALID_KEY_NAME')) + return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), codes.ERR_INVALID_KEY_NAME)) } const dsname = DsInfoName(name) @@ -305,7 +306,7 @@ class Keychain { const res = await this.store.get(dsname) return JSON.parse(uint8ArrayToString(res)) } catch (/** @type {any} */ err) { - return throwDelayed(errcode(new Error(`Key '${name}' does not exist. ${err.message}`), 'ERR_KEY_NOT_FOUND')) + return throwDelayed(errcode(new Error(`Key '${name}' does not exist. ${err.message}`), codes.ERR_KEY_NOT_FOUND)) } } @@ -318,7 +319,7 @@ class Keychain { async removeKey (name) { const self = this if (!validateKeyName(name) || name === 'self') { - return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), 'ERR_INVALID_KEY_NAME')) + return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), codes.ERR_INVALID_KEY_NAME)) } const dsname = DsName(name) const keyInfo = await self.findKeyByName(name) @@ -339,10 +340,10 @@ class Keychain { async renameKey (oldName, newName) { const self = this if (!validateKeyName(oldName) || oldName === 'self') { - return throwDelayed(errcode(new Error(`Invalid old key name '${oldName}'`), 'ERR_OLD_KEY_NAME_INVALID')) + return throwDelayed(errcode(new Error(`Invalid old key name '${oldName}'`), codes.ERR_OLD_KEY_NAME_INVALID)) } if (!validateKeyName(newName) || newName === 'self') { - return throwDelayed(errcode(new Error(`Invalid new key name '${newName}'`), 'ERR_NEW_KEY_NAME_INVALID')) + return throwDelayed(errcode(new Error(`Invalid new key name '${newName}'`), codes.ERR_NEW_KEY_NAME_INVALID)) } const oldDsname = DsName(oldName) const newDsname = DsName(newName) @@ -350,7 +351,7 @@ class Keychain { const newInfoName = DsInfoName(newName) const exists = await self.store.has(newDsname) - if (exists) return throwDelayed(errcode(new Error(`Key '${newName}' already exists`), 'ERR_KEY_ALREADY_EXISTS')) + if (exists) return throwDelayed(errcode(new Error(`Key '${newName}' already exists`), codes.ERR_KEY_ALREADY_EXISTS)) try { const pem = await self.store.get(oldDsname) @@ -379,10 +380,10 @@ class Keychain { */ async exportKey (name, password) { if (!validateKeyName(name)) { - return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), 'ERR_INVALID_KEY_NAME')) + return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), codes.ERR_INVALID_KEY_NAME)) } if (!password) { - return throwDelayed(errcode(new Error('Password is required'), 'ERR_PASSWORD_REQUIRED')) + return throwDelayed(errcode(new Error('Password is required'), codes.ERR_PASSWORD_REQUIRED)) } const dsname = DsName(name) @@ -409,20 +410,20 @@ class Keychain { async importKey (name, pem, password) { const self = this if (!validateKeyName(name) || name === 'self') { - return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), 'ERR_INVALID_KEY_NAME')) + return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), codes.ERR_INVALID_KEY_NAME)) } if (!pem) { - return throwDelayed(errcode(new Error('PEM encoded key is required'), 'ERR_PEM_REQUIRED')) + return throwDelayed(errcode(new Error('PEM encoded key is required'), codes.ERR_PEM_REQUIRED)) } const dsname = DsName(name) const exists = await self.store.has(dsname) - if (exists) return throwDelayed(errcode(new Error(`Key '${name}' already exists`), 'ERR_KEY_ALREADY_EXISTS')) + if (exists) return throwDelayed(errcode(new Error(`Key '${name}' already exists`), codes.ERR_KEY_ALREADY_EXISTS)) let privateKey try { privateKey = await crypto.keys.import(pem, password) } catch (/** @type {any} */ err) { - return throwDelayed(errcode(new Error('Cannot read the key, most likely the password is wrong'), 'ERR_CANNOT_READ_KEY')) + return throwDelayed(errcode(new Error('Cannot read the key, most likely the password is wrong'), codes.ERR_CANNOT_READ_KEY)) } let kid @@ -457,16 +458,16 @@ class Keychain { async importPeer (name, peer) { const self = this if (!validateKeyName(name)) { - return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), 'ERR_INVALID_KEY_NAME')) + return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), codes.ERR_INVALID_KEY_NAME)) } if (!peer || !peer.privKey) { - return throwDelayed(errcode(new Error('Peer.privKey is required'), 'ERR_MISSING_PRIVATE_KEY')) + return throwDelayed(errcode(new Error('Peer.privKey is required'), codes.ERR_MISSING_PRIVATE_KEY)) } const privateKey = peer.privKey const dsname = DsName(name) const exists = await self.store.has(dsname) - if (exists) return throwDelayed(errcode(new Error(`Key '${name}' already exists`), 'ERR_KEY_ALREADY_EXISTS')) + if (exists) return throwDelayed(errcode(new Error(`Key '${name}' already exists`), codes.ERR_KEY_ALREADY_EXISTS)) try { const kid = await privateKey.id() @@ -495,7 +496,7 @@ class Keychain { */ async _getPrivateKey (name) { if (!validateKeyName(name)) { - return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), 'ERR_INVALID_KEY_NAME')) + return throwDelayed(errcode(new Error(`Invalid key name '${name}'`), codes.ERR_INVALID_KEY_NAME)) } try { @@ -503,7 +504,7 @@ class Keychain { const res = await this.store.get(dsname) return uint8ArrayToString(res) } catch (/** @type {any} */ err) { - return throwDelayed(errcode(new Error(`Key '${name}' does not exist. ${err.message}`), 'ERR_KEY_NOT_FOUND')) + return throwDelayed(errcode(new Error(`Key '${name}' does not exist. ${err.message}`), codes.ERR_KEY_NOT_FOUND)) } } @@ -515,13 +516,13 @@ class Keychain { */ async rotateKeychainPass (oldPass, newPass) { if (typeof oldPass !== 'string') { - return throwDelayed(errcode(new Error(`Invalid old pass type '${typeof oldPass}'`), 'ERR_INVALID_OLD_PASS_TYPE')) + return throwDelayed(errcode(new Error(`Invalid old pass type '${typeof oldPass}'`), codes.ERR_INVALID_OLD_PASS_TYPE)) } if (typeof newPass !== 'string') { - return throwDelayed(errcode(new Error(`Invalid new pass type '${typeof newPass}'`), 'ERR_INVALID_NEW_PASS_TYPE')) + return throwDelayed(errcode(new Error(`Invalid new pass type '${typeof newPass}'`), codes.ERR_INVALID_NEW_PASS_TYPE)) } if (newPass.length < 20) { - return throwDelayed(errcode(new Error(`Invalid pass length ${newPass.length}`), 'ERR_INVALID_PASS_LENGTH')) + return throwDelayed(errcode(new Error(`Invalid pass length ${newPass.length}`), codes.ERR_INVALID_PASS_LENGTH)) } log('recreating keychain') const oldDek = privates.get(this).dek diff --git a/src/metrics/index.js b/src/metrics/index.js index 8d94861d81..5ea3f96af8 100644 --- a/src/metrics/index.js +++ b/src/metrics/index.js @@ -24,9 +24,6 @@ const directionToEvent = { */ /** - * @typedef MetricsProperties - * @property {import('../connection-manager')} connectionManager - * * @typedef MetricsOptions * @property {number} [computeThrottleMaxQueueSize = defaultOptions.computeThrottleMaxQueueSize] * @property {number} [computeThrottleTimeout = defaultOptions.computeThrottleTimeout] @@ -37,7 +34,7 @@ const directionToEvent = { class Metrics { /** * @class - * @param {MetricsProperties & MetricsOptions} options + * @param {MetricsOptions} options */ constructor (options) { this._options = mergeOptions(defaultOptions, options) @@ -47,10 +44,7 @@ class Metrics { this._oldPeers = oldPeerLRU(this._options.maxOldPeersRetention) this._running = false this._onMessage = this._onMessage.bind(this) - this._connectionManager = options.connectionManager - this._connectionManager.on('peer:disconnect', (connection) => { - this.onPeerDisconnected(connection.remotePeer) - }) + this._componentMetrics = new Map() } /** @@ -94,6 +88,22 @@ class Metrics { return Array.from(this._peerStats.keys()) } + /** + * @returns {Map} + */ + getComponentMetrics () { + return this._componentMetrics + } + + updateComponentMetric (component, metric, value) { + if (!this._componentMetrics.has(component)) { + this._componentMetrics.set(component, new Map()) + } + + const map = this._componentMetrics.get(component) + map.set(metric, value) + } + /** * Returns the `Stats` object for the given `PeerId` whether it * is a live peer, or in the disconnected peer LRU cache. diff --git a/src/metrics/stats.js b/src/metrics/stats.js index 267f3a2ed3..4246588f21 100644 --- a/src/metrics/stats.js +++ b/src/metrics/stats.js @@ -8,6 +8,7 @@ const retimer = require('retimer') /** * @typedef {import('@vascosantos/moving-average').IMovingAverage} IMovingAverage + * @typedef {import('bignumber.js').BigNumber} Big */ class Stats extends EventEmitter { diff --git a/src/metrics/tracked-map.js b/src/metrics/tracked-map.js new file mode 100644 index 0000000000..d37587a663 --- /dev/null +++ b/src/metrics/tracked-map.js @@ -0,0 +1,68 @@ +'use strict' + +/** + * @template K + * @template V + */ +class TrackedMap extends Map { + /** + * @param {string} component + * @param {string} name + * @param {import('.')} metrics + */ + constructor (component, name, metrics) { + super() + + this._component = component + this._name = name + this._metrics = metrics + + this._metrics.updateComponentMetric(this._component, this._name, this.size) + } + + /** + * @param {K} key + * @param {V} value + */ + set (key, value) { + super.set(key, value) + this._metrics.updateComponentMetric(this._component, this._name, this.size) + return this + } + + /** + * @param {K} key + */ + delete (key) { + const deleted = super.delete(key) + this._metrics.updateComponentMetric(this._component, this._name, this.size) + return deleted + } + + clear () { + super.clear() + + this._metrics.updateComponentMetric(this._component, this._name, this.size) + } +} + +/** + * @template K + * @template V + * @param {string} component + * @param {string} name + * @param {import('.')} [metrics] + * @returns {Map} + */ +module.exports = (component, name, metrics) => { + /** @type {Map} */ + let map + + if (metrics) { + map = new TrackedMap(component, name, metrics) + } else { + map = new Map() + } + + return map +} diff --git a/src/nat-manager.js b/src/nat-manager.js index 247401c7b8..cd8bf5aaf5 100644 --- a/src/nat-manager.js +++ b/src/nat-manager.js @@ -1,7 +1,7 @@ 'use strict' // @ts-ignore nat-api does not export types -const NatAPI = require('@motrix/nat-api') +const NatAPI = require('nat-api') const debug = require('debug') const { promisify } = require('es6-promisify') const { Multiaddr } = require('multiaddr') @@ -114,7 +114,7 @@ class NatManager { const client = this._getClient() const publicIp = this._externalIp || await client.externalIp() - // @ts-ignore isPrivate has no call signatures + // @ts-expect-error types are wrong if (isPrivateIp(publicIp)) { throw new Error(`${publicIp} is private - please set config.nat.externalIp to an externally routable IP or ensure you are not behind a double NAT`) } diff --git a/src/peer-routing.js b/src/peer-routing.js index bc22f8e4aa..fd6f99205b 100644 --- a/src/peer-routing.js +++ b/src/peer-routing.js @@ -5,11 +5,13 @@ const log = Object.assign(debug('libp2p:peer-routing'), { error: debug('libp2p:peer-routing:err') }) const errCode = require('err-code') +const errors = require('./errors') const { storeAddresses, uniquePeers, requirePeers } = require('./content-routing/utils') +const { TimeoutController } = require('timeout-abort-controller') const merge = require('it-merge') const { pipe } = require('it-pipe') @@ -21,6 +23,9 @@ const { clearDelayedInterval // @ts-ignore module with no types } = require('set-delayed-interval') +const { DHTPeerRouting } = require('./dht/dht-peer-routing') +// @ts-expect-error setMaxListeners is missing from the types +const { setMaxListeners } = require('events') /** * @typedef {import('peer-id')} PeerId @@ -33,6 +38,7 @@ const { * @property {boolean} [enabled = true] - Whether to enable the Refresh manager * @property {number} [bootDelay = 6e5] - Boot delay to start the Refresh Manager (in ms) * @property {number} [interval = 10e3] - Interval between each Refresh Manager run (in ms) + * @property {number} [timeout = 10e3] - How long to let each refresh run (in ms) * * @typedef {Object} PeerRoutingOptions * @property {RefreshManagerOptions} [refreshManager] @@ -51,7 +57,7 @@ class PeerRouting { // If we have the dht, add it to the available peer routers if (libp2p._dht && libp2p._config.dht.enabled) { - this._routers.push(libp2p._dht) + this._routers.push(new DHTPeerRouting(libp2p._dht)) } this._refreshManagerOptions = libp2p._options.peerRouting.refreshManager @@ -78,7 +84,7 @@ class PeerRouting { async _findClosestPeersTask () { try { // nb getClosestPeers adds the addresses to the address book - await drain(this.getClosestPeers(this._peerId.id)) + await drain(this.getClosestPeers(this._peerId.id, { timeout: this._refreshManagerOptions.timeout || 10e3 })) } catch (/** @type {any} */ err) { log.error(err) } @@ -101,19 +107,24 @@ class PeerRouting { */ async findPeer (id, options) { // eslint-disable-line require-await if (!this._routers.length) { - throw errCode(new Error('No peer routers available'), 'NO_ROUTERS_AVAILABLE') + throw errCode(new Error('No peer routers available'), errors.codes.ERR_NO_ROUTERS_AVAILABLE) } if (id.toB58String() === this._peerId.toB58String()) { - throw errCode(new Error('Should not try to find self'), 'ERR_FIND_SELF') + throw errCode(new Error('Should not try to find self'), errors.codes.ERR_FIND_SELF) } const output = await pipe( merge( - ...this._routers.map(router => [router.findPeer(id, options)]) + ...this._routers.map(router => (async function * () { + try { + yield await router.findPeer(id, options) + } catch (err) { + log.error(err) + } + })()) ), (source) => filter(source, Boolean), - // @ts-ignore findPeer resolves a Promise (source) => storeAddresses(source, this._peerStore), (source) => first(source) ) @@ -122,7 +133,7 @@ class PeerRouting { return output } - throw errCode(new Error('not found'), 'NOT_FOUND') + throw errCode(new Error(errors.messages.NOT_FOUND), errors.codes.ERR_NOT_FOUND) } /** @@ -130,12 +141,22 @@ class PeerRouting { * * @param {Uint8Array} key - A CID like key * @param {Object} [options] - * @param {number} [options.timeout=30e3] - How long the query can take. + * @param {number} [options.timeout=30e3] - How long the query can take + * @param {AbortSignal} [options.signal] - An AbortSignal to abort the request * @returns {AsyncIterable<{ id: PeerId, multiaddrs: Multiaddr[] }>} */ async * getClosestPeers (key, options = { timeout: 30e3 }) { if (!this._routers.length) { - throw errCode(new Error('No peer routers available'), 'NO_ROUTERS_AVAILABLE') + throw errCode(new Error('No peer routers available'), errors.codes.ERR_NO_ROUTERS_AVAILABLE) + } + + if (options.timeout) { + const controller = new TimeoutController(options.timeout) + // this controller will potentially be used while dialing lots of + // peers so prevent MaxListenersExceededWarning appearing in the console + setMaxListeners && setMaxListeners(Infinity, controller.signal) + + options.signal = controller.signal } yield * pipe( diff --git a/src/peer-store/book.js b/src/peer-store/book.js index 9b6d561b1e..3de0459486 100644 --- a/src/peer-store/book.js +++ b/src/peer-store/book.js @@ -2,10 +2,7 @@ const errcode = require('err-code') const PeerId = require('peer-id') - -const { - codes: { ERR_INVALID_PARAMETERS } -} = require('../errors') +const { codes } = require('../errors') /** * @param {any} data @@ -48,7 +45,7 @@ class Book { * @param {any[]|any} data */ set (peerId, data) { - throw errcode(new Error('set must be implemented by the subclass'), 'ERR_NOT_IMPLEMENTED') + throw errcode(new Error('set must be implemented by the subclass'), codes.ERR_NOT_IMPLEMENTED) } /** @@ -94,7 +91,7 @@ class Book { */ get (peerId) { if (!PeerId.isPeerId(peerId)) { - throw errcode(new Error('peerId must be an instance of peer-id'), ERR_INVALID_PARAMETERS) + throw errcode(new Error('peerId must be an instance of peer-id'), codes.ERR_INVALID_PARAMETERS) } const rec = this.data.get(peerId.toB58String()) @@ -111,7 +108,7 @@ class Book { */ delete (peerId) { if (!PeerId.isPeerId(peerId)) { - throw errcode(new Error('peerId must be an instance of peer-id'), ERR_INVALID_PARAMETERS) + throw errcode(new Error('peerId must be an instance of peer-id'), codes.ERR_INVALID_PARAMETERS) } if (!this.data.delete(peerId.toB58String())) { diff --git a/src/ping/index.js b/src/ping/index.js index 758c0ccabd..15b2692399 100644 --- a/src/ping/index.js +++ b/src/ping/index.js @@ -5,7 +5,7 @@ const log = Object.assign(debug('libp2p:ping'), { error: debug('libp2p:ping:err') }) const errCode = require('err-code') - +const { codes } = require('../errors') const crypto = require('libp2p-crypto') const { pipe } = require('it-pipe') // @ts-ignore it-buffer has no types exported @@ -50,7 +50,7 @@ async function ping (node, peer) { const end = Date.now() if (!equals(data, result)) { - throw errCode(new Error('Received wrong ping ack'), 'ERR_WRONG_PING_ACK') + throw errCode(new Error('Received wrong ping ack'), codes.ERR_WRONG_PING_ACK) } return end - start diff --git a/src/upgrader.js b/src/upgrader.js index 8b07be9731..23f9a338b9 100644 --- a/src/upgrader.js +++ b/src/upgrader.js @@ -297,7 +297,7 @@ class Upgrader { maConn.timeline.upgraded = Date.now() const errConnectionNotMultiplexed = () => { - throw errCode(new Error('connection is not multiplexed'), 'ERR_CONNECTION_NOT_MULTIPLEXED') + throw errCode(new Error('connection is not multiplexed'), codes.ERR_CONNECTION_NOT_MULTIPLEXED) } // Create the connection diff --git a/test/content-routing/content-routing.node.js b/test/content-routing/content-routing.node.js index 7206b19906..e35651e4c6 100644 --- a/test/content-routing/content-routing.node.js +++ b/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 diff --git a/test/content-routing/dht/configuration.node.js b/test/content-routing/dht/configuration.node.js index 9213d6e22d..ed22d3e9c6 100644 --- a/test/content-routing/dht/configuration.node.js +++ b/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) }) }) diff --git a/test/content-routing/dht/operation.node.js b/test/content-routing/dht/operation.node.js index c1cfbb13f4..646e843176 100644 --- a/test/content-routing/dht/operation.node.js +++ b/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) }) }) }) diff --git a/test/content-routing/dht/utils.js b/test/content-routing/dht/utils.js index c879f8d068..0a37de41ae 100644 --- a/test/content-routing/dht/utils.js +++ b/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' +] diff --git a/test/content-routing/utils.js b/test/content-routing/utils.js index 120f7281df..7b43d05046 100644 --- a/test/content-routing/utils.js +++ b/test/content-routing/utils.js @@ -13,9 +13,6 @@ const routingOptions = mergeOptions(baseOptions, { config: { dht: { kBucketSize: 20, - randomWalk: { - enabled: true - }, enabled: true } } diff --git a/test/keychain/keychain.spec.js b/test/keychain/keychain.spec.js index 0404ebf03e..070a233da4 100644 --- a/test/keychain/keychain.spec.js +++ b/test/keychain/keychain.spec.js @@ -296,7 +296,7 @@ describe('keychain', () => { it('requires plain data as a Uint8Array', async () => { const err = await ks.cms.encrypt(rsaKeyName, 'plain data').then(fail, err => err) expect(err).to.exist() - expect(err).to.have.property('code', 'ERR_INVALID_PARAMS') + expect(err).to.have.property('code', 'ERR_INVALID_PARAMETERS') }) it('encrypts', async () => { @@ -308,7 +308,7 @@ describe('keychain', () => { it('is a PKCS #7 message', async () => { const err = await ks.cms.decrypt('not CMS').then(fail, err => err) expect(err).to.exist() - expect(err).to.have.property('code', 'ERR_INVALID_PARAMS') + expect(err).to.have.property('code', 'ERR_INVALID_PARAMETERS') }) it('is a PKCS #7 binary message', async () => { diff --git a/test/metrics/index.spec.js b/test/metrics/index.spec.js index 5f401e8ac6..ed17c57ef8 100644 --- a/test/metrics/index.spec.js +++ b/test/metrics/index.spec.js @@ -3,9 +3,6 @@ const { expect } = require('aegir/utils/chai') const sinon = require('sinon') - -const { EventEmitter } = require('events') - const { randomBytes } = require('libp2p-crypto') const duplexPair = require('it-pair/duplex') const pipe = require('it-pipe') @@ -34,8 +31,7 @@ describe('Metrics', () => { const [local, remote] = duplexPair() const metrics = new Metrics({ computeThrottleMaxQueueSize: 1, // compute after every message - movingAverageIntervals: [10, 100, 1000], - connectionManager: new EventEmitter() + movingAverageIntervals: [10, 100, 1000] }) metrics.trackStream({ @@ -70,8 +66,7 @@ describe('Metrics', () => { const [local, remote] = duplexPair() const metrics = new Metrics({ computeThrottleMaxQueueSize: 1, // compute after every message - movingAverageIntervals: [10, 100, 1000], - connectionManager: new EventEmitter() + movingAverageIntervals: [10, 100, 1000] }) metrics.trackStream({ @@ -119,8 +114,7 @@ describe('Metrics', () => { const [local2, remote2] = duplexPair() const metrics = new Metrics({ computeThrottleMaxQueueSize: 1, // compute after every message - movingAverageIntervals: [10, 100, 1000], - connectionManager: new EventEmitter() + movingAverageIntervals: [10, 100, 1000] }) const protocol = '/echo/1.0.0' metrics.start() @@ -175,8 +169,7 @@ describe('Metrics', () => { const [local, remote] = duplexPair() const metrics = new Metrics({ computeThrottleMaxQueueSize: 1, // compute after every message - movingAverageIntervals: [10, 100, 1000], - connectionManager: new EventEmitter() + movingAverageIntervals: [10, 100, 1000] }) metrics.start() @@ -231,8 +224,7 @@ describe('Metrics', () => { })) const metrics = new Metrics({ - maxOldPeersRetention: 5, // Only keep track of 5 - connectionManager: new EventEmitter() + maxOldPeersRetention: 5 // Only keep track of 5 }) // Clone so trackedPeers isn't modified @@ -262,4 +254,22 @@ describe('Metrics', () => { expect(spy).to.have.property('callCount', 1) } }) + + it('should allow components to track metrics', () => { + const metrics = new Metrics({ + maxOldPeersRetention: 5 // Only keep track of 5 + }) + + expect(metrics.getComponentMetrics()).to.be.empty() + + const component = 'my-component' + const metric = 'some-metric' + const value = 1 + + metrics.updateComponentMetric(component, metric, value) + + expect(metrics.getComponentMetrics()).to.have.lengthOf(1) + expect(metrics.getComponentMetrics().get(component)).to.have.lengthOf(1) + expect(metrics.getComponentMetrics().get(component).get(metric)).to.equal(value) + }) }) diff --git a/test/nat-manager/nat-manager.node.js b/test/nat-manager/nat-manager.node.js index 5f5562e0b0..9dcf2b574e 100644 --- a/test/nat-manager/nat-manager.node.js +++ b/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 { diff --git a/test/peer-discovery/index.node.js b/test/peer-discovery/index.node.js index c7db964603..bdf4587960 100644 --- a/test/peer-discovery/index.node.js +++ b/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)) diff --git a/test/peer-routing/peer-routing.node.js b/test/peer-routing/peer-routing.node.js index fd76ee792d..4c008a1c03 100644 --- a/test/peer-routing/peer-routing.node.js +++ b/test/peer-routing/peer-routing.node.js @@ -36,7 +36,7 @@ describe('peer-routing', () => { it('.findPeer should return an error', async () => { await expect(node.peerRouting.findPeer('a cid')) .to.eventually.be.rejected() - .and.to.have.property('code', 'NO_ROUTERS_AVAILABLE') + .and.to.have.property('code', 'ERR_NO_ROUTERS_AVAILABLE') }) it('.getClosestPeers should return an error', async () => { @@ -45,7 +45,7 @@ describe('peer-routing', () => { throw new Error('.getClosestPeers 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') } }) }) @@ -72,33 +72,38 @@ describe('peer-routing', () => { after(() => Promise.all(nodes.map((n) => n.stop()))) - it('should use the nodes dht', () => { - const deferred = pDefer() - - sinon.stub(nodes[0]._dht, 'findPeer').callsFake(() => { - deferred.resolve() - return nodes[1].peerId + it('should use the nodes dht', async () => { + sinon.stub(nodes[0]._dht, 'findPeer').callsFake(async function * () { + yield { + name: 'FINAL_PEER', + peer: { + id: nodes[1].peerId, + multiaddrs: [] + } + } }) - nodes[0].peerRouting.findPeer() - return deferred.promise + expect(nodes[0]._dht.findPeer.called).to.be.false() + await nodes[0].peerRouting.findPeer(nodes[1].peerId) + expect(nodes[0]._dht.findPeer.called).to.be.true() + nodes[0]._dht.findPeer.restore() }) it('should use the nodes dht to get the closest peers', async () => { - const deferred = pDefer() - const [remotePeerId] = await peerUtils.createPeerId({ fixture: false }) - - sinon.stub(nodes[0]._dht, 'getClosestPeers').callsFake(function * () { - deferred.resolve() + sinon.stub(nodes[0]._dht, 'getClosestPeers').callsFake(async function * () { yield { - id: remotePeerId, - multiaddrs: [] + name: 'PEER_RESPONSE', + closer: [{ + id: nodes[1].peerId, + multiaddrs: [] + }] } }) - await nodes[0].peerRouting.getClosestPeers().next() - - return deferred.promise + expect(nodes[0]._dht.getClosestPeers.called).to.be.false() + await drain(nodes[0].peerRouting.getClosestPeers(nodes[1].peerId)) + expect(nodes[0]._dht.getClosestPeers.called).to.be.true() + nodes[0]._dht.getClosestPeers.restore() }) it('should error when peer tries to find itself', async () => { @@ -106,6 +111,95 @@ describe('peer-routing', () => { .to.eventually.be.rejected() .and.to.have.property('code', 'ERR_FIND_SELF') }) + + it('should handle error thrown synchronously during find peer', async () => { + const unknownPeers = await peerUtils.createPeerId({ number: 1, fixture: false }) + + nodes[0].peerRouting._routers = [{ + findPeer () { + throw new Error('Thrown sync') + } + }] + + await expect(nodes[0].peerRouting.findPeer(unknownPeers[0])) + .to.eventually.be.rejected() + .and.to.have.property('code', 'ERR_NOT_FOUND') + }) + + it('should handle error thrown asynchronously during find peer', async () => { + const unknownPeers = await peerUtils.createPeerId({ number: 1, fixture: false }) + + nodes[0].peerRouting._routers = [{ + async findPeer () { + throw new Error('Thrown async') + } + }] + + await expect(nodes[0].peerRouting.findPeer(unknownPeers[0])) + .to.eventually.be.rejected() + .and.to.have.property('code', 'ERR_NOT_FOUND') + }) + + it('should handle error thrown asynchronously after delay during find peer', async () => { + const unknownPeers = await peerUtils.createPeerId({ number: 1, fixture: false }) + + nodes[0].peerRouting._routers = [{ + async findPeer () { + await delay(100) + throw new Error('Thrown async after delay') + } + }] + + await expect(nodes[0].peerRouting.findPeer(unknownPeers[0])) + .to.eventually.be.rejected() + .and.to.have.property('code', 'ERR_NOT_FOUND') + }) + + it('should return value when one router errors synchronously and another returns a value', async () => { + const [peer] = await peerUtils.createPeerId({ number: 1, fixture: false }) + + nodes[0].peerRouting._routers = [{ + findPeer () { + throw new Error('Thrown sync') + } + }, { + async findPeer () { + return Promise.resolve({ + id: peer, + multiaddrs: [] + }) + } + }] + + await expect(nodes[0].peerRouting.findPeer(peer)) + .to.eventually.deep.equal({ + id: peer, + multiaddrs: [] + }) + }) + + it('should return value when one router errors asynchronously and another returns a value', async () => { + const [peer] = await peerUtils.createPeerId({ number: 1, fixture: false }) + + nodes[0].peerRouting._routers = [{ + async findPeer () { + throw new Error('Thrown sync') + } + }, { + async findPeer () { + return Promise.resolve({ + id: peer, + multiaddrs: [] + }) + } + }] + + await expect(nodes[0].peerRouting.findPeer(peer)) + .to.eventually.deep.equal({ + id: peer, + multiaddrs: [] + }) + }) }) describe('via delegate router', () => { @@ -145,36 +239,35 @@ describe('peer-routing', () => { }) it('should use the delegate router to find peers', async () => { - const deferred = pDefer() const [remotePeerId] = await peerUtils.createPeerId({ fixture: false }) sinon.stub(delegate, 'findPeer').callsFake(() => { - deferred.resolve() return { id: remotePeerId, multiaddrs: [] } }) - await node.peerRouting.findPeer() - return deferred.promise + expect(delegate.findPeer.called).to.be.false() + await node.peerRouting.findPeer(remotePeerId) + expect(delegate.findPeer.called).to.be.true() + delegate.findPeer.restore() }) it('should use the delegate router to get the closest peers', async () => { - const deferred = pDefer() const [remotePeerId] = await peerUtils.createPeerId({ fixture: false }) sinon.stub(delegate, 'getClosestPeers').callsFake(function * () { - deferred.resolve() yield { id: remotePeerId, multiaddrs: [] } }) - await node.peerRouting.getClosestPeers().next() - - return deferred.promise + expect(delegate.getClosestPeers.called).to.be.false() + await drain(node.peerRouting.getClosestPeers(remotePeerId)) + expect(delegate.getClosestPeers.called).to.be.true() + delegate.getClosestPeers.restore() }) it('should be able to find a peer', async () => { @@ -200,7 +293,7 @@ describe('peer-routing', () => { }) it('should error when a peer cannot be found', async () => { - const peerKey = 'key of a peer not on the network' + const peerId = await PeerId.create({ keyType: 'ed25519' }) const mockApi = nock('http://0.0.0.0:60197') .post('/api/v0/dht/findpeer') .query(true) @@ -209,20 +302,20 @@ describe('peer-routing', () => { 'X-Chunked-Output', '1' ]) - await expect(node.peerRouting.findPeer(peerKey)) + await expect(node.peerRouting.findPeer(peerId)) .to.eventually.be.rejected() expect(mockApi.isDone()).to.equal(true) }) it('should handle errors from the api', async () => { - const peerKey = 'key of a peer not on the network' + const peerId = await PeerId.create({ keyType: 'ed25519' }) const mockApi = nock('http://0.0.0.0:60197') .post('/api/v0/dht/findpeer') .query(true) .reply(502) - await expect(node.peerRouting.findPeer(peerKey)) + await expect(node.peerRouting.findPeer(peerId)) .to.eventually.be.rejected() expect(mockApi.isDone()).to.equal(true) @@ -230,7 +323,6 @@ describe('peer-routing', () => { it('should be able to get the closest peers', async () => { const peerId = await PeerId.create({ keyType: 'ed25519' }) - const closest1 = '12D3KooWLewYMMdGWAtuX852n4rgCWkK7EBn4CWbwwBzhsVoKxk3' const closest2 = '12D3KooWDtoQbpKhtnWddfj72QmpFvvLDTsBLTFkjvgQm6cde2AK' @@ -249,15 +341,12 @@ describe('peer-routing', () => { 'X-Chunked-Output', '1' ]) - const closestPeers = [] - for await (const peer of node.peerRouting.getClosestPeers(peerId.id, { timeout: 1000 })) { - closestPeers.push(peer) - } + const closestPeers = await all(node.peerRouting.getClosestPeers(peerId.id, { timeout: 1000 })) expect(closestPeers).to.have.length(2) - expect(closestPeers[0].id.toB58String()).to.equal(closest2) + expect(closestPeers[0].id.toB58String()).to.equal(closest1) expect(closestPeers[0].multiaddrs).to.have.lengthOf(2) - expect(closestPeers[1].id.toB58String()).to.equal(closest1) + expect(closestPeers[1].id.toB58String()).to.equal(closest2) expect(closestPeers[1].multiaddrs).to.have.lengthOf(2) expect(mockApi.isDone()).to.equal(true) }) @@ -316,7 +405,7 @@ describe('peer-routing', () => { multiaddrs: [] } - sinon.stub(node._dht, 'findPeer').callsFake(() => {}) + sinon.stub(node._dht, 'findPeer').callsFake(async function * () {}) sinon.stub(delegate, 'findPeer').callsFake(() => { return results }) @@ -334,7 +423,8 @@ describe('peer-routing', () => { const defer = pDefer() - sinon.stub(node._dht, 'findPeer').callsFake(async () => { + sinon.stub(node._dht, 'findPeer').callsFake(async function * () { + yield await defer.promise }) sinon.stub(delegate, 'findPeer').callsFake(() => { @@ -349,29 +439,32 @@ describe('peer-routing', () => { it('should not wait for the delegate to return if the dht does first', async () => { const [remotePeerId] = await peerUtils.createPeerId({ fixture: false }) - const results = { + const result = { id: remotePeerId, multiaddrs: [] } const defer = pDefer() - sinon.stub(node._dht, 'findPeer').callsFake(() => { - return results + sinon.stub(node._dht, 'findPeer').callsFake(async function * () { + yield { + name: 'FINAL_PEER', + peer: result + } }) sinon.stub(delegate, 'findPeer').callsFake(async () => { await defer.promise }) const peer = await node.peerRouting.findPeer(remotePeerId) - expect(peer).to.eql(results) + expect(peer).to.eql(result) defer.resolve() }) it('should store the addresses of the found peer', async () => { const [remotePeerId] = await peerUtils.createPeerId({ fixture: false }) - const results = { + const result = { id: remotePeerId, multiaddrs: [ new Multiaddr('/ip4/123.123.123.123/tcp/38982') @@ -380,14 +473,17 @@ describe('peer-routing', () => { const spy = sinon.spy(node.peerStore.addressBook, 'add') - sinon.stub(node._dht, 'findPeer').callsFake(() => { - return results + sinon.stub(node._dht, 'findPeer').callsFake(async function * () { + yield { + name: 'FINAL_PEER', + peer: result + } }) sinon.stub(delegate, 'findPeer').callsFake(() => {}) await node.peerRouting.findPeer(remotePeerId) - expect(spy.calledWith(results.id, results.multiaddrs)).to.be.true() + expect(spy.calledWith(result.id, result.multiaddrs)).to.be.true() }) it('should use the delegate if the dht fails to get the closest peer', async () => { @@ -487,8 +583,18 @@ describe('peer-routing', () => { sinon.spy(node.peerStore.addressBook, 'add') sinon.stub(node._dht, 'getClosestPeers').callsFake(function * () { - yield results[0] - yield results[1] + yield { + name: 'PEER_RESPONSE', + closer: [ + results[0] + ] + } + yield { + name: 'PEER_RESPONSE', + closer: [ + results[1] + ] + } }) await node.start() @@ -522,7 +628,7 @@ describe('peer-routing', () => { started: false }) - sinon.stub(node._dht, 'getClosestPeers').callsFake(function * () { + sinon.stub(node._dht, 'getClosestPeers').callsFake(async function * () { yield throw new Error('should not be called') }) diff --git a/test/peer-routing/utils.js b/test/peer-routing/utils.js index 120f7281df..7b43d05046 100644 --- a/test/peer-routing/utils.js +++ b/test/peer-routing/utils.js @@ -13,9 +13,6 @@ const routingOptions = mergeOptions(baseOptions, { config: { dht: { kBucketSize: 20, - randomWalk: { - enabled: true - }, enabled: true } } diff --git a/test/transports/transport-manager.node.js b/test/transports/transport-manager.node.js index 13854ce031..49876a0554 100644 --- a/test/transports/transport-manager.node.js +++ b/test/transports/transport-manager.node.js @@ -13,6 +13,7 @@ const { Multiaddr } = require('multiaddr') const mockUpgrader = require('../utils/mockUpgrader') const sinon = require('sinon') const Peers = require('../fixtures/peers') +const pWaitFor = require('p-wait-for') const addrs = [ new Multiaddr('/ip4/127.0.0.1/tcp/0'), new Multiaddr('/ip4/127.0.0.1/tcp/0') @@ -72,9 +73,13 @@ describe('Transport Manager (TCP)', () => { tm.add(Transport.prototype[Symbol.toStringTag], Transport) await tm.listen(addrs) - // Should created Self Peer record on new listen address - signedPeerRecord = await tm.libp2p.peerStore.addressBook.getPeerRecord(localPeer) - expect(signedPeerRecord).to.exist() + // Should created Self Peer record on new listen address, but it is done async + // with no event so we have to wait a bit + await pWaitFor(async () => { + signedPeerRecord = await tm.libp2p.peerStore.addressBook.getPeerRecord(localPeer) + + return signedPeerRecord != null + }, { interval: 100, timeout: 2000 }) const record = PeerRecord.createFromProtobuf(signedPeerRecord.payload) expect(record).to.exist() diff --git a/test/ts-use/package.json b/test/ts-use/package.json index 6445e42fb1..ac98a7b4e3 100644 --- a/test/ts-use/package.json +++ b/test/ts-use/package.json @@ -7,16 +7,16 @@ "libp2p": "file:../..", "libp2p-bootstrap": "^0.13.0", "libp2p-delegated-content-routing": "^0.11.0", - "libp2p-delegated-peer-routing": "^0.10.0", + "libp2p-delegated-peer-routing": "^0.11.1", "libp2p-gossipsub": "^0.9.0", "libp2p-interfaces": "^1.0.1", - "libp2p-kad-dht": "^0.23.1", + "libp2p-kad-dht": "^0.26.5", "libp2p-mplex": "^0.10.4", "@chainsafe/libp2p-noise": "^4.1.0", "libp2p-record": "^0.10.4", "libp2p-tcp": "^0.17.1", "libp2p-websockets": "^0.16.1", - "peer-id": "^0.15.0" + "peer-id": "^0.16.0" }, "scripts": { "build": "npx tsc", diff --git a/test/ts-use/src/main.ts b/test/ts-use/src/main.ts index d75a79f4ba..17c5e4d681 100644 --- a/test/ts-use/src/main.ts +++ b/test/ts-use/src/main.ts @@ -123,11 +123,6 @@ async function main() { dht: { enabled: true, kBucketSize: 20, - randomWalk: { - enabled: true, // Allows to disable discovery (enabled by default) - interval: 300e3, - timeout: 10e3 - }, clientMode: true, validators: { pk: Libp2pRecord.validator.validators.pk diff --git a/tsconfig.json b/tsconfig.json index d9083a6a34..47b635e4af 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,5 +1,5 @@ { - "extends": "./node_modules/aegir/src/config/tsconfig.aegir.json", + "extends": "aegir/src/config/tsconfig.aegir.json", "compilerOptions": { "outDir": "dist" },