fix: restore fetch message output format

It must match Acrobits specs

Author: gsanchietti

api/routes.go

@@ -69,7 +69,7 @@ func (h handler) fetchMessages(c echo.Context) error {
 		return mapServiceError(err)
 	}
 
-	logger.Info().Str("endpoint", "fetch_messages").Str("username", req.Username).Int("received", len(resp.ReceivedMessages)).Int("sent", len(resp.SentMessages)).Msg("messages fetched successfully")
+	logger.Info().Str("endpoint", "fetch_messages").Str("username", req.Username).Int("received", len(resp.ReceivedSMSs)).Int("sent", len(resp.SentSMSs)).Msg("messages fetched successfully")
 	return c.JSON(http.StatusOK, resp)
 }
 

docs/openapi.yaml

@@ -268,46 +268,56 @@ paths:
 
 components:
   schemas:
-    Message:
+    SMS:
       type: object
+      description: A message following the Acrobits Modern API format.
       properties:
-        id:
+        sms_id:
           type: string
           description: Unique identifier (Matrix Event ID).
         sending_date:
           type: string
           format: date-time
-          description: RFC 3339 timestamp.
+          description: RFC 3339 timestamp when the message was sent.
         sender:
           type: string
-          description: Sender address/ID.
+          description: Sender identifier (phone number or user name). Only present in received messages.
         recipient:
           type: string
-          description: Recipient address/ID (Room ID).
-        text:
+          description: Recipient identifier (phone number or user name). Only present in sent messages.
+        sms_text:
           type: string
-          description: Message body.
+          description: Message body (UTF-8 encoded).
         content_type:
           type: string
-          description: MIME type.
+          description: MIME content-type. Defaults to text/plain if omitted.
+        disposition_notification:
+          type: string
+          description: Opaque string from Send Message request. Can be omitted if empty.
+        displayed:
+          type: boolean
+          description: True if message has already been displayed on another device. Only in received messages.
         stream_id:
           type: string
-          description: Identifier for the conversation stream (Room ID).
+          description: Identifier for the conversation stream (Room ID or identifier).
     FetchMessagesResponse:
       type: object
+      description: Response from the fetch_messages endpoint following Acrobits Modern API specification.
       properties:
         date:
           type: string
           format: date-time
-          description: Current server time in RFC 3339.
-        received_messages:
+          description: Current server time in RFC 3339 format (used to synchronize timestamps).
+        received_smss:
           type: array
           items:
-            $ref: '#/components/schemas/Message'
-        sent_messages:
+            $ref: '#/components/schemas/SMS'
+          description: Array of received messages. Sorted by sending_date in ascending order (oldest first).
+        sent_smss:
           type: array
           items:
-            $ref: '#/components/schemas/Message'
+            $ref: '#/components/schemas/SMS'
+          description: Array of sent messages. Sorted by sending_date in ascending order (oldest first).
     MappingRequest:
       type: object
       required:
@@ -316,7 +326,7 @@ components:
       properties:
         number:
           type: string
-          description:  number or bridged identifier to map.
+          description: Phone number or bridged identifier to map.
         matrix_id:
           type: string
           description: Optional Matrix user to use when auto-creating DMs.

main_test.go

@@ -407,8 +407,8 @@ func TestIntegration_SendAndFetchMessages(t *testing.T) {
 		}
 
 		found := false
-		for _, msg := range fetchResp.ReceivedMessages {
-			if strings.Contains(msg.Text, "Hello from integration test") && msg.Sender == user1MatrixID {
+		for _, msg := range fetchResp.ReceivedSMSs {
+			if strings.Contains(msg.SMSText, "Hello from integration test") && msg.Sender == user1MatrixID {
 				found = true
 				t.Logf("Found test message from %s", msg.Sender)
 				break
@@ -703,10 +703,10 @@ func TestIntegration_SendMessageWithPhoneNumberMapping(t *testing.T) {
 		}
 
 		foundPhoneMessage := false
-		for _, msg := range fetchResp.ReceivedMessages {
-			if strings.Contains(msg.Text, "Message from phone number") && msg.Sender == user1MatrixID {
+		for _, msg := range fetchResp.ReceivedSMSs {
+			if strings.Contains(msg.SMSText, "Message from phone number") && msg.Sender == user1MatrixID {
 				foundPhoneMessage = true
-				t.Logf("User2 received message from phone-mapped user: sender=%s, text=%s", msg.Sender, msg.Text)
+				t.Logf("User2 received message from phone-mapped user: sender=%s, text=%s", msg.Sender, msg.SMSText)
 				break
 			}
 		}
@@ -823,10 +823,10 @@ func TestIntegration_RoomMessaging(t *testing.T) {
 
 		// Check that user1 sees the message from user2
 		foundUser2Message := false
-		for _, msg := range fetchResp1.ReceivedMessages {
-			if strings.Contains(msg.Text, "Hello from user2") && msg.Sender == user2MatrixID {
+		for _, msg := range fetchResp1.ReceivedSMSs {
+			if strings.Contains(msg.SMSText, "Hello from user2") && msg.Sender == user2MatrixID {
 				foundUser2Message = true
-				t.Logf("User1 received message from user2: %s", msg.Text)
+				t.Logf("User1 received message from user2: %s", msg.SMSText)
 				break
 			}
 		}
@@ -842,10 +842,10 @@ func TestIntegration_RoomMessaging(t *testing.T) {
 
 		// Check that user2 sees the message from user1
 		foundUser1Message := false
-		for _, msg := range fetchResp2.ReceivedMessages {
-			if strings.Contains(msg.Text, "Hello from user1") && msg.Sender == user1MatrixID {
+		for _, msg := range fetchResp2.ReceivedSMSs {
+			if strings.Contains(msg.SMSText, "Hello from user1") && msg.Sender == user1MatrixID {
 				foundUser1Message = true
-				t.Logf("User2 received message from user1: %s", msg.Text)
+				t.Logf("User2 received message from user1: %s", msg.SMSText)
 				break
 			}
 		}
@@ -855,10 +855,10 @@ func TestIntegration_RoomMessaging(t *testing.T) {
 
 		// Check that user2 also sees their own message in sent messages
 		foundOwnMessage := false
-		for _, msg := range fetchResp2.SentMessages {
-			if strings.Contains(msg.Text, "Hello from user2") && msg.Sender == user2MatrixID {
+		for _, msg := range fetchResp2.SentSMSs {
+			if strings.Contains(msg.SMSText, "Hello from user2") && msg.Recipient == user2MatrixID {
 				foundOwnMessage = true
-				t.Logf("User2 sees their own sent message: %s", msg.Text)
+				t.Logf("User2 sees their own sent message: %s", msg.SMSText)
 				break
 			}
 		}

models/messages.go

@@ -24,22 +24,35 @@ type FetchMessagesRequest struct {
 	Device     string `json:"device"`
 }
 
-// FetchMessagesResponse is the payload returned from the fetch_messages endpoint.
+// FetchMessagesResponse matches Acrobits Modern API specification.
 type FetchMessagesResponse struct {
-	Date             string    `json:"date"`
-	ReceivedMessages []Message `json:"received_messages"`
-	SentMessages     []Message `json:"sent_messages"`
+	Date         string `json:"date"`
+	ReceivedSMSs []SMS  `json:"received_smss"`
+	SentSMSs     []SMS  `json:"sent_smss"`
 }
 
-// Message represents the shared schema used in both fetch and send responses.
+// SMS represents a message in the Acrobits Modern API format.
+type SMS struct {
+	SMSID                   string `json:"sms_id"`
+	SendingDate             string `json:"sending_date"`
+	Sender                  string `json:"sender,omitempty"`
+	Recipient               string `json:"recipient,omitempty"`
+	SMSText                 string `json:"sms_text"`
+	ContentType             string `json:"content_type,omitempty"`
+	DispositionNotification string `json:"disposition_notification,omitempty"`
+	Displayed               bool   `json:"displayed,omitempty"`
+	StreamID                string `json:"stream_id"`
+}
+
+// Message is a helper struct for internal use.
 type Message struct {
-	ID          string `json:"message_id"`
-	SendingDate string `json:"sending_date"`
-	Sender      string `json:"sender"`
-	Recipient   string `json:"recipient"`
-	Text        string `json:"message_text"`
-	ContentType string `json:"content_type"`
-	StreamID    string `json:"stream_id"`
+	ID          string
+	SendingDate string
+	Sender      string
+	Recipient   string
+	Text        string
+	ContentType string
+	StreamID    string
 }
 
 // PushTokenReportRequest mirrors the Acrobits push token reporter POST JSON schema.

models/models_test.go

@@ -110,16 +110,16 @@ func TestSendMessageResponse_Marshal(t *testing.T) {
 func TestFetchMessagesResponse_Marshal(t *testing.T) {
 	resp := FetchMessagesResponse{
 		Date: "2025-01-01T00:00:00Z",
-		ReceivedMessages: []Message{
+		ReceivedSMSs: []SMS{
 			{
-				ID:   "$event1",
-				Text: "Received message",
+				SMSID:   "$event1",
+				SMSText: "Received message",
 			},
 		},
-		SentMessages: []Message{
+		SentSMSs: []SMS{
 			{
-				ID:   "$event2",
-				Text: "Sent message",
+				SMSID:   "$event2",
+				SMSText: "Sent message",
 			},
 		},
 	}
@@ -131,8 +131,8 @@ func TestFetchMessagesResponse_Marshal(t *testing.T) {
 	err = json.Unmarshal(data, &resp2)
 	assert.NoError(t, err)
 	assert.Equal(t, resp.Date, resp2.Date)
-	assert.Len(t, resp2.ReceivedMessages, 1)
-	assert.Len(t, resp2.SentMessages, 1)
+	assert.Len(t, resp2.ReceivedSMSs, 1)
+	assert.Len(t, resp2.SentSMSs, 1)
 }
 
 func TestMappingResponse_Marshal(t *testing.T) {

service/messages.go

@@ -158,7 +158,7 @@ func (s *MessageService) FetchMessages(ctx context.Context, req *models.FetchMes
 		return nil, fmt.Errorf("sync messages: %w", mapAuthErr(err))
 	}
 
-	received, sent := make([]models.Message, 0, 8), make([]models.Message, 0, 8)
+	received, sent := make([]models.SMS, 0, 8), make([]models.SMS, 0, 8)
 
 	// Resolve the caller's identifier (e.g. "91201")
 	callerIdentifier := s.resolveMatrixIDToIdentifier(string(userID))
@@ -204,20 +204,31 @@ func (s *MessageService) FetchMessages(ctx context.Context, req *models.FetchMes
 				msg.Recipient = callerIdentifier
 			}
 
+			// Convert internal Message to SMS
+			sms := models.SMS{
+				SMSID:       msg.ID,
+				SendingDate: msg.SendingDate,
+				SMSText:     msg.Text,
+				ContentType: msg.ContentType,
+				StreamID:    msg.StreamID,
+			}
+
 			if isSent {
-				sent = append(sent, msg)
+				sms.Recipient = msg.Recipient
+				sent = append(sent, sms)
 			} else {
-				received = append(received, msg)
+				sms.Sender = msg.Sender
+				received = append(received, sms)
 			}
 		}
 	}
 
 	logger.Debug().Str("user_id", string(userID)).Int("received_count", len(received)).Int("sent_count", len(sent)).Msg("processed sync messages")
 
 	return &models.FetchMessagesResponse{
-		Date:             s.now().UTC().Format(time.RFC3339),
-		ReceivedMessages: received,
-		SentMessages:     sent,
+		Date:         s.now().UTC().Format(time.RFC3339),
+		ReceivedSMSs: received,
+		SentSMSs:     sent,
 	}, nil
 }