spreadlab/internal/api/api.go
Justin Visser 9a392b1860 api: POST /api/scenario returns result plus graph topology (M3 slice 1)
One panel's whole world in one call: effective config in, echoed
config + cascade result + undirected edge list out. Edges are
[from, to] pairs with from < to in deterministic node order;
Graph.Edges() walks the adjacency once, GraphEdges(config) rebuilds
the seeded world (~25us) so Result stays lean and /api/comparison
stays untouched. This closes the topology gap the design brief
flagged; the frontend's seeded d3-force layout consumes these pairs.
Go bits: [][2]int is a slice of fixed-size arrays; [2]int is a value
type, comparable, and JSON-marshals to [a, b], exactly the wire
shape the spec asks for.
tygo regen includes a fix: engine.Strategy now maps to the generated
Strategy type instead of decaying to 'any' in ScenarioRequest.
Verified live through the dev stack: 7/120 reached, 351 edges.
2026-06-10 15:48:48 +02:00

122 lines
4.1 KiB
Go

// Package api exposes the engine over HTTP as a small JSON API. It stays
// thin on purpose: decode, run the engine, encode. All validation lives in
// the engine; the API only translates errors into status codes.
package api
import (
"encoding/json"
"fmt"
"net/http"
"github.com/JustinZeus/spreadlab/internal/engine"
)
// ComparisonResponse bundles what the dashboard needs to render one
// comparison: the config that was run, echoed back so frontend state stays
// honest, and one result per strategy.
type ComparisonResponse struct {
Config engine.Config `json:"config"`
Results []engine.Result `json:"results"`
}
// ScenarioRequest is the body of POST /api/scenario: one panel's effective
// config plus its strategy.
type ScenarioRequest struct {
Config engine.Config `json:"config"`
Strategy engine.Strategy `json:"strategy"`
}
// ScenarioResponse carries everything one dashboard panel needs: the
// echoed config, the cascade result, and the network topology as
// [from, to] node-index pairs (deterministic from the config's graph
// fields) for the frontend's force layout.
type ScenarioResponse struct {
Config engine.Config `json:"config"`
Result engine.Result `json:"result"`
Edges [][2]int `json:"edges"`
}
// errorResponse is the JSON shape of every non-2xx body.
type errorResponse struct {
Error string `json:"error"`
}
// NewServer returns the API as an http.Handler. Routes use the Go 1.22+
// pattern syntax, method and path in one string; the stdlib answers 405
// for wrong methods on a known path by itself.
func NewServer() http.Handler {
mux := http.NewServeMux()
mux.HandleFunc("GET /api/config/default", handleDefaultConfig)
mux.HandleFunc("POST /api/comparison", handleComparison)
mux.HandleFunc("POST /api/scenario", handleScenario)
return mux
}
func handleDefaultConfig(w http.ResponseWriter, _ *http.Request) {
writeJSON(w, http.StatusOK, engine.DefaultConfig())
}
func handleComparison(w http.ResponseWriter, r *http.Request) {
decoder := json.NewDecoder(r.Body)
decoder.DisallowUnknownFields() // a typo in a field name fails loudly
var config engine.Config
if err := decoder.Decode(&config); err != nil {
writeError(w, http.StatusBadRequest, fmt.Errorf("invalid config: %w", err))
return
}
strategies := engine.AllStrategies()
results := make([]engine.Result, 0, len(strategies))
for _, strategy := range strategies {
result, err := engine.RunScenario(config, strategy)
if err != nil {
// The engine only errors on bad parameter values, which is
// the client's mistake, not the server's.
writeError(w, http.StatusBadRequest, err)
return
}
results = append(results, result)
}
writeJSON(w, http.StatusOK, ComparisonResponse{Config: config, Results: results})
}
func handleScenario(w http.ResponseWriter, r *http.Request) {
decoder := json.NewDecoder(r.Body)
decoder.DisallowUnknownFields()
var request ScenarioRequest
if err := decoder.Decode(&request); err != nil {
writeError(w, http.StatusBadRequest, fmt.Errorf("invalid request: %w", err))
return
}
result, err := engine.RunScenario(request.Config, request.Strategy)
if err != nil {
writeError(w, http.StatusBadRequest, err)
return
}
// Building the graph again for its edges costs ~25us (seeded, so it is
// the identical world the scenario ran in).
edges, err := engine.GraphEdges(request.Config)
if err != nil {
writeError(w, http.StatusBadRequest, err)
return
}
writeJSON(w, http.StatusOK, ScenarioResponse{Config: request.Config, Result: result, Edges: edges})
}
// writeJSON marshals first and writes after, so an encoding failure can
// still become a clean 500 instead of a half-written body.
func writeJSON(w http.ResponseWriter, status int, payload any) {
body, err := json.Marshal(payload)
if err != nil {
http.Error(w, "encoding response failed", http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(status)
_, _ = w.Write(body) // a failed write means the client went away
}
func writeError(w http.ResponseWriter, status int, err error) {
writeJSON(w, status, errorResponse{Error: err.Error()})
}