readlink should return metadata

Author: poga

README.md

@@ -15,10 +15,10 @@ var drive = hyperdrive(memdb())
 var archive = drive.createArchive()
 
 ln.link(archive, 'linkfile', <ARCHIVE KEY>, [meta], err => {}) // create symlink to another archive
-ln.readlink(archive, 'linkfile', (err, info) => {}) // get linked archive key
+ln.readlink(archive, 'linkfile', (err, link) => {}) // get link data
 
 // assume ln.link(archive, 'path/to/file', <ARCHIVE KEY>)
-ln.resolve(archive, 'path/to/file/within/linked/archive', (err, archiveKey, restOfThePath)) // returns (err, <ARCHIVE KEY>, 'within/linked/archive')
+ln.resolve(archive, 'path/to/file/within/linked/archive', (err, link, restOfThePath)) // returns (err, {link: <ARCHIVE_KEY>, meta: {...}}, 'within/linked/archive')
 
 // resolve through archives
 ln.deepResolve(drive, swarmer, archive, path, (err, result) => {})
@@ -37,21 +37,21 @@ You can pass a `meta` object to store it in the symlink.
 
 #### `ln.readlink(archive, path, cb)`
 
-Get the archiveKey stored inside a symlink
+Get the link data stored inside a symlink.
 
 #### `ln.resolve(archive, path, cb)`
 
 Resolve a path. Returns an archive and a path within that archive with `cb(err, linkedArchiveKey, pathWithinLinkedArchive)`
 
-* If there's a symlink encountered in the path. `cb(err, linkKey, pathWithinLinkedArchive)` will be invoked.
-* If there's no symlink in the path, `cb(err, archive.key, path)` will be called.
+* If there's a symlink encountered in the path. `cb(err, link, pathWithinLinkedArchive)` will be invoked.
+* If there's no symlink in the path, `cb(err, {}, path)` will be called.
 
 for example:
 
 ```js
 ln.link(archive, 'foo/bar', '<LINK_KEY>', (err) => {
     ln.resolve(archive, 'foo/bar/baz', (err, link, path) => {
-      // link === '<LINK_KEY>'
+      // link === {link: '<LINK_KEY>', meta: {...}}
       // path === 'baz'
     })
 })

index.js

@@ -45,7 +45,7 @@ function resolve (archive, path, cb) {
           if (err && err.message === 'not a link') {
             if (i === components.length - 1) {
               // found the file
-              return cb(null, archive.key.toString('hex'), partialPath.join('/'))
+              return cb(null, {}, partialPath.join('/'))
             }
             return cb(new Error(`unresolvable at ${partialPath.join('/')}`))
           }
@@ -75,15 +75,15 @@ function deepResolve (drive, swarmer, archive, path, cb) {
 
   function _resolve (archive, path, cb) {
     var swarm = swarmer(archive)
-    resolve(archive, path, (err, nextArchiveKey, nextPath) => {
+    resolve(archive, path, (err, linkInfo, nextPath) => {
       // must return result: swarm need to be closed
       var result = {archive, path, swarm}
       if (err) {
         return cb(err, result)
       }
       if (nextPath === path) return cb(null, result)
 
-      var nextArchive = drive.createArchive(nextArchiveKey, {sparse: true})
+      var nextArchive = drive.createArchive(linkInfo.link, {sparse: true})
 
       _resolve(nextArchive, nextPath, (err, resolved) => {
         cb(err, {
@@ -112,7 +112,8 @@ function encode (destKey, meta) {
 }
 
 function decode (b) {
+  var data = JSON.parse(b)
   var link = JSON.parse(b)['$$hdln$$']
   if (!link) throw new Error('not a link')
-  return link
+  return {link: link, meta: data.meta}
 }

package.json

@@ -21,6 +21,6 @@
     "tape": "^4.6.3"
   },
   "scripts": {
-    "test": "node test/*.js"
+    "test": "tape test/*.js"
   }
 }

test/index.js

@@ -19,7 +19,7 @@ tape('link', function (t) {
 
       ln.readlink(archive, entries[0], (err, info) => {
         t.error(err)
-        t.same(info, 'foo')
+        t.same(info, {link: 'foo', meta: undefined})
         t.end()
       })
     })
@@ -37,9 +37,9 @@ tape('link with metadata', function (t) {
       t.error(err)
       t.same(entries[0].name, 'symlink')
 
-      ln.readlink(archive, entries[0], (err, key) => {
+      ln.readlink(archive, entries[0], (err, info) => {
         t.error(err)
-        t.same(key, 'foo')
+        t.same(info, {link: 'foo', meta: {bar: 'baz'}})
 
         collect(archive.createFileReadStream(entries[0]), (err, data) => {
           t.error(err)
@@ -62,7 +62,7 @@ tape('resolve', function (t) {
 
       ln.resolve(archive, '/foo/link/bar/baz.txt', (err, link, nextPath) => {
         t.error(err)
-        t.same(link, linkedArchive.key.toString('hex'))
+        t.same(link, {link: linkedArchive.key.toString('hex'), meta: undefined})
         t.same(nextPath, 'bar/baz.txt')
         t.end()
       })
@@ -78,7 +78,7 @@ tape('resolve to file without link', function (t) {
   function test () {
     ln.resolve(archive, '/foo/link', (err, link, nextPath) => {
       t.error(err)
-      t.same(link, archive.key.toString('hex'))
+      t.same(link, {})
       t.same(nextPath, '/foo/link')
       t.end()
     })