mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-08 05:18:52 +00:00
36e722ba12
Uncommitted migration work at the time of branch cleanup. Tagged as checkpoint/m1-migration-wip so the commit survives git gc --prune=now. Session context: Phase 3 Part B+C of the M-1 sentinel error migration was in progress. 38 modified files, 4 new files (errors.go + errors_test.go in internal/service/ and internal/api/handler/). Resume from this commit via 'git checkout checkpoint/m1-migration-wip'.
221 lines
8.0 KiB
Go
221 lines
8.0 KiB
Go
package handler
|
|
|
|
import (
|
|
"context"
|
|
"log/slog"
|
|
"net/http"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"github.com/shankar0123/certctl/internal/api/middleware"
|
|
"github.com/shankar0123/certctl/internal/domain"
|
|
)
|
|
|
|
// NotificationService defines the service interface for notification operations.
|
|
//
|
|
// ListNotificationsByStatus and RequeueNotification were added to close coverage
|
|
// gap I-005: the Dead letter tab on the GUI (?status=dead) needs a scoped
|
|
// listing path, and the Requeue action needs a dedicated endpoint that flips a
|
|
// dead notification back to 'pending' so the retry sweep can pick it up again.
|
|
type NotificationService interface {
|
|
ListNotifications(ctx context.Context, page, perPage int) ([]domain.NotificationEvent, int64, error)
|
|
ListNotificationsByStatus(ctx context.Context, status string, page, perPage int) ([]domain.NotificationEvent, int64, error)
|
|
GetNotification(ctx context.Context, id string) (*domain.NotificationEvent, error)
|
|
MarkAsRead(ctx context.Context, id string) error
|
|
RequeueNotification(ctx context.Context, id string) error
|
|
}
|
|
|
|
// NotificationHandler handles HTTP requests for notification operations.
|
|
type NotificationHandler struct {
|
|
svc NotificationService
|
|
}
|
|
|
|
// NewNotificationHandler creates a new NotificationHandler with a service dependency.
|
|
func NewNotificationHandler(svc NotificationService) NotificationHandler {
|
|
return NotificationHandler{svc: svc}
|
|
}
|
|
|
|
// ListNotifications lists notifications.
|
|
// GET /api/v1/notifications?page=1&per_page=50
|
|
func (h NotificationHandler) ListNotifications(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodGet {
|
|
Error(w, http.StatusMethodNotAllowed, "Method not allowed")
|
|
return
|
|
}
|
|
|
|
requestID := middleware.GetRequestID(r.Context())
|
|
|
|
page := 1
|
|
perPage := 50
|
|
query := r.URL.Query()
|
|
if p := query.Get("page"); p != "" {
|
|
if parsed, err := strconv.Atoi(p); err == nil && parsed > 0 {
|
|
page = parsed
|
|
}
|
|
}
|
|
if pp := query.Get("per_page"); pp != "" {
|
|
if parsed, err := strconv.Atoi(pp); err == nil && parsed > 0 && parsed <= 500 {
|
|
perPage = parsed
|
|
}
|
|
}
|
|
|
|
// I-005: branch to the status-scoped listing path when ?status= is present
|
|
// so the Dead letter tab on the GUI (?status=dead) can filter server-side.
|
|
// Empty status delegates to the original ListNotifications path to preserve
|
|
// the default tab's existing behavior.
|
|
var (
|
|
notifications []domain.NotificationEvent
|
|
total int64
|
|
err error
|
|
)
|
|
if status := query.Get("status"); status != "" {
|
|
notifications, total, err = h.svc.ListNotificationsByStatus(r.Context(), status, page, perPage)
|
|
} else {
|
|
notifications, total, err = h.svc.ListNotifications(r.Context(), page, perPage)
|
|
}
|
|
if err != nil {
|
|
ErrorWithRequestID(w, http.StatusInternalServerError, "Failed to list notifications", requestID)
|
|
return
|
|
}
|
|
|
|
response := PagedResponse{
|
|
Data: notifications,
|
|
Total: total,
|
|
Page: page,
|
|
PerPage: perPage,
|
|
}
|
|
|
|
JSON(w, http.StatusOK, response)
|
|
}
|
|
|
|
// GetNotification retrieves a single notification by ID.
|
|
// GET /api/v1/notifications/{id}
|
|
func (h NotificationHandler) GetNotification(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodGet {
|
|
Error(w, http.StatusMethodNotAllowed, "Method not allowed")
|
|
return
|
|
}
|
|
|
|
requestID := middleware.GetRequestID(r.Context())
|
|
|
|
id := strings.TrimPrefix(r.URL.Path, "/api/v1/notifications/")
|
|
parts := strings.Split(id, "/")
|
|
if len(parts) == 0 || parts[0] == "" {
|
|
ErrorWithRequestID(w, http.StatusBadRequest, "Notification ID is required", requestID)
|
|
return
|
|
}
|
|
id = parts[0]
|
|
|
|
notification, err := h.svc.GetNotification(r.Context(), id)
|
|
if err != nil {
|
|
// M-1 (P2): dispatch routes through errToStatus. Pre-M-1 this branch was
|
|
// a blanket `any error → 404 Notification not found` shortcut — which
|
|
// silently demoted transient DB failures from the service's List() wrap
|
|
// (notification.go:386 pre-M-1) to 404 Not Found with no observable
|
|
// external signal. Post-M-1: service/notification.go GetNotification only
|
|
// wraps the genuine "not found" path with service.ErrNotFound via %w, and
|
|
// every other error (including the List() wrap) surfaces without that
|
|
// sentinel — so errors.Is(err, service.ErrNotFound) picks up the real
|
|
// 404s and everything else correctly surfaces as 500 with server-side
|
|
// slog.Error capture (F-002 redacted-500 pattern preserved).
|
|
status := errToStatus(err)
|
|
if status == http.StatusInternalServerError {
|
|
slog.Error("GetNotification failed", "notification_id", id, "error", err.Error())
|
|
}
|
|
msg := "Failed to get notification"
|
|
if status == http.StatusNotFound {
|
|
msg = "Notification not found"
|
|
}
|
|
ErrorWithRequestID(w, status, msg, requestID)
|
|
return
|
|
}
|
|
|
|
JSON(w, http.StatusOK, notification)
|
|
}
|
|
|
|
// MarkAsRead marks a notification as read.
|
|
// POST /api/v1/notifications/{id}/read
|
|
func (h NotificationHandler) MarkAsRead(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodPost {
|
|
Error(w, http.StatusMethodNotAllowed, "Method not allowed")
|
|
return
|
|
}
|
|
|
|
requestID := middleware.GetRequestID(r.Context())
|
|
|
|
// Extract notification ID from path /api/v1/notifications/{id}/read
|
|
path := strings.TrimPrefix(r.URL.Path, "/api/v1/notifications/")
|
|
parts := strings.Split(path, "/")
|
|
if len(parts) < 2 || parts[0] == "" {
|
|
ErrorWithRequestID(w, http.StatusBadRequest, "Notification ID is required", requestID)
|
|
return
|
|
}
|
|
notificationID := parts[0]
|
|
|
|
if err := h.svc.MarkAsRead(r.Context(), notificationID); err != nil {
|
|
ErrorWithRequestID(w, http.StatusInternalServerError, "Failed to mark notification as read", requestID)
|
|
return
|
|
}
|
|
|
|
response := map[string]string{
|
|
"status": "marked_as_read",
|
|
}
|
|
|
|
JSON(w, http.StatusOK, response)
|
|
}
|
|
|
|
// RequeueNotification flips a dead notification back to 'pending' so the retry
|
|
// sweep (coverage gap I-005) can pick it up again on its next tick. The handler
|
|
// is strictly POST-only; GET/PUT/DELETE return 405. An empty id segment
|
|
// (/api/v1/notifications//requeue) returns 400. Service errors that carry a
|
|
// "not found" sentinel map to 404; all other service errors map to 500. This
|
|
// 404-vs-500 split mirrors GetCertificateDeployments at certificates.go:644.
|
|
// POST /api/v1/notifications/{id}/requeue
|
|
func (h NotificationHandler) RequeueNotification(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodPost {
|
|
Error(w, http.StatusMethodNotAllowed, "Method not allowed")
|
|
return
|
|
}
|
|
|
|
requestID := middleware.GetRequestID(r.Context())
|
|
|
|
// Extract notification ID from path /api/v1/notifications/{id}/requeue
|
|
path := strings.TrimPrefix(r.URL.Path, "/api/v1/notifications/")
|
|
parts := strings.Split(path, "/")
|
|
if len(parts) < 2 || parts[0] == "" {
|
|
ErrorWithRequestID(w, http.StatusBadRequest, "Notification ID is required", requestID)
|
|
return
|
|
}
|
|
notificationID := parts[0]
|
|
|
|
if err := h.svc.RequeueNotification(r.Context(), notificationID); err != nil {
|
|
// M-1 (P2): dispatch routes through errToStatus. Pre-M-1 this branch
|
|
// classified 404 via strings.Contains(err.Error(), "not found"), which
|
|
// would have given false positives on any error whose rendered text
|
|
// happened to contain "not found" — notably a transient DB failure whose
|
|
// driver message mentioned a missing relation or column. Post-M-1: the
|
|
// repo-layer Requeue (postgres/notification.go) wraps zero-rows-affected
|
|
// with repository.ErrNotFound via %w, and the service layer forwards
|
|
// that error with %w — so errors.Is(err, repository.ErrNotFound) walks
|
|
// the full wrap chain and picks up the real 404s while everything else
|
|
// (including transient DB errors) correctly surfaces as 500 with
|
|
// server-side slog.Error capture (F-002 redacted-500 pattern preserved).
|
|
status := errToStatus(err)
|
|
if status == http.StatusInternalServerError {
|
|
slog.Error("RequeueNotification failed", "notification_id", notificationID, "error", err.Error())
|
|
}
|
|
msg := "Failed to requeue notification"
|
|
if status == http.StatusNotFound {
|
|
msg = "Notification not found"
|
|
}
|
|
ErrorWithRequestID(w, status, msg, requestID)
|
|
return
|
|
}
|
|
|
|
response := map[string]string{
|
|
"status": "requeued",
|
|
}
|
|
|
|
JSON(w, http.StatusOK, response)
|
|
}
|