Publish ITWorx Pulse source

internal/eventapi/handler.go

@@ -0,0 +1,86 @@
+package eventapi
+
+import (
+	"context"
+	"encoding/json"
+	"errors"
+	"net/http"
+	"strconv"
+	"time"
+
+	"github.com/itworx/pulse/internal/auth"
+	"github.com/itworx/pulse/internal/problem"
+	"github.com/jackc/pgx/v5/pgxpool"
+)
+
+type Event struct {
+	ID            string          `json:"id"`
+	Type          string          `json:"type"`
+	Severity      string          `json:"severity"`
+	EntityID      *string         `json:"entityId,omitempty"`
+	SourceID      *string         `json:"sourceId,omitempty"`
+	OccurredAt    time.Time       `json:"occurredAt"`
+	ReceivedAt    time.Time       `json:"receivedAt"`
+	Summary       string          `json:"summary"`
+	Attributes    json.RawMessage `json:"attributes"`
+	CorrelationID *string         `json:"correlationId,omitempty"`
+}
+
+type Store interface {
+	List(context.Context, int) ([]Event, error)
+}
+
+type PostgresStore struct{ Pool *pgxpool.Pool }
+
+func (s PostgresStore) List(ctx context.Context, limit int) ([]Event, error) {
+	if s.Pool == nil {
+		return nil, errors.New("event database pool is nil")
+	}
+	rows, err := s.Pool.Query(ctx, `SELECT id::text,event_type,severity,entity_id::text,source_id::text,occurred_at,received_at,summary,attributes,correlation_id FROM events ORDER BY occurred_at DESC,id DESC LIMIT $1`, limit)
+	if err != nil {
+		return nil, err
+	}
+	defer rows.Close()
+	items := make([]Event, 0, limit)
+	for rows.Next() {
+		var item Event
+		if err := rows.Scan(&item.ID, &item.Type, &item.Severity, &item.EntityID, &item.SourceID, &item.OccurredAt, &item.ReceivedAt, &item.Summary, &item.Attributes, &item.CorrelationID); err != nil {
+			return nil, err
+		}
+		items = append(items, item)
+	}
+	return items, rows.Err()
+}
+
+type Handler struct{ Store Store }
+
+func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	if r.Method != http.MethodGet || r.URL.Path != "/api/v1/events" {
+		http.NotFound(w, r)
+		return
+	}
+	if _, ok := auth.PrincipalFromContext(r.Context()); !ok {
+		problem.Write(w, r, http.StatusUnauthorized, "UNAUTHORIZED", "Authentication required", "Authentication is required to read events.", nil)
+		return
+	}
+	limit := 100
+	if raw := r.URL.Query().Get("limit"); raw != "" {
+		value, err := strconv.Atoi(raw)
+		if err != nil || value < 1 || value > 100 {
+			problem.Write(w, r, http.StatusBadRequest, "INVALID_LIMIT", "Invalid limit", "The event limit must be between 1 and 100.", nil)
+			return
+		}
+		limit = value
+	}
+	items, err := h.Store.List(r.Context(), limit)
+	if err != nil {
+		if errors.Is(err, context.Canceled) || errors.Is(err, context.DeadlineExceeded) {
+			return
+		}
+		problem.Write(w, r, http.StatusServiceUnavailable, "EVENTS_UNAVAILABLE", "Events unavailable", "Gebeurtenissen konden niet worden gelezen.", nil)
+		return
+	}
+	w.Header().Set("Content-Type", "application/json")
+	w.Header().Set("Cache-Control", "private, max-age=5")
+	_ = json.NewEncoder(w).Encode(map[string]any{"items": items})
+}

internal/eventapi/handler_test.go

@@ -0,0 +1,44 @@
+package eventapi
+
+import (
+	"context"
+	"net/http"
+	"net/http/httptest"
+	"strings"
+	"testing"
+
+	"github.com/itworx/pulse/internal/auth"
+)
+
+type fakeStore struct{ limit int }
+
+func (s *fakeStore) List(_ context.Context, limit int) ([]Event, error) {
+	s.limit = limit
+	return []Event{{ID: "event-1", Type: "discovery.completed", Severity: "info", Summary: "Inventaris bijgewerkt", Attributes: []byte(`{}`)}}, nil
+}
+
+func TestHandlerListsBoundedEvents(t *testing.T) {
+	store := &fakeStore{}
+	req := httptest.NewRequest(http.MethodGet, "/api/v1/events?limit=25", nil)
+	req = req.WithContext(auth.WithPrincipal(req.Context(), auth.Principal{Subject: "viewer", Role: auth.RoleViewer}))
+	res := httptest.NewRecorder()
+	Handler{Store: store}.ServeHTTP(res, req)
+	if res.Code != http.StatusOK || store.limit != 25 || !strings.Contains(res.Body.String(), `"id":"event-1"`) {
+		t.Fatalf("status=%d limit=%d body=%s", res.Code, store.limit, res.Body.String())
+	}
+}
+
+func TestHandlerRejectsInvalidLimitAndAnonymous(t *testing.T) {
+	res := httptest.NewRecorder()
+	Handler{Store: &fakeStore{}}.ServeHTTP(res, httptest.NewRequest(http.MethodGet, "/api/v1/events", nil))
+	if res.Code != http.StatusUnauthorized {
+		t.Fatalf("anonymous status=%d", res.Code)
+	}
+	req := httptest.NewRequest(http.MethodGet, "/api/v1/events?limit=101", nil)
+	req = req.WithContext(auth.WithPrincipal(req.Context(), auth.Principal{Subject: "viewer", Role: auth.RoleViewer}))
+	res = httptest.NewRecorder()
+	Handler{Store: &fakeStore{}}.ServeHTTP(res, req)
+	if res.Code != http.StatusBadRequest {
+		t.Fatalf("limit status=%d", res.Code)
+	}
+}

internal/eventapi/postgres_integration_test.go

@@ -0,0 +1,61 @@
+package eventapi
+
+import (
+	"context"
+	"crypto/rand"
+	"fmt"
+	"os"
+	"testing"
+	"time"
+
+	"github.com/itworx/pulse/internal/database"
+)
+
+func integrationID(t *testing.T) string {
+	t.Helper()
+	var value [16]byte
+	if _, err := rand.Read(value[:]); err != nil {
+		t.Fatal(err)
+	}
+	value[6] = (value[6] & 0x0f) | 0x40
+	value[8] = (value[8] & 0x3f) | 0x80
+	return fmt.Sprintf("%x-%x-%x-%x-%x", value[0:4], value[4:6], value[6:8], value[8:10], value[10:16])
+}
+
+func TestPostgresStoreListsNewestEventsDeterministically(t *testing.T) {
+	dsn := os.Getenv("PULSE_TEST_DATABASE_URL")
+	if dsn == "" {
+		t.Skip("PULSE_TEST_DATABASE_URL is not set")
+	}
+	ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
+	defer cancel()
+	pool, err := database.NewPool(ctx, database.Config{URL: dsn, MaxConns: 2, MinConns: 1})
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer pool.Close()
+	if err := database.Migrate(ctx, pool); err != nil {
+		t.Fatal(err)
+	}
+	sourceID, olderID, newerID := integrationID(t), integrationID(t), integrationID(t)
+	if _, err := pool.Exec(ctx, `INSERT INTO data_sources(id,type,name,configuration_ref) VALUES($1,'fixture','event-api-test','test')`, sourceID); err != nil {
+		t.Fatal(err)
+	}
+	t.Cleanup(func() {
+		cleanup, stop := context.WithTimeout(context.Background(), 10*time.Second)
+		defer stop()
+		_, _ = pool.Exec(cleanup, `DELETE FROM events WHERE source_id=$1`, sourceID)
+		_, _ = pool.Exec(cleanup, `DELETE FROM data_sources WHERE id=$1`, sourceID)
+	})
+	at := time.Date(2099, 8, 12, 2, 0, 0, 0, time.UTC)
+	if _, err := pool.Exec(ctx, `INSERT INTO events(id,event_type,severity,source_id,occurred_at,dedup_key,summary) VALUES($1,'older','info',$3,$4,'older','Ouder'),($2,'newer','warning',$3,$5,'newer','Nieuwer')`, olderID, newerID, sourceID, at, at.Add(time.Minute)); err != nil {
+		t.Fatal(err)
+	}
+	items, err := (PostgresStore{Pool: pool}).List(ctx, 2)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if len(items) < 2 || items[0].ID != newerID || items[1].ID != olderID {
+		t.Fatalf("events not deterministically newest first: %#v", items)
+	}
+}