Adds two read surfaces for per-task persisted log history so an operator
can answer "why did task N park?" without needing to watch docker ps in
real time — the deployment model documented in CLAUDE.md.
/api/tasks/{id}/logs — built on logging.Tail the same way /api/logs
already is, defaults attempt to the tasks current Attempt from the store.
task_logs chat tool — lets Archie read task logs from Telegram or webui
chat. Identity enforcement matches chatTaskListerAdapter: a model bound
to one identity cannot read another identitys logs, and forge tasks
(empty identity) are denied.
internal/logging: add TaskRegistry.Path() for read-side access without
threading baseDir separately through every caller.
Fixes from adversarial review: strict identity check (no empty-identity
bypass), non-null Entries when disabled, component doc accuracy, and
adapter tests covering the security boundary.
Ref: #455
323 lines
11 KiB
Go
323 lines
11 KiB
Go
package gateway
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/samcharles93/archie-core/internal/tools"
|
|
)
|
|
|
|
const (
|
|
// defaultTaskListLimit is how many tasks a bare task_list returns.
|
|
defaultTaskListLimit = 20
|
|
|
|
// maxTaskListLimit bounds what the model can ask for. A queue of a few
|
|
// hundred tasks would otherwise land in the context window whole.
|
|
maxTaskListLimit = 100
|
|
|
|
// defaultTaskLogLimit is how many log entries a bare task_logs returns.
|
|
defaultTaskLogLimit = 200
|
|
|
|
// maxTaskLogLimit bounds what the model can ask for in one call.
|
|
maxTaskLogLimit = 2000
|
|
)
|
|
|
|
// ChatTaskSummary is the per-task view the task tools return. It is
|
|
// deliberately narrower than a store task: notes, plan and body are the bulk
|
|
// of a row and none of them help answer "what are you working on?".
|
|
type ChatTaskSummary struct {
|
|
ID int64 `json:"id"`
|
|
Repo string `json:"repo"` // "owner/name"
|
|
Title string `json:"title"`
|
|
Status string `json:"status"`
|
|
Workflow string `json:"workflow,omitempty"`
|
|
PRNumber int `json:"pr_number,omitempty"`
|
|
}
|
|
|
|
// ChatTaskLister is the read surface the task tools need. It mirrors the
|
|
// existing chatTaskWriter/chatTaskController pattern: gateway states what it
|
|
// needs and the daemon supplies an adapter over the store, so this package
|
|
// keeps its independence from internal/store.
|
|
type ChatTaskLister interface {
|
|
ListChatTasks(ctx context.Context, identity string, limit int) ([]ChatTaskSummary, error)
|
|
}
|
|
|
|
// TaskListResult is what task_list returns.
|
|
type TaskListResult struct {
|
|
Tasks []ChatTaskSummary `json:"tasks"`
|
|
}
|
|
|
|
// TaskSpawnResult is what task_spawn returns.
|
|
type TaskSpawnResult struct {
|
|
ID int64 `json:"id"`
|
|
Message string `json:"message"`
|
|
}
|
|
|
|
// ChatTaskLogEntry is one log line as task_logs returns it. It mirrors
|
|
// internal/logging.Entry's shape without importing that package: gateway
|
|
// keeps its independence from internal/logging the same way it already does
|
|
// from internal/store, with the daemon adapting between them.
|
|
type ChatTaskLogEntry struct {
|
|
Time time.Time `json:"time"`
|
|
Level string `json:"level"`
|
|
Message string `json:"message"`
|
|
Fields map[string]any `json:"fields,omitempty"`
|
|
}
|
|
|
|
// ChatTaskLogQuery filters a task_logs read.
|
|
type ChatTaskLogQuery struct {
|
|
// Component matches the log entry's component field case-insensitively.
|
|
// Empty means any.
|
|
Component string
|
|
// Contains matches the message or any field value, case-insensitively.
|
|
Contains string
|
|
// Limit caps returned entries.
|
|
Limit int
|
|
}
|
|
|
|
// ChatTaskLogResult is what task_logs returns.
|
|
type ChatTaskLogResult struct {
|
|
Entries []ChatTaskLogEntry `json:"entries"`
|
|
// Attempt is the attempt number actually read, so the model can tell
|
|
// the caller which run it looked at when none was requested explicitly.
|
|
Attempt int `json:"attempt"`
|
|
// Truncated reports that older matching entries exist beyond what this
|
|
// page examined.
|
|
Truncated bool `json:"truncated"`
|
|
}
|
|
|
|
// ChatTaskLogReader is the read surface task_logs needs. It mirrors the
|
|
// ChatTaskLister pattern: gateway states what it needs and the daemon
|
|
// supplies an adapter, so this package keeps its independence from
|
|
// internal/store and internal/logging.
|
|
type ChatTaskLogReader interface {
|
|
// ReadChatTaskLogs returns taskID's log entries for attempt (0 selects
|
|
// the task's current/latest attempt), scoped to identity's own tasks.
|
|
ReadChatTaskLogs(ctx context.Context, identity string, taskID int64, attempt int, q ChatTaskLogQuery) (ChatTaskLogResult, error)
|
|
}
|
|
|
|
// TaskTools builds the chat tools that let Archie see and add to its own work
|
|
// queue. Until these existed, /spawn and the task list were slash commands only
|
|
// a human could type, so "what are you working on?" had no tool path at all.
|
|
//
|
|
// Both tools are bound to identity at construction. The model never supplies
|
|
// it: a model that could name an identity could read or file work belonging to
|
|
// another instance on the same host.
|
|
//
|
|
// A nil backend omits its tool rather than registering one that always fails,
|
|
// so a daemon without chat task support advertises nothing.
|
|
//
|
|
// Deliberately absent: task_approve and task_cancel. waiting_human is the one
|
|
// point in the task lifecycle where a person must act, and /approve is that
|
|
// gate. The text reaching a chat turn is untrusted -- a forge issue body or an
|
|
// inbound email can be quoted into it -- so a tool that approves Archie's own
|
|
// work would remove the only human checkpoint in the lifecycle. Cancel is
|
|
// destructive on the same untrusted path. Both remain slash commands.
|
|
func TaskTools(lister ChatTaskLister, creator TaskCreator, logs ChatTaskLogReader, identity string) []tools.ToolEntry {
|
|
var entries []tools.ToolEntry
|
|
if lister != nil {
|
|
entries = append(entries, taskListTool(lister, identity))
|
|
}
|
|
if creator != nil {
|
|
entries = append(entries, taskSpawnTool(creator, identity))
|
|
}
|
|
if logs != nil {
|
|
entries = append(entries, taskLogsTool(logs, identity))
|
|
}
|
|
return entries
|
|
}
|
|
|
|
func taskListTool(lister ChatTaskLister, identity string) tools.ToolEntry {
|
|
return tools.ToolEntry{
|
|
Name: "task_list",
|
|
Toolset: "tasks",
|
|
Description: "List the tasks this instance is working on, most recent first. " +
|
|
"Use it to answer questions about current, queued, parked or finished work. " +
|
|
"Optionally filter by status (queued, running, waiting_human, parked, pr_open, merged, rejected).",
|
|
Classification: tools.ClassIdempotent,
|
|
Schema: tools.JSONSchema{
|
|
"type": "object",
|
|
"properties": map[string]any{
|
|
"status": map[string]any{
|
|
"type": "string",
|
|
"description": "Only return tasks with this status. Omit for all statuses.",
|
|
},
|
|
"limit": map[string]any{
|
|
"type": "integer",
|
|
"description": fmt.Sprintf(
|
|
"Maximum tasks to return. Defaults to %d, capped at %d.",
|
|
defaultTaskListLimit, maxTaskListLimit),
|
|
},
|
|
},
|
|
},
|
|
Handler: func(ctx context.Context, input map[string]any) (any, error) {
|
|
limit := taskListLimit(input)
|
|
|
|
// The bound identity, never input["identity"].
|
|
all, err := lister.ListChatTasks(ctx, identity, limit)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("task_list: %w", err)
|
|
}
|
|
|
|
status := strings.TrimSpace(strings.ToLower(asString(input["status"])))
|
|
// Non-nil even when empty: an empty queue is an answer, and a
|
|
// null would read to the model as a failed call worth retrying.
|
|
filtered := make([]ChatTaskSummary, 0, len(all))
|
|
for _, task := range all {
|
|
if status != "" && !strings.EqualFold(task.Status, status) {
|
|
continue
|
|
}
|
|
filtered = append(filtered, task)
|
|
}
|
|
return TaskListResult{Tasks: filtered}, nil
|
|
},
|
|
}
|
|
}
|
|
|
|
func taskSpawnTool(creator TaskCreator, identity string) tools.ToolEntry {
|
|
return tools.ToolEntry{
|
|
Name: "task_spawn",
|
|
Toolset: "tasks",
|
|
Description: "Queue a new task for this instance to work on in its own worktree, " +
|
|
"opening a pull request for review when it finishes. " +
|
|
"Use it when the user asks for work to be carried out rather than answered in chat.",
|
|
Classification: tools.ClassMutating,
|
|
Schema: tools.JSONSchema{
|
|
"type": "object",
|
|
"properties": map[string]any{
|
|
"title": map[string]any{
|
|
"type": "string",
|
|
"description": "What the task should accomplish, as a single instruction.",
|
|
},
|
|
"repo": map[string]any{
|
|
"type": "string",
|
|
"description": "Target repository as \"owner/name\". Omit to use this instance's default repository. A repository this instance is not configured for is refused.",
|
|
},
|
|
"workflow": map[string]any{
|
|
"type": "string",
|
|
"description": "Workflow to run (e.g. implement, tdd, feasibility). Omit to let the daemon route it.",
|
|
},
|
|
},
|
|
"required": []any{"title"},
|
|
},
|
|
Handler: func(ctx context.Context, input map[string]any) (any, error) {
|
|
title := strings.TrimSpace(asString(input["title"]))
|
|
if title == "" {
|
|
return nil, fmt.Errorf("task_spawn: title is required")
|
|
}
|
|
|
|
id, err := creator.CreateTask(ctx, SpawnRequest{
|
|
Title: title,
|
|
Repo: strings.TrimSpace(asString(input["repo"])),
|
|
Workflow: strings.TrimSpace(asString(input["workflow"])),
|
|
// The bound identity, never input["identity"]. CreateTask
|
|
// enforces the repository allow-list for it.
|
|
Identity: identity,
|
|
})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("task_spawn: %w", err)
|
|
}
|
|
return TaskSpawnResult{
|
|
ID: id,
|
|
Message: fmt.Sprintf("queued task %d: %s", id, title),
|
|
}, nil
|
|
},
|
|
}
|
|
}
|
|
|
|
func taskLogsTool(reader ChatTaskLogReader, identity string) tools.ToolEntry {
|
|
return tools.ToolEntry{
|
|
Name: "task_logs",
|
|
Toolset: "tasks",
|
|
Description: "Read a task's persisted log history -- gate output, agent activity, errors -- " +
|
|
"to answer questions like \"why did task N park?\" or \"what happened on task N?\" " +
|
|
"without an operator needing to open the dashboard. " +
|
|
"Defaults to the task's latest attempt when attempt is omitted.",
|
|
Classification: tools.ClassIdempotent,
|
|
Schema: tools.JSONSchema{
|
|
"type": "object",
|
|
"properties": map[string]any{
|
|
"task_id": map[string]any{
|
|
"type": "integer",
|
|
"description": "ID of the task to read logs for.",
|
|
},
|
|
"attempt": map[string]any{
|
|
"type": "integer",
|
|
"description": "Which attempt to read. Omit for the task's current/latest attempt.",
|
|
},
|
|
"component": map[string]any{
|
|
"type": "string",
|
|
"description": "Only return entries from this component (e.g. \"gate\"). Omit for all components.",
|
|
},
|
|
"q": map[string]any{
|
|
"type": "string",
|
|
"description": "Only return entries whose message or fields contain this text (case-insensitive).",
|
|
},
|
|
"limit": map[string]any{
|
|
"type": "integer",
|
|
"description": fmt.Sprintf(
|
|
"Maximum entries to return. Defaults to %d, capped at %d.",
|
|
defaultTaskLogLimit, maxTaskLogLimit),
|
|
},
|
|
},
|
|
"required": []any{"task_id"},
|
|
},
|
|
Handler: func(ctx context.Context, input map[string]any) (any, error) {
|
|
taskID, ok := asInt64(input["task_id"])
|
|
if !ok {
|
|
return nil, fmt.Errorf("task_logs: task_id is required")
|
|
}
|
|
attempt := 0
|
|
if v, ok := asInt64(input["attempt"]); ok {
|
|
attempt = int(v)
|
|
}
|
|
limit := tools.ListLimit(input, defaultTaskLogLimit, maxTaskLogLimit)
|
|
|
|
// The bound identity, never input["identity"].
|
|
result, err := reader.ReadChatTaskLogs(ctx, identity, taskID, attempt, ChatTaskLogQuery{
|
|
Component: strings.TrimSpace(asString(input["component"])),
|
|
Contains: strings.TrimSpace(asString(input["q"])),
|
|
Limit: limit,
|
|
})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("task_logs: %w", err)
|
|
}
|
|
return result, nil
|
|
},
|
|
}
|
|
}
|
|
|
|
// asInt64 reads an integer field. JSON numbers decode as float64, but a
|
|
// model that emits an integer through a different provider path can arrive
|
|
// as int or int64, so all three are accepted.
|
|
func asInt64(v any) (int64, bool) {
|
|
switch n := v.(type) {
|
|
case float64:
|
|
return int64(n), true
|
|
case int64:
|
|
return n, true
|
|
case int:
|
|
return int64(n), true
|
|
default:
|
|
return 0, false
|
|
}
|
|
}
|
|
|
|
// taskListLimit resolves the requested limit, falling back to the default for
|
|
// anything absent or non-positive and clamping the rest.
|
|
//
|
|
// JSON numbers decode as float64, but a model that emits an integer through a
|
|
// different provider path can arrive as int, so both are accepted.
|
|
func taskListLimit(input map[string]any) int {
|
|
return tools.ListLimit(input, defaultTaskListLimit, maxTaskListLimit)
|
|
}
|
|
|
|
// asString reads a string field, tolerating an absent or wrongly-typed value
|
|
// rather than failing the call over it.
|
|
func asString(v any) string {
|
|
s, _ := v.(string)
|
|
return s
|
|
}
|