Improve D&D validation reliability
This commit is contained in:
@@ -14,7 +14,7 @@ import (
|
||||
const (
|
||||
Key = "extract/dnd/combat-turns/shape"
|
||||
ReasonCode = "invalid_combat_turn_shape"
|
||||
policy = "dnd.combat_turns.validator.shape.v1"
|
||||
policy = "dnd.combat_turns.validator.shape.v2"
|
||||
)
|
||||
|
||||
type Options struct{}
|
||||
@@ -33,38 +33,48 @@ func (v *Validator) CheckpointFingerprints() []pipeline.CheckpointFingerprint {
|
||||
}
|
||||
|
||||
func (v *Validator) Validate(_ context.Context, req contracts.TypedValidationRequest[dnd.CombatTurnList]) (contracts.ValidationResult, error) {
|
||||
if err := Validate(req.Value); err != nil {
|
||||
return rejection(err.Error()), nil
|
||||
issues, corrections := assess(req.Value)
|
||||
if len(issues) != 0 {
|
||||
return rejection(
|
||||
diagnostics.Aggregate("invalid combat turn shape", issues),
|
||||
corrections.Guidance("Correct every rejected combat turn and return the complete replacement combat-turn list"),
|
||||
), nil
|
||||
}
|
||||
return contracts.ValidationResult{Approved: true}, nil
|
||||
}
|
||||
|
||||
func Validate(value dnd.CombatTurnList) error {
|
||||
issues := issuesFor(value)
|
||||
issues, _ := assess(value)
|
||||
if len(issues) == 0 {
|
||||
return nil
|
||||
}
|
||||
return fmt.Errorf("%s", diagnostics.Aggregate("invalid combat turn shape", issues))
|
||||
}
|
||||
|
||||
func issuesFor(value dnd.CombatTurnList) []string {
|
||||
func assess(value dnd.CombatTurnList) ([]string, diagnostics.Corrections) {
|
||||
var corrections diagnostics.Corrections
|
||||
if value.CombatTurns == nil {
|
||||
return []string{"combat_turns must be present"}
|
||||
corrections.Add("list", "Return a `combat_turns` array; use an empty array when the scene contains no combat turns.", "")
|
||||
return []string{"combat_turns must be present"}, corrections
|
||||
}
|
||||
issues := make([]string, 0)
|
||||
for turnIndex, turn := range value.CombatTurns {
|
||||
prefix := fmt.Sprintf("combat_turns[%d]", turnIndex)
|
||||
record := fmt.Sprintf("Affected %s for actor %s %s.", diagnostics.Quote(string(turn.TurnKind)), diagnostics.Quote(strings.TrimSpace(turn.Actor)), diagnostics.SourceRange(turn.SourceRefs))
|
||||
if strings.TrimSpace(turn.Actor) == "" {
|
||||
issues = append(issues, prefix+".actor must not be empty: "+diagnostics.Quote(turn.Actor))
|
||||
corrections.Add("actor", "Provide the contextual combatant name for every combat turn.", record)
|
||||
}
|
||||
if !validTurnKind(turn.TurnKind) {
|
||||
issues = append(issues, prefix+".turn_kind is unsupported: "+diagnostics.Quote(string(turn.TurnKind)))
|
||||
corrections.Add("kind", "Set `turn_kind` to exactly one of `turn`, `reaction`, `legendary_action`, `lair_action`, or `other`.", record)
|
||||
}
|
||||
if len(turn.SourceRefs) == 0 {
|
||||
issues = append(issues, prefix+".source_refs must contain at least one reference")
|
||||
corrections.Add("source-refs", "Provide at least one transcript source range that directly supports every combat turn.", record)
|
||||
}
|
||||
}
|
||||
return issues
|
||||
return issues, corrections
|
||||
}
|
||||
|
||||
func validTurnKind(value dnd.CombatTurnKind) bool {
|
||||
@@ -99,6 +109,6 @@ func DecodeOptions(options map[string]any) (Options, error) {
|
||||
|
||||
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, CorrectionGuidance: "Return a complete combat-turn list with every required field present, valid combatant names, and valid source references."}
|
||||
func rejection(message, guidance string) contracts.ValidationResult {
|
||||
return contracts.ValidationResult{Approved: false, ReasonCode: ReasonCode, Message: message, CorrectionGuidance: guidance}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user