feat: ipns over pubsub

Author: vasco-santos

SPEC/NAME.md

@@ -165,7 +165,7 @@ ipfs.name.pubsub.state(function (err, result) {
 
 ```JavaScript
 {
-  strings: ['QmQrX8hka2BtNHa8N8arAq16TCVx5qHcb46c5yPewRycLm']
+  strings: ['/ipns/QmQrX8hka2BtNHa8N8arAq16TCVx5qHcb46c5yPewRycLm']
 }
 ```
 
@@ -176,6 +176,6 @@ If no `callback` is passed, a promise is returned.
 ```JavaScript
 ipfs.name.pubsub.subs(function (err, result) {
     console.log(result.strings)
-    // ['QmQrX8hka2BtNHa8N8arAq16TCVx5qHcb46c5yPewRycLm']
+    // ['/ipns/QmQrX8hka2BtNHa8N8arAq16TCVx5qHcb46c5yPewRycLm']
 })
 ```

js/src/index.js

@@ -11,6 +11,7 @@ exports.key = require('./key')
 exports.ls = require('./ls')
 exports.miscellaneous = require('./miscellaneous')
 exports.name = require('./name')
+exports.namePubsub = require('./name-pubsub')
 exports.object = require('./object')
 exports.pin = require('./pin')
 exports.ping = require('./ping')

js/src/name-pubsub/cancel.js

@@ -0,0 +1,80 @@
+/* eslint max-nested-callbacks: ["error", 5] */
+/* eslint-env mocha */
+'use strict'
+
+const loadFixture = require('aegir/fixtures')
+
+const { spawnNodeWithId } = require('../utils/spawn')
+const { getDescribe, getIt, expect } = require('../utils/mocha')
+
+const fixture = Object.freeze({
+  data: loadFixture('js/test/fixtures/testfile.txt', 'interface-ipfs-core'),
+  cid: 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP'
+})
+
+module.exports = (createCommon, options) => {
+  const describe = getDescribe(options)
+  const it = getIt(options)
+  const common = createCommon()
+
+  describe('.name.pubsub.cancel', function () {
+    let ipfs
+    let nodeId
+
+    before(function (done) {
+      // CI takes longer to instantiate the daemon, so we need to increase the
+      // timeout for the before step
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+
+        spawnNodeWithId(factory, (err, node) => {
+          expect(err).to.not.exist()
+
+          ipfs = node
+          nodeId = node.peerId.id
+
+          ipfs.files.add(fixture.data, { pin: false }, done)
+        })
+      })
+    })
+
+    after((done) => common.teardown(done))
+
+    it('should return false when the name that is intended to cancel is not subscribed', function (done) {
+      this.timeout(60 * 1000)
+
+      ipfs.name.pubsub.cancel(nodeId, (err, res) => {
+        expect(err).to.not.exist()
+        expect(res).to.exist()
+        expect(res).to.have.property('canceled')
+        expect(res.canceled).to.eql(false)
+
+        done()
+      })
+    })
+
+    it('should cancel a subscription correctly returning true', function (done) {
+      this.timeout(140 * 1000)
+      const value = fixture.cid
+
+      ipfs.name.publish(value, { resolve: false }, (err, res) => {
+        expect(err).to.not.exist()
+
+        ipfs.name.resolve(nodeId, (err) => {
+          expect(err).to.not.exist()
+
+          ipfs.name.pubsub.cancel(nodeId, (err, res) => {
+            expect(err).to.not.exist()
+            expect(res).to.exist()
+            expect(res).to.have.property('canceled')
+            expect(res.canceled).to.eql(true)
+
+            done()
+          })
+        })
+      })
+    })
+  })
+}

js/src/name-pubsub/index.js

@@ -0,0 +1,10 @@
+'use strict'
+const { createSuite } = require('../utils/suite')
+
+const tests = {
+  cancel: require('./cancel'),
+  state: require('./state'),
+  subs: require('./subs')
+}
+
+module.exports = createSuite(tests)

js/src/name-pubsub/state.js

@@ -0,0 +1,47 @@
+/* eslint-env mocha */
+'use strict'
+
+const { spawnNodeWithId } = require('../utils/spawn')
+const { getDescribe, getIt, expect } = require('../utils/mocha')
+
+module.exports = (createCommon, options) => {
+  const describe = getDescribe(options)
+  const it = getIt(options)
+  const common = createCommon()
+
+  describe('.name.pubsub.state', function () {
+    let ipfs
+
+    before(function (done) {
+      // CI takes longer to instantiate the daemon, so we need to increase the
+      // timeout for the before step
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+
+        spawnNodeWithId(factory, (err, node) => {
+          expect(err).to.not.exist()
+
+          ipfs = node
+          done()
+        })
+      })
+    })
+
+    after((done) => common.teardown(done))
+
+    it('should get the current state of pubsub', function (done) {
+      this.timeout(50 * 1000)
+
+      ipfs.name.pubsub.state((err, res) => {
+        expect(err).to.not.exist()
+        expect(res).to.exist()
+        expect(res).to.have.property('enabled')
+        expect(res.enabled).to.be.eql(true)
+
+        done()
+      })
+    })
+  })
+}

js/src/name-pubsub/subs.js

@@ -0,0 +1,80 @@
+/* eslint max-nested-callbacks: ["error", 5] */
+/* eslint-env mocha */
+'use strict'
+
+const loadFixture = require('aegir/fixtures')
+
+const { spawnNodeWithId } = require('../utils/spawn')
+const { getDescribe, getIt, expect } = require('../utils/mocha')
+
+const fixture = Object.freeze({
+  data: loadFixture('js/test/fixtures/testfile.txt', 'interface-ipfs-core'),
+  cid: 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP'
+})
+
+module.exports = (createCommon, options) => {
+  const describe = getDescribe(options)
+  const it = getIt(options)
+  const common = createCommon()
+
+  describe('.name.pubsub.subs', function () {
+    let ipfs
+    let nodeId
+
+    before(function (done) {
+      // CI takes longer to instantiate the daemon, so we need to increase the
+      // timeout for the before step
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+
+        spawnNodeWithId(factory, (err, node) => {
+          expect(err).to.not.exist()
+
+          ipfs = node
+          nodeId = node.peerId.id
+
+          ipfs.files.add(fixture.data, { pin: false }, done)
+        })
+      })
+    })
+
+    after((done) => common.teardown(done))
+
+    it('should get a null result of subscriptions before any resolve', function (done) {
+      this.timeout(60 * 1000)
+
+      ipfs.name.pubsub.subs((err, res) => {
+        expect(err).to.not.exist()
+        expect(res).to.exist()
+        expect(res).to.have.property('strings')
+        expect(res.strings).to.eql(null)
+
+        done()
+      })
+    })
+
+    it('should get the list of subscriptions updated after a resolve', function (done) {
+      this.timeout(140 * 1000)
+      const value = fixture.cid
+
+      ipfs.name.publish(value, { resolve: false }, (err, res) => {
+        expect(err).to.not.exist()
+
+        ipfs.name.resolve(nodeId, (err) => {
+          expect(err).to.not.exist()
+
+          ipfs.name.pubsub.subs((err, res) => {
+            expect(err).to.not.exist()
+            expect(res).to.exist()
+            expect(res).to.have.property('strings')
+            expect(res.strings).to.be.an('array').that.does.include(`/ipns/${nodeId}`)
+
+            done()
+          })
+        })
+      })
+    })
+  })
+}