refactor(rpc): improve consistency

gotd · Jan 4, 2021 · de6ce25 · de6ce25
1 parent ec66c50
commit de6ce25
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 16 deletions.
diff --git a/internal/rpc/config.go b/internal/rpc/config.go
@@ -8,15 +8,15 @@ import (
 	"github.com/gotd/td/clock"
 )
 
-// Config of rpc engine.
-type Config struct {
+// Options of rpc engine.
+type Options struct {
 	RetryInterval time.Duration
 	MaxRetries    int
 	Logger        *zap.Logger
 	Clock         clock.Clock
 }
 
-func (cfg *Config) setDefaults() {
+func (cfg *Options) setDefaults() {
 	if cfg.RetryInterval == 0 {
 		cfg.RetryInterval = time.Second * 10
 	}

diff --git a/internal/rpc/engine.go b/internal/rpc/engine.go
@@ -11,6 +11,7 @@ import (
 	"golang.org/x/xerrors"
 
 	"github.com/gotd/td/bin"
+	"github.com/gotd/td/clock"
 )
 
 // Engine handles RPC requests.
@@ -21,7 +22,7 @@ type Engine struct {
 	rpc map[int64]func(*bin.Buffer, error) error
 	ack map[int64]func()
 
-	clock         Clock
+	clock         clock.Clock
 	log           *zap.Logger
 	retryInterval time.Duration
 	maxRetries    int
@@ -37,7 +38,7 @@ type Send func(ctx context.Context, msgID int64, seqNo int32, in bin.Encoder) er
 func NopSend(ctx context.Context, msgID int64, seqNo int32, in bin.Encoder) error { return nil }
 
 // New creates new rpc Engine.
-func New(send Send, cfg Config) *Engine {
+func New(send Send, cfg Options) *Engine {
 	cfg.setDefaults()
 
 	cfg.Logger.Info("Initialized",

diff --git a/internal/rpc/engine_test.go b/internal/rpc/engine_test.go
@@ -80,7 +80,7 @@ func TestRPCError(t *testing.T) {
 		return nil
 	}
 
-	runTest(t, Config{
+	runTest(t, Options{
 		RetryInterval: time.Second * 3,
 		MaxRetries:    2,
 		Clock:         clock,
@@ -144,7 +144,7 @@ func TestRPCResult(t *testing.T) {
 		return nil
 	}
 
-	runTest(t, Config{
+	runTest(t, Options{
 		RetryInterval: time.Second * 4,
 		MaxRetries:    2,
 		Clock:         clock,
@@ -213,7 +213,7 @@ func TestRPCAckThenResult(t *testing.T) {
 		return nil
 	}
 
-	runTest(t, Config{
+	runTest(t, Options{
 		RetryInterval: time.Second * 4,
 		MaxRetries:    2,
 		Clock:         clock,
@@ -285,7 +285,7 @@ func TestRPCWithRetryResult(t *testing.T) {
 		return nil
 	}
 
-	runTest(t, Config{
+	runTest(t, Options{
 		RetryInterval: time.Second * 4,
 		MaxRetries:    5,
 		Clock:         clock,
@@ -357,7 +357,7 @@ func TestEngineGracefulShutdown(t *testing.T) {
 		return nil
 	}
 
-	runTest(t, Config{
+	runTest(t, Options{
 		RetryInterval: time.Second * 5,
 		MaxRetries:    5,
 		Logger:        log.Named("rpc"),
@@ -366,7 +366,7 @@ func TestEngineGracefulShutdown(t *testing.T) {
 
 func runTest(
 	t *testing.T,
-	cfg Config,
+	cfg Options,
 	server func(t *testing.T, e *Engine, incoming <-chan request) error,
 	client func(t *testing.T, e *Engine) error,
 ) {

diff --git a/mtproto/conn.go b/mtproto/conn.go
@@ -122,7 +122,7 @@ func NewConn(addr string, opt Options) *Conn {
 		authKey: opt.Key,
 		salt:    opt.Salt,
 	}
-	conn.rpc = rpc.New(conn.write, rpc.Config{
+	conn.rpc = rpc.New(conn.write, rpc.Options{
 		Logger:        opt.Logger.Named("rpc"),
 		RetryInterval: opt.RetryInterval,
 		MaxRetries:    opt.MaxRetries,

diff --git a/mtproto/conn_test.go b/mtproto/conn_test.go
@@ -40,7 +40,7 @@ func newTestClient(h testHandler) *Conn {
 			return engine.NotifyResult(msgID, &b)
 		}
 		return nil
-	}, rpc.Config{})
+	}, rpc.Options{})
 
 	client := &Conn{
 		rpc:       engine,

diff --git a/mtproto/handle_message_fuzz.go b/mtproto/handle_message_fuzz.go
@@ -19,7 +19,7 @@ func (Zero) Read(p []byte) (n int, err error) { return len(p), nil }
 func FuzzHandleMessage(data []byte) int {
 	c := &Conn{
 		rand:      Zero{},
-		rpc:       rpc.New(rpc.NopSend, rpc.Config{}),
+		rpc:       rpc.New(rpc.NopSend, rpc.Options{}),
 		log:       zap.NewNop(),
 		messageID: proto.NewMessageIDGen(time.Now, 1),
 	}

diff --git a/mtproto/handle_message_test.go b/mtproto/handle_message_test.go
@@ -60,7 +60,7 @@ func TestClientHandleMessageCorpus(t *testing.T) {
 	c := &Conn{
 		rand: Zero{},
 		log:  zap.NewNop(),
-		rpc:  rpc.New(rpc.NopSend, rpc.Config{}),
+		rpc:  rpc.New(rpc.NopSend, rpc.Options{}),
 	}
 
 	corpus, err := ioutil.ReadDir(filepath.Join("..", "_fuzz", "handle_message", "corpus"))

diff --git a/telegram/client_test.go b/telegram/client_test.go
@@ -67,7 +67,7 @@ func newTestClient(h testHandler) *Client {
 			return engine.NotifyResult(msgID, &b)
 		}
 		return nil
-	}, rpc.Config{})
+	}, rpc.Options{})
 
 	client := &Client{
 		log:     zap.NewNop(),