feat(cron): add get and update actions to cron tool

Add GetJob and improved UpdateJob to CronService with proper cloning,
schedule diffing, and next-run recomputation. Expose get/update actions
in the cron tool so agents can inspect and partially update jobs without
losing payloads or needing remove+add cycles. Includes access control
for remote channels and command safety gates.
This commit is contained in:
sutra
2026-05-31 01:47:13 +08:00
parent e81d37108b
commit 1d8ef7dcfb
5 changed files with 767 additions and 7 deletions
+215 -5
View File
@@ -2,6 +2,7 @@ package tools
import (
"context"
"encoding/json"
"fmt"
"strings"
"time"
@@ -75,7 +76,12 @@ func (t *CronTool) Name() string {
// Description returns the tool description
func (t *CronTool) Description() string {
return "Schedule reminders, tasks, or system commands. IMPORTANT: When user asks to be reminded or scheduled, you MUST call this tool. Use 'at_seconds' for one-time reminders (e.g., 'remind me in 10 minutes' → at_seconds=600). Use 'every_seconds' ONLY for recurring tasks (e.g., 'every 2 hours' → every_seconds=7200). Use 'cron_expr' for complex recurring schedules. Use 'command' to execute shell commands directly."
return `Schedule, inspect, and update reminders, tasks, or system commands.
IMPORTANT: When user asks to be reminded or scheduled, you MUST call this tool.
Use 'at_seconds' for one-time reminders (e.g., 'remind me in 10 minutes' → at_seconds=600).
Use 'every_seconds' ONLY for recurring tasks (e.g., 'every 2 hours' → every_seconds=7200).
Use 'cron_expr' for complex recurring schedules.
Use 'command' to execute shell commands directly.`
}
// Parameters returns the tool parameters schema
@@ -85,8 +91,12 @@ func (t *CronTool) Parameters() map[string]any {
"properties": map[string]any{
"action": map[string]any{
"type": "string",
"enum": []string{"add", "list", "remove", "enable", "disable"},
"description": "Action to perform. Use 'add' when user wants to schedule a reminder or task.",
"enum": []string{"add", "list", "get", "update", "remove", "enable", "disable"},
"description": "Action to perform. Use 'get' before editing and 'update' to change existing jobs without losing their payload.",
},
"name": map[string]any{
"type": "string",
"description": "Optional job display name for update or add.",
},
"message": map[string]any{
"type": "string",
@@ -94,7 +104,7 @@ func (t *CronTool) Parameters() map[string]any {
},
"command": map[string]any{
"type": "string",
"description": "Optional: Shell command to execute directly (e.g., 'df -h'). If set, the agent will run this command and report output instead of just showing the message.",
"description": "Optional: Shell command to execute directly (e.g., 'df -h'). If set, the agent will run this command and report output instead of just showing the message. For update, omit to preserve the command or pass an empty string to clear it.",
},
"command_confirm": map[string]any{
"type": "boolean",
@@ -114,7 +124,7 @@ func (t *CronTool) Parameters() map[string]any {
},
"job_id": map[string]any{
"type": "string",
"description": "Job ID (for remove/enable/disable)",
"description": "Job ID (for get/update/remove/enable/disable)",
},
},
"required": []string{"action"},
@@ -133,6 +143,10 @@ func (t *CronTool) Execute(ctx context.Context, args map[string]any) *ToolResult
return t.addJob(ctx, args)
case "list":
return t.listJobs()
case "get":
return t.getJob(ctx, args)
case "update":
return t.updateJob(ctx, args)
case "remove":
return t.removeJob(args)
case "enable":
@@ -262,6 +276,81 @@ func (t *CronTool) listJobs() *ToolResult {
return SilentResult(result.String())
}
func (t *CronTool) getJob(ctx context.Context, args map[string]any) *ToolResult {
jobID, errResult := requiredCronJobID(args, "get")
if errResult != nil {
return errResult
}
job, ok := t.cronService.GetJob(jobID)
if !ok {
return ErrorResult(fmt.Sprintf("Job %s not found", jobID))
}
return SilentResult(formatCronJobJSON(job))
}
func (t *CronTool) updateJob(ctx context.Context, args map[string]any) *ToolResult {
jobID, errResult := requiredCronJobID(args, "update")
if errResult != nil {
return errResult
}
job, ok := t.cronService.GetJob(jobID)
if !ok {
return ErrorResult(fmt.Sprintf("Job %s not found", jobID))
}
patches := 0
if name, present, errResult := optionalNonEmptyString(args, "name"); errResult != nil {
return errResult
} else if present {
job.Name = name
patches++
}
if message, present, errResult := optionalNonEmptyString(args, "message"); errResult != nil {
return errResult
} else if present {
job.Payload.Message = message
patches++
}
schedule, hasSchedule, errResult := schedulePatch(args)
if errResult != nil {
return errResult
}
if hasSchedule {
job.Schedule = schedule
job.DeleteAfterRun = schedule.Kind == "at"
patches++
}
command, commandPresent, errResult := optionalString(args, "command")
if errResult != nil {
return errResult
}
if commandPresent {
if errResult := t.validateCommandMutation(ctx, args); errResult != nil {
return errResult
}
job.Payload.Command = command
patches++
}
if patches == 0 {
return ErrorResult("at least one update field is required")
}
if err := t.cronService.UpdateJob(job); err != nil {
return ErrorResult(fmt.Sprintf("Error updating job: %v", err))
}
updated, _ := t.cronService.GetJob(jobID)
return SilentResult(fmt.Sprintf("Cron job updated:\n%s", formatCronJobJSON(updated)))
}
func (t *CronTool) removeJob(args map[string]any) *ToolResult {
jobID, ok := args["job_id"].(string)
if !ok || jobID == "" {
@@ -274,6 +363,127 @@ func (t *CronTool) removeJob(args map[string]any) *ToolResult {
return ErrorResult(fmt.Sprintf("Job %s not found", jobID))
}
func requiredCronJobID(args map[string]any, action string) (string, *ToolResult) {
jobID, ok := args["job_id"].(string)
if !ok || jobID == "" {
return "", ErrorResult(fmt.Sprintf("job_id is required for %s", action))
}
return jobID, nil
}
func optionalNonEmptyString(args map[string]any, key string) (string, bool, *ToolResult) {
_, present := args[key]
if !present {
return "", false, nil
}
text, _, errResult := optionalString(args, key)
if errResult != nil {
return "", false, errResult
}
if strings.TrimSpace(text) == "" {
return "", false, ErrorResult(fmt.Sprintf("%s cannot be empty", key))
}
return text, true, nil
}
func optionalString(args map[string]any, key string) (string, bool, *ToolResult) {
value, present := args[key]
if !present {
return "", false, nil
}
text, ok := value.(string)
if !ok {
return "", false, ErrorResult(fmt.Sprintf("%s must be a string", key))
}
return text, true, nil
}
func schedulePatch(args map[string]any) (cron.CronSchedule, bool, *ToolResult) {
var schedule cron.CronSchedule
patches := 0
if _, present := args["at_seconds"]; present {
seconds, errResult := positiveSeconds(args, "at_seconds")
if errResult != nil {
return cron.CronSchedule{}, false, errResult
}
atMS := time.Now().UnixMilli() + seconds*1000
schedule = cron.CronSchedule{Kind: "at", AtMS: &atMS}
patches++
}
if _, present := args["every_seconds"]; present {
seconds, errResult := positiveSeconds(args, "every_seconds")
if errResult != nil {
return cron.CronSchedule{}, false, errResult
}
everyMS := seconds * 1000
schedule = cron.CronSchedule{Kind: "every", EveryMS: &everyMS}
patches++
}
if _, present := args["cron_expr"]; present {
cronExpr, ok := args["cron_expr"].(string)
if !ok {
return cron.CronSchedule{}, false, ErrorResult("cron_expr must be a string")
}
if strings.TrimSpace(cronExpr) == "" {
return cron.CronSchedule{}, false, ErrorResult("cron_expr cannot be empty")
}
schedule = cron.CronSchedule{Kind: "cron", Expr: cronExpr}
patches++
}
if patches > 1 {
return cron.CronSchedule{}, false, ErrorResult("only one of at_seconds, every_seconds, or cron_expr can be set")
}
return schedule, patches == 1, nil
}
func positiveSeconds(args map[string]any, key string) (int64, *ToolResult) {
value := args[key]
var seconds int64
switch v := value.(type) {
case float64:
if v != float64(int64(v)) {
return 0, ErrorResult(fmt.Sprintf("%s must be a positive integer", key))
}
seconds = int64(v)
case int:
seconds = int64(v)
case int64:
seconds = v
default:
return 0, ErrorResult(fmt.Sprintf("%s must be a positive integer", key))
}
if seconds <= 0 {
return 0, ErrorResult(fmt.Sprintf("%s must be a positive integer", key))
}
return seconds, nil
}
func (t *CronTool) validateCommandMutation(ctx context.Context, args map[string]any) *ToolResult {
if !t.execEnabled {
return ErrorResult("command execution is disabled")
}
if !constants.IsInternalChannel(ToolChannel(ctx)) {
return ErrorResult("updating command execution is restricted to internal channels")
}
commandConfirm, _ := args["command_confirm"].(bool)
if !t.allowCommand && !commandConfirm {
return ErrorResult("command_confirm=true is required when allow_command is disabled")
}
return nil
}
func formatCronJobJSON(job *cron.CronJob) string {
data, err := json.Marshal(job)
if err != nil {
return fmt.Sprintf("%+v", *job)
}
return string(data)
}
func (t *CronTool) enableJob(args map[string]any, enable bool) *ToolResult {
jobID, ok := args["job_id"].(string)
if !ok || jobID == "" {
+331
View File
@@ -2,6 +2,7 @@ package tools
import (
"context"
"encoding/json"
"fmt"
"path/filepath"
"strings"
@@ -73,6 +74,19 @@ func newTestCronTool(t *testing.T) *CronTool {
return newTestCronToolWithConfig(t, config.DefaultConfig())
}
func parseCronJobResult(t *testing.T, result *ToolResult) cron.CronJob {
t.Helper()
text := result.ForLLM
if idx := strings.Index(text, "{"); idx >= 0 {
text = text[idx:]
}
var job cron.CronJob
if err := json.Unmarshal([]byte(text), &job); err != nil {
t.Fatalf("failed to parse cron job JSON %q: %v", result.ForLLM, err)
}
return job
}
// TestCronTool_CommandBlockedFromRemoteChannel verifies command scheduling is restricted to internal channels
func TestCronTool_CommandBlockedFromRemoteChannel(t *testing.T) {
tool := newTestCronTool(t)
@@ -231,6 +245,323 @@ func TestCronTool_NonCommandJobAllowedFromRemoteChannel(t *testing.T) {
}
}
func TestCronTool_GetReturnsFullJobPayload(t *testing.T) {
tool := newTestCronTool(t)
ctx := WithToolContext(context.Background(), "telegram", "chat-1")
everyMS := int64(60_000)
message := strings.Repeat("daily briefing details ", 8)
job, err := tool.cronService.AddJob(
"daily",
cron.CronSchedule{Kind: "every", EveryMS: &everyMS},
message,
"telegram",
"chat-1",
)
if err != nil {
t.Fatalf("AddJob() error: %v", err)
}
result := tool.Execute(ctx, map[string]any{
"action": "get",
"job_id": job.ID,
})
if result.IsError {
t.Fatalf("get failed: %s", result.ForLLM)
}
got := parseCronJobResult(t, result)
if got.ID != job.ID || got.Payload.Message != message || got.Payload.Channel != "telegram" ||
got.Payload.To != "chat-1" {
t.Fatalf("get returned wrong payload: %+v", got)
}
if got.Schedule.Kind != "every" || got.Schedule.EveryMS == nil || *got.Schedule.EveryMS != everyMS {
t.Fatalf("get returned wrong schedule: %+v", got.Schedule)
}
if got.State.NextRunAtMS == nil {
t.Fatal("get should include next run state")
}
}
func TestCronTool_UpdateSchedulePreservesPayload(t *testing.T) {
tool := newTestCronTool(t)
ctx := WithToolContext(context.Background(), "cli", "direct")
original, err := tool.cronService.AddJob(
"AI daily",
cron.CronSchedule{Kind: "cron", Expr: "0 8 * * *"},
"fetch RSS, include source links",
"weixin",
"chat-1",
)
if err != nil {
t.Fatalf("AddJob() error: %v", err)
}
result := tool.Execute(ctx, map[string]any{
"action": "update",
"job_id": original.ID,
"cron_expr": "30 10 * * *",
})
if result.IsError {
t.Fatalf("update failed: %s", result.ForLLM)
}
updated, ok := tool.cronService.GetJob(original.ID)
if !ok {
t.Fatal("updated job not found")
}
if updated.ID != original.ID || updated.CreatedAtMS != original.CreatedAtMS {
t.Fatalf("identity changed after update: before=%+v after=%+v", original, updated)
}
if updated.Payload.Message != original.Payload.Message || updated.Payload.Channel != original.Payload.Channel ||
updated.Payload.To != original.Payload.To {
t.Fatalf("payload was not preserved: %+v", updated.Payload)
}
if updated.Schedule.Kind != "cron" || updated.Schedule.Expr != "30 10 * * *" {
t.Fatalf("schedule not updated: %+v", updated.Schedule)
}
if updated.DeleteAfterRun {
t.Fatal("cron schedule should not delete after run")
}
}
func TestCronTool_UpdateMessagePreservesScheduleAndNextRun(t *testing.T) {
tool := newTestCronTool(t)
ctx := WithToolContext(context.Background(), "telegram", "chat-1")
everyMS := int64(120_000)
original, err := tool.cronService.AddJob(
"reminder",
cron.CronSchedule{Kind: "every", EveryMS: &everyMS},
"old message",
"telegram",
"chat-1",
)
if err != nil {
t.Fatalf("AddJob() error: %v", err)
}
if original.State.NextRunAtMS == nil {
t.Fatal("expected original next run")
}
nextRunBefore := *original.State.NextRunAtMS
result := tool.Execute(ctx, map[string]any{
"action": "update",
"job_id": original.ID,
"message": "new message",
})
if result.IsError {
t.Fatalf("update failed: %s", result.ForLLM)
}
updated, _ := tool.cronService.GetJob(original.ID)
if updated.Payload.Message != "new message" {
t.Fatalf("message not updated: %+v", updated.Payload)
}
if updated.Name != "reminder" {
t.Fatalf("name should be preserved, got %q", updated.Name)
}
if updated.Schedule.Kind != "every" || updated.Schedule.EveryMS == nil || *updated.Schedule.EveryMS != everyMS {
t.Fatalf("schedule should be preserved: %+v", updated.Schedule)
}
if updated.State.NextRunAtMS == nil || *updated.State.NextRunAtMS != nextRunBefore {
t.Fatalf("next run should be preserved: before=%d after=%v", nextRunBefore, updated.State.NextRunAtMS)
}
}
func TestCronTool_UpdateValidationErrors(t *testing.T) {
tool := newTestCronTool(t)
ctx := WithToolContext(context.Background(), "cli", "direct")
job, err := tool.cronService.AddJob(
"job",
cron.CronSchedule{Kind: "cron", Expr: "0 8 * * *"},
"message",
"cli",
"direct",
)
if err != nil {
t.Fatalf("AddJob() error: %v", err)
}
tests := []struct {
name string
args map[string]any
want string
}{
{
name: "invalid job id",
args: map[string]any{"action": "update", "job_id": "missing", "message": "new"},
want: "not found",
},
{
name: "missing patch",
args: map[string]any{"action": "update", "job_id": job.ID},
want: "at least one update field",
},
{
name: "multiple schedule fields",
args: map[string]any{
"action": "update",
"job_id": job.ID,
"every_seconds": float64(60),
"cron_expr": "0 9 * * *",
},
want: "only one of",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := tool.Execute(ctx, tt.args)
if !result.IsError {
t.Fatalf("expected error, got: %s", result.ForLLM)
}
if !strings.Contains(result.ForLLM, tt.want) {
t.Fatalf("error = %q, want substring %q", result.ForLLM, tt.want)
}
})
}
}
func TestCronTool_RemoteCannotAccessOtherChatJob(t *testing.T) {
tool := newTestCronTool(t)
job, err := tool.cronService.AddJob(
"private",
cron.CronSchedule{Kind: "cron", Expr: "0 8 * * *"},
"secret",
"telegram",
"chat-1",
)
if err != nil {
t.Fatalf("AddJob() error: %v", err)
}
ctx := WithToolContext(context.Background(), "telegram", "chat-2")
getResult := tool.Execute(ctx, map[string]any{"action": "get", "job_id": job.ID})
if !getResult.IsError || !strings.Contains(getResult.ForLLM, "not accessible") {
t.Fatalf("expected inaccessible get, got: %+v", getResult)
}
updateResult := tool.Execute(ctx, map[string]any{"action": "update", "job_id": job.ID, "message": "changed"})
if !updateResult.IsError || !strings.Contains(updateResult.ForLLM, "not accessible") {
t.Fatalf("expected inaccessible update, got: %+v", updateResult)
}
}
func TestCronTool_RemoteCannotAccessCommandJob(t *testing.T) {
tool := newTestCronTool(t)
job, err := tool.cronService.AddJob(
"command",
cron.CronSchedule{Kind: "cron", Expr: "0 8 * * *"},
"run command",
"telegram",
"chat-1",
)
if err != nil {
t.Fatalf("AddJob() error: %v", err)
}
job.Payload.Command = "df -h"
if err := tool.cronService.UpdateJob(job); err != nil {
t.Fatalf("UpdateJob() error: %v", err)
}
ctx := WithToolContext(context.Background(), "telegram", "chat-1")
getResult := tool.Execute(ctx, map[string]any{"action": "get", "job_id": job.ID})
if !getResult.IsError || !strings.Contains(getResult.ForLLM, "not accessible") {
t.Fatalf("expected inaccessible get, got: %+v", getResult)
}
updateResult := tool.Execute(ctx, map[string]any{"action": "update", "job_id": job.ID, "message": "changed"})
if !updateResult.IsError || !strings.Contains(updateResult.ForLLM, "not accessible") {
t.Fatalf("expected inaccessible update, got: %+v", updateResult)
}
}
func TestCronTool_CommandUpdateSafetyGates(t *testing.T) {
t.Run("exec disabled", func(t *testing.T) {
cfg := config.DefaultConfig()
cfg.Tools.Exec.Enabled = false
tool := newTestCronToolWithConfig(t, cfg)
ctx := WithToolContext(context.Background(), "cli", "direct")
job, err := tool.cronService.AddJob(
"job",
cron.CronSchedule{Kind: "cron", Expr: "0 8 * * *"},
"message",
"cli",
"direct",
)
if err != nil {
t.Fatalf("AddJob() error: %v", err)
}
result := tool.Execute(ctx, map[string]any{
"action": "update",
"job_id": job.ID,
"command": "df -h",
"command_confirm": true,
})
if !result.IsError || !strings.Contains(result.ForLLM, "command execution is disabled") {
t.Fatalf("expected exec disabled error, got: %+v", result)
}
})
t.Run("confirm required", func(t *testing.T) {
cfg := config.DefaultConfig()
cfg.Tools.Cron.AllowCommand = false
tool := newTestCronToolWithConfig(t, cfg)
ctx := WithToolContext(context.Background(), "cli", "direct")
job, err := tool.cronService.AddJob(
"job",
cron.CronSchedule{Kind: "cron", Expr: "0 8 * * *"},
"message",
"cli",
"direct",
)
if err != nil {
t.Fatalf("AddJob() error: %v", err)
}
result := tool.Execute(ctx, map[string]any{
"action": "update",
"job_id": job.ID,
"command": "df -h",
})
if !result.IsError || !strings.Contains(result.ForLLM, "command_confirm=true") {
t.Fatalf("expected confirm error, got: %+v", result)
}
result = tool.Execute(ctx, map[string]any{
"action": "update",
"job_id": job.ID,
"command": "df -h",
"command_confirm": true,
})
if result.IsError {
t.Fatalf("expected confirmed command update to succeed, got: %s", result.ForLLM)
}
updated, _ := tool.cronService.GetJob(job.ID)
if updated.Payload.Command != "df -h" {
t.Fatalf("command not updated: %+v", updated.Payload)
}
result = tool.Execute(ctx, map[string]any{
"action": "update",
"job_id": job.ID,
"command": "",
"command_confirm": true,
})
if result.IsError {
t.Fatalf("expected empty command update to clear command, got: %s", result.ForLLM)
}
updated, _ = tool.cronService.GetJob(job.ID)
if updated.Payload.Command != "" {
t.Fatalf("command not cleared: %+v", updated.Payload)
}
})
}
func TestCronTool_ExecuteJobPublishesErrorWhenExecDisabled(t *testing.T) {
cfg := config.DefaultConfig()
cfg.Tools.Exec.Enabled = false