Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add transport config #406

Merged
merged 6 commits into from
Dec 24, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion conf/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ seata:
heartbeat: true
# the client batch send request enable
enableClientBatchSendRequest: true
compressor: nome
compressor: none
service:


Expand Down
4 changes: 2 additions & 2 deletions conf/seata_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ seata:
# Allow batch sending of requests (RM)
enable-rm-client-batch-send-request: true
# RM send request timeout
rpc-rm-request-timeout: 3s
rpc-rm-request-timeout: 30s
# TM send request timeout
rpc-tm-request-timeout: 3s
rpc-tm-request-timeout: 30s
# Configuration Center
config:
type: file
Expand Down
2 changes: 0 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ require (
google.golang.org/grpc v1.49.0
google.golang.org/protobuf v1.28.1
gopkg.in/yaml.v2 v2.4.0
gotest.tools v2.2.0+incompatible
vimagination.zapto.org/byteio v0.0.0-20200222190125-d27cba0f0b10
)

Expand Down Expand Up @@ -74,7 +73,6 @@ require (
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
github.com/golang/protobuf v1.5.2 // indirect
github.com/golang/snappy v0.0.4 // indirect
github.com/google/go-cmp v0.5.9 // indirect
github.com/gorilla/websocket v1.4.2 // indirect
github.com/grpc-ecosystem/grpc-opentracing v0.0.0-20180507213350-8e809c8a8645 // indirect
github.com/hashicorp/errwrap v1.1.0 // indirect
Expand Down
1 change: 0 additions & 1 deletion go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -1425,7 +1425,6 @@ gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C
gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo=
gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
honnef.co/go/tools v0.0.0-20180728063816-88497007e858/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
Expand Down
10 changes: 6 additions & 4 deletions pkg/client/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ import (
"github.com/knadh/koanf/parsers/yaml"
"github.com/knadh/koanf/providers/rawbytes"
"github.com/seata/seata-go/pkg/remoting/getty"
"github.com/seata/seata-go/pkg/tm"
"github.com/seata/seata-go/pkg/rm/tcc"
"github.com/seata/seata-go/pkg/tm"
"github.com/seata/seata-go/pkg/util/flagext"
)

Expand Down Expand Up @@ -61,15 +61,17 @@ func (c *ClientConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
}

type Config struct {
TCCConfig tcc.Config `yaml:"tcc" json:"tcc" koanf:"tcc"`
ClientConfig ClientConfig `yaml:"client" json:"client" koanf:"client"`
GettyConfig getty.Config `yaml:"getty" json:"getty" koanf:"getty"`
TCCConfig tcc.Config `yaml:"tcc" json:"tcc" koanf:"tcc"`
ClientConfig ClientConfig `yaml:"client" json:"client" koanf:"client"`
GettyConfig getty.Config `yaml:"getty" json:"getty" koanf:"getty"`
TransportConfig getty.TransportConfig `yaml:"transport" json:"transport" koanf:"transport"`
}

func (c *Config) RegisterFlags(f *flag.FlagSet) {
c.TCCConfig.FenceConfig.RegisterFlagsWithPrefix("tcc", f)
c.ClientConfig.RegisterFlagsWithPrefix("client", f)
c.GettyConfig.RegisterFlagsWithPrefix("getty", f)
c.TransportConfig.RegisterFlagsWithPrefix("transport", f)
}

type loaderConf struct {
Expand Down
30 changes: 29 additions & 1 deletion pkg/client/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,28 @@ func TestLoadPath(t *testing.T) {
assert.Equal(t, "client_test", cfg.GettyConfig.SessionConfig.SessionName)
assert.Equal(t, time.Second, cfg.GettyConfig.SessionConfig.CronPeriod)

assert.NotNil(t, cfg.TransportConfig)
assert.NotNil(t, cfg.TransportConfig.ShutdownConfig)
assert.NotNil(t, 3*time.Second, cfg.TransportConfig.ShutdownConfig.Wait)
assert.Equal(t, "TCP", cfg.TransportConfig.Type)
assert.Equal(t, "NIO", cfg.TransportConfig.Server)
assert.Equal(t, true, cfg.TransportConfig.Heartbeat)
assert.Equal(t, "seata", cfg.TransportConfig.Serialization)
assert.Equal(t, "none", cfg.TransportConfig.Compressor)
assert.Equal(t, false, cfg.TransportConfig.EnableTmClientBatchSendRequest)
assert.Equal(t, true, cfg.TransportConfig.EnableRmClientBatchSendRequest)
assert.Equal(t, 30*time.Second, cfg.TransportConfig.RPCRmRequestTimeout)
assert.Equal(t, 30*time.Second, cfg.TransportConfig.RPCTmRequestTimeout)

// reset flag.CommandLine
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
}

func TestLoadJson(t *testing.T) {
confJson := `{"client":{"tm":{"commit-retry-count":5,"rollback-retry-count":5,"default-global-transaction-timeout":"60s","degrade-check":false,"degrade-check-period":2000,"degrade-check-allow-times":"10s","interceptor-order":-2147482648}},"tcc":{"fence":{"log-table-name":"tcc_fence_log_test2","clean-period":80000000000}},
"getty":{"reconnect-interval":1,"connection-num":10,"heartbeat-period":"10s","session":{"compress-encoding":true,"tcp-no-delay":false,"tcp-keep-alive":false,"keep-alive-period":"120s","tcp-r-buf-size":261120,"tcp-w-buf-size":32768,"tcp-read-timeout":"2s","tcp-write-timeout":"8s","wait-timeout":"2s","max-msg-len":261120,"session-name":"client_test","cron-period":"2s"}}}`
"getty":{"reconnect-interval":1,"connection-num":10,"heartbeat-period":"10s","session":{"compress-encoding":true,"tcp-no-delay":false,"tcp-keep-alive":false,"keep-alive-period":"120s","tcp-r-buf-size":261120,"tcp-w-buf-size":32768,"tcp-read-timeout":"2s","tcp-write-timeout":"8s","wait-timeout":"2s","max-msg-len":261120,"session-name":"client_test","cron-period":"2s"}},
"transport":{"shutdown":{"wait":"3s"}, "type":"TCP", "server":"NIO", "heartbeat":true,"serialization":"seata","compressor":"none"," enable-tm-client-batch-send-request":false,"enable-rm-client-batch-send-request":true,"rpc-rm-request-timeout":"30s","rpc-tm-request-timeout":"30s"}}`

cfg := LoadJson([]byte(confJson))
assert.NotNil(t, cfg)

Expand Down Expand Up @@ -106,6 +121,19 @@ func TestLoadJson(t *testing.T) {
assert.Equal(t, "client_test", cfg.GettyConfig.SessionConfig.SessionName)
assert.Equal(t, time.Second*2, cfg.GettyConfig.SessionConfig.CronPeriod)

assert.NotNil(t, cfg.TransportConfig)
assert.NotNil(t, cfg.TransportConfig.ShutdownConfig)
assert.NotNil(t, 3*time.Second, cfg.TransportConfig.ShutdownConfig.Wait)
assert.Equal(t, "TCP", cfg.TransportConfig.Type)
assert.Equal(t, "NIO", cfg.TransportConfig.Server)
assert.Equal(t, true, cfg.TransportConfig.Heartbeat)
assert.Equal(t, "seata", cfg.TransportConfig.Serialization)
assert.Equal(t, "none", cfg.TransportConfig.Compressor)
assert.Equal(t, false, cfg.TransportConfig.EnableTmClientBatchSendRequest)
assert.Equal(t, true, cfg.TransportConfig.EnableRmClientBatchSendRequest)
assert.Equal(t, 30*time.Second, cfg.TransportConfig.RPCRmRequestTimeout)
assert.Equal(t, 30*time.Second, cfg.TransportConfig.RPCTmRequestTimeout)

// reset flag.CommandLine
flag.CommandLine = flag.NewFlagSet(os.Args[0], flag.ExitOnError)
}
34 changes: 34 additions & 0 deletions pkg/remoting/getty/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,44 @@ type Config struct {
SessionConfig SessionConfig `yaml:"session" json:"session" koanf:"session"`
}

type ShutdownConfig struct {
Wait time.Duration `yaml:"wait" json:"wait" konaf:"wait"`
}

type TransportConfig struct {
ShutdownConfig ShutdownConfig `yaml:"shutdown" json:"shutdown" koanf:"shutdown"`
Type string `yaml:"type" json:"type" koanf:"type"`
Server string `yaml:"server" json:"server" koanf:"server"`
Heartbeat bool `yaml:"heartbeat" json:"heartbeat" koanf:"heartbeat"`
Serialization string `yaml:"serialization" json:"serialization" koanf:"serialization"`
Compressor string `yaml:"compressor" json:"compressor" koanf:"compressor"`
EnableTmClientBatchSendRequest bool `yaml:"enable-tm-client-batch-send-request" json:"enable-tm-client-batch-send-request" koanf:"enable-tm-client-batch-send-request"`
EnableRmClientBatchSendRequest bool `yaml:"enable-rm-client-batch-send-request" json:"enable-rm-client-batch-send-request" koanf:"enable-rm-client-batch-send-request"`
RPCRmRequestTimeout time.Duration `yaml:"rpc-rm-request-timeout" json:"rpc-rm-request-timeout" koanf:"rpc-rm-request-timeout"`
RPCTmRequestTimeout time.Duration `yaml:"rpc-tm-request-timeout" json:"rpc-tm-request-timeout" koanf:"rpc-tm-request-timeout"`
}

// RegisterFlagsWithPrefix for Config.
func (cfg *Config) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
f.IntVar(&cfg.ReconnectInterval, prefix+".reconnect-interval", 0, "Reconnect interval.")
f.IntVar(&cfg.ConnectionNum, prefix+".connection-num", 16, "The getty_session pool.")
f.DurationVar(&cfg.HeartbeatPeriod, prefix+".heartbeat-period", 15*time.Second, "The heartbeat period.")
cfg.SessionConfig.RegisterFlagsWithPrefix(prefix+".session", f)
}

func (cfg *ShutdownConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
f.DurationVar(&cfg.Wait, prefix+".wait", 3*time.Second, "Shutdown wait time.")
}

func (cfg *TransportConfig) RegisterFlagsWithPrefix(prefix string, f *flag.FlagSet) {
cfg.ShutdownConfig.RegisterFlagsWithPrefix(prefix+".shutdown", f)
f.StringVar(&cfg.Type, prefix+".type", "TCP", "Transport protocol type.")
f.StringVar(&cfg.Server, prefix+".server", "NIO", "Server type.")
f.BoolVar(&cfg.Heartbeat, prefix+".heartbeat", true, "Heartbeat.")
f.StringVar(&cfg.Serialization, prefix+".serialization", "seata", "Encoding and decoding mode.")
f.StringVar(&cfg.Compressor, prefix+".compressor", "none", "Message compression mode.")
f.BoolVar(&cfg.EnableTmClientBatchSendRequest, prefix+".enable-tm-client-batch-send-request", false, "Allow batch sending of requests (TM).")
f.BoolVar(&cfg.EnableRmClientBatchSendRequest, prefix+".enable-rm-client-batch-send-request", true, "Allow batch sending of requests (RM).")
f.DurationVar(&cfg.RPCRmRequestTimeout, prefix+".rpc-rm-request-timeout", 30*time.Second, "RM send request timeout.")
f.DurationVar(&cfg.RPCTmRequestTimeout, prefix+".rpc-tm-request-timeout", 30*time.Second, "TM send request timeout.")
}
4 changes: 2 additions & 2 deletions testdata/conf/seatago.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ seata:
# Allow batch sending of requests (RM)
enable-rm-client-batch-send-request: true
# RM send request timeout
rpc-rm-request-timeout: 3s
rpc-rm-request-timeout: 30s
# TM send request timeout
rpc-tm-request-timeout: 3s
rpc-tm-request-timeout: 30s
# Configuration Center
config:
type: file
Expand Down