forked from NdoleStudio/httpsms
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathheartbeat_service.go
More file actions
430 lines (352 loc) · 17.7 KB
/
Copy pathheartbeat_service.go
File metadata and controls
430 lines (352 loc) · 17.7 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
package services
import (
"context"
"fmt"
"time"
"github.com/NdoleStudio/httpsms/pkg/events"
cloudevents "github.com/cloudevents/sdk-go/v2"
"github.com/google/uuid"
"github.com/NdoleStudio/httpsms/pkg/repositories"
"github.com/palantir/stacktrace"
"github.com/NdoleStudio/httpsms/pkg/entities"
"github.com/NdoleStudio/httpsms/pkg/telemetry"
)
const (
// select id, a.timestamp, a.owner, a.timestamp - (SELECT timestamp from heartbeats b where b.timestamp < a.timestamp and a.owner = b.owner and a.user_id = b.user_id order by b.timestamp desc limit 1) as diff from heartbeats a;
heartbeatCheckInterval = 16 * time.Minute
)
// HeartbeatService is handles heartbeat requests
type HeartbeatService struct {
service
logger telemetry.Logger
tracer telemetry.Tracer
repository repositories.HeartbeatRepository
monitorRepository repositories.HeartbeatMonitorRepository
dispatcher *EventDispatcher
}
// NewHeartbeatService creates a new HeartbeatService
func NewHeartbeatService(
logger telemetry.Logger,
tracer telemetry.Tracer,
repository repositories.HeartbeatRepository,
monitorRepository repositories.HeartbeatMonitorRepository,
dispatcher *EventDispatcher,
) (s *HeartbeatService) {
return &HeartbeatService{
logger: logger.WithService(fmt.Sprintf("%T", s)),
tracer: tracer,
repository: repository,
monitorRepository: monitorRepository,
dispatcher: dispatcher,
}
}
// DeleteAllForUser deletes all entities.Heartbeat for an entities.UserID.
func (service *HeartbeatService) DeleteAllForUser(ctx context.Context, userID entities.UserID) error {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
if err := service.repository.DeleteAllForUser(ctx, userID); err != nil {
msg := fmt.Sprintf("could not delete all [entities.Heartbeat] for user with ID [%s]", userID)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
if err := service.monitorRepository.DeleteAllForUser(ctx, userID); err != nil {
msg := fmt.Sprintf("could not delete all [entities.HeartbeatMonitor] for user with ID [%s]", userID)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("deleted all [entities.Heartbeat] and [entities.HeartbeatMonitor] for user with ID [%s]", userID))
return nil
}
// Index fetches the heartbeats for a phone number
func (service *HeartbeatService) Index(ctx context.Context, userID entities.UserID, owner string, params repositories.IndexParams) (*[]entities.Heartbeat, error) {
ctx, span := service.tracer.Start(ctx)
defer span.End()
ctxLogger := service.tracer.CtxLogger(service.logger, span)
heartbeats, err := service.repository.Index(ctx, userID, owner, params)
if err != nil {
msg := fmt.Sprintf("could not fetch heartbeats with parms [%+#v]", params)
return nil, service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("fetched [%d] messages with prams [%+#v]", len(*heartbeats), params))
return heartbeats, nil
}
// HeartbeatStoreParams are parameters for creating a new entities.Heartbeat
type HeartbeatStoreParams struct {
Owner string
Version string
Charging bool
Source string
Timestamp time.Time
UserID entities.UserID
}
// Store a new entities.Heartbeat
func (service *HeartbeatService) Store(ctx context.Context, params HeartbeatStoreParams) (*entities.Heartbeat, error) {
ctx, span := service.tracer.Start(ctx)
defer span.End()
ctxLogger := service.tracer.CtxLogger(service.logger, span)
heartbeat := &entities.Heartbeat{
ID: uuid.New(),
Owner: params.Owner,
Charging: params.Charging,
Timestamp: params.Timestamp,
Version: params.Version,
UserID: params.UserID,
}
if err := service.repository.Store(ctx, heartbeat); err != nil {
msg := fmt.Sprintf("cannot save heartbeat with id [%s]", heartbeat.ID)
return nil, service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("heartbeat saved with id [%s] for user [%s]", heartbeat.ID, heartbeat.UserID))
monitor, err := service.monitorRepository.Load(ctx, params.UserID, params.Owner)
if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
ctxLogger.Info(fmt.Sprintf("heartbeat monitor does not exist for owner [%s] and user [%s]", params.Owner, params.UserID))
return heartbeat, nil
}
if err != nil {
msg := fmt.Sprintf("cannot load heartbeat monitor for owner [%s] and user [%s]", params.Owner, params.UserID)
ctxLogger.Error(stacktrace.Propagate(err, msg))
return heartbeat, nil
}
if monitor.PhoneIsOffline() {
ctxLogger.Info(fmt.Sprintf("phone with monitor ID [%s] was offline for user [%s]", monitor.ID, monitor.UserID))
service.handleHeartbeatWhenPhoneWasOffline(ctx, params.Source, heartbeat, monitor)
}
return heartbeat, nil
}
// HeartbeatMonitorStoreParams are parameters for creating a new entities.Heartbeat
type HeartbeatMonitorStoreParams struct {
Owner string
PhoneID uuid.UUID
Source string
UserID entities.UserID
}
func (service *HeartbeatService) handleHeartbeatWhenPhoneWasOffline(ctx context.Context, source string, heartbeat *entities.Heartbeat, monitor *entities.HeartbeatMonitor) {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
if err := service.UpdatePhoneOnline(ctx, monitor.UserID, monitor.ID, true); err != nil {
msg := fmt.Sprintf("cannot update phone online status for heartbeat monitor [%s]", monitor.ID)
ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
}
event, err := service.createEvent(events.EventTypePhoneHeartbeatOnline, source, &events.PhoneHeartbeatOnlinePayload{
PhoneID: monitor.PhoneID,
UserID: monitor.UserID,
LastHeartbeatTimestamp: heartbeat.Timestamp,
Timestamp: time.Now().UTC(),
MonitorID: monitor.ID,
Owner: heartbeat.Owner,
})
if err != nil {
msg := fmt.Sprintf("cannot create [%s] event for monitor with ID [%s]", events.EventTypePhoneHeartbeatOnline, monitor.ID)
ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
return
}
if err = service.dispatcher.Dispatch(ctx, event); err != nil {
msg := fmt.Sprintf("cannot dispatch event [%s] for heartbeat monitor with phone id [%s]", event.Type(), monitor.PhoneID)
ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
return
}
ctxLogger.Info(fmt.Sprintf("[%s] event created with ID [%s] for monitor ID [%s] and user [%s]", event.Type(), event.ID(), monitor.ID, monitor.UserID))
return
}
// StoreMonitor a new entities.HeartbeatMonitor
func (service *HeartbeatService) StoreMonitor(ctx context.Context, params *HeartbeatMonitorStoreParams) (*entities.HeartbeatMonitor, error) {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
monitor, scheduleCheck, err := service.phoneMonitor(ctx, params)
if err != nil {
msg := fmt.Sprintf("cannot create monitor for with userID [%s] and owner [%s]", params.UserID, params.Owner)
return nil, service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
if !scheduleCheck {
ctxLogger.Info(fmt.Sprintf("heartbeat monitor [%s] for owner [%s] does not need scheduling because it was updated at [%s]", monitor.ID, monitor.Owner, monitor.UpdatedAt))
return monitor, nil
}
ctxLogger.Info(fmt.Sprintf("scheduling heartbeat monitor [%s] for owner [%s] and user [%s]", monitor.ID, monitor.Owner, monitor.UserID))
monitorParams := &HeartbeatMonitorParams{
Owner: monitor.Owner,
PhoneID: monitor.PhoneID,
UserID: monitor.UserID,
MonitorID: monitor.ID,
Source: params.Source,
}
if err = service.scheduleHeartbeatCheck(ctx, time.Now().UTC(), monitorParams); err != nil {
msg := fmt.Sprintf("cannot schedule healthcheck for monitor [%s] with owner [%s] and userID [%s]", monitor.ID, params.Owner, params.UserID)
return nil, service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
return monitor, nil
}
func (service *HeartbeatService) phoneMonitor(ctx context.Context, params *HeartbeatMonitorStoreParams) (*entities.HeartbeatMonitor, bool, error) {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
monitor, err := service.monitorRepository.Load(ctx, params.UserID, params.Owner)
if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
monitor = &entities.HeartbeatMonitor{
ID: uuid.New(),
PhoneID: params.PhoneID,
UserID: params.UserID,
Owner: params.Owner,
PhoneOnline: true,
CreatedAt: time.Now().UTC(),
UpdatedAt: time.Now().UTC(),
}
if err = service.monitorRepository.Store(ctx, monitor); err != nil {
msg := fmt.Sprintf("cannot save heartbeat monitor for owner [%s] and user [%s]", monitor.Owner, monitor.UserID)
return nil, false, service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("heartbeat monitor saved with id [%s] for owner [%s] and user [%s]", monitor.ID, monitor.Owner, monitor.UserID))
return monitor, true, nil
}
if err != nil {
msg := fmt.Sprintf("cannot check if monitor exists with userID [%s] and owner [%s]", params.UserID, params.Owner)
return nil, false, service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
return monitor, monitor.RequiresCheck(), nil
}
// DeleteMonitor an entities.HeartbeatMonitor
func (service *HeartbeatService) DeleteMonitor(ctx context.Context, userID entities.UserID, owner string) error {
ctx, span := service.tracer.Start(ctx)
defer span.End()
ctxLogger := service.tracer.CtxLogger(service.logger, span)
if err := service.monitorRepository.Delete(ctx, userID, owner); err != nil {
msg := fmt.Sprintf("cannot delete heartbeat monitor with userID [%s] and owner [%s]", userID, owner)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("heartbeat monitor deleted for userID [%s] and owner [%s]", userID, owner))
return nil
}
// UpdatePhoneOnline updates the phone_online field in an entities.HeartbeatMonitor
func (service *HeartbeatService) UpdatePhoneOnline(ctx context.Context, userID entities.UserID, monitorID uuid.UUID, phoneOnline bool) error {
ctx, span := service.tracer.Start(ctx)
defer span.End()
ctxLogger := service.tracer.CtxLogger(service.logger, span)
if err := service.monitorRepository.UpdatePhoneOnline(ctx, userID, monitorID, phoneOnline); err != nil {
msg := fmt.Sprintf("cannot update heartbeat monitor [%s] with userID [%s] and status [%t]", monitorID, userID, phoneOnline)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("heartbeat monitor [%s] updated for userID [%s] and status [%t]", monitorID, userID, phoneOnline))
return nil
}
// HeartbeatMonitorParams are parameters for monitoring the heartbeat
type HeartbeatMonitorParams struct {
Owner string
MonitorID uuid.UUID
PhoneID uuid.UUID
UserID entities.UserID
Source string
}
// Monitor the heartbeats of an owner and phone number
func (service *HeartbeatService) Monitor(ctx context.Context, params *HeartbeatMonitorParams) error {
ctx, span := service.tracer.Start(ctx)
defer span.End()
ctxLogger := service.tracer.CtxLogger(service.logger, span)
monitor, err := service.monitorRepository.Load(ctx, params.UserID, params.Owner)
if err != nil && stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
ctxLogger.Info(fmt.Sprintf("heartbeat monitor does not exist for owner [%s] and user [%s]", params.Owner, params.UserID))
return nil
}
if err != nil {
msg := fmt.Sprintf("cannot check if monitor exists with userID [%s] and owner [%s]", params.UserID, params.Owner)
ctxLogger.Error(stacktrace.Propagate(err, msg))
return service.scheduleHeartbeatCheck(ctx, time.Now().UTC(), params)
}
// Update params in case of ID duplicate
params.PhoneID = monitor.PhoneID
params.MonitorID = monitor.ID
heartbeat, err := service.repository.Last(ctx, params.UserID, params.Owner)
if err != nil {
msg := fmt.Sprintf("cannot fetch last heartbeat for userID [%s] and owner [%s] and ID [%s] removing check", params.UserID, params.Owner, params.MonitorID)
ctxLogger.Error(stacktrace.Propagate(err, msg))
return nil
}
// send urgent FCM message if the last heartbeat is late
if time.Now().UTC().Sub(heartbeat.Timestamp) > heartbeatCheckInterval && time.Now().UTC().Sub(heartbeat.Timestamp) < (heartbeatCheckInterval*5) {
ctxLogger.Info(fmt.Sprintf("sending missed heartbeat notification for userID [%s] and owner [%s] and monitor ID [%s]", params.UserID, params.Owner, params.MonitorID))
service.handleMissedMonitor(ctx, heartbeat.Timestamp, params)
}
if time.Now().UTC().Sub(heartbeat.Timestamp) > (heartbeatCheckInterval*4) &&
time.Now().UTC().Sub(heartbeat.Timestamp) < (heartbeatCheckInterval*5) && monitor.PhoneOnline {
return service.handleFailedMonitor(ctx, heartbeat.Timestamp, params)
}
return service.scheduleHeartbeatCheck(ctx, heartbeat.Timestamp, params)
}
func (service *HeartbeatService) handleMissedMonitor(ctx context.Context, lastTimestamp time.Time, params *HeartbeatMonitorParams) {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
event, err := service.createPhoneHeartbeatMissedEvent(params.Source, &events.PhoneHeartbeatMissedPayload{
PhoneID: params.PhoneID,
UserID: params.UserID,
MonitorID: params.MonitorID,
LastHeartbeatTimestamp: lastTimestamp,
Timestamp: time.Now().UTC(),
Owner: params.Owner,
})
if err != nil {
msg := fmt.Sprintf("cannot create event when phone monitor [%s] missed heartbeat", params.MonitorID.String())
ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
return
}
if _, err = service.dispatcher.DispatchWithTimeout(ctx, event, heartbeatCheckInterval); err != nil {
msg := fmt.Sprintf("cannot dispatch event [%s] for heartbeat monitor with phone id [%s]", event.Type(), params.PhoneID)
ctxLogger.Error(service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
}
}
func (service *HeartbeatService) handleFailedMonitor(ctx context.Context, lastTimestamp time.Time, params *HeartbeatMonitorParams) error {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
err := service.scheduleHeartbeatCheck(ctx, time.Now().UTC(), params)
if err != nil {
msg := fmt.Sprintf("cannot schedule healthcheck for monitor with owner [%s] and userID [%s]", params.Owner, params.UserID)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
event, err := service.createPhoneHeartbeatOfflineEvent(params.Source, &events.PhoneHeartbeatOfflinePayload{
PhoneID: params.PhoneID,
UserID: params.UserID,
MonitorID: params.MonitorID,
LastHeartbeatTimestamp: lastTimestamp,
Timestamp: time.Now().UTC(),
Owner: params.Owner,
})
if err != nil {
msg := fmt.Sprintf("cannot create event when phone monitor failed")
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
if err = service.dispatcher.Dispatch(ctx, event); err != nil {
msg := fmt.Sprintf("cannot dispatch event [%s] for heartbeat monitor with phone id [%s]", event.Type(), params.PhoneID)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("heartbeat monitor with id [%s] and phone id [%s] failed for user [%s]", params.MonitorID, params.PhoneID, params.UserID))
return nil
}
func (service *HeartbeatService) scheduleHeartbeatCheck(ctx context.Context, lastTimestamp time.Time, params *HeartbeatMonitorParams) error {
ctx, span, ctxLogger := service.tracer.StartWithLogger(ctx, service.logger)
defer span.End()
event, err := service.createPhoneHeartbeatCheckEvent(params.Source, &events.PhoneHeartbeatCheckPayload{
PhoneID: params.PhoneID,
UserID: params.UserID,
MonitorID: params.MonitorID,
ScheduledAt: lastTimestamp.Add(heartbeatCheckInterval),
Owner: params.Owner,
})
if err != nil {
msg := fmt.Sprintf("cannot create event when phone monitor failed")
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
queueID, err := service.dispatcher.DispatchWithTimeout(ctx, event, heartbeatCheckInterval)
if err != nil {
msg := fmt.Sprintf("cannot dispatch event [%s] for heartbeat monitor with phone id [%s]", event.Type(), params.PhoneID)
return service.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg))
}
if err = service.monitorRepository.UpdateQueueID(ctx, params.MonitorID, queueID); err != nil {
msg := fmt.Sprintf("cannot update monitor with id [%s] with queue with ID [%s]", params.MonitorID, queueID)
service.logger.Error(stacktrace.Propagate(err, msg))
}
ctxLogger.Info(fmt.Sprintf("heartbeat check scheduled for monitor with id [%s] and phone id [%s] and queue id [%s] for user [%s]", params.MonitorID, params.PhoneID, queueID, params.UserID))
return nil
}
func (service *HeartbeatService) createPhoneHeartbeatMissedEvent(source string, payload *events.PhoneHeartbeatMissedPayload) (cloudevents.Event, error) {
return service.createEvent(events.PhoneHeartbeatMissed, source, payload)
}
func (service *HeartbeatService) createPhoneHeartbeatOfflineEvent(source string, payload *events.PhoneHeartbeatOfflinePayload) (cloudevents.Event, error) {
return service.createEvent(events.EventTypePhoneHeartbeatOffline, source, payload)
}
func (service *HeartbeatService) createPhoneHeartbeatCheckEvent(source string, payload *events.PhoneHeartbeatCheckPayload) (cloudevents.Event, error) {
return service.createEvent(events.EventTypePhoneHeartbeatCheck, source, payload)
}