fix: browser and Node.js configuration

resolves #1103

BREAKING CHANGE: Multi parameter constructor options are no longer supported. To create a new IPFS HTTP client, pass a single parameter to the constructor. The parameter can be one of:

* String, formatted as one of:
    * Multiaddr e.g. /ip4/127.0.0.1/tcp/5001
    * URL e.g. http://127.0.0.1:5001
* [Multiaddr](https://www.npmjs.com/package/multiaddr) instance
* Object, in format of either:
    * Address and path e.g. `{ apiAddr: '/ip4/127.0.0.1/tcp/5001': apiPath: '/api/v0' }` (Note: `apiAddr` can also be a string in URL form or a Multiaddr instance)
    * Node.js style address e.g. `{ host: '127.0.0.1', port: 5001, protocol: 'http' }`

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

Author: Alan Shaw

README.md

@@ -68,6 +68,7 @@
     "ky-universal": "^0.3.0",
     "merge-options": "^2.0.0",
     "multiaddr": "^6.0.6",
+    "multiaddr-to-uri": "^5.0.0",
     "multibase": "~0.6.0",
     "multicodec": "~0.5.1",
     "multihashes": "~0.4.14",

package.json

@@ -1,10 +1,13 @@
 'use strict'
 
-module.exports = (config) => {
+const configure = require('./lib/configure')
+
+module.exports = configure(({ apiAddr, apiPath }) => {
+  const url = new URL(apiAddr)
   return () => ({
-    host: config.host,
-    port: config.port,
-    protocol: config.protocol,
-    'api-path': config['api-path']
+    host: url.hostname,
+    port: url.port,
+    protocol: url.protocol.split(':')[0], // remove ":"
+    'api-path': apiPath
   })
-}
+})

src/get-endpoint-config.js

@@ -101,7 +101,7 @@ function ipfsClient (config) {
         yield file
       }
     })()),
-    getPullStream: toPullStream((path, options) => (async function * () {
+    getPullStream: pullify.source((path, options) => (async function * () {
       for await (const file of get(path, options)) {
         if (file.content) {
           const { content } = file

src/index.js

@@ -3,7 +3,7 @@
 
 const ky = require('ky-universal').default
 const { isBrowser, isWebWorker } = require('ipfs-utils/src/env')
-const { toUri } = require('./multiaddr')
+const toUri = require('multiaddr-to-uri')
 const errorHandler = require('./error-handler')
 const mergeOptions = require('merge-options').bind({ ignoreUndefined: true })
 const parseDuration = require('parse-duration')
@@ -22,7 +22,16 @@ module.exports = create => config => {
 
   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'
+  config.apiAddr = trimEnd(config.apiAddr, '/')
+
+  const apiAddrPath = getNonRootPath(config.apiAddr)
+
+  // Use configured apiPath, or path on the end of apiAddr (if there is one) or default to /api/v0
+  config.apiPath = config.apiPath || config['api-path'] || apiAddrPath || '/api/v0'
+  config.apiPath = trimEnd(config.apiPath, '/')
+
+  // If user passed apiAddr with a path, trim it from the end (it is now apiPath)
+  config.apiAddr = apiAddrPath ? trimEnd(config.apiAddr, apiAddrPath) : config.apiAddr
 
   const defaults = {
     prefixUrl: config.apiAddr + config.apiPath,
@@ -48,13 +57,9 @@ module.exports = create => config => {
 
 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]
+        ? trimEnd(location.protocol, ':')
         : 'http'
     }
 
@@ -79,3 +84,13 @@ function wrap (fn, defaults) {
 function parseTimeout (value) {
   return typeof value === 'string' ? parseDuration(value) : value
 }
+
+const trimEnd = (str, end) => str.endsWith(end) ? str.slice(0, -end.length) : str
+
+// Get the path from a URL is it is not /
+function getNonRootPath (url) {
+  if (url) {
+    const { pathname } = new URL(url)
+    return pathname === '/' ? null : pathname
+  }
+}

src/lib/configure.js

@@ -44,15 +44,6 @@ describe('ipfs-http-client constructor tests', () => {
       expectConfig(ipfs, { host, port, protocol })
     })
 
-    it('multiaddr dns4 string, explicit https in opts', () => {
-      const host = 'foo.com'
-      const port = '1001'
-      const protocol = 'https'
-      const addr = `/dns4/${host}/tcp/${port}`
-      const ipfs = ipfsClient(addr, { protocol })
-      expectConfig(ipfs, { host, port, protocol })
-    })
-
     it('multiaddr ipv4 string (implicit http)', () => {
       const host = '101.101.101.101'
       const port = '1001'
@@ -82,22 +73,22 @@ describe('ipfs-http-client constructor tests', () => {
     it('host and port strings', () => {
       const host = '1.1.1.1'
       const port = '9999'
-      const ipfs = ipfsClient(host, port)
+      const ipfs = ipfsClient({ host, port })
       expectConfig(ipfs, { host, port })
     })
 
     it('host, port and api path', () => {
       const host = '10.100.100.255'
       const port = '9999'
       const apiPath = '/future/api/v1/'
-      const ipfs = ipfsClient(host, port, { 'api-path': apiPath })
-      expectConfig(ipfs, { host, port, apiPath })
+      const ipfs = ipfsClient({ host, port, apiPath })
+      expectConfig(ipfs, { host, port, apiPath: apiPath.slice(0, -1) })
     })
 
     it('throws on invalid multiaddr', () => {
       expect(() => ipfsClient('/dns4')).to.throw('invalid address')
       expect(() => ipfsClient('/hello')).to.throw('no protocol with name')
-      expect(() => ipfsClient('/dns4/ipfs.io')).to.throw('multiaddr must have a valid format')
+      expect(() => ipfsClient('/dns4/ipfs.io')).to.throw(/Invalid URL/)
     })
   })
 
@@ -134,7 +125,7 @@ async function clientWorks (client) {
 function expectConfig (ipfs, { host, port, protocol, apiPath }) {
   const conf = ipfs.getEndpointConfig()
   expect(conf.host).to.be.oneOf([host, 'localhost', ''])
-  expect(conf.port).to.be.oneOf([port, '5001', 80])
+  expect(conf.port).to.be.oneOf([port, '5001', '80'])
   expect(conf.protocol).to.equal(protocol || 'http')
-  expect(conf['api-path']).to.equal(apiPath || '/api/v0/')
+  expect(conf['api-path']).to.equal(apiPath || '/api/v0')
 }

src/lib/multiaddr.js

@@ -3,43 +3,16 @@
 'use strict'
 
 const { expect } = require('interface-ipfs-core/src/utils/mocha')
-const isNode = require('detect-node')
 const ipfsClient = require('../src')
-const f = require('./utils/factory')
 
 describe('.getEndpointConfig', () => {
-  if (!isNode) { return }
-
-  let ipfsd
-  let ipfs
-
-  before(async function () {
-    this.timeout(20 * 1000) // slow CI
-
-    ipfsd = await f.spawn({
-      initOptions: {
-        bits: 1024,
-        profile: 'test'
-      }
-    })
-    ipfs = ipfsClient(ipfsd.apiAddr)
-  })
-
-  after(async function () {
-    this.timeout(10 * 1000)
-
-    if (ipfsd) {
-      await ipfsd.stop()
-    }
-  })
-
   it('should return the endpoint configuration', function () {
+    const ipfs = ipfsClient('https://127.0.0.1:5501/ipfs/api/')
     const endpoint = ipfs.getEndpointConfig()
 
     expect(endpoint.host).to.equal('127.0.0.1')
-    expect(endpoint.protocol).to.equal('http')
-    expect(endpoint['api-path']).to.equal('/api/v0/')
-    // changes per test run so we just assert it exists.
-    expect(endpoint).to.have.property('port')
+    expect(endpoint.protocol).to.equal('https')
+    expect(endpoint['api-path']).to.equal('/ipfs/api')
+    expect(endpoint.port).to.equal('5501')
   })
 })

test/constructor.spec.js

@@ -10,7 +10,7 @@ describe('lib/configure', () => {
   it('should accept no config', () => {
     configure(config => {
       if (isBrowser || isWebWorker) {
-        expect(config.apiAddr).to.eql('')
+        expect(config.apiAddr).to.eql(location.origin)
       } else {
         expect(config.apiAddr).to.eql('http://localhost:5001')
       }
@@ -24,10 +24,17 @@ describe('lib/configure', () => {
     })(input)
   })
 
+  it('should accept string url', () => {
+    const input = 'http://127.0.0.1:5001'
+    configure(config => {
+      expect(config.apiAddr).to.eql('http://127.0.0.1:5001')
+    })(input)
+  })
+
   it('should accept multiaddr instance', () => {
-    const input = Multiaddr('/ip4/127.0.0.1')
+    const input = Multiaddr('/ip4/127.0.0.1/tcp/5001')
     configure(config => {
-      expect(config.apiAddr).to.eql('http://127.0.0.1')
+      expect(config.apiAddr).to.eql('http://127.0.0.1:5001')
     })(input)
   })