feat: Support specify hash algorithm in files.add (#597)

*  support support specify hash alg

* Add test for add with --hash option. Pass raw cid/multihash to ipfs object get/data

* Allow object get/data to accept CID

* Var naming tweaks from review

Author: alanshaw

src/files/add.js

@@ -21,6 +21,26 @@ module.exports = (send) => {
       return callback(new Error('"files" must be a buffer, readable stream, or array of objects'))
     }
 
+    const qs = {}
+
+    if (opts['cid-version'] != null) {
+      qs['cid-version'] = opts['cid-version']
+    } else if (opts.cidVersion != null) {
+      qs['cid-version'] = opts.cidVersion
+    }
+
+    if (opts['raw-leaves'] != null) {
+      qs['raw-leaves'] = opts['raw-leaves']
+    } else if (opts.rawLeaves != null) {
+      qs['raw-leaves'] = opts.rawLeaves
+    }
+
+    if (opts.hash != null) {
+      qs.hash = opts.hash
+    } else if (opts.hashAlg != null) {
+      qs.hash = opts.hashAlg
+    }
+
     const request = { path: 'add', files: files, qs: opts, progress: opts.progress }
 
     // Transform the response stream to DAGNode values

src/object/data.js

@@ -2,7 +2,7 @@
 
 const promisify = require('promisify-es6')
 const streamToValue = require('../utils/stream-to-value')
-const cleanMultihash = require('../utils/clean-multihash')
+const CID = require('cids')
 const LRU = require('lru-cache')
 const lruOptions = {
   max: 128
@@ -11,7 +11,7 @@ const lruOptions = {
 const cache = LRU(lruOptions)
 
 module.exports = (send) => {
-  return promisify((multihash, options, callback) => {
+  return promisify((cid, options, callback) => {
     if (typeof options === 'function') {
       callback = options
       options = {}
@@ -20,21 +20,24 @@ module.exports = (send) => {
       options = {}
     }
 
+    let cidB58Str
+
     try {
-      multihash = cleanMultihash(multihash, options)
+      cid = new CID(cid)
+      cidB58Str = cid.toBaseEncodedString()
     } catch (err) {
       return callback(err)
     }
 
-    const node = cache.get(multihash)
+    const node = cache.get(cidB58Str)
 
     if (node) {
       return callback(null, node.data)
     }
 
     send({
       path: 'object/data',
-      args: multihash
+      args: cidB58Str
     }, (err, result) => {
       if (err) {
         return callback(err)

src/object/get.js

@@ -5,7 +5,7 @@ const dagPB = require('ipld-dag-pb')
 const DAGNode = dagPB.DAGNode
 const DAGLink = dagPB.DAGLink
 const bs58 = require('bs58')
-const cleanMultihash = require('../utils/clean-multihash')
+const CID = require('cids')
 const LRU = require('lru-cache')
 const lruOptions = {
   max: 128
@@ -14,7 +14,7 @@ const lruOptions = {
 const cache = LRU(lruOptions)
 
 module.exports = (send) => {
-  return promisify((multihash, options, callback) => {
+  return promisify((cid, options, callback) => {
     if (typeof options === 'function') {
       callback = options
       options = {}
@@ -24,21 +24,24 @@ module.exports = (send) => {
       options = {}
     }
 
+    let cidB58Str
+
     try {
-      multihash = cleanMultihash(multihash, options)
+      cid = new CID(cid)
+      cidB58Str = cid.toBaseEncodedString()
     } catch (err) {
       return callback(err)
     }
 
-    const node = cache.get(multihash)
+    const node = cache.get(cidB58Str)
 
     if (node) {
       return callback(null, node)
     }
 
     send({
       path: 'object/get',
-      args: multihash
+      args: cidB58Str
     }, (err, result) => {
       if (err) {
         return callback(err)
@@ -52,7 +55,7 @@ module.exports = (send) => {
         if (err) {
           return callback(err)
         }
-        cache.set(multihash, node)
+        cache.set(cidB58Str, node)
         callback(null, node)
       })
     })

src/utils/get-dagnode.js

@@ -3,21 +3,24 @@
 const DAGNode = require('ipld-dag-pb').DAGNode
 const parallel = require('async/parallel')
 const CID = require('cids')
-const mh = require('multihashes')
 const streamToValue = require('./stream-to-value')
 
 module.exports = function (send, hash, callback) {
-  // Until js-ipfs supports object/get and object/data by CID
-  // we need to convert our CID or multihash hash into a multihash
-  const multihash = mh.toB58String(new CID(hash).multihash)
+  let cid
+
+  try {
+    cid = new CID(hash)
+  } catch (err) {
+    return callback(err)
+  }
 
   // Retrieve the object and its data in parallel, then produce a DAGNode
   // instance using this information.
   parallel([
     (done) => {
       send({
         path: 'object/get',
-        args: multihash
+        args: cid.toBaseEncodedString()
       }, done)
     },
     (done) => {
@@ -26,7 +29,7 @@ module.exports = function (send, hash, callback) {
       // See https://github.com/ipfs/go-ipfs/issues/1582 for more details.
       send({
         path: 'object/data',
-        args: multihash
+        args: cid.toBaseEncodedString()
       }, done)
     }
   ], (err, res) => {

test/files.spec.js

@@ -8,13 +8,27 @@ const expect = chai.expect
 chai.use(dirtyChai)
 const isNode = require('detect-node')
 const loadFixture = require('aegir/fixtures')
+const mh = require('multihashes')
+const CID = require('cids')
 
 const FactoryClient = require('./ipfs-factory/client')
 
 const testfile = isNode
   ? loadFixture(__dirname, '/fixtures/testfile.txt')
   : loadFixture(__dirname, 'fixtures/testfile.txt')
 
+// TODO: Test against all algorithms Object.keys(mh.names)
+// This subset is known to work with both go-ipfs and js-ipfs as of 2017-09-05
+const HASH_ALGS = [
+  'sha1',
+  'sha2-256',
+  'sha2-512',
+  'keccak-224',
+  'keccak-256',
+  'keccak-384',
+  'keccak-512'
+]
+
 describe('.files (the MFS API part)', function () {
   this.timeout(120 * 1000)
 
@@ -73,6 +87,25 @@ describe('.files (the MFS API part)', function () {
       })
     })
 
+    HASH_ALGS.forEach((name) => {
+      it(`files.add with hash=${name} and raw-leaves=false`, (done) => {
+        const content = String(Math.random() + Date.now())
+        const file = {
+          path: content + '.txt',
+          content: Buffer.from(content)
+        }
+        const options = { hash: name, 'raw-leaves': false }
+
+        ipfs.files.add([file], options, (err, res) => {
+          if (err) return done(err)
+          expect(res).to.have.length(1)
+          const cid = new CID(res[0].hash)
+          expect(mh.decode(cid.multihash).name).to.equal(name)
+          done()
+        })
+      })
+    })
+
     it.only('files.add with progress options', (done) => {
       ipfs.files.add(testfile, {progress: false}, (err, res) => {
         expect(err).to.not.exist()
@@ -239,6 +272,24 @@ describe('.files (the MFS API part)', function () {
         })
     })
 
+    HASH_ALGS.forEach((name) => {
+      it(`files.add with hash=${name} and raw-leaves=false`, () => {
+        const content = String(Math.random() + Date.now())
+        const file = {
+          path: content + '.txt',
+          content: Buffer.from(content)
+        }
+        const options = { hash: name, 'raw-leaves': false }
+
+        return ipfs.files.add([file], options)
+          .then((res) => {
+            expect(res).to.have.length(1)
+            const cid = new CID(res[0].hash)
+            expect(mh.decode(cid.multihash).name).to.equal(name)
+          })
+      })
+    })
+
     it('files.mkdir', () => {
       return ipfs.files.mkdir('/test-folder')
     })