-
Notifications
You must be signed in to change notification settings - Fork 19
Not returning on connection close for chainsync, block-fetch and tx-submission protocol #1141
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
base: main
Are you sure you want to change the base?
Changes from 3 commits
6b39f59
c42b242
829e00e
b255d66
3afdaa0
4de8be1
a43fdd1
762277d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,171 @@ | ||
// Copyright 2025 Blink Labs Software | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
package blockfetch | ||
|
||
import ( | ||
"errors" | ||
"io" | ||
"log/slog" | ||
"net" | ||
"testing" | ||
"time" | ||
|
||
"github.com/blinklabs-io/gouroboros/connection" | ||
"github.com/blinklabs-io/gouroboros/ledger" | ||
"github.com/blinklabs-io/gouroboros/muxer" | ||
"github.com/blinklabs-io/gouroboros/protocol" | ||
"github.com/blinklabs-io/gouroboros/protocol/common" | ||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
// testAddr implements net.Addr for testing | ||
type testAddr struct{} | ||
|
||
func (a testAddr) Network() string { return "test" } | ||
func (a testAddr) String() string { return "test-addr" } | ||
|
||
// testConn implements net.Conn for testing with buffered writes | ||
type testConn struct { | ||
writeChan chan []byte | ||
} | ||
|
||
func (c *testConn) Read(b []byte) (n int, err error) { return 0, nil } | ||
func (c *testConn) Write(b []byte) (n int, err error) { | ||
c.writeChan <- b | ||
return len(b), nil | ||
} | ||
func (c *testConn) Close() error { return nil } | ||
func (c *testConn) LocalAddr() net.Addr { return testAddr{} } | ||
func (c *testConn) RemoteAddr() net.Addr { return testAddr{} } | ||
func (c *testConn) SetDeadline(t time.Time) error { return nil } | ||
func (c *testConn) SetReadDeadline(t time.Time) error { return nil } | ||
func (c *testConn) SetWriteDeadline(t time.Time) error { return nil } | ||
|
||
func getTestProtocolOptions(conn net.Conn) protocol.ProtocolOptions { | ||
mux := muxer.New(conn) | ||
return protocol.ProtocolOptions{ | ||
ConnectionId: connection.ConnectionId{ | ||
LocalAddr: testAddr{}, | ||
RemoteAddr: testAddr{}, | ||
}, | ||
Muxer: mux, | ||
Logger: slog.Default(), | ||
} | ||
} | ||
|
||
func TestNewBlockFetch(t *testing.T) { | ||
conn := &testConn{writeChan: make(chan []byte, 1)} | ||
cfg := NewConfig() | ||
bf := New(getTestProtocolOptions(conn), &cfg) | ||
assert.NotNil(t, bf.Client) | ||
assert.NotNil(t, bf.Server) | ||
} | ||
|
||
func TestConfigOptions(t *testing.T) { | ||
t.Run("Default config", func(t *testing.T) { | ||
cfg := NewConfig() | ||
assert.Equal(t, 5*time.Second, cfg.BatchStartTimeout) | ||
assert.Equal(t, 60*time.Second, cfg.BlockTimeout) | ||
}) | ||
|
||
t.Run("Custom config", func(t *testing.T) { | ||
cfg := NewConfig( | ||
WithBatchStartTimeout(10*time.Second), | ||
WithBlockTimeout(30*time.Second), | ||
WithRecvQueueSize(100), | ||
) | ||
assert.Equal(t, 10*time.Second, cfg.BatchStartTimeout) | ||
assert.Equal(t, 30*time.Second, cfg.BlockTimeout) | ||
assert.Equal(t, 100, cfg.RecvQueueSize) | ||
}) | ||
} | ||
|
||
func TestConnectionErrorHandling(t *testing.T) { | ||
conn := &testConn{writeChan: make(chan []byte, 1)} | ||
cfg := NewConfig() | ||
bf := New(getTestProtocolOptions(conn), &cfg) | ||
|
||
t.Run("Non-EOF error when not done", func(t *testing.T) { | ||
err := bf.HandleConnectionError(errors.New("test error")) | ||
assert.Error(t, err) | ||
}) | ||
|
||
t.Run("EOF error when not done", func(t *testing.T) { | ||
err := bf.HandleConnectionError(io.EOF) | ||
assert.Error(t, err) | ||
}) | ||
|
||
t.Run("Connection reset error", func(t *testing.T) { | ||
err := bf.HandleConnectionError(errors.New("connection reset by peer")) | ||
assert.Error(t, err) | ||
}) | ||
} | ||
|
||
func TestCallbackRegistration(t *testing.T) { | ||
conn := &testConn{writeChan: make(chan []byte, 1)} | ||
|
||
t.Run("Block callback registration", func(t *testing.T) { | ||
blockFunc := func(ctx CallbackContext, slot uint, block ledger.Block) error { | ||
return nil | ||
} | ||
cfg := NewConfig(WithBlockFunc(blockFunc)) | ||
client := NewClient(getTestProtocolOptions(conn), &cfg) | ||
assert.NotNil(t, client) | ||
assert.NotNil(t, cfg.BlockFunc) | ||
}) | ||
|
||
t.Run("RequestRange callback registration", func(t *testing.T) { | ||
requestRangeFunc := func(ctx CallbackContext, start, end common.Point) error { | ||
return nil | ||
} | ||
cfg := NewConfig(WithRequestRangeFunc(requestRangeFunc)) | ||
server := NewServer(getTestProtocolOptions(conn), &cfg) | ||
assert.NotNil(t, server) | ||
assert.NotNil(t, cfg.RequestRangeFunc) | ||
}) | ||
} | ||
|
||
func TestClientMessageSending(t *testing.T) { | ||
conn := &testConn{writeChan: make(chan []byte, 1)} | ||
cfg := NewConfig() | ||
client := NewClient(getTestProtocolOptions(conn), &cfg) | ||
|
||
t.Run("Client can send messages", func(t *testing.T) { | ||
// Start the client protocol | ||
client.Start() | ||
|
||
// Send a done message | ||
err := client.Protocol.SendMessage(NewMsgClientDone()) | ||
assert.NoError(t, err) | ||
|
||
// Verify message was written to connection | ||
select { | ||
case <-conn.writeChan: | ||
// Message was sent successfully | ||
case <-time.After(100 * time.Millisecond): | ||
t.Fatal("timeout waiting for message send") | ||
} | ||
}) | ||
} | ||
|
||
func TestServerMessageHandling(t *testing.T) { | ||
conn := &testConn{writeChan: make(chan []byte, 1)} | ||
cfg := NewConfig() | ||
server := NewServer(getTestProtocolOptions(conn), &cfg) | ||
|
||
t.Run("Server can be started", func(t *testing.T) { | ||
server.Start() | ||
|
||
}) | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,6 +35,8 @@ type Client struct { | |
blockUseCallback bool | ||
onceStart sync.Once | ||
onceStop sync.Once | ||
currentState protocol.State | ||
stateMutex sync.Mutex | ||
} | ||
|
||
func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client { | ||
|
@@ -46,6 +48,7 @@ func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client { | |
config: cfg, | ||
blockChan: make(chan ledger.Block), | ||
startBatchResultChan: make(chan error), | ||
currentState: StateIdle, | ||
} | ||
c.callbackContext = CallbackContext{ | ||
Client: c, | ||
|
@@ -82,6 +85,18 @@ func NewClient(protoOptions protocol.ProtocolOptions, cfg *Config) *Client { | |
return c | ||
} | ||
|
||
func (c *Client) IsDone() bool { | ||
c.stateMutex.Lock() | ||
defer c.stateMutex.Unlock() | ||
return c.currentState.Id == StateDone.Id | ||
} | ||
|
||
func (c *Client) setState(newState protocol.State) { | ||
c.stateMutex.Lock() | ||
defer c.stateMutex.Unlock() | ||
c.currentState = newState | ||
} | ||
|
||
|
||
func (c *Client) Start() { | ||
c.onceStart.Do(func() { | ||
c.Protocol.Logger(). | ||
|
@@ -110,7 +125,11 @@ func (c *Client) Stop() error { | |
"connection_id", c.callbackContext.ConnectionId.String(), | ||
) | ||
msg := NewMsgClientDone() | ||
err = c.SendMessage(msg) | ||
if sendErr := c.SendMessage(msg); sendErr != nil { | ||
err = sendErr | ||
return | ||
} | ||
c.setState(StateDone) | ||
}) | ||
return err | ||
} | ||
|
@@ -196,6 +215,8 @@ func (c *Client) messageHandler(msg protocol.Message) error { | |
err = c.handleBlock(msg) | ||
case MessageTypeBatchDone: | ||
err = c.handleBatchDone() | ||
case MessageTypeClientDone: | ||
c.setState(StateDone) | ||
default: | ||
err = fmt.Errorf( | ||
"%s: received unexpected message type %d", | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These checks need to be done at the top level, in
Connection
. We have an error handler for muxer errors there, and we can check the state of all active protocols from there.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
made the cahange, could you please review?