refactor: use ky

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

Author: Alan Shaw

package.json

@@ -17,9 +17,7 @@
   "browser": {
     "glob": false,
     "fs": false,
-    "stream": "readable-stream",
-    "./src/lib/configure.js": "./src/lib/configure.browser.js",
-    "./src/lib/querystring.js": "./src/lib/querystring.browser.js"
+    "stream": "readable-stream"
   },
   "repository": "github:ipfs/js-ipfs-http-client",
   "scripts": {
@@ -64,13 +62,14 @@
     "just-kebab-case": "^1.1.0",
     "just-map-keys": "^1.1.0",
     "kind-of": "^6.0.2",
+    "ky": "^0.11.2",
+    "ky-universal": "^0.2.2",
     "lru-cache": "^5.1.1",
     "multiaddr": "^6.0.6",
     "multibase": "~0.6.0",
     "multicodec": "~0.5.1",
     "multihashes": "~0.4.14",
     "ndjson": "github:hugomrdias/ndjson#feat/readable-stream3",
-    "node-fetch": "^2.6.0",
     "once": "^1.4.0",
     "peer-id": "~0.12.2",
     "peer-info": "~0.15.1",

src/lib/configure.browser.js

@@ -1,8 +1,10 @@
 'use strict'
+/* eslint-env browser */
 
-const { Headers } = require('node-fetch')
+const ky = require('ky-universal')
+const { isBrowser, isWebWorker } = require('ipfs-utils/src/env')
 const { toUri } = require('./multiaddr')
-const pkg = require('../../package.json')
+const errorHandler = require('./error-handler')
 
 // Set default configuration and call create function with them
 module.exports = create => config => {
@@ -16,28 +18,46 @@ module.exports = create => config => {
     config = { ...config }
   }
 
-  config.fetch = config.fetch || require('./fetch').fetch
-
   if (config.protocol || config.host || config.port) {
     const port = config.port ? `:${config.port}` : ''
     config.apiAddr = `${config.protocol || 'http'}://${config.host || 'localhost'}${port}`
   }
 
-  config.apiAddr = (config.apiAddr || 'http://localhost:5001').toString()
-  config.apiAddr = config.apiAddr.startsWith('/')
-    ? toUri(config.apiAddr)
-    : config.apiAddr
+  config.apiAddr = (config.apiAddr || getDefaultApiAddr(config)).toString()
+  config.apiAddr = config.apiAddr.startsWith('/') ? toUri(config.apiAddr) : config.apiAddr
   config.apiPath = config.apiPath || config['api-path'] || '/api/v0'
 
-  if (config.apiPath.endsWith('/')) {
-    config.apiPath = config.apiPath.slice(0, -1)
-  }
+  return create({
+    // TODO configure ky to use config.fetch when this is released:
+    // https://github.com/sindresorhus/ky/pull/153
+    ky: ky.extend({
+      prefixUrl: config.apiAddr + config.apiPath,
+      timeout: config.timeout || 60 * 1000,
+      headers: config.headers,
+      hooks: {
+        afterResponse: [errorHandler]
+      }
+    })
+  })
+}
+
+function getDefaultApiAddr ({ protocol, host, port }) {
+  if (isBrowser || isWebWorker) {
+    if (!protocol && !host && !port) { // Use current origin
+      return ''
+    }
+
+    if (!protocol) {
+      protocol = location.protocol.startsWith('http')
+        ? location.protocol.split(':')[0]
+        : 'http'
+    }
 
-  config.headers = new Headers(config.headers)
+    host = host || location.hostname
+    port = port || location.port
 
-  if (!config.headers.has('User-Agent')) {
-    config.headers.append('User-Agent', `${pkg.name}/${pkg.version}`)
+    return `${protocol}://${host}${port ? ':' + port : ''}`
   }
 
-  return create(config)
+  return `${protocol || 'http'}://${host || 'localhost'}:${port || 5001}`
 }

src/lib/configure.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const { HTTPError } = require('ky-universal')
+const log = require('debug')('ipfs-http-client:lib:error-handler')
+
+function isJsonResponse (res) {
+  return (res.headers.get('Content-Type') || '').startsWith('application/json')
+}
+
+module.exports = async function errorHandler (response) {
+  if (response.ok) return
+
+  let msg
+
+  try {
+    if (isJsonResponse(response)) {
+      const data = await response.json()
+      log(data)
+      msg = data.Message || data.message
+    } else {
+      msg = await response.text()
+    }
+  } catch (err) {
+    log('Failed to parse error response', err)
+    // Failed to extract/parse error message from response
+    throw new HTTPError(response)
+  }
+
+  if (!msg) throw new HTTPError(response)
+  throw Object.assign(new Error(msg), { status: response.status })
+}

src/lib/error-handler.js

@@ -0,0 +1,25 @@
+'use strict'
+
+module.exports = function toIterable (body) {
+  // Node.js stream
+  if (body[Symbol.asyncIterator]) return body
+
+  // Browser ReadableStream
+  if (body.getReader) {
+    return (async function * () {
+      const reader = body.getReader()
+
+      try {
+        while (true) {
+          const { done, value } = await reader.read()
+          if (done) return
+          yield value
+        }
+      } finally {
+        reader.releaseLock()
+      }
+    })()
+  }
+
+  throw new Error('unknown stream')
+}

src/lib/fetch.js

@@ -1,20 +1,18 @@
 'use strict'
 
 const configure = require('../lib/configure')
-const { ok } = require('../lib/fetch')
-const { objectToQuery } = require('../lib/querystring')
 
-module.exports = configure(({ fetch, apiAddr, apiPath, headers }) => {
+module.exports = configure(({ ky }) => {
   return async (options) => {
     options = options || {}
 
-    const qs = objectToQuery(options.qs)
-    const url = `${apiAddr}${apiPath}/pubsub/ls${qs}`
-    const res = await ok(fetch(url, {
+    const { Strings } = await ky.get('pubsub/ls', {
+      timeout: options.timeout,
       signal: options.signal,
-      headers: options.headers || headers
-    }))
-    const data = await res.json()
-    return data.Strings || []
+      headers: options.headers,
+      searchParams: options.searchParams
+    }).json()
+
+    return Strings || []
   }
 })

src/lib/querystring.browser.js

@@ -1,10 +1,8 @@
 'use strict'
 
-const { objectToQuery } = require('../lib/querystring')
 const configure = require('../lib/configure')
-const { ok } = require('../lib/fetch')
 
-module.exports = configure(({ fetch, apiAddr, apiPath, headers }) => {
+module.exports = configure(({ ky }) => {
   return async (topic, options) => {
     if (!options && typeof topic === 'object') {
       options = topic
@@ -13,17 +11,16 @@ module.exports = configure(({ fetch, apiAddr, apiPath, headers }) => {
 
     options = options || {}
 
-    const qs = objectToQuery({
-      arg: topic,
-      ...(options.qs || {})
-    })
+    const searchParams = new URLSearchParams(options.searchParams)
+    searchParams.set('arg', topic)
 
-    const url = `${apiAddr}${apiPath}/pubsub/peers${qs}`
-    const res = await ok(fetch(url, {
+    const { Strings } = await ky.get('pubsub/peers', {
+      timeout: options.timeout,
       signal: options.signal,
-      headers: options.headers || headers
-    }))
-    const data = await res.json()
-    return data.Strings || []
+      headers: options.headers,
+      searchParams
+    }).json()
+
+    return Strings || []
   }
 })