Files
probo/pkg/agent/errors.go
Aurélien Sibiril 0f1d893668 Tighten ctx-suspend plumbing and trim docs
Address review feedback:

- Move ErrSuspendForCheckpoint from checkpoint.go to errors.go
  next to the rest of the agent error declarations; drop the
  colon in the error string so it matches the existing
  `agent run <event>` style used by the supervisor sentinels.
- Replace the inline `outerCtx := ctx; ctx = context.WithoutCancel(ctx)`
  pattern with a small `suspendShield` helper in context.go used
  by coreLoop, resumeWithOpts, and resumeNested. Reads more
  cleanly and stops surfacing the WithoutCancel mechanism at
  every call site.
- Trim the doc comments on Run, RunStreamed, Resume, Restore, the
  ErrSuspendForCheckpoint declaration, and the saveCtx comment in
  restoreNestedSuspended down to the contract bullet.

Signed-off-by: Aurélien Sibiril <81782+aureliensibiril@users.noreply.github.com>
2026-05-08 13:02:52 +02:00

109 lines
3.0 KiB
Go

// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package agent
import (
"errors"
"fmt"
"go.probo.inc/probo/pkg/llm"
)
// ErrSuspendForCheckpoint is the cancel cause to use when the caller
// wants the agent loop to gracefully suspend.
var ErrSuspendForCheckpoint = errors.New("agent run graceful suspend requested")
type (
MaxTurnsExceededError struct {
MaxTurns int
}
MaxToolDepthExceededError struct {
MaxDepth int
}
InputGuardrailTrippedError struct {
Guardrail string
Message string
}
OutputGuardrailTrippedError struct {
Guardrail string
Message string
}
InterruptedError struct {
ToolCalls []llm.ToolCall
PendingApprovals []llm.ToolCall
Agent *Agent
Messages []llm.Message
Usage llm.Usage
Turns int
outerState *outerLoopState
}
needsApprovalError struct {
allToolCalls []llm.ToolCall
pendingApprovals []llm.ToolCall
}
nestedInterruptionError struct {
inner *InterruptedError
toolCallID string
allToolCalls []llm.ToolCall
completedCalls []CompletedCall
}
outerLoopState struct {
agent *Agent
messages []llm.Message
usage llm.Usage
turns int
allToolCalls []llm.ToolCall
toolCallID string
completedCalls []CompletedCall
innerInterrupt *InterruptedError
}
)
func (e *MaxTurnsExceededError) Error() string {
return fmt.Sprintf("agent exceeded maximum number of turns (%d)", e.MaxTurns)
}
func (e *MaxToolDepthExceededError) Error() string {
return fmt.Sprintf("agent-tool delegation exceeded maximum depth (%d)", e.MaxDepth)
}
func (e *InputGuardrailTrippedError) Error() string {
return fmt.Sprintf("input guardrail %q tripped: %s", e.Guardrail, e.Message)
}
func (e *OutputGuardrailTrippedError) Error() string {
return fmt.Sprintf("output guardrail %q tripped: %s", e.Guardrail, e.Message)
}
func (e *InterruptedError) Error() string {
return fmt.Sprintf("run interrupted: %d tool call(s) require approval", len(e.PendingApprovals))
}
func (e *needsApprovalError) Error() string {
return fmt.Sprintf("%d tool call(s) require approval", len(e.pendingApprovals))
}
func (e *nestedInterruptionError) Error() string {
return fmt.Sprintf("nested agent interrupted: %s", e.inner.Error())
}