Add scan queue execution and listing endpoint.

Run scans in background with progress/status updates and store scan metrics in memory or PostgreSQL. Made-with: Cursor
2026-04-09 21:49:38 +10:00
parent 284794ec8d
commit 43cb339605
12 changed files with 753 additions and 23 deletions
@@ -0,0 +1,282 @@
+package scans
+
+import (
+	"context"
+	"database/sql"
+	"encoding/json"
+	"errors"
+	"sort"
+	"time"
+)
+
+type PostgresStore struct {
+	db *sql.DB
+}
+
+func NewPostgresStore(db *sql.DB) *PostgresStore {
+	return &PostgresStore{db: db}
+}
+
+func (s *PostgresStore) CreateScan(req CreateScanRequest) (ScanJob, error) {
+	if err := validateCreateScanRequest(req); err != nil {
+		return ScanJob{}, err
+	}
+	applyDefaultOptions(&req.Options)
+
+	id, err := newID()
+	if err != nil {
+		return ScanJob{}, err
+	}
+
+	now := time.Now().UTC()
+	job := ScanJob{
+		ID:                id,
+		Name:              req.Name,
+		Status:            "queued",
+		CIDRs:             req.CIDRs,
+		ExcludeIPs:        req.ExcludeIPs,
+		SNMPCredentialsID: req.SNMPCredentialsID,
+		Options:           req.Options,
+		Progress:          0,
+		Stats:             ScanStats{},
+		CreatedAt:         now,
+	}
+
+	cidrsJSON, err := json.Marshal(job.CIDRs)
+	if err != nil {
+		return ScanJob{}, err
+	}
+	excludeJSON, err := json.Marshal(job.ExcludeIPs)
+	if err != nil {
+		return ScanJob{}, err
+	}
+	optionsJSON, err := json.Marshal(job.Options)
+	if err != nil {
+		return ScanJob{}, err
+	}
+	statsJSON, err := json.Marshal(job.Stats)
+	if err != nil {
+		return ScanJob{}, err
+	}
+
+	var snmpID any
+	if job.SNMPCredentialsID != "" {
+		snmpID = job.SNMPCredentialsID
+	}
+
+	query := `
+insert into scan_jobs (
+  id, name, status, cidrs, exclude_ips, options, progress, stats, snmp_credentials_id, created_at
+) values (
+  $1, $2, $3, $4::jsonb, $5::jsonb, $6::jsonb, $7, $8::jsonb, $9, $10
+)`
+
+	_, err = s.db.ExecContext(context.Background(), query,
+		job.ID,
+		job.Name,
+		job.Status,
+		string(cidrsJSON),
+		string(excludeJSON),
+		string(optionsJSON),
+		job.Progress,
+		string(statsJSON),
+		snmpID,
+		job.CreatedAt,
+	)
+	if err != nil {
+		return ScanJob{}, err
+	}
+
+	return job, nil
+}
+
+func (s *PostgresStore) GetScan(id string) (ScanJob, bool) {
+	query := `
+select id, name, status, cidrs::text, exclude_ips::text, options::text,
+       progress, stats::text, coalesce(snmp_credentials_id::text, ''),
+       created_at, started_at, finished_at
+from scan_jobs
+where id = $1
+limit 1`
+
+	var job ScanJob
+	var cidrsRaw string
+	var excludeRaw string
+	var optionsRaw string
+	var statsRaw string
+	var startedAt sql.NullTime
+	var finishedAt sql.NullTime
+
+	err := s.db.QueryRowContext(context.Background(), query, id).Scan(
+		&job.ID,
+		&job.Name,
+		&job.Status,
+		&cidrsRaw,
+		&excludeRaw,
+		&optionsRaw,
+		&job.Progress,
+		&statsRaw,
+		&job.SNMPCredentialsID,
+		&job.CreatedAt,
+		&startedAt,
+		&finishedAt,
+	)
+	if errors.Is(err, sql.ErrNoRows) {
+		return ScanJob{}, false
+	}
+	if err != nil {
+		return ScanJob{}, false
+	}
+
+	if err = json.Unmarshal([]byte(cidrsRaw), &job.CIDRs); err != nil {
+		return ScanJob{}, false
+	}
+	if err = json.Unmarshal([]byte(excludeRaw), &job.ExcludeIPs); err != nil {
+		return ScanJob{}, false
+	}
+	if err = json.Unmarshal([]byte(optionsRaw), &job.Options); err != nil {
+		return ScanJob{}, false
+	}
+	if err = json.Unmarshal([]byte(statsRaw), &job.Stats); err != nil {
+		return ScanJob{}, false
+	}
+	if startedAt.Valid {
+		job.StartedAt = startedAt.Time
+	}
+	if finishedAt.Valid {
+		job.FinishedAt = finishedAt.Time
+	}
+
+	return job, true
+}
+
+func (s *PostgresStore) ListScans(limit int) []ScanJob {
+	if limit <= 0 {
+		limit = 50
+	}
+	query := `
+select id, name, status, cidrs::text, exclude_ips::text, options::text, progress,
+       stats::text, coalesce(snmp_credentials_id::text, ''), created_at, started_at, finished_at
+from scan_jobs
+order by created_at desc
+limit $1`
+
+	rows, err := s.db.QueryContext(context.Background(), query, limit)
+	if err != nil {
+		return nil
+	}
+	defer rows.Close()
+
+	jobs := make([]ScanJob, 0, limit)
+	for rows.Next() {
+		var job ScanJob
+		var cidrsRaw string
+		var excludeRaw string
+		var optionsRaw string
+		var statsRaw string
+		var startedAt sql.NullTime
+		var finishedAt sql.NullTime
+
+		err = rows.Scan(
+			&job.ID,
+			&job.Name,
+			&job.Status,
+			&cidrsRaw,
+			&excludeRaw,
+			&optionsRaw,
+			&job.Progress,
+			&statsRaw,
+			&job.SNMPCredentialsID,
+			&job.CreatedAt,
+			&startedAt,
+			&finishedAt,
+		)
+		if err != nil {
+			return nil
+		}
+
+		if json.Unmarshal([]byte(cidrsRaw), &job.CIDRs) != nil ||
+			json.Unmarshal([]byte(excludeRaw), &job.ExcludeIPs) != nil ||
+			json.Unmarshal([]byte(optionsRaw), &job.Options) != nil ||
+			json.Unmarshal([]byte(statsRaw), &job.Stats) != nil {
+			return nil
+		}
+		if startedAt.Valid {
+			job.StartedAt = startedAt.Time
+		}
+		if finishedAt.Valid {
+			job.FinishedAt = finishedAt.Time
+		}
+		jobs = append(jobs, job)
+	}
+
+	sort.Slice(jobs, func(i, j int) bool {
+		return jobs[i].CreatedAt.After(jobs[j].CreatedAt)
+	})
+	return jobs
+}
+
+func (s *PostgresStore) UpdateScan(id string, update ScanUpdate) (ScanJob, bool) {
+	current, ok := s.GetScan(id)
+	if !ok {
+		return ScanJob{}, false
+	}
+
+	if update.Status != "" {
+		current.Status = update.Status
+	}
+	if update.Progress >= 0 {
+		current.Progress = update.Progress
+	}
+	current.Stats = update.Stats
+	if update.StartedAt != nil {
+		current.StartedAt = *update.StartedAt
+	}
+	if update.FinishedAt != nil {
+		current.FinishedAt = *update.FinishedAt
+	}
+
+	optionsJSON, err := json.Marshal(current.Options)
+	if err != nil {
+		return ScanJob{}, false
+	}
+	statsJSON, err := json.Marshal(current.Stats)
+	if err != nil {
+		return ScanJob{}, false
+	}
+
+	var startedAt any
+	if !current.StartedAt.IsZero() {
+		startedAt = current.StartedAt
+	}
+	var finishedAt any
+	if !current.FinishedAt.IsZero() {
+		finishedAt = current.FinishedAt
+	}
+
+	query := `
+update scan_jobs
+set status = $2,
+    options = $3::jsonb,
+    progress = $4,
+    stats = $5::jsonb,
+    started_at = $6,
+    finished_at = $7
+where id = $1`
+	_, err = s.db.ExecContext(
+		context.Background(),
+		query,
+		id,
+		current.Status,
+		string(optionsJSON),
+		current.Progress,
+		string(statsJSON),
+		startedAt,
+		finishedAt,
+	)
+	if err != nil {
+		return ScanJob{}, false
+	}
+
+	return current, true
+}