fix: reinstate DAGLink.multihash property with deprecation notice

Just having a slight wobble about removing the `.multihash` property from the DAGLink class as part of #99. It's the right thing to do but it will cause a lot of disruption.
ipld · Nov 12, 2018 · 66dde2a · 66dde2a
1 parent d56ed9a
commit 66dde2a
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,7 @@
     - [`link.name`](#linkname)
     - [`link.size`](#linksize)
     - [`link.cid`](#linkcid)
+    - [`link.multihash`](#linkmultihash)
     - [`link.toJSON()`](#linktojson)
     - [`link.toString()`](#linktostring)
   - [[IPLD Format Specifics](https://github.com/ipld/interface-ipld-format) - Local (node/block scope) resolver](#ipld-format-specificshttpsgithubcomipldinterface-ipld-format---local-nodeblock-scope-resolver)
@@ -263,6 +264,12 @@ const link = new DAGLink(name, size, cid)
 
 #### `link.cid`
 
+
+
+#### `link.multihash`
+
+**Deprecated** Please use `link.cid` instead.
+
 #### `link.toJSON()`
 
 #### `link.toString()`

diff --git a/src/dag-link/index.js b/src/dag-link/index.js
@@ -26,7 +26,8 @@ class DAGLink {
       this._json = Object.freeze({
         name: this.name,
         size: this.size,
-        cid: this._cid.toBaseEncodedString()
+        cid: this._cid.toBaseEncodedString(),
+        multihash: this._cid.toBaseEncodedString()
       })
     }
 
@@ -56,6 +57,14 @@ class DAGLink {
   set cid (cid) {
     throw new Error("Can't set property: 'cid' is immutable")
   }
+
+  get multihash () {
+    return this._cid.buffer
+  }
+
+  set multihash (cid) {
+    throw new Error("Can't set property: 'multihash' is immutable")
+  }
 }
 
 exports = module.exports = withIs(DAGLink, { className: 'DAGLink', symbolName: '@ipld/js-ipld-dag-pb/daglink' })

diff --git a/test/dag-link-test.js b/test/dag-link-test.js
@@ -44,7 +44,8 @@ module.exports = (repo) => {
       expect(link.toJSON()).to.eql({
         name: 'hello',
         size: 3,
-        cid: 'QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39U'
+        cid: 'QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39U',
+        multihash: 'QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39U'
       })
     })
 
@@ -70,5 +71,22 @@ module.exports = (repo) => {
         expect(error.message).to.include("'cid' is immutable")
       }
     })
+
+    it('exposes a multihash', () => {
+      const cid = new CID('QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39U')
+      const link = new DAGLink('hello', 3, cid)
+      expect(link.multihash).to.deep.equal(cid.buffer)
+    })
+
+    it('has an immutable multihash', () => {
+      const link = new DAGLink('hello', 3, 'QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39U')
+
+      try {
+        link.multihash = 'foo'
+        throw new Error('Should not be able to update multihash')
+      } catch (error) {
+        expect(error.message).to.include("'multihash' is immutable")
+      }
+    })
   })
 }
diff --git a/test/dag-node-test.js b/test/dag-node-test.js
@@ -491,36 +491,43 @@ module.exports = (repo) => {
         {
           name: '',
           cid: 'QmSbCgdsX12C4KDw3PDmpBN9iCzS87a5DjgSCoW9esqzXk',
+          multihash: 'QmSbCgdsX12C4KDw3PDmpBN9iCzS87a5DjgSCoW9esqzXk',
           size: 45623854
         },
         {
           name: '',
           cid: 'Qma4GxWNhywSvWFzPKtEswPGqeZ9mLs2Kt76JuBq9g3fi2',
+          multihash: 'Qma4GxWNhywSvWFzPKtEswPGqeZ9mLs2Kt76JuBq9g3fi2',
           size: 45623854
         },
         {
           name: '',
           cid: 'QmQfyxyys7a1e3mpz9XsntSsTGc8VgpjPj5BF1a1CGdGNc',
+          multihash: 'QmQfyxyys7a1e3mpz9XsntSsTGc8VgpjPj5BF1a1CGdGNc',
           size: 45623854
         },
         {
           name: '',
           cid: 'QmSh2wTTZT4N8fuSeCFw7wterzdqbE93j1XDhfN3vQHzDV',
+          multihash: 'QmSh2wTTZT4N8fuSeCFw7wterzdqbE93j1XDhfN3vQHzDV',
           size: 45623854
         },
         {
           name: '',
           cid: 'QmVXsSVjwxMsCwKRCUxEkGb4f4B98gXVy3ih3v4otvcURK',
+          multihash: 'QmVXsSVjwxMsCwKRCUxEkGb4f4B98gXVy3ih3v4otvcURK',
           size: 45623854
         },
         {
           name: '',
           cid: 'QmZjhH97MEYwQXzCqSQbdjGDhXWuwW4RyikR24pNqytWLj',
+          multihash: 'QmZjhH97MEYwQXzCqSQbdjGDhXWuwW4RyikR24pNqytWLj',
           size: 45623854
         },
         {
           name: '',
           cid: 'QmRs6U5YirCqC7taTynz3x2GNaHJZ3jDvMVAzaiXppwmNJ',
+          multihash: 'QmRs6U5YirCqC7taTynz3x2GNaHJZ3jDvMVAzaiXppwmNJ',
           size: 32538395
         }
       ]
@@ -545,21 +552,25 @@ module.exports = (repo) => {
         {
           name: 'audio_only.m4a',
           cid: 'QmaUAwAQJNtvUdJB42qNbTTgDpzPYD1qdsKNtctM5i7DGB',
+          multihash: 'QmaUAwAQJNtvUdJB42qNbTTgDpzPYD1qdsKNtctM5i7DGB',
           size: 23319629
         },
         {
           name: 'chat.txt',
           cid: 'QmNVrxbB25cKTRuKg2DuhUmBVEK9NmCwWEHtsHPV6YutHw',
+          multihash: 'QmNVrxbB25cKTRuKg2DuhUmBVEK9NmCwWEHtsHPV6YutHw',
           size: 996
         },
         {
           name: 'playback.m3u',
           cid: 'QmUcjKzDLXBPmB6BKHeKSh6ZoFZjss4XDhMRdLYRVuvVfu',
+          multihash: 'QmUcjKzDLXBPmB6BKHeKSh6ZoFZjss4XDhMRdLYRVuvVfu',
           size: 116
         },
         {
           name: 'zoom_0.mp4',
           cid: 'QmQqy2SiEkKgr2cw5UbQ93TtLKEMsD8TdcWggR8q9JabjX',
+          multihash: 'QmQqy2SiEkKgr2cw5UbQ93TtLKEMsD8TdcWggR8q9JabjX',
           size: 306281879
         }
       ]

diff --git a/test/resolver.spec.js b/test/resolver.spec.js
@@ -24,10 +24,12 @@ describe('IPLD Format resolver (local)', () => {
   const links = [{
     name: '',
     cid: 'QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39U',
+    multihash: 'QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39U',
     size: 10
   }, {
     name: 'named link',
     cid: 'QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39V',
+    multihash: 'QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39V',
     size: 8
   }]
   const create = (data, links, callback) => waterfall([