mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 23:31:39 +00:00
9834b4e4a4
Three frontend call sites (OnboardingWizard.tsx:603, CertificatesPage.tsx:52,
CertificateDetailPage.tsx:169) populated the renewal_policy_id dropdown from
getPolicies() — the compliance-rule endpoint returning pol-* IDs — which
violated the FK managed_certificates.renewal_policy_id REFERENCES
renewal_policies(id) ON DELETE RESTRICT. Create would fail pg 23503 at insert.
Backend (new):
- RenewalPolicyRepository CRUD + ListAll/ExistsByID (pg 23503 → ErrRenewalPolicyInUse
→ HTTP 409; pg 23505 → ErrRenewalPolicyDuplicateName → HTTP 409)
- RenewalPolicyService with repo-only constructor. Service sentinels
var-alias the repo sentinels so errors.Is walks across layers.
- RenewalPolicyHandler with validation bounds: name 1–255;
renewal_window_days [1,365] default 30; max_retries [0,10] not defaulted;
retry_interval_seconds [60,86400] default 3600; alert_thresholds_days
[0,365] default [30,14,7,0]. Auto-generated IDs rp-<slug(name)>.
- Router registers 5 routes under /api/v1/renewal-policies[/{id}].
Frontend:
- CertificatesPage/CertificateDetailPage/OnboardingWizard now call
getRenewalPolicies() and render rp-* IDs.
- client.ts adds getRenewalPolicies/createRenewalPolicy/updateRenewalPolicy/
deleteRenewalPolicy. types.ts adds the RenewalPolicy shape.
OpenAPI: RenewalPolicies tag + 5 operations + 3 schemas (RenewalPolicy,
RenewalPolicyCreateRequest, RenewalPolicyUpdateRequest). 409 responses
on create/update duplicate-name and delete FK-in-use.
No migration — renewal_policies table already exists from the initial
schema (000001).
Tests:
- internal/service/renewal_policy_test.go: CRUD + validation + sentinel
error wrapping.
- internal/api/handler/renewal_policy_handler_test.go: handler endpoint
contracts including 400/404/409.
- web/src/api/client.test.ts: 4 subtests covering the 4 new API functions.
Phase 3 gates all green: go vet, build, short tests, race tests (service/
handler/router/scheduler), staticcheck (G-1 packages), govulncheck (0
reachable), coverage (service 69.7%, handler 79.0%, domain 86.9%,
middleware 80.6% — all above thresholds), tsc, vitest (256 passed),
vite build, OpenAPI structural validation.
244 lines
8.3 KiB
Go
244 lines
8.3 KiB
Go
package handler
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"net/http"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"github.com/shankar0123/certctl/internal/api/middleware"
|
|
"github.com/shankar0123/certctl/internal/domain"
|
|
"github.com/shankar0123/certctl/internal/service"
|
|
)
|
|
|
|
// RenewalPolicyService defines the service interface for renewal policy
|
|
// operations. G-1: all methods take ctx so the handler can propagate
|
|
// request-scoped cancellation/deadlines through the full stack.
|
|
type RenewalPolicyService interface {
|
|
ListRenewalPolicies(ctx context.Context, page, perPage int) ([]domain.RenewalPolicy, int64, error)
|
|
GetRenewalPolicy(ctx context.Context, id string) (*domain.RenewalPolicy, error)
|
|
CreateRenewalPolicy(ctx context.Context, rp domain.RenewalPolicy) (*domain.RenewalPolicy, error)
|
|
UpdateRenewalPolicy(ctx context.Context, id string, rp domain.RenewalPolicy) (*domain.RenewalPolicy, error)
|
|
DeleteRenewalPolicy(ctx context.Context, id string) error
|
|
}
|
|
|
|
// RenewalPolicyHandler serves /api/v1/renewal-policies CRUD endpoints.
|
|
//
|
|
// G-1 design note: the service-level `ErrRenewalPolicyDuplicateName` /
|
|
// `ErrRenewalPolicyInUse` sentinels alias the repository sentinels (same var
|
|
// identity), so `errors.Is` walks transparently across layers. Delete/Update
|
|
// not-found detection intentionally uses a `strings.Contains(err.Error(),
|
|
// "not found")` substring check — the repo wraps `sql.ErrNoRows` as
|
|
// `fmt.Errorf("renewal policy not found: %s", id)` which strips the sentinel,
|
|
// and the handler red-tests' `ErrMockNotFound = errors.New("mock not found
|
|
// error")` follows the same substring convention.
|
|
type RenewalPolicyHandler struct {
|
|
svc RenewalPolicyService
|
|
}
|
|
|
|
// NewRenewalPolicyHandler constructs the handler with its service dependency.
|
|
// Returned by value to match the house pattern (PolicyHandler, IssuerHandler
|
|
// etc.) — the registry stores handlers by value in router.HandlerRegistry.
|
|
func NewRenewalPolicyHandler(svc RenewalPolicyService) RenewalPolicyHandler {
|
|
return RenewalPolicyHandler{svc: svc}
|
|
}
|
|
|
|
// ListRenewalPolicies lists all renewal policies (paginated).
|
|
// GET /api/v1/renewal-policies?page=1&per_page=50
|
|
func (h RenewalPolicyHandler) ListRenewalPolicies(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
|
|
}
|
|
}
|
|
|
|
policies, total, err := h.svc.ListRenewalPolicies(r.Context(), page, perPage)
|
|
if err != nil {
|
|
ErrorWithRequestID(w, http.StatusInternalServerError, "Failed to list renewal policies", requestID)
|
|
return
|
|
}
|
|
|
|
response := PagedResponse{
|
|
Data: policies,
|
|
Total: total,
|
|
Page: page,
|
|
PerPage: perPage,
|
|
}
|
|
|
|
JSON(w, http.StatusOK, response)
|
|
}
|
|
|
|
// GetRenewalPolicy retrieves a single renewal policy by ID.
|
|
// GET /api/v1/renewal-policies/{id}
|
|
func (h RenewalPolicyHandler) GetRenewalPolicy(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/renewal-policies/")
|
|
parts := strings.Split(id, "/")
|
|
if len(parts) == 0 || parts[0] == "" {
|
|
ErrorWithRequestID(w, http.StatusBadRequest, "Renewal policy ID is required", requestID)
|
|
return
|
|
}
|
|
id = parts[0]
|
|
|
|
policy, err := h.svc.GetRenewalPolicy(r.Context(), id)
|
|
if err != nil {
|
|
// Matches the PolicyHandler.GetPolicy convention: any error from the
|
|
// service surfaces as 404. The repo wraps sql.ErrNoRows as
|
|
// "renewal policy not found: %s" and there's no other expected failure
|
|
// mode on Get — the caller gets a clean 404.
|
|
ErrorWithRequestID(w, http.StatusNotFound, "Renewal policy not found", requestID)
|
|
return
|
|
}
|
|
|
|
JSON(w, http.StatusOK, policy)
|
|
}
|
|
|
|
// CreateRenewalPolicy inserts a new renewal policy.
|
|
// POST /api/v1/renewal-policies
|
|
//
|
|
// Error mapping:
|
|
// - invalid JSON / missing name → 400
|
|
// - ErrRenewalPolicyDuplicateName (pg 23505 on name UNIQUE) → 409
|
|
// - anything else → 500
|
|
func (h RenewalPolicyHandler) CreateRenewalPolicy(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodPost {
|
|
Error(w, http.StatusMethodNotAllowed, "Method not allowed")
|
|
return
|
|
}
|
|
|
|
requestID := middleware.GetRequestID(r.Context())
|
|
|
|
var rp domain.RenewalPolicy
|
|
if err := json.NewDecoder(r.Body).Decode(&rp); err != nil {
|
|
ErrorWithRequestID(w, http.StatusBadRequest, "Invalid request body", requestID)
|
|
return
|
|
}
|
|
|
|
if err := ValidateRequired("name", rp.Name); err != nil {
|
|
ErrorWithRequestID(w, http.StatusBadRequest, err.Error(), requestID)
|
|
return
|
|
}
|
|
|
|
created, err := h.svc.CreateRenewalPolicy(r.Context(), rp)
|
|
if err != nil {
|
|
if errors.Is(err, service.ErrRenewalPolicyDuplicateName) {
|
|
ErrorWithRequestID(w, http.StatusConflict, "A renewal policy with that name already exists", requestID)
|
|
return
|
|
}
|
|
ErrorWithRequestID(w, http.StatusInternalServerError, "Failed to create renewal policy", requestID)
|
|
return
|
|
}
|
|
|
|
JSON(w, http.StatusCreated, created)
|
|
}
|
|
|
|
// UpdateRenewalPolicy replaces the fields of an existing renewal policy.
|
|
// PUT /api/v1/renewal-policies/{id}
|
|
//
|
|
// Error mapping:
|
|
// - invalid JSON / empty ID → 400
|
|
// - ErrRenewalPolicyDuplicateName → 409
|
|
// - error text contains "not found" → 404 (see struct doc comment re: substring check)
|
|
// - anything else → 500
|
|
func (h RenewalPolicyHandler) UpdateRenewalPolicy(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodPut {
|
|
Error(w, http.StatusMethodNotAllowed, "Method not allowed")
|
|
return
|
|
}
|
|
|
|
requestID := middleware.GetRequestID(r.Context())
|
|
|
|
id := strings.TrimPrefix(r.URL.Path, "/api/v1/renewal-policies/")
|
|
parts := strings.Split(id, "/")
|
|
if len(parts) == 0 || parts[0] == "" {
|
|
ErrorWithRequestID(w, http.StatusBadRequest, "Renewal policy ID is required", requestID)
|
|
return
|
|
}
|
|
id = parts[0]
|
|
|
|
var rp domain.RenewalPolicy
|
|
if err := json.NewDecoder(r.Body).Decode(&rp); err != nil {
|
|
ErrorWithRequestID(w, http.StatusBadRequest, "Invalid request body", requestID)
|
|
return
|
|
}
|
|
|
|
updated, err := h.svc.UpdateRenewalPolicy(r.Context(), id, rp)
|
|
if err != nil {
|
|
if errors.Is(err, service.ErrRenewalPolicyDuplicateName) {
|
|
ErrorWithRequestID(w, http.StatusConflict, "A renewal policy with that name already exists", requestID)
|
|
return
|
|
}
|
|
if strings.Contains(err.Error(), "not found") {
|
|
ErrorWithRequestID(w, http.StatusNotFound, "Renewal policy not found", requestID)
|
|
return
|
|
}
|
|
ErrorWithRequestID(w, http.StatusInternalServerError, "Failed to update renewal policy", requestID)
|
|
return
|
|
}
|
|
|
|
JSON(w, http.StatusOK, updated)
|
|
}
|
|
|
|
// DeleteRenewalPolicy removes a renewal policy.
|
|
// DELETE /api/v1/renewal-policies/{id}
|
|
//
|
|
// Error mapping:
|
|
// - empty ID (trailing slash) → 400
|
|
// - ErrRenewalPolicyInUse (pg 23503 FK-RESTRICT against managed_certificates.renewal_policy_id) → 409
|
|
// - error text contains "not found" → 404
|
|
// - anything else → 500
|
|
func (h RenewalPolicyHandler) DeleteRenewalPolicy(w http.ResponseWriter, r *http.Request) {
|
|
if r.Method != http.MethodDelete {
|
|
Error(w, http.StatusMethodNotAllowed, "Method not allowed")
|
|
return
|
|
}
|
|
|
|
requestID := middleware.GetRequestID(r.Context())
|
|
|
|
id := strings.TrimPrefix(r.URL.Path, "/api/v1/renewal-policies/")
|
|
parts := strings.Split(id, "/")
|
|
if len(parts) == 0 || parts[0] == "" {
|
|
ErrorWithRequestID(w, http.StatusBadRequest, "Renewal policy ID is required", requestID)
|
|
return
|
|
}
|
|
id = parts[0]
|
|
|
|
if err := h.svc.DeleteRenewalPolicy(r.Context(), id); err != nil {
|
|
if errors.Is(err, service.ErrRenewalPolicyInUse) {
|
|
ErrorWithRequestID(w, http.StatusConflict, "Renewal policy is still referenced by managed certificates", requestID)
|
|
return
|
|
}
|
|
if strings.Contains(err.Error(), "not found") {
|
|
ErrorWithRequestID(w, http.StatusNotFound, "Renewal policy not found", requestID)
|
|
return
|
|
}
|
|
ErrorWithRequestID(w, http.StatusInternalServerError, "Failed to delete renewal policy", requestID)
|
|
return
|
|
}
|
|
|
|
w.WriteHeader(http.StatusNoContent)
|
|
}
|