fix!: remove @libp2p/components

`@libp2p/components` is a choke-point for our dependency graph as it depends on every interface, meaning when one interface revs a major `@libp2p/components` major has to
change too which means every module depending on it also needs a major.

Switch instead to constructor injection of simple objects that let modules declare their dependencies on interfaces directly instead of indirectly via `@libp2p/components`

Refs libp2p/js-libp2p-components#6

BREAKING CHANGE: modules no longer implement `Initializable` instead switching to constructor injection

Author: achingbrain

package.json

@@ -143,18 +143,20 @@
     "any-signal": "^3.0.1",
     "err-code": "^3.0.1",
     "it-drain": "^1.0.5",
+    "multiformats": "^10.0.0",
     "p-defer": "^4.0.0",
     "p-queue": "^7.2.0"
   },
   "devDependencies": {
     "aegir": "^37.5.3",
-    "go-ipfs": "^0.15.0",
+    "go-ipfs": "^0.16.0",
     "ipfs-core-types": "^0.12.0",
     "ipfs-http-client": "^58.0.0",
     "ipfsd-ctl": "^12.0.2",
     "it-all": "^1.0.6",
     "it-drain": "^1.0.5",
-    "uint8arrays": "^3.0.0",
+    "timeout-abort-controller": "^3.0.0",
+    "uint8arrays": "^4.0.2",
     "wherearewe": "^2.0.1"
   },
   "browser": {

src/index.ts

@@ -4,11 +4,13 @@ import PQueue from 'p-queue'
 import defer from 'p-defer'
 import errCode from 'err-code'
 import anySignal from 'any-signal'
-import type { IPFSHTTPClient, CID, HTTPClientExtraOptions } from 'ipfs-http-client'
+import { CID as IPFSCCID } from 'ipfs-http-client'
+import type { IPFSHTTPClient, HTTPClientExtraOptions } from 'ipfs-http-client'
 import type { AbortOptions } from 'ipfs-core-types/src/utils'
 import type { ContentRouting } from '@libp2p/interface-content-routing'
 import type { PeerInfo } from '@libp2p/interface-peer-info'
 import type { Startable } from '@libp2p/interfaces/startable'
+import type { CID } from 'multiformats/cid'
 
 const log = logger('libp2p:delegated-content-routing')
 
@@ -19,7 +21,7 @@ const CONCURRENT_HTTP_REFS_REQUESTS = 2
 /**
  * An implementation of content routing, using a delegated peer
  */
-export class DelegatedContentRouting implements ContentRouting, Startable {
+class DelegatedContentRouting implements ContentRouting, Startable {
   private readonly client: IPFSHTTPClient
   private readonly httpQueue: PQueue
   private readonly httpQueueRefs: PQueue
@@ -95,7 +97,10 @@ export class DelegatedContentRouting implements ContentRouting, Startable {
     try {
       await onStart.promise
 
-      for await (const event of this.client.dht.findProvs(key, options)) {
+      // can be removed after ipfs ships with [email protected]
+      const ipfsCid = IPFSCCID.parse(key.toString())
+
+      for await (const event of this.client.dht.findProvs(ipfsCid, options)) {
         if (event.name === 'PROVIDER') {
           yield * event.providers.map(prov => {
             const peerInfo: PeerInfo = {
@@ -134,9 +139,12 @@ export class DelegatedContentRouting implements ContentRouting, Startable {
     options.timeout = options.timeout ?? DEFAULT_TIMEOUT
     options.signal = anySignal([this.abortController.signal].concat((options.signal != null) ? [options.signal] : []))
 
+    // can be removed after ipfs ships with [email protected]
+    const ipfsCid = IPFSCCID.parse(key.toString())
+
     await this.httpQueueRefs.add(async () => {
-      await this.client.block.stat(key, options)
-      await drain(this.client.dht.provide(key, options))
+      await this.client.block.stat(ipfsCid, options)
+      await drain(this.client.dht.provide(ipfsCid, options))
     })
     log('provide finished: %c', key)
   }
@@ -180,3 +188,7 @@ export class DelegatedContentRouting implements ContentRouting, Startable {
     })
   }
 }
+
+export function delegatedContentRouting (client: IPFSHTTPClient): (components?: any) => ContentRouting {
+  return () => new DelegatedContentRouting(client)
+}

test/index.spec.ts

@@ -2,18 +2,21 @@
 
 import { expect } from 'aegir/chai'
 import { Controller, createFactory } from 'ipfsd-ctl'
-import { create, CID } from 'ipfs-http-client'
+import { create, CID as IPFSCCID } from 'ipfs-http-client'
 import all from 'it-all'
 import drain from 'it-drain'
 import { isElectronMain, isNode } from 'wherearewe'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
-import { DelegatedContentRouting } from '../src/index.js'
+import { delegatedContentRouting } from '../src/index.js'
 // @ts-expect-error no types
 import goIpfs from 'go-ipfs'
 import pDefer from 'p-defer'
+import { CID } from 'multiformats/cid'
 import type { PeerId } from '@libp2p/interface-peer-id'
 import type { IDResult } from 'ipfs-core-types/src/root'
 import type { PeerInfo } from '@libp2p/interface-peer-info'
+import { stop } from '@libp2p/interfaces/startable'
+import { TimeoutController } from 'timeout-abort-controller'
 
 const factory = createFactory({
   type: 'go',
@@ -78,7 +81,7 @@ describe('DelegatedContentRouting', function () {
   describe('create', () => {
     it('should require ipfs http client', () => {
       // @ts-expect-error missing parameters
-      expect(() => new DelegatedContentRouting()).to.throw()
+      expect(() => delegatedContentRouting()()).to.throw()
     })
 
     it('should accept an http api client instance at construction time', () => {
@@ -87,7 +90,7 @@ describe('DelegatedContentRouting', function () {
         port: 8000,
         host: 'localhost'
       })
-      const router = new DelegatedContentRouting(client)
+      const router = delegatedContentRouting(client)()
 
       expect(router).to.have.property('client')
         .that.has.property('getEndpointConfig')
@@ -103,7 +106,7 @@ describe('DelegatedContentRouting', function () {
 
   describe('findProviders', () => {
     const data = uint8ArrayFromString('some data')
-    const cid = CID.parse('QmVv4Wz46JaZJeH5PMV4LGbRiiMKEmszPYY3g6fjGnVXBS') // 'some data'
+    const cid = IPFSCCID.parse('QmVv4Wz46JaZJeH5PMV4LGbRiiMKEmszPYY3g6fjGnVXBS') // 'some data'
 
     before('register providers', async () => {
       await Promise.all([
@@ -118,13 +121,13 @@ 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(create({
+      const routing = delegatedContentRouting(create({
         protocol: 'http',
         port: opts.port,
         host: opts.host
-      }))
+      }))()
 
-      const providers = await all(routing.findProviders(cid))
+      const providers = await all(routing.findProviders(CID.parse(cid.toString())))
 
       // We should get the bootstrap node as provider
       // The delegate node is not included, because it is handling the requests
@@ -134,30 +137,33 @@ describe('DelegatedContentRouting', function () {
 
     it('should be able to specify a timeout', async () => {
       const opts = delegateNode.apiAddr.toOptions()
-      const routing = new DelegatedContentRouting(create({
+      const routing = delegatedContentRouting(create({
         protocol: 'http',
         port: opts.port,
         host: opts.host
-      }))
+      }))()
+      const controller = new TimeoutController(5e3)
 
-      const providers = await all(routing.findProviders(cid, { timeout: 5e3 }))
+      const providers = await all(routing.findProviders(CID.parse(cid.toString()), { signal: controller.signal }))
 
       expect(providers.map((p) => p.id.toString())).to.include(bootstrapId.id.toString(), 'Did not include bootstrap node')
+
+      controller.clear()
     })
   })
 
   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(create({
+      const contentRouter = delegatedContentRouting(create({
         protocol: 'http',
         port: opts.port,
         host: opts.host
-      }))
+      }))()
 
       const { cid } = await selfNode.api.add(uint8ArrayFromString(`hello-${Math.random()}`))
 
-      await contentRouter.provide(cid)
+      await contentRouter.provide(CID.parse(cid.toString()))
 
       const providers: PeerInfo[] = []
 
@@ -173,18 +179,18 @@ describe('DelegatedContentRouting', function () {
 
     it('should provide non-dag-pb nodes via the delegate node', async () => {
       const opts = delegateNode.apiAddr.toOptions()
-      const contentRouter = new DelegatedContentRouting(create({
+      const contentRouter = delegatedContentRouting(create({
         protocol: 'http',
         port: opts.port,
         host: opts.host
-      }))
+      }))()
 
       const cid = await selfNode.api.dag.put(`hello-${Math.random()}`, {
         storeCodec: 'dag-cbor',
         hashAlg: 'sha2-256'
       })
 
-      await contentRouter.provide(cid)
+      await contentRouter.provide(CID.parse(cid.toString()))
 
       const providers: PeerInfo[] = []
 
@@ -202,11 +208,11 @@ describe('DelegatedContentRouting', function () {
   describe('get', () => {
     it('should get a value', async () => {
       const opts = delegateNode.apiAddr.toOptions()
-      const contentRouter = new DelegatedContentRouting(create({
+      const contentRouter = delegatedContentRouting(create({
         protocol: 'http',
         port: opts.port,
         host: opts.host
-      }))
+      }))()
 
       const cid = await selfNode.api.dag.put(`hello-${Math.random()}`, {
         storeCodec: 'dag-cbor',
@@ -224,11 +230,11 @@ describe('DelegatedContentRouting', function () {
   describe('put', () => {
     it('should put a value', async () => {
       const opts = delegateNode.apiAddr.toOptions()
-      const contentRouter = new DelegatedContentRouting(create({
+      const contentRouter = delegatedContentRouting(create({
         protocol: 'http',
         port: opts.port,
         host: opts.host
-      }))
+      }))()
 
       const cid = await selfNode.api.dag.put(`hello-${Math.random()}`, {
         storeCodec: 'dag-cbor',
@@ -259,11 +265,11 @@ describe('DelegatedContentRouting', function () {
   describe('stop', () => {
     it('should cancel in-flight requests when stopping', async () => {
       const opts = delegateNode.apiAddr.toOptions()
-      const contentRouter = new DelegatedContentRouting(create({
+      const contentRouter = delegatedContentRouting(create({
         protocol: 'http',
         port: opts.port,
         host: opts.host
-      }))
+      }))()
 
       const deferred = pDefer<Error>()
       // non-existent CID
@@ -277,7 +283,7 @@ describe('DelegatedContentRouting', function () {
           deferred.resolve(err)
         })
 
-      await contentRouter.stop()
+      await stop(contentRouter)
       await expect(deferred.promise).to.eventually.have.property('message').that.matches(/aborted/)
     })
   })