refactor: api response

Author: alexluong

internal/publishmq/eventhandler.go

@@ -25,21 +25,15 @@ type EventHandler interface {
 }
 
 type HandleResult struct {
-	EventID      string              `json:"id"`
-	MatchedCount int                 `json:"matched_count"`
-	QueuedCount  int                 `json:"queued_count"`
-	Destinations []DestinationStatus `json:"destinations,omitempty"`
-}
-
-type DestinationStatus struct {
-	ID     string                 `json:"id"`
-	Status DestinationMatchStatus `json:"status"`
+	EventID           string                  `json:"id"`
+	MatchedCount      int                     `json:"matched_count"`
+	QueuedCount       int                     `json:"queued_count"`
+	DestinationStatus *DestinationMatchStatus `json:"destination_status,omitempty"`
 }
 
 type DestinationMatchStatus string
 
 const (
-	DestinationStatusQueued        DestinationMatchStatus = "queued"
 	DestinationStatusDisabled      DestinationMatchStatus = "disabled"
 	DestinationStatusNotFound      DestinationMatchStatus = "not_found"
 	DestinationStatusTopicMismatch DestinationMatchStatus = "topic_mismatch"
@@ -95,7 +89,7 @@ func (h *eventHandler) Handle(ctx context.Context, event *models.Event) (*Handle
 		zap.String("destination_id", event.DestinationID))
 
 	var matchedDestinations []models.DestinationSummary
-	var destStatus *DestinationStatus
+	var destStatus *DestinationMatchStatus
 	var err error
 
 	// Branch: specific destination vs topic-based matching
@@ -123,12 +117,12 @@ func (h *eventHandler) Handle(ctx context.Context, event *models.Event) (*Handle
 		QueuedCount:  0,
 	}
 
-	if destStatus != nil {
-		result.Destinations = []DestinationStatus{*destStatus}
-	}
-
 	// Early return if no destinations matched
 	if len(matchedDestinations) == 0 {
+		// Only set destination_status if destination_id was specified and nothing matched
+		if event.DestinationID != "" && destStatus != nil {
+			result.DestinationStatus = destStatus
+		}
 		logger.Info("no matching destinations",
 			zap.String("event_id", event.ID),
 			zap.String("tenant_id", event.TenantID))
@@ -176,51 +170,35 @@ func (h *eventHandler) doPublish(ctx context.Context, event *models.Event, match
 
 // matchSpecificDestination handles the case where a specific destination_id is provided.
 // It retrieves the destination and validates it, returning both the matched destinations
-// and the status for the API response.
-func (h *eventHandler) matchSpecificDestination(ctx context.Context, event *models.Event) ([]models.DestinationSummary, *DestinationStatus, error) {
+// and the status (only set when nothing matched - disabled/not_found/topic_mismatch).
+func (h *eventHandler) matchSpecificDestination(ctx context.Context, event *models.Event) ([]models.DestinationSummary, *DestinationMatchStatus, error) {
 	destination, err := h.entityStore.RetrieveDestination(ctx, event.TenantID, event.DestinationID)
 	if err != nil {
 		h.logger.Ctx(ctx).Warn("failed to retrieve destination",
 			zap.Error(err),
 			zap.String("destination_id", event.DestinationID))
-		status := DestinationStatus{
-			ID:     event.DestinationID,
-			Status: DestinationStatusNotFound,
-		}
+		status := DestinationStatusNotFound
 		return []models.DestinationSummary{}, &status, nil
 	}
 
 	if destination == nil {
-		status := DestinationStatus{
-			ID:     event.DestinationID,
-			Status: DestinationStatusNotFound,
-		}
+		status := DestinationStatusNotFound
 		return []models.DestinationSummary{}, &status, nil
 	}
 
 	if destination.DisabledAt != nil {
-		status := DestinationStatus{
-			ID:     event.DestinationID,
-			Status: DestinationStatusDisabled,
-		}
+		status := DestinationStatusDisabled
 		return []models.DestinationSummary{}, &status, nil
 	}
 
 	// Check topic match
 	if event.Topic != "" && event.Topic != "*" && destination.Topics[0] != "*" && !slices.Contains(destination.Topics, event.Topic) {
-		status := DestinationStatus{
-			ID:     event.DestinationID,
-			Status: DestinationStatusTopicMismatch,
-		}
+		status := DestinationStatusTopicMismatch
 		return []models.DestinationSummary{}, &status, nil
 	}
 
-	// Matched!
-	status := DestinationStatus{
-		ID:     event.DestinationID,
-		Status: DestinationStatusQueued,
-	}
-	return []models.DestinationSummary{*destination.ToSummary()}, &status, nil
+	// Matched! Return nil status since it will be queued
+	return []models.DestinationSummary{*destination.ToSummary()}, nil, nil
 }
 
 func (h *eventHandler) enqueueDeliveryEvent(ctx context.Context, deliveryEvent models.DeliveryEvent) error {

internal/publishmq/eventhandler_test.go

@@ -259,7 +259,7 @@ func TestEventHandler_HandleResult(t *testing.T) {
 		require.Equal(t, event.ID, result.EventID)
 		require.Equal(t, 3, result.MatchedCount)
 		require.Equal(t, 3, result.QueuedCount)
-		require.Nil(t, result.Destinations)
+		require.Nil(t, result.DestinationStatus)
 	})
 
 	t.Run("no destinations matched", func(t *testing.T) {
@@ -274,7 +274,7 @@ func TestEventHandler_HandleResult(t *testing.T) {
 		require.Equal(t, event.ID, result.EventID)
 		require.Equal(t, 0, result.MatchedCount)
 		require.Equal(t, 0, result.QueuedCount)
-		require.Nil(t, result.Destinations)
+		require.Nil(t, result.DestinationStatus)
 	})
 
 	t.Run("duplicate event - idempotency", func(t *testing.T) {
@@ -320,9 +320,7 @@ func TestEventHandler_HandleResult(t *testing.T) {
 		require.NoError(t, err)
 		require.Equal(t, 1, result.MatchedCount)
 		require.Equal(t, 1, result.QueuedCount)
-		require.Len(t, result.Destinations, 1)
-		require.Equal(t, dest.ID, result.Destinations[0].ID)
-		require.Equal(t, publishmq.DestinationStatusQueued, result.Destinations[0].Status)
+		require.Nil(t, result.DestinationStatus, "no status when successfully queued")
 	})
 
 	t.Run("with destination_id - disabled", func(t *testing.T) {
@@ -344,9 +342,8 @@ func TestEventHandler_HandleResult(t *testing.T) {
 		require.NoError(t, err)
 		require.Equal(t, 0, result.MatchedCount)
 		require.Equal(t, 0, result.QueuedCount)
-		require.Len(t, result.Destinations, 1)
-		require.Equal(t, dest.ID, result.Destinations[0].ID)
-		require.Equal(t, publishmq.DestinationStatusDisabled, result.Destinations[0].Status)
+		require.NotNil(t, result.DestinationStatus, "status provided when not queued")
+		require.Equal(t, publishmq.DestinationStatusDisabled, *result.DestinationStatus)
 	})
 
 	t.Run("with destination_id - not found", func(t *testing.T) {
@@ -360,9 +357,8 @@ func TestEventHandler_HandleResult(t *testing.T) {
 		require.NoError(t, err)
 		require.Equal(t, 0, result.MatchedCount)
 		require.Equal(t, 0, result.QueuedCount)
-		require.Len(t, result.Destinations, 1)
-		require.Equal(t, "dest_not_found", result.Destinations[0].ID)
-		require.Equal(t, publishmq.DestinationStatusNotFound, result.Destinations[0].Status)
+		require.NotNil(t, result.DestinationStatus, "status provided when not queued")
+		require.Equal(t, publishmq.DestinationStatusNotFound, *result.DestinationStatus)
 	})
 
 	t.Run("with destination_id - topic mismatch", func(t *testing.T) {
@@ -382,8 +378,7 @@ func TestEventHandler_HandleResult(t *testing.T) {
 		require.NoError(t, err)
 		require.Equal(t, 0, result.MatchedCount)
 		require.Equal(t, 0, result.QueuedCount)
-		require.Len(t, result.Destinations, 1)
-		require.Equal(t, dest.ID, result.Destinations[0].ID)
-		require.Equal(t, publishmq.DestinationStatusTopicMismatch, result.Destinations[0].Status)
+		require.NotNil(t, result.DestinationStatus, "status provided when not queued")
+		require.Equal(t, publishmq.DestinationStatusTopicMismatch, *result.DestinationStatus)
 	})
 }