An approval, ask or park can be resolved by an operator, a rule, a classifier or automatically, so the vocabulary stops naming a person: - step type human.approve -> workflow.approve - park class needs_human -> needs_decision (ParkNeedsDecision) - event kinds human_* -> operator_* - alert kind task.needs_human -> task.needs_decision - status grouping "needs you" -> "needs attention" 0061 rewrites the stored values, including the approval step type in the workflow-definitions resource and each task's pinned definition, with the digest recomputed so resumed tasks still match.
277 lines
9.5 KiB
Go
277 lines
9.5 KiB
Go
package modelloop
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"slices"
|
|
|
|
aicore "github.com/samcharles93/ai-sdk/core"
|
|
|
|
"github.com/samcharles93/archie-core/internal/agentexec"
|
|
"github.com/samcharles93/archie-core/internal/domain/agentrun"
|
|
"github.com/samcharles93/archie-core/internal/tools"
|
|
)
|
|
|
|
// ToolLimits are the tool result limits for one turn or stage. A negative
|
|
// limit means none.
|
|
type ToolLimits struct {
|
|
MaxResultChars int
|
|
SpillDir string
|
|
}
|
|
|
|
// EnsureSpillDir creates the spill directory if one is set.
|
|
func (l ToolLimits) EnsureSpillDir() error {
|
|
if l.SpillDir == "" {
|
|
return nil
|
|
}
|
|
// 0700: spill files are verbatim tool output and may hold anything the
|
|
// tools could read.
|
|
if err := os.MkdirAll(l.SpillDir, 0o700); err != nil {
|
|
return fmt.Errorf("create tool spill directory %s: %w", l.SpillDir, err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Options builds the tool-set options for a single turn or stage.
|
|
// There is no aggregate turn output budget; only per-result caps apply.
|
|
func (l ToolLimits) Options(excludeToolsets ...string) ToolSetOptions {
|
|
opts := ToolSetOptions{
|
|
MaxResultChars: l.MaxResultChars,
|
|
ExcludeToolsets: excludeToolsets,
|
|
SpillDir: l.SpillDir,
|
|
}
|
|
return opts
|
|
}
|
|
|
|
// ToolSetOptions bounds what a built tool set may do and return.
|
|
//
|
|
// The zero value builds every available tool with no result limits, which is
|
|
// the behaviour this package had before the options existed.
|
|
type ToolSetOptions struct {
|
|
// SpillDir receives complete results displaced by the per-tool cap. Empty
|
|
// selects inline truncation. There is deliberately no aggregate turn cap.
|
|
SpillDir string
|
|
|
|
// MaxResultChars caps a single tool result. Entries setting
|
|
// ToolEntry.MaxResultSizeChars override it. Zero or negative means no cap.
|
|
MaxResultChars int
|
|
|
|
// ExcludeToolsets omits entries whose ToolEntry.Toolset matches. Task
|
|
// agents use it to drop the chat workspace's file and shell tools, which
|
|
// are rooted at a directory that is not the task's worktree and which
|
|
// bypass the agent loop's read-only and protected-path enforcement.
|
|
ExcludeToolsets []string
|
|
|
|
// Approval is the operator-consent gate for tools marked RequiresApproval.
|
|
// Nil means no approver is configured — such tools are omitted from the
|
|
// built set rather than failing at call time.
|
|
Approval tools.ApprovalRequester
|
|
|
|
// OnToolCall, when non-nil, is notified once per completed tool call.
|
|
// LoopRunner populates it so a workflow stage can surface tool activity on
|
|
// the task timeline. Nil means no one is listening.
|
|
OnToolCall agentrun.ToolCallReporter
|
|
}
|
|
|
|
// reportToolCallCompletion notifies opts.OnToolCall, if set, of one
|
|
// completed call. Factored out of toolExecute's closure so the branching
|
|
// here doesn't add to that function's own cognitive-complexity budget.
|
|
func reportToolCallCompletion(opts ToolSetOptions, entry tools.ToolEntry, result string, err error) {
|
|
if opts.OnToolCall == nil {
|
|
return
|
|
}
|
|
outcome := result
|
|
if err != nil {
|
|
outcome = "error: " + err.Error()
|
|
}
|
|
opts.OnToolCall(agentrun.ToolCallReport{Tool: entry.Name, Detail: agentexec.ClipToolCallDetail(outcome), Failed: err != nil})
|
|
}
|
|
|
|
// resultLimit returns the cap that applies to one entry.
|
|
func (o ToolSetOptions) resultLimit(entry tools.ToolEntry) int {
|
|
if entry.MaxResultSizeChars != 0 {
|
|
return entry.MaxResultSizeChars
|
|
}
|
|
return o.MaxResultChars
|
|
}
|
|
|
|
// excludes reports whether an entry's toolset is omitted.
|
|
func (o ToolSetOptions) excludes(entry tools.ToolEntry) bool {
|
|
return slices.Contains(o.ExcludeToolsets, entry.Toolset)
|
|
}
|
|
|
|
// BuildToolSet converts reg's available entries into an ai-sdk ToolSet,
|
|
// translating JSON input and enforcing result limits. A nil registry returns
|
|
// an empty set.
|
|
func BuildToolSet(reg *tools.Registry, opts ToolSetOptions) (aicore.ToolSet, error) {
|
|
if reg == nil {
|
|
return aicore.ToolSet{}, nil
|
|
}
|
|
return BuildToolSetFrom(reg.All(), opts)
|
|
}
|
|
|
|
// BuildToolSetFrom is BuildToolSet over a slice of entries.
|
|
func BuildToolSetFrom(entries []tools.ToolEntry, opts ToolSetOptions) (aicore.ToolSet, error) {
|
|
set := aicore.ToolSet{}
|
|
for _, entry := range entries {
|
|
if opts.excludes(entry) {
|
|
continue
|
|
}
|
|
// A tool that requires approval must not appear in a set built without
|
|
// an approver: the model would see a tool it can never invoke. With an
|
|
// approver present the tool is built and the execute closure gates each
|
|
// call on the operator's decision.
|
|
if entry.Classification.IsApprovalRequired() && opts.Approval == nil {
|
|
continue
|
|
}
|
|
available, err := safeToolAvailable(entry)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("tool %s availability: %w", entry.Name, err)
|
|
}
|
|
if !available {
|
|
continue
|
|
}
|
|
schema, err := safeResolvedSchema(entry)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("tool %s schema: %w", entry.Name, err)
|
|
}
|
|
if schema == nil {
|
|
schema = tools.JSONSchema{
|
|
"type": "object",
|
|
"properties": map[string]any{},
|
|
}
|
|
}
|
|
params, err := json.Marshal(schema)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("tool %s schema: %w", entry.Name, err)
|
|
}
|
|
tool := aicore.NewTool(entry.Name, entry.Description, params, toolExecute(entry, opts))
|
|
tool.Concurrency = concurrency(entry.Classification)
|
|
set[entry.Name] = tool
|
|
}
|
|
return set, nil
|
|
}
|
|
|
|
// MaxParallelToolCalls bounds how many of one model step's tool calls run at
|
|
// once. Each tool's classification decides which calls may overlap.
|
|
const MaxParallelToolCalls = 8
|
|
|
|
// concurrency maps a classification to how a call may overlap others.
|
|
// Unclassified and approval-gated tools run alone: approvals are asked one
|
|
// at a time, and an unknown tool is never assumed safe.
|
|
func concurrency(class tools.ToolClassification) func(string) aicore.Concurrency {
|
|
switch {
|
|
case class.IsApprovalRequired():
|
|
return nil
|
|
case class.IsIdempotent():
|
|
return func(input string) aicore.Concurrency { return pathKeyed(input, true) }
|
|
case class.IsMutating():
|
|
return func(input string) aicore.Concurrency { return pathKeyed(input, false) }
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// pathKeyed orders calls per path argument, so a read and a write of one
|
|
// file keep the model's order. A call without a path runs in parallel when
|
|
// pathless is set and alone otherwise.
|
|
func pathKeyed(input string, pathless bool) aicore.Concurrency {
|
|
var args struct {
|
|
Path string `json:"path"`
|
|
}
|
|
if json.Unmarshal([]byte(input), &args) != nil || args.Path == "" {
|
|
return aicore.Concurrency{Parallel: pathless}
|
|
}
|
|
return aicore.Concurrency{Parallel: true, Key: filepath.Clean(args.Path)}
|
|
}
|
|
|
|
func safeToolAvailable(entry tools.ToolEntry) (available bool, err error) {
|
|
defer func() {
|
|
if recovered := recover(); recovered != nil {
|
|
err = fmt.Errorf("panic: %v", recovered)
|
|
}
|
|
}()
|
|
return entry.Available(), nil
|
|
}
|
|
|
|
func safeResolvedSchema(entry tools.ToolEntry) (schema tools.JSONSchema, err error) {
|
|
defer func() {
|
|
if recovered := recover(); recovered != nil {
|
|
err = fmt.Errorf("panic: %v", recovered)
|
|
}
|
|
}()
|
|
return entry.ResolvedSchema(), nil
|
|
}
|
|
|
|
// toolExecute adapts a ToolEntry's handler to an ai-sdk Execute and caps the
|
|
// marshalled result.
|
|
func toolExecute(entry tools.ToolEntry, opts ToolSetOptions) func(context.Context, string) (string, error) {
|
|
limit := opts.resultLimit(entry)
|
|
return func(ctx context.Context, input string) (result string, err error) {
|
|
defer func() { reportToolCallCompletion(opts, entry, result, err) }()
|
|
|
|
var args map[string]any
|
|
if input != "" {
|
|
if err := json.Unmarshal([]byte(input), &args); err != nil {
|
|
return "", fmt.Errorf("tool %s: decode input: %w", entry.Name, err)
|
|
}
|
|
}
|
|
if entry.Classification.IsApprovalRequired() {
|
|
if err := requireApproval(ctx, entry, opts, args); err != nil {
|
|
return "", err
|
|
}
|
|
}
|
|
out, err := entry.Handler(ctx, args)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
data, err := json.Marshal(out)
|
|
if err != nil {
|
|
return "", fmt.Errorf("tool %s: encode output: %w", entry.Name, err)
|
|
}
|
|
|
|
payload := tools.CapPayload(entry.Name, string(data), limit, opts.SpillDir)
|
|
return payload, nil
|
|
}
|
|
}
|
|
|
|
// requireApproval blocks until entry's approval is granted, returning an
|
|
// error if it is denied, times out, or the approver misbehaves.
|
|
func requireApproval(ctx context.Context, entry tools.ToolEntry, opts ToolSetOptions, args map[string]any) error {
|
|
if opts.Approval == nil {
|
|
return fmt.Errorf("tool %s requires approval but no approver is configured", entry.Name)
|
|
}
|
|
approveCtx, cancel := context.WithTimeout(ctx, tools.ToolApprovalTimeout)
|
|
defer cancel()
|
|
desc := entry.Description
|
|
if entry.BuildApprovalDescription != nil {
|
|
desc = entry.BuildApprovalDescription(args)
|
|
}
|
|
decision, err := opts.Approval.RequestApproval(approveCtx, entry.Name, desc)
|
|
if err != nil {
|
|
// A tool timeout is a plain error; a turn cancellation stays a context
|
|
// error.
|
|
if (errors.Is(err, context.DeadlineExceeded) || errors.Is(err, context.Canceled)) && ctx.Err() == nil {
|
|
return fmt.Errorf("tool %s: approval timed out after %v", entry.Name, tools.ToolApprovalTimeout)
|
|
}
|
|
return fmt.Errorf("tool %s: approval: %w", entry.Name, err)
|
|
}
|
|
switch decision {
|
|
case tools.ApprovalApproved, tools.ApprovalPermanentlyApproved:
|
|
// PermanentlyApproved is handled by the adapter caching the
|
|
// decision; the dispatch layer treats both the same.
|
|
return nil
|
|
case tools.ApprovalDenied:
|
|
return fmt.Errorf("tool %s: %w", entry.Name, tools.ErrApprovalDenied)
|
|
default:
|
|
// Fail closed: an unrecognised decision value from a faulty or
|
|
// future Approver must not execute the tool. ApprovalDecision is
|
|
// an exported int type, so a value returned with nil error is a
|
|
// defect in the approver, not a grant.
|
|
return fmt.Errorf("tool %s: approval returned unexpected decision %v", entry.Name, decision)
|
|
}
|
|
}
|