mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 22:11:38 +00:00
0e29c416b1
Closes one 2026-04-24 audit finding (P2):
- cat-s6-efc7f6f6bd50: 30 strings.Contains(err.Error(), ...) sites
in internal/api/handler/ — brittle to repository-layer message
changes, untyped against the actual failure mode.
Approach (Option B from prompt design notes):
- New typed sentinels in internal/repository/errors.go:
ErrNotFound, ErrForeignKeyConstraint
IsForeignKeyError(err) helper (the only place substring
matching at the lib/pq boundary is allowed; isolates the
DB-driver string knowledge to one function).
- New typed sentinel in internal/domain/errors.go:
ErrValidation (reserved for future per-entity validation
wrappers; not yet used by all handlers).
- 49 sites in internal/repository/postgres/*.go updated to wrap
sql.ErrNoRows-derived errors via fmt.Errorf("...: %w",
repository.ErrNotFound).
- 18 not-found handler sites + 2 FK-constraint handler sites
refactored to errors.Is(err, repository.ErrNotFound) /
repository.IsForeignKeyError(err).
- 23 inline `fmt.Errorf("X not found")` test fixtures across
handler tests rewrapped to wrap repository.ErrNotFound.
- test_utils.go::ErrMockNotFound rewrapped to wrap
repository.ErrNotFound; renewal_policy.go closure docblock
updated to reflect the new convention.
- integration test mockJobRepository.Get wraps repository.ErrNotFound.
CI regression guardrail:
- .github/workflows/ci.yml::"Forbidden strings.Contains(err.Error())
regression guard (S-2)" greps for the three patterns ("not found",
"violates foreign key", "RESTRICT") under internal/api/handler/
and fails the build on regression.
Verification:
- go build ./... — clean
- go vet ./... — clean
- go test ./... -short -count=1 — all packages pass (handler +
repository + service + integration)
- golangci-lint v2.11.4 run ./... — 0 issues
- S-2 guardrail dry-run on post-fix tree → empty (good)
- All sibling guardrails (S-1, G-3, D-1+D-2, B-1, L-1, H-1, C-1, F-1, P-1) pass
Audit findings closed:
- cat-s6-efc7f6f6bd50 (P2)
Deferred follow-ups:
- 6 domain-specific substring patterns still inline in handlers
("cannot approve", "cannot reject", "cannot be parsed",
"no certificates found", "challenge password", "invalid"/
"required" validation chains in profiles + agent_groups). Each
needs its own typed sentinel, scoped per service. Documented
by the S-2 CI guardrail's allowlist for closure-comments only.
- Per-entity not-found sentinels (Option A — ErrCertificateNotFound,
ErrAgentNotFound, etc.) deferred. Generic ErrNotFound covers the
current dispatch needs; per-entity precision would let handlers
return entity-aware error bodies without a domain.Type field,
but not blocking.
189 lines
6.2 KiB
Go
189 lines
6.2 KiB
Go
package handler
|
|
|
|
import (
|
|
"github.com/shankar0123/certctl/internal/repository"
|
|
"errors"
|
|
"context"
|
|
"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 {
|
|
ErrorWithRequestID(w, http.StatusNotFound, "Notification not found", 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 {
|
|
if errors.Is(err, repository.ErrNotFound) {
|
|
ErrorWithRequestID(w, http.StatusNotFound, "Notification not found", requestID)
|
|
return
|
|
}
|
|
ErrorWithRequestID(w, http.StatusInternalServerError, "Failed to requeue notification", requestID)
|
|
return
|
|
}
|
|
|
|
response := map[string]string{
|
|
"status": "requeued",
|
|
}
|
|
|
|
JSON(w, http.StatusOK, response)
|
|
}
|