minor DefaultRouteBehaviour refactoring (#845)

Author: Denchick

cmd/router/main.go

@@ -11,6 +11,7 @@ import (
 	"runtime"
 	"runtime/pprof"
 	"strconv"
+	"strings"
 	"sync"
 	"syscall"
 
@@ -83,7 +84,7 @@ func init() {
 	rootCmd.PersistentFlags().IntVarP(&adminPort, "admin-port", "", 0, "router Metadata PostgreSQL interface admin port")
 	rootCmd.PersistentFlags().IntVarP(&grpcPort, "grpc-port", "", 0, "router Metadata GRPC interface admin port")
 
-	rootCmd.PersistentFlags().StringVarP(&default_route_behaviour, "default-route-behaviour", "", "", "router block or scatters-out failed to route statements")
+	rootCmd.PersistentFlags().StringVarP(&default_route_behaviour, "default-route-behaviour", "", "", "The router will either block or scatter-out multishard queries by default")
 
 	rootCmd.PersistentFlags().BoolVarP(&pgprotoDebug, "proto-debug", "", false, "reply router notice, warning, etc")
 	rootCmd.AddCommand(runCmd)
@@ -218,7 +219,11 @@ var runCmd = &cobra.Command{
 		}
 
 		if default_route_behaviour != "" {
-			rcfg.Qr.DefaultRouteBehaviour = default_route_behaviour
+			if strings.ToLower(default_route_behaviour) == "block" {
+				rcfg.Qr.DefaultRouteBehaviour = config.DefaultRouteBehaviourBlock
+			} else {
+				rcfg.Qr.DefaultRouteBehaviour = config.DefaultRouteBehaviourAllow
+			}
 		}
 
 		router, err := instance.NewRouter(ctx, rcfg, os.Getenv("NOTIFY_SOCKET"), persist)

docs/configuration/router.mdx

@@ -83,12 +83,12 @@ Map of string to Shard objects. Refer to the `Shard` struct in the [pkg/config/r
 
 ## Feature Flags
 
-| Setting                                 | Description                                     | Possible Values |
-|-----------------------------------------|-------------------------------------------------|-----------------|
-| `maintain_params`                       | Whether to maintain parameters flag.            | `true`, `false` |
-| `query_routing.default_route_behaviour` | Whether to explicitly block multishard queries. | `BLOCK`, ``     |
-| `with_jaeger`                           | Whether to integrate with Jaeger for tracing.   | `true`, `false` |
-| `world_shard_fallback`                  | Whether to enable fallback to world shard.      | `true`, `false` |
+| Setting                                 | Description                                     |  Possible Values |
+|-----------------------------------------|-------------------------------------------------|------------------|
+| `maintain_params`                       | Whether to maintain parameters flag.            | `true`, `false`  |
+| `query_routing.default_route_behaviour` | Whether to explicitly block multishard queries. | `BLOCK`, `ALLOW` |
+| `with_jaeger`                           | Whether to integrate with Jaeger for tracing.   | `true`, `false`  |
+| `world_shard_fallback`                  | Whether to enable fallback to world shard.      | `true`, `false`  |
 
 
 ## Mode Settings

pkg/config/router.go

@@ -17,6 +17,7 @@ import (
 type PoolMode string
 type ShardType string
 type RouterMode string
+type DefaultRouteBehaviour string
 
 const (
 	PoolModeSession     = PoolMode("SESSION")
@@ -27,6 +28,9 @@ const (
 
 	LocalMode = RouterMode("LOCAL")
 	ProxyMode = RouterMode("PROXY")
+
+	DefaultRouteBehaviourBlock = DefaultRouteBehaviour("BLOCK")
+	DefaultRouteBehaviourAllow = DefaultRouteBehaviour("ALLOW")
 )
 
 var cfgRouter Router
@@ -86,7 +90,7 @@ type Router struct {
 }
 
 type QRouter struct {
-	DefaultRouteBehaviour string `json:"default_route_behaviour" toml:"default_route_behaviour" yaml:"default_route_behaviour"`
+	DefaultRouteBehaviour DefaultRouteBehaviour `json:"default_route_behaviour" toml:"default_route_behaviour" yaml:"default_route_behaviour"`
 }
 
 type BackendRule struct {

router/qrouter/proxy_routing.go

@@ -1203,6 +1203,8 @@ func (qr *ProxyQrouter) Route(ctx context.Context, stmt lyx.Node, sph session.Se
 		switch sph.DefaultRouteBehaviour() {
 		case "BLOCK":
 			return routingstate.SkipRoutingState{}, spqrerror.NewByCode(spqrerror.SPQR_NO_DATASHARD)
+		case "ALLOW":
+			return v, nil
 		default:
 			return v, nil
 		}

router/rulerouter/rulerouter.go

@@ -147,7 +147,7 @@ func NewRouter(tlsconfig *tls.Config, rcfg *config.Router, notifier *notifier.No
 
 // TODO : unit tests
 func (r *RuleRouterImpl) PreRoute(conn net.Conn, pt port.RouterPortType) (rclient.RouterClient, error) {
-	cl := rclient.NewPsqlClient(conn, pt, r.Config().Qr.DefaultRouteBehaviour, r.Config().ShowNoticeMessages, r.Config().DefaultTSA)
+	cl := rclient.NewPsqlClient(conn, pt, string(r.Config().Qr.DefaultRouteBehaviour), r.Config().ShowNoticeMessages, r.Config().DefaultTSA)
 
 	tlsConfig := r.tlsconfig
 	if pt == port.UnixSocketPortType {