Merge pull request #409 from hookdeck/chore/event-payload-alert

chore: Include event data & metadata in alert payload

Author: leggetter

internal/alert/monitor.go

@@ -75,11 +75,11 @@ func WithLogger(logger *logging.Logger) AlertOption {
 
 // DeliveryAttempt represents a single delivery attempt
 type DeliveryAttempt struct {
-	Success       bool
-	DeliveryEvent *models.DeliveryEvent
-	Destination   *AlertDestination
-	Timestamp     time.Time
-	Data          map[string]interface{}
+	Success          bool
+	DeliveryEvent    *models.DeliveryEvent
+	Destination      *AlertDestination
+	Timestamp        time.Time
+	DeliveryResponse map[string]interface{}
 }
 
 type alertMonitor struct {
@@ -147,11 +147,17 @@ func (m *alertMonitor) HandleAttempt(ctx context.Context, attempt DeliveryAttemp
 	}
 
 	alert := NewConsecutiveFailureAlert(ConsecutiveFailureData{
+		Event: AlertedEvent{
+			ID:       attempt.DeliveryEvent.Event.ID,
+			Topic:    attempt.DeliveryEvent.Event.Topic,
+			Metadata: attempt.DeliveryEvent.Event.Metadata,
+			Data:     attempt.DeliveryEvent.Event.Data,
+		},
 		MaxConsecutiveFailures: m.autoDisableFailureCount,
 		ConsecutiveFailures:    count,
 		WillDisable:            m.disabler != nil && level == 100,
 		Destination:            attempt.Destination,
-		Data:                   attempt.Data,
+		DeliveryResponse:       attempt.DeliveryResponse,
 	})
 
 	// If we've hit 100% and have a disabler configured, disable the destination

internal/alert/monitor_test.go

@@ -58,7 +58,7 @@ func TestAlertMonitor_ConsecutiveFailures_MaxFailures(t *testing.T) {
 		Success:       false,
 		DeliveryEvent: deliveryEvent,
 		Destination:   dest,
-		Data: map[string]interface{}{
+		DeliveryResponse: map[string]interface{}{
 			"status": "500",
 			"data":   map[string]any{"error": "test error"},
 		},
@@ -79,8 +79,8 @@ func TestAlertMonitor_ConsecutiveFailures_MaxFailures(t *testing.T) {
 			failures := alert.Data.ConsecutiveFailures
 			require.Contains(t, []int{10, 14, 18, 20}, failures, "Alert should be sent at 50%, 66%, 90%, and 100% thresholds")
 			require.Equal(t, dest, alert.Data.Destination)
-			require.Equal(t, "alert.consecutive-failure", alert.Topic)
-			require.Equal(t, attempt.Data, alert.Data.Data)
+			require.Equal(t, "alert.consecutive_failure", alert.Topic)
+			require.Equal(t, attempt.DeliveryResponse, alert.Data.DeliveryResponse)
 			require.Equal(t, 20, alert.Data.MaxConsecutiveFailures)
 			require.Equal(t, failures == 20, alert.Data.WillDisable, "WillDisable should only be true at 100% (20 failures)")
 		}
@@ -125,7 +125,7 @@ func TestAlertMonitor_ConsecutiveFailures_Reset(t *testing.T) {
 		Success:       false,
 		DeliveryEvent: deliveryEvent,
 		Destination:   dest,
-		Data: map[string]interface{}{
+		DeliveryResponse: map[string]interface{}{
 			"status": "500",
 			"data":   map[string]any{"error": "test error"},
 		},

internal/alert/notifier.go

@@ -42,6 +42,13 @@ func NotifierWithBearerToken(token string) NotifierOption {
 	}
 }
 
+type AlertedEvent struct {
+	ID       string                 `json:"id"`
+	Topic    string                 `json:"topic"`    // event topic
+	Metadata map[string]string      `json:"metadata"` // event metadata
+	Data     map[string]interface{} `json:"data"`     // event payload
+}
+
 type AlertDestination struct {
 	ID         string        `json:"id" redis:"id"`
 	TenantID   string        `json:"tenant_id" redis:"-"`
@@ -54,11 +61,12 @@ type AlertDestination struct {
 
 // ConsecutiveFailureData represents the data needed for a consecutive failure alert
 type ConsecutiveFailureData struct {
+	Event                  AlertedEvent           `json:"event"`
 	MaxConsecutiveFailures int                    `json:"max_consecutive_failures"`
 	ConsecutiveFailures    int                    `json:"consecutive_failures"`
 	WillDisable            bool                   `json:"will_disable"`
 	Destination            *AlertDestination      `json:"destination"`
-	Data                   map[string]interface{} `json:"data"`
+	DeliveryResponse       map[string]interface{} `json:"delivery_response"`
 }
 
 // ConsecutiveFailureAlert represents an alert for consecutive failures
@@ -77,7 +85,7 @@ func (a ConsecutiveFailureAlert) MarshalJSON() ([]byte, error) {
 // NewConsecutiveFailureAlert creates a new consecutive failure alert with defaults
 func NewConsecutiveFailureAlert(data ConsecutiveFailureData) ConsecutiveFailureAlert {
 	return ConsecutiveFailureAlert{
-		Topic:     "alert.consecutive-failure",
+		Topic:     "alert.consecutive_failure",
 		Timestamp: time.Now(),
 		Data:      data,
 	}

internal/alert/notifier_test.go

@@ -34,7 +34,7 @@ func TestAlertNotifier_Notify(t *testing.T) {
 				err := json.NewDecoder(r.Body).Decode(&body)
 				require.NoError(t, err)
 
-				assert.Equal(t, "alert.consecutive-failure", body["topic"])
+				assert.Equal(t, "alert.consecutive_failure", body["topic"])
 				data := body["data"].(map[string]interface{})
 				assert.Equal(t, float64(10), data["max_consecutive_failures"])
 				assert.Equal(t, float64(5), data["consecutive_failures"])
@@ -102,7 +102,7 @@ func TestAlertNotifier_Notify(t *testing.T) {
 				ConsecutiveFailures:    5,
 				WillDisable:            true,
 				Destination:            dest,
-				Data: map[string]interface{}{
+				DeliveryResponse: map[string]interface{}{
 					"status": "error",
 					"data":   map[string]any{"code": "ETIMEDOUT"},
 				},

internal/deliverymq/messagehandler.go

@@ -302,14 +302,14 @@ func (h *messageHandler) handleAlertAttempt(ctx context.Context, deliveryEvent *
 		if errors.As(err, &delErr) {
 			var pubErr *destregistry.ErrDestinationPublishAttempt
 			if errors.As(delErr.err, &pubErr) {
-				attempt.Data = pubErr.Data
+				attempt.DeliveryResponse = pubErr.Data
 			} else {
-				attempt.Data = map[string]interface{}{
+				attempt.DeliveryResponse = map[string]interface{}{
 					"error": delErr.err.Error(),
 				}
 			}
 		} else {
-			attempt.Data = map[string]interface{}{
+			attempt.DeliveryResponse = map[string]interface{}{
 				"error":   "unexpected",
 				"message": err.Error(),
 			}

internal/deliverymq/messagehandler_test.go

@@ -1125,7 +1125,7 @@ func TestMessageHandler_PublishSuccess(t *testing.T) {
 		return attempt.Success && // Should be a successful attempt
 			attempt.Destination.ID == destination.ID && // Should have correct destination
 			attempt.DeliveryEvent != nil && // Should have delivery event
-			attempt.Data == nil // No error data for success
+			attempt.DeliveryResponse == nil // No error data for success
 	})).Return(nil)
 
 	// Setup message handler
@@ -1255,8 +1255,8 @@ func assertAlertMonitor(t *testing.T, m *mockAlertMonitor, success bool, destina
 	assert.NotNil(t, attempt.DeliveryEvent, "alert attempt should have delivery event")
 
 	if expectedData != nil {
-		assert.Equal(t, expectedData, attempt.Data, "alert attempt data should match")
+		assert.Equal(t, expectedData, attempt.DeliveryResponse, "alert attempt data should match")
 	} else {
-		assert.Nil(t, attempt.Data, "alert attempt should not have data")
+		assert.Nil(t, attempt.DeliveryResponse, "alert attempt should not have data")
 	}
 }