feat(gateway): expose /routing/v1 server (opt-in) #9877

hacdias · 2023-05-12T13:16:04Z

Summary

This PR adds ability to expose Kubo's routing system as /routing/v1 on the gateway port.
This feature is disabled by default, requires opt-in via config (Gateway.ExposeRoutingAPI=true).

Closes #9875. Uses boxo/routing/http/server to implement the Routing v1 HTTP server in Kubo.

Details

core/corehttp/routing.go

lidel

Feedback after first pass, mainly ensuring we support legacy schemas, and avoid re-implementing PUTs in near future. Details inline.

docs/changelogs/v0.23.md

docs/config.md

test/cli/routing_http_test.go

test/cli/delegated_routing_http_test.go

test/cli/routing_http_test.go

routing/delegated.go

core/corehttp/routing.go

hacdias · 2023-08-25T10:22:52Z

@lidel I had completely missed the part of your comment on renaming get-ipns and put-ipns in the router configuration to find-ipns and provide-ipns. I do think we should solve this.

Get and Put for IPNS are historically related to it adhering to the routing API which uses routing.ValueStore, which uses Get/Put names in the code. At the same time, peer and providers have been called find and provide in other parts of the code. Therefore, that could be more consistent with remaining code, but not with the other methods of the routing v1.

I’m up to either:

Change Kubo to find-ipns and provide-ipns; or
Change Boxo to keep GetIPNS and PutIPNS - more consistent with Libp2p stack naming.

What do you think?

lidel · 2023-08-25T11:28:00Z

@hacdias I'm leaning towards (2): keeping get-ipns and put-ipns in Kubo config and renaming to GetIPNS and PutIPNS here because

it seem to make smaller waves (we don't change Kubo, do we dont break existing config examples other people published)
the API in this PR does not return iterator, but record, so naming it "get/put" is ok

(Apologies for flip-flopping this so many times, not familiar with naming conventions here as much as I would like to, but (2) seems to make most sense given the information we have now)

hacdias · 2023-08-25T11:33:20Z

@lidel agreed. Done both in Boxo and here. I think #9877 (comment) is the only missing thing to decide on to be able to merge Boxo and then this one.

test/cli/delegated_routing_v1_http_proxy_test.go

lidel · 2023-08-25T12:52:08Z

cmd/ipfs/daemon.go

+	if cfg.Gateway.ExposeRoutingAPI.WithDefault(config.DefaultExposeRoutingAPI) {
+		for _, listener := range listeners {
+			fmt.Printf("Routing V1 API exposed at http://%s/routing/v1\n", listener.Addr())
+		}
+	}


ℹ️ we do this for WebUI URL, would not hurt here – makes it easy for user to eyeball if it is enabled, and copy URL for testing.

core/corehttp/routing.go

Co-authored-by: Marcin Rataj <[email protected]>

we do this for webui, would not hurt here

addressed

lidel

Thank you for including end-to-end in test/cli/delegated_routing_v1_http_proxy_test.go 👍

Since this is opt-in via Gateway.ExposeRoutingAPI, I think its good enough for giving it a try in Kubo 0.23

hacdias self-assigned this May 12, 2023

hacdias mentioned this pull request May 12, 2023

feat: pass records limit on routing.FindProviders ipfs/boxo#299

Merged

hacdias force-pushed the issue/9875 branch 3 times, most recently from bf22d94 to 562d7f3 Compare May 15, 2023 09:02

hacdias commented May 15, 2023

View reviewed changes

core/corehttp/routing.go Outdated Show resolved Hide resolved

hacdias force-pushed the issue/9875 branch from 562d7f3 to e57dd07 Compare May 15, 2023 11:00

hacdias marked this pull request as ready for review May 15, 2023 11:56

hacdias requested review from lidel and a team as code owners May 15, 2023 11:56

lidel reviewed May 23, 2023

View reviewed changes

core/corehttp/routing.go Outdated Show resolved Hide resolved

hacdias force-pushed the issue/9875 branch 2 times, most recently from 5cec615 to a01c4f0 Compare May 29, 2023 08:08

hacdias mentioned this pull request May 29, 2023

IPIP-417: Delegated Peer Routing HTTP API ipfs/specs#417

Merged

lidel mentioned this pull request Jun 1, 2023

HTTP Router only uses Addresses.Swarm #9823

Closed

3 tasks

hacdias force-pushed the issue/9875 branch 6 times, most recently from 0805ab6 to 5627805 Compare August 8, 2023 14:24

hacdias mentioned this pull request Aug 8, 2023

feat(routing/http)!: delegated peer routing server and client, IPIP 417 ipfs/boxo#422

Merged

5 tasks

hacdias force-pushed the issue/9875 branch from 5627805 to 14b4112 Compare August 8, 2023 14:41

hacdias requested a review from lidel August 8, 2023 14:41

hacdias force-pushed the issue/9875 branch from 14b4112 to 4856ce3 Compare August 9, 2023 09:35

TorfinnOlsen mentioned this pull request Aug 9, 2023

Providers support a routers 'all' flag for IPIP-0388 ipni/storetheindex#2215

Open

hacdias force-pushed the issue/9875 branch from 4856ce3 to 03dd364 Compare August 15, 2023 10:12

lidel changed the title ~~feat(gateway): expose routing v1 server via optional setting~~ feat(gateway): expose /routing/v1 server (opt-in) Aug 21, 2023

lidel mentioned this pull request Aug 22, 2023

feat(routing/http): delegated IPNS server and client, IPIP 379 ipfs/boxo#333

Merged

3 tasks

lidel requested changes Aug 22, 2023

View reviewed changes

hacdias force-pushed the issue/9875 branch from 6377f33 to 2a0d04e Compare August 25, 2023 10:20

hacdias commented Aug 25, 2023

View reviewed changes

core/corehttp/routing.go Outdated Show resolved Hide resolved

hacdias requested a review from lidel August 25, 2023 10:49

lidel reviewed Aug 25, 2023

View reviewed changes

test/cli/delegated_routing_v1_http_proxy_test.go Show resolved Hide resolved

lidel reviewed Aug 25, 2023

View reviewed changes

core/corehttp/routing.go Show resolved Hide resolved

hacdias and others added 13 commits August 25, 2023 16:55

feat: expose routing v1 server via optional setting

d65b8ab

feat: re-add deprecated schema bitswap to ensure compatibility

19af511

refactor: restore PUT code, but keep not supporting

5ab1ec7

chore: apply feedback suggestions

82e6ae5

Co-authored-by: Marcin Rataj <[email protected]>

feat: e2e tests, remove .SearchValue override

833823c

refactor: rename Find/ProvideIPNS to Get/PutIPNS

c658c6c

fix: ensure tests don't "collide" with each other

6e57511

chore: bump boxo, do not force bitswap

9310e26

chore: revert gateway names

07f3000

fix: disable mdns in routing v1 test

abeeb59

fix: disable mdns in routing v1 test

030ee4b

feat: print routing v1 url

997a3d3

we do this for webui, would not hurt here

chore: bump boxo

5fb2d5e

hacdias force-pushed the issue/9875 branch from b43f8b2 to 5fb2d5e Compare August 25, 2023 14:55

chore: bump boxo to main

d2caa67

hacdias enabled auto-merge (squash) August 25, 2023 15:20

lidel approved these changes Aug 25, 2023

View reviewed changes

hacdias merged commit 4606586 into master Aug 25, 2023
17 checks passed

hacdias deleted the issue/9875 branch August 25, 2023 15:30

hacdias mentioned this pull request Aug 25, 2023

Cleanup from the move from "Reframe" to "HTTP Delegated Routing" #9479

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(gateway): expose /routing/v1 server (opt-in) #9877

feat(gateway): expose /routing/v1 server (opt-in) #9877

hacdias commented May 12, 2023 •

edited by lidel

Loading

lidel left a comment

hacdias commented Aug 25, 2023 •

edited

Loading

lidel commented Aug 25, 2023

hacdias commented Aug 25, 2023 •

edited

Loading

lidel Aug 25, 2023

lidel left a comment

feat(gateway): expose /routing/v1 server (opt-in) #9877

feat(gateway): expose /routing/v1 server (opt-in) #9877

Conversation

hacdias commented May 12, 2023 • edited by lidel Loading

Summary

Details

lidel left a comment

Choose a reason for hiding this comment

hacdias commented Aug 25, 2023 • edited Loading

lidel commented Aug 25, 2023

hacdias commented Aug 25, 2023 • edited Loading

lidel Aug 25, 2023

Choose a reason for hiding this comment

lidel left a comment

Choose a reason for hiding this comment

hacdias commented May 12, 2023 •

edited by lidel

Loading

hacdias commented Aug 25, 2023 •

edited

Loading

hacdias commented Aug 25, 2023 •

edited

Loading