-
Notifications
You must be signed in to change notification settings - Fork 73
Expand file tree
/
Copy pathtest_registrar.nim
More file actions
1636 lines (1308 loc) · 58.1 KB
/
Copy pathtest_registrar.nim
File metadata and controls
1636 lines (1308 loc) · 58.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# SPDX-License-Identifier: Apache-2.0 OR MIT
# Copyright (c) Status Research & Development GmbH
{.used.}
import chronos, math, results, tables
import
../../../libp2p/[
crypto/crypto,
extended_peer_record,
multiaddress,
peerid,
protocols/service_discovery/registrar,
protocols/service_discovery/types,
routing_record,
signed_envelope,
utils/iptree,
]
import ../../../libp2p/protocols/kademlia/protobuf as kadprotobuf
import ../../tools/[crypto, unittest]
import ./utils
func initMoment(secs: int64): Moment =
Moment.init(secs, Second)
func inFloatSecs(d: Duration): float64 =
d.secs.float64
proc makeAdvertisementWithServices(
services: seq[ServiceInfo],
privateKey: PrivateKey = PrivateKey.random(rng()).get(),
addrs: seq[MultiAddress] = @[],
seqNo: uint64 = Moment.now().epochSeconds.uint64,
): Advertisement =
let peerId = PeerId.init(privateKey).get()
var addressInfos: seq[AddressInfo]
for address in addrs:
addressInfos.add(AddressInfo(address: address))
let extRecord = ExtendedPeerRecord(
peerId: peerId, seqNo: seqNo, addresses: addressInfos, services: services
)
SignedExtendedPeerRecord.init(privateKey, extRecord).get()
suite "Service Discovery Registrar - Waiting Time Calculation":
test "waitingTime returns low value for empty cache with no IP similarity":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let ad = makeAdvertisement(addrs = @[makeMultiAddress("10.0.0.1")])
let now = Moment.now()
let serviceId = makeServiceId()
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
# With empty cache: c = 0, occupancy = 1.0, c_s = 0, ipSim = 0
# w = advertExpiry * 1.0 * (0 + 0 + safetyParam)
let expected =
round(discoConfig.advertExpiry.seconds.float64 * discoConfig.safetyParam)
check abs(w.inFloatSecs - expected) < 0.001
test "waitingTime increases with cache occupancy":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let serviceId1 = makeServiceId(1)
let serviceId2 = makeServiceId(2)
let ad1 = makeAdvertisement($serviceId1)
let ad2 = makeAdvertisement($serviceId2)
let now = Moment.now()
registrar.cache[serviceId1] = @[ad1]
registrar.cacheTimestamps[ad1.toAdvertisementKey()] = now
let w1 = registrar.waitingTime(discoConfig, ad1, 100, serviceId1, now)
registrar.cache[serviceId2] = @[ad2]
registrar.cacheTimestamps[ad2.toAdvertisementKey()] = now
let w2 = registrar.waitingTime(discoConfig, ad2, 100, serviceId2, now)
check w1 < w2
test "waitingTime increases with service similarity":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let serviceId1 = makeServiceId(1)
let serviceId2 = makeServiceId(2)
let serviceId3 = makeServiceId(3)
let serviceId4 = makeServiceId(4)
let ad1 = makeAdvertisement($serviceId1)
let ad2 = makeAdvertisement($serviceId2)
let ad3 = makeAdvertisement($serviceId3)
let ad4 = makeAdvertisement($serviceId4)
let ad5 = makeAdvertisement($serviceId4)
let ad6 = makeAdvertisement($serviceId4)
let now = Moment.now()
registrar.cache[serviceId1] = @[ad1]
registrar.cache[serviceId2] = @[ad2]
registrar.cache[serviceId3] = @[ad3]
registrar.cacheTimestamps[ad1.toAdvertisementKey()] = now
registrar.cacheTimestamps[ad2.toAdvertisementKey()] = now
registrar.cacheTimestamps[ad3.toAdvertisementKey()] = now
let w1 = registrar.waitingTime(discoConfig, ad1, 100, serviceId1, now)
registrar.cache.clear()
registrar.cacheTimestamps.clear()
registrar.cache[serviceId4] = @[ad4, ad5, ad6]
registrar.cacheTimestamps[ad4.toAdvertisementKey()] = now
registrar.cacheTimestamps[ad5.toAdvertisementKey()] = now
registrar.cacheTimestamps[ad6.toAdvertisementKey()] = now
let w2 = registrar.waitingTime(discoConfig, ad4, 100, serviceId4, now)
check w1 < w2
test "waitingTime returns 0.0 IP similarity for IPs not in tree":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement(addrs = @[makeMultiAddress("192.168.1.1")])
let now = Moment.now()
# Tree is empty so IP score is 0
check registrar.ipTree.ipScore(
IpAddress(family: IpAddressFamily.IPv4, address_v4: [192'u8, 168, 1, 1])
) == 0.0
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
check w == ZeroDuration
test "waitingTime uses maximum IP score across multiple addresses":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let serviceId = makeServiceId()
registrar.ipTree.insertIp(
IpAddress(family: IpAddressFamily.IPv4, address_v4: [192'u8, 168, 1, 10])
)
registrar.ipTree.insertIp(
IpAddress(family: IpAddressFamily.IPv4, address_v4: [192'u8, 168, 1, 20])
)
registrar.ipTree.insertIp(
IpAddress(family: IpAddressFamily.IPv4, address_v4: [192'u8, 168, 1, 30])
)
let ad = makeAdvertisement(
addrs = @[
makeMultiAddress("10.0.0.1"), # Different subnet – low score
makeMultiAddress("192.168.1.50"), # Same subnet – high score
]
)
let now = Moment.now()
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
check w > ZeroDuration
test "waitingTime at cache capacity returns high occupancy":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let ad = makeAdvertisement()
let serviceId = makeServiceId()
for i in 0 ..< 1000:
let testAd = makeAdvertisement($i)
registrar.cacheTimestamps[testAd.toAdvertisementKey()] = Moment.now()
let now = Moment.now()
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
# At capacity, occupancy = 100.0
# Allow 1 ns tolerance: float->ns truncation can lose a sub-nanosecond fraction
let expectedSecs =
round(discoConfig.advertExpiry.seconds.float64 * 100.0 * discoConfig.safetyParam)
check w.inFloatSecs >= expectedSecs - 1e-9
test "waitingTime formula includes safety parameter":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new(safetyParam = 0.5)
let ad = makeAdvertisement()
let now = Moment.now()
let serviceId = makeServiceId()
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
# Empty cache, no IP sim: w = advertExpiry * 1.0 * safetyParam
let expected =
ceil(discoConfig.advertExpiry.seconds.float64 * discoConfig.safetyParam)
check abs(w.inFloatSecs - expected) < 1.0
test "waitingTime ipSimCoefficient=0 eliminates IP similarity penalty":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new(ipSimCoefficient = 0.0)
let serviceId = makeServiceId()
# Six nodes on the same /24 already registered
for i in 1 .. 6:
let ip =
IpAddress(family: IpAddressFamily.IPv4, address_v4: [192'u8, 168, 1, uint8(i)])
registrar.ipTree.insertIp(ip)
let ad = makeAdvertisement(addrs = @[makeMultiAddress("192.168.1.7")])
registrar.cache[serviceId] = newSeq[Advertisement](6)
let now = Moment.now()
for i in 0 ..< 6:
registrar.cacheTimestamps[(peerId: ad.data.peerId, seqNo: uint64(i))] = now
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
# With ipSimCoefficient=0, ipSim is excluded; w is driven only by serviceSim (6/1000)
# w = 900 * ~1.0 * (0.006 + 0 + 1e-7) ≈ 5.4s → well under 10s
check w < 10.seconds
test "waitingTime ipSimCoefficient=1 (default) preserves IP similarity penalty":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new(ipSimCoefficient = 1.0)
let serviceId = makeServiceId()
for i in 1 .. 6:
let ip =
IpAddress(family: IpAddressFamily.IPv4, address_v4: [192'u8, 168, 1, uint8(i)])
registrar.ipTree.insertIp(ip)
let ad = makeAdvertisement(addrs = @[makeMultiAddress("192.168.1.7")])
let now = Moment.now()
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
# ipSim ≈ 0.97 for same /24; w should be in the hundreds of seconds
check w > 500.seconds
suite "Service Discovery Registrar - advertExpiry cap":
test "registration caps the offered tWaitFor at advertExpiry":
let advertExpiry = 100.secs
let conf = ServiceDiscoveryConfig.new(
advertExpiry = advertExpiry, safetyParam = 1.0, advertCacheCap = 10
)
let disco = setupServiceDiscoveryNode(discoConfig = conf)
let serviceName = "service"
let serviceId = serviceName.hashServiceId()
let advertiserKey = PrivateKey.random(rng()).get()
let advertiserId = PeerId.init(advertiserKey).get()
let adBytes = makeAdvertisement(serviceName, advertiserKey).encode().get()
# Saturate the cache: occupancy pins at 100.0, so w = 100*100*1.0 = 10000s.
for i in 0 ..< 10:
disco.registrar.cacheTimestamps[(peerId: randomPeerId(), seqNo: uint64(i))] =
Moment.now()
let inMsg = kadprotobuf.Message(
msgType: kadprotobuf.MessageType.register,
key: serviceId,
register: Opt.some(
kadprotobuf.RegisterMessage(
advertisement: adBytes,
status: Opt.none(kadprotobuf.RegistrationStatus),
ticket: Opt.none(Ticket),
)
),
)
let reply = disco.registration(advertiserId, inMsg).register.get()
check reply.status.get() == kadprotobuf.RegistrationStatus.Wait
check reply.ticket.get().tWaitFor.get() == advertExpiry
test "sustained overload keeps offering advertExpiry-length waits across retries":
let advertExpiry = 100.secs
let registrationWindow = 10.secs
let conf = ServiceDiscoveryConfig.new(
advertExpiry = advertExpiry,
safetyParam = 1.0,
advertCacheCap = 10,
registrationWindow = registrationWindow,
)
let disco = setupServiceDiscoveryNode(discoConfig = conf)
let serviceName = "service"
let serviceId = serviceName.hashServiceId()
let advertiserKey = PrivateKey.random(rng()).get()
let advertiserId = PeerId.init(advertiserKey).get()
let adBytes = makeAdvertisement(serviceName, advertiserKey).encode().get()
for i in 0 ..< 10:
disco.registrar.cacheTimestamps[(peerId: randomPeerId(), seqNo: uint64(i))] =
Moment.now()
let firstAttemptTime =
Moment.init((Moment.now() - advertExpiry).epochSeconds, Second)
var retryTicket = Ticket(
advertisement: adBytes,
tInit: firstAttemptTime,
tMod: firstAttemptTime,
tWaitFor: advertExpiry,
signature: Opt.none(seq[byte]),
)
check retryTicket.sign(disco.switch.peerInfo.privateKey).isOk()
let inMsg = kadprotobuf.Message(
msgType: kadprotobuf.MessageType.register,
key: serviceId,
register: Opt.some(
kadprotobuf.RegisterMessage(
advertisement: adBytes,
status: Opt.none(kadprotobuf.RegistrationStatus),
ticket: Opt.some(retryTicket),
)
),
)
let reply = disco.registration(advertiserId, inMsg).register.get()
check reply.status.get() == kadprotobuf.RegistrationStatus.Wait
check reply.ticket.get().tWaitFor.get() == advertExpiry
suite "Service Discovery Registrar - Lower Bound Enforcement":
test "waitingTime enforces service lower bound when exists":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId)
let now = initMoment(1000)
# bound = 1500, timestamp = 1000 → effective = 1500 - 0 = 1500
registrar.boundService[serviceId] = initMoment(1500)
registrar.timestampService[serviceId] = initMoment(1000)
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
check w >= 500.secs
test "waitingTime enforces IP lower bound when exists":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let ip = "192.168.1.50"
let ad = makeAdvertisement(addrs = @[makeMultiAddress(ip)])
let now = initMoment(1000)
let serviceId = makeServiceId()
registrar.boundIp[ip] = initMoment(1500)
registrar.timestampIp[ip] = initMoment(1000)
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
check w >= 500.secs
test "waitingTime IP lower bound is per IP address":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let ip1 = "192.168.1.1"
let ip2 = "10.0.0.1"
let now = initMoment(1000)
let serviceId = makeServiceId()
registrar.boundIp[ip1] = initMoment(1500)
registrar.timestampIp[ip1] = initMoment(1000)
let ad2 = makeAdvertisement(addrs = @[makeMultiAddress(ip2)])
let w2 = registrar.waitingTime(discoConfig, ad2, 1000, serviceId, now)
let ad1 = makeAdvertisement(addrs = @[makeMultiAddress(ip1)])
let w1 = registrar.waitingTime(discoConfig, ad1, 1000, serviceId, now)
check w1 > w2
test "waitingTime uses most restrictive lower bound":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new(advertExpiry = 2500.secs)
let serviceId = makeServiceId()
let ip1 = "192.168.1.1"
let ip2 = "10.0.0.1"
let now = initMoment(1000)
registrar.boundService[serviceId] = initMoment(2000)
registrar.timestampService[serviceId] = initMoment(1000)
registrar.boundIp[ip1] = initMoment(3000)
registrar.timestampIp[ip1] = initMoment(1000)
registrar.boundIp[ip2] = initMoment(1500)
registrar.timestampIp[ip2] = initMoment(1000)
let ad = makeAdvertisement(
$serviceId, addrs = @[makeMultiAddress(ip1), makeMultiAddress(ip2)]
)
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
check w >= 2000.secs
suite "Service Discovery Registrar - Lower Bound Updates":
test "updateLowerBounds stores service bound as w":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId)
let now = initMoment(1000)
let w = 500.secs
updateLowerBounds(registrar, serviceId, ad, w, now)
check serviceId in registrar.boundService
check registrar.boundService[serviceId] == now + w
check registrar.timestampService[serviceId] == now
test "updateLowerBounds updates service bound when w exceeds effective bound":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId)
let now = initMoment(1000)
registrar.boundService[serviceId] = initMoment(1500)
registrar.timestampService[serviceId] = initMoment(500)
# effective = 1500 - (1000 - 500) = 1000; new w = 1200 > 1000 → update
updateLowerBounds(registrar, serviceId, ad, 1200.secs, now)
check registrar.boundService[serviceId] == initMoment(2200)
check registrar.timestampService[serviceId] == initMoment(1000)
test "updateLowerBounds does not decrease service bound":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId)
let now = initMoment(1000)
registrar.boundService[serviceId] = initMoment(2500)
registrar.timestampService[serviceId] = initMoment(500)
# effective = 2500 - 500 = 2000; new w = 1000 < 2000 → no update
let oldBound = registrar.boundService[serviceId]
updateLowerBounds(registrar, serviceId, ad, 1000.secs, now)
check registrar.boundService[serviceId] == oldBound
test "updateLowerBounds updates IP bound for each address":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ip1 = "192.168.1.1"
let ip2 = "10.0.0.1"
let ad = makeAdvertisement(
$serviceId, addrs = @[makeMultiAddress(ip1), makeMultiAddress(ip2)]
)
let now = initMoment(1000)
let w = 500.secs
updateLowerBounds(registrar, serviceId, ad, w, now)
check ip1 in registrar.boundIp
check registrar.boundIp[ip1] == now + w
check registrar.timestampIp[ip1] == now
check ip2 in registrar.boundIp
check registrar.boundIp[ip2] == now + w
check registrar.timestampIp[ip2] == now
test "updateLowerBounds accumulates bounds correctly across multiple calls":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId)
updateLowerBounds(registrar, serviceId, ad, 500.secs, initMoment(1000))
check registrar.boundService[serviceId] == initMoment(1500)
updateLowerBounds(registrar, serviceId, ad, 800.secs, initMoment(1500))
check registrar.boundService[serviceId] == initMoment(2300)
updateLowerBounds(registrar, serviceId, ad, 1200.secs, initMoment(2000))
check registrar.boundService[serviceId] == initMoment(3200)
test "updateLowerBounds with empty addresses does not crash":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId, addrs = @[])
let now = initMoment(1000)
updateLowerBounds(registrar, serviceId, ad, 500.secs, now)
check registrar.boundService[serviceId] == initMoment(1500)
suite "Service Discovery Registrar - Cache Pruning":
test "pruneExpiredAds does nothing on empty registrar":
let registrar = Registrar.new()
pruneExpiredAds(registrar, 900.secs)
check registrar.cache.len == 0
check registrar.cacheTimestamps.len == 0
test "pruneExpiredAds keeps ad within expiry time":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId)
let now = Moment.now()
registrar.cache[serviceId] = @[ad]
registrar.cacheTimestamps[ad.toAdvertisementKey()] = now
pruneExpiredAds(registrar, 900.secs)
check ad in registrar.cache[serviceId]
check ad.toAdvertisementKey() in registrar.cacheTimestamps
test "pruneExpiredAds removes ad past expiry time":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId)
let now = Moment.now()
registrar.cache[serviceId] = @[ad]
registrar.cacheTimestamps[ad.toAdvertisementKey()] = now - 1000.secs
pruneExpiredAds(registrar, 900.secs)
check ad notin registrar.cache.getOrDefault(serviceId)
check ad.toAdvertisementKey() notin registrar.cacheTimestamps
test "pruneExpiredAds removes ad from IP tree":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ip = IpAddress(family: IpAddressFamily.IPv4, address_v4: [192'u8, 168, 1, 1])
let ad = makeAdvertisement($serviceId, addrs = @[makeMultiAddress("192.168.1.1")])
let now = Moment.now()
registrar.cache[serviceId] = @[ad]
registrar.cacheTimestamps[ad.toAdvertisementKey()] = now - 1000.secs
registrar.ipTree.insertIp(ip)
check registrar.ipTree.root.counter == 1
pruneExpiredAds(registrar, 900.secs)
check registrar.ipTree.root.counter == 0
test "pruneExpiredAds removes from cacheTimestamps":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId)
let now = Moment.now()
registrar.cache[serviceId] = @[ad]
registrar.cacheTimestamps[ad.toAdvertisementKey()] = now - 1000.secs
check ad.toAdvertisementKey() in registrar.cacheTimestamps
pruneExpiredAds(registrar, 900.secs)
check ad.toAdvertisementKey() notin registrar.cacheTimestamps
test "pruneExpiredAds handles multiple ads for same service":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad1 = makeAdvertisement($serviceId)
let ad2 = makeAdvertisement($serviceId)
let ad3 = makeAdvertisement($serviceId)
let now = Moment.now()
registrar.cache[serviceId] = @[ad1, ad2, ad3]
registrar.cacheTimestamps[ad1.toAdvertisementKey()] = now - 1000.secs # expired
registrar.cacheTimestamps[ad2.toAdvertisementKey()] = now # fresh
registrar.cacheTimestamps[ad3.toAdvertisementKey()] = now - 2000.secs # expired
pruneExpiredAds(registrar, 900.secs)
check registrar.cache[serviceId].len == 1
check ad2 in registrar.cache[serviceId]
check ad1 notin registrar.cache[serviceId]
check ad3 notin registrar.cache[serviceId]
test "pruneExpiredAds handles ad with no valid IP addresses":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId, addrs = @[])
let now = Moment.now()
registrar.cache[serviceId] = @[ad]
registrar.cacheTimestamps[ad.toAdvertisementKey()] = now - 1000.secs
pruneExpiredAds(registrar, 900.secs)
check ad notin registrar.cache.getOrDefault(serviceId)
test "pruneExpiredAds removes same expired ad from all services":
let registrar = Registrar.new()
let serviceId1 = makeServiceId(1)
let serviceId2 = makeServiceId(2)
let ad = makeAdvertisement(addrs = @[makeMultiAddress("10.0.0.1")])
let now = Moment.now()
registrar.cache[serviceId1] = @[ad]
registrar.cache[serviceId2] = @[ad]
registrar.cacheTimestamps[ad.toAdvertisementKey()] = now - 1000.secs
# Each service's copy is a separate ad_cache admission
registrar.ipTree.insertAd(ad)
registrar.ipTree.insertAd(ad)
pruneExpiredAds(registrar, 900.secs)
check:
registrar.cache.len == 0
ad.toAdvertisementKey() notin registrar.cacheTimestamps
registrar.ipTree.root.counter == 0
# Second prune must be a no-op
pruneExpiredAds(registrar, 900.secs)
check registrar.cache.len == 0
test "pruneExpiredAds removes orphan ad with no timestamp":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId)
registrar.cache[serviceId] = @[ad]
# Deliberately no cacheTimestamps entry
pruneExpiredAds(registrar, 900.secs)
check:
ad notin registrar.cache.getOrDefault(serviceId)
registrar.cache.len == 0
test "pruneExpiredAds progresses past mixed fresh, orphan, and expired ads":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let fresh = makeAdvertisement($serviceId)
let orphan = makeAdvertisement($serviceId)
let expired = makeAdvertisement($serviceId)
let now = Moment.now()
registrar.cache[serviceId] = @[fresh, orphan, expired]
registrar.cacheTimestamps[fresh.toAdvertisementKey()] = now
# orphan has no timestamp
registrar.cacheTimestamps[expired.toAdvertisementKey()] = now - 1000.secs
pruneExpiredAds(registrar, 900.secs)
check:
registrar.cache[serviceId].len == 1
fresh in registrar.cache[serviceId]
orphan notin registrar.cache[serviceId]
expired notin registrar.cache[serviceId]
fresh.toAdvertisementKey() in registrar.cacheTimestamps
expired.toAdvertisementKey() notin registrar.cacheTimestamps
test "pruneExpiredAds removes multi-service ad from IP tree once per service":
let registrar = Registrar.new()
let serviceId1 = makeServiceId(1)
let serviceId2 = makeServiceId(2)
let ad = makeAdvertisement(addrs = @[makeMultiAddress("192.168.1.1")])
let now = Moment.now()
registrar.cache[serviceId1] = @[ad]
registrar.cache[serviceId2] = @[ad]
registrar.cacheTimestamps[ad.toAdvertisementKey()] = now - 1000.secs
# Each service's copy is a separate ad_cache admission
registrar.ipTree.insertAd(ad)
registrar.ipTree.insertAd(ad)
check registrar.ipTree.root.counter == 2
pruneExpiredAds(registrar, 900.secs)
check:
registrar.cache.len == 0
registrar.ipTree.root.counter == 0
suite "Service Discovery Registrar - State Management":
test "cache can store multiple ads for same service ID":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad1 = makeAdvertisement($serviceId)
let ad2 = makeAdvertisement($serviceId)
let ad3 = makeAdvertisement($serviceId)
registrar.cache[serviceId] = @[ad1, ad2, ad3]
check registrar.cache[serviceId].len == 3
check ad1 in registrar.cache[serviceId]
check ad2 in registrar.cache[serviceId]
check ad3 in registrar.cache[serviceId]
test "cache can store ads for different service IDs":
let registrar = Registrar.new()
let serviceId1 = makeServiceId(1)
let serviceId2 = makeServiceId(2)
let ad1 = makeAdvertisement($serviceId1)
let ad2 = makeAdvertisement($serviceId2)
registrar.cache[serviceId1] = @[ad1]
registrar.cache[serviceId2] = @[ad2]
check registrar.cache.len == 2
check serviceId1 in registrar.cache
check serviceId2 in registrar.cache
test "cacheTimestamps correctly tracks insertion time":
let registrar = Registrar.new()
let ad = makeAdvertisement()
let timestamp = initMoment(12345)
registrar.cacheTimestamps[ad.toAdvertisementKey()] = timestamp
check registrar.cacheTimestamps[ad.toAdvertisementKey()] == timestamp
test "IP tree is independent from cache":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ip = IpAddress(family: IpAddressFamily.IPv4, address_v4: [192'u8, 168, 1, 1])
let ad = makeAdvertisement($serviceId, addrs = @[makeMultiAddress("192.168.1.1")])
registrar.cache[serviceId] = @[ad]
check registrar.ipTree.root.counter == 0
registrar.ipTree.insertIp(ip)
check registrar.ipTree.root.counter == 1
suite "Service Discovery Registrar - Edge Cases":
test "waitingTime with advertisement with no addresses":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let ad = makeAdvertisement(addrs = @[])
let now = Moment.now()
let serviceId = makeServiceId()
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
check w >= ZeroDuration
test "waitingTime with IPv6 addresses only (ignored in IP tree)":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let serviceId = makeServiceId()
let ipv6Addr = MultiAddress.init("/ip6/::1/tcp/9000").get()
let ad = makeAdvertisement(addrs = @[ipv6Addr])
let now = Moment.now()
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
check w >= ZeroDuration
test "waitingTime with mixed IPv4 and IPv6 addresses":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let serviceId = makeServiceId()
registrar.ipTree.insertIp(
IpAddress(family: IpAddressFamily.IPv4, address_v4: [192'u8, 168, 1, 1])
)
let ipv4Addr = makeMultiAddress("192.168.1.50")
let ipv6Addr = MultiAddress.init("/ip6/::1/tcp/9000").get()
let ad = makeAdvertisement(addrs = @[ipv4Addr, ipv6Addr])
let now = Moment.now()
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
check w > ZeroDuration
test "waitingTime with service ID not in boundService":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let ad = makeAdvertisement()
let now = Moment.now()
let serviceId = makeServiceId()
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
check w >= ZeroDuration
test "waitingTime with IP not in boundIp":
let registrar = Registrar.new()
let discoConfig = ServiceDiscoveryConfig.new()
let ad = makeAdvertisement(addrs = @[makeMultiAddress("10.0.0.1")])
let now = Moment.now()
let serviceId = makeServiceId()
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
check w >= ZeroDuration
test "updateLowerBounds with zero w":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId)
let now = initMoment(1000)
updateLowerBounds(registrar, serviceId, ad, ZeroDuration, now)
check serviceId in registrar.boundService
check registrar.boundService[serviceId] == now
test "pruneExpiredAds with very old timestamp":
let registrar = Registrar.new()
let serviceId = makeServiceId()
let ad = makeAdvertisement($serviceId)
registrar.cache[serviceId] = @[ad]
registrar.cacheTimestamps[ad.toAdvertisementKey()] = initMoment(0)
check ad in registrar.cache.getOrDefault(serviceId)
check ad.toAdvertisementKey() in registrar.cacheTimestamps
# expire ads that are older than 1s
# our ad is very old (moment zero)
pruneExpiredAds(registrar, 1.secs)
check ad notin registrar.cache.getOrDefault(serviceId)
check ad.toAdvertisementKey() notin registrar.cacheTimestamps
suite "Service Discovery Registrar - Configuration Variations":
test "different advertCacheCap affects occupancy":
let registrar = Registrar.new()
let ad = makeAdvertisement()
let now = Moment.now()
let serviceId = makeServiceId()
for i in 0 ..< 100:
let testAd = makeAdvertisement($makeServiceId(i.byte))
registrar.cacheTimestamps[testAd.toAdvertisementKey()] = now
let discoConfig = ServiceDiscoveryConfig.new()
let w1 = registrar.waitingTime(discoConfig, ad, 100, serviceId, now)
let w2 = registrar.waitingTime(discoConfig, ad, 10000, serviceId, now)
check w1 >= w2
test "different occupancyExp changes wait time curve":
let registrar = Registrar.new()
let ad = makeAdvertisement()
let now = Moment.now()
let serviceId = makeServiceId()
for i in 0 ..< 500:
let testAd = makeAdvertisement($makeServiceId(i.byte))
registrar.cacheTimestamps[testAd.toAdvertisementKey()] = now
let discoConfig1 = ServiceDiscoveryConfig.new(occupancyExp = 1.0)
let w1 = registrar.waitingTime(discoConfig1, ad, 1000, serviceId, now)
let discoConfig2 = ServiceDiscoveryConfig.new(occupancyExp = 20.0)
let w2 = registrar.waitingTime(discoConfig2, ad, 1000, serviceId, now)
check w2 >= w1
test "different advertExpiry scales base wait time":
let registrar = Registrar.new()
let ad = makeAdvertisement()
let now = Moment.now()
let serviceId = makeServiceId()
let discoConfig1 =
ServiceDiscoveryConfig.new(safetyParam = 1.0, advertExpiry = 100.secs)
let w1 = registrar.waitingTime(discoConfig1, ad, 1000, serviceId, now)
let discoConfig2 =
ServiceDiscoveryConfig.new(safetyParam = 1.0, advertExpiry = 10000.secs)
let w2 = registrar.waitingTime(discoConfig2, ad, 1000, serviceId, now)
check w2 > w1
test "different safetyParam adds to wait time":
let registrar = Registrar.new()
let ad = makeAdvertisement()
let now = Moment.now()
let serviceId = makeServiceId()
let discoConfig1 = ServiceDiscoveryConfig.new(safetyParam = 0.0)
let w1 = registrar.waitingTime(discoConfig1, ad, 1000, serviceId, now)
let discoConfig2 = ServiceDiscoveryConfig.new(safetyParam = 1.0)
let w2 = registrar.waitingTime(discoConfig2, ad, 1000, serviceId, now)
check w2 > w1
test "occupancyExp of 0 gives occupancy of 1.0":
let registrar = Registrar.new()
let ad = makeAdvertisement()
let now = Moment.now()
let serviceId = makeServiceId()
for i in 0 ..< 500:
let testAd = makeAdvertisement($makeServiceId(i.byte))
registrar.cacheTimestamps[testAd.toAdvertisementKey()] = now
let discoConfig = ServiceDiscoveryConfig.new(occupancyExp = 0.0)
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
# pow(x, 0) = 1.0 regardless of x, so occupancy = 1.0 / 1.0 = 1.0
check w >= ZeroDuration
test "occupancyExp of 1 gives linear occupancy":
let registrar = Registrar.new()
let ad = makeAdvertisement()
let now = Moment.now()
let serviceId = makeServiceId()
for i in 0 ..< 500:
let testAd = makeAdvertisement($makeServiceId(i.byte))
registrar.cacheTimestamps[testAd.toAdvertisementKey()] = now
let discoConfig = ServiceDiscoveryConfig.new(occupancyExp = 1.0)
let w = registrar.waitingTime(discoConfig, ad, 1000, serviceId, now)
# occupancyExp=1: occupancy = 1/(1-0.5) = 2.0
check w >= ZeroDuration
suite "Service Discovery Registrar - Register Message Validation":
test "isValidAdvertisement rejects empty advertisement":
let regMsg = kadprotobuf.RegisterMessage(
advertisement: @[],
status: Opt.none(kadprotobuf.RegistrationStatus),
ticket: Opt.none(Ticket),
)
check isValidAdvertisement(regMsg, makeServiceId()).isErr()
test "isValidAdvertisement rejects malformed advertisement bytes":
let regMsg = kadprotobuf.RegisterMessage(
advertisement: @[1'u8, 2, 3, 4],
status: Opt.none(kadprotobuf.RegistrationStatus),
ticket: Opt.none(Ticket),
)
check isValidAdvertisement(regMsg, makeServiceId()).isErr()
test "isValidAdvertisement accepts decodable advertisement":
let serviceStr = $1
let serviceId = hashServiceId(serviceStr)
let ad = makeAdvertisement(serviceStr, addrs = @[makeMultiAddress("10.0.0.1")])
let adBuf = ad.encode().get()
let regMsg = kadprotobuf.RegisterMessage(
advertisement: adBuf,
status: Opt.none(kadprotobuf.RegistrationStatus),
ticket: Opt.none(Ticket),
)
let decoded = isValidAdvertisement(regMsg, serviceId)
check decoded.isOk()
check decoded.get().data.peerId == ad.data.peerId
check decoded.get().data.seqNo == ad.data.seqNo
test "isValidAdvertisement rejects advertisement for different service":
let serviceId = "service".hashServiceId()
let ad = makeAdvertisement("other-service")
let adBuf = ad.encode().get()
let regMsg = kadprotobuf.RegisterMessage(
advertisement: adBuf,
status: Opt.none(kadprotobuf.RegistrationStatus),
ticket: Opt.none(Ticket),
)
check isValidAdvertisement(regMsg, serviceId).isErr()
test "isValidAdvertisement rejects advertisement with no services":
let serviceId = "service".hashServiceId()
let ad = makeAdvertisementWithServices(@[])
let adBuf = ad.encode().get()
let regMsg = kadprotobuf.RegisterMessage(
advertisement: adBuf,
status: Opt.none(kadprotobuf.RegistrationStatus),
ticket: Opt.none(Ticket),
)
check isValidAdvertisement(regMsg, serviceId).isErr()
test "isValidAdvertisement accepts multi-service advertisement":
let services = @[
makeServiceInfo("service-a"),
makeServiceInfo("service-b"),
makeServiceInfo("service-c"),
]
let serviceId = services[0].id.hashServiceId()
let ad = makeAdvertisementWithServices(services)
let adBuf = ad.encode().get()
let regMsg = kadprotobuf.RegisterMessage(
advertisement: adBuf,
status: Opt.none(kadprotobuf.RegistrationStatus),
ticket: Opt.none(Ticket),
)
let decoded = isValidAdvertisement(regMsg, serviceId)
check:
decoded.isOk()
decoded.get().data.peerId == ad.data.peerId
decoded.get().data.services.len == 3
suite "Service Discovery Registrar - Retry Ticket Processing":
test "subtracts accumulated wait for retry":
let disco = setupServiceDiscoveryNode()
let ad = makeAdvertisement(addrs = @[makeMultiAddress("10.0.0.1")])
let adBuf = ad.encode().get()
# Set tMod = now, tWaitFor = 0 → windowStart = now (within window)
# totalWaitSoFar = now - (now - 150) = 150 ± 1
let now = Moment.now()
var ticket = Ticket(
advertisement: adBuf,
tInit: now - 150.secs,
tMod: now,
tWaitFor: 0.secs,
signature: Opt.none(seq[byte]),
)
check ticket.sign(disco.switch.peerInfo.privateKey).isOk()