mirror of
https://github.com/shankar0123/certctl.git
synced 2026-06-07 18:41:30 +00:00
8b75e0311b
Mechanical sed across the main go.mod's module declaration, the f5-mock-icontrol
sub-module's go.mod, every Go file's import path (361 files), and a rebuild of
the checked-in f5-mock-icontrol binary so its embedded build-info reflects the
new module path. No behavior change.
Choice B from cowork/transfer-certctl-to-org.md, executed 2026-05-04. Choice A
(keep module path declared as github.com/shankar0123/certctl regardless of
repo URL) shipped on the day of the org transfer (2026-05-03) since we had no
external Go consumers; this commit closes that deferral.
Backward-compat: GitHub HTTP redirects continue to forward
github.com/shankar0123/certctl → github.com/certctl-io/certctl at the URL
level, but Go's module proxy uses the path declared in go.mod as the
canonical name. Pre-fix, anyone trying `go get github.com/certctl-io/certctl/...`
hit a "module path mismatch" error because go.mod said
github.com/shankar0123/certctl and the URL they fetched it from said
certctl-io/certctl. Post-fix, the canonical name and the URL agree, so
go get / go install / external Go consumers / Go-tooling integrations
work cleanly via either the new path (preferred) or the old path (which
redirects and Go follows the redirect for source fetch).
Anyone still importing the old path inside their own code keeps working
provided they update their go.mod's `require` line to match — the module
path declared in their consumer's go.sum / go.mod is the authoritative
import name, so a mass sed across their import statements is the migration
on the consumer side. No external consumers exist today.
Diff shape:
361 *.go files — import path replacement only
2 go.mod — module declaration replacement only
1 binary — deploy/test/f5-mock-icontrol/f5-mock-icontrol rebuilt
so embedded build-info reflects the new path (8618965 vs
8618933 bytes; 32-byte diff is the build-info change)
Total: 364 files, 730 insertions / 730 deletions, net-zero size, pure
mechanical substitution.
Verification:
gofmt: 17 files needed re-alignment after sed (the new path is one char
shorter than the old, so column-aligned import groups drifted). Applied
`gofmt -w` to fix.
go mod tidy: clean exit on both modules.
go vet ./...: clean exit.
go build ./...: clean exit.
go test -short -count=1 on representative packages: all green
(internal/domain, internal/validation, internal/crypto, internal/crypto/signer,
cmd/agent). Test output now reads `ok github.com/certctl-io/certctl/...`
confirming the module path resolves correctly.
binary: f5-mock-icontrol rebuilt; `strings | grep shankar0123` returns
nothing; `strings | grep certctl-io/certctl` shows the new module path
embedded in build-info.
Files intentionally NOT touched in this commit:
README.md / CHANGELOG.md / docs/ / etc. — already swept to certctl-io
URLs in commit 0729ee4 (the post-transfer URL refresh). This commit is
purely the Go-tooling layer.
Scarf pixels (`shankar0123.docker.scarf.sh/...`) — Scarf-account
namespace, not a Go import or GitHub repo URL. Stays.
This is a non-blocking, non-customer-impacting change. Operators pulling
container images, running `make verify`, hitting the API, or installing the
agent see no functional difference. Only Go-tooling consumers (none today)
are affected, and they're enabled — not broken — by this commit.
189 lines
6.2 KiB
Go
189 lines
6.2 KiB
Go
package handler
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"github.com/certctl-io/certctl/internal/repository"
|
|
"net/http"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"github.com/certctl-io/certctl/internal/api/middleware"
|
|
"github.com/certctl-io/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)
|
|
}
|