forked from NdoleStudio/httpsms
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmessage_handler.go
More file actions
419 lines (361 loc) · 17.4 KB
/
Copy pathmessage_handler.go
File metadata and controls
419 lines (361 loc) · 17.4 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
package handlers
import (
"fmt"
"strings"
"sync"
"time"
"github.com/NdoleStudio/httpsms/pkg/entities"
"github.com/NdoleStudio/httpsms/pkg/repositories"
"github.com/google/uuid"
"github.com/NdoleStudio/httpsms/pkg/requests"
"github.com/NdoleStudio/httpsms/pkg/services"
"github.com/NdoleStudio/httpsms/pkg/telemetry"
"github.com/NdoleStudio/httpsms/pkg/validators"
"github.com/davecgh/go-spew/spew"
"github.com/gofiber/fiber/v2"
"github.com/palantir/stacktrace"
)
// MessageHandler handles message http requests.
type MessageHandler struct {
handler
logger telemetry.Logger
tracer telemetry.Tracer
billingService *services.BillingService
validator *validators.MessageHandlerValidator
service *services.MessageService
}
// NewMessageHandler creates a new MessageHandler
func NewMessageHandler(
logger telemetry.Logger,
tracer telemetry.Tracer,
validator *validators.MessageHandlerValidator,
billingService *services.BillingService,
service *services.MessageService,
) (h *MessageHandler) {
return &MessageHandler{
logger: logger.WithService(fmt.Sprintf("%T", h)),
tracer: tracer,
validator: validator,
billingService: billingService,
service: service,
}
}
// RegisterRoutes registers the routes for the MessageHandler
func (h *MessageHandler) RegisterRoutes(router fiber.Router) {
router.Post("/messages/send", h.PostSend)
router.Post("/messages/bulk-send", h.BulkSend)
router.Post("/messages/receive", h.PostReceive)
router.Get("/messages/outstanding", h.GetOutstanding)
router.Get("/messages", h.Index)
router.Post("/messages/:messageID/events", h.PostEvent)
router.Delete("/messages/:messageID", h.Delete)
}
// PostSend a new entities.Message
// @Summary Send a new SMS message
// @Description Add a new SMS message to be sent by the android phone
// @Security ApiKeyAuth
// @Tags Messages
// @Accept json
// @Produce json
// @Param payload body requests.MessageSend true "PostSend message request payload"
// @Success 200 {object} responses.MessageResponse
// @Failure 400 {object} responses.BadRequest
// @Failure 401 {object} responses.Unauthorized
// @Failure 422 {object} responses.UnprocessableEntity
// @Failure 500 {object} responses.InternalServerError
// @Router /messages/send [post]
func (h *MessageHandler) PostSend(c *fiber.Ctx) error {
ctx, span := h.tracer.StartFromFiberCtx(c)
defer span.End()
ctxLogger := h.tracer.CtxLogger(h.logger, span)
var request requests.MessageSend
if err := c.BodyParser(&request); err != nil {
msg := fmt.Sprintf("cannot marshall [%s] into %T", c.Body(), request)
ctxLogger.Warn(stacktrace.Propagate(err, msg))
return h.responseBadRequest(c, err)
}
if errors := h.validator.ValidateMessageSend(ctx, h.userIDFomContext(c), request.Sanitize()); len(errors) != 0 {
msg := fmt.Sprintf("validation errors [%s], while sending payload [%s]", spew.Sdump(errors), c.Body())
ctxLogger.Warn(stacktrace.NewError(msg))
return h.responseUnprocessableEntity(c, errors, "validation errors while sending message")
}
if msg := h.billingService.IsEntitled(ctx, h.userIDFomContext(c)); msg != nil {
ctxLogger.Warn(stacktrace.NewError(fmt.Sprintf("user with ID [%s] can't send a message", h.userIDFomContext(c))))
return h.responsePaymentRequired(c, *msg)
}
message, err := h.service.SendMessage(ctx, request.ToMessageSendParams(h.userIDFomContext(c), c.OriginalURL()))
if err != nil {
msg := fmt.Sprintf("cannot send message with paylod [%s]", c.Body())
ctxLogger.Error(stacktrace.Propagate(err, msg))
return h.responseInternalServerError(c)
}
return h.responseOK(c, "message added to queue", message)
}
// BulkSend a bulk entities.Message
// @Summary Send bulk SMS messages
// @Description Add bulk SMS messages to be sent by the android phone
// @Security ApiKeyAuth
// @Tags Messages
// @Accept json
// @Produce json
// @Param payload body requests.MessageBulkSend true "Bulk send message request payload"
// @Success 200 {object} []responses.MessagesResponse
// @Failure 400 {object} responses.BadRequest
// @Failure 401 {object} responses.Unauthorized
// @Failure 422 {object} responses.UnprocessableEntity
// @Failure 500 {object} responses.InternalServerError
// @Router /messages/bulk-send [post]
func (h *MessageHandler) BulkSend(c *fiber.Ctx) error {
ctx, span := h.tracer.StartFromFiberCtx(c)
defer span.End()
ctxLogger := h.tracer.CtxLogger(h.logger, span)
var request requests.MessageBulkSend
if err := c.BodyParser(&request); err != nil {
msg := fmt.Sprintf("cannot marshall [%s] into %T", c.Body(), request)
ctxLogger.Warn(stacktrace.Propagate(err, msg))
return h.responseBadRequest(c, err)
}
if errors := h.validator.ValidateMessageBulkSend(ctx, h.userIDFomContext(c), request.Sanitize()); len(errors) != 0 {
msg := fmt.Sprintf("validation errors [%s], while sending payload [%s]", spew.Sdump(errors), c.Body())
ctxLogger.Warn(stacktrace.NewError(msg))
return h.responseUnprocessableEntity(c, errors, "validation errors while sending messages")
}
if msg := h.billingService.IsEntitledWithCount(ctx, h.userIDFomContext(c), uint(len(request.To))); msg != nil {
ctxLogger.Warn(stacktrace.NewError(fmt.Sprintf("user with ID [%s] is not entitled to send [%d] messages", h.userIDFomContext(c), len(request.To))))
return h.responsePaymentRequired(c, *msg)
}
wg := sync.WaitGroup{}
params := request.ToMessageSendParams(h.userIDFomContext(c), c.OriginalURL())
responses := make([]*entities.Message, len(params))
for index, message := range params {
wg.Add(1)
go func(message services.MessageSendParams, index int) {
response, err := h.service.SendMessage(ctx, message)
if err != nil {
msg := fmt.Sprintf("cannot send message with paylod [%s]", c.Body())
ctxLogger.Error(stacktrace.Propagate(err, msg))
}
responses[index] = response
wg.Done()
}(message, index)
}
wg.Wait()
return h.responseOK(c, fmt.Sprintf("[%d] messages processed successfully", len(responses)), responses)
}
// GetOutstanding returns an entities.Message which is still to be sent by the mobile phone
// @Summary Get an outstanding message
// @Description Get an outstanding message to be sent by an android phone
// @Security ApiKeyAuth
// @Tags Messages
// @Accept json
// @Produce json
// @Param message_id query string true "The ID of the message" default(32343a19-da5e-4b1b-a767-3298a73703cb)
// @Success 200 {object} responses.MessageResponse
// @Failure 400 {object} responses.BadRequest
// @Failure 401 {object} responses.Unauthorized
// @Failure 422 {object} responses.UnprocessableEntity
// @Failure 500 {object} responses.InternalServerError
// @Router /messages/outstanding [get]
func (h *MessageHandler) GetOutstanding(c *fiber.Ctx) error {
ctx, span := h.tracer.StartFromFiberCtx(c)
defer span.End()
timestamp := time.Now().UTC()
ctxLogger := h.tracer.CtxLogger(h.logger, span)
var request requests.MessageOutstanding
if err := c.QueryParser(&request); err != nil {
msg := fmt.Sprintf("cannot marshall params [%s] into %T", c.OriginalURL(), request)
ctxLogger.Warn(stacktrace.Propagate(err, msg))
return h.responseBadRequest(c, err)
}
if errors := h.validator.ValidateMessageOutstanding(ctx, request.Sanitize()); len(errors) != 0 {
msg := fmt.Sprintf("validation errors [%s], while fetching outstanding messages [%s]", spew.Sdump(errors), c.OriginalURL())
ctxLogger.Warn(stacktrace.NewError(msg))
return h.responseUnprocessableEntity(c, errors, "validation errors while fetching outstanding messages")
}
message, err := h.service.GetOutstanding(ctx, request.ToGetOutstandingParams(c.Path(), h.userIDFomContext(c), timestamp))
if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
msg := fmt.Sprintf("outstanding message with id [%s] already fetched", request.MessageID)
ctxLogger.Warn(stacktrace.Propagate(err, msg))
return h.responseNotFound(c, "outstanding message already processed")
}
if err != nil {
msg := fmt.Sprintf("cannot get outstanding messgage with ID [%s]", request.MessageID)
ctxLogger.Error(stacktrace.Propagate(err, msg))
return h.responseInternalServerError(c)
}
return h.responseOK(c, "outstanding message fetched successfully", message)
}
// Index returns messages sent between 2 phone numbers
// @Summary Get messages which are sent between 2 phone numbers
// @Description Get list of messages which are sent between 2 phone numbers. It will be sorted by timestamp in descending order.
// @Security ApiKeyAuth
// @Tags Messages
// @Accept json
// @Produce json
// @Param owner query string true "the owner's phone number" default(+18005550199)
// @Param contact query string true "the contact's phone number" default(+18005550100)
// @Param skip query int false "number of messages to skip" minimum(0)
// @Param query query string false "filter messages containing query"
// @Param limit query int false "number of messages to return" minimum(1) maximum(20)
// @Success 200 {object} responses.MessagesResponse
// @Failure 400 {object} responses.BadRequest
// @Failure 401 {object} responses.Unauthorized
// @Failure 422 {object} responses.UnprocessableEntity
// @Failure 500 {object} responses.InternalServerError
// @Router /messages [get]
func (h *MessageHandler) Index(c *fiber.Ctx) error {
ctx, span := h.tracer.StartFromFiberCtx(c)
defer span.End()
ctxLogger := h.tracer.CtxLogger(h.logger, span)
var request requests.MessageIndex
if err := c.QueryParser(&request); err != nil {
msg := fmt.Sprintf("cannot marshall params [%s] into %T", c.OriginalURL(), request)
ctxLogger.Warn(stacktrace.Propagate(err, msg))
return h.responseBadRequest(c, err)
}
if errors := h.validator.ValidateMessageIndex(ctx, request.Sanitize()); len(errors) != 0 {
msg := fmt.Sprintf("validation errors [%s], while fetching messages [%+#v]", spew.Sdump(errors), request)
ctxLogger.Warn(stacktrace.NewError(msg))
return h.responseUnprocessableEntity(c, errors, "validation errors while fetching messages")
}
messages, err := h.service.GetMessages(ctx, request.ToGetParams(h.userIDFomContext(c)))
if err != nil {
msg := fmt.Sprintf("cannot get messgaes with params [%+#v]", request)
ctxLogger.Error(stacktrace.Propagate(err, msg))
return h.responseInternalServerError(c)
}
return h.responseOK(c, fmt.Sprintf("fetched %d %s", len(*messages), h.pluralize("message", len(*messages))), messages)
}
// PostEvent registers an event on a message
// @Summary Upsert an event for a message on the mobile phone
// @Description Use this endpoint to send events for a message when it is failed, sent or delivered by the mobile phone.
// @Security ApiKeyAuth
// @Tags Messages
// @Accept json
// @Produce json
// @Param messageID path string true "ID of the message" default(32343a19-da5e-4b1b-a767-3298a73703ca)
// @Param payload body requests.MessageEvent true "Payload of the event emitted."
// @Success 200 {object} responses.MessageResponse
// @Failure 400 {object} responses.BadRequest
// @Failure 401 {object} responses.Unauthorized
// @Failure 404 {object} responses.NotFound
// @Failure 422 {object} responses.UnprocessableEntity
// @Failure 500 {object} responses.InternalServerError
// @Router /messages/{messageID}/events [post]
func (h *MessageHandler) PostEvent(c *fiber.Ctx) error {
ctx, span := h.tracer.StartFromFiberCtx(c)
defer span.End()
ctxLogger := h.tracer.CtxLogger(h.logger, span)
var request requests.MessageEvent
if err := c.BodyParser(&request); err != nil {
msg := fmt.Sprintf("cannot marshall [%s] into %T", c.Body(), request)
ctxLogger.Warn(stacktrace.Propagate(err, msg))
return h.responseBadRequest(c, err)
}
request.MessageID = c.Params("messageID")
if strings.Contains(request.MessageID, ".") {
return h.responseNoContent(c, "duplicate send event received.")
}
if errors := h.validator.ValidateMessageEvent(ctx, request.Sanitize()); len(errors) != 0 {
msg := fmt.Sprintf("validation errors [%s], while storing event [%s] for message [%s]", spew.Sdump(errors), c.Body(), request.MessageID)
ctxLogger.Warn(stacktrace.NewError(msg))
return h.responseUnprocessableEntity(c, errors, "validation errors while storing event")
}
message, err := h.service.GetMessage(ctx, h.userIDFomContext(c), uuid.MustParse(request.MessageID))
if err != nil && stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
return h.responseNotFound(c, fmt.Sprintf("cannot find message with ID [%s]", request.MessageID))
}
if err != nil {
msg := fmt.Sprintf("cannot find message with id [%s]", request.MessageID)
ctxLogger.Error(h.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
return h.responseInternalServerError(c)
}
message, err = h.service.StoreEvent(ctx, message, request.ToMessageStoreEventParams(c.OriginalURL()))
if err != nil {
msg := fmt.Sprintf("cannot store event for message [%s] with paylod [%s]", request.MessageID, c.Body())
ctxLogger.Error(h.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
return h.responseInternalServerError(c)
}
return h.responseOK(c, "message event stored successfully", message)
}
// PostReceive receives a new entities.Message
// @Summary Receive a new SMS message from a mobile phone
// @Description Add a new message received from a mobile phone
// @Security ApiKeyAuth
// @Tags Messages
// @Accept json
// @Produce json
// @Param payload body requests.MessageReceive true "Received message request payload"
// @Success 200 {object} responses.MessageResponse
// @Failure 400 {object} responses.BadRequest
// @Failure 422 {object} responses.UnprocessableEntity
// @Failure 500 {object} responses.InternalServerError
// @Router /messages/receive [post]
func (h *MessageHandler) PostReceive(c *fiber.Ctx) error {
ctx, span := h.tracer.StartFromFiberCtx(c)
defer span.End()
ctxLogger := h.tracer.CtxLogger(h.logger, span)
var request requests.MessageReceive
if err := c.BodyParser(&request); err != nil {
msg := fmt.Sprintf("cannot marshall [%s] into %T", c.Body(), request)
ctxLogger.Warn(stacktrace.Propagate(err, msg))
return h.responseBadRequest(c, err)
}
if errors := h.validator.ValidateMessageReceive(ctx, request.Sanitize()); len(errors) != 0 {
msg := fmt.Sprintf("validation errors [%s], while sending payload [%s]", spew.Sdump(errors), c.Body())
ctxLogger.Warn(stacktrace.NewError(msg))
return h.responseUnprocessableEntity(c, errors, "validation errors while receiving message")
}
if msg := h.billingService.IsEntitled(ctx, h.userIDFomContext(c)); msg != nil {
ctxLogger.Warn(stacktrace.NewError(fmt.Sprintf("user with ID [%s] can't receive a message becasuse they have exceeded the limit", h.userIDFomContext(c))))
return h.responsePaymentRequired(c, *msg)
}
message, err := h.service.ReceiveMessage(ctx, request.ToMessageReceiveParams(h.userIDFomContext(c), c.OriginalURL()))
if err != nil {
msg := fmt.Sprintf("cannot receive message with paylod [%s]", c.Body())
ctxLogger.Error(stacktrace.Propagate(err, msg))
return h.responseInternalServerError(c)
}
return h.responseOK(c, "message received successfully", message)
}
// Delete a message
// @Summary Delete a message from the database.
// @Description Delete a message from the database and removes the message content from the list of threads.
// @Security ApiKeyAuth
// @Tags Messages
// @Accept json
// @Produce json
// @Param messageID path string true "ID of the message" default(32343a19-da5e-4b1b-a767-3298a73703ca)
// @Success 204 {object} responses.NoContent
// @Failure 400 {object} responses.BadRequest
// @Failure 401 {object} responses.Unauthorized
// @Failure 404 {object} responses.NotFound
// @Failure 422 {object} responses.UnprocessableEntity
// @Failure 500 {object} responses.InternalServerError
// @Router /messages/{messageID} [delete]
func (h *MessageHandler) Delete(c *fiber.Ctx) error {
ctx, span := h.tracer.StartFromFiberCtx(c)
defer span.End()
ctxLogger := h.tracer.CtxLogger(h.logger, span)
messageID := c.Params("messageID")
if errors := h.validator.ValidateUUID(ctx, messageID, "messageID"); len(errors) != 0 {
msg := fmt.Sprintf("validation errors [%s], while deleting a message with ID [%s]", spew.Sdump(errors), messageID)
ctxLogger.Warn(stacktrace.NewError(msg))
return h.responseUnprocessableEntity(c, errors, "validation errors while storing event")
}
message, err := h.service.GetMessage(ctx, h.userIDFomContext(c), uuid.MustParse(messageID))
if stacktrace.GetCode(err) == repositories.ErrCodeNotFound {
return h.responseNotFound(c, fmt.Sprintf("cannot find message with ID [%s]", messageID))
}
if err != nil {
msg := fmt.Sprintf("cannot find message with id [%s]", messageID)
ctxLogger.Error(h.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
return h.responseInternalServerError(c)
}
if err = h.service.DeleteMessage(ctx, c.OriginalURL(), message); err != nil {
msg := fmt.Sprintf("cannot delete message with ID [%s] for user with ID [%s]", messageID, message.UserID)
ctxLogger.Error(h.tracer.WrapErrorSpan(span, stacktrace.Propagate(err, msg)))
return h.responseInternalServerError(c)
}
return h.responseNoContent(c, "message deleted successfully")
}