deps!: update delegated routing client (#937)

BREAKING CHANGE: pass the endpoint URL to the delegated routing router  as a `url` property of an init object

Author: achingbrain

packages/interop/src/ipns-http.spec.ts

@@ -25,7 +25,9 @@ describe('@helia/ipns - http', () => {
     kubo = await createKuboNode()
     helia = await createHeliaHTTP({
       routers: [
-        delegatedHTTPRouting('http://127.0.0.1:8180')
+        delegatedHTTPRouting({
+          url: 'http://127.0.0.1:8180'
+        })
       ]
     })
     name = ipns(helia)

packages/routers/package.json

@@ -47,10 +47,9 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@helia/delegated-routing-v1-http-api-client": "^5.1.2",
+    "@helia/delegated-routing-v1-http-api-client": "^6.0.0",
     "@helia/interface": "^6.0.2",
     "@libp2p/interface": "^3.1.0",
-    "@libp2p/logger": "^6.2.0",
     "@libp2p/peer-id": "^6.0.3",
     "@multiformats/uri-to-multiaddr": "^10.0.0",
     "ipns": "^10.1.2",
@@ -61,6 +60,7 @@
   },
   "devDependencies": {
     "@libp2p/crypto": "^5.1.12",
+    "@libp2p/logger": "^6.2.0",
     "aegir": "^47.0.22",
     "it-all": "^3.0.9",
     "it-drain": "^3.0.10",

packages/routers/src/delegated-http-routing.ts

@@ -1,6 +1,5 @@
 import { delegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
 import { NotFoundError } from '@libp2p/interface'
-import { defaultLogger } from '@libp2p/logger'
 import { marshalIPNSRecord, multihashFromIPNSRoutingKey, unmarshalIPNSRecord } from 'ipns'
 import first from 'it-first'
 import map from 'it-map'
@@ -22,7 +21,7 @@ function isIPNSKey (key: Uint8Array): boolean {
 class DelegatedHTTPRouter implements Routing {
   private readonly client: DelegatedRoutingV1HttpApiClient
 
-  constructor (components: DelegatedRoutingV1HttpApiClientComponents, init: DelegatedRoutingV1HttpApiClientInit & { url: string | URL }) {
+  constructor (components: DelegatedRoutingV1HttpApiClientComponents, init: DelegatedRoutingV1HttpApiClientInit) {
     this.client = delegatedRoutingV1HttpApiClient(init)(components)
   }
 
@@ -105,24 +104,6 @@ class DelegatedHTTPRouter implements Routing {
 /**
  * Creates a Helia Router that connects to an endpoint that supports the [Delegated Routing V1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/) spec.
  */
-export function delegatedHTTPRouting (init: DelegatedRoutingV1HttpApiClientInit & { url: string | URL }): (components: any) => Routing
-/**
- * @deprecated Use `delegatedHTTPRouting(init)` instead
- */
-export function delegatedHTTPRouting (url: string | URL, init?: DelegatedRoutingV1HttpApiClientInit): Routing
-export function delegatedHTTPRouting (url: string | URL | (DelegatedRoutingV1HttpApiClientInit & { url: string | URL }), init?: DelegatedRoutingV1HttpApiClientInit): Routing | ((components: any) => Routing) {
-  if (typeof url === 'string' || url instanceof URL) {
-    return new DelegatedHTTPRouter({
-      logger: defaultLogger()
-    }, {
-      ...delegatedHTTPRoutingDefaults(),
-      ...init,
-      url: new URL(url)
-    })
-  }
-
-  return (components: any) => new DelegatedHTTPRouter(components, {
-    ...delegatedHTTPRoutingDefaults(),
-    ...url
-  })
+export function delegatedHTTPRouting (init: DelegatedRoutingV1HttpApiClientInit): (components: any) => Routing {
+  return (components: any) => new DelegatedHTTPRouter(components, delegatedHTTPRoutingDefaults(init))
 }

packages/routers/src/utils/delegated-http-routing-defaults.browser.ts

@@ -1,6 +1,6 @@
 import type { DelegatedRoutingV1HttpApiClientInit } from '@helia/delegated-routing-v1-http-api-client'
 
-export function delegatedHTTPRoutingDefaults (init?: DelegatedRoutingV1HttpApiClientInit): DelegatedRoutingV1HttpApiClientInit & { url: string } {
+export function delegatedHTTPRoutingDefaults (init?: DelegatedRoutingV1HttpApiClientInit): DelegatedRoutingV1HttpApiClientInit {
   return {
     url: 'https://delegated-ipfs.dev',
     filterProtocols: ['unknown', 'transport-bitswap', 'transport-ipfs-gateway-http'],

packages/routers/src/utils/delegated-http-routing-defaults.ts

@@ -1,6 +1,6 @@
 import type { DelegatedRoutingV1HttpApiClientInit } from '@helia/delegated-routing-v1-http-api-client'
 
-export function delegatedHTTPRoutingDefaults (init?: DelegatedRoutingV1HttpApiClientInit): DelegatedRoutingV1HttpApiClientInit & { url: string } {
+export function delegatedHTTPRoutingDefaults (init?: DelegatedRoutingV1HttpApiClientInit): DelegatedRoutingV1HttpApiClientInit {
   return {
     url: 'https://delegated-ipfs.dev',
     filterProtocols: ['unknown', 'transport-bitswap', 'transport-ipfs-gateway-http'],

packages/routers/test/delegated-http-routing.spec.ts

@@ -1,4 +1,5 @@
 import { generateKeyPair } from '@libp2p/crypto/keys'
+import { defaultLogger } from '@libp2p/logger'
 import { peerIdFromString } from '@libp2p/peer-id'
 import { expect } from 'aegir/chai'
 import { multihashToIPNSRoutingKey, createIPNSRecord, marshalIPNSRecord } from 'ipns'
@@ -17,7 +18,11 @@ describe('delegated-http-routing', () => {
   beforeEach(() => {
     client = stubInterface<DelegatedRoutingV1HttpApiClient>()
 
-    router = delegatedHTTPRouting('http://127.0.0.1')
+    router = delegatedHTTPRouting({
+      url: 'http://127.0.0.1'
+    })({
+      logger: defaultLogger()
+    })
     // @ts-expect-error private field
     router.client = client
   })