-
Notifications
You must be signed in to change notification settings - Fork 5
/
service.go
330 lines (290 loc) · 10 KB
/
service.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
package provider
import (
"context"
"errors"
"fmt"
"sync"
"time"
"github.com/mycontroller-org/server/v2/pkg/types"
contextTY "github.com/mycontroller-org/server/v2/pkg/types/context"
msgTY "github.com/mycontroller-org/server/v2/pkg/types/message"
nodeTY "github.com/mycontroller-org/server/v2/pkg/types/node"
"github.com/mycontroller-org/server/v2/pkg/types/topic"
"github.com/mycontroller-org/server/v2/pkg/utils"
cloneUtils "github.com/mycontroller-org/server/v2/pkg/utils/clone"
queueUtils "github.com/mycontroller-org/server/v2/pkg/utils/queue"
busTY "github.com/mycontroller-org/server/v2/plugin/bus/types"
gwPlugin "github.com/mycontroller-org/server/v2/plugin/gateway"
providerTY "github.com/mycontroller-org/server/v2/plugin/gateway/provider/type"
gwTY "github.com/mycontroller-org/server/v2/plugin/gateway/types"
"go.uber.org/zap"
)
const (
messageQueueLimit = 200
rawMessageQueueLimit = 200
sleepingQueuePerNodeLimit = 20 // number of messages can be in sleeping queue per node
messageWorkersCount = 1
rawMessageWorkersCount = 1
defaultReconnectDelay = "15s"
loggerName = "gateway_service"
)
// Service component of the provider
type Service struct {
GatewayConfig *gwTY.Config
provider providerTY.Plugin
messageQueue *queueUtils.QueueSpec
rawMessageQueue *queueUtils.QueueSpec
sleepingMessageQueue map[string][]msgTY.Message
mutex *sync.RWMutex
ctx context.Context
logger *zap.Logger
bus busTY.Plugin
}
// GetService returns service instance
func GetService(ctx context.Context, gatewayCfg *gwTY.Config) (*Service, error) {
logger, err := contextTY.LoggerFromContext(ctx)
if err != nil {
return nil, err
}
bus, err := busTY.FromContext(ctx)
if err != nil {
return nil, err
}
// verify default reconnect delay
gatewayCfg.ReconnectDelay = utils.ValidDuration(gatewayCfg.ReconnectDelay, defaultReconnectDelay)
// get a plugin
provider, err := gwPlugin.Create(ctx, gatewayCfg.Provider.GetString(types.KeyType), gatewayCfg)
if err != nil {
return nil, err
}
s := &Service{
GatewayConfig: gatewayCfg,
provider: provider,
ctx: ctx,
mutex: &sync.RWMutex{},
logger: logger.Named(loggerName),
bus: bus,
}
// message queues
s.rawMessageQueue = &queueUtils.QueueSpec{
Queue: queueUtils.New(s.logger, fmt.Sprintf("gw_provider_raw_msg_%s", s.GatewayConfig.ID), rawMessageQueueLimit, s.rawMessageProcessor, rawMessageWorkersCount),
Topic: topic.TopicPostMessageToProcessor,
SubscriptionId: -1,
}
s.messageQueue = &queueUtils.QueueSpec{
Queue: queueUtils.New(s.logger, fmt.Sprintf("gw_provider_msg_%s", s.GatewayConfig.ID), messageQueueLimit, s.messageConsumer, messageWorkersCount),
Topic: fmt.Sprintf("%s.%s", topic.TopicPostMessageToProvider, s.GatewayConfig.ID),
SubscriptionId: -1,
}
return s, nil
}
// Start gateway service
func (s *Service) Start() error {
s.logger.Debug("starting a provider service", zap.String("gatewayId", s.GatewayConfig.ID), zap.String("providerType", s.GatewayConfig.Provider.GetString(types.NameType)))
s.sleepingMessageQueue = make(map[string][]msgTY.Message)
// start message listener
s.startMessageListener()
// start provider
err := s.provider.Start(s.rawMessageQueueProduceFunc)
if err != nil {
s.logger.Error("error", zap.Error(err))
err := s.bus.Unsubscribe(s.messageQueue.Topic, s.messageQueue.SubscriptionId)
if err != nil {
s.logger.Error("error on unsubscribe", zap.Error(err), zap.String("topic", s.messageQueue.Topic))
}
s.messageQueue.Close()
s.rawMessageQueue.Close()
}
return err
}
// unsubscribe and stop queues
func (s *Service) stopService() {
err := s.bus.Unsubscribe(s.messageQueue.Topic, s.messageQueue.SubscriptionId)
if err != nil {
s.logger.Error("error on unsubscribe", zap.Error(err), zap.String("topic", s.messageQueue.Topic))
}
s.messageQueue.Close()
s.rawMessageQueue.Close()
}
// Stop the service
func (s *Service) Stop() error {
defer s.stopService() // in any case when exit, call stopService
err := s.provider.Close() // close protocol connection
if err != nil {
return err
}
return nil
}
// this function supplied to provider-protocol
// rawMessages will be added directly to here
func (s *Service) rawMessageQueueProduceFunc(rawMsg *msgTY.RawMessage) error {
status := s.rawMessageQueue.Produce(rawMsg)
if !status {
return errors.New("failed to add rawMessage in to queue")
}
return nil
}
// listens messages from server
func (s *Service) startMessageListener() {
subscriptionID, err := s.bus.Subscribe(s.messageQueue.Topic, func(event *busTY.BusData) {
msg := &msgTY.Message{}
err := event.LoadData(msg)
if err != nil {
s.logger.Warn("received invalid type", zap.Any("event", event))
return
}
if msg.GatewayID == "" {
s.logger.Warn("received message with empty gatewayId", zap.Any("message", msg))
return
}
s.messageQueue.Produce(msg)
})
if err != nil {
s.logger.Error("error on subscription", zap.String("topic", s.messageQueue.Topic), zap.Error(err))
} else {
s.messageQueue.SubscriptionId = subscriptionID
}
}
func (s *Service) messageConsumer(item interface{}) {
msg, ok := item.(*msgTY.Message)
if !ok {
s.logger.Error("invalid message type", zap.Any("received", item))
return
}
// include timestamp, if not set
if msg.Timestamp.IsZero() {
msg.Timestamp = time.Now()
}
// if it is awake message send the sleeping queue messages
if msg.Type == msgTY.TypeAction && len(msg.Payloads) > 0 && msg.Payloads[0].Value == nodeTY.ActionAwake {
s.publishSleepingMessageQueue(msg.NodeID)
return
} else if msg.IsSleepNode {
// for sleeping node message to be added in to the sleeping queue
// when node sends awake signal, queue message will be published
s.addToSleepingMessageQueue(msg)
return
} else {
s.postMessage(msg, s.GatewayConfig.QueueFailedMessage)
}
}
// postMessage to the provider
func (s *Service) postMessage(msg *msgTY.Message, queueFailedMessage bool) {
err := s.provider.Post(msg)
if err != nil {
s.logger.Warn("error on sending", zap.String("gatewayId", s.GatewayConfig.ID), zap.Any("message", msg), zap.Error(err))
if queueFailedMessage {
msg.Labels = msg.Labels.Init()
isSleepingQueueDisabled := msg.Labels.IsExists(types.LabelNodeSleepQueueDisabled) && msg.Labels.GetBool(types.LabelNodeSleepQueueDisabled)
if !isSleepingQueueDisabled {
s.addToSleepingMessageQueue(msg)
}
}
}
}
// process received raw messages from protocol
func (s *Service) rawMessageProcessor(data interface{}) {
rawMsg := data.(*msgTY.RawMessage)
s.logger.Debug("received rawMessage", zap.String("gatewayId", s.GatewayConfig.ID), zap.Any("rawMessage", rawMsg))
messages, err := s.provider.ConvertToMessages(rawMsg)
if err != nil {
s.logger.Warn("failed to parse", zap.String("gatewayId", s.GatewayConfig.ID), zap.Any("rawMessage", rawMsg), zap.Error(err))
return
}
if len(messages) == 0 {
s.logger.Debug("messages not parsed", zap.String("gatewayId", s.GatewayConfig.ID), zap.Any("rawMessage", rawMsg))
return
}
// update gatewayID if not found
for index := 0; index < len(messages); index++ {
msg := messages[index]
if msg != nil {
if msg != nil && msg.GatewayID == "" {
msg.GatewayID = s.GatewayConfig.ID
}
err = s.bus.Publish(s.rawMessageQueue.Topic, msg)
if err != nil {
s.logger.Debug("failed to post on topic", zap.String("topic", s.rawMessageQueue.Topic), zap.String("gatewayId", s.GatewayConfig.ID), zap.Any("message", msg), zap.Error(err))
return
}
}
}
}
// add message in to sleeping queue
func (s *Service) addToSleepingMessageQueue(msg *msgTY.Message) {
s.mutex.Lock()
defer s.mutex.Unlock()
// add into sleeping queue
queue, ok := s.sleepingMessageQueue[msg.NodeID]
if !ok {
queue = make([]msgTY.Message, 0)
s.sleepingMessageQueue[msg.NodeID] = queue
}
// verify if the message already in the queue, if then remove it
newMsgId := msg.GetID()
for index, oldMsg := range queue {
if newMsgId == oldMsg.GetID() {
queue[index] = *msg
queue = append(queue[:index], queue[index+1:]...)
break
}
}
// add it to the queue
queue = append(queue, *msg)
// if queue size exceeds maximum defined size, do resize
oldSize := len(queue)
if oldSize > sleepingQueuePerNodeLimit {
queue = queue[:sleepingQueuePerNodeLimit]
s.logger.Debug("dropped messages from sleeping queue", zap.Int("oldSize", oldSize), zap.Int("newSize", len(queue)), zap.String("gatewayID", msg.GatewayID), zap.String("nodeID", msg.NodeID))
}
s.sleepingMessageQueue[msg.NodeID] = queue
}
// emptySleepingMessageQueue clears all the messages on the queue
func (s *Service) publishSleepingMessageQueue(nodeID string) {
s.mutex.Lock()
defer s.mutex.Unlock()
msgQueue, ok := s.sleepingMessageQueue[nodeID]
if !ok {
return
}
// post messages
for _, msg := range msgQueue {
s.postMessage(&msg, false)
}
// remove messages from the map
s.sleepingMessageQueue[nodeID] = make([]msgTY.Message, 0)
}
// returns sleeping queue messages
func (s *Service) GetGatewaySleepingQueue() map[string][]msgTY.Message {
s.mutex.Lock()
defer s.mutex.Unlock()
// clone the queue and return
clonedQueue := cloneUtils.Clone(s.sleepingMessageQueue)
return clonedQueue.(map[string][]msgTY.Message)
}
// returns sleeping queue messages
func (s *Service) GetNodeSleepingQueue(nodeID string) []msgTY.Message {
s.mutex.Lock()
defer s.mutex.Unlock()
msgQueue, ok := s.sleepingMessageQueue[nodeID]
if !ok {
return make([]msgTY.Message, 0)
}
// clone the queue and return
clonedQueue := cloneUtils.Clone(msgQueue)
return clonedQueue.([]msgTY.Message)
}
// clear all sleeping messages
func (s *Service) ClearGatewaySleepingQueue() {
s.mutex.Lock()
defer s.mutex.Unlock()
// clear all the messages
s.sleepingMessageQueue = make(map[string][]msgTY.Message)
}
// clear sleeping queue message of a node
func (s *Service) ClearNodeSleepingQueue(nodeID string) {
s.mutex.Lock()
defer s.mutex.Unlock()
// remove messages for a node
s.sleepingMessageQueue[nodeID] = make([]msgTY.Message, 0)
}