refactor: pin set walking

Author: dirkmc

src/core/components/pin/pin-set.js

@@ -231,19 +231,15 @@ exports = module.exports = function (dag) {
       dag.get(link.Hash, '', { preload: false }, (err, res) => {
         if (err) { return callback(err) }
         const keys = []
-        const step = link => keys.push(link.Hash.buffer)
-        pinSet.walkItems(res.value, step, err => {
+        const stepPin = link => keys.push(link.Hash.buffer)
+        pinSet.walkItems(res.value, { stepPin }, err => {
           if (err) { return callback(err) }
           return callback(null, keys)
         })
       })
     },
 
-    walkItems: (node, step, callback) => {
-      pinSet.walkAll(node, step, () => {}, callback)
-    },
-
-    walkAll: (node, stepPin, stepBin, callback) => {
+    walkItems: (node, { stepPin = () => {}, stepBin = () => {} }, callback) => {
       let pbh
       try {
         pbh = readHeader(node)
@@ -263,7 +259,7 @@ exports = module.exports = function (dag) {
             // walk the links of this fanout bin
             return dag.get(linkHash, '', { preload: false }, (err, res) => {
               if (err) { return eachCb(err) }
-              pinSet.walkAll(res.value, stepPin, stepBin, eachCb)
+              pinSet.walkItems(res.value, { stepPin, stepBin }, eachCb)
             })
           }
         } else {
@@ -279,14 +275,14 @@ exports = module.exports = function (dag) {
       // "Empty block" used by the pinner
       const cids = [new CID(emptyKey)]
 
-      const step = link => cids.push(link.Hash)
+      const stepBin = link => cids.push(link.Hash)
       eachSeries(rootNode.Links, (topLevelLink, cb) => {
         cids.push(topLevelLink.Hash)
 
         dag.get(topLevelLink.Hash, '', { preload: false }, (err, res) => {
           if (err) { return cb(err) }
 
-          pinSet.walkAll(res.value, () => {}, step, cb)
+          pinSet.walkItems(res.value, { stepBin }, cb)
         })
       }, (err) => callback(err, cids))
     }

test/core/pin-set.js

@@ -181,12 +181,12 @@ describe('pinSet', function () {
     })
   })
 
-  describe('walkAll', function () {
+  describe('walkItems', function () {
     it(`fails if node doesn't have a pin-set protobuf header`, function (done) {
       createNode('datum', (err, node) => {
         expect(err).to.not.exist()
 
-        pinSet.walkAll(node, () => {}, () => {}, (err, res) => {
+        pinSet.walkItems(node, {}, (err, res) => {
           expect(err).to.exist()
           expect(res).to.not.exist()
           done()
@@ -198,17 +198,17 @@ describe('pinSet', function () {
       this.timeout(90 * 1000)
 
       const seenPins = []
-      const walkerPin = (link, idx, data) => seenPins.push({ link, idx, data })
+      const stepPin = (link, idx, data) => seenPins.push({ link, idx, data })
       const seenBins = []
-      const walkerBin = (link, idx, data) => seenBins.push({ link, idx, data })
+      const stepBin = (link, idx, data) => seenBins.push({ link, idx, data })
 
       createNodes(maxItems + 1, (err, nodes) => {
         expect(err).to.not.exist()
 
         pinSet.storeSet(nodes, (err, result) => {
           expect(err).to.not.exist()
 
-          pinSet.walkAll(result.node, walkerPin, walkerBin, err => {
+          pinSet.walkItems(result.node, { stepPin, stepBin }, err => {
             expect(err).to.not.exist()
             expect(seenPins).to.have.length(maxItems + 1)
             expect(seenBins).to.have.length(defaultFanout)
@@ -217,20 +217,18 @@ describe('pinSet', function () {
         })
       })
     })
-  })
 
-  describe('walkItems', function () {
     it('visits all non-fanout links of a root node', function (done) {
       const seen = []
-      const walker = (link, idx, data) => seen.push({ link, idx, data })
+      const stepPin = (link, idx, data) => seen.push({ link, idx, data })
 
       createNodes(defaultFanout, (err, nodes) => {
         expect(err).to.not.exist()
 
         pinSet.storeSet(nodes, (err, result) => {
           expect(err).to.not.exist()
 
-          pinSet.walkItems(result.node, walker, err => {
+          pinSet.walkItems(result.node, { stepPin }, err => {
             expect(err).to.not.exist()
             expect(seen).to.have.length(defaultFanout)
             expect(seen[0].idx).to.eql(defaultFanout)