05c79ac8c2
This should resolve the spurious ping timeouts we've had on low powered boxes. Those errors are the result of us requiring a timely Pong response to our Pings. However this is unnecessarily strict - as long as we've received *anything* recently, we know the other peer is alive. So the new mechanism removes the Pong message entirely and separates the ping check into two routines: - One that makes sure to send ping periodically, if nothing else has been sent. This guarantees a message sent every 45-90 seconds. - One that checks how long it was since we last received a message. If it's longer than 300 seconds, we trigger an ErrTimeout. So we're guaranteed to detect a connection failure in 300 + 300/2 seconds (due to how often the check runs) and we may detect it much sooner if we get an actual error on the ping write (a connection reset or so). This is more sluggish than before but I think that's an OK price to pay for making it actually work out of the box. This removes the configurability of it, as the timeout on one side is dependent on the send interval on the other side. Do we still need it configurable?
317 lines
6.7 KiB
Go
317 lines
6.7 KiB
Go
// Copyright (C) 2014 The Protocol Authors.
|
|
|
|
package protocol
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/hex"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"io/ioutil"
|
|
"os"
|
|
"reflect"
|
|
"strings"
|
|
"testing"
|
|
"testing/quick"
|
|
|
|
"github.com/calmh/xdr"
|
|
)
|
|
|
|
var (
|
|
c0ID = NewDeviceID([]byte{1})
|
|
c1ID = NewDeviceID([]byte{2})
|
|
)
|
|
|
|
func TestHeaderFunctions(t *testing.T) {
|
|
f := func(ver, id, typ int) bool {
|
|
ver = int(uint(ver) % 16)
|
|
id = int(uint(id) % 4096)
|
|
typ = int(uint(typ) % 256)
|
|
h0 := header{version: ver, msgID: id, msgType: typ}
|
|
h1 := decodeHeader(encodeHeader(h0))
|
|
return h0 == h1
|
|
}
|
|
if err := quick.Check(f, nil); err != nil {
|
|
t.Error(err)
|
|
}
|
|
}
|
|
|
|
func TestHeaderLayout(t *testing.T) {
|
|
var e, a uint32
|
|
|
|
// Version are the first four bits
|
|
e = 0xf0000000
|
|
a = encodeHeader(header{version: 0xf})
|
|
if a != e {
|
|
t.Errorf("Header layout incorrect; %08x != %08x", a, e)
|
|
}
|
|
|
|
// Message ID are the following 12 bits
|
|
e = 0x0fff0000
|
|
a = encodeHeader(header{msgID: 0xfff})
|
|
if a != e {
|
|
t.Errorf("Header layout incorrect; %08x != %08x", a, e)
|
|
}
|
|
|
|
// Type are the last 8 bits before reserved
|
|
e = 0x0000ff00
|
|
a = encodeHeader(header{msgType: 0xff})
|
|
if a != e {
|
|
t.Errorf("Header layout incorrect; %08x != %08x", a, e)
|
|
}
|
|
}
|
|
|
|
func TestPing(t *testing.T) {
|
|
ar, aw := io.Pipe()
|
|
br, bw := io.Pipe()
|
|
|
|
c0 := NewConnection(c0ID, ar, bw, newTestModel(), "name", CompressAlways).(wireFormatConnection).next.(*rawConnection)
|
|
c0.Start()
|
|
c1 := NewConnection(c1ID, br, aw, newTestModel(), "name", CompressAlways).(wireFormatConnection).next.(*rawConnection)
|
|
c1.Start()
|
|
c0.ClusterConfig(ClusterConfigMessage{})
|
|
c1.ClusterConfig(ClusterConfigMessage{})
|
|
|
|
if ok := c0.ping(); !ok {
|
|
t.Error("c0 ping failed")
|
|
}
|
|
if ok := c1.ping(); !ok {
|
|
t.Error("c1 ping failed")
|
|
}
|
|
}
|
|
|
|
func TestVersionErr(t *testing.T) {
|
|
m0 := newTestModel()
|
|
m1 := newTestModel()
|
|
|
|
ar, aw := io.Pipe()
|
|
br, bw := io.Pipe()
|
|
|
|
c0 := NewConnection(c0ID, ar, bw, m0, "name", CompressAlways).(wireFormatConnection).next.(*rawConnection)
|
|
c0.Start()
|
|
c1 := NewConnection(c1ID, br, aw, m1, "name", CompressAlways)
|
|
c1.Start()
|
|
c0.ClusterConfig(ClusterConfigMessage{})
|
|
c1.ClusterConfig(ClusterConfigMessage{})
|
|
|
|
w := xdr.NewWriter(c0.cw)
|
|
w.WriteUint32(encodeHeader(header{
|
|
version: 2,
|
|
msgID: 0,
|
|
msgType: 0,
|
|
}))
|
|
w.WriteUint32(0) // Avoids reader closing due to EOF
|
|
|
|
if !m1.isClosed() {
|
|
t.Error("Connection should close due to unknown version")
|
|
}
|
|
}
|
|
|
|
func TestTypeErr(t *testing.T) {
|
|
m0 := newTestModel()
|
|
m1 := newTestModel()
|
|
|
|
ar, aw := io.Pipe()
|
|
br, bw := io.Pipe()
|
|
|
|
c0 := NewConnection(c0ID, ar, bw, m0, "name", CompressAlways).(wireFormatConnection).next.(*rawConnection)
|
|
c0.Start()
|
|
c1 := NewConnection(c1ID, br, aw, m1, "name", CompressAlways)
|
|
c1.Start()
|
|
c0.ClusterConfig(ClusterConfigMessage{})
|
|
c1.ClusterConfig(ClusterConfigMessage{})
|
|
|
|
w := xdr.NewWriter(c0.cw)
|
|
w.WriteUint32(encodeHeader(header{
|
|
version: 0,
|
|
msgID: 0,
|
|
msgType: 42,
|
|
}))
|
|
w.WriteUint32(0) // Avoids reader closing due to EOF
|
|
|
|
if !m1.isClosed() {
|
|
t.Error("Connection should close due to unknown message type")
|
|
}
|
|
}
|
|
|
|
func TestClose(t *testing.T) {
|
|
m0 := newTestModel()
|
|
m1 := newTestModel()
|
|
|
|
ar, aw := io.Pipe()
|
|
br, bw := io.Pipe()
|
|
|
|
c0 := NewConnection(c0ID, ar, bw, m0, "name", CompressAlways).(wireFormatConnection).next.(*rawConnection)
|
|
c0.Start()
|
|
c1 := NewConnection(c1ID, br, aw, m1, "name", CompressAlways)
|
|
c1.Start()
|
|
c0.ClusterConfig(ClusterConfigMessage{})
|
|
c1.ClusterConfig(ClusterConfigMessage{})
|
|
|
|
c0.close(nil)
|
|
|
|
<-c0.closed
|
|
if !m0.isClosed() {
|
|
t.Fatal("Connection should be closed")
|
|
}
|
|
|
|
// None of these should panic, some should return an error
|
|
|
|
if c0.ping() {
|
|
t.Error("Ping should not return true")
|
|
}
|
|
|
|
c0.Index("default", nil, 0, nil)
|
|
c0.Index("default", nil, 0, nil)
|
|
|
|
if _, err := c0.Request("default", "foo", 0, 0, nil, 0, nil); err == nil {
|
|
t.Error("Request should return an error")
|
|
}
|
|
}
|
|
|
|
func TestElementSizeExceededNested(t *testing.T) {
|
|
m := ClusterConfigMessage{
|
|
Folders: []Folder{
|
|
{ID: "longstringlongstringlongstringinglongstringlongstringlonlongstringlongstringlon"},
|
|
},
|
|
}
|
|
_, err := m.EncodeXDR(ioutil.Discard)
|
|
if err == nil {
|
|
t.Errorf("ID length %d > max 64, but no error", len(m.Folders[0].ID))
|
|
}
|
|
}
|
|
|
|
func TestMarshalIndexMessage(t *testing.T) {
|
|
var quickCfg = &quick.Config{MaxCountScale: 10}
|
|
if testing.Short() {
|
|
quickCfg = nil
|
|
}
|
|
|
|
f := func(m1 IndexMessage) bool {
|
|
for i, f := range m1.Files {
|
|
m1.Files[i].CachedSize = 0
|
|
for j := range f.Blocks {
|
|
f.Blocks[j].Offset = 0
|
|
if len(f.Blocks[j].Hash) == 0 {
|
|
f.Blocks[j].Hash = nil
|
|
}
|
|
}
|
|
}
|
|
|
|
return testMarshal(t, "index", &m1, &IndexMessage{})
|
|
}
|
|
|
|
if err := quick.Check(f, quickCfg); err != nil {
|
|
t.Error(err)
|
|
}
|
|
}
|
|
|
|
func TestMarshalRequestMessage(t *testing.T) {
|
|
var quickCfg = &quick.Config{MaxCountScale: 10}
|
|
if testing.Short() {
|
|
quickCfg = nil
|
|
}
|
|
|
|
f := func(m1 RequestMessage) bool {
|
|
return testMarshal(t, "request", &m1, &RequestMessage{})
|
|
}
|
|
|
|
if err := quick.Check(f, quickCfg); err != nil {
|
|
t.Error(err)
|
|
}
|
|
}
|
|
|
|
func TestMarshalResponseMessage(t *testing.T) {
|
|
var quickCfg = &quick.Config{MaxCountScale: 10}
|
|
if testing.Short() {
|
|
quickCfg = nil
|
|
}
|
|
|
|
f := func(m1 ResponseMessage) bool {
|
|
if len(m1.Data) == 0 {
|
|
m1.Data = nil
|
|
}
|
|
return testMarshal(t, "response", &m1, &ResponseMessage{})
|
|
}
|
|
|
|
if err := quick.Check(f, quickCfg); err != nil {
|
|
t.Error(err)
|
|
}
|
|
}
|
|
|
|
func TestMarshalClusterConfigMessage(t *testing.T) {
|
|
var quickCfg = &quick.Config{MaxCountScale: 10}
|
|
if testing.Short() {
|
|
quickCfg = nil
|
|
}
|
|
|
|
f := func(m1 ClusterConfigMessage) bool {
|
|
return testMarshal(t, "clusterconfig", &m1, &ClusterConfigMessage{})
|
|
}
|
|
|
|
if err := quick.Check(f, quickCfg); err != nil {
|
|
t.Error(err)
|
|
}
|
|
}
|
|
|
|
func TestMarshalCloseMessage(t *testing.T) {
|
|
var quickCfg = &quick.Config{MaxCountScale: 10}
|
|
if testing.Short() {
|
|
quickCfg = nil
|
|
}
|
|
|
|
f := func(m1 CloseMessage) bool {
|
|
return testMarshal(t, "close", &m1, &CloseMessage{})
|
|
}
|
|
|
|
if err := quick.Check(f, quickCfg); err != nil {
|
|
t.Error(err)
|
|
}
|
|
}
|
|
|
|
type message interface {
|
|
EncodeXDR(io.Writer) (int, error)
|
|
DecodeXDR(io.Reader) error
|
|
}
|
|
|
|
func testMarshal(t *testing.T, prefix string, m1, m2 message) bool {
|
|
var buf bytes.Buffer
|
|
|
|
failed := func(bc []byte) {
|
|
bs, _ := json.MarshalIndent(m1, "", " ")
|
|
ioutil.WriteFile(prefix+"-1.txt", bs, 0644)
|
|
bs, _ = json.MarshalIndent(m2, "", " ")
|
|
ioutil.WriteFile(prefix+"-2.txt", bs, 0644)
|
|
if len(bc) > 0 {
|
|
f, _ := os.Create(prefix + "-data.txt")
|
|
fmt.Fprint(f, hex.Dump(bc))
|
|
f.Close()
|
|
}
|
|
}
|
|
|
|
_, err := m1.EncodeXDR(&buf)
|
|
if err != nil && strings.Contains(err.Error(), "exceeds size") {
|
|
return true
|
|
}
|
|
if err != nil {
|
|
failed(nil)
|
|
t.Fatal(err)
|
|
}
|
|
|
|
bc := make([]byte, len(buf.Bytes()))
|
|
copy(bc, buf.Bytes())
|
|
|
|
err = m2.DecodeXDR(&buf)
|
|
if err != nil {
|
|
failed(bc)
|
|
t.Fatal(err)
|
|
}
|
|
|
|
ok := reflect.DeepEqual(m1, m2)
|
|
if !ok {
|
|
failed(bc)
|
|
}
|
|
return ok
|
|
}
|