fix: accept http client instance (#43)

* fix: accept http client instance

Instead of the http client being a dependency of this module, accept
a pre-configured http client instance at construction time.

This resolves the weird dependency loop and means we can remove this
module from the no-hoist config in ipfs.

BREAKING CHANGE:

- An instance of ipfs http client is now a required argument

* chore: update node versions

* chore: update readme

* chore: restore peer deps

Author: achingbrain

.travis.yml

@@ -6,8 +6,8 @@ stages:
   - cov
 
 node_js:
-  - '10'
-  - '12'
+  - 'lts/*'
+  - 'node'
 
 os:
   - linux

README.md

@@ -18,7 +18,7 @@ Requires access to `/api/v0/dht/findprovs` and `/api/v0/refs` HTTP API endpoints
 
 ## Requirements
 
-`libp2p-delegated-content-routing` leverages the `ipfs-http-client` library and requires it as a peer dependency, as such, both must be installed in order for this module to work properly.
+`libp2p-delegated-content-routing` leverages the `ipfs-http-client` library and requires an instance of it as a constructor argument.
 
 ```sh
 npm install ipfs-http-client libp2p-delegated-content-routing
@@ -28,14 +28,15 @@ npm install ipfs-http-client libp2p-delegated-content-routing
 
 ```js
 const DelegatedContentRouting = require('libp2p-delegated-content-routing')
+const ipfsHttpClient = require('ipfs-http-client')
 
 // default is to use ipfs.io
-const routing = new DelegatedContentRouing(peerId, {
+const routing = new DelegatedContentRouing(peerId, ipfsHttpClient({
   // use default api settings
   protocol: 'https',
   port: 443,
   host: 'ipfs.io'
-})
+}))
 const cid = new CID('QmS4ustL54uo8FzR9455qaxZwuMiUhyvMcX9Ba8nUH4uVv')
 
 for await (const { id, multiaddrs } of routing.findProviders(cid)) {

package.json

@@ -18,25 +18,28 @@
     "coverage": "aegir coverage"
   },
   "devDependencies": {
-    "aegir": "^25.1.0",
+    "aegir": "^26.0.0",
     "go-ipfs": "^0.6.0",
     "ipfs-http-client": "^46.0.0",
-    "ipfs-utils": "^2.4.0",
+    "ipfs-utils": "^3.0.0",
     "ipfsd-ctl": "^5.0.0",
     "it-drain": "^1.0.0",
     "peer-id": "^0.14.0",
     "uint8arrays": "^1.1.0"
   },
-  "peerDependencies": {
-    "ipfs-http-client": "^46.0.0"
-  },
   "dependencies": {
     "debug": "^4.1.1",
     "it-all": "^1.0.0",
     "multiaddr": "^8.0.0",
     "p-defer": "^3.0.0",
     "p-queue": "^6.2.1"
   },
+  "peerDependencies": {
+    "ipfs-http-client": "^46.0.0"
+  },
+  "browser": {
+    "go-ipfs": false
+  },
   "contributors": [
     "Jacob Heun <jacobheun@gmail.com>",
     "Vasco Santos <vasco.santos@moxy.studio>",

src/index.js

@@ -2,8 +2,6 @@
 
 const debug = require('debug')
 const PeerId = require('peer-id')
-const createFindProvs = require('ipfs-http-client/src/dht/find-provs')
-const createRefs = require('ipfs-http-client/src/refs')
 
 const { default: PQueue } = require('p-queue')
 const all = require('it-all')
@@ -13,12 +11,6 @@ const log = debug('libp2p-delegated-content-routing')
 log.error = debug('libp2p-delegated-content-routing:error')
 
 const DEFAULT_TIMEOUT = 30e3 // 30 second default
-const DEFAULT_IPFS_API = {
-  protocol: 'https',
-  port: 443,
-  host: 'node0.delegate.ipfs.io'
-}
-
 const CONCURRENT_HTTP_REQUESTS = 4
 
 /**
@@ -29,16 +21,18 @@ class DelegatedContentRouting {
    * Create a new DelegatedContentRouting instance.
    *
    * @param {PeerID} peerId - the id of the node that is using this routing.
-   * @param {object} [api] - (Optional) the api endpoint of the delegated node to use.
+   * @param {object} [client] - an instance of the ipfs-http-client module
    */
-  constructor (peerId, api) {
+  constructor (peerId, client) {
     if (peerId == null) {
       throw new Error('missing self peerId')
     }
 
-    this.api = Object.assign({}, DEFAULT_IPFS_API, api)
-    this.dht = { findProvs: createFindProvs(this.api) }
-    this.refs = createRefs(this.api)
+    if (client == null) {
+      throw new Error('missing ipfs http client')
+    }
+
+    this._client = client
     this.peerId = peerId
 
     // limit concurrency to avoid request flood in web browser
@@ -50,7 +44,14 @@ class DelegatedContentRouting {
     this._httpQueueRefs = new PQueue(Object.assign({}, concurrency, {
       concurrency: 2
     }))
-    log(`enabled DelegatedContentRouting via ${this.api.protocol}://${this.api.host}:${this.api.port}`)
+
+    const {
+      protocol,
+      host,
+      port
+    } = client.getEndpointConfig()
+
+    log(`enabled DelegatedContentRouting via ${protocol}://${host}:${port}`)
   }
 
   /**
@@ -80,7 +81,7 @@ class DelegatedContentRouting {
     try {
       await onStart.promise
 
-      for await (const { id, addrs } of this.dht.findProvs(key, {
+      for await (const { id, addrs } of this._client.dht.findProvs(key, {
         numProviders: options.numProviders,
         timeout: options.timeout
       })) {
@@ -113,7 +114,7 @@ class DelegatedContentRouting {
     const keyString = `${key}`
     log('provide starts:', keyString)
     const results = await this._httpQueueRefs.add(() =>
-      all(this.refs(keyString, { recursive: false }))
+      all(this._client.refs(keyString, { recursive: false }))
     )
     log('provide finished:', keyString, results)
   }

test/index.spec.js

@@ -3,7 +3,8 @@
 
 const { expect } = require('aegir/utils/chai')
 const { createFactory } = require('ipfsd-ctl')
-const { CID } = require('ipfs-http-client')
+const ipfsHttpClient = require('ipfs-http-client')
+const { CID } = ipfsHttpClient
 const PeerId = require('peer-id')
 const all = require('it-all')
 const drain = require('it-drain')
@@ -76,37 +77,27 @@ describe('DelegatedContentRouting', function () {
       expect(() => new DelegatedContentRouting()).to.throw()
     })
 
-    it('should default to https://node0.delegate.ipfs.io as the delegate', () => {
-      const router = new DelegatedContentRouting(selfId)
-
-      expect(router.api).to.include({
-        protocol: 'https',
-        port: 443,
-        host: 'node0.delegate.ipfs.io'
-      })
-    })
-
-    it('should allow for just specifying the host', () => {
-      const router = new DelegatedContentRouting(selfId, {
-        host: 'other.ipfs.io'
-      })
-
-      expect(router.api).to.include({
-        protocol: 'https',
-        port: 443,
-        host: 'other.ipfs.io'
-      })
+    it('should require ipfs http client', () => {
+      expect(() => new DelegatedContentRouting(selfId)).to.throw()
     })
 
-    it('should allow for overriding the api', () => {
-      const api = {
+    it('should accept an http api client instance at construction time', () => {
+      const client = ipfsHttpClient({
         protocol: 'http',
         port: 8000,
         host: 'localhost'
-      }
-      const router = new DelegatedContentRouting(selfId, api)
+      })
+      const router = new DelegatedContentRouting(selfId, client)
+
+      expect(router).to.have.property('_client')
+        .that.has.property('getEndpointConfig')
+        .that.is.a('function')
 
-      expect(router.api).to.include(api)
+      expect(router._client.getEndpointConfig()).to.deep.include({
+        protocol: 'http:',
+        port: '8000',
+        host: 'localhost'
+      })
     })
   })
 
@@ -127,11 +118,11 @@ describe('DelegatedContentRouting', function () {
 
     it('should be able to find providers through the delegate node', async function () {
       const opts = delegateNode.apiAddr.toOptions()
-      const routing = new DelegatedContentRouting(selfId, {
+      const routing = new DelegatedContentRouting(selfId, ipfsHttpClient({
         protocol: 'http',
         port: opts.port,
         host: opts.host
-      })
+      }))
 
       const providers = await all(routing.findProviders(cid, { numProviders: 2 }))
 
@@ -143,11 +134,11 @@ describe('DelegatedContentRouting', function () {
 
     it('should be able to specify a timeout', async () => {
       const opts = delegateNode.apiAddr.toOptions()
-      const routing = new DelegatedContentRouting(selfId, {
+      const routing = new DelegatedContentRouting(selfId, ipfsHttpClient({
         protocol: 'http',
         port: opts.port,
         host: opts.host
-      })
+      }))
 
       const providers = await all(routing.findProviders(cid, { numProviders: 2, timeout: 5e3 }))
 
@@ -158,11 +149,11 @@ describe('DelegatedContentRouting', function () {
   describe('provide', () => {
     it('should be able to register as a content provider to the delegate node', async () => {
       const opts = delegateNode.apiAddr.toOptions()
-      const contentRouter = new DelegatedContentRouting(selfId, {
+      const contentRouter = new DelegatedContentRouting(selfId, ipfsHttpClient({
         protocol: 'http',
         port: opts.port,
         host: opts.host
-      })
+      }))
 
       const { cid } = await selfNode.api.add(uint8ArrayFromString(`hello-${Math.random()}`))