feat(routing): Delegated Routing (#8997)

* Delegated Routing.

Implementation of Reframe specs (https://github.com/ipfs/specs/blob/master/REFRAME.md) using go-delegated-routing library.

* Requested changes.

* Init using op string

* Separate possible ContentRouters for TopicDiscovery.

If we don't do this, we have a ciclic dependency creating TieredRouter.
Now we can create first all possible content routers, and after that,
create Routers.

* Set dht default routing type

* Add tests and remove uneeded code

* Add documentation.

* docs: Routing.Routers

* Requested changes.

Signed-off-by: Antonio Navarro Perez <antnavper@gmail.com>

* Add some documentation on new fx functions.

* Add changelog entry and integration tests

* test: sharness for 'dht' in 'routing' commands

Since 'routing' is currently the same as 'dht' (minus query command)
we need to test both, that way we won't have unnoticed divergence
in the default behavior.

* test(sharness): delegated routing via reframe URL

* Add more tests for delegated routing.

* If any put operation fails, the tiered router will fail.

* refactor: Routing.Routers: Parameters.Endpoint

As agreed  in #8997 (comment)

* Try to improve CHANGELOG entry.

* chore: update reframe spec link

* Update go-delegated-routing dependency

* Fix config error test

* use new changelog format

* Remove port conflict

* go mod tidy

* ProviderManyWrapper to ProviderMany

* Update docs/changelogs/v0.14.md

Co-authored-by: Adin Schmahmann <adin.schmahmann@gmail.com>

Co-authored-by: Marcin Rataj <lidel@lidel.org>
Co-authored-by: Adin Schmahmann <adin.schmahmann@gmail.com>

CHANGELOG.md

@@ -1,5 +1,6 @@
 # Kubo Changelogs
 
+- [v0.14](docs/changelogs/v0.14.md)
 - [v0.13](docs/changelogs/v0.13.md)
 - [v0.12](docs/changelogs/v0.12.md)
 - [v0.11](docs/changelogs/v0.11.md)

cmd/ipfs/daemon.go

@@ -400,10 +400,7 @@ func daemonFunc(req *cmds.Request, re cmds.ResponseEmitter, env cmds.Environment
 
 	routingOption, _ := req.Options[routingOptionKwd].(string)
 	if routingOption == routingOptionDefaultKwd {
-		routingOption = cfg.Routing.Type
-		if routingOption == "" {
-			routingOption = routingOptionDHTKwd
-		}
+		routingOption = cfg.Routing.Type.WithDefault(routingOptionDHTKwd)
 	}
 	switch routingOption {
 	case routingOptionSupernodeKwd:

config/init.go

@@ -48,7 +48,7 @@ func InitWithIdentity(identity Identity) (*Config, error) {
 		},
 
 		Routing: Routing{
-			Type: "dht",
+			Type: NewOptionalString("dht"),
 		},
 
 		// setup the node mount points.

config/profile.go

@@ -174,7 +174,7 @@ functionality - performance of content discovery and data
 fetching may be degraded.
 `,
 		Transform: func(c *Config) error {
-			c.Routing.Type = "dhtclient"
+			c.Routing.Type = NewOptionalString("dhtclient")
 			c.AutoNAT.ServiceMode = AutoNATServiceDisabled
 			c.Reprovider.Interval = "0"
 

config/routing.go

@@ -5,5 +5,40 @@ type Routing struct {
 	// Type sets default daemon routing mode.
 	//
 	// Can be one of "dht", "dhtclient", "dhtserver", "none", or unset.
+	Type *OptionalString `json:",omitempty"`
+
+	Routers map[string]Router
+}
+
+type Router struct {
+
+	// Currenly only supported Type is "reframe".
+	// Reframe type allows to add other resolvers using the Reframe spec:
+	// https://github.com/ipfs/specs/tree/main/reframe
+	// In the future we will support "dht" and other Types here.
 	Type string
+
+	Enabled Flag `json:",omitempty"`
+
+	// Parameters are extra configuration that this router might need.
+	// A common one for reframe router is "Endpoint".
+	Parameters map[string]string
 }
+
+// Type is the routing type.
+// Depending of the type we need to instantiate different Routing implementations.
+type RouterType string
+
+const (
+	RouterTypeReframe RouterType = "reframe"
+)
+
+type RouterParam string
+
+const (
+	// RouterParamEndpoint is the URL where the routing implementation will point to get the information.
+	// Usually used for reframe Routers.
+	RouterParamEndpoint RouterParam = "Endpoint"
+
+	RouterParamPriority RouterParam = "Priority"
+)

config/types.go

@@ -321,6 +321,11 @@ type OptionalString struct {
 	value *string
 }
 
+// NewOptionalString returns an OptionalString from a string
+func NewOptionalString(s string) *OptionalString {
+	return &OptionalString{value: &s}
+}
+
 // WithDefault resolves the integer with the given default.
 func (p *OptionalString) WithDefault(defaultValue string) (value string) {
 	if p == nil || p.value == nil {

core/commands/commands_test.go

@@ -119,6 +119,12 @@ func TestCommands(t *testing.T) {
 		"/dht/provide",
 		"/dht/put",
 		"/dht/query",
+		"/routing",
+		"/routing/put",
+		"/routing/get",
+		"/routing/findpeer",
+		"/routing/findprovs",
+		"/routing/provide",
 		"/diag",
 		"/diag/cmds",
 		"/diag/cmds/clear",