feat: enable pubsub in the browser

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

Author: Alan Shaw

package.json

@@ -17,7 +17,8 @@
   "browser": {
     "glob": false,
     "fs": false,
-    "stream": "readable-stream"
+    "stream": "readable-stream",
+    "./src/lib/configure.js": "./src/lib/configure.browser.js"
   },
   "repository": "github:ipfs/js-ipfs-http-client",
   "scripts": {
@@ -33,6 +34,7 @@
     "coverage": "npx nyc -r html npm run test:node -- --bail"
   },
   "dependencies": {
+    "abort-controller": "^3.0.0",
     "async": "^2.6.1",
     "bignumber.js": "^9.0.0",
     "bl": "^3.0.0",
@@ -44,6 +46,7 @@
     "detect-node": "^2.0.4",
     "end-of-stream": "^1.4.1",
     "err-code": "^1.1.2",
+    "explain-error": "^1.0.4",
     "flatmap": "0.0.3",
     "glob": "^7.1.3",
     "ipfs-block": "~0.8.1",
@@ -56,6 +59,7 @@
     "is-stream": "^2.0.0",
     "iso-stream-http": "~0.1.2",
     "iso-url": "~0.4.6",
+    "iterable-ndjson": "^1.1.0",
     "just-kebab-case": "^1.1.0",
     "just-map-keys": "^1.1.0",
     "kind-of": "^6.0.2",
@@ -65,6 +69,7 @@
     "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",
@@ -74,6 +79,7 @@
     "pull-to-stream": "~0.1.1",
     "pump": "^3.0.0",
     "qs": "^6.5.2",
+    "querystring": "^0.2.0",
     "readable-stream": "^3.1.1",
     "stream-to-pull-stream": "^1.7.2",
     "tar-stream": "^2.0.1",

src/lib/callbackify.js

@@ -0,0 +1,17 @@
+'use strict'
+
+module.exports = (fn, opts) => {
+  opts = opts || {}
+  // Min number of non-callback args
+  opts.minArgs = opts.minArgs == null ? 0 : opts.minArgs
+
+  return (...args) => {
+    const cb = args[args.length - 1]
+
+    if (typeof cb !== 'function' || args.length === opts.minArgs) {
+      return fn(...args)
+    }
+
+    fn(...args.slice(0, -1)).then(res => cb(null, res), cb)
+  }
+}

src/lib/configure.browser.js

@@ -0,0 +1,46 @@
+'use strict'
+/* eslint-env browser */
+
+const { toUri } = require('./multiaddr')
+
+// Set default configuration and call create function with them
+module.exports = create => config => {
+  config = config || {}
+
+  if (typeof config === 'string') {
+    config = { apiAddr: config }
+  }
+
+  // Multiaddr instance
+  if (config.constructor && config.constructor.isMultiaddr) {
+    config = { apiAddr: config }
+  }
+
+  config.fetch = config.fetch || require('./fetch').fetch
+  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)
+  }
+
+  config.headers = new Headers(config.headers)
+
+  return create(config)
+}
+
+function getDefaultApiAddr ({ protocol, host, port }) {
+  if (!protocol) {
+    protocol = location.protocol.startsWith('http')
+      ? location.protocol.split(':')[0]
+      : 'http'
+  }
+
+  host = host || location.hostname
+  port = port || location.port
+
+  return `${protocol}://${host}${port ? ':' + port : ''}`
+}

src/lib/configure.js

@@ -0,0 +1,44 @@
+'use strict'
+
+const { Headers } = require('node-fetch')
+const { toUri } = require('./multiaddr')
+const pkg = require('../../package.json')
+
+// Set default configuration and call create function with them
+module.exports = create => config => {
+  config = config || {}
+
+  if (typeof config === 'string') {
+    config = { apiAddr: config }
+  }
+
+  // Multiaddr instance
+  if (config.constructor && config.constructor.isMultiaddr) {
+    config = { apiAddr: 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.apiPath = config.apiPath || config['api-path'] || '/api/v0'
+
+  if (config.apiPath.endsWith('/')) {
+    config.apiPath = config.apiPath.slice(0, -1)
+  }
+
+  config.headers = new Headers(config.headers)
+
+  if (!config.headers.has('User-Agent')) {
+    config.headers.append('User-Agent', `${pkg.name}/${pkg.version}`)
+  }
+
+  return create(config)
+}

src/lib/fetch.js

@@ -0,0 +1,53 @@
+'use strict'
+
+const explain = require('explain-error')
+
+exports.fetch = require('node-fetch')
+
+// Ensure fetch response is ok (200)
+// and if not, attempt to JSON parse body, extract error message and throw
+exports.ok = async res => {
+  res = await res
+
+  if (!res.ok) {
+    const { status } = res
+    const defaultMsg = `unexpected status ${status}`
+    let msg
+    try {
+      let data = await res.text()
+      try {
+        data = JSON.parse(data)
+        msg = data.message || data.Message
+      } catch (err) {
+        msg = data
+      }
+    } catch (err) {
+      throw Object.assign(explain(err, defaultMsg), { status })
+    }
+    throw Object.assign(new Error(msg || defaultMsg), { status })
+  }
+
+  return res
+}
+
+exports.toIterable = body => {
+  if (body[Symbol.asyncIterator]) return body
+
+  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/multiaddr.js

@@ -0,0 +1,16 @@
+// Convert a multiaddr to a URI
+// Assumes multiaddr is in a format that can be converted to a HTTP(s) URI
+exports.toUri = ma => {
+  const parts = `${ma}`.split('/')
+  const port = getPort(parts)
+  return `${getProtocol(parts)}://${parts[2]}${port == null ? '' : ':' + port}`
+}
+
+function getProtocol (maParts) {
+  return maParts.indexOf('https') === -1 ? 'http' : 'https'
+}
+
+function getPort (maParts) {
+  const tcpIndex = maParts.indexOf('tcp')
+  return tcpIndex === -1 ? null : maParts[tcpIndex + 1]
+}

src/lib/querystring.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const QueryString = require('querystring')
+
+// Convert an object to a query string INCLUDING leading ?
+// Excludes null/undefined values
+exports.objectToQuery = obj => {
+  if (!obj) return ''
+
+  const qs = Object.entries(obj).reduce((obj, [key, value]) => {
+    if (value != null) obj[key] = value
+    return obj
+  }, {})
+
+  return Object.keys(qs).length ? `?${QueryString.stringify(qs)}` : ''
+}