notarius/internal/modules/dnd/validate/itemregistry/source_refs/validator.go

// Package sourcerefs validates item citations against the current source.
package sourcerefs

import (
	"context"
	"fmt"

	"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"
	"gitea.maximumdirect.net/eric/notarius/internal/modules/dnd/shared/diagnostics"
	itemshape "gitea.maximumdirect.net/eric/notarius/internal/modules/dnd/validate/itemregistry/shape"
)

const (
	Key        = "extract/dnd/item-registry/source_refs"
	ReasonCode = "invalid_item_source_refs"
	policy     = "dnd.item_registry.validator.source_refs.v1"
)

type Options struct{}
type Validator struct{}

var _ contracts.TypedValidator[dnd.ItemRegistry] = (*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.ItemRegistry]) (contracts.ValidationResult, error) {
	if req.Stage == string(pipeline.StageExtract) && req.Chunk == nil {
		return contracts.ValidationResult{}, fmt.Errorf("item source-reference validator requires the current extraction chunk")
	}
	if err := itemshape.Validate(req.Value); err != nil {
		return contracts.ValidationResult{Approved: true}, nil
	}
	index := source.NewDocumentIndex(req.Source)
	issues := make([]string, 0)
	for itemIndex, item := range req.Value.Items {
		for refIndex, ref := range item.SourceRefs {
			if err := index.ValidateRef(ref); err != nil {
				issues = append(issues, fmt.Sprintf("items[%d].source_refs[%d]: %s", itemIndex, refIndex, diagnostics.Truncate(err.Error())))
				continue
			}
			if req.Stage == string(pipeline.StageExtract) && !chunkContainsRef(req.Chunk, ref) {
				issues = append(issues, fmt.Sprintf("items[%d].source_refs[%d]: source reference is outside the current extraction chunk", itemIndex, refIndex))
			}
		}
	}
	if len(issues) == 0 {
		return contracts.ValidationResult{Approved: true}, nil
	}
	return rejection(diagnostics.Aggregate("invalid item source references", issues)), nil
}

func chunkContainsRef(chunk *source.Chunk, ref source.SourceRef) bool {
	if chunk == nil || ref.SourceID != chunk.SourceID {
		return false
	}
	startFound := false
	endFound := false
	for _, unit := range chunk.Units {
		startFound = startFound || unit.ID == ref.StartUnitID
		endFound = endFound || unit.ID == ref.EndUnitID
	}
	return startFound && endFound
}

func Spec() pipeline.ValidatorSpec {
	return pipeline.ValidatorSpec{Key: Key, ExecutionClass: contracts.ExecutionClassDeterministic}
}

func Register(registry *pipeline.ValidatorRegistry) error {
	return pipeline.RegisterTypedValidatorBuilder(registry, dnd.ItemRegistryKind, Spec(), validateOptions, func(request pipeline.BuildRequest) (contracts.TypedValidator[dnd.ItemRegistry], 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, CorrectionGuidance: "Return registry items whose source references identify valid transcript ranges within the supplied extraction chunk and directly support each named item."}
}