[messages] minor fixes and documenting

Author: capcom6

internal/sms-gateway/handlers/messages/mobile.go

@@ -38,9 +38,9 @@ type MobileController struct {
 //	@Tags			Device, Messages
 //	@Accept			json
 //	@Produce		json
-//	@Param			order	query		string									false	"Message processing order: lifo (default) or fifo"	Enums(lifo,fifo)
+//	@Param			order	query		string									false	"Message processing order: lifo (default) or fifo"	Enums(lifo,fifo) default(lifo)
 //	@Success		200		{object}	smsgateway.MobileGetMessagesResponse	"List of pending messages"
-//	@Failure		400		{object}	smsgateway.ErrorResponse				"Bad request"
+//	@Failure		400		{object}	smsgateway.ErrorResponse				"Invalid request"
 //	@Failure		500		{object}	smsgateway.ErrorResponse				"Internal server error"
 //	@Router			/mobile/v1/message [get]
 //
@@ -52,7 +52,7 @@ func (h *MobileController) list(device models.Device, c *fiber.Ctx) error {
 		return fiber.NewError(fiber.StatusBadRequest, err.Error())
 	}
 
-	msgs, err := h.messagesSvc.SelectPending(device.ID, messages.MessagesOrder(params.OrderOrDefault()))
+	msgs, err := h.messagesSvc.SelectPending(device.ID, params.OrderOrDefault())
 	if err != nil {
 		return fmt.Errorf("can't get messages: %w", err)
 	}
@@ -82,7 +82,7 @@ func (h *MobileController) list(device models.Device, c *fiber.Ctx) error {
 // Update message state
 func (h *MobileController) patch(device models.Device, c *fiber.Ctx) error {
 	var req smsgateway.MobilePatchMessageRequest
-	if err := c.BodyParser(&req); err != nil {
+	if err := h.BodyParserValidator(c, &req); err != nil {
 		return fiber.NewError(fiber.StatusBadRequest, err.Error())
 	}
 
@@ -96,7 +96,10 @@ func (h *MobileController) patch(device models.Device, c *fiber.Ctx) error {
 
 		err := h.messagesSvc.UpdateState(device.ID, messageState)
 		if err != nil && !errors.Is(err, messages.ErrMessageNotFound) {
-			h.Logger.Error("Can't update message status", zap.Error(err))
+			h.Logger.Error("Can't update message status",
+				zap.String("message_id", v.ID),
+				zap.Error(err),
+			)
 		}
 	}
 

internal/sms-gateway/handlers/messages/params.go

@@ -75,13 +75,13 @@ func (p *thirdPartyGetQueryParams) ToOptions() messages.MessagesSelectOptions {
 }
 
 type mobileGetQueryParams struct {
-	Order string `query:"order" validate:"omitempty,oneof=lifo fifo"`
+	Order messages.MessagesOrder `query:"order" validate:"omitempty,oneof=lifo fifo"`
 }
 
-func (p *mobileGetQueryParams) OrderOrDefault() string {
+func (p *mobileGetQueryParams) OrderOrDefault() messages.MessagesOrder {
 	if p.Order != "" {
 		return p.Order
 	}
-	return "lifo"
+	return messages.MessagesOrderLIFO
 
 }

internal/sms-gateway/modules/messages/repository.go

@@ -13,6 +13,7 @@ import (
 )
 
 const hashingLockName = "36444143-1ace-4dbf-891c-cc505911497e"
+const maxPendingBatch = 100
 
 var ErrMessageNotFound = gorm.ErrRecordNotFound
 var ErrMessageAlreadyExists = errors.New("duplicate id")
@@ -101,7 +102,7 @@ func (r *repository) SelectPending(deviceID string, order MessagesOrder) ([]Mess
 		State:    ProcessingStatePending,
 	}, MessagesSelectOptions{
 		WithRecipients: true,
-		Limit:          100,
+		Limit:          maxPendingBatch,
 		OrderBy:        order,
 	})
 

internal/sms-gateway/modules/messages/repository_filter.go

@@ -2,10 +2,14 @@ package messages
 
 import "time"
 
+// MessagesOrder defines supported ordering for message selection.
+// Valid values: "lifo" (default), "fifo".
 type MessagesOrder string
 
 const (
+	// MessagesOrderLIFO orders messages newest-first within the same priority (default).
 	MessagesOrderLIFO MessagesOrder = "lifo"
+	// MessagesOrderFIFO orders messages oldest-first within the same priority.
 	MessagesOrderFIFO MessagesOrder = "fifo"
 )
 
@@ -23,6 +27,8 @@ type MessagesSelectOptions struct {
 	WithDevice     bool
 	WithStates     bool
 
+	// OrderBy sets the retrieval order for pending messages.
+	// Empty (zero) value defaults to "lifo".
 	OrderBy MessagesOrder
 
 	Limit  int

pkg/swagger/docs/swagger.json

@@ -989,6 +989,7 @@
                             "fifo"
                         ],
                         "type": "string",
+                        "default": "lifo",
                         "description": "Message processing order: lifo (default) or fifo",
                         "name": "order",
                         "in": "query"
@@ -1005,7 +1006,7 @@
                         }
                     },
                     "400": {
-                        "description": "Bad request",
+                        "description": "Invalid request",
                         "schema": {
                             "$ref": "#/definitions/smsgateway.ErrorResponse"
                         }

pkg/swagger/docs/swagger.yaml

@@ -1418,7 +1418,8 @@ paths:
       - application/json
       description: Returns list of pending messages
       parameters:
-      - description: 'Message processing order: lifo (default) or fifo'
+      - default: lifo
+        description: 'Message processing order: lifo (default) or fifo'
         enum:
         - lifo
         - fifo
@@ -1435,7 +1436,7 @@ paths:
               $ref: '#/definitions/smsgateway.MobileMessage'
             type: array
         "400":
-          description: Bad request
+          description: Invalid request
           schema:
             $ref: '#/definitions/smsgateway.ErrorResponse'
         "500":