feat: add bitswap.unwant javascript spec

Author: wraithgar

SPEC/BITSWAP.md

@@ -4,7 +4,20 @@
 * [bitswap.unwant](#bitswapunwant)
 * [bitswap.stat](#bitswapstat)
 
-#### `bitswap.wantlist`
+#### `unwant`
+
+> Removes a given block from your wantlist
+
+##### `Go` **WIP**
+
+##### `JavaScript` - ipfs.bitswap.unwant(cid)
+
+`cid` is a [cid][cid] which can be passed as:
+
+- CID, a CID instance
+- String, the base58 encoded version of the multihash
+
+### `bitswap.wantlist`
 
 (not spec'ed yet)
 

js/src/bitswap.js

@@ -0,0 +1,119 @@
+'use strict'
+
+const chai = require('chai')
+const dirtyChai = require('dirty-chai')
+const expect = chai.expect
+const statsTests = require('./utils/stats')
+chai.use(dirtyChai)
+const CID = require('cids')
+
+module.exports = (common) => {
+  describe('.bitswap online', () => {
+    let ipfs
+    let withGo
+    const key = 'QmUBdnXXPyoDFXj3Hj39dNJ5VkN3QFRskXxcGaYFBB8CNR'
+
+    before(function (done) {
+      // CI takes longer to instantiate the daemon, so we need to increase the
+      // timeout for the before step
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+        factory.spawnNode((err, node) => {
+          expect(err).to.not.exist()
+          ipfs = node
+          ipfs.block.get(key)
+            .then(() => {})
+            .catch(() => {})
+          ipfs.id((err, id) => {
+            expect(err).to.not.exist()
+            withGo = id.agentVersion.startsWith('go-ipfs')
+            setTimeout(done, 250) //Give block.get time to take effect
+          })
+        })
+      })
+    })
+
+    after((done) => common.teardown(done))
+
+    it('.stat', (done) => {
+
+      ipfs.bitswap.stat((err, stats) => {
+        statsTests.expectIsBitswap(err, stats)
+        done()
+      })
+    })
+
+    it('.wantlist', (done) => {
+      ipfs.bitswap.wantlist((err, list) => {
+        expect(err).to.not.exist()
+        expect(list.Keys).to.have.length(1);
+        expect(list.Keys[0]['/']).to.equal(key)
+        done()
+      })
+    })
+
+    it('.unwant', function (done) {
+      if (withGo) {
+        this.skip()
+      }
+      ipfs.bitswap.unwant(key, (err) => {
+        expect(err).to.not.exist();
+        ipfs.bitswap.wantlist((err, list) => {
+          expect(err).to.not.exist();
+          expect(list.Keys).to.be.empty()
+          done()
+        })
+      })
+    })
+  })
+
+  describe('.bitswap offline', () => {
+    let ipfs
+
+    before(function (done) {
+      // CI takes longer to instantiate the daemon, so we need to increase the
+      // timeout for the before step
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+        factory.spawnNode((err, node) => {
+          expect(err).to.not.exist()
+          ipfs = node
+          ipfs.id((err, id) => {
+            expect(err).to.not.exist()
+            ipfs.stop((err) => {
+              // TODO: go-ipfs returns an error, https://github.com/ipfs/go-ipfs/issues/4078
+              if (!id.agentVersion.startsWith('go-ipfs')) {
+                expect(err).to.not.exist()
+              }
+              done()
+            })
+          })
+        })
+      })
+    })
+
+    it('.stat gives error while offline', () => {
+      ipfs.bitswap.stat((err, stats) => {
+        expect(err).to.match(/online mode/)
+        expect(stats).to.not.exist()
+      })
+    })
+
+    it('.wantlist gives error if offline', () => {
+      ipfs.bitswap.wantlist((err, list) => {
+        expect(err).to.match(/online mode/)
+        expect(list).to.not.exist()
+      })
+    })
+
+    it('.unwant gives error if offline', () => {
+      expect(() => ipfs.bitswap.unwant(key, (err) => {
+        expect(err).to.match(/online mode/)
+      }))
+    })
+  })
+}

js/src/index.js

@@ -19,3 +19,4 @@ exports.repo = require('./repo')
 exports.bootstrap = require('./bootstrap')
 exports.types = require('./types')
 exports.util = require('./util')
+exports.bitswap = require('./bitswap')