IPIP-0388: Routing HTTP API Support for Querying Multiple Routers #388
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # IPIP-0388: Routing HTTP API Support for Querying Multiple Routers | ||
|
|
||
| <!-- IPIP number should match its pull request number. After you open a PR, | ||
| please update title and include an abbreviated title in the filename too: | ||
| `0000-draft-title-abbrev.md`. --> | ||
|
|
||
| - Start Date: 2023-03-20 | ||
| - Related Issues: | ||
| - https://github.com/ipfs-shipyard/someguy/issues/12 | ||
| - https://github.com/ipfs-shipyard/someguy/issues/13 | ||
| - https://github.com/ipfs/bifrost-gateway/issues/151 | ||
|
|
||
| ## Summary | ||
|
|
||
| Adding support for querying individual routers to a single Routing v1 HTTP endpoint. | ||
|
|
||
| ## Motivation | ||
|
|
||
| At the moment there is no way for a Routing v1 client to ask for a specific routing backend to be used nor for a Routing v1 endpoint to signal what routing backends they support. When Routing v1 is used as a proxy for one or more routing systems (e.g. IPFS Public DHT, IPNI, mainlineDHT, ...) clients may want to be able to judge a given endpoint's suitability to be a proxy for that routing system. | ||
|
|
||
| For instance if all-the-routers.alice.tld is very good at proxying IPNI requests but bad at proxying IPFS Public DHT requests, but dht-proxy.bob.tld is good at proxying IPFS Public DHT requests. In this scenario clients wanting good responses would have to ask both Alice and Bob to do DHT lookups for them even though Alice's DHT lookups are unneccessary because Bob is doing them. Similarly, clients could evaluate the best endpoint to request responses from since they can now do comparisons between largely equivalent routing systems. Additionally, this allows clients to discover the data sources behind Routing v1 endpoints without as much out of band information. | ||
|
|
||
| ## Detailed design | ||
|
|
||
| AKA Solution Proposal | ||
|
|
||
| The proposal is to: | ||
| 1. Add a `?routing=<list-of-routers>` optional parameter to `GET /routing/v1/providers/{CID}` that indicates which routing systems to use | ||
| 2. Add an `OPTIONS /routing/v1/providers` endpoint which when queried may respond with a `Ipfs-Supported-Routers` HTTP header, with the value as the comma separated list of the routing systems supported | ||
|
|
||
| ## Design rationale | ||
|
|
||
| The rationale fleshes out the specification by describing what motivated | ||
| the design and why particular design decisions were made. | ||
|
|
||
| Provide evidence of rough consensus and working code within the community, | ||
| and discuss important objections or concerns raised during discussion. | ||
|
|
||
| ### User benefit | ||
|
|
||
| End users will be able to query endpoints that provide proxies for multiple routing systems (e.g. cid.contact/routing/v1) and get back DHT, IPNI or both depending on what they need. | ||
|
|
||
| For users that are running a DHT client locally they can dynamically evaluate if cid.contact's DHT proxy is either good enough that they can conserve their local resources by reducing how they use their client. Similarly, if they discover that their local DHT results are better than cid.contact's DHT proxy then they can ease the burden on cid.contact by only requesting IPNI results and doing the DHT lookups themselves. | ||
|
|
||
| ### Compatibility | ||
|
|
||
| This should not effect existing clients or servers | ||
|
|
||
| ### Security | ||
|
|
||
| Mostly not applicable. However, clients should not expect proxies to give 1:1 mappings with the underlying systems if they are too expensive and should consider that when evaluating the performance of individual endpoints. | ||
|
|
||
| ### Alternatives | ||
|
|
||
| - Having clients fetch from multiple sources which may have overlapping data -> lots of work on servers and extra processing work for clients | ||
| - Having clients fetch from a single source with the best data -> is not friendly to the introduction of new services and may result in less data being retrieved | ||
| - Having servers restrict to one endpoint per router (e.g. dht.alice.tld and ipni.alice.tld or alice.tld/dht/routing/v1 and alice.tld/ipni/routing/v1) -> also doable, but discoverability of new router types would require other semantics (e.g. an OPTIONS request to alice.tld/routing/v1) | ||
| - Having `OPTIONS` on `/routing/v1` instead of `/routing/v1/providers` -> also good, perhaps a better choice. given that not every router will support every request type there's a tradeoff around how low level you put the `OPTIONS`. In theory both could be supported. | ||
| - Having `OPTIONS` on `/routing/v1/providers/{CID}` in the event the CID tells you some information about which providers to use (e.g. for non-BitTorrent codecs don't use mainline DHT) -> also doable. Unclear if this would be useful in practice since sometimes the codec information will get lost (e.g. replaced with the raw/0x55 codec). | ||
|
|
||
| ### Copyright | ||
|
|
||
| Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some quick thoughts:
curl -X OPTIONS, JS may need explicit entry in Access-Control-Expose-Headers for the value to be readable via JS.GETand return them as JSON.Alternative idea just to see if it resonates better:
Request:
GET /routing/v1/routers(dedicated endpoint)Response: JSON with list of items following
routerschema{ "Schema": "router", "Name": "ipfs-public-dht", "Default": false, // is it used when `?routers` is not passed "RoutingType": ["providers", "ipns", "peers"], // where can it be used "Details": { .. } // optional opaque JSON with router-type-specific values }There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rebased this IPIP on top of latest spec, and replaced OPTIONS with
GET /routing/v1/routersand arouterschema above.