-
Notifications
You must be signed in to change notification settings - Fork 210
/
reporter.go
614 lines (542 loc) · 15.7 KB
/
reporter.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
package events
import (
"fmt"
"runtime/debug"
"sync"
"github.com/libp2p/go-libp2p/core/event"
"github.com/libp2p/go-libp2p/p2p/host/eventbus"
"go.uber.org/zap/zapcore"
"github.com/spacemeshos/go-spacemesh/common/types"
"github.com/spacemeshos/go-spacemesh/log"
)
// Subscription is a subscription to events.
// Consumer must be aware that publish will block if subsription is not read fast enough.
type Subscription = event.Subscription
var (
mu sync.RWMutex
// reporter is the event reporter singleton.
reporter *EventReporter
)
// InitializeReporter initializes the event reporting interface with
// a nonzero channel buffer. This is useful for testing, where we want reporting to
// block.
func InitializeReporter() {
mu.Lock()
defer mu.Unlock()
if reporter != nil {
return
}
reporter = newEventReporter()
}
// EventHook returns hook for logger.
func EventHook() func(entry zapcore.Entry) error {
return func(entry zapcore.Entry) error {
// If we report anything less than this we'll end up in an infinite loop
if entry.Level >= zapcore.ErrorLevel {
ReportError(NodeError{
Msg: entry.Message,
Trace: string(debug.Stack()),
Level: entry.Level,
})
}
return nil
}
}
// ReportNewTx dispatches incoming events to the reporter singleton.
func ReportNewTx(layerID types.LayerID, tx *types.Transaction) {
ReportTxWithValidity(layerID, tx, true)
}
// ReportTxWithValidity reports a tx along with whether it was just invalidated.
func ReportTxWithValidity(layerID types.LayerID, tx *types.Transaction, valid bool) {
mu.RLock()
defer mu.RUnlock()
txWithValidity := Transaction{
Transaction: tx,
LayerID: layerID,
Valid: valid,
}
if reporter != nil {
if err := reporter.transactionEmitter.Emit(txWithValidity); err != nil {
// TODO(nkryuchkov): consider returning an error and log outside the function
log.With().Error("Failed to emit transaction", tx.ID, layerID, log.Err(err))
} else {
log.Debug("reported tx: %v", txWithValidity)
}
}
}
// ReportNewActivation reports a new activation.
func ReportNewActivation(activation *types.VerifiedActivationTx) {
mu.RLock()
defer mu.RUnlock()
activationTxEvent := ActivationTx{VerifiedActivationTx: activation}
if reporter != nil {
if err := reporter.activationEmitter.Emit(activationTxEvent); err != nil {
// TODO(nkryuchkov): consider returning an error and log outside the function
log.With().Error("Failed to emit activation", activation.ID(), activation.PublishEpoch, log.Err(err))
}
}
}
// ReportRewardReceived reports a new reward.
func ReportRewardReceived(r Reward) {
mu.RLock()
defer mu.RUnlock()
if reporter != nil {
if err := reporter.rewardEmitter.Emit(r); err != nil {
// TODO(nkryuchkov): consider returning an error and log outside the function
log.With().Error("Failed to emit rewards", r.Layer, log.Err(err))
} else {
log.Debug("reported reward: %v", r)
}
}
}
// ReportLayerUpdate reports a new layer, or an update to an existing layer.
func ReportLayerUpdate(layer LayerUpdate) {
mu.RLock()
defer mu.RUnlock()
if reporter != nil {
if err := reporter.layerEmitter.Emit(layer); err != nil {
// TODO(nkryuchkov): consider returning an error and log outside the function
log.With().Error("Failed to emit updated layer", layer, log.Err(err))
} else {
log.With().Debug("reported new or updated layer", layer)
}
}
}
// ReportError reports an error.
func ReportError(err NodeError) {
mu.RLock()
defer mu.RUnlock()
if reporter != nil {
if err := reporter.errorEmitter.Emit(err); err != nil {
// TODO(nkryuchkov): consider returning an error and log outside the function
log.With().Error("Failed to emit error", log.Err(err))
} else {
log.Debug("reported error: %v", err)
}
}
}
// ReportNodeStatusUpdate reports an update to the node status. It just
// pings the listener to notify them that there is an update; the listener
// is responsible for fetching the new status details. This is because
// status contains disparate information coming from different services,
// and the listener already knows how to gather that information so there
// is no point in duplicating that logic here.
// Note: There is some overlap with channelLayer here, as a new latest
// or verified layer should be sent over that channel as well. However,
// that happens inside the Mesh, at the source. It doesn't currently
// happen here because the status update includes only a layer ID, not
// full layer data, and the Reporter currently has no way to retrieve
// full layer data.
func ReportNodeStatusUpdate() {
mu.RLock()
defer mu.RUnlock()
if reporter != nil {
if err := reporter.statusEmitter.Emit(Status{}); err != nil {
// TODO(nkryuchkov): consider returning an error and log outside the function
log.With().Error("Failed to emit status update", log.Err(err))
} else {
log.Debug("reported status update")
}
}
}
// ReportResult reports creation or receipt of a new tx receipt.
func ReportResult(rst types.TransactionWithResult) {
if reporter != nil {
if err := reporter.resultsEmitter.Emit(rst); err != nil {
// TODO(nkryuchkov): consider returning an error and log outside the function
log.With().Error("Failed to emit tx results", rst.ID, log.Err(err))
}
}
}
// ReportAccountUpdate reports an account whose data has been updated.
func ReportAccountUpdate(a types.Address) {
mu.RLock()
defer mu.RUnlock()
accountEvent := Account{Address: a}
if reporter != nil {
if err := reporter.accountEmitter.Emit(accountEvent); err != nil {
// TODO(nkryuchkov): consider returning an error and log outside the function
log.With().Error("Failed to emit account update", log.String("account", a.String()), log.Err(err))
} else {
log.With().Debug("reported account update", a)
}
}
}
// SubscribeTxs subscribes to new transactions.
func SubscribeTxs() Subscription {
mu.RLock()
defer mu.RUnlock()
if reporter != nil {
sub, err := reporter.bus.Subscribe(new(Transaction))
if err != nil {
log.With().Panic("Failed to subscribe to transactions")
}
return sub
}
return nil
}
// SubscribeActivations subscribes to activations.
func SubscribeActivations() Subscription {
mu.RLock()
defer mu.RUnlock()
if reporter != nil {
sub, err := reporter.bus.Subscribe(new(ActivationTx))
if err != nil {
log.With().Panic("Failed to subscribe to activations")
}
return sub
}
return nil
}
// SubscribeLayers subscribes to all layer data.
func SubscribeLayers() Subscription {
mu.RLock()
defer mu.RUnlock()
if reporter != nil {
sub, err := reporter.bus.Subscribe(new(LayerUpdate))
if err != nil {
log.With().Panic("Failed to subscribe to layers")
}
return sub
}
return nil
}
// SubscribeErrors subscribes to node errors.
func SubscribeErrors() Subscription {
mu.RLock()
defer mu.RUnlock()
if reporter != nil {
sub, err := reporter.bus.Subscribe(new(NodeError))
if err != nil {
log.With().Panic("Failed to subscribe to errors")
}
return sub
}
return nil
}
// SubscribeStatus subscribes to node status messages.
func SubscribeStatus() Subscription {
mu.RLock()
defer mu.RUnlock()
if reporter != nil {
sub, err := reporter.bus.Subscribe(new(Status))
if err != nil {
log.With().Panic("Failed to subscribe to status")
}
return sub
}
return nil
}
// SubscribeAccount subscribes to account data updates.
func SubscribeAccount() Subscription {
mu.RLock()
defer mu.RUnlock()
if reporter != nil {
sub, err := reporter.bus.Subscribe(new(Account))
if err != nil {
log.With().Panic("Failed to subscribe to account updates")
}
return sub
}
return nil
}
// SubscribeRewards subscribes to rewards.
func SubscribeRewards() Subscription {
mu.RLock()
defer mu.RUnlock()
if reporter != nil {
sub, err := reporter.bus.Subscribe(new(Reward))
if err != nil {
log.With().Panic("Failed to subscribe to rewards")
}
return sub
}
return nil
}
// SubscribeToLayers is used to track and report automatically every time a
// new layer is reached.
func SubscribeToLayers(ticker LayerClock) {
mu.RLock()
defer mu.RUnlock()
if reporter == nil {
return
}
// This will block, so run in a goroutine
go func() {
next := ticker.CurrentLayer().Add(1)
for {
mu.RLock()
stopChan := reporter.stopChan
mu.RUnlock()
select {
case <-ticker.AwaitLayer(next):
current := ticker.CurrentLayer()
if current.Before(next) {
log.Info("time sync detected, realigning ProposalBuilder")
continue
}
next = current.Add(1)
log.With().Debug("reporter got new layer", current)
ReportNodeStatusUpdate()
case <-stopChan:
return
}
}
}()
}
func SubscribeUserEvents(opts ...SubOpt) (*BufferedSubscription[UserEvent], *Ring[UserEvent], error) {
mu.RLock()
defer mu.RUnlock()
if reporter == nil {
return nil, nil, nil
}
return reporter.subUserEvents(opts...)
}
// The status of a layer
// TODO: this list is woefully inadequate and does not map to reality. See https://github.com/spacemeshos/api/issues/144.
const (
LayerStatusTypeUnknown = iota
LayerStatusTypeApproved // approved by Hare
LayerStatusTypeConfirmed // confirmed by Tortoise
LayerStatusTypeApplied // applied to state
)
// LayerUpdate packages up a layer with its status (which a layer does not ordinarily contain).
type LayerUpdate struct {
LayerID types.LayerID
Status int
}
// Field returns a log field. Implements the LoggableField interface.
func (nl LayerUpdate) Field() log.Field {
return log.String("layer", fmt.Sprintf("status: %d, number: %d", nl.Status, nl.LayerID))
}
// NodeError represents an internal error to be reported.
type NodeError struct {
Msg string
Trace string
Level zapcore.Level
}
// TxReceipt represents a transaction receipt.
type TxReceipt struct {
ID types.TransactionID
Result int
GasUsed uint64
Fee uint64
Layer types.LayerID
Index uint32
Address types.Address
}
// Reward represents a reward object with extra data needed by the API.
type Reward struct {
Layer types.LayerID
Total uint64
LayerReward uint64
Coinbase types.Address
}
// Transaction wraps a tx with its layer ID and validity info.
type Transaction struct {
Transaction *types.Transaction
LayerID types.LayerID
Valid bool
}
// ActivationTx wraps *types.VerifiedActivationTx.
type ActivationTx struct {
*types.VerifiedActivationTx
}
// Status indicates status change event.
type Status struct{}
// Account wraps account address.
type Account struct {
types.Address
}
// EventReporter is the struct that receives incoming events and dispatches them.
type EventReporter struct {
bus event.Bus
transactionEmitter event.Emitter
activationEmitter event.Emitter
layerEmitter event.Emitter
errorEmitter event.Emitter
statusEmitter event.Emitter
accountEmitter event.Emitter
rewardEmitter event.Emitter
resultsEmitter event.Emitter
proposalsEmitter event.Emitter
events struct {
sync.Mutex
buf *Ring[UserEvent]
emitter event.Emitter
}
stopChan chan struct{}
}
func (r *EventReporter) emitUserEvent(ev UserEvent) error {
r.events.Lock()
defer r.events.Unlock()
r.events.buf.insert(ev)
return r.events.emitter.Emit(ev)
}
func (r *EventReporter) subUserEvents(opts ...SubOpt) (*BufferedSubscription[UserEvent], *Ring[UserEvent], error) {
r.events.Lock()
defer r.events.Unlock()
sub, err := Subscribe[UserEvent](opts...)
if err != nil {
return nil, nil, err
}
buf := r.events.buf.Copy()
return sub, buf, nil
}
func newEventReporter() *EventReporter {
bus := eventbus.NewBus()
transactionEmitter, err := bus.Emitter(new(Transaction))
if err != nil {
log.With().Panic("failed to create transaction emitter", log.Err(err))
}
activationEmitter, err := bus.Emitter(new(ActivationTx))
if err != nil {
log.With().Panic("failed to create activation emitter", log.Err(err))
}
layerEmitter, err := bus.Emitter(new(LayerUpdate))
if err != nil {
log.With().Panic("failed to create layer emitter", log.Err(err))
}
statusEmitter, err := bus.Emitter(new(Status))
if err != nil {
log.With().Panic("failed to create status emitter", log.Err(err))
}
accountEmitter, err := bus.Emitter(new(Account))
if err != nil {
log.With().Panic("failed to create account emitter", log.Err(err))
}
rewardEmitter, err := bus.Emitter(new(Reward))
if err != nil {
log.With().Panic("failed to create reward emitter", log.Err(err))
}
resultsEmitter, err := bus.Emitter(new(types.TransactionWithResult))
if err != nil {
log.With().Panic("failed to create receipt emitter", log.Err(err))
}
errorEmitter, err := bus.Emitter(new(NodeError))
if err != nil {
log.With().Panic("failed to create error emitter", log.Err(err))
}
proposalsEmitter, err := bus.Emitter(new(EventProposal))
if err != nil {
log.With().Panic("failed to to create proposal emitter", log.Err(err))
}
eventsEmitter, err := bus.Emitter(new(UserEvent))
if err != nil {
log.With().Panic("failed to to create proposal emitter", log.Err(err))
}
reporter := &EventReporter{
bus: bus,
transactionEmitter: transactionEmitter,
activationEmitter: activationEmitter,
layerEmitter: layerEmitter,
statusEmitter: statusEmitter,
accountEmitter: accountEmitter,
rewardEmitter: rewardEmitter,
resultsEmitter: resultsEmitter,
errorEmitter: errorEmitter,
proposalsEmitter: proposalsEmitter,
stopChan: make(chan struct{}),
}
reporter.events.buf = newRing[UserEvent](100)
reporter.events.emitter = eventsEmitter
return reporter
}
// CloseEventReporter shuts down the event reporting service and closes open channels.
func CloseEventReporter() {
mu.Lock()
defer mu.Unlock()
if reporter != nil {
if err := reporter.transactionEmitter.Close(); err != nil {
log.With().Panic("failed to close transactionEmitter", log.Err(err))
}
if err := reporter.activationEmitter.Close(); err != nil {
log.With().Panic("failed to close activationEmitter", log.Err(err))
}
if err := reporter.layerEmitter.Close(); err != nil {
log.With().Panic("failed to close layerEmitter", log.Err(err))
}
if err := reporter.errorEmitter.Close(); err != nil {
log.With().Panic("failed to close errorEmitter", log.Err(err))
}
if err := reporter.statusEmitter.Close(); err != nil {
log.With().Panic("failed to close statusEmitter", log.Err(err))
}
if err := reporter.accountEmitter.Close(); err != nil {
log.With().Panic("failed to close accountEmitter", log.Err(err))
}
if err := reporter.rewardEmitter.Close(); err != nil {
log.With().Panic("failed to close rewardEmitter", log.Err(err))
}
if err := reporter.resultsEmitter.Close(); err != nil {
log.With().Panic("failed to close receiptEmitter", log.Err(err))
}
if err := reporter.proposalsEmitter.Close(); err != nil {
log.With().Panic("failed to close propoposalsEmitter", log.Err(err))
}
close(reporter.stopChan)
reporter = nil
}
}
func newRing[T any](size int) *Ring[T] {
return &Ring[T]{
last: -1,
data: make([]T, size),
}
}
// Ring is an insert only buffer.
type Ring[T any] struct {
data []T
first, last int
}
func (r *Ring[T]) insert(value T) {
last := r.last
r.last++
r.last %= len(r.data)
r.data[r.last] = value
if last != -1 && r.first == r.last {
r.first++
r.first %= len(r.data)
}
}
func (r *Ring[T]) Copy() *Ring[T] {
cp := &Ring[T]{
first: r.first,
last: r.last,
data: make([]T, r.Len()),
}
copy(cp.data, r.data)
return cp
}
func (r *Ring[T]) Len() int {
if r.last == -1 {
return 0
}
if r.first > r.last {
return len(r.data)
}
return r.last - r.first + 1
}
func (r *Ring[T]) Iterate(iter func(val T) bool) {
if r.last == -1 {
return
}
if r.last > r.first {
for i := r.first; i <= r.last; i++ {
if !iter(r.data[i]) {
return
}
}
return
}
for i := r.first; i < len(r.data); i++ {
if !iter(r.data[i]) {
return
}
}
for i := 0; i < r.first; i++ {
if !iter(r.data[i]) {
return
}
}
}