fix!: remove @libp2p/components (#194)

`@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

.aegir.cjs

@@ -9,7 +9,7 @@ process.on('beforeExit', (code) => process.exit(code))
 const ECHO_PROTOCOL = '/echo/1.0.0'
 
 async function before () {
-  const { WebRTCDirect } = await import('./dist/src/index.js')
+  const { webRTCDirect } = await import('./dist/src/index.js')
   const { pipe } = await import('it-pipe')
   const { multiaddr } = await import('@multiformats/multiaddr')
   const { mockUpgrader, mockRegistrar } = await import('@libp2p/interface-mocks')
@@ -28,9 +28,9 @@ async function before () {
     registrar
   })
 
-  const wd = new WebRTCDirect({
+  const wd = webRTCDirect({
     wrtc
-  })
+  })()
 
   const listeners = await Promise.all(
     [REMOTE_MULTIADDR_IP4, REMOTE_MULTIADDR_IP6].map(async ma => {

README.md

@@ -33,55 +33,19 @@ $ npm i @libp2p/webrtc-direct
 ## Usage
 
 ```js
-import { WebRTCDirect } from '@libp2p/webrtc-direct'
-import { multiaddr } from '@multiformats/multiaddr'
-import { pipe } from 'it-pipe'
-import all from 'it-all'
-
-const ECHO_PROTOCOL = '/echo/1.0.0'
-const addr = multiaddr('/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct')
-const webRTCDirect = new WebRTCDirect()
-
-const listener = webRTCDirect.createListener({
-  handler: (connection) => {
-    console.log('new connection opened')
-
-    connection.newStream([ECHO_PROTOCOL])
-      .then(({ stream }) => {
-        void pipe(stream, stream)
-      })
-  },
-  upgrader
+import { createLibp2pNode } from 'libp2p'
+import { webRTCDirect } from '@libp2p/webrtc-direct'
+
+const node = await createLibp2p({
+  transports: [
+    webRTCDirect()
+  ]
+  //... other config
 })
-
-await listener.listen(addr)
-console.log('listening')
-
-const connection = await webRTCDirect.dial(addr, {
-  upgrader
-})
-const { stream } = await connection.newStream([ECHO_PROTOCOL])
-const values = await pipe(
-  [uint8arrayFromString('hello')],
-  stream,
-  (source) => all(source)
-)
-console.log(`Value: ${uint8ArrayToString(values[0])}`)
-
-// Close connection after reading
-await listener.close()
+await node.start()
+await node.dial('/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct')
 ```
 
-Outputs:
-
-```sh
-listening
-new connection opened
-Value: hello
-```
-
-Note that it may take some time for the connection to be established.
-
 ## API
 
 ### Transport

package.json

@@ -148,16 +148,16 @@
     "@multiformats/multiaddr": "^11.0.0",
     "abortable-iterator": "^4.0.2",
     "err-code": "^3.0.0",
-    "multiformats": "^9.4.5",
+    "multiformats": "^10.0.0",
     "native-fetch": "^4.0.2",
     "p-event": "^5.0.1",
-    "uint8arrays": "^3.0.0",
+    "uint8arrays": "^4.0.2",
     "undici": "^5.2.0",
     "wherearewe": "^2.0.1"
   },
   "devDependencies": {
-    "@libp2p/interface-mocks": "^6.0.1",
-    "@libp2p/interface-transport-compliance-tests": "^2.0.6",
+    "@libp2p/interface-mocks": "^7.0.1",
+    "@libp2p/interface-transport-compliance-tests": "^3.0.0",
     "@mapbox/node-pre-gyp": "^1.0.8",
     "aegir": "^37.5.3",
     "it-all": "^1.0.6",

src/index.ts

@@ -21,7 +21,7 @@ export interface WebRTCDirectInit {
   recieverOptions?: WebRTCReceiverInit
 }
 
-export class WebRTCDirect implements Transport {
+class WebRTCDirect implements Transport {
   private readonly initiatorOptions?: WebRTCInitiatorInit
   private readonly recieverOptions?: WebRTCReceiverInit
   public wrtc?: WRTC
@@ -198,3 +198,7 @@ export class WebRTCDirect implements Transport {
     })
   }
 }
+
+export function webRTCDirect (init: WebRTCDirectInit = {}): () => Transport {
+  return () => new WebRTCDirect(init)
+}

test/browser.ts

@@ -1,11 +1,11 @@
 
 import listenTests from './listen.js'
 import dialTests from './dial.js'
-import { WebRTCDirect } from '../src/index.js'
+import { webRTCDirect } from '../src/index.js'
 
 describe('browser RTC', () => {
   const create = async () => {
-    const ws = new WebRTCDirect()
+    const ws = webRTCDirect()()
 
     return ws
   }

test/compliance.ts

@@ -1,10 +1,10 @@
 /* eslint-env mocha */
 
+import type { Transport } from '@libp2p/interface-transport'
 import tests from '@libp2p/interface-transport-compliance-tests'
 import { multiaddr } from '@multiformats/multiaddr'
-import type { WebRTCDirect } from '../src/index.js'
 
-export default (create: () => Promise<WebRTCDirect>) => {
+export default (create: () => Promise<Transport>) => {
   describe('interface-transport compliance', function () {
     this.timeout(20 * 1000)
 

test/dial.ts

@@ -6,8 +6,7 @@ import { pipe } from 'it-pipe'
 import all from 'it-all'
 import { fromString } from 'uint8arrays/from-string'
 import { mockRegistrar, mockUpgrader } from '@libp2p/interface-mocks'
-import type { WebRTCDirect } from '../src/index.js'
-import type { Upgrader } from '@libp2p/interface-transport'
+import type { Transport, Upgrader } from '@libp2p/interface-transport'
 import type { Uint8ArrayList } from 'uint8arraylist'
 import type { Source } from 'it-stream-types'
 
@@ -22,7 +21,7 @@ async function * toBytes (source: Source<Uint8ArrayList>) {
   }
 }
 
-export default (create: () => Promise<WebRTCDirect>) => {
+export default (create: () => Promise<Transport>) => {
   describe('dial', function () {
     this.timeout(20 * 1000)
 

test/filter.spec.ts

@@ -2,11 +2,11 @@
 
 import { expect } from 'aegir/chai'
 import { multiaddr } from '@multiformats/multiaddr'
-import { WebRTCDirect } from '../src/index.js'
+import { webRTCDirect } from '../src/index.js'
 
 describe('filter', () => {
   it('filters non valid webrtc-direct multiaddrs', () => {
-    const wd = new WebRTCDirect()
+    const wd = webRTCDirect()()
     const maArr = [
       multiaddr('/ip4/1.2.3.4/tcp/3456/http/p2p-webrtc-direct'),
       multiaddr('/ip4/127.0.0.1/tcp/9090/ws'),
@@ -21,7 +21,7 @@ describe('filter', () => {
   })
 
   it('filter a single addr for this transport', () => {
-    const wd = new WebRTCDirect()
+    const wd = webRTCDirect()()
     const ma = multiaddr('/ip4/127.0.0.1/tcp/9090/http/p2p-webrtc-direct')
 
     const filtered = wd.filter([ma])

test/instance.spec.ts

@@ -1,18 +1,12 @@
 /* eslint-env mocha */
 
 import { expect } from 'aegir/chai'
-import { WebRTCDirect } from '../src/index.js'
+import { webRTCDirect } from '../src/index.js'
 
 describe('instances', () => {
   it('create', (done) => {
-    const wdirect = new WebRTCDirect()
+    const wdirect = webRTCDirect()()
     expect(wdirect).to.exist()
     done()
   })
-
-  it('create without new throws', (done) => {
-    // @ts-expect-error need new keyword
-    expect(() => WebRTCDirect()).to.throw()
-    done()
-  })
 })

test/listen.ts

@@ -4,21 +4,21 @@ import { expect } from 'aegir/chai'
 import { multiaddr } from '@multiformats/multiaddr'
 import { mockRegistrar, mockUpgrader } from '@libp2p/interface-mocks'
 import { isBrowser } from 'wherearewe'
-import type { WebRTCDirect } from '../src/index.js'
 import { pipe } from 'it-pipe'
 import { pEvent } from 'p-event'
+import type { Transport } from '@libp2p/interface-transport'
 
 const ECHO_PROTOCOL = '/echo/1.0.0'
 
-export default (create: () => Promise<WebRTCDirect>) => {
+export default (create: () => Promise<Transport>) => {
   describe('listen', function () {
     this.timeout(20 * 1000)
 
     if (isBrowser) {
       return
     }
 
-    let wd: WebRTCDirect
+    let wd: Transport
 
     const ma = multiaddr('/ip4/127.0.0.1/tcp/20123/http/p2p-webrtc-direct')
 

test/node.ts

@@ -4,17 +4,17 @@ import complianceTests from './compliance.js'
 import dialTests from './dial.js'
 // @ts-expect-error no types
 import wrtc from 'wrtc'
-import { WebRTCDirect } from '../src/index.js'
+import { webRTCDirect } from '../src/index.js'
 
 // TODO: Temporary fix per wrtc issue
 // https://github.com/node-webrtc/node-webrtc/issues/636#issuecomment-774171409
 process.on('beforeExit', (code) => process.exit(code))
 
 describe('transport: with wrtc', () => {
   const create = async () => {
-    const ws = new WebRTCDirect({
+    const ws = webRTCDirect({
       wrtc
-    })
+    })()
 
     return ws
   }