fix: align cron session key routing (#18637) (thanks @vignesh07)

This commit is contained in:
Peter Steinberger
2026-02-17 01:53:52 +01:00
parent 064a3079cb
commit c20ef582cb
5 changed files with 126 additions and 2 deletions

View File

@@ -0,0 +1,36 @@
import { beforeEach, describe, expect, it, vi } from "vitest";
const callGatewayMock = vi.fn();
vi.mock("../../gateway/call.js", () => ({
callGateway: (opts: unknown) => callGatewayMock(opts),
}));
vi.mock("../agent-scope.js", () => ({
resolveSessionAgentId: () => "agent-123",
}));
import { createCronTool } from "./cron-tool.js";
describe("cron tool flat-params", () => {
beforeEach(() => {
callGatewayMock.mockReset();
callGatewayMock.mockResolvedValue({ ok: true });
});
it("preserves explicit top-level sessionKey during flat-params recovery", async () => {
const tool = createCronTool({ agentSessionKey: "agent:main:discord:channel:ops" });
await tool.execute("call-flat-session-key", {
action: "add",
sessionKey: "agent:main:telegram:group:-100123:topic:99",
schedule: { kind: "at", at: new Date(123).toISOString() },
message: "do stuff",
});
const call = callGatewayMock.mock.calls[0]?.[0] as {
method?: string;
params?: { sessionKey?: string };
};
expect(call.method).toBe("cron.add");
expect(call.params?.sessionKey).toBe("agent:main:telegram:group:-100123:topic:99");
});
});

View File

@@ -299,6 +299,7 @@ Use jobId as the canonical identifier; id is accepted for compatibility. Use con
"description",
"deleteAfterRun",
"agentId",
"sessionKey",
"message",
"text",
"model",

View File

@@ -0,0 +1,81 @@
import os from "node:os";
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";
const enqueueSystemEventMock = vi.fn();
const requestHeartbeatNowMock = vi.fn();
const loadConfigMock = vi.fn();
vi.mock("../infra/system-events.js", () => ({
enqueueSystemEvent: (...args: unknown[]) => enqueueSystemEventMock(...args),
}));
vi.mock("../infra/heartbeat-wake.js", () => ({
requestHeartbeatNow: (...args: unknown[]) => requestHeartbeatNowMock(...args),
}));
vi.mock("../config/config.js", async () => {
const actual = await vi.importActual<typeof import("../config/config.js")>("../config/config.js");
return {
...actual,
loadConfig: () => loadConfigMock(),
};
});
import { buildGatewayCronService } from "./server-cron.js";
describe("buildGatewayCronService", () => {
beforeEach(() => {
enqueueSystemEventMock.mockReset();
requestHeartbeatNowMock.mockReset();
loadConfigMock.mockReset();
});
it("canonicalizes non-agent sessionKey to agent store key for enqueue + wake", async () => {
const tmpDir = path.join(os.tmpdir(), `server-cron-${Date.now()}`);
const cfg = {
session: {
mainKey: "main",
},
cron: {
store: path.join(tmpDir, "cron.json"),
},
} as OpenClawConfig;
loadConfigMock.mockReturnValue(cfg);
const state = buildGatewayCronService({
cfg,
deps: {} as CliDeps,
broadcast: () => {},
});
try {
const job = await state.cron.add({
name: "canonicalize-session-key",
enabled: true,
schedule: { kind: "at", at: new Date(1).toISOString() },
sessionTarget: "main",
wakeMode: "next-heartbeat",
sessionKey: "discord:channel:ops",
payload: { kind: "systemEvent", text: "hello" },
});
await state.cron.run(job.id, "force");
expect(enqueueSystemEventMock).toHaveBeenCalledWith(
"hello",
expect.objectContaining({
sessionKey: "agent:main:discord:channel:ops",
}),
);
expect(requestHeartbeatNowMock).toHaveBeenCalledWith(
expect.objectContaining({
sessionKey: "agent:main:discord:channel:ops",
}),
);
} finally {
state.cron.stop();
}
});
});

View File

@@ -16,7 +16,7 @@ import { runHeartbeatOnce } from "../infra/heartbeat-runner.js";
import { requestHeartbeatNow } from "../infra/heartbeat-wake.js";
import { enqueueSystemEvent } from "../infra/system-events.js";
import { getChildLogger } from "../logging.js";
import { normalizeAgentId } from "../routing/session-key.js";
import { normalizeAgentId, toAgentStoreSessionKey } from "../routing/session-key.js";
import { defaultRuntime } from "../runtime.js";
export type GatewayCronState = {
@@ -98,10 +98,15 @@ export function buildGatewayCronService(params: {
agentId: params.agentId,
});
}
const candidate = toAgentStoreSessionKey({
agentId: params.agentId,
requestKey: requested,
mainKey: params.runtimeConfig.session?.mainKey,
});
const canonical = canonicalizeMainSessionAlias({
cfg: params.runtimeConfig,
agentId: params.agentId,
sessionKey: requested,
sessionKey: candidate,
});
if (canonical !== "global") {
const sessionAgentId = resolveAgentIdFromSessionKey(canonical);