Make ipfs.files.add return DAGNodes.

Author: hackergrrl

package.json

@@ -5,8 +5,9 @@
   "main": "lib/index.js",
   "jsnext:main": "src/index.js",
   "dependencies": {
-    "bl": "^1.1.2",
+    "async": "^2.0.0-rc.5",
     "babel-runtime": "^6.6.1",
+    "bl": "^1.1.2",
     "bs58": "^3.0.0",
     "detect-node": "^2.0.3",
     "flatmap": "0.0.3",

src/api/add.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const Wreck = require('wreck')
+const async = require('async')
+const DAGNode = require('ipfs-merkle-dag').DAGNode
 
 module.exports = (send) => {
   return function add (files, opts, cb) {
@@ -9,6 +11,8 @@ module.exports = (send) => {
       opts = {}
     }
 
+    send = send.withTransform(transform)
+
     if (typeof files === 'string' && files.startsWith('http')) {
       return Wreck.request('GET', files, null, (err, res) => {
         if (err) return cb(err)
@@ -18,5 +22,22 @@ module.exports = (send) => {
     }
 
     return send('add', null, opts, files, cb)
+
+    // transform returned objects into DAGNodes
+    function transform (err, res, done) {
+      if (err) return done(err)
+
+      async.map(res,
+        function map (entry, fin) {
+          send('object/get', entry.Hash, null, null, function (err, result) {
+            if (err) return done(err)
+            const node = new DAGNode(result.Data, result.Links)
+            fin(err, node)
+          })
+        },
+        function complete (err, results) {
+          if (done) return done(err, results)
+        })
+    }
   }
 }

src/request-api.js

@@ -110,7 +110,7 @@ function requestAPI (config, path, args, qs, files, buffer, cb) {
 // -- Interface
 
 exports = module.exports = function getRequestAPI (config) {
-  return function (path, args, qs, files, buffer, cb) {
+  var send = function (path, args, qs, files, buffer, cb) {
     if (typeof buffer === 'function') {
       cb = buffer
       buffer = false
@@ -127,4 +127,41 @@ exports = module.exports = function getRequestAPI (config) {
 
     return requestAPI(config, path, args, qs, files, buffer, cb)
   }
+
+  // Wraps the 'send' function such that an asynchronous transform may be
+  // applied to its result before passing it on to either its callback or
+  // promise.
+  send.withTransform = function (transform) {
+    return function (path, args, qs, files, buffer, cb) {
+      if (typeof buffer === 'function') {
+        cb = buffer
+        buffer = false
+      }
+
+      var p = send(path, args, qs, files, buffer, wrap(cb))
+
+      if (p instanceof Promise) {
+        return p.then((res) => {
+          return new Promise(function (resolve, reject) {
+            transform(null, res, function (err, res) {
+              if (err) reject(err)
+              else resolve(res)
+            })
+          })
+        })
+      } else {
+        return p
+      }
+
+      function wrap (done) {
+        if (done) {
+          return function (err, res) {
+            transform(err, res, done)
+          }
+        }
+      }
+    }
+  }
+
+  return send
 }

test/api/add.spec.js

@@ -7,6 +7,7 @@ const Readable = require('stream').Readable
 const path = require('path')
 const isNode = require('detect-node')
 const fs = require('fs')
+const bs58 = require('bs58')
 
 const testfileBig = fs.readFileSync(path.join(__dirname, '/../15mb.random'))
 const testfile = fs.readFileSync(path.join(__dirname, '/../testfile.txt'))
@@ -26,8 +27,9 @@ describe('.add', () => {
       expect(err).to.not.exist
 
       const added = res[0] != null ? res[0] : res
-      expect(added).to.have.property('Hash', 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP')
-      expect(added).to.have.property('Name', 'testfile.txt')
+      const mh = bs58.encode(added.multihash()).toString()
+      expect(mh).to.equal('Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP')
+      expect(added.links).to.have.length(0)
       done()
     })
   })
@@ -38,7 +40,9 @@ describe('.add', () => {
       expect(err).to.not.exist
 
       expect(res).to.have.length(1)
-      expect(res[0]).to.have.property('Hash', 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP')
+      const mh = bs58.encode(res[0].multihash()).toString()
+      expect(mh).to.equal('Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP')
+      expect(res[0].links).to.have.length(0)
       done()
     })
   })
@@ -52,7 +56,9 @@ describe('.add', () => {
       expect(err).to.not.exist
 
       expect(res).to.have.length(1)
-      expect(res[0]).to.have.a.property('Hash', 'Qme79tX2bViL26vNjPsF3DP1R9rMKMvnPYJiKTTKPrXJjq')
+      const mh = bs58.encode(res[0].multihash()).toString()
+      expect(mh).to.equal('Qmcx5werSWQPdrGVap7LARHB4QUSPRPJwxhFuHvdoXqQXT')
+      expect(res[0].links).to.have.length(58)
       done()
     })
   })
@@ -66,7 +72,9 @@ describe('.add', () => {
       expect(err).to.not.exist
 
       const added = res[0] != null ? res[0] : res
-      expect(added).to.have.property('Hash', 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP')
+      const mh = bs58.encode(added.multihash()).toString()
+      expect(mh).to.equal('Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP')
+      expect(added.links).to.have.length(0)
       done()
     })
   })
@@ -77,14 +85,9 @@ describe('.add', () => {
         expect(err).to.not.exist
 
         const added = res[res.length - 1]
-        expect(added).to.have.property('Hash', 'QmRNjDeKStKGTQXnJ2NFqeQ9oW23WcpbmvCVrpDHgDg3T6')
-
-        // check that the symlink was replaced by the target file
-        const linkPath = 'test-folder/hello-link'
-        const filePath = 'test-folder/files/hello.txt'
-        const linkHash = res.filter((e) => e.Name === linkPath)[0].Hash
-        const fileHash = res.filter((e) => e.Name === filePath)[0].Hash
-        expect(linkHash).to.equal(fileHash)
+        const mh = bs58.encode(added.multihash()).toString()
+        expect(mh).to.equal('QmRNjDeKStKGTQXnJ2NFqeQ9oW23WcpbmvCVrpDHgDg3T6')
+        expect(added.links).to.have.length(7)
 
         done()
       } else {
@@ -101,7 +104,9 @@ describe('.add', () => {
 
         const added = res[res.length - 1]
         // same hash as the result from the cli (ipfs add test/test-folder -r)
-        expect(added).to.have.property('Hash', 'QmRArDYd8Rk7Zb7K2699KqmQM1uUoejn1chtEAcqkvjzGg')
+        const mh = bs58.encode(added.multihash()).toString()
+        expect(mh).to.equal('QmRArDYd8Rk7Zb7K2699KqmQM1uUoejn1chtEAcqkvjzGg')
+        expect(added.links).to.have.length(7)
         done()
       } else {
         expect(err.message).to.be.equal('Recursive uploads are not supported in the browser')
@@ -137,7 +142,9 @@ describe('.add', () => {
       expect(err).to.not.exist
 
       const added = res[res.length - 1]
-      expect(added).to.have.property('Hash', 'QmTDH2RXGn8XyDAo9YyfbZAUXwL1FCr44YJCN9HBZmL9Gj')
+      const mh = bs58.encode(added.multihash()).toString()
+      expect(mh).to.equal('QmTDH2RXGn8XyDAo9YyfbZAUXwL1FCr44YJCN9HBZmL9Gj')
+      expect(added.links).to.have.length(6)
       done()
     })
   })
@@ -151,7 +158,9 @@ describe('.add', () => {
       expect(err).to.not.exist
 
       const added = res[0] != null ? res[0] : res
-      expect(added).to.have.a.property('Hash', 'QmNRCQWfgze6AbBCaT1rkrkV5tJ2aP4oTNPb5JZcXYywve')
+      const mh = bs58.encode(added.multihash()).toString()
+      expect(mh).to.equal('QmNRCQWfgze6AbBCaT1rkrkV5tJ2aP4oTNPb5JZcXYywve')
+      expect(added.links).to.have.length(0)
       done()
     })
   })
@@ -162,7 +171,9 @@ describe('.add', () => {
       expect(err).to.not.exist
 
       const added = res[0] != null ? res[0] : res
-      expect(added).to.have.a.property('Hash', 'QmZmHgEX9baxUn3qMjsEXQzG6DyNcrVnwieQQTrpDdrFvt')
+      const mh = bs58.encode(added.multihash()).toString()
+      expect(mh).to.equal('QmRzvSX35JpzQ2Lyn55r3YwWqdVP6PPxYHFpiWpwQTff8A')
+      expect(added.links).to.have.length(0)
       done()
     })
   })
@@ -172,8 +183,10 @@ describe('.add', () => {
       let buf = new Buffer(testfile)
       return apiClients.a.add(buf)
         .then((res) => {
-          expect(res).to.have.length(1)
-          expect(res[0]).to.have.property('Hash', 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP')
+          const added = res[0] != null ? res[0] : res
+          const mh = bs58.encode(added.multihash()).toString()
+          expect(mh).to.equal('Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP')
+          expect(added.links).to.have.length(0)
         })
     })
   })