fix: block presences deserialization

Author: dirkmc

src/types/message/index.js

@@ -29,10 +29,9 @@ class BitswapMessage {
     if (wantType == null) {
       wantType = BitswapMessage.WantType.Block
     }
-    const cidStr = cid.toString('base58btc')
 
+    const cidStr = cid.toString('base58btc')
     const entry = this.wantlist.get(cidStr)
-
     if (entry) {
       // Only change priority if want is of the same type
       if (entry.wantType === wantType) {
@@ -121,10 +120,13 @@ class BitswapMessage {
           return {
             block: entry.cid.buffer, // cid
             priority: Number(entry.priority),
-            cancel: Boolean(entry.cancel)
+            wantType: entry.wantType,
+            cancel: Boolean(entry.cancel),
+            sendDontHave: Boolean(entry.sendDontHave)
           }
         })
       },
+      blockPresences: [],
       payload: []
     }
 
@@ -187,6 +189,17 @@ BitswapMessage.deserialize = async (raw) => {
     })
   }
 
+  if (decoded.blockPresences) {
+    decoded.blockPresences.forEach((blockPresence) => {
+      const cid = new CID(blockPresence.cid)
+      if (blockPresence.type === BitswapMessage.BlockPresenceType.Have) {
+        msg.addHave(cid)
+      } else {
+        msg.addDontHave(cid)
+      }
+    })
+  }
+
   // Bitswap 1.0.0
   // decoded.blocks are just the byte arrays
   if (decoded.blocks.length > 0) {

test/types/message.spec.js

@@ -22,22 +22,72 @@ describe('BitswapMessage', () => {
   let cids
 
   before(async () => {
-    blocks = await makeBlock(3)
+    blocks = await makeBlock(4)
     cids = blocks.map((b) => b.cid)
   })
 
-  it('.addEntry - want block', () => {
-    const cid = cids[1]
-    const msg = new BitswapMessage(true)
-    msg.addEntry(cid, 1)
-    const serialized = msg.serializeToBitswap100()
+  describe('.addEntry', () => {
+    it('want type defaults to want block', () => {
+      const cid = cids[1]
+      const msg = new BitswapMessage(true)
+      msg.addEntry(cid, 1)
+      const serialized = msg.serializeToBitswap100()
+
+      expect(pbm.Message.decode(serialized).wantlist.entries[0]).to.be.eql({
+        block: cid.buffer,
+        priority: 1,
+        cancel: false,
+        sendDontHave: false,
+        wantType: pbm.Message.Wantlist.WantType.Block
+      })
+    })
+
+    it('updates priority only if same want type', () => {
+      const msg = new BitswapMessage(true)
+
+      msg.addEntry(cids[0], 1, BitswapMessage.WantType.Block, false, false)
+
+      msg.addEntry(cids[0], 2, BitswapMessage.WantType.Have, true, false)
+      expect(msg.wantlist.get(cids[0].toString('base58btc')).priority).to.eql(1)
 
-    expect(pbm.Message.decode(serialized).wantlist.entries[0]).to.be.eql({
-      block: cid.buffer,
-      priority: 1,
-      cancel: false,
-      sendDontHave: false,
-      wantType: pbm.Message.Wantlist.WantType.Block
+      msg.addEntry(cids[0], 2, BitswapMessage.WantType.Block, true, false)
+      expect(msg.wantlist.get(cids[0].toString('base58btc')).priority).to.eql(2)
+    })
+
+    it('only changes from dont cancel to do cancel', () => {
+      const msg = new BitswapMessage(true)
+
+      msg.addEntry(cids[0], 1, BitswapMessage.WantType.Block, true, false)
+      msg.addEntry(cids[0], 1, BitswapMessage.WantType.Block, false, false)
+      expect(msg.wantlist.get(cids[0].toString('base58btc')).cancel).to.eql(true)
+
+      msg.addEntry(cids[1], 1, BitswapMessage.WantType.Block, false, false)
+      msg.addEntry(cids[1], 1, BitswapMessage.WantType.Block, true, false)
+      expect(msg.wantlist.get(cids[1].toString('base58btc')).cancel).to.eql(true)
+    })
+
+    it('only changes from dont send to do send DONT_HAVE', () => {
+      const msg = new BitswapMessage(true)
+
+      msg.addEntry(cids[0], 1, BitswapMessage.WantType.Block, false, false)
+      msg.addEntry(cids[0], 1, BitswapMessage.WantType.Block, false, true)
+      expect(msg.wantlist.get(cids[0].toString('base58btc')).sendDontHave).to.eql(true)
+
+      msg.addEntry(cids[1], 1, BitswapMessage.WantType.Block, false, true)
+      msg.addEntry(cids[1], 1, BitswapMessage.WantType.Block, false, false)
+      expect(msg.wantlist.get(cids[1].toString('base58btc')).sendDontHave).to.eql(true)
+    })
+
+    it('only override want-have with want-block (not vice versa)', () => {
+      const msg = new BitswapMessage(true)
+
+      msg.addEntry(cids[0], 1, BitswapMessage.WantType.Block, false, false)
+      msg.addEntry(cids[0], 1, BitswapMessage.WantType.Have, false, false)
+      expect(msg.wantlist.get(cids[0].toString('base58btc')).wantType).to.eql(BitswapMessage.WantType.Block)
+
+      msg.addEntry(cids[1], 1, BitswapMessage.WantType.Have, false, false)
+      msg.addEntry(cids[1], 1, BitswapMessage.WantType.Block, false, false)
+      expect(msg.wantlist.get(cids[1].toString('base58btc')).wantType).to.eql(BitswapMessage.WantType.Block)
     })
   })
 
@@ -54,12 +104,27 @@ describe('BitswapMessage', () => {
     const msg = new BitswapMessage(true)
     msg.addBlock(block)
     msg.setPendingBytes(10)
+    msg.addEntry(cids[0], 10, BitswapMessage.WantType.Have, false, true)
+    msg.addHave(cids[1])
+    msg.addDontHave(cids[2])
 
     const serialized = msg.serializeToBitswap110()
     const decoded = pbm.Message.decode(serialized)
-
     expect(decoded.payload[0].data).to.eql(block.data)
     expect(decoded.pendingBytes).to.eql(10)
+    expect(decoded.wantlist.entries.length).to.eql(1)
+    expect(decoded.wantlist.entries[0].priority).to.eql(10)
+    expect(decoded.wantlist.entries[0].wantType).to.eql(BitswapMessage.WantType.Have)
+    expect(decoded.wantlist.entries[0].cancel).to.eql(false)
+    expect(decoded.wantlist.entries[0].sendDontHave).to.eql(true)
+    expect(decoded.blockPresences.length).to.eql(2)
+    for (const bp of decoded.blockPresences) {
+      if (bp.type === BitswapMessage.BlockPresenceType.Have) {
+        expect(bp.cid.equals(cids[1].buffer)).to.eql(true)
+      } else {
+        expect(bp.cid.equals(cids[2].buffer)).to.eql(true)
+      }
+    }
   })
 
   it('.deserialize a Bitswap100 Message', async () => {
@@ -104,6 +169,7 @@ describe('BitswapMessage', () => {
     const cid0 = cids[0]
     const cid1 = cids[1]
     const cid2 = cids[2]
+    const cid3 = cids[3]
 
     const b1 = blocks[1]
     const b2 = blocks[2]
@@ -112,7 +178,9 @@ describe('BitswapMessage', () => {
       wantlist: {
         entries: [{
           block: cid0.buffer,
-          cancel: false
+          cancel: false,
+          wantType: BitswapMessage.WantType.Block,
+          sendDontHave: true
         }],
         full: true
       },
@@ -123,6 +191,10 @@ describe('BitswapMessage', () => {
         data: b2.data,
         prefix: cid2.prefix
       }],
+      blockPresences: [{
+        cid: cid3.buffer,
+        type: BitswapMessage.BlockPresenceType.Have
+      }],
       pendingBytes: 10
     })
 
@@ -131,7 +203,7 @@ describe('BitswapMessage', () => {
     expect(Array.from(msg.wantlist))
       .to.eql([[
         cid0.toString('base58btc'),
-        new BitswapMessage.Entry(cid0, 0, BitswapMessage.WantType.Block, false)
+        new BitswapMessage.Entry(cid0, 0, BitswapMessage.WantType.Block, false, true)
       ]])
 
     expect(
@@ -140,6 +212,13 @@ describe('BitswapMessage', () => {
       [cid1.toString('base58btc'), b1.data],
       [cid2.toString('base58btc'), b2.data]
     ])
+
+    expect(Array.from(msg.blockPresences))
+      .to.eql([[
+        cid3.toString('base58btc'),
+        BitswapMessage.BlockPresenceType.Have
+      ]])
+
     expect(msg.pendingBytes).to.equal(10)
   })
 

test/types/wantlist.spec.js

@@ -8,6 +8,7 @@ const CID = require('cids')
 const multihashing = require('multihashing-async')
 
 const Wantlist = require('../../src/types/wantlist')
+const Message = require('../../src/types/message')
 const makeBlock = require('../utils/make-block')
 
 describe('Wantlist', () => {
@@ -76,12 +77,12 @@ describe('Wantlist', () => {
   it('entries', () => {
     const b = blocks[0]
 
-    wm.add(b.cid, 2)
+    wm.add(b.cid, 2, Message.WantType.Have)
     expect(
       Array.from(wm.entries())
     ).to.be.eql([[
       b.cid.toString('base58btc'),
-      new Wantlist.Entry(b.cid, 2)
+      new Wantlist.Entry(b.cid, 2, Message.WantType.Have)
     ]])
   })