Add D&D NPC extraction and validation

internal/modules/dnd/validate/npcs/shape/validator.go

@@ -0,0 +1,121 @@
+package shape
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"gitea.maximumdirect.net/eric/notarius/internal/framework/contracts"
+	"gitea.maximumdirect.net/eric/notarius/internal/framework/pipeline"
+	"gitea.maximumdirect.net/eric/notarius/internal/modules/dnd"
+	"gitea.maximumdirect.net/eric/notarius/internal/modules/dnd/validate/npcs/diagnostics"
+)
+
+const (
+	Key        = "extract/dnd/npcs/shape"
+	ReasonCode = "invalid_npc_shape"
+	policy     = "dnd.npcs.validator.shape.v1"
+)
+
+type Options struct{}
+type Validator struct{}
+
+var _ contracts.TypedValidator[dnd.NPCList] = (*Validator)(nil)
+var _ pipeline.CheckpointFingerprintProvider = (*Validator)(nil)
+
+func New(Options) *Validator      { return &Validator{} }
+func (v *Validator) Name() string { return Key }
+func (v *Validator) ExecutionClass() contracts.ExecutionClass {
+	return contracts.ExecutionClassDeterministic
+}
+func (v *Validator) CheckpointFingerprints() []pipeline.CheckpointFingerprint {
+	return []pipeline.CheckpointFingerprint{{Name: "policy", Value: policy}}
+}
+
+func (v *Validator) Validate(_ context.Context, req contracts.TypedValidationRequest[dnd.NPCList]) (contracts.ValidationResult, error) {
+	issues := issuesFor(req.Value)
+	if len(issues) > 0 {
+		return rejection(diagnostics.Aggregate("invalid NPC shape", issues)), nil
+	}
+	return contracts.ValidationResult{Approved: true}, nil
+}
+
+func Validate(value dnd.NPCList) error {
+	issues := issuesFor(value)
+	if len(issues) == 0 {
+		return nil
+	}
+	return fmt.Errorf("%s", diagnostics.Aggregate("invalid NPC shape", issues))
+}
+
+func issuesFor(value dnd.NPCList) []string {
+	issues := make([]string, 0)
+	if value.NPCs == nil {
+		return []string{"npcs must be present"}
+	}
+	for index, npc := range value.NPCs {
+		prefix := fmt.Sprintf("npcs[%d]", index)
+		if strings.TrimSpace(npc.ID) == "" {
+			issues = append(issues, prefix+".id must not be empty")
+		}
+		if strings.TrimSpace(npc.Name) == "" {
+			issues = append(issues, prefix+".name must not be empty")
+		}
+		if npc.Aliases == nil {
+			issues = append(issues, prefix+".aliases must be present")
+		} else {
+			for aliasIndex, alias := range npc.Aliases {
+				if strings.TrimSpace(alias) == "" {
+					issues = append(issues, fmt.Sprintf("%s.aliases[%d] must not be empty: %s", prefix, aliasIndex, diagnostics.Quote(alias)))
+				}
+			}
+		}
+		if strings.TrimSpace(npc.Description) == "" {
+			issues = append(issues, prefix+".description must not be empty")
+		}
+		if npc.Relationships == nil {
+			issues = append(issues, prefix+".relationships must be present")
+		} else {
+			for relationshipIndex, relationship := range npc.Relationships {
+				relationshipPrefix := fmt.Sprintf("%s.relationships[%d]", prefix, relationshipIndex)
+				if strings.TrimSpace(relationship.Target) == "" {
+					issues = append(issues, relationshipPrefix+".target must not be empty: "+diagnostics.Quote(relationship.Target))
+				}
+				if strings.TrimSpace(relationship.Relationship) == "" {
+					issues = append(issues, relationshipPrefix+".relationship must not be empty: "+diagnostics.Quote(relationship.Relationship))
+				}
+			}
+		}
+		if len(npc.SourceRefs) == 0 {
+			issues = append(issues, prefix+".source_refs must not be empty")
+		}
+	}
+	return issues
+}
+
+func Spec() pipeline.ValidatorSpec {
+	return pipeline.ValidatorSpec{Key: Key, ExecutionClass: contracts.ExecutionClassDeterministic}
+}
+
+func Register(registry *pipeline.ValidatorRegistry) error {
+	return pipeline.RegisterTypedValidatorBuilder(registry, dnd.NPCListKind, Spec(), validateOptions, func(request pipeline.BuildRequest) (contracts.TypedValidator[dnd.NPCList], error) {
+		options, err := DecodeOptions(request.Options)
+		if err != nil {
+			return nil, err
+		}
+		return New(options), nil
+	})
+}
+
+func DecodeOptions(options map[string]any) (Options, error) {
+	if err := pipeline.RejectUnknownOptions(options); err != nil {
+		return Options{}, err
+	}
+	return Options{}, nil
+}
+
+func validateOptions(options map[string]any) error { _, err := DecodeOptions(options); return err }
+
+func rejection(message string) contracts.ValidationResult {
+	return contracts.ValidationResult{Approved: false, ReasonCode: ReasonCode, Message: message}
+}

internal/modules/dnd/validate/npcs/shape/validator_test.go

@@ -0,0 +1,92 @@
+package shape
+
+import (
+	"context"
+	"strings"
+	"testing"
+	"unicode/utf8"
+
+	"gitea.maximumdirect.net/eric/notarius/internal/core/source"
+	"gitea.maximumdirect.net/eric/notarius/internal/framework/contracts"
+	"gitea.maximumdirect.net/eric/notarius/internal/framework/pipeline"
+	"gitea.maximumdirect.net/eric/notarius/internal/modules/dnd"
+)
+
+func TestValidatorApprovesWellFormedNPCPayload(t *testing.T) {
+	result, err := New(Options{}).Validate(context.Background(), requestWithValue(validNPCList()))
+	if err != nil || !result.Approved {
+		t.Fatalf("Validate() = %#v, %v; want approval", result, err)
+	}
+}
+
+func TestValidatorRejectsRequiredShapeValues(t *testing.T) {
+	value := validNPCList()
+	value.NPCs[0].Aliases = nil
+	result, err := New(Options{}).Validate(context.Background(), requestWithValue(value))
+	if err != nil || result.Approved || result.ReasonCode != ReasonCode || !strings.Contains(result.Message, "aliases must be present") {
+		t.Fatalf("Validate() = %#v, %v; want bounded shape rejection", result, err)
+	}
+
+	missing := dnd.NPCList{}
+	result, err = New(Options{}).Validate(context.Background(), requestWithValue(missing))
+	if err != nil || result.Approved || result.ReasonCode != ReasonCode {
+		t.Fatalf("missing Validate() = %#v, %v; want shape rejection", result, err)
+	}
+}
+
+func TestValidatorBoundsDiagnosticsAndQuotesUnicode(t *testing.T) {
+	value := dnd.NPCList{NPCs: make([]dnd.NPC, 24)}
+	long := strings.Repeat("火", 220) + "\n\t"
+	for index := range value.NPCs {
+		value.NPCs[index] = dnd.NPC{ID: "candidate", Name: long, Aliases: []string{"\n\t"}, Description: "", Relationships: []dnd.NPCRelationship{{Target: " ", Relationship: " "}}, SourceRefs: []source.SourceRef{}}
+	}
+	result, err := New(Options{}).Validate(context.Background(), requestWithValue(value))
+	if err != nil || result.Approved || len([]byte(result.Message)) > diagnosticsMaxMessageBytes || !utf8.ValidString(result.Message) {
+		t.Fatalf("Validate() = %#v, %v; want bounded valid UTF-8 rejection", result, err)
+	}
+	if strings.Count(result.Message, "npcs[") > diagnosticsMaxIssues || !strings.Contains(result.Message, "additional issue(s) omitted") || !strings.Contains(result.Message, `\n\t`) {
+		t.Fatalf("message = %q, want bounded quoted diagnostics", result.Message)
+	}
+}
+
+func TestValidatorSpecCheckpointAndRegistration(t *testing.T) {
+	if got := New(Options{}).CheckpointFingerprints(); len(got) != 1 || got[0].Name != "policy" || got[0].Value != "dnd.npcs.validator.shape.v1" {
+		t.Fatalf("CheckpointFingerprints() = %#v, want local policy", got)
+	}
+	if spec := Spec(); spec.Key != Key || spec.ExecutionClass != contracts.ExecutionClassDeterministic {
+		t.Fatalf("Spec() = %#v, want deterministic shape validator", spec)
+	}
+	registry := pipeline.NewValidatorRegistry()
+	if err := Register(registry); err != nil {
+		t.Fatalf("Register() error = %v", err)
+	}
+	if _, err := DecodeOptions(map[string]any{"unexpected": true}); err == nil {
+		t.Fatal("DecodeOptions() accepted unknown option")
+	}
+}
+
+func TestValidatorDoesNotMutateValue(t *testing.T) {
+	value := validNPCList()
+	before := value
+	_, err := New(Options{}).Validate(context.Background(), requestWithValue(value))
+	if err != nil || value.NPCs[0].Aliases[0] != before.NPCs[0].Aliases[0] {
+		t.Fatalf("Validate() mutated value: %#v", value)
+	}
+}
+
+func requestWithValue(value dnd.NPCList) contracts.TypedValidationRequest[dnd.NPCList] {
+	return contracts.TypedValidationRequest[dnd.NPCList]{Value: value}
+}
+
+func validNPCList() dnd.NPCList {
+	return dnd.NPCList{NPCs: []dnd.NPC{{
+		ID: "candidate", Name: "Mira Thorn", Aliases: []string{"The Greencloak"}, Description: "A guarded ranger.",
+		Relationships: []dnd.NPCRelationship{{Target: "Captain Vale", Relationship: "reports to"}},
+		SourceRefs:    []source.SourceRef{{SourceID: "session", StartUnitID: 1, EndUnitID: 1}},
+	}}}
+}
+
+const (
+	diagnosticsMaxIssues       = 20
+	diagnosticsMaxMessageBytes = 4096
+)