Skip to content

Commit 0b3c21b

Browse files
committed
nit
Signed-off-by: Joshua Kim <20001595+joshua-kim@users.noreply.github.com>
1 parent 9974a69 commit 0b3c21b

File tree

4 files changed

+59
-63
lines changed

4 files changed

+59
-63
lines changed

network/p2p/p2ptest/client.go

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,19 @@ import (
2121

2222
// NewClient generates a client-server pair and returns the client used to
2323
// communicate with a server with the specified handler
24-
func NewClient(t *testing.T, rootCtx context.Context, handler p2p.Handler) *p2p.Client {
24+
func NewClient(
25+
t *testing.T,
26+
rootCtx context.Context,
27+
handler p2p.Handler,
28+
clientNodeID ids.NodeID,
29+
serverNodeID ids.NodeID,
30+
) *p2p.Client {
2531
clientSender := &enginetest.Sender{}
2632
serverSender := &enginetest.Sender{}
2733

28-
clientNodeID := ids.GenerateTestNodeID()
2934
clientNetwork, err := p2p.NewNetwork(logging.NoLog{}, clientSender, prometheus.NewRegistry(), "")
3035
require.NoError(t, err)
3136

32-
serverNodeID := ids.GenerateTestNodeID()
3337
serverNetwork, err := p2p.NewNetwork(logging.NoLog{}, serverSender, prometheus.NewRegistry(), "")
3438
require.NoError(t, err)
3539

network/p2p/p2ptest/client_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ func TestNewClient_AppGossip(t *testing.T) {
2727
},
2828
}
2929

30-
client := NewClient(t, ctx, testHandler)
30+
client := NewClient(t, ctx, testHandler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
3131
require.NoError(client.AppGossip(ctx, common.SendConfig{}, []byte("foobar")))
3232
<-appGossipChan
3333
}
@@ -94,7 +94,7 @@ func TestNewClient_AppRequest(t *testing.T) {
9494
},
9595
}
9696

97-
client := NewClient(t, ctx, testHandler)
97+
client := NewClient(t, ctx, testHandler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
9898
require.NoError(tt.appRequestF(
9999
ctx,
100100
client,

x/sync/network_server.go

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -75,15 +75,15 @@ type SyncGetChangeProofHandler struct {
7575
func (*SyncGetChangeProofHandler) AppGossip(context.Context, ids.NodeID, []byte) {}
7676

7777
func (s *SyncGetChangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID, _ time.Time, requestBytes []byte) ([]byte, *common.AppError) {
78-
request := &pb.SyncGetChangeProofRequest{}
79-
if err := proto.Unmarshal(requestBytes, request); err != nil {
78+
req := &pb.SyncGetChangeProofRequest{}
79+
if err := proto.Unmarshal(requestBytes, req); err != nil {
8080
return nil, &common.AppError{
8181
Code: p2p.ErrUnexpected.Code,
8282
Message: fmt.Sprintf("failed to unmarshal request: %s", err),
8383
}
8484
}
8585

86-
if err := validateChangeProofRequest(request); err != nil {
86+
if err := validateChangeProofRequest(req); err != nil {
8787
return nil, &common.AppError{
8888
Code: p2p.ErrUnexpected.Code,
8989
Message: fmt.Sprintf("invalid request: %s", err),
@@ -92,21 +92,21 @@ func (s *SyncGetChangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID
9292

9393
// override limits if they exceed caps
9494
var (
95-
keyLimit = min(request.KeyLimit, maxKeyValuesLimit)
96-
bytesLimit = min(int(request.BytesLimit), maxByteSizeLimit)
97-
start = maybeBytesToMaybe(request.StartKey)
98-
end = maybeBytesToMaybe(request.EndKey)
95+
keyLimit = min(req.KeyLimit, maxKeyValuesLimit)
96+
bytesLimit = min(int(req.BytesLimit), maxByteSizeLimit)
97+
start = maybeBytesToMaybe(req.StartKey)
98+
end = maybeBytesToMaybe(req.EndKey)
9999
)
100100

101-
startRoot, err := ids.ToID(request.StartRootHash)
101+
startRoot, err := ids.ToID(req.StartRootHash)
102102
if err != nil {
103103
return nil, &common.AppError{
104104
Code: p2p.ErrUnexpected.Code,
105105
Message: fmt.Sprintf("failed to parse start root hash: %s", err),
106106
}
107107
}
108108

109-
endRoot, err := ids.ToID(request.EndRootHash)
109+
endRoot, err := ids.ToID(req.EndRootHash)
110110
if err != nil {
111111
return nil, &common.AppError{
112112
Code: p2p.ErrUnexpected.Code,
@@ -140,11 +140,11 @@ func (s *SyncGetChangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID
140140
ctx,
141141
g.db,
142142
&pb.SyncGetRangeProofRequest{
143-
RootHash: request.EndRootHash,
144-
StartKey: request.StartKey,
145-
EndKey: request.EndKey,
146-
KeyLimit: request.KeyLimit,
147-
BytesLimit: request.BytesLimit,
143+
RootHash: req.EndRootHash,
144+
StartKey: req.StartKey,
145+
EndKey: req.EndKey,
146+
KeyLimit: req.KeyLimit,
147+
BytesLimit: req.BytesLimit,
148148
},
149149
func(rangeProof *merkledb.RangeProof) ([]byte, error) {
150150
return proto.Marshal(&pb.SyncGetChangeProofResponse{
@@ -191,10 +191,6 @@ func (s *SyncGetChangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID
191191
}
192192
}
193193

194-
func (*SyncGetChangeProofHandler) CrossChainAppRequest(context.Context, ids.ID, time.Time, []byte) ([]byte, error) {
195-
return nil, nil
196-
}
197-
198194
func NewSyncGetRangeProofHandler(log logging.Logger, db DB) *SyncGetRangeProofHandler {
199195
return &SyncGetRangeProofHandler{
200196
log: log,
@@ -210,29 +206,29 @@ type SyncGetRangeProofHandler struct {
210206
func (*SyncGetRangeProofHandler) AppGossip(context.Context, ids.NodeID, []byte) {}
211207

212208
func (s *SyncGetRangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID, _ time.Time, requestBytes []byte) ([]byte, *common.AppError) {
213-
request := &pb.SyncGetRangeProofRequest{}
214-
if err := proto.Unmarshal(requestBytes, request); err != nil {
209+
req := &pb.SyncGetRangeProofRequest{}
210+
if err := proto.Unmarshal(requestBytes, req); err != nil {
215211
return nil, &common.AppError{
216212
Code: p2p.ErrUnexpected.Code,
217213
Message: fmt.Sprintf("failed to unmarshal request: %s", err),
218214
}
219215
}
220216

221-
if err := validateRangeProofRequest(request); err != nil {
217+
if err := validateRangeProofRequest(req); err != nil {
222218
return nil, &common.AppError{
223219
Code: p2p.ErrUnexpected.Code,
224220
Message: fmt.Sprintf("invalid range proof request: %s", err),
225221
}
226222
}
227223

228224
// override limits if they exceed caps
229-
request.KeyLimit = min(request.KeyLimit, maxKeyValuesLimit)
230-
request.BytesLimit = min(request.BytesLimit, maxByteSizeLimit)
225+
req.KeyLimit = min(req.KeyLimit, maxKeyValuesLimit)
226+
req.BytesLimit = min(req.BytesLimit, maxByteSizeLimit)
231227

232228
proofBytes, err := getRangeProof(
233229
ctx,
234230
s.db,
235-
request,
231+
req,
236232
func(rangeProof *merkledb.RangeProof) ([]byte, error) {
237233
return proto.Marshal(rangeProof.ToProto())
238234
},
@@ -247,10 +243,6 @@ func (s *SyncGetRangeProofHandler) AppRequest(ctx context.Context, _ ids.NodeID,
247243
return proofBytes, nil
248244
}
249245

250-
func (*SyncGetRangeProofHandler) CrossChainAppRequest(context.Context, ids.ID, time.Time, []byte) ([]byte, error) {
251-
return nil, nil
252-
}
253-
254246
// Get the range proof specified by [req].
255247
// If the generated proof is too large, the key limit is reduced
256248
// and the proof is regenerated. This process is repeated until

x/sync/sync_test.go

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ func Test_Completion(t *testing.T) {
7373
ctx := context.Background()
7474
syncer, err := NewManager(ManagerConfig{
7575
DB: db,
76-
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, emptyDB)),
77-
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, emptyDB)),
76+
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, emptyDB), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
77+
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, emptyDB), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
7878
TargetRoot: emptyRoot,
7979
SimultaneousWorkLimit: 5,
8080
Log: logging.NoLog{},
@@ -178,8 +178,8 @@ func Test_Sync_FindNextKey_InSync(t *testing.T) {
178178
ctx := context.Background()
179179
syncer, err := NewManager(ManagerConfig{
180180
DB: db,
181-
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync)),
182-
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync)),
181+
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
182+
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
183183
TargetRoot: syncRoot,
184184
SimultaneousWorkLimit: 5,
185185
Log: logging.NoLog{},
@@ -377,8 +377,8 @@ func Test_Sync_FindNextKey_ExtraValues(t *testing.T) {
377377
ctx := context.Background()
378378
syncer, err := NewManager(ManagerConfig{
379379
DB: db,
380-
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync)),
381-
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync)),
380+
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
381+
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
382382
TargetRoot: syncRoot,
383383
SimultaneousWorkLimit: 5,
384384
Log: logging.NoLog{},
@@ -440,7 +440,7 @@ func TestFindNextKeyEmptyEndProof(t *testing.T) {
440440
syncer, err := NewManager(ManagerConfig{
441441
DB: db,
442442
RangeProofClient: &p2p.Client{},
443-
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, db)),
443+
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, db), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
444444
TargetRoot: ids.Empty,
445445
SimultaneousWorkLimit: 5,
446446
Log: logging.NoLog{},
@@ -508,8 +508,8 @@ func Test_Sync_FindNextKey_DifferentChild(t *testing.T) {
508508
ctx := context.Background()
509509
syncer, err := NewManager(ManagerConfig{
510510
DB: db,
511-
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync)),
512-
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync)),
511+
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
512+
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
513513
TargetRoot: syncRoot,
514514
SimultaneousWorkLimit: 5,
515515
Log: logging.NoLog{},
@@ -779,7 +779,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
779779
response.KeyValues = append(response.KeyValues, merkledb.KeyValue{})
780780
})
781781

782-
return p2ptest.NewClient(t, context.Background(), handler)
782+
return p2ptest.NewClient(t, context.Background(), handler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
783783
},
784784
},
785785
{
@@ -789,7 +789,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
789789
response.KeyValues = response.KeyValues[min(1, len(response.KeyValues)):]
790790
})
791791

792-
return p2ptest.NewClient(t, context.Background(), handler)
792+
return p2ptest.NewClient(t, context.Background(), handler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
793793
},
794794
},
795795
{
@@ -815,7 +815,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
815815
}
816816
})
817817

818-
return p2ptest.NewClient(t, context.Background(), handler)
818+
return p2ptest.NewClient(t, context.Background(), handler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
819819
},
820820
},
821821
{
@@ -826,7 +826,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
826826
_ = slices.Delete(response.KeyValues, i, min(len(response.KeyValues), i+1))
827827
})
828828

829-
return p2ptest.NewClient(t, context.Background(), handler)
829+
return p2ptest.NewClient(t, context.Background(), handler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
830830
},
831831
},
832832
{
@@ -837,7 +837,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
837837
response.EndProof = nil
838838
})
839839

840-
return p2ptest.NewClient(t, context.Background(), handler)
840+
return p2ptest.NewClient(t, context.Background(), handler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
841841
},
842842
},
843843
{
@@ -847,7 +847,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
847847
response.EndProof = nil
848848
})
849849

850-
return p2ptest.NewClient(t, context.Background(), handler)
850+
return p2ptest.NewClient(t, context.Background(), handler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
851851
},
852852
},
853853
{
@@ -859,7 +859,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
859859
response.KeyValues = nil
860860
})
861861

862-
return p2ptest.NewClient(t, context.Background(), handler)
862+
return p2ptest.NewClient(t, context.Background(), handler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
863863
},
864864
},
865865
{
@@ -868,7 +868,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
868868
return p2ptest.NewClient(t, context.Background(), &flakyHandler{
869869
Handler: NewSyncGetRangeProofHandler(logging.NoLog{}, db),
870870
c: &counter{m: 2},
871-
})
871+
}, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
872872
},
873873
},
874874
{
@@ -878,7 +878,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
878878
response.KeyChanges = append(response.KeyChanges, make([]merkledb.KeyChange, defaultRequestKeyLimit)...)
879879
})
880880

881-
return p2ptest.NewClient(t, context.Background(), handler)
881+
return p2ptest.NewClient(t, context.Background(), handler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
882882
},
883883
},
884884
{
@@ -888,7 +888,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
888888
response.KeyChanges = response.KeyChanges[min(1, len(response.KeyChanges)):]
889889
})
890890

891-
return p2ptest.NewClient(t, context.Background(), handler)
891+
return p2ptest.NewClient(t, context.Background(), handler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
892892
},
893893
},
894894
{
@@ -899,7 +899,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
899899
_ = slices.Delete(response.KeyChanges, i, min(len(response.KeyChanges), i+1))
900900
})
901901

902-
return p2ptest.NewClient(t, context.Background(), handler)
902+
return p2ptest.NewClient(t, context.Background(), handler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
903903
},
904904
},
905905
{
@@ -910,7 +910,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
910910
response.EndProof = nil
911911
})
912912

913-
return p2ptest.NewClient(t, context.Background(), handler)
913+
return p2ptest.NewClient(t, context.Background(), handler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
914914
},
915915
},
916916
{
@@ -919,7 +919,7 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
919919
return p2ptest.NewClient(t, context.Background(), &flakyHandler{
920920
Handler: NewSyncGetChangeProofHandler(logging.NoLog{}, db),
921921
c: &counter{m: 2},
922-
})
922+
}, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
923923
},
924924
},
925925
}
@@ -948,13 +948,13 @@ func Test_Sync_Result_Correct_Root(t *testing.T) {
948948
)
949949

950950
rangeProofHandler := NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync)
951-
rangeProofClient = p2ptest.NewClient(t, ctx, rangeProofHandler)
951+
rangeProofClient = p2ptest.NewClient(t, ctx, rangeProofHandler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
952952
if tt.rangeProofClient != nil {
953953
rangeProofClient = tt.rangeProofClient(dbToSync)
954954
}
955955

956956
changeProofHandler := NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync)
957-
changeProofClient = p2ptest.NewClient(t, ctx, changeProofHandler)
957+
changeProofClient = p2ptest.NewClient(t, ctx, changeProofHandler, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
958958
if tt.changeProofClient != nil {
959959
changeProofClient = tt.changeProofClient(dbToSync)
960960
}
@@ -1029,8 +1029,8 @@ func Test_Sync_Result_Correct_Root_With_Sync_Restart(t *testing.T) {
10291029
ctx := context.Background()
10301030
syncer, err := NewManager(ManagerConfig{
10311031
DB: db,
1032-
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync)),
1033-
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync)),
1032+
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
1033+
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
10341034
TargetRoot: syncRoot,
10351035
SimultaneousWorkLimit: 5,
10361036
Log: logging.NoLog{},
@@ -1056,8 +1056,8 @@ func Test_Sync_Result_Correct_Root_With_Sync_Restart(t *testing.T) {
10561056

10571057
newSyncer, err := NewManager(ManagerConfig{
10581058
DB: db,
1059-
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync)),
1060-
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync)),
1059+
RangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
1060+
ChangeProofClient: p2ptest.NewClient(t, ctx, NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync), ids.GenerateTestNodeID(), ids.GenerateTestNodeID()),
10611061
TargetRoot: syncRoot,
10621062
SimultaneousWorkLimit: 5,
10631063
Log: logging.NoLog{},
@@ -1129,12 +1129,12 @@ func Test_Sync_Result_Correct_Root_Update_Root_During(t *testing.T) {
11291129
rangeProofClient := p2ptest.NewClient(t, ctx, &testHandler{
11301130
handler: NewSyncGetRangeProofHandler(logging.NoLog{}, dbToSync),
11311131
updatedRootChan: updatedRootChan,
1132-
})
1132+
}, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
11331133

11341134
changeProofClient := p2ptest.NewClient(t, ctx, &testHandler{
11351135
handler: NewSyncGetChangeProofHandler(logging.NoLog{}, dbToSync),
11361136
updatedRootChan: updatedRootChan,
1137-
})
1137+
}, ids.GenerateTestNodeID(), ids.GenerateTestNodeID())
11381138

11391139
syncer, err := NewManager(ManagerConfig{
11401140
DB: db,

0 commit comments

Comments
 (0)