Add an optional request_id parameter when sending messages. Closes #242

AchoArnold · AchoArnold · commit 564a3f5ae835 · 2023-07-17T20:49:40.000+03:00
diff --git a/api/pkg/entities/message.go b/api/pkg/entities/message.go
@@ -77,13 +77,14 @@ func (s SIM) String() string {
 
 // Message represents a message sent between 2 phone numbers
 type Message struct {
-	ID      uuid.UUID     `json:"id" gorm:"primaryKey;type:uuid;" example:"32343a19-da5e-4b1b-a767-3298a73703cb"`
-	Owner   string        `json:"owner" gorm:"index:idx_messages_user_id__owner__contact" example:"+18005550199"`
-	UserID  UserID        `json:"user_id" gorm:"index:idx_messages__user_id" example:"WB7DRDWrJZRGbYrv2CKGkqbzvqdC"`
-	Contact string        `json:"contact" gorm:"index:idx_messages_user_id__owner__contact" example:"+18005550100"`
-	Content string        `json:"content" example:"This is a sample text message"`
-	Type    MessageType   `json:"type" example:"mobile-terminated"`
-	Status  MessageStatus `json:"status" gorm:"index:idx_messages_status" example:"pending"`
+	ID        uuid.UUID     `json:"id" gorm:"primaryKey;type:uuid;" example:"32343a19-da5e-4b1b-a767-3298a73703cb"`
+	RequestID *string       `json:"request_id" example:"153554b5-ae44-44a0-8f4f-7bbac5657ad4"`
+	Owner     string        `json:"owner" gorm:"index:idx_messages_user_id__owner__contact" example:"+18005550199"`
+	UserID    UserID        `json:"user_id" gorm:"index:idx_messages__user_id" example:"WB7DRDWrJZRGbYrv2CKGkqbzvqdC"`
+	Contact   string        `json:"contact" gorm:"index:idx_messages_user_id__owner__contact" example:"+18005550100"`
+	Content   string        `json:"content" example:"This is a sample text message"`
+	Type      MessageType   `json:"type" example:"mobile-terminated"`
+	Status    MessageStatus `json:"status" gorm:"index:idx_messages_status" example:"pending"`
 	// SIM is the SIM card to use to send the message
 	// * SMS1: use the SIM card in slot 1
 	// * SMS2: use the SIM card in slot 2
diff --git a/api/pkg/events/message_api_sent_event.go b/api/pkg/events/message_api_sent_event.go
@@ -16,6 +16,7 @@ type MessageAPISentPayload struct {
 	MessageID         uuid.UUID       `json:"message_id"`
 	UserID            entities.UserID `json:"user_id"`
 	Owner             string          `json:"owner"`
+	RequestID         *string         `json:"request_id"`
 	MaxSendAttempts   uint            `json:"max_send_attempts"`
 	Contact           string          `json:"contact"`
 	RequestReceivedAt time.Time       `json:"request_received_at"`
diff --git a/api/pkg/events/message_phone_delivered_event.go b/api/pkg/events/message_phone_delivered_event.go
@@ -16,6 +16,7 @@ type MessagePhoneDeliveredPayload struct {
 	ID        uuid.UUID       `json:"id"`
 	Owner     string          `json:"owner"`
 	Contact   string          `json:"contact"`
+	RequestID *string         `json:"request_id"`
 	UserID    entities.UserID `json:"user_id"`
 	Timestamp time.Time       `json:"timestamp"`
 	Content   string          `json:"content"`
diff --git a/api/pkg/events/message_phone_sending_event.go b/api/pkg/events/message_phone_sending_event.go
@@ -14,6 +14,7 @@ const EventTypeMessagePhoneSending = "message.phone.sending"
 type MessagePhoneSendingPayload struct {
 	ID        uuid.UUID       `json:"id"`
 	UserID    entities.UserID `json:"user_id"`
+	RequestID *string         `json:"request_id"`
 	Timestamp time.Time       `json:"timestamp"`
 	Owner     string          `json:"owner"`
 	Contact   string          `json:"contact"`
diff --git a/api/pkg/events/message_phone_sent_event.go b/api/pkg/events/message_phone_sent_event.go
@@ -15,6 +15,7 @@ const EventTypeMessagePhoneSent = "message.phone.sent"
 type MessagePhoneSentPayload struct {
 	ID        uuid.UUID       `json:"id"`
 	UserID    entities.UserID `json:"user_id"`
+	RequestID *string         `json:"request_id"`
 	Owner     string          `json:"owner"`
 	Contact   string          `json:"contact"`
 	Timestamp time.Time       `json:"timestamp"`
diff --git a/api/pkg/events/message_send_expired_event.go b/api/pkg/events/message_send_expired_event.go
@@ -15,6 +15,7 @@ const EventTypeMessageSendExpired = "message.send.expired"
 type MessageSendExpiredPayload struct {
 	MessageID uuid.UUID       `json:"message_id"`
 	Owner     string          `json:"owner"`
+	RequestID *string         `json:"request_id"`
 	Contact   string          `json:"contact"`
 	UserID    entities.UserID `json:"user_id"`
 	Timestamp time.Time       `json:"timestamp"`
diff --git a/api/pkg/events/message_send_failed_event.go b/api/pkg/events/message_send_failed_event.go
@@ -16,6 +16,7 @@ type MessageSendFailedPayload struct {
 	ErrorMessage string          `json:"error_message"`
 	UserID       entities.UserID `json:"user_id"`
 	Owner        string          `json:"owner"`
+	RequestID    *string         `json:"request_id"`
 	Contact      string          `json:"contact"`
 	Timestamp    time.Time       `json:"timestamp"`
 	Content      string          `json:"content"`
diff --git a/api/pkg/requests/message_bulk_send_request.go b/api/pkg/requests/message_bulk_send_request.go
@@ -13,9 +13,10 @@ import (
 // MessageBulkSend is the payload for sending bulk SMS messages
 type MessageBulkSend struct {
 	request
-	From    string   `json:"from" example:"+18005550199"`
-	To      []string `json:"to" example:"+18005550100,+18005550100"`
-	Content string   `json:"content" example:"This is a sample text message"`
+	From      string   `json:"from" example:"+18005550199"`
+	To        []string `json:"to" example:"+18005550100,+18005550100"`
+	RequestID string   `json:"request_id" example:"153554b5-ae44-44a0-8f4f-7bbac5657ad4" validate:"optional"`
+	Content   string   `json:"content" example:"This is a sample text message"`
 }
 
 // Sanitize sets defaults to MessageReceive
@@ -37,6 +38,7 @@ func (input *MessageBulkSend) ToMessageSendParams(userID entities.UserID, source
 		result = append(result, services.MessageSendParams{
 			Source:            source,
 			Owner:             *from,
+			RequestID:         input.sanitizeStringPointer(input.RequestID),
 			UserID:            userID,
 			RequestReceivedAt: time.Now().UTC(),
 			Contact:           to,
diff --git a/api/pkg/requests/message_send_request.go b/api/pkg/requests/message_send_request.go
@@ -1,6 +1,7 @@
 package requests
 
 import (
+	"strings"
 	"time"
 
 	"github.com/NdoleStudio/httpsms/pkg/entities"
@@ -13,14 +14,16 @@ import (
 // MessageSend is the payload for sending and SMS message
 type MessageSend struct {
 	request
-	From    string `json:"from" example:"+18005550199"`
-	To      string `json:"to" example:"+18005550100"`
-	Content string `json:"content" example:"This is a sample text message"`
+	From      string `json:"from" example:"+18005550199"`
+	To        string `json:"to" example:"+18005550100"`
+	RequestID string `json:"request_id" example:"153554b5-ae44-44a0-8f4f-7bbac5657ad4" validate:"optional"`
+	Content   string `json:"content" example:"This is a sample text message"`
 }
 
 // Sanitize sets defaults to MessageReceive
 func (input *MessageSend) Sanitize() MessageSend {
 	input.To = input.sanitizeAddress(input.To)
+	input.RequestID = strings.TrimSpace(input.RequestID)
 	input.From = input.sanitizeAddress(input.From)
 	return *input
 }
@@ -31,6 +34,7 @@ func (input *MessageSend) ToMessageSendParams(userID entities.UserID, source str
 	return services.MessageSendParams{
 		Source:            source,
 		Owner:             *from,
+		RequestID:         input.sanitizeStringPointer(input.RequestID),
 		UserID:            userID,
 		RequestReceivedAt: time.Now().UTC(),
 		Contact:           input.sanitizeAddress(input.To),
diff --git a/api/pkg/requests/request.go b/api/pkg/requests/request.go
@@ -28,7 +28,7 @@ func (input *request) sanitizeAddress(value string) string {
 	return value
 }
 
-// getLimit gets the take as a string
+// sanitizeBool sanitizes a boolean string
 func (input *request) sanitizeBool(value string) string {
 	value = strings.TrimSpace(value)
 	if value == "1" || strings.ToLower(value) == "true" {
@@ -42,6 +42,14 @@ func (input *request) sanitizeBool(value string) string {
 	return value
 }
 
+func (input *request) sanitizeStringPointer(value string) *string {
+	value = strings.TrimSpace(value)
+	if value == "" {
+		return nil
+	}
+	return &value
+}
+
 func (input *request) removeStringDuplicates(values []string) []string {
 	cache := map[string]struct{}{}
 	for _, value := range values {
diff --git a/api/pkg/services/message_service.go b/api/pkg/services/message_service.go
@@ -221,6 +221,7 @@ func (service *MessageService) handleMessageSentEvent(ctx context.Context, param
 		ID:        message.ID,
 		Owner:     message.Owner,
 		UserID:    message.UserID,
+		RequestID: message.RequestID,
 		Timestamp: params.Timestamp,
 		Contact:   message.Contact,
 		Content:   message.Content,
@@ -246,6 +247,7 @@ func (service *MessageService) handleMessageDeliveredEvent(ctx context.Context,
 		ID:        message.ID,
 		Owner:     message.Owner,
 		UserID:    message.UserID,
+		RequestID: message.RequestID,
 		Timestamp: params.Timestamp,
 		Contact:   message.Contact,
 		Content:   message.Content,
@@ -278,6 +280,7 @@ func (service *MessageService) handleMessageFailedEvent(ctx context.Context, par
 		ErrorMessage: errorMessage,
 		Timestamp:    params.Timestamp,
 		Contact:      message.Contact,
+		RequestID:    message.RequestID,
 		UserID:       message.UserID,
 		Content:      message.Content,
 		SIM:          message.SIM,
@@ -300,6 +303,7 @@ type MessageSendParams struct {
 	Contact           string
 	Content           string
 	Source            string
+	RequestID         *string
 	UserID            entities.UserID
 	RequestReceivedAt time.Time
 }
@@ -317,6 +321,7 @@ func (service *MessageService) SendMessage(ctx context.Context, params MessageSe
 		MessageID:         uuid.New(),
 		UserID:            params.UserID,
 		MaxSendAttempts:   sendAttempts,
+		RequestID:         params.RequestID,
 		Owner:             phonenumbers.Format(&params.Owner, phonenumbers.E164),
 		Contact:           params.Contact,
 		RequestReceivedAt: params.RequestReceivedAt,
@@ -666,6 +671,7 @@ func (service *MessageService) CheckExpired(ctx context.Context, params MessageC
 		MessageID: message.ID,
 		Owner:     message.Owner,
 		Contact:   message.Contact,
+		RequestID: message.RequestID,
 		UserID:    message.UserID,
 		Timestamp: time.Now().UTC(),
 		Content:   message.Content,
@@ -714,6 +720,7 @@ func (service *MessageService) storeSentMessage(ctx context.Context, payload eve
 		Contact:           payload.Contact,
 		UserID:            payload.UserID,
 		Content:           payload.Content,
+		RequestID:         payload.RequestID,
 		SIM:               payload.SIM,
 		Type:              entities.MessageTypeMobileTerminated,
 		Status:            entities.MessageStatusPending,
diff --git a/api/pkg/validators/message_handler_validator.go b/api/pkg/validators/message_handler_validator.go
@@ -82,6 +82,9 @@ func (validator MessageHandlerValidator) ValidateMessageSend(ctx context.Context
 				"required",
 				contactPhoneNumberRule,
 			},
+			"request_id": []string{
+				"max:255",
+			},
 			"from": []string{
 				"required",
 				phoneNumberRule,
