fix: review feedback

License: MIT
Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>

Author: Alan Shaw

package.json

@@ -96,7 +96,7 @@
     "ipfs-bitswap": "~0.25.1",
     "ipfs-block": "~0.8.1",
     "ipfs-block-service": "~0.15.2",
-    "ipfs-http-client": "^33.0.1",
+    "ipfs-http-client": "^33.1.1",
     "ipfs-http-response": "~0.3.1",
     "ipfs-mfs": "~0.12.0",
     "ipfs-multipart": "~0.1.1",
@@ -150,7 +150,6 @@
     "multihashes": "~0.4.14",
     "multihashing-async": "~0.6.0",
     "node-fetch": "^2.3.0",
-    "p-event": "^4.1.0",
     "peer-book": "~0.9.0",
     "peer-id": "~0.12.3",
     "peer-info": "~0.15.0",
@@ -198,6 +197,7 @@
     "ipfsd-ctl": "^0.43.0",
     "libp2p-websocket-star": "~0.10.2",
     "ncp": "^2.0.0",
+    "p-event": "^4.1.0",
     "qs": "^6.5.2",
     "rimraf": "^2.6.2",
     "sinon": "^7.4.0",

src/core/components/files-regular/add-pull-stream.js

@@ -116,7 +116,7 @@ function pinFile (file, self, opts, cb) {
   const isRootDir = !file.path.includes('/')
   const shouldPin = pin && isRootDir && !opts.onlyHash && !opts.hashAlg
   if (shouldPin) {
-    // Note: we take a GC lock wherever we call addPullStream(), so tell
+    // Note: addPullStream() has already taken a GC lock, so tell
     // pin.add() not to take a (second) GC lock
     return self.pin.add(file.hash, { preload: false, lock: false }, err => cb(err, file))
   } else {

src/core/components/pin/gc.js

@@ -5,14 +5,15 @@ const CID = require('cids')
 const base32 = require('base32.js')
 const parallel = require('async/parallel')
 const mapLimit = require('async/mapLimit')
-const { Key } = require('interface-datastore')
 const expErr = require('explain-error')
 const { cidToString } = require('../../../utils/cid')
 const log = require('debug')('ipfs:gc')
+// TODO: Use exported key from root when upgraded to ipfs-mfs@>=13
+// https://github.com/ipfs/js-ipfs-mfs/pull/58
+const { MFS_ROOT_KEY } = require('ipfs-mfs/src/core/utils/constants')
 
 // Limit on the number of parallel block remove operations
 const BLOCK_RM_CONCURRENCY = 256
-const MFS_ROOT_DS_KEY = new Key('/local/filesroot')
 
 // Perform mark and sweep garbage collection
 module.exports = function gc (self) {
@@ -72,7 +73,7 @@ function createMarkedSet (ipfs, callback) {
     }),
 
     // The MFS root and all its descendants
-    (cb) => ipfs._repo.root.get(MFS_ROOT_DS_KEY, (err, mh) => {
+    (cb) => ipfs._repo.root.get(MFS_ROOT_KEY, (err, mh) => {
       if (err) {
         if (err.code === 'ERR_NOT_FOUND') {
           log(`No blocks in MFS`)
@@ -147,6 +148,8 @@ function deleteUnmarkedBlocks (ipfs, markedSet, blockKeys, callback) {
   })
 }
 
+// TODO: Use exported utility when upgrade to ipfs-repo@>=0.27.1
+// https://github.com/ipfs/js-ipfs-repo/pull/206
 function dsKeyToCid (key) {
   // Block key is of the form /<base32 encoded string>
   const decoder = new base32.Decoder()

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

@@ -13,17 +13,14 @@ const { Key } = require('interface-datastore')
 const errCode = require('err-code')
 const multicodec = require('multicodec')
 const debug = require('debug')
+const { cidToString } = require('../../../utils/cid')
 
 const createPinSet = require('./pin-set')
 
 // arbitrary limit to the number of concurrent dag operations
 const concurrencyLimit = 300
 const PIN_DS_KEY = new Key('/local/pins')
 
-function toB58String (hash) {
-  return new CID(hash).toBaseEncodedString()
-}
-
 function invalidPinTypeErr (type) {
   const errMsg = `Invalid type '${type}', must be one of {direct, indirect, recursive, all}`
   return errCode(new Error(errMsg), 'ERR_INVALID_PIN_TYPE')
@@ -192,8 +189,8 @@ class PinManager {
         if (err) { return callback(err) }
         const [rKeys, dKeys] = keys
 
-        this.directPins = new Set(dKeys.map(toB58String))
-        this.recursivePins = new Set(rKeys.map(toB58String))
+        this.directPins = new Set(dKeys.map(k => cidToString(k)))
+        this.recursivePins = new Set(rKeys.map(k => cidToString(k)))
 
         this.log('Loaded pins from the datastore')
         return callback(null)
@@ -202,7 +199,7 @@ class PinManager {
   }
 
   isPinnedWithType (multihash, type, callback) {
-    const key = toB58String(multihash)
+    const key = cidToString(multihash)
     const { recursive, direct, all } = PinTypes
 
     // recursive

src/utils/mutex.js

@@ -2,7 +2,6 @@
 
 const assert = require('assert')
 const mortice = require('mortice')
-const setImmediate = require('async/setImmediate')
 const noop = () => {}
 
 // Wrap mortice to present a callback interface
@@ -33,8 +32,8 @@ class Mutex {
   * @returns {void}
   */
   _lock (type, lockedFn, cb = noop) {
-    assert(typeof lockedFn === 'function', `first argument to CBLock.${type}() must be a function`)
-    assert(typeof cb === 'function', `second argument to CBLock.${type}() must be a callback function`)
+    assert(typeof lockedFn === 'function', `first argument to Mutex.${type}() must be a function`)
+    assert(typeof cb === 'function', `second argument to Mutex.${type}() must be a callback function`)
 
     const lockId = this.lockId++
     this.log(`[${lockId}] ${type} requested`)
@@ -55,10 +54,7 @@ class Mutex {
     const lock = this.mutex[type](locked)
 
     // When the locked piece of code is complete, the Promise resolves
-    return lock.then(
-      (res) => setImmediate(() => cb(null, res)),
-      (err) => setImmediate(() => cb(err))
-    )
+    return lock.then(res => cb(null, res), cb)
   }
 }