refactor: convert some object and files API methods to async/await

License: MIT
Signed-off-by: Alan Shaw <alan@tableflip.io>

Author: alanshaw

src/files/index.js

@@ -1,8 +1,9 @@
 'use strict'
 
+const callbackify = require('callbackify')
 const moduleConfig = require('../utils/module-config')
 
-module.exports = (arg) => {
+module.exports = (arg, config) => {
   const send = moduleConfig(arg)
 
   return {
@@ -17,7 +18,7 @@ module.exports = (arg) => {
     read: require('./read')(send),
     readReadableStream: require('./read-readable-stream')(send),
     readPullStream: require('./read-pull-stream')(send),
-    write: require('./write')(send),
+    write: callbackify.variadic(require('./write')(config)),
     mv: require('./mv')(send)
   }
 }

src/files/write.js

@@ -1,42 +1,32 @@
 'use strict'
 
-const promisify = require('promisify-es6')
-const concatStream = require('concat-stream')
-const once = require('once')
-const SendFilesStream = require('../utils/send-files-stream')
-
-module.exports = (send) => {
-  const sendFilesStream = SendFilesStream(send, 'files/write')
-
-  return promisify((pathDst, _files, opts, _callback) => {
-    if (typeof opts === 'function' &&
-      !_callback) {
-      _callback = opts
-      opts = {}
-    }
-
-    // opts is the real callback --
-    // 'callback' is being injected by promisify
-    if (typeof opts === 'function' &&
-      typeof _callback === 'function') {
-      _callback = opts
-      opts = {}
-    }
-
-    const files = [].concat(_files)
-    const callback = once(_callback)
-
-    const options = {
-      args: pathDst,
-      qs: opts
-    }
-
-    const stream = sendFilesStream({ qs: options })
-    const concat = concatStream((result) => callback(null, result))
-    stream.once('error', callback)
-    stream.pipe(concat)
-
-    files.forEach((file) => stream.write(file))
-    stream.end()
-  })
-}
+const configure = require('../lib/configure')
+const toFormData = require('../lib/buffer-to-form-data')
+
+module.exports = configure(({ ky }) => {
+  return async (path, input, options) => {
+    options = options || {}
+
+    const searchParams = new URLSearchParams(options.searchParams)
+    searchParams.set('arg', path)
+    searchParams.set('stream-channels', true)
+    if (options.cidVersion) searchParams.set('cid-version', options.cidVersion)
+    if (options.create != null) searchParams.set('create', options.create)
+    if (options.hashAlg) searchParams.set('hash', options.hashAlg)
+    if (options.length != null) searchParams.set('length', options.length)
+    if (options.offset != null) searchParams.set('offset', options.offset)
+    if (options.parents != null) searchParams.set('parents', options.parents)
+    if (options.rawLeaves != null) searchParams.set('raw-leaves', options.rawLeaves)
+    if (options.truncate != null) searchParams.set('truncate', options.truncate)
+
+    const res = await ky.post('files/write', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams,
+      body: toFormData(input) // TODO: support inputs other than buffer as per spec
+    })
+
+    return res.text()
+  }
+})

src/object/appendData.js

@@ -1,35 +1,24 @@
 'use strict'
 
-const promisify = require('promisify-es6')
-const once = require('once')
 const CID = require('cids')
-const SendOneFile = require('../utils/send-one-file')
+const configure = require('../lib/configure')
+const toFormData = require('../lib/buffer-to-form-data')
 
-module.exports = (send) => {
-  const sendOneFile = SendOneFile(send, 'object/patch/append-data')
+module.exports = configure(({ ky }) => {
+  return async (cid, data, options) => {
+    options = options || {}
 
-  return promisify((cid, data, opts, _callback) => {
-    if (typeof opts === 'function') {
-      _callback = opts
-      opts = {}
-    }
-    const callback = once(_callback)
-    if (!opts) {
-      opts = {}
-    }
+    const searchParams = new URLSearchParams(options.searchParams)
+    searchParams.set('arg', `${cid}`)
 
-    try {
-      cid = new CID(cid)
-    } catch (err) {
-      return callback(err)
-    }
+    const { Hash } = await ky.post('object/patch/append-data', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams,
+      body: toFormData(data)
+    }).json()
 
-    sendOneFile(data, { args: [cid.toString()] }, (err, result) => {
-      if (err) {
-        return callback(err)
-      }
-
-      callback(null, new CID(result.Hash))
-    })
-  })
-}
+    return new CID(Hash)
+  }
+})

src/object/index.js

@@ -1,22 +1,23 @@
 'use strict'
 
+const callbackify = require('callbackify')
 const moduleConfig = require('../utils/module-config')
 
-module.exports = (arg) => {
+module.exports = (arg, config) => {
   const send = moduleConfig(arg)
 
   return {
     get: require('./get')(send),
-    put: require('./put')(send),
+    put: callbackify.variadic(require('./put')(config)),
     data: require('./data')(send),
     links: require('./links')(send),
     stat: require('./stat')(send),
     new: require('./new')(send),
     patch: {
       addLink: require('./addLink')(send),
       rmLink: require('./rmLink')(send),
-      setData: require('./setData')(send),
-      appendData: require('./appendData')(send)
+      setData: callbackify.variadic(require('./setData')(config)),
+      appendData: callbackify.variadic(require('./appendData')(config))
     }
   }
 }

src/object/put.js

@@ -1,26 +1,14 @@
 'use strict'
 
-const promisify = require('promisify-es6')
 const CID = require('cids')
 const { DAGNode } = require('ipld-dag-pb')
+const { Buffer } = require('buffer')
+const configure = require('../lib/configure')
+const toFormData = require('../lib/buffer-to-form-data')
 
-const SendOneFile = require('../utils/send-one-file')
-const once = require('once')
-
-module.exports = (send) => {
-  const sendOneFile = SendOneFile(send, 'object/put')
-
-  return promisify((obj, options, _callback) => {
-    if (typeof options === 'function') {
-      _callback = options
-      options = {}
-    }
-
-    const callback = once(_callback)
-
-    if (!options) {
-      options = {}
-    }
+module.exports = configure(({ ky }) => {
+  return async (obj, options) => {
+    options = options || {}
 
     let tmpObj = {
       Data: null,
@@ -47,7 +35,7 @@ module.exports = (send) => {
       tmpObj.Data = obj.Data.toString()
       tmpObj.Links = obj.Links
     } else {
-      return callback(new Error('obj not recognized'))
+      throw new Error('obj not recognized')
     }
 
     let buf
@@ -56,18 +44,20 @@ module.exports = (send) => {
     } else {
       buf = Buffer.from(JSON.stringify(tmpObj))
     }
-    const enc = options.enc || 'json'
-
-    const sendOptions = {
-      qs: { inputenc: enc }
-    }
-
-    sendOneFile(buf, sendOptions, (err, result) => {
-      if (err) {
-        return callback(err) // early
-      }
 
-      callback(null, new CID(result.Hash))
-    })
-  })
-}
+    const searchParams = new URLSearchParams(options.searchParams)
+    if (options.enc) searchParams.set('inputenc', options.enc)
+    if (options.pin != null) searchParams.set('pin', options.pin)
+    if (options.quiet != null) searchParams.set('quiet', options.quiet)
+
+    const { Hash } = await ky.post('object/put', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams,
+      body: toFormData(buf)
+    }).json()
+
+    return new CID(Hash)
+  }
+})

src/object/setData.js

@@ -1,34 +1,24 @@
 'use strict'
 
-const promisify = require('promisify-es6')
-const once = require('once')
 const CID = require('cids')
-const SendOneFile = require('../utils/send-one-file')
+const configure = require('../lib/configure')
+const toFormData = require('../lib/buffer-to-form-data')
 
-module.exports = (send) => {
-  const sendOneFile = SendOneFile(send, 'object/patch/set-data')
+module.exports = configure(({ ky }) => {
+  return async (cid, data, options) => {
+    options = options || {}
 
-  return promisify((cid, data, opts, _callback) => {
-    if (typeof opts === 'function') {
-      _callback = opts
-      opts = {}
-    }
-    const callback = once(_callback)
-    if (!opts) {
-      opts = {}
-    }
+    const searchParams = new URLSearchParams(options.searchParams)
+    searchParams.set('arg', `${cid}`)
 
-    try {
-      cid = new CID(cid)
-    } catch (err) {
-      return callback(err)
-    }
+    const { Hash } = await ky.post('object/patch/set-data', {
+      timeout: options.timeout,
+      signal: options.signal,
+      headers: options.headers,
+      searchParams,
+      body: toFormData(data)
+    }).json()
 
-    sendOneFile(data, { args: [cid.toString()] }, (err, result) => {
-      if (err) {
-        return callback(err)
-      }
-      callback(null, new CID(result.Hash))
-    })
-  })
-}
+    return new CID(Hash)
+  }
+})

src/utils/tar-stream-to-objects.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const tar = require('tar-stream')
+const tarExtract = require('tar-stream/extract')
 const { EventIterator } = require('event-iterator')
 
 function pipe (reader, writable) {
@@ -35,7 +35,7 @@ function pipe (reader, writable) {
   { path: 'string', content: AsyncIterator<Buffer> }
 */
 async function * tarStreamToObjects (inputStream) {
-  const extractStream = tar.extract()
+  const extractStream = tarExtract()
   let onEntry
 
   const tarStream = new EventIterator(