chore: fix circular import (#371)

There is a circular import going on and it makes ipjs fail.

Author: achingbrain

.aegir.cjs

@@ -11,6 +11,9 @@ const esbuild = {
         build.onResolve({ filter: /^stream$/ }, () => {
           return { path: require.resolve('readable-stream') }
         })
+        build.onResolve({ filter: /^.*create-libp2p-node\.js$/ }, (args) => {
+          return { path: require.resolve('./scripts/false.js') }
+        })
       }
     }
   ]
@@ -28,5 +31,8 @@ module.exports = {
   build: {
     bundlesizeMax: '44KB',
     config: esbuild
+  },
+  ts: {
+    copyTo: './dist/types'
   }
 }

.github/workflows/main.yml

@@ -19,7 +19,7 @@ jobs:
   test-node:
     needs: check
     runs-on: ${{ matrix.os }}
-    name: Test ${{ matrix.project }} node
+    name: test node ${{ matrix.node }}
     strategy:
       matrix:
         os: [windows-latest, ubuntu-latest, macos-latest]
@@ -31,7 +31,7 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
       - run: npm install
-      - run: npm run test --cov -t node -- --exit
+      - run: npm run test -- -t node
   test-browser:
     needs: check
     runs-on: ubuntu-latest
@@ -52,22 +52,22 @@ jobs:
           node-version: 16
       - run: npm install
       - run: npm run test -- -t ${{ matrix.type }} -- --browser ${{ matrix.browser }}
-   test-electron:
-     needs: check
-     runs-on: ubuntu-latest
-     name: test ${{ matrix.type }}
-     strategy:
-       matrix:
-         type:
-           - electron-main
-           - electron-renderer
-       fail-fast: true
-     steps:
-       - uses: actions/checkout@v2
-       - uses: actions/setup-node@v1
-         with:
-           node-version: 16
-       - run: npm install
-       - uses: GabrielBB/xvfb-action@v1
-         with:
-           run: npm run test -- -t ${{ matrix.type }} --bail --exit
+  test-electron:
+    needs: check
+    runs-on: ubuntu-latest
+    name: test ${{ matrix.type }}
+    strategy:
+      matrix:
+        type:
+          - electron-main
+          - electron-renderer
+      fail-fast: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - run: npm install
+      - uses: GabrielBB/xvfb-action@v1
+        with:
+          run: npm run test -- -t ${{ matrix.type }} --bail -f dist/cjs/node-test/node.js

package.json

@@ -10,6 +10,11 @@
     "*",
     "!**/*.tsbuildinfo"
   ],
+  "exports": {
+    ".": {
+      "import": "./src/index.js"
+    }
+  },
   "eslintConfig": {
     "extends": "ipfs",
     "parserOptions": {
@@ -21,32 +26,18 @@
       "*.test-d.ts"
     ]
   },
-  "browser": {
-    "./test/utils/create-libp2p-node": false
-  },
-  "typesVersions": {
-    "*": {
-      "src/*": [
-        "dist/src/*",
-        "dist/src/*/index"
-      ],
-      "src/": [
-        "dist/src/index"
-      ]
-    }
-  },
   "scripts": {
     "generate": "run-s generate:*",
     "generate:proto": "pbjs -t static-module -w es6 -r ipfs-bitswap --force-number --no-verify --no-delimited --no-create --no-beautify --no-defaults --lint eslint-disable -o src/types/message/message.js src/types/message/message.proto",
     "generate:proto-types": "pbts -o src/types/message/message.d.ts src/types/message/message.js",
     "build": "aegir build",
     "clean": "rimraf dist types",
     "lint": "aegir ts -p check && aegir lint",
-    "release": "aegir release --target node",
-    "release-minor": "aegir release --type minor --target node",
-    "release-major": "aegir release --type major --target node",
+    "release": "aegir release",
+    "release-minor": "aegir release --type minor",
+    "release-major": "aegir release --type major",
     "pretest": "aegir build --esm-tests",
-    "test": "aegir test --target node -- --exit",
+    "test": "aegir test",
     "dep-check": "aegir dep-check -i rimraf",
     "bench": "node benchmarks/index",
     "benchmarks": "node test/benchmarks/get-many"

scripts/false.js

@@ -0,0 +1,3 @@
+
+export const Node = false
+export const createLibp2pNode = false

src/types/message/message.d.ts

@@ -1,4 +1,4 @@
-import * as $protobuf from "protobufjs";
+import $protobuf from "protobufjs/minimal.js";
 /** Properties of a Message. */
 export interface IMessage {
 

src/types/wantlist/index.js

@@ -1,7 +1,12 @@
 
 import { WantListEntry as Entry } from './entry.js'
 import { base58btc } from 'multiformats/bases/base58'
-import { BitswapMessage as Message } from '../message/index.js'
+import { Message } from '../message/message.js'
+
+const WantType = {
+  Block: Message.Wantlist.WantType.Block,
+  Have: Message.Wantlist.WantType.Have
+}
 
 /**
  * @template T
@@ -50,7 +55,7 @@ export class Wantlist {
       entry.priority = priority
 
       // We can only overwrite want-have with want-block
-      if (entry.wantType === Message.WantType.Have && wantType === Message.WantType.Block) {
+      if (entry.wantType === WantType.Have && wantType === WantType.Block) {
         entry.wantType = wantType
       }
     } else {

test/bitswap-stats.js

@@ -87,7 +87,7 @@ describe('bitswap stats', () => {
 
     expectedStats.forEach((key) => {
       expect(snapshot).to.have.property(key)
-      expect(snapshot[key]).to.equal(0n)
+      expect(snapshot[key]).to.equal(BigInt(0))
     })
 
     const movingAverages = stats.movingAverages
@@ -104,15 +104,15 @@ describe('bitswap stats', () => {
 
   it('updates blocks received', (done) => {
     bs.stat().once('update', (stats) => {
-      expect(stats.blocksReceived).to.equal(2n)
-      expect(stats.dataReceived).to.equal(96n)
-      expect(stats.dupBlksReceived).to.equal(0n)
-      expect(stats.dupDataReceived).to.equal(0n)
-      expect(stats.blocksSent).to.equal(0n)
-      expect(stats.dataSent).to.equal(0n)
-      expect(stats.providesBufferLength).to.equal(0n)
-      expect(stats.wantListLength).to.equal(0n)
-      expect(stats.peerCount).to.equal(1n)
+      expect(stats.blocksReceived).to.equal(BigInt(2))
+      expect(stats.dataReceived).to.equal(BigInt(96))
+      expect(stats.dupBlksReceived).to.equal(BigInt(0))
+      expect(stats.dupDataReceived).to.equal(BigInt(0))
+      expect(stats.blocksSent).to.equal(BigInt(0))
+      expect(stats.dataSent).to.equal(BigInt(0))
+      expect(stats.providesBufferLength).to.equal(BigInt(0))
+      expect(stats.wantListLength).to.equal(BigInt(0))
+      expect(stats.peerCount).to.equal(BigInt(1))
 
       // test moving averages
       const movingAverages = bs.stat().movingAverages
@@ -144,13 +144,13 @@ describe('bitswap stats', () => {
 
   it('updates duplicate blocks counters', (done) => {
     bs.stat().once('update', (stats) => {
-      expect(stats.blocksReceived).to.equal(4n)
-      expect(stats.dataReceived).to.equal(192n)
-      expect(stats.dupBlksReceived).to.equal(2n)
-      expect(stats.dupDataReceived).to.equal(96n)
-      expect(stats.blocksSent).to.equal(0n)
-      expect(stats.dataSent).to.equal(0n)
-      expect(stats.providesBufferLength).to.equal(0n)
+      expect(stats.blocksReceived).to.equal(BigInt(4))
+      expect(stats.dataReceived).to.equal(BigInt(192))
+      expect(stats.dupBlksReceived).to.equal(BigInt(2))
+      expect(stats.dupDataReceived).to.equal(BigInt(96))
+      expect(stats.blocksSent).to.equal(BigInt(0))
+      expect(stats.dataSent).to.equal(BigInt(0))
+      expect(stats.providesBufferLength).to.equal(BigInt(0))
       done()
     })
 
@@ -187,15 +187,15 @@ describe('bitswap stats', () => {
     it('updates stats on transfer', async () => {
       const originalStats = bs.stat().snapshot
 
-      expect(originalStats.blocksReceived).to.equal(4n)
-      expect(originalStats.dataReceived).to.equal(192n)
-      expect(originalStats.dupBlksReceived).to.equal(2n)
-      expect(originalStats.dupDataReceived).to.equal(96n)
-      expect(originalStats.blocksSent).to.equal(0n)
-      expect(originalStats.dataSent).to.equal(0n)
-      expect(originalStats.providesBufferLength).to.equal(0n)
-      expect(originalStats.wantListLength).to.equal(0n)
-      expect(originalStats.peerCount).to.equal(1n)
+      expect(originalStats.blocksReceived).to.equal(BigInt(4))
+      expect(originalStats.dataReceived).to.equal(BigInt(192))
+      expect(originalStats.dupBlksReceived).to.equal(BigInt(2))
+      expect(originalStats.dupDataReceived).to.equal(BigInt(96))
+      expect(originalStats.blocksSent).to.equal(BigInt(0))
+      expect(originalStats.dataSent).to.equal(BigInt(0))
+      expect(originalStats.providesBufferLength).to.equal(BigInt(0))
+      expect(originalStats.wantListLength).to.equal(BigInt(0))
+      expect(originalStats.peerCount).to.equal(BigInt(1))
 
       const deferred = pEvent(bs.stat(), 'update')
 
@@ -204,15 +204,15 @@ describe('bitswap stats', () => {
 
       const nextStats = await deferred
 
-      expect(nextStats.blocksReceived).to.equal(4n)
-      expect(nextStats.dataReceived).to.equal(192n)
-      expect(nextStats.dupBlksReceived).to.equal(2n)
-      expect(nextStats.dupDataReceived).to.equal(96n)
-      expect(nextStats.blocksSent).to.equal(1n)
-      expect(nextStats.dataSent).to.equal(48n)
-      expect(nextStats.providesBufferLength).to.equal(0n)
-      expect(nextStats.wantListLength).to.equal(0n)
-      expect(nextStats.peerCount).to.equal(2n)
+      expect(nextStats.blocksReceived).to.equal(BigInt(4))
+      expect(nextStats.dataReceived).to.equal(BigInt(192))
+      expect(nextStats.dupBlksReceived).to.equal(BigInt(2))
+      expect(nextStats.dupDataReceived).to.equal(BigInt(96))
+      expect(nextStats.blocksSent).to.equal(BigInt(1))
+      expect(nextStats.dataSent).to.equal(BigInt(48))
+      expect(nextStats.providesBufferLength).to.equal(BigInt(0))
+      expect(nextStats.wantListLength).to.equal(BigInt(0))
+      expect(nextStats.peerCount).to.equal(BigInt(2))
     })
 
     it('has peer stats', async () => {
@@ -229,15 +229,15 @@ describe('bitswap stats', () => {
 
       const stats = await pEvent(peerStats, 'update')
 
-      expect(stats.blocksReceived).to.equal(1n)
-      expect(stats.dataReceived).to.equal(49n)
-      expect(stats.dupBlksReceived).to.equal(0n)
-      expect(stats.dupDataReceived).to.equal(0n)
-      expect(stats.blocksSent).to.equal(0n)
-      expect(stats.dataSent).to.equal(0n)
-      expect(stats.providesBufferLength).to.equal(0n)
-      expect(stats.wantListLength).to.equal(0n)
-      expect(stats.peerCount).to.equal(1n)
+      expect(stats.blocksReceived).to.equal(BigInt(1))
+      expect(stats.dataReceived).to.equal(BigInt(49))
+      expect(stats.dupBlksReceived).to.equal(BigInt(0))
+      expect(stats.dupDataReceived).to.equal(BigInt(0))
+      expect(stats.blocksSent).to.equal(BigInt(0))
+      expect(stats.dataSent).to.equal(BigInt(0))
+      expect(stats.providesBufferLength).to.equal(BigInt(0))
+      expect(stats.wantListLength).to.equal(BigInt(0))
+      expect(stats.peerCount).to.equal(BigInt(1))
 
       const ma = peerStats.movingAverages.dataReceived[60000]
       expect(ma.movingAverage()).to.be.above(0)

test/utils/make-blocks.js

@@ -1,6 +1,6 @@
 import { CID } from 'multiformats/cid'
 import { sha256 } from 'multiformats/hashes/sha2'
-import { randomBytes} from 'iso-random-stream'
+import { randomBytes } from 'iso-random-stream'
 // @ts-ignore
 import range from 'lodash.range'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'