refactor: convert misc root level APIs to async/await

License: MIT
Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>

src/commands.js

@@ -1,14 +1,19 @@
 'use strict'
 
-const promisify = require('promisify-es6')
-const moduleConfig = require('./utils/module-config')
-
-module.exports = (arg) => {
-  const send = moduleConfig(arg)
-
-  return promisify((callback) => {
-    send({
-      path: 'commands'
-    }, callback)
-  })
-}
+const configure = require('./lib/configure')
+
+module.exports = configure(({ ky }) => {
+  return options => {
+    options = options || {}
+
+    const searchParams = new URLSearchParams(options.searchParams)
+    if (options.flags != null) searchParams.set('flags', options.flags)
+
+    return ky.get('commands', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams
+    }).json()
+  }
+})

src/dns.js

@@ -1,25 +1,22 @@
 'use strict'
 
-const promisify = require('promisify-es6')
-const moduleConfig = require('./utils/module-config')
+const configure = require('./lib/configure')
 
-const transform = function (res, callback) {
-  callback(null, res.Path)
-}
+module.exports = configure(({ ky }) => {
+  return async (domain, options) => {
+    options = options || {}
 
-module.exports = (arg) => {
-  const send = moduleConfig(arg)
+    const searchParams = new URLSearchParams(options.searchParams)
+    searchParams.set('arg', domain)
+    if (options.recursive != null) searchParams.set('recursive', options.recursive)
 
-  return promisify((args, opts, callback) => {
-    if (typeof (opts) === 'function') {
-      callback = opts
-      opts = {}
-    }
+    const res = await ky.post('dns', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams
+    }).json()
 
-    send.andTransform({
-      path: 'dns',
-      args: args,
-      qs: opts
-    }, transform, callback)
-  })
-}
+    return res.Path
+  }
+})

src/id.js

@@ -1,32 +1,19 @@
 'use strict'
 
-const promisify = require('promisify-es6')
-const moduleConfig = require('./utils/module-config')
+const configure = require('./lib/configure')
+const toCamel = require('./lib/object-to-camel')
 
-module.exports = (arg) => {
-  const send = moduleConfig(arg)
+module.exports = configure(({ ky }) => {
+  return async options => {
+    options = options || {}
 
-  return promisify((opts, callback) => {
-    if (typeof opts === 'function') {
-      callback = opts
-      opts = undefined
-    }
+    const res = await ky.get('id', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams: options.searchParams
+    }).json()
 
-    send({
-      path: 'id',
-      args: opts
-    }, (err, result) => {
-      if (err) {
-        return callback(err)
-      }
-      const identity = {
-        id: result.ID,
-        publicKey: result.PublicKey,
-        addresses: result.Addresses,
-        agentVersion: result.AgentVersion,
-        protocolVersion: result.ProtocolVersion
-      }
-      callback(null, identity)
-    })
-  })
-}
+    return toCamel(res)
+  }
+})

src/resolve.js

@@ -1,54 +1,25 @@
 'use strict'
 
-const promisify = require('promisify-es6')
-const multibase = require('multibase')
-const CID = require('cids')
-
-module.exports = (send) => {
-  return promisify((args, opts, callback) => {
-    if (typeof (opts) === 'function') {
-      callback = opts
-      opts = {}
-    }
-
-    opts = opts || {}
-
-    if (opts.cidBase) {
-      opts['cid-base'] = opts.cidBase
-      delete opts.cidBase
-    }
-
-    const transform = (res, callback) => {
-      if (!opts['cid-base']) {
-        return callback(null, res.Path)
-      }
-
-      // FIXME: remove when go-ipfs supports ?cid-base for /api/v0/resolve
-      // https://github.com/ipfs/go-ipfs/pull/5777#issuecomment-439838555
-      const parts = res.Path.split('/') // ['', 'ipfs', 'QmHash', ...]
-
-      if (multibase.isEncoded(parts[2]) !== opts['cid-base']) {
-        try {
-          let cid = new CID(parts[2])
-
-          if (cid.version === 0 && opts['cid-base'] !== 'base58btc') {
-            cid = cid.toV1()
-          }
-
-          parts[2] = cid.toBaseEncodedString(opts['cid-base'])
-          res.Path = parts.join('/')
-        } catch (err) {
-          return callback(err)
-        }
-      }
-
-      callback(null, res.Path)
-    }
-
-    send.andTransform({
-      path: 'resolve',
-      args: args,
-      qs: opts
-    }, transform, callback)
-  })
-}
+const configure = require('./lib/configure')
+
+module.exports = configure(({ ky }) => {
+  return async (path, options) => {
+    options = options || {}
+
+    const searchParams = new URLSearchParams(options.searchParams)
+    searchParams.set('arg', `${path}`)
+    if (options.cidBase) searchParams.set('cid-base', options.cidBase)
+    if (options.dhtRecordCount) searchParams.set('dht-record-count', options.dhtRecordCount)
+    if (options.dhtTimeout) searchParams.set('dht-timeout', options.dhtTimeout)
+    if (options.recursive != null) searchParams.set('recursive', options.recursive)
+
+    const res = await ky.post('resolve', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams
+    }).json()
+
+    return res.Path
+  }
+})

src/stop.js

@@ -1,12 +1,16 @@
 'use strict'
 
-const promisify = require('promisify-es6')
-const moduleConfig = require('./utils/module-config')
+const configure = require('./lib/configure')
 
-module.exports = (arg) => {
-  const send = moduleConfig(arg)
+module.exports = configure(({ ky }) => {
+  return options => {
+    options = options || {}
 
-  return promisify((callback) => {
-    send({ path: 'shutdown' }, callback)
-  })
-}
+    return ky.post('shutdown', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams: options.searchParams
+    }).text()
+  }
+})

src/utils/load-commands.js

@@ -55,6 +55,8 @@ function requireCommands (send, config) {
     catReadableStream: streamify.readable(cat),
     catPullStream: pullify.source(cat),
     _catAsyncIterator: cat,
+    commands: callbackify.variadic(require('../commands')(config)),
+    dns: callbackify.variadic(require('../dns')(config)),
     get: callbackify.variadic(async (path, options) => {
       const output = []
 
@@ -98,6 +100,7 @@ function requireCommands (send, config) {
       )
     },
     _getAsyncIterator: get,
+    id: callbackify.variadic(require('../id')(config)),
     ls: callbackify.variadic((path, options) => collectify(ls)(path, options)),
     lsReadableStream: streamify.readable(ls),
     lsPullStream: pullify.source(ls),
@@ -106,6 +109,9 @@ function requireCommands (send, config) {
     refsReadableStream: streamify.readable(refs),
     refsPullStream: pullify.source(refs),
     _refsAsyncIterator: refs,
+    resolve: callbackify.variadic(require('../resolve')(config)),
+    stop: callbackify.variadic(require('../stop')(config)),
+    shutdown: callbackify.variadic(require('../stop')(config)),
     getEndpointConfig: require('../get-endpoint-config')(config),
     bitswap: require('../bitswap')(config),
     block: require('../block')(config),
@@ -138,21 +144,15 @@ function requireCommands (send, config) {
     pingPullStream: require('../ping-pull-stream'),
     swarm: require('../swarm'),
     pubsub: require('../pubsub'),
-    dns: require('../dns'),
 
     // Miscellaneous
-    commands: require('../commands'),
-    id: require('../id'),
     key: require('../key'),
     log: require('../log'),
     mount: require('../mount'),
     repo: require('../repo'),
-    stop: require('../stop'),
-    shutdown: require('../stop'),
     stats: require('../stats'),
     update: require('../update'),
-    version: require('../version'),
-    resolve: require('../resolve')
+    version: require('../version')
   }
 
   Object.keys(subCmds).forEach((file) => {

test/custom-headers.spec.js

@@ -4,23 +4,13 @@
 const isNode = require('detect-node')
 const { expect } = require('interface-ipfs-core/src/utils/mocha')
 const ipfsClient = require('../src')
-const f = require('./utils/factory')
 
 describe('custom headers', function () {
   // do not test in browser
   if (!isNode) { return }
-  this.timeout(50 * 1000) // slow CI
   let ipfs
-  let ipfsd
   // initialize ipfs with custom headers
-  before(async () => {
-    ipfsd = await f.spawn({
-      initOptions: {
-        bits: 1024,
-        profile: 'test'
-      }
-    })
-
+  before(() => {
     ipfs = ipfsClient({
       host: 'localhost',
       port: 6001,
@@ -37,6 +27,7 @@ describe('custom headers', function () {
       req.on('data', () => {})
       req.on('end', () => {
         res.writeHead(200)
+        res.write(JSON.stringify({}))
         res.end()
         // ensure custom headers are present
         expect(req.headers.authorization).to.equal('Bearer ' + 'YOLO')
@@ -48,16 +39,10 @@ describe('custom headers', function () {
     server.listen(6001, () => {
       ipfs.id((err, res) => {
         if (err) {
-          throw new Error('Unexpected error.')
+          throw err
         }
         // this call is used to test that headers are being sent.
       })
     })
   })
-
-  after(async () => {
-    if (ipfsd) {
-      await ipfsd.stop()
-    }
-  })
 })