File size: 14,430 Bytes
f778c12 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 | // Boundary proof: real silent dispatch, service persistence, Gateway handlers, and CLI rendering.
// The agent-output input and RPC transport are test boundaries; no provider or channel send is claimed.
import { randomUUID } from "node:crypto";
import { expectDefined } from "@openclaw/normalization-core";
import { Command } from "commander";
import { afterEach, describe, expect, it, vi } from "vitest";
import { isRich, theme } from "../../../packages/terminal-core/src/theme.js";
import { resolveCronDeliveryPlan } from "../../cron/delivery-plan.js";
import { dispatchCronDelivery } from "../../cron/isolated-agent/delivery-dispatch.js";
import { CronService, type CronEvent } from "../../cron/service.js";
import { createNoopLogger } from "../../cron/service.test-harness.js";
import type { CronServiceDeps } from "../../cron/service/state.js";
import { loadCronStore } from "../../cron/store.js";
import { cronStoreKey } from "../../cron/store/key.js";
import { readCronTaskRunHistoryPage } from "../../cron/task-run-history.js";
import type { CronJob } from "../../cron/types.js";
import { cronHandlers } from "../../gateway/server-methods/cron.js";
import type { RespondFn } from "../../gateway/server-methods/types.js";
import { getActiveGatewayRootWorkCount } from "../../process/gateway-work-admission.js";
import { ExitError } from "../../runtime.js";
import { resetTaskRegistryForTests } from "../../tasks/task-runtime.test-helpers.js";
import { withOpenClawTestState } from "../../test-utils/openclaw-test-state.js";
const mocks = vi.hoisted(() => ({
runtime: {
log: vi.fn(),
error: vi.fn(),
writeStdout: vi.fn(),
writeJson: vi.fn(),
exit: vi.fn(),
},
callGatewayFromCli: vi.fn(),
}));
vi.mock("../gateway-rpc.js", async () => {
const actual = await vi.importActual<typeof import("../gateway-rpc.js")>("../gateway-rpc.js");
return { ...actual, callGatewayFromCli: mocks.callGatewayFromCli };
});
vi.mock("../../runtime.js", async () => {
const actual = await vi.importActual<typeof import("../../runtime.js")>("../../runtime.js");
return { ...actual, defaultRuntime: mocks.runtime };
});
const { registerCronCli } = await import("../cron-cli.js");
async function runCli(args: string[]) {
for (const mock of Object.values(mocks.runtime)) {
mock.mockClear();
}
const program = new Command();
program.exitOverride();
registerCronCli(program);
let exitCode: number | undefined;
try {
await program.parseAsync(["cron", ...args], { from: "user" });
} catch (error) {
if (!(error instanceof ExitError)) {
throw error;
}
exitCode = error.code;
}
expect(mocks.runtime.error).not.toHaveBeenCalled();
return {
text: mocks.runtime.log.mock.calls.map(([line]) => String(line)).join("\n"),
json: mocks.runtime.writeJson.mock.calls.at(-1)?.[0],
exitCode,
};
}
function installGatewayTransport(cron: CronService, storePath: string) {
const invoke = async (method: string, params: Record<string, unknown> = {}) => {
const handler = expectDefined(cronHandlers[method], `missing Gateway method ${method}`);
let response: { ok: boolean; payload?: unknown; error?: { message?: string } } | undefined;
const respond: RespondFn = (ok, payload, error) => {
response = { ok, payload, error };
};
await handler({
req: {} as never,
client: null,
params,
respond,
context: { cron, cronStorePath: storePath, getRuntimeConfig: () => ({}) } as never,
} as never);
const result = expectDefined(response, `${method} returned no response`);
expect(result.ok, result.error?.message).toBe(true);
// JSON wire encoding drops undefined fields; structuredClone would preserve them.
// oxlint-disable-next-line unicorn/prefer-structured-clone
return JSON.parse(JSON.stringify(result.payload)) as unknown;
};
mocks.callGatewayFromCli.mockImplementation(
async (method: string, _options: unknown, params?: Record<string, unknown>) =>
invoke(method, params),
);
return invoke;
}
afterEach(() => {
mocks.callGatewayFromCli.mockReset();
vi.restoreAllMocks();
});
describe("cron CLI delivery suppression readback", () => {
it("distinguishes intentional silence from failures across repeated runs of one stored job", async () => {
await withOpenClawTestState(
{ layout: "home", prefix: "openclaw-cron-cli-suppression-" },
async (state) => {
await state.writeConfig({});
resetTaskRegistryForTests({ persist: false });
const storePath = state.statePath("cron", "jobs.json");
const events: CronEvent[] = [];
let phase:
| "silent"
| "delivery-error"
| "required-delivery-error"
| "execution-error"
| "not-requested" = "silent";
const runIsolatedAgentJob: CronServiceDeps["runIsolatedAgentJob"] = async ({
job,
abortSignal,
}) => {
if (phase === "execution-error") {
throw new Error("fixture agent execution failed");
}
const text = phase === "silent" ? "NO_REPLY" : "Actionable update";
const sessionId = randomUUID();
const sessionKey = `agent:main:cron:${job.id}:run:${sessionId}`;
const now = Date.now();
const dispatch = await dispatchCronDelivery({
cfg: {},
cfgWithAgentDefaults: {},
deps: {},
job,
agentId: "main",
agentSessionKey: sessionKey,
runSessionKey: sessionKey,
sessionId,
lifecycleRevision: randomUUID(),
sessionUpdatedAt: now,
runStartedAt: now,
runEndedAt: now,
timeoutMs: 5_000,
resolvedDelivery:
phase === "delivery-error" || phase === "required-delivery-error"
? {
ok: false,
mode: "explicit",
error: new Error("fixture delivery route unavailable"),
}
: { ok: true, mode: "explicit", channel: "telegram", to: "123" },
deliveryPlan: resolveCronDeliveryPlan(job),
deliveryRequested: phase !== "not-requested",
undeliveredRunStatus: "ok",
spawnOnlyHandoff: false,
sourceDeliveryOutcome: {
visibleDeliveries: [],
verifiedMessageToolDelivery: false,
satisfiesSourceDelivery: false,
unverifiedMessageToolDelivery: false,
},
deliveryBestEffort: job.delivery?.bestEffort === true,
deliveryPayloadHasStructuredContent: false,
deliveryPayloads: [{ text }],
synthesizedText: text,
summary: text,
outputText: text,
abortSignal,
isAborted: () => abortSignal?.aborted === true,
abortReason: () => "fixture aborted",
withRunSession: (result) => ({ ...result, sessionId, sessionKey }),
});
return {
status: "ok",
...dispatch.result,
delivered: dispatch.delivered,
deliveryAttempted: dispatch.deliveryAttempted,
deliveryError: dispatch.deliveryError,
deliverySuppressionReason: dispatch.deliverySuppressionReason,
deliveryState: dispatch.deliveryState,
};
};
const cron = new CronService({
storePath,
defaultAgentId: "main",
cronEnabled: true,
log: createNoopLogger(),
enqueueSystemEvent: vi.fn(),
requestHeartbeat: vi.fn(),
runIsolatedAgentJob,
onEvent: (event) => {
if (event.action === "finished") {
events.push(event);
}
},
});
const invoke = installGatewayTransport(cron, storePath);
try {
await cron.start();
const job = await cron.add({
name: "idle-check",
enabled: true,
schedule: { kind: "every", everyMs: 3_600_000 },
sessionTarget: "isolated",
wakeMode: "next-heartbeat",
payload: { kind: "agentTurn", message: "Check for work; reply NO_REPLY when idle." },
delivery: { mode: "announce", channel: "telegram", to: "123" },
});
for (const nextPhase of [
"silent",
"delivery-error",
"required-delivery-error",
"execution-error",
"silent",
"not-requested",
] as const) {
phase = nextPhase;
await cron.update(job.id, {
delivery:
phase === "not-requested"
? { mode: "none" }
: {
mode: "announce",
channel: "telegram",
to: "123",
bestEffort: phase === "delivery-error",
},
});
const run = await runCli([
"run",
job.id,
"--wait",
"--wait-timeout",
"10s",
"--poll-interval",
"10ms",
]);
const failed = phase === "execution-error" || phase === "required-delivery-error";
const expectedStatus = failed ? "error" : "ok";
const completionStatus = failed ? "failed" : "succeeded";
const deliveryStatus =
phase === "execution-error"
? "unknown"
: phase === "not-requested"
? "not-requested"
: "not-delivered";
const delivered = phase === "execution-error" ? undefined : false;
expect(run.exitCode).toBe(failed ? 1 : 0);
await vi.waitFor(() => expect(getActiveGatewayRootWorkCount()).toBe(0));
const reason = phase === "silent" ? "silent" : undefined;
const persisted = expectDefined(
(await loadCronStore(storePath)).jobs.find((entry) => entry.id === job.id),
"expected persisted cron job",
);
expect(persisted.state.deliverySuppressionReason).toBe(reason);
expect(persisted.state).toMatchObject({
lastRunStatus: expectedStatus,
lastDeliveryStatus: deliveryStatus,
});
expect(persisted.state.lastDelivered).toBe(delivered);
const history = readCronTaskRunHistoryPage({
storeKey: cronStoreKey(storePath),
jobId: job.id,
});
expect(history.entries[0]?.deliverySuppressionReason).toBe(reason);
const outcome = { status: expectedStatus, completionStatus, deliveryStatus };
expect(history.entries[0]).toMatchObject(outcome);
expect(history.entries[0]?.delivered).toBe(delivered);
expect(run.json).toMatchObject({
completed: true,
status: expectedStatus,
completionStatus,
run: outcome,
});
if (phase === "silent" || phase === "not-requested") {
expect(persisted.state.lastError).toBeUndefined();
expect(persisted.state.lastDeliveryError).toBeUndefined();
expect(history.entries[0]?.deliveryError).toBeUndefined();
} else {
expect(persisted.state.lastDeliveryError).toContain(
phase === "execution-error"
? "fixture agent execution failed"
: "fixture delivery route unavailable",
);
}
expect(events.at(-1)?.deliverySuppressionReason).toBe(reason);
expect(
(run.json as { run: { deliverySuppressionReason?: string } }).run
.deliverySuppressionReason,
).toBe(reason);
const get = (await runCli(["get", job.id])).json as CronJob & {
deliverySuppressionReason?: string;
};
expect(get.deliverySuppressionReason).toBe(reason);
expect(get.state.deliverySuppressionReason).toBe(reason);
const compact = (await invoke("cron.list", { compact: true })) as {
jobs: Array<{ deliverySuppressionReason?: string }>;
};
expect(compact.jobs[0]?.deliverySuppressionReason).toBe(reason);
const listJson = (await runCli(["list", "--json"])).json as { jobs: CronJob[] };
expect(listJson.jobs[0]?.state.deliverySuppressionReason).toBe(reason);
const list = await runCli(["list"]);
const show = await runCli(["show", job.id]);
if (isRich()) {
const color = failed
? theme.error
: phase === "delivery-error"
? theme.warn
: theme.success;
const probe = color("probe");
const expectedAnsi = probe.slice(0, probe.indexOf("probe"));
expect(expectedAnsi).not.toBe("");
expect.soft(list.text).toContain(`${expectedAnsi}${expectedStatus}`);
}
if (phase === "silent") {
expect.soft(list.text).toMatch(/silent|suppressed/i);
expect.soft(show.text).toMatch(/silent|suppressed/i);
expect.soft(list.text).not.toContain("ok (not delivered)");
expect.soft(show.text).not.toContain("ok (not delivered)");
} else if (phase === "delivery-error") {
expect(list.text).toContain("ok (not delivered)");
expect(show.text).toContain(
"last delivery error: fixture delivery route unavailable",
);
} else if (failed) {
expect(show.text).toContain("status: error");
expect(show.text).not.toContain("ok (not delivered)");
} else {
expect(show.text).toContain("status: ok");
expect(show.text).not.toContain("ok (not delivered)");
}
}
expect(events).toHaveLength(6);
expect(
readCronTaskRunHistoryPage({ storeKey: cronStoreKey(storePath), jobId: job.id }).total,
).toBe(6);
} finally {
cron.stop();
resetTaskRegistryForTests({ persist: false });
}
},
);
}, 30_000);
});
|