Browse Source
privVal: Improve SocketClient network code (#1315)
Follow-up to feedback from #1286, this change simplifies the connection handling in the SocketClient and makes the communication via TCP more robust. It introduces the tcpTimeoutListener to encapsulate accept and i/o timeout handling as well as connection keep-alive, this type could likely be upgraded to handle more fine-grained tuning of the tcp stack (linger, nodelay, etc.) according to the properties we desire. The same methods should be applied to the RemoteSigner which will be overhauled when the priv_val_server is fleshed out. * require private key * simplify connect logic * break out conn upgrades to tcpTimeoutListener * extend test coverage and simplify component setuppull/1323/head
Alexander Simmerl
6 years ago
committed by
Anton Kaliaev
Anton Kaliaev
8 changed files with 400 additions and 208 deletions
Split View
Diff Options
-
+1 -2Gopkg.lock
-
+0 -4Gopkg.toml
-
+2 -1cmd/priv_val_server/main.go
-
+1 -1node/node.go
-
+115 -109types/priv_validator/socket.go
-
+66 -0types/priv_validator/socket_tcp.go
-
+64 -0types/priv_validator/socket_tcp_test.go
-
+151 -91types/priv_validator/socket_test.go
+ 1
- 2
Gopkg.lock
View File
+ 0
- 4
Gopkg.toml
View File
+ 2
- 1
cmd/priv_val_server/main.go
View File
+ 1
- 1
node/node.go
View File
+ 115
- 109
types/priv_validator/socket.go
View File
+ 66
- 0
types/priv_validator/socket_tcp.go
View File
| @ -0,0 +1,66 @@ | |||
| package types | |||
| import ( | |||
| "net" | |||
| "time" | |||
| ) | |||
| // timeoutError can be used to check if an error returned from the netp package | |||
| // was due to a timeout. | |||
| type timeoutError interface { | |||
| Timeout() bool | |||
| } | |||
| // tcpTimeoutListener implements net.Listener. | |||
| var _ net.Listener = (*tcpTimeoutListener)(nil) | |||
| // tcpTimeoutListener wraps a *net.TCPListener to standardise protocol timeouts | |||
| // and potentially other tuning parameters. | |||
| type tcpTimeoutListener struct { | |||
| *net.TCPListener | |||
| acceptDeadline time.Duration | |||
| connDeadline time.Duration | |||
| period time.Duration | |||
| } | |||
| // newTCPTimeoutListener returns an instance of tcpTimeoutListener. | |||
| func newTCPTimeoutListener( | |||
| ln net.Listener, | |||
| acceptDeadline, connDeadline time.Duration, | |||
| period time.Duration, | |||
| ) tcpTimeoutListener { | |||
| return tcpTimeoutListener{ | |||
| TCPListener: ln.(*net.TCPListener), | |||
| acceptDeadline: acceptDeadline, | |||
| connDeadline: connDeadline, | |||
| period: period, | |||
| } | |||
| } | |||
| // Accept implements net.Listener. | |||
| func (ln tcpTimeoutListener) Accept() (net.Conn, error) { | |||
| err := ln.SetDeadline(time.Now().Add(ln.acceptDeadline)) | |||
| if err != nil { | |||
| return nil, err | |||
| } | |||
| tc, err := ln.AcceptTCP() | |||
| if err != nil { | |||
| return nil, err | |||
| } | |||
| if err := tc.SetDeadline(time.Now().Add(ln.connDeadline)); err != nil { | |||
| return nil, err | |||
| } | |||
| if err := tc.SetKeepAlive(true); err != nil { | |||
| return nil, err | |||
| } | |||
| if err := tc.SetKeepAlivePeriod(ln.period); err != nil { | |||
| return nil, err | |||
| } | |||
| return tc, nil | |||
| } | |||
+ 64
- 0
types/priv_validator/socket_tcp_test.go
View File
| @ -0,0 +1,64 @@ | |||
| package types | |||
| import ( | |||
| "net" | |||
| "testing" | |||
| "time" | |||
| ) | |||
| func TestTCPTimeoutListenerAcceptDeadline(t *testing.T) { | |||
| ln, err := net.Listen("tcp", "127.0.0.1:0") | |||
| if err != nil { | |||
| t.Fatal(err) | |||
| } | |||
| ln = newTCPTimeoutListener(ln, time.Millisecond, time.Second, time.Second) | |||
| _, err = ln.Accept() | |||
| opErr, ok := err.(*net.OpError) | |||
| if !ok { | |||
| t.Fatalf("have %v, want *net.OpError", err) | |||
| } | |||
| if have, want := opErr.Op, "accept"; have != want { | |||
| t.Errorf("have %v, want %v", have, want) | |||
| } | |||
| } | |||
| func TestTCPTimeoutListenerConnDeadline(t *testing.T) { | |||
| ln, err := net.Listen("tcp", "127.0.0.1:0") | |||
| if err != nil { | |||
| t.Fatal(err) | |||
| } | |||
| ln = newTCPTimeoutListener(ln, time.Second, time.Millisecond, time.Second) | |||
| donec := make(chan struct{}) | |||
| go func(ln net.Listener) { | |||
| defer close(donec) | |||
| c, err := ln.Accept() | |||
| if err != nil { | |||
| t.Fatal(err) | |||
| } | |||
| time.Sleep(2 * time.Millisecond) | |||
| _, err = c.Write([]byte("foo")) | |||
| opErr, ok := err.(*net.OpError) | |||
| if !ok { | |||
| t.Fatalf("have %v, want *net.OpError", err) | |||
| } | |||
| if have, want := opErr.Op, "write"; have != want { | |||
| t.Errorf("have %v, want %v", have, want) | |||
| } | |||
| }(ln) | |||
| _, err = net.Dial("tcp", ln.Addr().String()) | |||
| if err != nil { | |||
| t.Fatal(err) | |||
| } | |||
| <-donec | |||
| } | |||