-
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
Open
jkawan
wants to merge
8
commits into
main
Choose a base branch
from
feat/no-error-return
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+934
−63
Open
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
6b39f59
feat: no error return on connection close
c42b242
feat: no error return on connection close
829e00e
feat: no error return on connection close
b255d66
feat: no error return on connection close
3afdaa0
feat: no error return on connection close
4de8be1
feat: no error return on connection close
a43fdd1
feat: no error return on connection close
762277d
feat: addressed review comments
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,207 @@ | ||
// 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 | ||
closed bool | ||
closeChan chan struct{} | ||
} | ||
|
||
func newTestConn() *testConn { | ||
return &testConn{ | ||
writeChan: make(chan []byte, 100), | ||
closeChan: make(chan struct{}), | ||
} | ||
} | ||
|
||
func (c *testConn) Read(b []byte) (n int, err error) { return 0, nil } | ||
func (c *testConn) Write(b []byte) (n int, err error) { | ||
select { | ||
case c.writeChan <- b: | ||
return len(b), nil | ||
case <-c.closeChan: | ||
return 0, io.EOF | ||
} | ||
} | ||
func (c *testConn) Close() error { | ||
if !c.closed { | ||
close(c.closeChan) | ||
c.closed = true | ||
} | ||
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) | ||
go mux.Start() | ||
go func() { | ||
<-conn.(*testConn).closeChan | ||
mux.Stop() | ||
}() | ||
|
||
return protocol.ProtocolOptions{ | ||
ConnectionId: connection.ConnectionId{ | ||
LocalAddr: testAddr{}, | ||
RemoteAddr: testAddr{}, | ||
}, | ||
Muxer: mux, | ||
Logger: slog.Default(), | ||
} | ||
} | ||
|
||
func TestNewBlockFetch(t *testing.T) { | ||
conn := newTestConn() | ||
defer conn.Close() | ||
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 := newTestConn() | ||
defer conn.Close() | ||
cfg := NewConfig() | ||
bf := New(getTestProtocolOptions(conn), &cfg) | ||
|
||
// Start protocols | ||
bf.Client.Start() | ||
defer bf.Client.Stop() | ||
bf.Server.Start() | ||
defer bf.Server.Stop() | ||
|
||
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) | ||
}) | ||
|
||
t.Run("EOF error when done", func(t *testing.T) { | ||
// Send done message to properly transition to done state | ||
err := bf.Client.SendMessage(NewMsgClientDone()) | ||
assert.NoError(t, err) | ||
|
||
// Wait for state transition | ||
time.Sleep(100 * time.Millisecond) | ||
|
||
err = bf.HandleConnectionError(io.EOF) | ||
assert.NoError(t, err, "expected no error when protocol is in done state") | ||
}) | ||
} | ||
|
||
func TestCallbackRegistration(t *testing.T) { | ||
conn := newTestConn() | ||
defer conn.Close() | ||
|
||
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 := newTestConn() | ||
defer conn.Close() | ||
cfg := NewConfig() | ||
client := NewClient(getTestProtocolOptions(conn), &cfg) | ||
|
||
t.Run("Client can send messages", func(t *testing.T) { | ||
client.Start() | ||
defer client.Stop() | ||
|
||
// Send a done message | ||
err := client.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") | ||
} | ||
}) | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -109,8 +109,12 @@ func (c *Client) Stop() error { | |
"protocol", ProtocolName, | ||
"connection_id", c.callbackContext.ConnectionId.String(), | ||
) | ||
msg := NewMsgClientDone() | ||
err = c.SendMessage(msg) | ||
if !c.IsDone() { | ||
msg := NewMsgClientDone() | ||
if err = c.SendMessage(msg); err != nil { | ||
return | ||
} | ||
} | ||
}) | ||
return err | ||
} | ||
|
@@ -196,6 +200,8 @@ func (c *Client) messageHandler(msg protocol.Message) error { | |
err = c.handleBlock(msg) | ||
case MessageTypeBatchDone: | ||
err = c.handleBatchDone() | ||
case MessageTypeClientDone: | ||
return nil | ||
|
||
default: | ||
err = fmt.Errorf( | ||
"%s: received unexpected message type %d", | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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?