* fix(cron): comprehensive cron scheduling and delivery fixes - Fix delivery target resolution for isolated agent cron jobs - Improve schedule parsing and validation - Add job retry logic and error handling - Enhance cron ops with better state management - Add timer improvements for more reliable cron execution - Add cron event type to protocol schema - Support cron events in heartbeat runner (skip empty-heartbeat check, use dedicated CRON_EVENT_PROMPT for relay) * fix: remove cron debug test and add changelog/docs notes (#11641) (thanks @tyler6204)
406 lines
13 KiB
TypeScript
406 lines
13 KiB
TypeScript
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
import { beforeEach, describe, expect, it, vi } from "vitest";
|
|
import type { CliDeps } from "../cli/deps.js";
|
|
import type { OpenClawConfig } from "../config/config.js";
|
|
import type { CronJob } from "./types.js";
|
|
import { withTempHome as withTempHomeBase } from "../../test/helpers/temp-home.js";
|
|
import { telegramOutbound } from "../channels/plugins/outbound/telegram.js";
|
|
import { setActivePluginRegistry } from "../plugins/runtime.js";
|
|
import { createOutboundTestPlugin, createTestRegistry } from "../test-utils/channel-plugins.js";
|
|
|
|
vi.mock("../agents/pi-embedded.js", () => ({
|
|
abortEmbeddedPiRun: vi.fn().mockReturnValue(false),
|
|
runEmbeddedPiAgent: vi.fn(),
|
|
resolveEmbeddedSessionLane: (key: string) => `session:${key.trim() || "main"}`,
|
|
}));
|
|
vi.mock("../agents/model-catalog.js", () => ({
|
|
loadModelCatalog: vi.fn(),
|
|
}));
|
|
vi.mock("../agents/subagent-announce.js", () => ({
|
|
runSubagentAnnounceFlow: vi.fn(),
|
|
}));
|
|
|
|
import { loadModelCatalog } from "../agents/model-catalog.js";
|
|
import { runEmbeddedPiAgent } from "../agents/pi-embedded.js";
|
|
import { runSubagentAnnounceFlow } from "../agents/subagent-announce.js";
|
|
import { runCronIsolatedAgentTurn } from "./isolated-agent.js";
|
|
|
|
async function withTempHome<T>(fn: (home: string) => Promise<T>): Promise<T> {
|
|
return withTempHomeBase(fn, { prefix: "openclaw-cron-" });
|
|
}
|
|
|
|
async function writeSessionStore(home: string) {
|
|
const dir = path.join(home, ".openclaw", "sessions");
|
|
await fs.mkdir(dir, { recursive: true });
|
|
const storePath = path.join(dir, "sessions.json");
|
|
await fs.writeFile(
|
|
storePath,
|
|
JSON.stringify(
|
|
{
|
|
"agent:main:main": {
|
|
sessionId: "main-session",
|
|
updatedAt: Date.now(),
|
|
lastProvider: "webchat",
|
|
lastTo: "",
|
|
},
|
|
},
|
|
null,
|
|
2,
|
|
),
|
|
"utf-8",
|
|
);
|
|
return storePath;
|
|
}
|
|
|
|
function makeCfg(
|
|
home: string,
|
|
storePath: string,
|
|
overrides: Partial<OpenClawConfig> = {},
|
|
): OpenClawConfig {
|
|
const base: OpenClawConfig = {
|
|
agents: {
|
|
defaults: {
|
|
model: "anthropic/claude-opus-4-5",
|
|
workspace: path.join(home, "openclaw"),
|
|
},
|
|
},
|
|
session: { store: storePath, mainKey: "main" },
|
|
} as OpenClawConfig;
|
|
return { ...base, ...overrides };
|
|
}
|
|
|
|
function makeJob(payload: CronJob["payload"]): CronJob {
|
|
const now = Date.now();
|
|
return {
|
|
id: "job-1",
|
|
name: "job-1",
|
|
enabled: true,
|
|
createdAtMs: now,
|
|
updatedAtMs: now,
|
|
schedule: { kind: "every", everyMs: 60_000 },
|
|
sessionTarget: "isolated",
|
|
wakeMode: "now",
|
|
payload,
|
|
state: {},
|
|
};
|
|
}
|
|
|
|
describe("runCronIsolatedAgentTurn", () => {
|
|
beforeEach(() => {
|
|
vi.mocked(runEmbeddedPiAgent).mockReset();
|
|
vi.mocked(loadModelCatalog).mockResolvedValue([]);
|
|
vi.mocked(runSubagentAnnounceFlow).mockReset().mockResolvedValue(true);
|
|
setActivePluginRegistry(
|
|
createTestRegistry([
|
|
{
|
|
pluginId: "telegram",
|
|
plugin: createOutboundTestPlugin({ id: "telegram", outbound: telegramOutbound }),
|
|
source: "test",
|
|
},
|
|
]),
|
|
);
|
|
});
|
|
|
|
it("announces via shared subagent flow when delivery is requested", async () => {
|
|
await withTempHome(async (home) => {
|
|
const storePath = await writeSessionStore(home);
|
|
const deps: CliDeps = {
|
|
sendMessageWhatsApp: vi.fn(),
|
|
sendMessageTelegram: vi.fn(),
|
|
sendMessageDiscord: vi.fn(),
|
|
sendMessageSignal: vi.fn(),
|
|
sendMessageIMessage: vi.fn(),
|
|
};
|
|
vi.mocked(runEmbeddedPiAgent).mockResolvedValue({
|
|
payloads: [{ text: "hello from cron" }],
|
|
meta: {
|
|
durationMs: 5,
|
|
agentMeta: { sessionId: "s", provider: "p", model: "m" },
|
|
},
|
|
});
|
|
|
|
const res = await runCronIsolatedAgentTurn({
|
|
cfg: makeCfg(home, storePath, {
|
|
channels: { telegram: { botToken: "t-1" } },
|
|
}),
|
|
deps,
|
|
job: {
|
|
...makeJob({ kind: "agentTurn", message: "do it" }),
|
|
delivery: { mode: "announce", channel: "telegram", to: "123" },
|
|
},
|
|
message: "do it",
|
|
sessionKey: "cron:job-1",
|
|
lane: "cron",
|
|
});
|
|
|
|
expect(res.status).toBe("ok");
|
|
expect(runSubagentAnnounceFlow).toHaveBeenCalledTimes(1);
|
|
const announceArgs = vi.mocked(runSubagentAnnounceFlow).mock.calls[0]?.[0] as
|
|
| { announceType?: string }
|
|
| undefined;
|
|
expect(announceArgs?.announceType).toBe("cron job");
|
|
expect(deps.sendMessageTelegram).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
it("passes final payload text into shared subagent announce flow", async () => {
|
|
await withTempHome(async (home) => {
|
|
const storePath = await writeSessionStore(home);
|
|
const deps: CliDeps = {
|
|
sendMessageWhatsApp: vi.fn(),
|
|
sendMessageTelegram: vi.fn(),
|
|
sendMessageDiscord: vi.fn(),
|
|
sendMessageSignal: vi.fn(),
|
|
sendMessageIMessage: vi.fn(),
|
|
};
|
|
vi.mocked(runEmbeddedPiAgent).mockResolvedValue({
|
|
payloads: [{ text: "Working on it..." }, { text: "Final weather summary" }],
|
|
meta: {
|
|
durationMs: 5,
|
|
agentMeta: { sessionId: "s", provider: "p", model: "m" },
|
|
},
|
|
});
|
|
|
|
const res = await runCronIsolatedAgentTurn({
|
|
cfg: makeCfg(home, storePath, {
|
|
channels: { telegram: { botToken: "t-1" } },
|
|
}),
|
|
deps,
|
|
job: {
|
|
...makeJob({ kind: "agentTurn", message: "do it" }),
|
|
delivery: { mode: "announce", channel: "telegram", to: "123" },
|
|
},
|
|
message: "do it",
|
|
sessionKey: "cron:job-1",
|
|
lane: "cron",
|
|
});
|
|
|
|
expect(res.status).toBe("ok");
|
|
expect(runSubagentAnnounceFlow).toHaveBeenCalledTimes(1);
|
|
const announceArgs = vi.mocked(runSubagentAnnounceFlow).mock.calls[0]?.[0] as
|
|
| { roundOneReply?: string; requesterOrigin?: { threadId?: string | number } }
|
|
| undefined;
|
|
expect(announceArgs?.roundOneReply).toBe("Final weather summary");
|
|
expect(announceArgs?.requesterOrigin?.threadId).toBeUndefined();
|
|
});
|
|
});
|
|
|
|
it("passes resolved threadId into shared subagent announce flow", async () => {
|
|
await withTempHome(async (home) => {
|
|
const storePath = await writeSessionStore(home);
|
|
await fs.writeFile(
|
|
storePath,
|
|
JSON.stringify(
|
|
{
|
|
"agent:main:main": {
|
|
sessionId: "main-session",
|
|
updatedAt: Date.now(),
|
|
lastChannel: "telegram",
|
|
lastTo: "123",
|
|
lastThreadId: 42,
|
|
},
|
|
},
|
|
null,
|
|
2,
|
|
),
|
|
"utf-8",
|
|
);
|
|
const deps: CliDeps = {
|
|
sendMessageWhatsApp: vi.fn(),
|
|
sendMessageTelegram: vi.fn(),
|
|
sendMessageDiscord: vi.fn(),
|
|
sendMessageSignal: vi.fn(),
|
|
sendMessageIMessage: vi.fn(),
|
|
};
|
|
vi.mocked(runEmbeddedPiAgent).mockResolvedValue({
|
|
payloads: [{ text: "Final weather summary" }],
|
|
meta: {
|
|
durationMs: 5,
|
|
agentMeta: { sessionId: "s", provider: "p", model: "m" },
|
|
},
|
|
});
|
|
|
|
const res = await runCronIsolatedAgentTurn({
|
|
cfg: makeCfg(home, storePath, {
|
|
channels: { telegram: { botToken: "t-1" } },
|
|
}),
|
|
deps,
|
|
job: {
|
|
...makeJob({ kind: "agentTurn", message: "do it" }),
|
|
delivery: { mode: "announce", channel: "last" },
|
|
},
|
|
message: "do it",
|
|
sessionKey: "cron:job-1",
|
|
lane: "cron",
|
|
});
|
|
|
|
expect(res.status).toBe("ok");
|
|
const announceArgs = vi.mocked(runSubagentAnnounceFlow).mock.calls[0]?.[0] as
|
|
| { requesterOrigin?: { threadId?: string | number; channel?: string; to?: string } }
|
|
| undefined;
|
|
expect(announceArgs?.requesterOrigin?.channel).toBe("telegram");
|
|
expect(announceArgs?.requesterOrigin?.to).toBe("123");
|
|
expect(announceArgs?.requesterOrigin?.threadId).toBe(42);
|
|
});
|
|
});
|
|
|
|
it("skips announce when messaging tool already sent to target", async () => {
|
|
await withTempHome(async (home) => {
|
|
const storePath = await writeSessionStore(home);
|
|
const deps: CliDeps = {
|
|
sendMessageWhatsApp: vi.fn(),
|
|
sendMessageTelegram: vi.fn(),
|
|
sendMessageDiscord: vi.fn(),
|
|
sendMessageSignal: vi.fn(),
|
|
sendMessageIMessage: vi.fn(),
|
|
};
|
|
vi.mocked(runEmbeddedPiAgent).mockResolvedValue({
|
|
payloads: [{ text: "sent" }],
|
|
meta: {
|
|
durationMs: 5,
|
|
agentMeta: { sessionId: "s", provider: "p", model: "m" },
|
|
},
|
|
didSendViaMessagingTool: true,
|
|
messagingToolSentTargets: [{ tool: "message", provider: "telegram", to: "123" }],
|
|
});
|
|
|
|
const res = await runCronIsolatedAgentTurn({
|
|
cfg: makeCfg(home, storePath, {
|
|
channels: { telegram: { botToken: "t-1" } },
|
|
}),
|
|
deps,
|
|
job: {
|
|
...makeJob({ kind: "agentTurn", message: "do it" }),
|
|
delivery: { mode: "announce", channel: "telegram", to: "123" },
|
|
},
|
|
message: "do it",
|
|
sessionKey: "cron:job-1",
|
|
lane: "cron",
|
|
});
|
|
|
|
expect(res.status).toBe("ok");
|
|
expect(runSubagentAnnounceFlow).not.toHaveBeenCalled();
|
|
expect(deps.sendMessageTelegram).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
it("skips announce for heartbeat-only output", async () => {
|
|
await withTempHome(async (home) => {
|
|
const storePath = await writeSessionStore(home);
|
|
const deps: CliDeps = {
|
|
sendMessageWhatsApp: vi.fn(),
|
|
sendMessageTelegram: vi.fn(),
|
|
sendMessageDiscord: vi.fn(),
|
|
sendMessageSignal: vi.fn(),
|
|
sendMessageIMessage: vi.fn(),
|
|
};
|
|
vi.mocked(runEmbeddedPiAgent).mockResolvedValue({
|
|
payloads: [{ text: "HEARTBEAT_OK" }],
|
|
meta: {
|
|
durationMs: 5,
|
|
agentMeta: { sessionId: "s", provider: "p", model: "m" },
|
|
},
|
|
});
|
|
|
|
const res = await runCronIsolatedAgentTurn({
|
|
cfg: makeCfg(home, storePath, {
|
|
channels: { telegram: { botToken: "t-1" } },
|
|
}),
|
|
deps,
|
|
job: {
|
|
...makeJob({ kind: "agentTurn", message: "do it" }),
|
|
delivery: { mode: "announce", channel: "telegram", to: "123" },
|
|
},
|
|
message: "do it",
|
|
sessionKey: "cron:job-1",
|
|
lane: "cron",
|
|
});
|
|
|
|
expect(res.status).toBe("ok");
|
|
expect(runSubagentAnnounceFlow).not.toHaveBeenCalled();
|
|
expect(deps.sendMessageTelegram).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
it("fails when shared announce flow fails and best-effort is disabled", async () => {
|
|
await withTempHome(async (home) => {
|
|
const storePath = await writeSessionStore(home);
|
|
const deps: CliDeps = {
|
|
sendMessageWhatsApp: vi.fn(),
|
|
sendMessageTelegram: vi.fn().mockRejectedValue(new Error("boom")),
|
|
sendMessageDiscord: vi.fn(),
|
|
sendMessageSignal: vi.fn(),
|
|
sendMessageIMessage: vi.fn(),
|
|
};
|
|
vi.mocked(runEmbeddedPiAgent).mockResolvedValue({
|
|
payloads: [{ text: "hello from cron" }],
|
|
meta: {
|
|
durationMs: 5,
|
|
agentMeta: { sessionId: "s", provider: "p", model: "m" },
|
|
},
|
|
});
|
|
vi.mocked(runSubagentAnnounceFlow).mockResolvedValue(false);
|
|
const res = await runCronIsolatedAgentTurn({
|
|
cfg: makeCfg(home, storePath, {
|
|
channels: { telegram: { botToken: "t-1" } },
|
|
}),
|
|
deps,
|
|
job: {
|
|
...makeJob({ kind: "agentTurn", message: "do it" }),
|
|
delivery: { mode: "announce", channel: "telegram", to: "123" },
|
|
},
|
|
message: "do it",
|
|
sessionKey: "cron:job-1",
|
|
lane: "cron",
|
|
});
|
|
|
|
expect(res.status).toBe("error");
|
|
expect(res.error).toBe("cron announce delivery failed");
|
|
});
|
|
});
|
|
|
|
it("ignores shared announce flow failures when best-effort is enabled", async () => {
|
|
await withTempHome(async (home) => {
|
|
const storePath = await writeSessionStore(home);
|
|
const deps: CliDeps = {
|
|
sendMessageWhatsApp: vi.fn(),
|
|
sendMessageTelegram: vi.fn().mockRejectedValue(new Error("boom")),
|
|
sendMessageDiscord: vi.fn(),
|
|
sendMessageSignal: vi.fn(),
|
|
sendMessageIMessage: vi.fn(),
|
|
};
|
|
vi.mocked(runEmbeddedPiAgent).mockResolvedValue({
|
|
payloads: [{ text: "hello from cron" }],
|
|
meta: {
|
|
durationMs: 5,
|
|
agentMeta: { sessionId: "s", provider: "p", model: "m" },
|
|
},
|
|
});
|
|
vi.mocked(runSubagentAnnounceFlow).mockResolvedValue(false);
|
|
const res = await runCronIsolatedAgentTurn({
|
|
cfg: makeCfg(home, storePath, {
|
|
channels: { telegram: { botToken: "t-1" } },
|
|
}),
|
|
deps,
|
|
job: {
|
|
...makeJob({ kind: "agentTurn", message: "do it" }),
|
|
delivery: {
|
|
mode: "announce",
|
|
channel: "telegram",
|
|
to: "123",
|
|
bestEffort: true,
|
|
},
|
|
},
|
|
message: "do it",
|
|
sessionKey: "cron:job-1",
|
|
lane: "cron",
|
|
});
|
|
|
|
expect(res.status).toBe("ok");
|
|
expect(runSubagentAnnounceFlow).toHaveBeenCalledTimes(1);
|
|
expect(deps.sendMessageTelegram).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
});
|