refactor: convert pin API to async/await (#1168)

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

Author: Alan Shaw

src/pin/add.js

@@ -1,22 +1,22 @@
 'use strict'
 
-const promisify = require('promisify-es6')
+const configure = require('../lib/configure')
 
-module.exports = (send) => {
-  return promisify((hash, opts, callback) => {
-    if (typeof opts === 'function') {
-      callback = opts
-      opts = null
-    }
-    send({
-      path: 'pin/add',
-      args: hash,
-      qs: opts
-    }, (err, res) => {
-      if (err) {
-        return callback(err)
-      }
-      callback(null, res.Pins.map((hash) => ({ hash: hash })))
-    })
-  })
-}
+module.exports = configure(({ ky }) => {
+  return async (path, options) => {
+    options = options || {}
+
+    const searchParams = new URLSearchParams(options.searchParams)
+    searchParams.set('arg', `${path}`)
+    if (options.recursive != null) searchParams.set('recursive', options.recursive)
+
+    const res = await ky.post('pin/add', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams
+    }).json()
+
+    return (res.Pins || []).map(hash => ({ hash }))
+  }
+})

src/pin/index.js

@@ -1,13 +1,9 @@
 'use strict'
 
-const moduleConfig = require('../utils/module-config')
+const callbackify = require('callbackify')
 
-module.exports = (arg) => {
-  const send = moduleConfig(arg)
-
-  return {
-    add: require('./add')(send),
-    rm: require('./rm')(send),
-    ls: require('./ls')(send)
-  }
-}
+module.exports = config => ({
+  add: callbackify.variadic(require('./add')(config)),
+  rm: callbackify.variadic(require('./rm')(config)),
+  ls: callbackify.variadic(require('./ls')(config))
+})

src/pin/ls.js

@@ -1,33 +1,27 @@
 'use strict'
 
-const promisify = require('promisify-es6')
+const configure = require('../lib/configure')
 
-module.exports = (send) => {
-  return promisify((hash, opts, callback) => {
-    if (typeof hash === 'function') {
-      callback = hash
-      opts = null
-      hash = null
+module.exports = configure(({ ky }) => {
+  return async (path, options) => {
+    if (path && path.type) {
+      options = path
+      path = null
     }
-    if (typeof opts === 'function') {
-      callback = opts
-      opts = null
-    }
-    if (hash && hash.type) {
-      opts = hash
-      hash = null
-    }
-    send({
-      path: 'pin/ls',
-      args: hash,
-      qs: opts
-    }, (err, res) => {
-      if (err) {
-        return callback(err)
-      }
-      callback(null, Object.keys(res.Keys).map(hash => (
-        { hash, type: res.Keys[hash].Type }
-      )))
-    })
-  })
-}
+
+    options = options || {}
+
+    const searchParams = new URLSearchParams(options.searchParams)
+    if (path) searchParams.set('arg', `${path}`)
+    if (options.type) searchParams.set('type', options.type)
+
+    const { Keys } = await ky.get('pin/ls', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams
+    }).json()
+
+    return Object.keys(Keys).map(hash => ({ hash, type: Keys[hash].Type }))
+  }
+})

src/pin/rm.js

@@ -1,22 +1,22 @@
 'use strict'
 
-const promisify = require('promisify-es6')
+const configure = require('../lib/configure')
 
-module.exports = (send) => {
-  return promisify((hash, opts, callback) => {
-    if (typeof opts === 'function') {
-      callback = opts
-      opts = null
-    }
-    send({
-      path: 'pin/rm',
-      args: hash,
-      qs: opts
-    }, (err, res) => {
-      if (err) {
-        return callback(err)
-      }
-      callback(null, res.Pins.map((hash) => ({ hash: hash })))
-    })
-  })
-}
+module.exports = configure(({ ky }) => {
+  return async (path, options) => {
+    options = options || {}
+
+    const searchParams = new URLSearchParams(options.searchParams)
+    searchParams.set('arg', `${path}`)
+    if (options.recursive != null) searchParams.set('recursive', options.recursive)
+
+    const res = await ky.post('pin/rm', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams
+    }).json()
+
+    return (res.Pins || []).map(hash => ({ hash }))
+  }
+})

src/utils/load-commands.js

@@ -113,7 +113,8 @@ function requireCommands (send, config) {
     config: require('../config')(config),
     dag: require('../dag')(config),
     dht: require('../dht')(config),
-    diag: require('../diag')(config)
+    diag: require('../diag')(config),
+    pin: require('../pin')(config)
   }
 
   Object.assign(cmds.refs, {
@@ -129,7 +130,6 @@ function requireCommands (send, config) {
 
     // Graph
     object: require('../object'),
-    pin: require('../pin'),
 
     // Network
     name: require('../name'),