-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
helpers.go
1350 lines (1130 loc) · 43.1 KB
/
helpers.go
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
package logpoller
import (
"bytes"
"context"
"fmt"
"math/big"
"math/rand"
"sort"
"strings"
"sync"
"sync/atomic"
"testing"
"time"
geth "github.com/ethereum/go-ethereum"
"github.com/ethereum/go-ethereum/accounts/abi"
"github.com/ethereum/go-ethereum/common"
geth_types "github.com/ethereum/go-ethereum/core/types"
"github.com/jmoiron/sqlx"
"github.com/rs/zerolog"
"github.com/scylladb/go-reflectx"
"github.com/stretchr/testify/require"
"github.com/smartcontractkit/seth"
"github.com/smartcontractkit/wasp"
commonconfig "github.com/smartcontractkit/chainlink-common/pkg/config"
"github.com/smartcontractkit/chainlink-testing-framework/blockchain"
ctf_test_env "github.com/smartcontractkit/chainlink-testing-framework/docker/test_env"
"github.com/smartcontractkit/chainlink-testing-framework/logging"
"github.com/smartcontractkit/chainlink-testing-framework/networks"
"github.com/smartcontractkit/chainlink-testing-framework/utils/ptr"
"github.com/smartcontractkit/chainlink/integration-tests/actions"
actions_seth "github.com/smartcontractkit/chainlink/integration-tests/actions/seth"
"github.com/smartcontractkit/chainlink/integration-tests/client"
"github.com/smartcontractkit/chainlink/integration-tests/contracts"
"github.com/smartcontractkit/chainlink/integration-tests/contracts/ethereum"
"github.com/smartcontractkit/chainlink/integration-tests/docker/test_env"
tc "github.com/smartcontractkit/chainlink/integration-tests/testconfig"
lp_config "github.com/smartcontractkit/chainlink/integration-tests/testconfig/log_poller"
"github.com/smartcontractkit/chainlink/integration-tests/types/config/node"
evmcfg "github.com/smartcontractkit/chainlink/v2/core/chains/evm/config/toml"
"github.com/smartcontractkit/chainlink/v2/core/chains/evm/logpoller"
cltypes "github.com/smartcontractkit/chainlink/v2/core/chains/evm/types"
ac "github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/automation_compatible_utils"
le "github.com/smartcontractkit/chainlink/v2/core/gethwrappers/generated/log_emitter"
core_logger "github.com/smartcontractkit/chainlink/v2/core/logger"
)
var (
EmitterABI, _ = abi.JSON(strings.NewReader(le.LogEmitterABI))
automatoinConvABI = cltypes.MustGetABI(ac.AutomationCompatibleUtilsABI)
bytes0 = [32]byte{
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
} // bytes representation of 0x0000000000000000000000000000000000000000000000000000000000000000
)
var registerSingleTopicFilter = func(registry contracts.KeeperRegistry, upkeepID *big.Int, emitterAddress common.Address, topic common.Hash) error {
logTriggerConfigStruct := ac.IAutomationV21PlusCommonLogTriggerConfig{
ContractAddress: emitterAddress,
FilterSelector: 0,
Topic0: topic,
Topic1: bytes0,
Topic2: bytes0,
Topic3: bytes0,
}
encodedLogTriggerConfig, err := automatoinConvABI.Methods["_logTriggerConfig"].Inputs.Pack(&logTriggerConfigStruct)
if err != nil {
return err
}
err = registry.SetUpkeepTriggerConfig(upkeepID, encodedLogTriggerConfig)
if err != nil {
return err
}
return nil
}
// Currently Unused November 8, 2023, Might be useful in the near future so keeping it here for now
// this is not really possible, log trigger doesn't support multiple topics, even if log poller does
// var registerMultipleTopicsFilter = func(registry contracts.KeeperRegistry, upkeepID *big.Int, emitterAddress common.Address, topics []abi.Event) error {
// if len(topics) > 4 {
// return errors.New("Cannot register more than 4 topics")
// }
// var getTopic = func(topics []abi.Event, i int) common.Hash {
// if i > len(topics)-1 {
// return bytes0
// }
// return topics[i].ID
// }
// var getFilterSelector = func(topics []abi.Event) (uint8, error) {
// switch len(topics) {
// case 0:
// return 0, errors.New("Cannot register filter with 0 topics")
// case 1:
// return 0, nil
// case 2:
// return 1, nil
// case 3:
// return 3, nil
// case 4:
// return 7, nil
// default:
// return 0, errors.New("Cannot register filter with more than 4 topics")
// }
// }
// filterSelector, err := getFilterSelector(topics)
// if err != nil {
// return err
// }
// logTriggerConfigStruct := automation_convenience.LogTriggerConfig{
// ContractAddress: emitterAddress,
// FilterSelector: filterSelector,
// Topic0: getTopic(topics, 0),
// Topic1: getTopic(topics, 1),
// Topic2: getTopic(topics, 2),
// Topic3: getTopic(topics, 3),
// }
// encodedLogTriggerConfig, err := automatoinConvABI.Methods["_logTriggerConfig"].Inputs.Pack(&logTriggerConfigStruct)
// if err != nil {
// return err
// }
// err = registry.SetUpkeepTriggerConfig(upkeepID, encodedLogTriggerConfig)
// if err != nil {
// return err
// }
// return nil
// }
// NewORM returns a new logpoller.orm instance
func NewORM(logger core_logger.SugaredLogger, chainID *big.Int, postgresDb *ctf_test_env.PostgresDb) (logpoller.ORM, *sqlx.DB, error) {
dsn := fmt.Sprintf("host=%s port=%s user=%s password=%s dbname=%s sslmode=disable", "127.0.0.1", postgresDb.ExternalPort, postgresDb.User, postgresDb.Password, postgresDb.DbName)
db, err := sqlx.Open("postgres", dsn)
if err != nil {
return nil, db, err
}
db.MapperFunc(reflectx.CamelToSnakeASCII)
return logpoller.NewORM(chainID, db, logger), db, nil
}
type ExpectedFilter struct {
emitterAddress common.Address
topic common.Hash
}
// GetExpectedFilters returns a slice of ExpectedFilter structs based on the provided log emitters and config
func GetExpectedFilters(logEmitters []*contracts.LogEmitter, cfg *lp_config.Config) []ExpectedFilter {
expectedFilters := make([]ExpectedFilter, 0)
for _, emitter := range logEmitters {
for _, event := range cfg.General.EventsToEmit {
expectedFilters = append(expectedFilters, ExpectedFilter{
emitterAddress: (*emitter).Address(),
topic: event.ID,
})
}
}
return expectedFilters
}
// NodeHasExpectedFilters returns true if the provided node has all the expected filters registered
func NodeHasExpectedFilters(ctx context.Context, expectedFilters []ExpectedFilter, logger core_logger.SugaredLogger, chainID *big.Int, postgresDb *ctf_test_env.PostgresDb) (bool, string, error) {
orm, db, err := NewORM(logger, chainID, postgresDb)
if err != nil {
return false, "", err
}
defer db.Close()
knownFilters, err := orm.LoadFilters(ctx)
if err != nil {
return false, "", err
}
for _, expectedFilter := range expectedFilters {
filterFound := false
for _, knownFilter := range knownFilters {
if bytes.Equal(expectedFilter.emitterAddress.Bytes(), knownFilter.Addresses[0].Bytes()) && bytes.Equal(expectedFilter.topic.Bytes(), knownFilter.EventSigs[0].Bytes()) {
filterFound = true
break
}
}
if !filterFound {
return false, fmt.Sprintf("no filter found for emitter %s and topic %s", expectedFilter.emitterAddress.String(), expectedFilter.topic.Hex()), nil
}
}
return true, "", nil
}
// randomWait waits for a random amount of time between minMilliseconds and maxMilliseconds
func randomWait(minMilliseconds, maxMilliseconds int) {
rand.New(rand.NewSource(time.Now().UnixNano()))
randomMilliseconds := rand.Intn(maxMilliseconds-minMilliseconds+1) + minMilliseconds
time.Sleep(time.Duration(randomMilliseconds) * time.Millisecond)
}
type LogEmitterChannel struct {
logsEmitted int
err error
}
// getIntSlice returns a slice of ints of the provided length
func getIntSlice(length int) []int {
result := make([]int, length)
for i := 0; i < length; i++ {
result[i] = i
}
return result
}
// getStringSlice returns a slice of strings of the provided length
func getStringSlice(length int) []string {
result := make([]string, length)
for i := 0; i < length; i++ {
result[i] = "amazing event"
}
return result
}
// emitEvents emits events from the provided log emitter concurrently according to the provided config
func emitEvents(ctx context.Context, l zerolog.Logger, client *seth.Client, logEmitter *contracts.LogEmitter, cfg *lp_config.Config, wg *sync.WaitGroup, results chan LogEmitterChannel) {
address := (*logEmitter).Address().String()
defer wg.Done()
var executionGroup sync.WaitGroup
// Atomic counter is used to keep track of the number of logs emitted
var atomicCounter = atomic.Int32{}
for i := 0; i < *cfg.LoopedConfig.ExecutionCount; i++ {
executionGroup.Add(1)
}
var emitAllEvents = func() {
defer executionGroup.Done()
current := atomicCounter.Add(1)
for _, event := range cfg.General.EventsToEmit {
select {
case <-ctx.Done():
l.Warn().Str("Emitter address", address).Msg("Context cancelled, not emitting events")
return
default:
l.Debug().Str("Emitter address", address).Str("Event type", event.Name).Str("index", fmt.Sprintf("%d/%d", current, *cfg.LoopedConfig.ExecutionCount)).Msg("Emitting log from emitter")
var err error
switch event.Name {
case "Log1":
_, err = client.Decode((*logEmitter).EmitLogIntsFromKey(getIntSlice(*cfg.General.EventsPerTx), client.AnySyncedKey()))
case "Log2":
_, err = client.Decode((*logEmitter).EmitLogIntsIndexedFromKey(getIntSlice(*cfg.General.EventsPerTx), client.AnySyncedKey()))
case "Log3":
_, err = client.Decode((*logEmitter).EmitLogStringsFromKey(getStringSlice(*cfg.General.EventsPerTx), client.AnySyncedKey()))
case "Log4":
_, err = client.Decode((*logEmitter).EmitLogIntMultiIndexedFromKey(1, 1, *cfg.General.EventsPerTx, client.AnySyncedKey()))
default:
err = fmt.Errorf("unknown event name: %s", event.Name)
}
if err != nil {
results <- LogEmitterChannel{
err: err,
}
return
}
randomWait(*cfg.LoopedConfig.MinEmitWaitTimeMs, *cfg.LoopedConfig.MaxEmitWaitTimeMs)
}
if (current)%10 == 0 {
l.Info().Str("Emitter address", address).Str("Index", fmt.Sprintf("%d/%d", current, *cfg.LoopedConfig.ExecutionCount)).Msgf("Emitted all %d events", len(cfg.General.EventsToEmit))
}
}
}
clientNumber := int(*client.Cfg.EphemeralAddrs)
emissionsPerClient := *cfg.LoopedConfig.ExecutionCount / clientNumber
extraEmissions := *cfg.LoopedConfig.ExecutionCount % clientNumber
l.Debug().Str("Emitter address", address).
Int("Total logs to emit", *cfg.LoopedConfig.ExecutionCount*len(cfg.General.EventsToEmit)*(*cfg.General.EventsPerTx)).
Int("Total clients", clientNumber).
Int("Emissions per client", emissionsPerClient).
Int("Extra emissions", extraEmissions).
Msg("Starting to emit events")
for i := 0; i < clientNumber; i++ {
go func(key int) {
numTasks := emissionsPerClient
if key < extraEmissions {
numTasks++
}
for idx := 0; idx < numTasks; idx++ {
emitAllEvents()
}
}(i)
}
executionGroup.Wait()
localCounter := int(atomicCounter.Load()) * *cfg.General.EventsPerTx * len(cfg.General.EventsToEmit)
l.Info().Str("Emitter address", address).Int("Total logs emitted", localCounter).Msg("Finished emitting events")
results <- LogEmitterChannel{
logsEmitted: localCounter,
err: nil,
}
}
// LogPollerHasFinalisedEndBlock returns true if all CL nodes have finalised processing the provided end block
func LogPollerHasFinalisedEndBlock(endBlock int64, chainID *big.Int, l zerolog.Logger, coreLogger core_logger.SugaredLogger, nodes *test_env.ClCluster) (bool, error) {
wg := &sync.WaitGroup{}
type boolQueryResult struct {
nodeName string
hasFinalised bool
finalizedBlock int64
err error
}
endBlockCh := make(chan boolQueryResult, len(nodes.Nodes)-1)
ctx, cancelFn := context.WithCancel(context.Background())
for i := 1; i < len(nodes.Nodes); i++ {
wg.Add(1)
go func(clNode *test_env.ClNode, r chan boolQueryResult) {
defer wg.Done()
select {
case <-ctx.Done():
return
default:
orm, db, err := NewORM(coreLogger, chainID, clNode.PostgresDb)
if err != nil {
r <- boolQueryResult{
nodeName: clNode.ContainerName,
hasFinalised: false,
err: err,
}
}
defer db.Close()
latestBlock, err := orm.SelectLatestBlock(ctx)
if err != nil {
r <- boolQueryResult{
nodeName: clNode.ContainerName,
hasFinalised: false,
err: err,
}
}
r <- boolQueryResult{
nodeName: clNode.ContainerName,
finalizedBlock: latestBlock.FinalizedBlockNumber,
hasFinalised: latestBlock.FinalizedBlockNumber > endBlock,
err: nil,
}
}
}(nodes.Nodes[i], endBlockCh)
}
var err error
allFinalisedCh := make(chan bool, 1)
go func() {
foundMap := make(map[string]bool, 0)
for r := range endBlockCh {
if r.err != nil {
err = r.err
cancelFn()
return
}
foundMap[r.nodeName] = r.hasFinalised
if r.hasFinalised {
l.Info().Str("Node name", r.nodeName).Msg("CL node has finalised end block")
} else {
l.Warn().Int64("Has", r.finalizedBlock).Int64("Want", endBlock).Str("Node name", r.nodeName).Msg("CL node has not finalised end block yet")
}
if len(foundMap) == len(nodes.Nodes)-1 {
allFinalised := true
for _, v := range foundMap {
if !v {
allFinalised = false
break
}
}
allFinalisedCh <- allFinalised
return
}
}
}()
wg.Wait()
close(endBlockCh)
return <-allFinalisedCh, err
}
// ClNodesHaveExpectedLogCount returns true if all CL nodes have the expected log count in the provided block range and matching the provided filters
func ClNodesHaveExpectedLogCount(startBlock, endBlock int64, chainID *big.Int, expectedLogCount int, expectedFilters []ExpectedFilter, l zerolog.Logger, coreLogger core_logger.SugaredLogger, nodes *test_env.ClCluster) (bool, error) {
wg := &sync.WaitGroup{}
type logQueryResult struct {
nodeName string
logCount int
hasExpectedCount bool
err error
}
resultChan := make(chan logQueryResult, len(nodes.Nodes)-1)
ctx, cancelFn := context.WithCancel(context.Background())
for i := 1; i < len(nodes.Nodes); i++ {
wg.Add(1)
go func(clNode *test_env.ClNode, resultChan chan logQueryResult) {
defer wg.Done()
select {
case <-ctx.Done():
return
default:
orm, db, err := NewORM(coreLogger, chainID, clNode.PostgresDb)
if err != nil {
resultChan <- logQueryResult{
nodeName: clNode.ContainerName,
logCount: 0,
hasExpectedCount: false,
err: err,
}
}
defer db.Close()
foundLogsCount := 0
for _, filter := range expectedFilters {
logs, err := orm.SelectLogs(ctx, startBlock, endBlock, filter.emitterAddress, filter.topic)
if err != nil {
resultChan <- logQueryResult{
nodeName: clNode.ContainerName,
logCount: 0,
hasExpectedCount: false,
err: err,
}
}
foundLogsCount += len(logs)
}
resultChan <- logQueryResult{
nodeName: clNode.ContainerName,
logCount: foundLogsCount,
hasExpectedCount: foundLogsCount >= expectedLogCount,
err: nil,
}
}
}(nodes.Nodes[i], resultChan)
}
var err error
allFoundCh := make(chan bool, 1)
go func() {
foundMap := make(map[string]bool, 0)
for r := range resultChan {
if r.err != nil {
err = r.err
cancelFn()
return
}
foundMap[r.nodeName] = r.hasExpectedCount
if r.hasExpectedCount {
l.Debug().
Str("Node name", r.nodeName).
Int("Logs count", r.logCount).
Msg("Expected log count found in CL node")
} else {
l.Debug().
Str("Node name", r.nodeName).
Str("Found/Expected logs", fmt.Sprintf("%d/%d", r.logCount, expectedLogCount)).
Int("Missing logs", expectedLogCount-r.logCount).
Msg("Too low log count found in CL node")
}
if len(foundMap) == len(nodes.Nodes)-1 {
allFound := true
for _, hadAllLogs := range foundMap {
if !hadAllLogs {
allFound = false
break
}
}
allFoundCh <- allFound
return
}
}
}()
wg.Wait()
close(resultChan)
return <-allFoundCh, err
}
type MissingLogs map[string][]geth_types.Log
// IsEmpty returns true if there are no missing logs
func (m *MissingLogs) IsEmpty() bool {
for _, v := range *m {
if len(v) > 0 {
return false
}
}
return true
}
// GetMissingLogs returns a map of CL node name to missing logs in that node compared to EVM node to which the provided evm client is connected
func GetMissingLogs(startBlock, endBlock int64, logEmitters []*contracts.LogEmitter, client *seth.Client, clnodeCluster *test_env.ClCluster, l zerolog.Logger, coreLogger core_logger.SugaredLogger, cfg *lp_config.Config) (MissingLogs, error) {
wg := &sync.WaitGroup{}
type dbQueryResult struct {
err error
nodeName string
logs []logpoller.Log
}
ctx, cancelFn := context.WithCancel(context.Background())
resultCh := make(chan dbQueryResult, len(clnodeCluster.Nodes)-1)
for i := 1; i < len(clnodeCluster.Nodes); i++ {
wg.Add(1)
go func(ctx context.Context, i int, r chan dbQueryResult) {
defer wg.Done()
select {
case <-ctx.Done():
l.Warn().Msg("Context cancelled. Terminating fetching logs from log poller's DB")
return
default:
nodeName := clnodeCluster.Nodes[i].ContainerName
l.Debug().Str("Node name", nodeName).Msg("Fetching log poller logs")
orm, db, err := NewORM(coreLogger, big.NewInt(client.ChainID), clnodeCluster.Nodes[i].PostgresDb)
if err != nil {
r <- dbQueryResult{
err: err,
nodeName: nodeName,
logs: []logpoller.Log{},
}
}
defer db.Close()
logs := make([]logpoller.Log, 0)
for j := 0; j < len(logEmitters); j++ {
address := (*logEmitters[j]).Address()
for _, event := range cfg.General.EventsToEmit {
l.Trace().Str("Event name", event.Name).Str("Emitter address", address.String()).Msg("Fetching single emitter's logs")
result, err := orm.SelectLogs(ctx, startBlock, endBlock, address, event.ID)
if err != nil {
r <- dbQueryResult{
err: err,
nodeName: nodeName,
logs: []logpoller.Log{},
}
}
sort.Slice(result, func(i, j int) bool {
return result[i].BlockNumber < result[j].BlockNumber
})
logs = append(logs, result...)
l.Trace().Str("Event name", event.Name).Str("Emitter address", address.String()).Int("Log count", len(result)).Msg("Logs found per node")
}
}
l.Info().Int("Count", len(logs)).Str("Node name", nodeName).Msg("Fetched log poller logs")
r <- dbQueryResult{
err: nil,
nodeName: nodeName,
logs: logs,
}
}
}(ctx, i, resultCh)
}
allLogPollerLogs := make(map[string][]logpoller.Log, 0)
missingLogs := map[string][]geth_types.Log{}
var dbError error
go func() {
for r := range resultCh {
if r.err != nil {
l.Err(r.err).Str("Node name", r.nodeName).Msg("Error fetching logs from log poller's DB")
dbError = r.err
cancelFn()
return
}
// use channel for aggregation and then for := range over it after closing resultCh?
allLogPollerLogs[r.nodeName] = r.logs
}
}()
wg.Wait()
close(resultCh)
if dbError != nil {
return nil, dbError
}
allLogsInEVMNode, err := getEVMLogs(ctx, startBlock, endBlock, logEmitters, client, l, cfg)
if err != nil {
return nil, err
}
wg = &sync.WaitGroup{}
type missingLogResult struct {
nodeName string
logs []geth_types.Log
}
evmLogCount := len(allLogsInEVMNode)
l.Info().Int("Log count", evmLogCount).Msg("Started comparison of logs from EVM node and CL nodes. This may take a while if there's a lot of logs")
missingCh := make(chan missingLogResult, len(clnodeCluster.Nodes)-1)
for i := 1; i < len(clnodeCluster.Nodes); i++ {
wg.Add(1)
go func(i int, result chan missingLogResult) {
defer wg.Done()
nodeName := clnodeCluster.Nodes[i].ContainerName
l.Debug().Str("Node name", nodeName).Str("Progress", fmt.Sprintf("0/%d", evmLogCount)).Msg("Comparing single CL node's logs with EVM logs")
missingLogs := make([]geth_types.Log, 0)
for i, evmLog := range allLogsInEVMNode {
logFound := false
for _, logPollerLog := range allLogPollerLogs[nodeName] {
if logPollerLog.BlockNumber == int64(evmLog.BlockNumber) && logPollerLog.TxHash == evmLog.TxHash && bytes.Equal(logPollerLog.Data, evmLog.Data) && logPollerLog.LogIndex == int64(evmLog.Index) &&
logPollerLog.Address == evmLog.Address && logPollerLog.BlockHash == evmLog.BlockHash && bytes.Equal(logPollerLog.Topics[0][:], evmLog.Topics[0].Bytes()) {
logFound = true
continue
}
}
if i%10000 == 0 && i != 0 {
l.Debug().Str("Node name", nodeName).Str("Progress", fmt.Sprintf("%d/%d", i, evmLogCount)).Msg("Comparing single CL node's logs with EVM logs")
}
if !logFound {
missingLogs = append(missingLogs, evmLog)
}
}
if len(missingLogs) > 0 {
l.Warn().Int("Count", len(missingLogs)).Str("Node name", nodeName).Msg("Some EMV logs were missing from CL node")
} else {
l.Info().Str("Node name", nodeName).Str("Missing/Total logs", fmt.Sprintf("%d/%d", len(missingLogs), evmLogCount)).Msg("All EVM logs were found in CL node")
}
result <- missingLogResult{
nodeName: nodeName,
logs: missingLogs,
}
}(i, missingCh)
}
wg.Wait()
close(missingCh)
for v := range missingCh {
if len(v.logs) > 0 {
missingLogs[v.nodeName] = v.logs
}
}
expectedTotalLogsEmitted := GetExpectedLogCount(cfg)
if int64(len(allLogsInEVMNode)) != expectedTotalLogsEmitted {
l.Warn().
Str("Actual/Expected", fmt.Sprintf("%d/%d", expectedTotalLogsEmitted, len(allLogsInEVMNode))).
Msg("Some of the test logs were not found in EVM node. This is a bug in the test")
}
return missingLogs, nil
}
// PrintMissingLogsInfo prints various useful information about the missing logs
func PrintMissingLogsInfo(missingLogs map[string][]geth_types.Log, l zerolog.Logger, cfg *lp_config.Config) {
var findHumanName = func(topic common.Hash) string {
for _, event := range cfg.General.EventsToEmit {
if event.ID == topic {
return event.Name
}
}
return "Unknown event"
}
missingByType := make(map[string]int)
for _, logs := range missingLogs {
for _, v := range logs {
humanName := findHumanName(v.Topics[0])
missingByType[humanName]++
}
}
l.Debug().Msg("Missing log by event name")
for k, v := range missingByType {
l.Debug().Str("Event name", k).Int("Missing count", v).Msg("Missing logs by type")
}
missingByBlock := make(map[uint64]int)
for _, logs := range missingLogs {
for _, l := range logs {
missingByBlock[l.BlockNumber]++
}
}
l.Debug().Msg("Missing logs by block")
for k, v := range missingByBlock {
l.Debug().Uint64("Block number", k).Int("Missing count", v).Msg("Missing logs by block")
}
missingByEmitter := make(map[string]int)
for _, logs := range missingLogs {
for _, l := range logs {
missingByEmitter[l.Address.String()]++
}
}
l.Debug().Msg("Missing logs by emitter")
for k, v := range missingByEmitter {
l.Debug().Str("Emitter address", k).Int("Missing count", v).Msg("Missing logs by emitter")
}
}
// getEVMLogs returns a slice of all logs emitted by the provided log emitters in the provided block range,
// which are present in the EVM node to which the provided evm client is connected
func getEVMLogs(ctx context.Context, startBlock, endBlock int64, logEmitters []*contracts.LogEmitter, client *seth.Client, l zerolog.Logger, cfg *lp_config.Config) ([]geth_types.Log, error) {
allLogsInEVMNode := make([]geth_types.Log, 0)
for j := 0; j < len(logEmitters); j++ {
address := (*logEmitters[j]).Address()
for _, event := range cfg.General.EventsToEmit {
l.Debug().Str("Event name", event.Name).Str("Emitter address", address.String()).Msg("Fetching logs from EVM node")
logsInEVMNode, err := client.Client.FilterLogs(ctx, geth.FilterQuery{
Addresses: []common.Address{(address)},
Topics: [][]common.Hash{{event.ID}},
FromBlock: big.NewInt(startBlock),
ToBlock: big.NewInt(endBlock),
})
if err != nil {
return nil, err
}
sort.Slice(logsInEVMNode, func(i, j int) bool {
return logsInEVMNode[i].BlockNumber < logsInEVMNode[j].BlockNumber
})
allLogsInEVMNode = append(allLogsInEVMNode, logsInEVMNode...)
l.Debug().Str("Event name", event.Name).Str("Emitter address", address.String()).Int("Log count", len(logsInEVMNode)).Msg("Logs found in EVM node")
}
}
l.Info().Int("Count", len(allLogsInEVMNode)).Msg("Logs in EVM node")
return allLogsInEVMNode, nil
}
// ExecuteGenerator executes the configured generator and returns the total number of logs emitted
func ExecuteGenerator(t *testing.T, cfg *lp_config.Config, client *seth.Client, logEmitters []*contracts.LogEmitter) (int, error) {
if *cfg.General.Generator == lp_config.GeneratorType_WASP {
return runWaspGenerator(t, cfg, logEmitters)
}
return runLoopedGenerator(t, cfg, client, logEmitters)
}
// runWaspGenerator runs the wasp generator and returns the total number of logs emitted
func runWaspGenerator(t *testing.T, cfg *lp_config.Config, logEmitters []*contracts.LogEmitter) (int, error) {
l := logging.GetTestLogger(t)
var RPSprime int64
// if LPS is set, we need to calculate based on countract count and events per transaction
if *cfg.Wasp.LPS > 0 {
RPSprime = *cfg.Wasp.LPS / int64(*cfg.General.Contracts) / int64(*cfg.General.EventsPerTx) / int64(len(cfg.General.EventsToEmit))
if RPSprime < 1 {
return 0, fmt.Errorf("invalid load configuration, effective RPS would have been zero. Adjust LPS, contracts count, events per tx or events to emit")
}
}
// if RPS is set simply split it between contracts
if *cfg.Wasp.RPS > 0 {
RPSprime = *cfg.Wasp.RPS / int64(*cfg.General.Contracts)
}
counter := &Counter{
mu: &sync.Mutex{},
value: 0,
}
p := wasp.NewProfile()
for _, logEmitter := range logEmitters {
g, err := wasp.NewGenerator(&wasp.Config{
T: t,
LoadType: wasp.RPS,
GenName: fmt.Sprintf("log_poller_gen_%s", (*logEmitter).Address().String()),
RateLimitUnitDuration: cfg.Wasp.RateLimitUnitDuration.Duration,
CallTimeout: cfg.Wasp.CallTimeout.Duration,
Schedule: wasp.Plain(
RPSprime,
cfg.Wasp.Duration.Duration,
),
Gun: NewLogEmitterGun(
logEmitter,
cfg.General.EventsToEmit,
*cfg.General.EventsPerTx,
l,
),
SharedData: counter,
})
p.Add(g, err)
}
_, err := p.Run(true)
if err != nil {
return 0, err
}
return counter.value, nil
}
// runLoopedGenerator runs the looped generator and returns the total number of logs emitted
func runLoopedGenerator(t *testing.T, cfg *lp_config.Config, client *seth.Client, logEmitters []*contracts.LogEmitter) (int, error) {
l := logging.GetTestLogger(t)
// Start emitting events in parallel, each contract is emitting events in a separate goroutine
// We will stop as soon as we encounter an error
wg := &sync.WaitGroup{}
emitterCh := make(chan LogEmitterChannel, len(logEmitters))
ctx, cancelFn := context.WithCancel(context.Background())
defer cancelFn()
for i := 0; i < len(logEmitters); i++ {
wg.Add(1)
go func(idx int) {
emitEvents(ctx, l, client, logEmitters[idx], cfg, wg, emitterCh)
}(i)
}
var emitErr error
total := 0
aggrChan := make(chan int, len(logEmitters))
go func() {
for {
select {
case <-ctx.Done():
return
case emitter := <-emitterCh:
if emitter.err != nil {
emitErr = emitter.err
cancelFn()
return
}
aggrChan <- emitter.logsEmitted
}
}
}()
wg.Wait()
close(emitterCh)
if emitErr != nil {
return 0, emitErr
}
for i := 0; i < len(logEmitters); i++ {
total += <-aggrChan
}
return int(total), nil
}
// GetExpectedLogCount returns the expected number of logs to be emitted based on the provided config
func GetExpectedLogCount(cfg *lp_config.Config) int64 {
if *cfg.General.Generator == lp_config.GeneratorType_WASP {
if *cfg.Wasp.RPS != 0 {
return *cfg.Wasp.RPS * int64(cfg.Wasp.Duration.Seconds()) * int64(*cfg.General.EventsPerTx)
}
return *cfg.Wasp.LPS * int64(cfg.Wasp.Duration.Duration.Seconds())
}
return int64(len(cfg.General.EventsToEmit) * *cfg.LoopedConfig.ExecutionCount * *cfg.General.Contracts * *cfg.General.EventsPerTx)
}
type PauseData struct {
StartBlock uint64
EndBlock uint64
TargetComponent string
ContaineName string
}
var ChaosPauses = []PauseData{}
// chaosPauseSyncFn pauses ranom container of the provided type for a random amount of time between 5 and 20 seconds
func chaosPauseSyncFn(l zerolog.Logger, client *seth.Client, cluster *test_env.ClCluster, targetComponent string) ChaosPauseData {
rand.New(rand.NewSource(time.Now().UnixNano()))
randomNode := cluster.Nodes[rand.Intn(len(cluster.Nodes)-1)+1]
var component ctf_test_env.EnvComponent
switch strings.ToLower(targetComponent) {
case "chainlink":
component = randomNode.EnvComponent
case "postgres":
component = randomNode.PostgresDb.EnvComponent
default:
return ChaosPauseData{Err: fmt.Errorf("unknown component %s", targetComponent)}
}
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
pauseStartBlock, err := client.Client.BlockNumber(ctx)
if err != nil {
return ChaosPauseData{Err: err}
}
pauseTimeSec := rand.Intn(20-5) + 5
l.Info().Str("Container", component.ContainerName).Int("Pause time", pauseTimeSec).Msg("Pausing component")
pauseTimeDur := time.Duration(pauseTimeSec) * time.Second
err = component.ChaosPause(l, pauseTimeDur)
if err != nil {
return ChaosPauseData{Err: err}
}
l.Info().Str("Container", component.ContainerName).Msg("Component unpaused")
ctx, cancel = context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()
pauseEndBlock, err := client.Client.BlockNumber(ctx)
if err != nil {
return ChaosPauseData{Err: err}
}
return ChaosPauseData{PauseData: PauseData{
StartBlock: pauseStartBlock,
EndBlock: pauseEndBlock,
TargetComponent: targetComponent,
ContaineName: component.ContainerName,
}}
}
type ChaosPauseData struct {
Err error
PauseData PauseData
}
// ExecuteChaosExperiment executes the configured chaos experiment, which consist of pausing CL node or Postgres containers
func ExecuteChaosExperiment(l zerolog.Logger, testEnv *test_env.CLClusterTestEnv, testConfig *tc.TestConfig, errorCh chan error) {
if testConfig == nil || testConfig.LogPoller.ChaosConfig == nil || *testConfig.LogPoller.ChaosConfig.ExperimentCount == 0 {
errorCh <- nil
return
}
chaosChan := make(chan ChaosPauseData, *testConfig.LogPoller.ChaosConfig.ExperimentCount)
wg := &sync.WaitGroup{}
selectedNetwork := networks.MustGetSelectedNetworkConfig(testConfig.Network)[0]
sethClient, err := testEnv.GetSethClient(selectedNetwork.ChainID)
if err != nil {
errorCh <- err