chore: ipns routing logic moved to instantiation

vasco-santos · vasco-santos · commit 73d3686d7a3e · 2018-11-11T02:36:30.000Z
diff --git a/package.json b/package.json
@@ -78,6 +78,7 @@
   "dependencies": {
     "@nodeutils/defaults-deep": "^1.1.0",
     "async": "^2.6.1",
+    "base32.js": "~0.1.0",
     "big.js": "^5.2.2",
     "binary-querystring": "~0.1.2",
     "bl": "^2.1.2",
@@ -86,6 +87,7 @@
     "byteman": "^1.3.5",
     "cid-tool": "~0.1.0",
     "cids": "~0.5.5",
+    "datastore-core": "~0.6.0",
     "debug": "^4.1.0",
     "err-code": "^1.1.2",
     "file-type": "^10.2.0",
diff --git a/src/core/components/init.js b/src/core/components/init.js
@@ -8,6 +8,9 @@ const defaultsDeep = require('@nodeutils/defaults-deep')
 const defaultConfig = require('../runtime/config-nodejs.js')
 const Keychain = require('libp2p-keychain')
 
+const IPNS = require('../ipns')
+const OfflineDatastore = require('../ipns/routing/offline-datastore')
+
 const addDefaultAssets = require('./init-assets')
 
 module.exports = function init (self) {
@@ -105,6 +108,13 @@ module.exports = function init (self) {
           cb(null, true)
         }
       },
+      // Setup offline routing for IPNS. This is primarily used for offline ipns modifications, such as the initializeKeyspace feature.
+      (_, cb) => {
+        const offlineDatastore = new OfflineDatastore(self._repo)
+
+        self._ipns = new IPNS(offlineDatastore, self)
+        cb(null, true)
+      },
       // add empty unixfs dir object (go-ipfs assumes this exists)
       (_, cb) => {
         if (opts.emptyRepo) {
diff --git a/src/core/components/name.js b/src/core/components/name.js
@@ -128,7 +128,7 @@ module.exports = function name (self) {
       const nocache = options.nocache && options.nocache.toString() === 'true'
       const recursive = options.recursive && options.recursive.toString() === 'true'
 
-      const local = true // TODO ROUTING - use self._options.local
+      const local = self._options.local
 
       if (!self.isOnline() && !local) {
         const errMsg = utils.OFFLINE_ERROR
@@ -157,11 +157,10 @@ module.exports = function name (self) {
 
       const resolveOptions = {
         nocache,
-        recursive,
-        local
+        recursive
       }
 
-      self._ipns.resolve(name, self._peerInfo.id, resolveOptions, callback)
+      self._ipns.resolve(name, resolveOptions, callback)
     })
   }
 }
diff --git a/src/core/components/pre-start.js b/src/core/components/pre-start.js
@@ -7,6 +7,10 @@ const waterfall = require('async/waterfall')
 const Keychain = require('libp2p-keychain')
 const extend = require('deep-extend')
 const NoKeychain = require('./no-keychain')
+
+const IPNS = require('../ipns')
+const OfflineDatastore = require('../ipns/routing/offline-datastore')
+
 /*
  * Load stuff from Repo into memory
  */
@@ -95,6 +99,13 @@ module.exports = function preStart (self) {
 
         cb()
       },
+      // Setup offline routing for IPNS.
+      (cb) => {
+        const offlineDatastore = new OfflineDatastore(self._repo)
+
+        self._ipns = new IPNS(offlineDatastore, self)
+        cb()
+      },
       (cb) => self.pin._load(cb)
     ], callback)
   }
diff --git a/src/core/components/start.js b/src/core/components/start.js
@@ -4,6 +4,10 @@ const series = require('async/series')
 const Bitswap = require('ipfs-bitswap')
 const setImmediate = require('async/setImmediate')
 const promisify = require('promisify-es6')
+const { TieredDatastore } = require('datastore-core')
+
+const IPNS = require('../ipns')
+const OfflineDatastore = require('../ipns/routing/offline-datastore')
 
 module.exports = (self) => {
   return promisify((callback) => {
@@ -34,6 +38,20 @@ module.exports = (self) => {
       },
       (cb) => self.libp2p.start(cb),
       (cb) => {
+        // Setup online routing for IPNS with a tiered routing composed by a DHT and a Pubsub router (if properly enabled)
+        const ipnsStores = []
+
+        // TODO Add IPNS pubsub if enabled
+
+        // NOTE: Until the IPNS over DHT is not ready, it is being replaced by the local repo datastore
+        // When DHT is added, If local option enabled, should receive offlineDatastore as well
+        const offlineDatastore = new OfflineDatastore(self._repo)
+        ipnsStores.push(offlineDatastore)
+
+        // Create ipns routing with a set of datastores
+        const routing = new TieredDatastore(ipnsStores)
+        self._ipns = new IPNS(routing, self)
+
         self._bitswap = new Bitswap(
           self._libp2pNode,
           self._repo.blocks,
diff --git a/src/core/index.js b/src/core/index.js
@@ -33,7 +33,7 @@ const ipldZcash = require('ipld-zcash')
 const config = require('./config')
 const boot = require('./boot')
 const components = require('./components')
-const IPNS = require('./ipns')
+
 // replaced by repo-browser when running in the browser
 const defaultRepo = require('./runtime/repo-nodejs')
 const preload = require('./preload')
@@ -107,7 +107,7 @@ class IPFS extends EventEmitter {
     })
     this._preload = preload(this)
     this._mfsPreload = mfsPreload(this)
-    this._ipns = new IPNS(null, this)
+    this._ipns = undefined
 
     // IPFS Core exposed components
     //   - for booting up a node
diff --git a/src/core/ipns/index.js b/src/core/ipns/index.js
@@ -19,8 +19,9 @@ class IPNS {
   constructor (routing, ipfs) {
     this.publisher = new IpnsPublisher(routing, ipfs._repo)
     this.republisher = new IpnsRepublisher(this.publisher, ipfs)
-    this.resolver = new IpnsResolver(routing, ipfs._repo)
+    this.resolver = new IpnsResolver(routing)
     this.cache = new Receptacle({ max: 1000 }) // Create an LRU cache with max 1000 items
+    this.routing = routing
   }
 
   // Publish
@@ -53,7 +54,12 @@ class IPNS {
   }
 
   // Resolve
-  resolve (name, peerId, options, callback) {
+  resolve (name, options, callback) {
+    if (typeof options === 'function') {
+      callback = options
+      options = {}
+    }
+
     // If recursive, we should not try to get the cached value
     if (!options.nocache && !options.recursive) {
       // Try to get the record from cache
@@ -67,7 +73,7 @@ class IPNS {
       }
     }
 
-    this.resolver.resolve(name, peerId, options, (err, result) => {
+    this.resolver.resolve(name, options, (err, result) => {
       if (err) {
         log.error(err)
         return callback(err)
diff --git a/src/core/ipns/path.js b/src/core/ipns/path.js
@@ -13,13 +13,7 @@ const resolvePath = (ipfsNode, name, callback) => {
   if (isIPFS.ipnsPath(name)) {
     log(`resolve ipns path ${name}`)
 
-    const local = true // TODO ROUTING - use self._options.local
-
-    const options = {
-      local: local
-    }
-
-    return ipfsNode._ipns.resolve(name, ipfsNode._peerInfo.id, options, callback)
+    return ipfsNode._ipns.resolve(name, callback)
   }
 
   // ipfs path
diff --git a/src/core/ipns/publisher.js b/src/core/ipns/publisher.js
@@ -67,17 +67,17 @@ class IpnsPublisher {
 
       let keys
       try {
-        keys = ipns.getIdKeys(peerId.id)
+        keys = ipns.getIdKeys(peerId.toBytes())
       } catch (err) {
         log.error(err)
         return callback(err)
       }
 
       series([
-        (cb) => this._publishEntry(keys.ipnsKey, embedPublicKeyRecord || record, peerId, cb),
+        (cb) => this._publishEntry(keys.routingKey, embedPublicKeyRecord || record, peerId, cb),
         // Publish the public key if a public key cannot be extracted from the ID
         // We will be able to deprecate this part in the future, since the public keys will be only in the peerId
-        (cb) => embedPublicKeyRecord ? this._publishPublicKey(keys.pkKey, publicKey, peerId, cb) : cb()
+        (cb) => embedPublicKeyRecord ? this._publishPublicKey(keys.routingPubKey, publicKey, peerId, cb) : cb()
       ], (err) => {
         if (err) {
           log.error(err)
@@ -108,13 +108,13 @@ class IpnsPublisher {
       return callback(err)
     }
 
-    // TODO Routing - this should be replaced by a put to the DHT
-    this._repo.datastore.put(key, rec.serialize(), (err, res) => {
+    // Add record to routing (buffer key)
+    this._routing.put(key.toBuffer(), rec.serialize(), (err, res) => {
       if (err) {
         const errMsg = `ipns record for ${key.toString()} could not be stored in the routing`
 
         log.error(errMsg)
-        return callback(errcode(new Error(errMsg), 'ERR_STORING_IN_DATASTORE'))
+        return callback(errcode(new Error(errMsg), 'ERR_PUTTING_TO_ROUTING'))
       }
 
       log(`ipns record for ${key.toString()} was stored in the routing`)
@@ -146,13 +146,13 @@ class IpnsPublisher {
       return callback(err)
     }
 
-    // TODO Routing - this should be replaced by a put to the DHT
-    this._repo.datastore.put(key, rec.serialize(), (err, res) => {
+    // Add public key to routing (buffer key)
+    this._routing.put(key.toBuffer(), rec.serialize(), (err, res) => {
       if (err) {
         const errMsg = `public key for ${key.toString()} could not be stored in the routing`
 
         log.error(errMsg)
-        return callback(errcode(new Error(errMsg), 'ERR_STORING_IN_DATASTORE'))
+        return callback(errcode(new Error(errMsg), 'ERR_PUTTING_TO_ROUTING'))
       }
 
       log(`public key for ${key.toString()} was stored in the routing`)
diff --git a/src/core/ipns/resolver.js b/src/core/ipns/resolver.js
@@ -3,6 +3,7 @@
 const ipns = require('ipns')
 const { fromB58String } = require('multihashes')
 const Record = require('libp2p-record').Record
+const PeerId = require('peer-id')
 const errcode = require('err-code')
 
 const debug = require('debug')
@@ -12,13 +13,11 @@ log.error = debug('jsipfs:ipns:resolver:error')
 const defaultMaximumRecursiveDepth = 32
 
 class IpnsResolver {
-  constructor (routing, repo) {
+  constructor (routing) {
     this._routing = routing
-    this._repo = repo
-    this._resolver = undefined // TODO Routing - add Router resolver
   }
 
-  resolve (name, peerId, options, callback) {
+  resolve (name, options, callback) {
     if (typeof options === 'function') {
       callback = options
       options = {}
@@ -33,7 +32,6 @@ class IpnsResolver {
 
     options = options || {}
     const recursive = options.recursive && options.recursive.toString() === 'true'
-    const local = !(options.local === false)
 
     const nameSegments = name.split('/')
 
@@ -53,20 +51,7 @@ class IpnsResolver {
       depth = defaultMaximumRecursiveDepth
     }
 
-    // Get the intended resoulver function
-    // TODO Routing - set default resolverFn
-
-    let resolverFn
-
-    if (local) {
-      resolverFn = this._resolveLocal
-    }
-
-    if (!resolverFn) {
-      return callback(new Error('not implemented yet'))
-    }
-
-    this.resolver(key, depth, peerId, resolverFn, (err, res) => {
+    this.resolver(key, depth, (err, res) => {
       if (err) {
         return callback(err)
       }
@@ -77,10 +62,7 @@ class IpnsResolver {
   }
 
   // Recursive resolver according to the specified depth
-  resolver (name, depth, peerId, resolverFn, callback) {
-    // bind resolver function
-    this._resolver = resolverFn
-
+  resolver (name, depth, callback) {
     // Exceeded recursive maximum depth
     if (depth === 0) {
       const errMsg = `could not resolve name (recursion limit of ${defaultMaximumRecursiveDepth} exceeded)`
@@ -89,7 +71,7 @@ class IpnsResolver {
       return callback(errcode(new Error(errMsg), 'ERR_RESOLVE_RECURSION_LIMIT'))
     }
 
-    this._resolver(name, peerId, (err, res) => {
+    this._resolveName(name, (err, res) => {
       if (err) {
         return callback(err)
       }
@@ -102,30 +84,35 @@ class IpnsResolver {
       }
 
       // continue recursively until depth equals 0
-      this.resolver(nameSegments[2], depth - 1, peerId, resolverFn, callback)
+      this.resolver(nameSegments[2], depth - 1, callback)
     })
   }
 
-  // resolve ipns entries locally using the datastore
-  _resolveLocal (name, peerId, callback) {
-    const { ipnsKey } = ipns.getIdKeys(fromB58String(name))
+  // resolve ipns entries from the provided routing
+  _resolveName (name, callback) {
+    const peerId = PeerId.createFromB58String(name)
+    const { routingKey } = ipns.getIdKeys(fromB58String(name))
 
-    this._repo.datastore.get(ipnsKey, (err, dsVal) => {
-      if (err) {
-        const errMsg = `local record requested was not found for ${name} (${ipnsKey})`
+    // TODO DHT - get public key from routing?
+    // https://github.com/ipfs/go-ipfs/blob/master/namesys/routing.go#L70
+    // https://github.com/libp2p/go-libp2p-routing/blob/master/routing.go#L99
+
+    this._routing.get(routingKey.toBuffer(), (err, res) => {
+      if (err || !res) {
+        const errMsg = `record requested was not found for ${name} (${routingKey}) in the network`
 
         log.error(errMsg)
-        return callback(errcode(new Error(errMsg), 'ERR_NO_LOCAL_RECORD_FOUND'))
+        return callback(errcode(new Error(errMsg), 'ERR_NO_NETWORK_RECORD_FOUND'))
       }
 
-      if (!Buffer.isBuffer(dsVal)) {
+      if (!Buffer.isBuffer(res)) {
         const errMsg = `found ipns record that we couldn't convert to a value`
 
         log.error(errMsg)
         return callback(errcode(new Error(errMsg), 'ERR_INVALID_RECORD_RECEIVED'))
       }
 
-      const record = Record.deserialize(dsVal)
+      const record = Record.deserialize(res)
       const ipnsEntry = ipns.unmarshal(record.value)
 
       ipns.extractPublicKey(peerId, ipnsEntry, (err, pubKey) => {
diff --git a/src/core/ipns/routing/offline-datastore.js b/src/core/ipns/routing/offline-datastore.js
diff --git a/src/core/ipns/routing/utils.js b/src/core/ipns/routing/utils.js
diff --git a/test/cli/name.js b/test/cli/name.js

Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ module.exports = function name (self) {`
`128`	`128`	`const nocache = options.nocache && options.nocache.toString() === 'true'`
`129`	`129`	`const recursive = options.recursive && options.recursive.toString() === 'true'`
`130`	`130`
`131`		`- const local = true // TODO ROUTING - use self._options.local`
	`131`	`+ const local = self._options.local`
`132`	`132`
`133`	`133`	`if (!self.isOnline() && !local) {`
`134`	`134`	`const errMsg = utils.OFFLINE_ERROR`
`@@ -157,11 +157,10 @@ module.exports = function name (self) {`
`157`	`157`
`158`	`158`	`const resolveOptions = {`
`159`	`159`	`nocache,`
`160`		`- recursive,`
`161`		`- local`
	`160`	`+ recursive`
`162`	`161`	`}`
`163`	`162`
`164`		`- self._ipns.resolve(name, self._peerInfo.id, resolveOptions, callback)`
	`163`	`+ self._ipns.resolve(name, resolveOptions, callback)`
`165`	`164`	`})`
`166`	`165`	`}`
`167`	`166`	`}`