/
registry.go
601 lines (525 loc) · 20.3 KB
/
registry.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
package registry
import (
"errors"
"fmt"
"sort"
"strings"
"sync"
"time"
"github.com/Bendomey/nucleo-go"
"github.com/Bendomey/nucleo-go/middleware"
"github.com/Bendomey/nucleo-go/payload"
"github.com/Bendomey/nucleo-go/service"
"github.com/Bendomey/nucleo-go/strategy"
"github.com/Bendomey/nucleo-go/transit"
"github.com/Bendomey/nucleo-go/transit/pubsub"
log "github.com/sirupsen/logrus"
)
type messageHandlerFunc func(message nucleo.Payload)
type ServiceRegistry struct {
logger *log.Entry
transit transit.Transit
localNode nucleo.Node
nodes *NodeCatalog
services *ServiceCatalog
actions *ActionCatalog
events *EventCatalog
broker *nucleo.BrokerDelegates
strategy strategy.Strategy
stopping bool
heartbeatFrequency time.Duration
heartbeatTimeout time.Duration
offlineCheckFrequency time.Duration
offlineTimeout time.Duration
nodeReceivedMutex *sync.Mutex
namespace string
}
// createTransit create a transit instance based on the config.
func createTransit(broker *nucleo.BrokerDelegates) transit.Transit {
transit := pubsub.Create(broker)
return transit
}
// createStrategy create a strategy instance based on the config.
func createStrategy(broker *nucleo.BrokerDelegates) strategy.Strategy {
//TODO: when new strategies are addes.. adde config check here to load the right one.
if broker.Config.StrategyFactory != nil {
return broker.Config.StrategyFactory().(strategy.Strategy)
}
if broker.Config.Strategy == nucleo.StrategyRoundRobin {
return &strategy.RoundRobinStrategy{}
}
return strategy.RandomStrategy{}
}
func CreateRegistry(nodeID string, broker *nucleo.BrokerDelegates) *ServiceRegistry {
config := broker.Config
transit := createTransit(broker)
strategy := createStrategy(broker)
logger := broker.Logger("registry", nodeID)
localNode := CreateNode(nodeID, true, logger.WithField("Node", nodeID))
localNode.Unavailable()
registry := &ServiceRegistry{
broker: broker,
transit: transit,
strategy: strategy,
logger: logger,
localNode: localNode,
actions: CreateActionCatalog(logger.WithField("catalog", "Actions")),
events: CreateEventCatalog(logger.WithField("catalog", "Events")),
services: CreateServiceCatalog(logger.WithField("catalog", "Services")),
nodes: CreateNodesCatalog(logger.WithField("catalog", "Nodes")),
heartbeatFrequency: config.HeartbeatFrequency,
heartbeatTimeout: config.HeartbeatTimeout,
offlineCheckFrequency: config.OfflineCheckFrequency,
offlineTimeout: config.OfflineTimeout,
stopping: false,
nodeReceivedMutex: &sync.Mutex{},
namespace: config.Namespace,
}
registry.logger.Debugln("Service Registry created for broker: ", nodeID)
broker.Bus().On("$broker.started", func(args ...interface{}) {
registry.logger.Debugln("Registry -> $broker.started event")
registry.localNode.Available()
})
registry.setupMessageHandlers()
return registry
}
func (registry *ServiceRegistry) KnowService(name string) bool {
return registry.services.FindByName(name)
}
func (registry *ServiceRegistry) KnowAction(name string) bool {
return registry.actions.Find(name) != nil
}
func (registry *ServiceRegistry) KnowNode(nodeID string) bool {
_, found := registry.nodes.findNode(nodeID)
return found
}
func (registry *ServiceRegistry) LocalNode() nucleo.Node {
return registry.localNode
}
func (registry *ServiceRegistry) setupMessageHandlers() {
messageHandler := map[string]messageHandlerFunc{
"HEARTBEAT": registry.filterMessages(registry.heartbeatMessageReceived),
"DISCONNECT": registry.filterMessages(registry.disconnectMessageReceived),
"INFO": registry.filterMessages(registry.remoteNodeInfoReceived),
}
registry.broker.Bus().On("$registry.transit.message", func(args ...interface{}) {
registry.logger.Traceln("Registry -> $registry.transit.message event - args: ", args)
command := args[0].(string)
message := args[1].(nucleo.Payload)
handler := messageHandler[command]
if handler == nil {
panic(errors.New(fmt.Sprint("Registry - $registry.transit.message event - invalid command:", command)))
}
handler(message)
})
}
func (registry *ServiceRegistry) Stop() {
registry.logger.Debugln("Registry Stopping...")
registry.stopping = true
err := <-registry.transit.Disconnect()
registry.localNode.Unavailable()
if err != nil {
registry.logger.Debugln("Error trying to disconnect transit - error: ", err)
return
}
registry.logger.Debugln("Transit Disconnected -> Registry Full Stop!")
}
func (registry *ServiceRegistry) LocalServices() []*service.Service {
return []*service.Service{createNodeService(registry)}
}
// Start : start the registry background processes.
func (registry *ServiceRegistry) Start() {
registry.logger.Debugln("Registry Start() ")
registry.stopping = false
err := <-registry.transit.Connect()
if err != nil {
panic(errors.New(fmt.Sprint("Could not connect to the transit. err: ", err)))
}
<-registry.transit.DiscoverNodes()
registry.nodes.Add(registry.localNode)
if registry.heartbeatFrequency > 0 {
go registry.loopWhileAlive(registry.heartbeatFrequency, registry.transit.SendHeartbeat)
}
if registry.heartbeatTimeout > 0 {
go registry.loopWhileAlive(registry.heartbeatTimeout, registry.checkExpiredRemoteNodes)
}
if registry.offlineCheckFrequency > 0 {
go registry.loopWhileAlive(registry.offlineCheckFrequency, registry.checkOfflineNodes)
}
}
func (registry *ServiceRegistry) ServiceForAction(name string) []*service.Service {
actions := registry.actions.Find(name)
if actions != nil {
result := make([]*service.Service, len(actions))
for i, action := range actions {
result[i] = action.Service()
}
return result
}
return nil
}
// HandleRemoteEvent handle when a remote event is delivered and call all the local handlers.
func (registry *ServiceRegistry) HandleRemoteEvent(context nucleo.BrokerContext) {
name := context.EventName()
groups := context.Groups()
if registry.stopping {
registry.logger.Errorln("HandleRemoteEvent() - registry is stopping. Discarding event -> name: ", name, " groups: ", groups)
return
}
broadcast := context.IsBroadcast()
registry.logger.Debugln("HandleRemoteEvent() - name: ", name, " groups: ", groups)
var stg strategy.Strategy
if !broadcast {
stg = registry.strategy
}
entries := registry.events.Find(name, groups, true, true, stg)
for _, localEvent := range entries {
go localEvent.emitLocalEvent(context)
}
}
// LoadBalanceEvent load balance an event based on the known targetNodes.
func (registry *ServiceRegistry) LoadBalanceEvent(context nucleo.BrokerContext) []*EventEntry {
name := context.EventName()
params := context.Payload()
groups := context.Groups()
eventSig := fmt.Sprint("name: ", name, " groups: ", groups)
registry.logger.Traceln("LoadBalanceEvent() - ", eventSig, " params: ", params)
entries := registry.events.Find(name, groups, true, false, registry.strategy)
if entries == nil {
msg := fmt.Sprint("Broker - no endpoints found for event: ", name, " it was discarded!")
registry.logger.Warnln(msg)
return nil
}
for _, eventEntry := range entries {
if eventEntry.isLocal {
eventEntry.emitLocalEvent(context)
} else {
registry.emitRemoteEvent(context, eventEntry)
}
}
registry.logger.Traceln("LoadBalanceEvent() - ", eventSig, " End.")
return entries
}
func (registry *ServiceRegistry) BroadcastEvent(context nucleo.BrokerContext) []*EventEntry {
name := context.EventName()
groups := context.Groups()
eventSig := fmt.Sprint("name: ", name, " groups: ", groups)
registry.logger.Traceln("BroadcastEvent() - ", eventSig, " payload: ", context.Payload())
entries := registry.events.Find(name, groups, false, false, nil)
if entries == nil {
msg := fmt.Sprint("Broker - no endpoints found for event: ", name, " it was discarded!")
registry.logger.Warnln(msg)
return nil
}
for _, eventEntry := range entries {
if eventEntry.isLocal {
eventEntry.emitLocalEvent(context)
} else {
registry.emitRemoteEvent(context, eventEntry)
}
}
registry.logger.Traceln("BroadcastEvent() - ", eventSig, " End.")
return entries
}
// DelegateCall : invoke a service action and return a channel which will eventualy deliver the results ;).
// This call might be local or remote.
func (registry *ServiceRegistry) LoadBalanceCall(context nucleo.BrokerContext, opts ...nucleo.Options) chan nucleo.Payload {
actionName := context.ActionName()
params := context.Payload()
registry.logger.Traceln("LoadBalanceCall() - actionName: ", actionName, " params: ", params, " namespace: ", registry.namespace, " opts: ", opts)
actionEntry := registry.nextAction(actionName, registry.strategy, opts...)
if actionEntry == nil {
msg := "Registry - endpoint not found for actionName: " + actionName
if registry.namespace != "" {
msg = msg + " namespace: " + registry.namespace
}
registry.logger.Errorln(msg)
resultChan := make(chan nucleo.Payload, 1)
resultChan <- payload.Error(msg)
return resultChan
}
registry.logger.Debugln("LoadBalanceCall() - actionName: ", actionName, " target nodeID: ", actionEntry.TargetNodeID())
context.SetPayloadSchema(actionEntry.action.Params().RawMap())
if actionEntry.isLocal {
beforeLocalActionResult := registry.broker.MiddlewareHandler("beforeLocalAction", context)
if beforeLocalActionResult != nil {
_, isValidContext := beforeLocalActionResult.(nucleo.BrokerContext)
if !isValidContext {
resultChan := make(chan nucleo.Payload, 1)
resultChan <- payload.New(beforeLocalActionResult)
return resultChan
}
}
result := <-actionEntry.invokeLocalAction(context)
tempParams := registry.broker.MiddlewareHandler("afterLocalAction", middleware.AfterActionParams{context, result})
actionParams := tempParams.(middleware.AfterActionParams)
resultChan := make(chan nucleo.Payload, 1)
resultChan <- actionParams.Result
return resultChan
}
beforeRemoteActionResult := registry.broker.MiddlewareHandler("beforeRemoteAction", context)
if beforeRemoteActionResult != nil {
_, isValidContext := beforeRemoteActionResult.(nucleo.BrokerContext)
if !isValidContext {
resultChan := make(chan nucleo.Payload, 1)
resultChan <- payload.New(beforeRemoteActionResult)
return resultChan
}
}
result := <-registry.invokeRemoteAction(context, actionEntry)
tempParams := registry.broker.MiddlewareHandler("afterRemoteAction", middleware.AfterActionParams{context, result})
actionParams := tempParams.(middleware.AfterActionParams)
resultChan := make(chan nucleo.Payload, 1)
resultChan <- actionParams.Result
return resultChan
}
func (registry *ServiceRegistry) emitRemoteEvent(context nucleo.BrokerContext, eventEntry *EventEntry) {
context.SetTargetNodeID(eventEntry.TargetNodeID())
registry.logger.Traceln("Before invoking remote event: ", context.EventName(), " context.TargetNodeID: ", context.TargetNodeID(), " context.Payload(): ", context.Payload())
registry.transit.Emit(context)
}
func (registry *ServiceRegistry) invokeRemoteAction(context nucleo.BrokerContext, actionEntry *ActionEntry) chan nucleo.Payload {
result := make(chan nucleo.Payload, 1)
context.SetTargetNodeID(actionEntry.TargetNodeID())
registry.logger.Traceln("Before invoking remote action: ", context.ActionName(), " context.TargetNodeID: ", context.TargetNodeID(), " context.Payload(): ", context.Payload())
go func() {
actionResult := <-registry.transit.Request(context)
registry.logger.Traceln("remote request done! action: ", context.ActionName(), " results: ", actionResult)
if registry.stopping {
registry.logger.Errorln("invokeRemoteAction() - registry is stopping. Discarding action result -> name: ", context.ActionName())
result <- payload.New(errors.New("can't complete request! registry stopping..."))
} else {
result <- actionResult
}
}()
return result
}
// removeServicesByNodeID
func (registry *ServiceRegistry) removeServicesByNodeID(nodeID string) {
svcs := registry.services.RemoveByNode(nodeID)
if len(svcs) > 0 {
for _, svc := range svcs {
registry.broker.Bus().EmitAsync(
"$registry.service.removed",
[]interface{}{svc.Summary()})
}
}
registry.actions.RemoveByNode(nodeID)
registry.events.RemoveByNode(nodeID)
}
// disconnectNode remove node info (actions, events) from local registry.
func (registry *ServiceRegistry) disconnectNode(nodeID string) {
node, exists := registry.nodes.findNode(nodeID)
if !exists {
return
}
registry.removeServicesByNodeID(nodeID)
node.Unavailable()
registry.broker.Bus().EmitAsync("$node.disconnected", []interface{}{nodeID})
registry.logger.Warnf("Node %s disconnected ", nodeID)
}
func (registry *ServiceRegistry) checkExpiredRemoteNodes() {
expiredNodes := registry.nodes.expiredNodes(registry.heartbeatTimeout)
for _, node := range expiredNodes {
registry.disconnectNode(node.GetID())
}
}
func (registry *ServiceRegistry) checkOfflineNodes() {
expiredNodes := registry.nodes.expiredNodes(registry.offlineTimeout)
for _, node := range expiredNodes {
nodeID := node.GetID()
registry.nodes.removeNode(nodeID)
registry.logger.Warnf("Removed offline Node: %s from the registry because it hasn't submitted heartbeat in %d seconds.", nodeID, registry.offlineTimeout)
}
}
// loopWhileAlive : can the delegate runction in the given frequency and stop whe the registry is stopping
func (registry *ServiceRegistry) loopWhileAlive(frequency time.Duration, delegate func()) {
for {
if registry.stopping {
break
}
delegate()
time.Sleep(frequency)
}
}
func (registry *ServiceRegistry) filterMessages(handler func(message nucleo.Payload)) func(message nucleo.Payload) {
return func(message nucleo.Payload) {
if registry.stopping {
registry.logger.Warnln("filterMessages() - registry is stopping. Discarding message: ", message)
return
}
if message.Get("sender").Exists() && message.Get("sender").String() == registry.localNode.GetID() {
registry.logger.Debugln("filterMessages() - Same host message (sender == localNodeID). discarding... ", message)
return
}
handler(message)
}
}
func (registry *ServiceRegistry) heartbeatMessageReceived(message nucleo.Payload) {
heartbeat := message.RawMap()
succesful := registry.nodes.HeartBeat(heartbeat)
if !succesful {
sender := heartbeat["sender"].(string)
registry.transit.DiscoverNode(sender)
}
}
// disconnectMessageReceived handles when a disconnect msg is received.
// It remove all actions/events from the sender node from the local registry.
func (registry *ServiceRegistry) disconnectMessageReceived(message nucleo.Payload) {
sender := message.Get("sender").String()
node, exists := registry.nodes.findNode(sender)
registry.logger.Debugln("disconnectMessageReceived() sender: ", sender, " exists: ", exists)
if exists {
registry.disconnectNode(node.GetID())
}
}
func compatibility(info map[string]interface{}) map[string]interface{} {
_, exists := info["version"]
if !exists {
info["version"] = ""
}
return info
}
// remoteNodeInfoReceived process the remote node info message and add to local registry.
func (registry *ServiceRegistry) remoteNodeInfoReceived(message nucleo.Payload) {
registry.nodeReceivedMutex.Lock()
defer registry.nodeReceivedMutex.Unlock()
nodeID := message.Get("sender").String()
services := message.Get("services").MapArray()
exists, reconnected := registry.nodes.Info(message.RawMap())
for _, serviceInfo := range services {
serviceInfo = compatibility(serviceInfo)
svc, newService, updatedActions, newActions, deletedActions, updatedEvents, newEvents, deletedEvents := registry.services.updateRemote(nodeID, serviceInfo)
for _, newAction := range newActions {
serviceAction := service.CreateServiceAction(
serviceInfo["name"].(string),
newAction.Name(),
nil,
payload.Empty(),
)
registry.actions.Add(serviceAction, svc, false)
}
for _, updates := range updatedActions {
fullname := updates["name"].(string)
registry.actions.Update(nodeID, fullname, updates)
}
for _, deleted := range deletedActions {
fullname := deleted.FullName()
registry.actions.Remove(nodeID, fullname)
}
for _, newEvent := range newEvents {
serviceEvent := service.CreateServiceEvent(
newEvent.Name(),
serviceInfo["name"].(string),
newEvent.Group(),
newEvent.Handler())
registry.events.Add(serviceEvent, svc, false)
}
for _, updates := range updatedEvents {
name := updates["name"].(string)
registry.events.Update(nodeID, name, updates)
}
for _, deleted := range deletedEvents {
name := deleted.Name()
registry.events.Remove(nodeID, name)
}
if newService {
registry.logger.Infof("Registry - remote %s service is registered.", svc.FullName())
registry.broker.Bus().EmitAsync(
"$registry.service.added",
[]interface{}{svc.Summary()})
}
}
var neighbours int64
if message.Get("neighbours").Exists() {
neighbours = message.Get("neighbours").Int64()
}
eventParam := []interface{}{nodeID, neighbours}
eventName := "$node.connected"
if exists {
eventName = "$node.updated"
} else if reconnected {
eventName = "$node.reconnected"
}
registry.broker.Bus().EmitAsync(eventName, eventParam)
}
// subscribeInternalEvent subscribe event listeners for internal events (e.g. $node.disconnected) using the localBus.
func (registry *ServiceRegistry) subscribeInternalEvent(event service.Event) {
registry.broker.Bus().On(event.Name(), func(data ...interface{}) {
params := payload.New(nil)
if len(data) > 0 {
params = payload.New(data[0])
}
brokerContext := registry.broker.BrokerContext()
eventContext := brokerContext.ChildEventContext(event.Name(), params, nil, false)
event.Handler()(eventContext.(nucleo.Context), params)
})
}
// AddLocalService : add a local service to the registry
// it will create endpoints for all service actions.
func (registry *ServiceRegistry) AddLocalService(service *service.Service) {
if registry.services.Find(service.Name(), service.Version(), registry.localNode.GetID()) {
registry.logger.Traceln("registry - AddLocalService() - Service already registered, will ignore.. service fullName: ", service.FullName())
return
}
registry.services.Add(service)
actions := service.Actions()
events := service.Events()
for _, action := range actions {
registry.actions.Add(action, service, true)
}
for _, event := range events {
if strings.Index(event.Name(), "$") == 0 {
registry.subscribeInternalEvent(event)
} else {
registry.events.Add(event, service, true)
}
}
registry.localNode.Publish(service.AsMap())
registry.logger.Debugln("Registry published local service: ", service.FullName(), " # actions: ", len(actions), " # events: ", len(events), " nodeID: ", service.NodeID())
registry.notifyServiceAdded(service.Summary())
}
// notifyServiceAdded notify when a service is added to the registry.
func (registry *ServiceRegistry) notifyServiceAdded(svc map[string]string) {
if registry.broker.IsStarted() {
registry.broker.Bus().EmitAsync(
"$registry.service.added",
[]interface{}{svc})
} else {
registry.broker.Bus().Once("$broker.started", func(...interface{}) {
registry.broker.Bus().EmitAsync(
"$registry.service.added",
[]interface{}{svc})
})
}
}
// nextAction it will find and return the next action to be invoked.
// If multiple nodes that contain this action are found it will use the strategy to decide which one to use.
func (registry *ServiceRegistry) nextAction(actionName string, strategy strategy.Strategy, opts ...nucleo.Options) *ActionEntry {
if len(opts) > 0 && opts[0].NodeID != "" {
return registry.actions.NextFromNode(actionName, opts[0].NodeID)
}
return registry.actions.Next(actionName, strategy)
}
func (registry *ServiceRegistry) KnownEventListeners(addNode bool) []string {
events := registry.events.list()
result := make([]string, len(events))
for index, event := range events {
if addNode {
result[index] = fmt.Sprint(event.targetNodeID, ".", event.event.ServiceName(), ".", event.event.Name())
} else {
result[index] = fmt.Sprint(event.event.ServiceName(), ".", event.event.Name())
}
}
sort.Strings(result)
return result
}
func (registry *ServiceRegistry) KnownNodes() []string {
nodes := registry.nodes.list()
result := make([]string, len(nodes))
for index, node := range nodes {
result[index] = node.GetID()
}
sort.Strings(result)
return result
}