transport: enable tnet by default (#56)

Co-authored-by: wineguo <wineguo@tencent.com>

client/client_linux.go

@@ -0,0 +1,40 @@
+//go:build linux && amd64
+// +build linux,amd64
+
+package client
+
+import (
+	"trpc.group/trpc-go/trpc-go/log"
+	"trpc.group/trpc-go/trpc-go/transport"
+	"trpc.group/trpc-go/trpc-go/transport/tnet"
+)
+
+func attemptSwitchingTransport(o *Options) transport.ClientTransport {
+	// If the user doesn't explicitly set the transport (which is usually the case for trpc protocol),
+	// attempt to switch to the tnet transport.
+	if o.Transport == nil {
+		if check(o) {
+			cheer(o)
+			return tnet.DefaultClientTransport
+		}
+		sigh(o)
+		return transport.DefaultClientTransport
+	}
+	return o.Transport
+}
+
+func check(o *Options) bool {
+	// Only use tnet transport with TCP and trpc.
+	return (o.Network == "tcp" ||
+		o.Network == "tcp4" ||
+		o.Network == "tcp6") &&
+		o.Protocol == "trpc"
+}
+
+func cheer(o *Options) {
+	log.Infof("client %s is empowered with tnet! 🤩 ", o.ServiceName)
+}
+
+func sigh(o *Options) {
+	log.Infof("client: %s, tnet is not enabled by default 🧐 ", o.ServiceName)
+}

client/client_nolinux.go

@@ -0,0 +1,13 @@
+//go:build !(linux && amd64)
+// +build !linux !amd64
+
+package client
+
+import "trpc.group/trpc-go/trpc-go/transport"
+
+func attemptSwitchingTransport(o *Options) transport.ClientTransport {
+	if o.Transport == nil {
+		return transport.DefaultClientTransport
+	}
+	return o.Transport
+}

client/config.go

@@ -91,9 +91,13 @@ func (cfg *BackendConfig) genOptions() (*Options, error) {
 		opts.CompressType = cfg.Compression
 	}
 
+	// Reset the transport to check if the user has specified any transport.
+	opts.Transport = nil
+	WithTransport(transport.GetClientTransport(cfg.Transport))(opts)
+	WithStreamTransport(transport.GetClientStreamTransport(cfg.Transport))(opts)
 	WithProtocol(cfg.Protocol)(opts)
 	WithNetwork(cfg.Network)(opts)
-	WithTransport(transport.GetClientTransport(cfg.Transport))(opts)
+	opts.Transport = attemptSwitchingTransport(opts)
 	WithPassword(cfg.Password)(opts)
 	WithTLS(cfg.TLSCert, cfg.TLSKey, cfg.CACert, cfg.TLSServerName)(opts)
 	if cfg.Protocol != "" && opts.Codec == nil {

client/options.go

@@ -39,6 +39,7 @@ type Options struct {
 	endpoint string // The same as service name if target is not set.
 
 	Network           string
+	Protocol          string
 	CallType          codec.RequestType           // Type of request, referring to transport.RequestType.
 	CallOptions       []transport.RoundTripOption // Options for client transport to call server.
 	Transport         transport.ClientTransport
@@ -361,6 +362,7 @@ func WithProtocol(s string) Option {
 		if s == "" {
 			return
 		}
+		o.Protocol = s
 		o.Codec = codec.GetClient(s)
 		if b := transport.GetFramerBuilder(s); b != nil {
 			o.CallOptions = append(o.CallOptions,

server/service.go

@@ -107,26 +107,17 @@ type service struct {
 // It will use transport.DefaultServerTransport unless Option WithTransport()
 // is called to replace its transport.ServerTransport plugin.
 var New = func(opts ...Option) Service {
-	const (
-		invalidCompressType      = -1
-		invalidSerializationType = -1
-	)
+	o := defaultOptions()
 	s := &service{
-		opts: &Options{
-			protocol:                 "unknown-protocol",
-			ServiceName:              "empty-name",
-			CurrentSerializationType: invalidSerializationType,
-			CurrentCompressType:      invalidCompressType,
-			Transport:                transport.DefaultServerTransport,
-			StreamTransport:          transport.DefaultServerStreamTransport,
-		},
+		opts:           o,
 		handlers:       make(map[string]Handler),
 		streamHandlers: make(map[string]StreamHandler),
 		streamInfo:     make(map[string]*StreamServerInfo),
 	}
 	for _, o := range opts {
 		o(s.opts)
 	}
+	o.Transport = attemptSwitchingTransport(o)
 	if !s.opts.handlerSet {
 		// if handler is not set, pass the service (which implements Handler interface)
 		// as handler of transport plugin.
@@ -589,3 +580,16 @@ func checkProcessStatus() (isGracefulRestart, isParentalProcess bool) {
 	}
 	return true, ppid == os.Getpid()
 }
+
+func defaultOptions() *Options {
+	const (
+		invalidSerializationType = -1
+		invalidCompressType      = -1
+	)
+	return &Options{
+		protocol:                 "unknown-protocol",
+		ServiceName:              "empty-name",
+		CurrentSerializationType: invalidSerializationType,
+		CurrentCompressType:      invalidCompressType,
+	}
+}

server/service_linux.go

@@ -0,0 +1,36 @@
+//go:build linux && amd64
+// +build linux,amd64
+
+package server
+
+import (
+	"trpc.group/trpc-go/trpc-go/log"
+	"trpc.group/trpc-go/trpc-go/transport"
+	"trpc.group/trpc-go/trpc-go/transport/tnet"
+)
+
+func attemptSwitchingTransport(o *Options) transport.ServerTransport {
+	// If the user doesn't explicitly set the transport (which is usually the case for trpc protocol),
+	// attempt to switch to the tnet transport.
+	if o.Transport == nil {
+		// Only use tnet transport with TCP and trpc.
+		if (o.network == "tcp" ||
+			o.network == "tcp4" ||
+			o.network == "tcp6") &&
+			o.protocol == "trpc" {
+			log.Infof("service %s with network %s and protocol %s is empowered with tnet! 🤩 "+
+				"you can always use 'go get -u trpc.group/trpc-go/trpc-go@v0.15.1' "+
+				"(without the '-tnet-enabled' suffix) , or set 'transport: go-net' in your "+
+				"trpc_go.yaml's service configuration to switch to the vanilla version",
+				o.ServiceName, o.network, o.protocol)
+			return tnet.DefaultServerTransport
+		}
+		log.Infof("service: %s, tnet is not enabled by default for the network %s and protocol %s, 🧐 "+
+			"fallback to go-net transport, it is either because tnet does not support them or "+
+			"we haven't fully test for some third-party protocols, you can set 'transport: tnet' "+
+			"in your service configuration to force using tnet and test it at your own risk",
+			o.ServiceName, o.network, o.protocol)
+		return transport.DefaultServerTransport
+	}
+	return o.Transport
+}

server/service_nolinux.go

@@ -0,0 +1,13 @@
+//go:build !(linux && amd64)
+// +build !linux !amd64
+
+package server
+
+import "trpc.group/trpc-go/trpc-go/transport"
+
+func attemptSwitchingTransport(o *Options) transport.ServerTransport {
+	if o.Transport == nil {
+		return transport.DefaultServerTransport
+	}
+	return o.Transport
+}

transport/client_transport.go

@@ -14,6 +14,11 @@ import (
 	"trpc.group/trpc-go/trpc-go/pool/multiplexed"
 )
 
+func init() {
+	RegisterClientTransport(transportName, DefaultClientTransport)
+	RegisterClientStreamTransport(transportName, DefaultClientStreamTransport)
+}
+
 // DefaultClientTransport is the default client transport.
 var DefaultClientTransport = NewClientTransport()
 

transport/server_transport.go

@@ -27,6 +27,12 @@ import (
 	"trpc.group/trpc-go/trpc-go/log"
 )
 
+const transportName = "go-net"
+
+func init() {
+	RegisterServerTransport(transportName, DefaultServerTransport)
+}
+
 const (
 	// EnvGraceRestart is the flag of graceful restart.
 	EnvGraceRestart = "TRPC_IS_GRACEFUL"