refactor: remove proxy api object and detect initialisation state

package.json

@@ -102,7 +102,7 @@
     "ipfs-http-response": "^0.5.0",
     "ipfs-mfs": "^1.0.0",
     "ipfs-multipart": "^0.3.0",
-    "ipfs-repo": "^0.30.0",
+    "ipfs-repo": "^1.0.0",
     "ipfs-unixfs": "^0.3.0",
     "ipfs-unixfs-exporter": "^0.41.0",
     "ipfs-unixfs-importer": "^0.44.0",
@@ -155,7 +155,6 @@
     "multicodec": "^1.0.0",
     "multihashes": "~0.4.14",
     "multihashing-async": "^0.8.0",
-    "p-defer": "^3.0.0",
     "p-queue": "^6.1.0",
     "parse-duration": "^0.1.2",
     "peer-id": "^0.13.5",

src/core/api-manager.js

@@ -1,23 +1,128 @@
 'use strict'
 
+const noop = () => {}
+const defaultApi = (onUndef = noop) => ({
+  add: onUndef,
+  bitswap: {
+    stat: onUndef,
+    unwant: onUndef,
+    wantlist: onUndef
+  },
+  block: {
+    get: onUndef,
+    put: onUndef,
+    rm: onUndef,
+    stat: onUndef
+  },
+  bootstrap: {
+    add: onUndef,
+    list: onUndef,
+    rm: onUndef
+  },
+  cat: onUndef,
+  config: onUndef,
+  dag: {
+    get: onUndef,
+    put: onUndef,
+    resolve: onUndef,
+    tree: onUndef
+  },
+  dns: onUndef,
+  files: {
+    chmod: onUndef,
+    cp: onUndef,
+    flush: onUndef,
+    ls: onUndef,
+    mkdir: onUndef,
+    mv: onUndef,
+    read: onUndef,
+    rm: onUndef,
+    stat: onUndef,
+    touch: onUndef,
+    write: onUndef
+  },
+  get: onUndef,
+  id: onUndef,
+  init: onUndef,
+  isOnline: onUndef,
+  key: {
+    export: onUndef,
+    gen: onUndef,
+    import: onUndef,
+    info: onUndef,
+    list: onUndef,
+    rename: onUndef,
+    rm: onUndef
+  },
+  ls: onUndef,
+  name: {
+    publish: onUndef,
+    pubsub: {
+      cancel: onUndef,
+      state: onUndef,
+      subs: onUndef
+    }
+  },
+  object: {
+    data: onUndef,
+    get: onUndef,
+    links: onUndef,
+    new: onUndef,
+    patch: {
+      addLink: onUndef,
+      appendData: onUndef,
+      rmLink: onUndef,
+      setData: onUndef
+    },
+    put: onUndef,
+    stat: onUndef
+  },
+  pin: onUndef,
+  ping: onUndef,
+  pubsub: {
+    subscribe: onUndef,
+    unsubscribe: onUndef,
+    publish: onUndef,
+    ls: onUndef,
+    peers: onUndef
+  },
+  refs: onUndef,
+  repo: {
+    gc: onUndef,
+    stat: onUndef,
+    version: onUndef
+  },
+  resolve: onUndef,
+  start: onUndef,
+  stats: {
+    bitswap: onUndef,
+    bw: onUndef,
+    repo: onUndef
+  },
+  stop: onUndef,
+  swarm: {
+    addrs: onUndef,
+    connect: onUndef,
+    disconnect: onUndef,
+    localAddrs: onUndef,
+    peers: onUndef
+  },
+  version: onUndef
+})
+
 module.exports = class ApiManager {
   constructor () {
-    this._api = {}
-    this._onUndef = () => undefined
-    this.api = new Proxy(this._api, {
-      get: (_, prop) => {
-        if (prop === 'then') return undefined // Not a promise!
-        return this._api[prop] === undefined ? this._onUndef(prop) : this._api[prop]
-      }
-    })
+    this.api = {
+      ...defaultApi()
+    }
   }
 
   update (nextApi, onUndef) {
     const prevApi = { ...this._api }
     const prevUndef = this._onUndef
-    Object.keys(this._api).forEach(k => { delete this._api[k] })
-    Object.assign(this._api, nextApi)
-    if (onUndef) this._onUndef = onUndef
+    Object.keys(this.api).forEach(k => { delete this.api[k] })
+    Object.assign(this.api, defaultApi(onUndef), nextApi)
+    this._onUndef = onUndef || noop
     return { cancel: () => this.update(prevApi, prevUndef), api: this.api }
   }
 }

src/core/components/init.js

@@ -5,24 +5,21 @@ const PeerId = require('peer-id')
 const PeerInfo = require('peer-info')
 const mergeOptions = require('merge-options')
 const getDefaultConfig = require('../runtime/config-nodejs.js')
-const createRepo = require('../runtime/repo-nodejs')
 const Keychain = require('libp2p-keychain')
 const NoKeychain = require('./no-keychain')
 const mortice = require('mortice')
 const { DAGNode } = require('ipld-dag-pb')
 const UnixFs = require('ipfs-unixfs')
 const multicodec = require('multicodec')
 const {
-  AlreadyInitializingError,
   AlreadyInitializedError,
-  NotStartedError,
-  NotEnabledError
+  AlreadyInitializingError,
+  NotStartedError
 } = require('../errors')
 const BlockService = require('ipfs-block-service')
 const Ipld = require('ipld')
 const getDefaultIpldOptions = require('../runtime/ipld-nodejs')
 const createPreloader = require('../preload')
-const { ERR_REPO_NOT_INITIALIZED } = require('ipfs-repo').errors
 const IPNS = require('../ipns')
 const OfflineDatastore = require('../ipns/routing/offline-datastore')
 const initAssets = require('../runtime/init-assets-nodejs')
@@ -32,9 +29,14 @@ const Components = require('./')
 module.exports = ({
   apiManager,
   print,
-  options: constructorOptions
+  options: constructorOptions,
+  repo
 }) => async function init (options) {
-  const { cancel } = apiManager.update({ init: () => { throw new AlreadyInitializingError() } })
+  const { cancel } = apiManager.update({
+    init: () => {
+      throw new AlreadyInitializingError()
+    }
+  })
 
   try {
     options = options || {}
@@ -49,30 +51,9 @@ module.exports = ({
       options.config = mergeOptions(options.config, constructorOptions.config)
     }
 
-    options.repo = options.repo || constructorOptions.repo
     options.repoAutoMigrate = options.repoAutoMigrate || constructorOptions.repoAutoMigrate
 
-    const repo = typeof options.repo === 'string' || options.repo == null
-      ? createRepo({ path: options.repo, autoMigrate: options.repoAutoMigrate })
-      : options.repo
-
-    let isInitialized = true
-
-    if (repo.closed) {
-      try {
-        await repo.open()
-      } catch (err) {
-        if (err.code === ERR_REPO_NOT_INITIALIZED) {
-          isInitialized = false
-        } else {
-          throw err
-        }
-      }
-    }
-
-    if (!isInitialized && options.allowNew === false) {
-      throw new NotEnabledError('new repo initialization is not enabled')
-    }
+    const isInitialized = await repo.isInitialized()
 
     const { peerId, keychain } = isInitialized
       ? await initExistingRepo(repo, options)
@@ -212,6 +193,7 @@ async function initNewRepo (repo, { privateKey, emptyRepo, bits, profiles, confi
 }
 
 async function initExistingRepo (repo, { config: newConfig, profiles, pass }) {
+  await repo.open()
   let config = await repo.config.get()
 
   if (newConfig || profiles) {

src/core/components/start.js

@@ -3,10 +3,14 @@
 const Bitswap = require('ipfs-bitswap')
 const multiaddr = require('multiaddr')
 const get = require('dlv')
-const defer = require('p-defer')
 const IPNS = require('../ipns')
 const routingConfig = require('../ipns/routing/config')
-const { AlreadyInitializedError, NotEnabledError } = require('../errors')
+const {
+  AlreadyInitializedError,
+  AlreadyStartingError,
+  AlreadyStartedError,
+  NotEnabledError
+} = require('../errors')
 const Components = require('./')
 const createMfsPreload = require('../mfs-preload')
 
@@ -24,8 +28,11 @@ module.exports = ({
   print,
   repo
 }) => async function start () {
-  const startPromise = defer()
-  const { cancel } = apiManager.update({ start: () => startPromise.promise })
+  const { cancel } = apiManager.update({
+    start: () => {
+      throw new AlreadyStartingError()
+    }
+  })
 
   try {
     // The repo may be closed if previously stopped
@@ -97,14 +104,12 @@ module.exports = ({
       repo
     })
 
-    apiManager.update(api, () => undefined)
+    apiManager.update(api)
   } catch (err) {
     cancel()
-    startPromise.reject(err)
     throw err
   }
 
-  startPromise.resolve(apiManager.api)
   return apiManager.api
 }
 
@@ -234,7 +239,7 @@ function createApi ({
       version: Components.repo.version({ repo })
     },
     resolve,
-    start: () => apiManager.api,
+    start: async () => { throw new AlreadyStartedError() }, // eslint-disable-line require-await
     stats: {
       bitswap: Components.bitswap.stat({ bitswap }),
       bw: libp2p.metrics

src/core/components/stop.js

@@ -1,7 +1,10 @@
 'use strict'
 
-const defer = require('p-defer')
-const { NotStartedError, AlreadyInitializedError } = require('../errors')
+const {
+  NotStartedError,
+  AlreadyInitializedError,
+  AlreadyStoppingError
+} = require('../errors')
 const Components = require('./')
 
 module.exports = ({
@@ -22,8 +25,11 @@ module.exports = ({
   print,
   repo
 }) => async function stop () {
-  const stopPromise = defer()
-  const { cancel } = apiManager.update({ stop: () => stopPromise.promise })
+  const { cancel } = apiManager.update({
+    stop: () => {
+      throw new AlreadyStoppingError()
+    }
+  })
 
   try {
     blockService.unsetExchange()
@@ -58,11 +64,9 @@ module.exports = ({
     apiManager.update(api, () => { throw new NotStartedError() })
   } catch (err) {
     cancel()
-    stopPromise.reject(err)
     throw err
   }
 
-  stopPromise.resolve(apiManager.api)
   return apiManager.api
 }
 
@@ -182,7 +186,7 @@ function createApi ({
       bw: notStarted,
       repo: Components.repo.stat({ repo })
     },
-    stop: () => apiManager.api,
+    stop: notStarted,
     swarm: {
       addrs: notStarted,
       connect: notStarted,

src/core/errors.js

@@ -44,6 +44,39 @@ class NotStartedError extends Error {
 NotStartedError.code = 'ERR_NOT_STARTED'
 exports.NotStartedError = NotStartedError
 
+class AlreadyStartingError extends Error {
+  constructor (message = 'already starting') {
+    super(message)
+    this.name = 'AlreadyStartingError'
+    this.code = AlreadyStartingError.code
+  }
+}
+
+AlreadyStartingError.code = 'ERR_ALREADY_STARTING'
+exports.AlreadyStartingError = AlreadyStartingError
+
+class AlreadyStartedError extends Error {
+  constructor (message = 'already started') {
+    super(message)
+    this.name = 'AlreadyStartedError'
+    this.code = AlreadyStartedError.code
+  }
+}
+
+AlreadyStartedError.code = 'ERR_ALREADY_STARTED'
+exports.AlreadyStartedError = AlreadyStartedError
+
+class AlreadyStoppingError extends Error {
+  constructor (message = 'already started') {
+    super(message)
+    this.name = 'AlreadyStoppingError'
+    this.code = AlreadyStartedError.code
+  }
+}
+
+AlreadyStoppingError.code = 'ERR_ALREADY_STOPPING'
+exports.AlreadyStoppingError = AlreadyStoppingError
+
 class NotEnabledError extends Error {
   constructor (message = 'not enabled') {
     super(message)