feat: ipns working locally

Author: vasco-santos

js/src/index.js

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

js/src/name/index.js

@@ -0,0 +1,9 @@
+'use strict'
+const { createSuite } = require('../utils/suite')
+
+const tests = {
+  publish: require('./publish'),
+  resolve: require('./resolve')
+}
+
+module.exports = createSuite(tests)

js/src/name/publish.js

@@ -0,0 +1,96 @@
+/* eslint-env mocha */
+'use strict'
+
+const each = require('async/each')
+const hat = require('hat')
+
+const { fixtures } = require('./utils')
+const { getDescribe, getIt, expect } = require('../utils/mocha')
+
+module.exports = (createCommon, options) => {
+  const describe = getDescribe(options)
+  const it = getIt(options)
+  const common = createCommon()
+
+  describe('.name.publish', function () {
+    this.timeout(50 * 1000)
+
+    const keyName = hat()
+    let ipfs
+    let nodeId
+    let keyId
+
+    before(function (done) {
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+
+        factory.spawnNode((err, node) => {
+          expect(err).to.not.exist()
+
+          ipfs = node
+          ipfs.id().then((res) => {
+            expect(res.id).to.exist()
+
+            nodeId = res.id
+
+            ipfs.key.gen(keyName, { type: 'rsa', size: 2048 }, (err, key) => {
+              expect(err).to.not.exist()
+              expect(key).to.exist()
+              expect(key).to.have.property('name', keyName)
+              expect(key).to.have.property('id')
+
+              keyId = key.id
+              populate()
+            })
+          })
+        })
+      })
+
+      function populate () {
+        each(fixtures.files, (file, cb) => {
+          ipfs.files.add(file.data, { pin: false }, cb)
+        }, done)
+      }
+    })
+
+    after((done) => common.teardown(done))
+
+    it('name publish should publish correctly', (done) => {
+      const value = fixtures.files[0].cid
+
+      ipfs.name.publish(value, true, '1m', '10s', 'self', (err, res) => {
+        expect(err).to.not.exist()
+        expect(res).to.exist()
+        expect(res).to.equal(nodeId)
+
+        done()
+      })
+    })
+
+    it('name publish should publish correctly when the file was not added but resolve is disabled', (done) => {
+      const value = 'QmPFVLPmp9zv5Z5KUqLhe2EivAGccQW2r7M7jhVJGLZoZU'
+
+      ipfs.name.publish(value, false, '1m', '10s', 'self', (err, res) => {
+        expect(err).to.not.exist()
+        expect(res).to.exist()
+        expect(res).to.equal(nodeId)
+
+        done()
+      })
+    })
+
+    it('name publish should publish correctly when a new key is used', (done) => {
+      const value = fixtures.files[0].cid
+
+      ipfs.name.publish(value, false, '24h', '10s', keyName, (err, res) => {
+        expect(err).to.not.exist()
+        expect(res).to.exist()
+        expect(res).to.equal(keyId)
+
+        done()
+      })
+    })
+  })
+}

js/src/name/resolve.js

@@ -0,0 +1,123 @@
+/* eslint-env mocha */
+'use strict'
+
+const each = require('async/each')
+const hat = require('hat')
+
+const { fixtures } = require('./utils')
+const { getDescribe, getIt, expect } = require('../utils/mocha')
+
+module.exports = (createCommon, options) => {
+  const describe = getDescribe(options)
+  const it = getIt(options)
+  const common = createCommon()
+
+  describe('.name.resolve', function () {
+    this.timeout(50 * 1000)
+
+    const keyName = hat()
+    let ipfs
+    let nodeId
+    let keyId
+
+    before(function (done) {
+      this.timeout(60 * 1000)
+
+      common.setup((err, factory) => {
+        expect(err).to.not.exist()
+
+        factory.spawnNode((err, node) => {
+          expect(err).to.not.exist()
+
+          ipfs = node
+          ipfs.id().then((res) => {
+            expect(res.id).to.exist()
+
+            nodeId = res.id
+
+            ipfs.key.gen(keyName, { type: 'rsa', size: 2048 }, (err, key) => {
+              expect(err).to.not.exist()
+              expect(key).to.exist()
+              expect(key).to.have.property('name', keyName)
+              expect(key).to.have.property('id')
+
+              keyId = key.id
+              populate()
+            })
+          })
+        })
+      })
+
+      function populate () {
+        each(fixtures.files, (file, cb) => {
+          ipfs.files.add(file.data, { pin: false }, cb)
+        }, done)
+      }
+    })
+
+    after((done) => common.teardown(done))
+
+    it('name resolve should resolve correctly after a publish', (done) => {
+      this.timeout(60 * 1000)
+
+      const value = fixtures.files[0].cid
+
+      ipfs.name.publish(value, true, '1m', '10s', 'self', (err, res) => {
+        expect(err).to.not.exist()
+        expect(res).to.exist()
+
+        ipfs.name.resolve(nodeId, false, false, (err, res) => {
+          expect(err).to.not.exist()
+          expect(res).to.exist()
+          expect(res).to.equal(`/ipfs/${value}`)
+
+          done()
+        })
+      })
+    })
+
+    it('name resolve should not get the entry correctly if its validity time expired', (done) => {
+      this.timeout(60 * 1000)
+
+      const value = fixtures.files[0].cid
+
+      ipfs.name.publish(value, true, '10ns', '10s', 'self', (err, res) => {
+        expect(err).to.not.exist()
+        expect(res).to.exist()
+
+        setTimeout(function () {
+          ipfs.name.resolve(nodeId, false, false, (err, res) => {
+            expect(err).to.exist()
+            expect(res).to.not.exist()
+
+            done()
+          })
+        }, 1)
+      })
+    })
+
+    it('name resolve should should go recursively until finding an ipfs hash', (done) => {
+      this.timeout(60 * 1000)
+
+      const value = fixtures.files[0].cid
+
+      ipfs.name.publish(value, true, '24h', '10s', 'self', (err, res) => {
+        expect(err).to.not.exist()
+        expect(res).to.exist()
+
+        ipfs.name.publish(`/ipns/${nodeId}`, true, '24h', '10s', keyName, (err, res) => {
+          expect(err).to.not.exist()
+          expect(res).to.exist()
+
+          ipfs.name.resolve(keyId, false, true, (err, res) => {
+            expect(err).to.not.exist()
+            expect(res).to.exist()
+            expect(res).to.equal(`/ipfs/${value}`)
+
+            done()
+          })
+        })
+      })
+    })
+  })
+}

js/src/name/utils.js

@@ -0,0 +1,13 @@
+'use strict'
+
+const loadFixture = require('aegir/fixtures')
+
+exports.fixtures = Object.freeze({
+  files: Object.freeze([Object.freeze({
+    data: loadFixture('js/test/fixtures/testfile.txt', 'interface-ipfs-core'),
+    cid: 'Qma4hjFTnCasJ8PVp3mZbZK5g2vGDT4LByLJ7m8ciyRFZP'
+  }), Object.freeze({
+    data: loadFixture('js/test/fixtures/test-folder/files/hello.txt', 'interface-ipfs-core'),
+    cid: 'QmY9cxiHqTFoWamkQVkpmmqzBrY3hCBEL2XNu3NtX74Fuu'
+  })])
+})