Skip to content

Commit 3af3bc9

Browse files
joshua-kimjoshua-kim
committed
nit
Signed-off-by: Joshua Kim <20001595+joshua-kim@users.noreply.github.com>
1 parent 2ad58e3 commit 3af3bc9

File tree

5 files changed

+68
-66
lines changed

5 files changed

+68
-66
lines changed

‎network/p2p/p2ptest/client.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@ func NewClient(
8080
return nil
8181
}
8282

83-
require.NoError(t, clientNetwork.Connected(rootCtx, clientNodeID, nil))
84-
require.NoError(t, clientNetwork.Connected(rootCtx, serverNodeID, nil))
85-
require.NoError(t, serverNetwork.Connected(rootCtx, clientNodeID, nil))
86-
require.NoError(t, serverNetwork.Connected(rootCtx, serverNodeID, nil))
83+
require.NoError(t, clientNetwork.Connected(ctx, clientNodeID, nil))
84+
require.NoError(t, clientNetwork.Connected(ctx, serverNodeID, nil))
85+
require.NoError(t, serverNetwork.Connected(ctx, clientNodeID, nil))
86+
require.NoError(t, serverNetwork.Connected(ctx, serverNodeID, nil))
8787

8888
require.NoError(t, serverNetwork.AddHandler(0, handler))
8989
return clientNetwork.NewClient(0)

‎x/sync/client_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ func newModifiedRangeProofHandler(
4343
db merkledb.MerkleDB,
4444
modifyResponse func(response *merkledb.RangeProof),
4545
) p2p.Handler {
46-
handler := NewSyncGetRangeProofHandler(logging.NoLog{}, db)
46+
handler := NewGetRangeProofHandler(logging.NoLog{}, db)
4747

4848
c := counter{m: 2}
4949
return &p2p.TestHandler{
@@ -79,7 +79,7 @@ func newModifiedChangeProofHandler(
7979
db merkledb.MerkleDB,
8080
modifyResponse func(response *merkledb.ChangeProof),
8181
) p2p.Handler {
82-
handler := NewSyncGetChangeProofHandler(logging.NoLog{}, db)
82+
handler := NewGetChangeProofHandler(logging.NoLog{}, db)
8383

8484
c := counter{m: 2}
8585
return &p2p.TestHandler{

‎x/sync/network_server.go‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ var (
4949
errInvalidBounds = errors.New("start key is greater than end key")
5050
errInvalidRootHash = fmt.Errorf("root hash must have length %d", hashing.HashLen)
5151

52-
_ p2p.Handler = (*SyncGetChangeProofHandler)(nil)
53-
_ p2p.Handler = (*SyncGetRangeProofHandler)(nil)
52+
_ p2p.Handler = (*GetChangeProofHandler)(nil)
53+
_ p2p.Handler = (*GetRangeProofHandler)(nil)
5454
)
5555

5656
func maybeBytesToMaybe(mb *pb.MaybeBytes) maybe.Maybe[[]byte] {
@@ -60,21 +60,21 @@ func maybeBytesToMaybe(mb *pb.MaybeBytes) maybe.Maybe[[]byte] {
6060
return maybe.Nothing[[]byte]()
6161
}
6262

63-
func NewSyncGetChangeProofHandler(log logging.Logger, db DB) *SyncGetChangeProofHandler {
64-
return &SyncGetChangeProofHandler{
63+
func NewGetChangeProofHandler(log logging.Logger, db DB) *GetChangeProofHandler {
64+
return &GetChangeProofHandler{
6565
log: log,
6666
db: db,
6767
}
6868
}
6969

70-
type SyncGetChangeProofHandler struct {
70+
type GetChangeProofHandler struct {
7171
log logging.Logger
7272
db DB
7373
}
7474

75-
func (*SyncGetChangeProofHandler) AppGossip(context.Context, ids.NodeID, []byte) {}
75+
func (*GetChangeProofHandler) AppGossip(context.Context, ids.NodeID, []byte) {}
7676

77-
func (s *SyncGetChangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID, _ time.Time, requestBytes []byte) ([]byte, *common.AppError) {
77+
func (g *GetChangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID, _ time.Time, requestBytes []byte) ([]byte, *common.AppError) {
7878
req := &pb.SyncGetChangeProofRequest{}
7979
if err := proto.Unmarshal(requestBytes, req); err != nil {
8080
return nil, &common.AppError{
@@ -115,11 +115,12 @@ func (s *SyncGetChangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID
115115
}
116116

117117
for keyLimit > 0 {
118-
changeProof, err := s.db.GetChangeProof(ctx, startRoot, endRoot, start, end, int(keyLimit))
118+
changeProof, err := g.db.GetChangeProof(ctx, startRoot, endRoot, start, end, int(keyLimit))
119119
if err != nil {
120120
if !errors.Is(err, merkledb.ErrInsufficientHistory) {
121121
// We should only fail to get a change proof if we have insufficient history.
122122
// Other errors are unexpected.
123+
// TODO define custom errors
123124
return nil, &common.AppError{
124125
Code: p2p.ErrUnexpected.Code,
125126
Message: fmt.Sprintf("failed to get change proof: %s", err),
@@ -138,7 +139,7 @@ func (s *SyncGetChangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID
138139
// Generate a range proof for the end root ID instead.
139140
proofBytes, err := getRangeProof(
140141
ctx,
141-
s.db,
142+
g.db,
142143
&pb.SyncGetRangeProofRequest{
143144
RootHash: req.EndRootHash,
144145
StartKey: req.StartKey,
@@ -191,21 +192,21 @@ func (s *SyncGetChangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID
191192
}
192193
}
193194

194-
func NewSyncGetRangeProofHandler(log logging.Logger, db DB) *SyncGetRangeProofHandler {
195-
return &SyncGetRangeProofHandler{
195+
func NewGetRangeProofHandler(log logging.Logger, db DB) *GetRangeProofHandler {
196+
return &GetRangeProofHandler{
196197
log: log,
197198
db: db,
198199
}
199200
}
200201

201-
type SyncGetRangeProofHandler struct {
202+
type GetRangeProofHandler struct {
202203
log logging.Logger
203204
db DB
204205
}
205206

206-
func (*SyncGetRangeProofHandler) AppGossip(context.Context, ids.NodeID, []byte) {}
207+
func (*GetRangeProofHandler) AppGossip(context.Context, ids.NodeID, []byte) {}
207208

208-
func (s *SyncGetRangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID, _ time.Time, requestBytes []byte) ([]byte, *common.AppError) {
209+
func (g *GetRangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID, _ time.Time, requestBytes []byte) ([]byte, *common.AppError) {
209210
req := &pb.SyncGetRangeProofRequest{}
210211
if err := proto.Unmarshal(requestBytes, req); err != nil {
211212
return nil, &common.AppError{
@@ -227,7 +228,7 @@ func (s *SyncGetRangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID,
227228

228229
proofBytes, err := getRangeProof(
229230
ctx,
230-
s.db,
231+
g.db,
231232
req,
232233
func(rangeProof *merkledb.RangeProof) ([]byte, error) {
233234
return proto.Marshal(rangeProof.ToProto())

‎x/sync/network_server_test.go‎

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ func Test_Server_GetRangeProof(t *testing.T) {
8585
expectedErr: p2p.ErrUnexpected,
8686
},
8787
{
88-
name: "key limit too large",
88+
name: "response bounded by key limit",
8989
request: &pb.SyncGetRangeProofRequest{
9090
RootHash: smallTrieRoot[:],
9191
KeyLimit: 2 * defaultRequestKeyLimit,
@@ -94,7 +94,7 @@ func Test_Server_GetRangeProof(t *testing.T) {
9494
expectedResponseLen: defaultRequestKeyLimit,
9595
},
9696
{
97-
name: "bytes limit too large",
97+
name: "response bounded by byte limit",
9898
request: &pb.SyncGetRangeProofRequest{
9999
RootHash: smallTrieRoot[:],
100100
KeyLimit: defaultRequestKeyLimit,
@@ -118,7 +118,7 @@ func Test_Server_GetRangeProof(t *testing.T) {
118118
t.Run(test.name, func(t *testing.T) {
119119
require := require.New(t)
120120

121-
handler := NewSyncGetRangeProofHandler(logging.NoLog{}, smallTrieDB)
121+
handler := NewGetRangeProofHandler(logging.NoLog{}, smallTrieDB)
122122
requestBytes, err := proto.Marshal(test.request)
123123
require.NoError(err)
124124
responseBytes, err := handler.AppRequest(context.Background(), test.nodeID, time.Time{}, requestBytes)
@@ -130,17 +130,12 @@ func Test_Server_GetRangeProof(t *testing.T) {
130130
require.Nil(responseBytes)
131131
return
132132
}
133-
require.NotNil(responseBytes)
134133

135-
var proof *merkledb.RangeProof
136-
if !test.proofNil {
137-
var proofProto pb.RangeProof
138-
require.NoError(proto.Unmarshal(responseBytes, &proofProto))
134+
var proofProto pb.RangeProof
135+
require.NoError(proto.Unmarshal(responseBytes, &proofProto))
139136

140-
var p merkledb.RangeProof
141-
require.NoError(p.UnmarshalProto(&proofProto))
142-
proof = &p
143-
}
137+
var proof merkledb.RangeProof
138+
require.NoError(proof.UnmarshalProto(&proofProto))
144139

145140
if test.expectedResponseLen > 0 {
146141
require.LessOrEqual(len(proof.KeyValues), test.expectedResponseLen)
@@ -344,7 +339,7 @@ func Test_Server_GetChangeProof(t *testing.T) {
344339
t.Run(test.name, func(t *testing.T) {
345340
require := require.New(t)
346341

347-
handler := NewSyncGetChangeProofHandler(logging.NoLog{}, serverDB)
342+
handler := NewGetChangeProofHandler(logging.NoLog{}, serverDB)
348343

349344
requestBytes, err := proto.Marshal(test.request)
350345
require.NoError(err)

0 commit comments

Comments
 (0)