feat(go): M5.1 — hand-author /api/* wire types + JSON Schemas
All checks were successful
Deploy to K8s / deploy (push) Successful in 7s
All checks were successful
Deploy to K8s / deploy (push) Successful in 7s
Add internal/web/api package with Go structs for every /api/X route:
AdultsResponse, JuniorsResponse, PaymentsResponse, VersionResponse.
All fields carry explicit json: tags matching the Python view-model keys.
Key design choices:
- member_data / month_labels / raw_payments are nested objects (not
the pre-serialised JSON strings used in Jinja templates)
- Expected{Value int; Unknown bool} with custom MarshalJSON emits int
or the string "?" for junior single-attendance months
- RawTransaction covers the full 11-column payments sheet row
schemagen_test.go reflects all four response types via
github.com/invopop/jsonschema and golden-compares against committed
schemas in tests/fixtures/api-schema/. The JSONSchema() method on
Expected lives in the test file so the prod binary has no jsonschema
dependency.
Closes M5.1 in docs/plans/2026-05-03-2349-go-backend-rewrite-progress.md.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
42
go/internal/web/api/adults.go
Normal file
42
go/internal/web/api/adults.go
Normal file
@@ -0,0 +1,42 @@
|
||||
package api
|
||||
|
||||
// AdultsMonthData is the reconciled ledger for one adult member in one month.
|
||||
// Keys match Python's result["members"][name]["months"][YYYY-MM].
|
||||
type AdultsMonthData struct {
|
||||
Expected int `json:"expected"`
|
||||
OriginalExpected int `json:"original_expected"`
|
||||
AttendanceCount int `json:"attendance_count"`
|
||||
Exception *ExceptionData `json:"exception"`
|
||||
Paid float64 `json:"paid"` // float: proportional allocator may produce fractional CZK
|
||||
Transactions []MemberTxEntry `json:"transactions"`
|
||||
}
|
||||
|
||||
// AdultsMemberData is the reconciled ledger for one adult member.
|
||||
// Keys match Python's result["members"][name].
|
||||
type AdultsMemberData struct {
|
||||
Tier string `json:"tier"`
|
||||
Months map[string]AdultsMonthData `json:"months"` // YYYY-MM → month data
|
||||
OtherTransactions []MemberOtherEntry `json:"other_transactions"`
|
||||
TotalBalance int `json:"total_balance"`
|
||||
}
|
||||
|
||||
// AdultsResponse is the JSON contract for GET /api/adults.
|
||||
// MemberData, MonthLabels, and RawPayments correspond to the Python view-model
|
||||
// fields member_data, month_labels_json, and raw_payments_json respectively,
|
||||
// but as nested objects rather than pre-serialised JSON strings.
|
||||
type AdultsResponse struct {
|
||||
Months []string `json:"months"` // display labels
|
||||
RawMonths []string `json:"raw_months"` // "YYYY-MM"
|
||||
Results []MemberRow `json:"results"`
|
||||
Totals []TotalCell `json:"totals"`
|
||||
MemberData map[string]AdultsMemberData `json:"member_data"` // name → ledger
|
||||
MonthLabels map[string]string `json:"month_labels"` // YYYY-MM → display label
|
||||
RawPayments map[string][]RawTransaction `json:"raw_payments"` // name → raw sheet rows
|
||||
Credits []Credit `json:"credits"`
|
||||
Debts []Credit `json:"debts"`
|
||||
Unmatched []RawTransaction `json:"unmatched"`
|
||||
AttendanceURL string `json:"attendance_url"`
|
||||
PaymentsURL string `json:"payments_url"`
|
||||
BankAccount string `json:"bank_account"`
|
||||
CurrentMonth string `json:"current_month"`
|
||||
}
|
||||
41
go/internal/web/api/juniors.go
Normal file
41
go/internal/web/api/juniors.go
Normal file
@@ -0,0 +1,41 @@
|
||||
package api
|
||||
|
||||
// JuniorsMonthData is the reconciled ledger for one junior member in one month.
|
||||
// expected and original_expected may be the "?" sentinel (single-attendance month
|
||||
// requiring manual review); they are carried via the Expected type.
|
||||
type JuniorsMonthData struct {
|
||||
Expected Expected `json:"expected"`
|
||||
OriginalExpected Expected `json:"original_expected"`
|
||||
AttendanceCount int `json:"attendance_count"`
|
||||
Exception *ExceptionData `json:"exception"`
|
||||
Paid float64 `json:"paid"`
|
||||
Transactions []MemberTxEntry `json:"transactions"`
|
||||
}
|
||||
|
||||
// JuniorsMemberData is the reconciled ledger for one junior member.
|
||||
type JuniorsMemberData struct {
|
||||
Tier string `json:"tier"`
|
||||
Months map[string]JuniorsMonthData `json:"months"`
|
||||
OtherTransactions []MemberOtherEntry `json:"other_transactions"`
|
||||
TotalBalance int `json:"total_balance"`
|
||||
}
|
||||
|
||||
// JuniorsResponse is the JSON contract for GET /api/juniors.
|
||||
// Same outer shape as AdultsResponse; differs in that member_data carries
|
||||
// Expected (int or "?") for expected/original_expected fields.
|
||||
type JuniorsResponse struct {
|
||||
Months []string `json:"months"`
|
||||
RawMonths []string `json:"raw_months"`
|
||||
Results []MemberRow `json:"results"`
|
||||
Totals []TotalCell `json:"totals"`
|
||||
MemberData map[string]JuniorsMemberData `json:"member_data"`
|
||||
MonthLabels map[string]string `json:"month_labels"`
|
||||
RawPayments map[string][]RawTransaction `json:"raw_payments"`
|
||||
Credits []Credit `json:"credits"`
|
||||
Debts []Credit `json:"debts"`
|
||||
Unmatched []RawTransaction `json:"unmatched"`
|
||||
AttendanceURL string `json:"attendance_url"`
|
||||
PaymentsURL string `json:"payments_url"`
|
||||
BankAccount string `json:"bank_account"`
|
||||
CurrentMonth string `json:"current_month"`
|
||||
}
|
||||
9
go/internal/web/api/payments.go
Normal file
9
go/internal/web/api/payments.go
Normal file
@@ -0,0 +1,9 @@
|
||||
package api
|
||||
|
||||
// PaymentsResponse is the JSON contract for GET /api/payments.
|
||||
type PaymentsResponse struct {
|
||||
GroupedPayments map[string][]RawTransaction `json:"grouped_payments"` // person name → rows
|
||||
SortedPeople []string `json:"sorted_people"`
|
||||
AttendanceURL string `json:"attendance_url"`
|
||||
PaymentsURL string `json:"payments_url"`
|
||||
}
|
||||
81
go/internal/web/api/schemagen_test.go
Normal file
81
go/internal/web/api/schemagen_test.go
Normal file
@@ -0,0 +1,81 @@
|
||||
package api
|
||||
|
||||
// schemagen_test.go generates and golden-compares JSON Schema files for every
|
||||
// /api/X response type.
|
||||
//
|
||||
// Normal run (CI): go test ./internal/web/api/... — asserts schemas match committed files.
|
||||
// Regenerate: go test -run TestGenerateSchemas -update ./internal/web/api/...
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"flag"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/invopop/jsonschema"
|
||||
)
|
||||
|
||||
var updateFlag = flag.Bool("update", false, "overwrite api-schema fixture files with freshly generated schemas")
|
||||
|
||||
// JSONSchema makes Expected self-describing for the reflector at test time.
|
||||
// The method is in a test file and is not compiled into production binaries.
|
||||
// It emits oneOf [integer, "?"] to match the custom MarshalJSON behaviour.
|
||||
func (Expected) JSONSchema() *jsonschema.Schema {
|
||||
return &jsonschema.Schema{
|
||||
OneOf: []*jsonschema.Schema{
|
||||
{Type: "integer"},
|
||||
{Enum: []any{"?"}},
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func TestGenerateSchemas(t *testing.T) {
|
||||
r := &jsonschema.Reflector{
|
||||
AllowAdditionalProperties: false,
|
||||
}
|
||||
|
||||
cases := []struct {
|
||||
name string
|
||||
val any
|
||||
}{
|
||||
{"adults", &AdultsResponse{}},
|
||||
{"juniors", &JuniorsResponse{}},
|
||||
{"payments", &PaymentsResponse{}},
|
||||
{"version", &VersionResponse{}},
|
||||
}
|
||||
|
||||
for _, tc := range cases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
schema := r.Reflect(tc.val)
|
||||
|
||||
got, err := json.MarshalIndent(schema, "", " ")
|
||||
if err != nil {
|
||||
t.Fatalf("marshal schema: %v", err)
|
||||
}
|
||||
got = append(got, '\n')
|
||||
|
||||
// Path: go/internal/web/api/ → ../../.. → go/ → tests/fixtures/api-schema/
|
||||
path := filepath.Join("..", "..", "..", "tests", "fixtures", "api-schema", tc.name+".schema.json")
|
||||
|
||||
if *updateFlag {
|
||||
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||
t.Fatalf("mkdir: %v", err)
|
||||
}
|
||||
if err := os.WriteFile(path, got, 0o644); err != nil {
|
||||
t.Fatalf("write schema: %v", err)
|
||||
}
|
||||
t.Logf("wrote %s", path)
|
||||
return
|
||||
}
|
||||
|
||||
want, err := os.ReadFile(path)
|
||||
if err != nil {
|
||||
t.Fatalf("read fixture %s: %v (re-run with -update to generate)", path, err)
|
||||
}
|
||||
if string(got) != string(want) {
|
||||
t.Errorf("schema mismatch for %s; re-run with -update to regenerate", tc.name)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
122
go/internal/web/api/types.go
Normal file
122
go/internal/web/api/types.go
Normal file
@@ -0,0 +1,122 @@
|
||||
// Package api defines wire types for the JSON API contract (/api/...).
|
||||
// These structs have explicit json: tags matching the Python view-model dict
|
||||
// keys so that M5 parity tests can do byte-equal comparison between backends.
|
||||
//
|
||||
// The three Python template-only JSON-string fields (member_data,
|
||||
// month_labels_json, raw_payments_json) are represented here as nested objects;
|
||||
// the Python /api/X shadow endpoint strips the json.dumps wrappers before
|
||||
// serialising.
|
||||
package api
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// Expected holds a junior fee expectation: either a concrete integer or the
|
||||
// "?" sentinel (single-attendance month requiring manual review).
|
||||
// MarshalJSON emits the integer or the JSON string "?".
|
||||
type Expected struct {
|
||||
Value int
|
||||
Unknown bool
|
||||
}
|
||||
|
||||
func (e Expected) MarshalJSON() ([]byte, error) {
|
||||
if e.Unknown {
|
||||
return []byte(`"?"`), nil
|
||||
}
|
||||
return json.Marshal(e.Value)
|
||||
}
|
||||
|
||||
func (e *Expected) UnmarshalJSON(data []byte) error {
|
||||
if len(data) > 0 && data[0] == '"' {
|
||||
var s string
|
||||
if err := json.Unmarshal(data, &s); err != nil {
|
||||
return err
|
||||
}
|
||||
if s == "?" {
|
||||
e.Unknown = true
|
||||
return nil
|
||||
}
|
||||
return fmt.Errorf("api.Expected: unexpected string %q", s)
|
||||
}
|
||||
e.Unknown = false
|
||||
return json.Unmarshal(data, &e.Value)
|
||||
}
|
||||
|
||||
// ExceptionData is a manual fee override for one member in one month.
|
||||
type ExceptionData struct {
|
||||
Amount int `json:"amount"`
|
||||
Note string `json:"note"`
|
||||
}
|
||||
|
||||
// MemberTxEntry is one payment allocation to a member+month, as stored in
|
||||
// member_data.months[YYYY-MM].transactions.
|
||||
type MemberTxEntry struct {
|
||||
Amount float64 `json:"amount"`
|
||||
Date string `json:"date"`
|
||||
Sender string `json:"sender"`
|
||||
Message string `json:"message"`
|
||||
Confidence string `json:"confidence"`
|
||||
}
|
||||
|
||||
// MemberOtherEntry is an "other:…" purpose payment allocated to a member.
|
||||
type MemberOtherEntry struct {
|
||||
Amount float64 `json:"amount"`
|
||||
Date string `json:"date"`
|
||||
Sender string `json:"sender"`
|
||||
Message string `json:"message"`
|
||||
Purpose string `json:"purpose"`
|
||||
Confidence string `json:"confidence"`
|
||||
}
|
||||
|
||||
// RawTransaction is a full payments-sheet row.
|
||||
// Used for unmatched transactions and raw_payments groupings.
|
||||
// Columns match the sheet layout: Date|Amount|manual fix|Person|Purpose|
|
||||
// Inferred Amount|Sender|VS|Message|Bank ID|Sync ID.
|
||||
type RawTransaction struct {
|
||||
Date string `json:"date"`
|
||||
Amount float64 `json:"amount"`
|
||||
ManualFix string `json:"manual_fix"`
|
||||
Person string `json:"person"`
|
||||
Purpose string `json:"purpose"`
|
||||
InferredAmount float64 `json:"inferred_amount"`
|
||||
Sender string `json:"sender"`
|
||||
VS string `json:"vs"`
|
||||
Message string `json:"message"`
|
||||
BankID string `json:"bank_id"`
|
||||
SyncID string `json:"sync_id"`
|
||||
}
|
||||
|
||||
// MonthCell is one cell in a member's month column on the dashboard.
|
||||
type MonthCell struct {
|
||||
Text string `json:"text"`
|
||||
Overridden bool `json:"overridden"`
|
||||
Status string `json:"status"` // "empty"|"ok"|"partial"|"unpaid"|"surplus"
|
||||
Amount int `json:"amount"`
|
||||
Month string `json:"month"` // display label, e.g. "Apr+May 2025"
|
||||
RawMonth string `json:"raw_month"` // "YYYY-MM"
|
||||
Tooltip string `json:"tooltip"`
|
||||
}
|
||||
|
||||
// TotalCell is one cell in the monthly totals row.
|
||||
type TotalCell struct {
|
||||
Text string `json:"text"`
|
||||
Status string `json:"status"`
|
||||
}
|
||||
|
||||
// MemberRow is one member's summary row in the dashboard results table.
|
||||
type MemberRow struct {
|
||||
Name string `json:"name"`
|
||||
Months []MonthCell `json:"months"`
|
||||
Balance int `json:"balance"`
|
||||
UnpaidPeriods string `json:"unpaid_periods"`
|
||||
RawUnpaidPeriods string `json:"raw_unpaid_periods"`
|
||||
PayableAmount int `json:"payable_amount"`
|
||||
}
|
||||
|
||||
// Credit is one entry in the credits or debts lists.
|
||||
type Credit struct {
|
||||
Name string `json:"name"`
|
||||
Amount int `json:"amount"`
|
||||
}
|
||||
9
go/internal/web/api/version.go
Normal file
9
go/internal/web/api/version.go
Normal file
@@ -0,0 +1,9 @@
|
||||
package api
|
||||
|
||||
// VersionResponse is the JSON contract for GET /api/version.
|
||||
// Keys match Python's BUILD_META dict (see app.py).
|
||||
type VersionResponse struct {
|
||||
Tag string `json:"tag"`
|
||||
Commit string `json:"commit"`
|
||||
BuildDate string `json:"build_date"`
|
||||
}
|
||||
Reference in New Issue
Block a user