feat: migrate exporter to use IPLD Resolver

Author: daviddias

package.json

@@ -2,7 +2,7 @@
   "name": "ipfs-unixfs-engine",
   "version": "0.11.4",
   "description": "JavaScript implementation of the unixfs Engine used by IPFS",
-  "main": "lib/index.js",
+  "main": "src/index.js",
   "jsnext:main": "src/index.js",
   "scripts": {
     "lint": "aegir-lint",

src/exporter.js

@@ -2,6 +2,7 @@
 
 const traverse = require('pull-traverse')
 const pull = require('pull-stream')
+const CID = require('cids')
 
 const util = require('./util')
 const switchType = util.switchType
@@ -10,29 +11,29 @@ const cleanMultihash = util.cleanMultihash
 const dirExporter = require('./exporters/dir')
 const fileExporter = require('./exporters/file')
 
-module.exports = (hash, dagService, options) => {
+module.exports = (hash, ipldResolver, options) => {
   hash = cleanMultihash(hash)
   options = options || {}
 
   function visitor (item) {
     return pull(
-      dagService.getStream(item.hash),
+      ipldResolver.getStream(new CID(item.hash)),
       pull.map((node) => switchType(
         node,
-        () => dirExporter(node, item.path, dagService),
-        () => fileExporter(node, item.path, dagService)
+        () => dirExporter(node, item.path, ipldResolver),
+        () => fileExporter(node, item.path, ipldResolver)
       )),
       pull.flatten()
     )
   }
 
   // Traverse the DAG
   return pull(
-    dagService.getStream(hash),
+    ipldResolver.getStream(new CID(hash)),
     pull.map((node) => switchType(
       node,
       () => traverse.widthFirst({path: hash, hash}, visitor),
-      () => fileExporter(node, hash, dagService)
+      () => fileExporter(node, hash, ipldResolver)
     )),
     pull.flatten()
   )

src/exporters/dir.js

@@ -3,12 +3,13 @@
 const path = require('path')
 const pull = require('pull-stream')
 const paramap = require('pull-paramap')
+const CID = require('cids')
 
 const fileExporter = require('./file')
 const switchType = require('../util').switchType
 
 // Logic to export a unixfs directory.
-module.exports = (node, name, dagService) => {
+module.exports = (node, name, ipldResolver) => {
   // The algorithm below is as follows
   //
   // 1. Take all links from a given directory node
@@ -25,15 +26,15 @@ module.exports = (node, name, dagService) => {
       path: path.join(name, link.name),
       hash: link.hash
     })),
-    paramap((item, cb) => dagService.get(item.hash, (err, n) => {
+    paramap((item, cb) => ipldResolver.get(new CID(item.hash), (err, n) => {
       if (err) {
         return cb(err)
       }
 
       cb(null, switchType(
         n,
         () => pull.values([item]),
-        () => fileExporter(n, item.path, dagService)
+        () => fileExporter(n, item.path, ipldResolver)
       ))
     })),
     pull.flatten()

src/exporters/file.js

@@ -2,11 +2,12 @@
 
 const traverse = require('pull-traverse')
 const UnixFS = require('ipfs-unixfs')
+const CID = require('cids')
 const pull = require('pull-stream')
 const paramap = require('pull-paramap')
 
 // Logic to export a single (possibly chunked) unixfs file.
-module.exports = (node, name, ds) => {
+module.exports = (node, name, ipldResolver) => {
   function getData (node) {
     try {
       const file = UnixFS.unmarshal(node.data)
@@ -19,7 +20,7 @@ module.exports = (node, name, ds) => {
   function visitor (node) {
     return pull(
       pull.values(node.links),
-      paramap((link, cb) => ds.get(link.hash, cb))
+      paramap((link, cb) => ipldResolver.get(new CID(link.hash), cb))
     )
   }
 

test/test-exporter.js

@@ -3,38 +3,42 @@
 
 const expect = require('chai').expect
 const BlockService = require('ipfs-block-service')
-const DAGService = require('ipld-resolver')
+const IPLDResolver = require('ipld-resolver')
 const UnixFS = require('ipfs-unixfs')
 const fs = require('fs')
 const path = require('path')
 const bs58 = require('bs58')
 const pull = require('pull-stream')
 const zip = require('pull-zip')
+const CID = require('cids')
 
 const unixFSEngine = require('./../src')
 const exporter = unixFSEngine.exporter
 
 module.exports = (repo) => {
   describe('exporter', () => {
-    let ds
+    let ipldResolver
 
     const bigFile = fs.readFileSync(path.join(__dirname, '/test-data/1.2MiB.txt'))
     before(() => {
       const bs = new BlockService(repo)
-      ds = new DAGService(bs)
+      ipldResolver = new IPLDResolver(bs)
     })
 
     it('import and export', (done) => {
       pull(
         pull.values([{
           path: '1.2MiB.txt',
-          content: pull.values([bigFile, Buffer('hello world')])
+          content: pull.values([
+            bigFile,
+            Buffer('hello world')
+          ])
         }]),
-        unixFSEngine.importer(ds),
+        unixFSEngine.importer(ipldResolver),
         pull.map((file) => {
           expect(file.path).to.be.eql('1.2MiB.txt')
 
-          return exporter(file.multihash, ds)
+          return exporter(file.multihash, ipldResolver)
         }),
         pull.flatten(),
         pull.collect((err, files) => {
@@ -50,15 +54,15 @@ module.exports = (repo) => {
       const mhBuf = new Buffer(bs58.decode(hash))
 
       pull(
-        ds.getStream(hash),
+        ipldResolver.getStream(new CID(hash)),
         pull.map((node) => UnixFS.unmarshal(node.data)),
         pull.collect((err, nodes) => {
           expect(err).to.not.exist
 
           const unmarsh = nodes[0]
 
           pull(
-            exporter(mhBuf, ds),
+            exporter(mhBuf, ipldResolver),
             pull.collect(onFiles)
           )
 
@@ -79,10 +83,10 @@ module.exports = (repo) => {
       pull(
         zip(
           pull(
-            ds.getStream(hash),
+            ipldResolver.getStream(new CID(hash)),
             pull.map((node) => UnixFS.unmarshal(node.data))
           ),
-          exporter(hash, ds)
+          exporter(hash, ipldResolver)
         ),
         pull.collect((err, values) => {
           expect(err).to.not.exist
@@ -97,7 +101,7 @@ module.exports = (repo) => {
     it('export a small file with links', (done) => {
       const hash = 'QmW7BDxEbGqxxSYVtn3peNPQgdDXbWkoQ6J1EFYAEuQV3Q'
       pull(
-        exporter(hash, ds),
+        exporter(hash, ipldResolver),
         pull.collect((err, files) => {
           expect(err).to.not.exist
 
@@ -109,7 +113,7 @@ module.exports = (repo) => {
     it('export a large file > 5mb', (done) => {
       const hash = 'QmRQgufjp9vLE8XK2LGKZSsPCFCF6e4iynCQtNB5X2HBKE'
       pull(
-        exporter(hash, ds),
+        exporter(hash, ipldResolver),
         pull.collect((err, files) => {
           expect(err).to.not.exist
 
@@ -123,7 +127,7 @@ module.exports = (repo) => {
       const hash = 'QmWChcSFMNcFkfeJtNd8Yru1rE6PhtCRfewi1tMwjkwKjN'
 
       pull(
-        exporter(hash, ds),
+        exporter(hash, ipldResolver),
         pull.collect((err, files) => {
           expect(err).to.not.exist
 
@@ -162,7 +166,7 @@ module.exports = (repo) => {
       const hash = 'QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn'
 
       pull(
-        exporter(hash, ds),
+        exporter(hash, ipldResolver),
         pull.collect((err, files) => {
           expect(err).to.not.exist
           expect(files[0].content).to.not.exist
@@ -176,7 +180,7 @@ module.exports = (repo) => {
       const hash = 'QmWChcSFMNcFkfeJtNd8Yru1rE6PhtCRfewi1tMwjkwKj3'
 
       pull(
-        exporter(hash, ds),
+        exporter(hash, ipldResolver),
         pull.collect((err, files) => {
           expect(err).to.exist
           done()
@@ -190,7 +194,9 @@ function fileEql (f1, f2, done) {
   pull(
     f1.content,
     pull.collect((err, data) => {
-      if (err) return done(err)
+      if (err) {
+        return done(err)
+      }
 
       try {
         if (f2) {

test/test-importer.js

@@ -18,7 +18,7 @@ function stringifyMh (files) {
 }
 
 module.exports = function (repo) {
-  describe.only('importer', function () {
+  describe('importer', function () {
     let ipldResolver
 
     const bigFile = fs.readFileSync(path.join(__dirname, '/test-data/1.2MiB.txt'))