File size: 13,676 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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 | // Agent session helper tests cover explicit session resolution through config and session stores.
import { beforeEach, describe, expect, it, vi } from "vitest";
import type { OpenClawConfig } from "../../config/config.js";
import { resolveSessionKeyForRequest } from "./session.runtime.js";
const mocks = vi.hoisted(() => ({
listSessionEntriesReadOnly: vi.fn(),
loadExactSessionEntryReadOnly: vi.fn(),
resolveStorePath: vi.fn(),
listAgentIds: vi.fn(),
resolveExplicitAgentSessionKey: vi.fn(),
}));
vi.mock("../../config/sessions/main-session.js", async () => {
const actual = await vi.importActual<typeof import("../../config/sessions/main-session.js")>(
"../../config/sessions/main-session.js",
);
return {
...actual,
resolveExplicitAgentSessionKey: mocks.resolveExplicitAgentSessionKey,
};
});
vi.mock("../../config/sessions/session-accessor.js", () => ({
listSessionEntriesReadOnly: mocks.listSessionEntriesReadOnly,
loadExactSessionEntryReadOnly: mocks.loadExactSessionEntryReadOnly,
}));
vi.mock("../../config/sessions/paths.js", () => ({
resolveSessionStorePathCore: mocks.resolveStorePath,
}));
vi.mock("../../agents/agent-scope.js", async () => {
const { normalizeAgentId } = await vi.importActual<typeof import("../../routing/session-key.js")>(
"../../routing/session-key.js",
);
return {
listAgentIds: mocks.listAgentIds,
resolveDefaultAgentId: (cfg: OpenClawConfig) => {
const agents = cfg.agents?.list ?? [];
return normalizeAgentId(agents.find((agent) => agent?.default)?.id ?? agents[0]?.id);
},
};
});
describe("resolveSessionKeyForRequest", () => {
const MAIN_STORE_PATH = "/tmp/main-store.json";
const MYBOT_STORE_PATH = "/tmp/mybot-store.json";
const SHARED_STORE_PATH = "/tmp/shared-store.json";
type SessionStoreEntry = { sessionId: string; updatedAt: number };
type SessionStoreMap = Record<string, SessionStoreEntry>;
const setupMainAndMybotStorePaths = () => {
mocks.listAgentIds.mockReturnValue(["main", "mybot"]);
mocks.resolveStorePath.mockImplementation(
(_store: string | undefined, opts?: { agentId?: string }) => {
if (opts?.agentId === "mybot") {
return MYBOT_STORE_PATH;
}
return MAIN_STORE_PATH;
},
);
};
const mockStoresByPath = (stores: Partial<Record<string, SessionStoreMap>>) => {
mocks.loadExactSessionEntryReadOnly.mockImplementation(
({ storePath, sessionKey }: { storePath: string; sessionKey: string }) => {
const entry = stores[storePath]?.[sessionKey];
return entry ? { sessionKey, entry: structuredClone(entry) } : undefined;
},
);
mocks.listSessionEntriesReadOnly.mockImplementation((scope?: { storePath?: string }) =>
Object.entries(stores[scope?.storePath ?? ""] ?? {}).map(([sessionKey, entry]) => ({
sessionKey,
entry,
})),
);
};
beforeEach(() => {
vi.clearAllMocks();
mocks.loadExactSessionEntryReadOnly.mockReset();
mocks.listAgentIds.mockReturnValue(["main"]);
mocks.resolveExplicitAgentSessionKey.mockReturnValue(undefined);
});
const baseCfg: OpenClawConfig = {};
it("returns sessionKey when --to resolves a session key via context", () => {
mocks.resolveStorePath.mockReturnValue(MAIN_STORE_PATH);
mockStoresByPath({
[MAIN_STORE_PATH]: {
"agent:main:main": { sessionId: "sess-1", updatedAt: 0 },
},
});
const result = resolveSessionKeyForRequest({
cfg: baseCfg,
to: "+15551234567",
});
expect(result.sessionKey).toBe("agent:main:main");
});
it("uses an agent-scoped --to value as the requested session key", () => {
const sessionKey = "agent:main:openclaw-weixin:direct:o9cq802hhmfc@im.wechat";
mocks.resolveStorePath.mockReturnValue(MAIN_STORE_PATH);
mockStoresByPath({
[MAIN_STORE_PATH]: {
[sessionKey]: { sessionId: "wechat-session", updatedAt: 0 },
},
});
const result = resolveSessionKeyForRequest({
cfg: baseCfg,
to: sessionKey,
});
expect(result.sessionKey).toBe(sessionKey);
});
it("uses the configured default agent store for new --to sessions", () => {
setupMainAndMybotStorePaths();
mockStoresByPath({
[MAIN_STORE_PATH]: {},
[MYBOT_STORE_PATH]: {},
});
const result = resolveSessionKeyForRequest({
cfg: {
agents: { list: [{ id: "mybot", default: true }] },
} satisfies OpenClawConfig,
to: "+15551234567",
});
expect(result.sessionKey).toBe("agent:mybot:main");
expect(result.storePath).toBe(MYBOT_STORE_PATH);
});
it("canonicalizes an explicit main alias for the selected agent", () => {
setupMainAndMybotStorePaths();
mockStoresByPath({
[MAIN_STORE_PATH]: {},
[MYBOT_STORE_PATH]: {},
});
const result = resolveSessionKeyForRequest({
cfg: {
agents: { list: [{ id: "mybot", default: true }] },
session: { mainKey: "work" },
} satisfies OpenClawConfig,
sessionKey: "main",
});
expect(result.sessionKey).toBe("agent:mybot:work");
expect(result.storePath).toBe(MYBOT_STORE_PATH);
});
it("does not adopt another agent's main session for a default-agent request", () => {
setupMainAndMybotStorePaths();
const mainStore = {
"agent:main:main": { sessionId: "legacy-session-id", updatedAt: 1 },
};
const mybotStore = {};
mockStoresByPath({
[MAIN_STORE_PATH]: mainStore,
[MYBOT_STORE_PATH]: mybotStore,
});
const result = resolveSessionKeyForRequest({
cfg: {
agents: { list: [{ id: "mybot", default: true }] },
} satisfies OpenClawConfig,
to: "+15551234567",
});
expect(result.sessionKey).toBe("agent:mybot:main");
expect(result.sessionEntry).toBeUndefined();
expect(result.storePath).toBe(MYBOT_STORE_PATH);
});
it("does not adopt another agent's main session from a literal shared store", () => {
const sharedStore = {
"agent:main:main": { sessionId: "legacy-session-id", updatedAt: 1 },
};
mocks.listAgentIds.mockReturnValue(["main", "mybot"]);
mocks.resolveStorePath.mockReturnValue(SHARED_STORE_PATH);
mockStoresByPath({ [SHARED_STORE_PATH]: sharedStore });
const result = resolveSessionKeyForRequest({
cfg: {
agents: { list: [{ id: "mybot", default: true }] },
session: { store: SHARED_STORE_PATH },
} satisfies OpenClawConfig,
to: "+15551234567",
});
expect(result.sessionKey).toBe("agent:mybot:main");
expect(result.sessionEntry).toBeUndefined();
expect(result.storePath).toBe(SHARED_STORE_PATH);
expect(mocks.listSessionEntriesReadOnly).not.toHaveBeenCalled();
});
it("prefers the configured default-agent session over legacy main-store rows", () => {
setupMainAndMybotStorePaths();
const mybotStore = {
"agent:mybot:main": { sessionId: "current-session-id", updatedAt: 2 },
};
mockStoresByPath({
[MAIN_STORE_PATH]: {
"agent:main:main": { sessionId: "legacy-session-id", updatedAt: 1 },
},
[MYBOT_STORE_PATH]: mybotStore,
});
const result = resolveSessionKeyForRequest({
cfg: {
agents: { list: [{ id: "mybot", default: true }] },
} satisfies OpenClawConfig,
to: "+15551234567",
});
expect(result.sessionKey).toBe("agent:mybot:main");
expect(result.sessionEntry).toEqual(mybotStore["agent:mybot:main"]);
expect(result.storePath).toBe(MYBOT_STORE_PATH);
});
it("finds session by sessionId via reverse lookup in primary store", () => {
mocks.resolveStorePath.mockReturnValue(MAIN_STORE_PATH);
mockStoresByPath({
[MAIN_STORE_PATH]: {
"agent:main:main": { sessionId: "target-session-id", updatedAt: 0 },
},
});
const result = resolveSessionKeyForRequest({
cfg: baseCfg,
sessionId: "target-session-id",
});
expect(result.sessionKey).toBe("agent:main:main");
});
it("finds session by sessionId in non-primary agent store", () => {
setupMainAndMybotStorePaths();
mockStoresByPath({
[MYBOT_STORE_PATH]: {
"agent:mybot:main": { sessionId: "target-session-id", updatedAt: 0 },
},
});
const result = resolveSessionKeyForRequest({
cfg: baseCfg,
sessionId: "target-session-id",
});
expect(result.sessionKey).toBe("agent:mybot:main");
expect(result.storePath).toBe(MYBOT_STORE_PATH);
});
it("does not let --agent short-circuit --session-id back to the agent main session", () => {
setupMainAndMybotStorePaths();
mocks.resolveExplicitAgentSessionKey.mockReturnValue("agent:mybot:main");
mockStoresByPath({
[MYBOT_STORE_PATH]: {
"agent:mybot:main": { sessionId: "other-session-id", updatedAt: 0 },
"agent:mybot:whatsapp:direct:+15551234567": {
sessionId: "target-session-id",
updatedAt: 1,
},
},
});
const result = resolveSessionKeyForRequest({
cfg: baseCfg,
agentId: "mybot",
sessionId: "target-session-id",
});
expect(result.sessionKey).toBe("agent:mybot:whatsapp:direct:+15551234567");
expect(result.storePath).toBe(MYBOT_STORE_PATH);
});
it("treats whitespace --session-id as absent when resolving --agent", () => {
setupMainAndMybotStorePaths();
mocks.resolveExplicitAgentSessionKey.mockReturnValue("agent:mybot:main");
mockStoresByPath({
[MYBOT_STORE_PATH]: {
"agent:mybot:main": { sessionId: "existing-session-id", updatedAt: 1 },
},
});
const result = resolveSessionKeyForRequest({
cfg: baseCfg,
agentId: "mybot",
sessionId: " ",
});
expect(result.sessionKey).toBe("agent:mybot:main");
expect(result.storePath).toBe(MYBOT_STORE_PATH);
});
it("does not search other agent stores when --agent scopes --session-id", () => {
setupMainAndMybotStorePaths();
mockStoresByPath({
[MAIN_STORE_PATH]: {
"agent:main:whatsapp:direct:+15550000000": {
sessionId: "target-session-id",
updatedAt: 10,
},
},
[MYBOT_STORE_PATH]: {},
});
const result = resolveSessionKeyForRequest({
cfg: baseCfg,
agentId: "mybot",
sessionId: "target-session-id",
});
expect(result.sessionKey).toBe("agent:mybot:explicit:target-session-id");
expect(result.storePath).toBe(MYBOT_STORE_PATH);
expect(mocks.listSessionEntriesReadOnly).toHaveBeenCalledTimes(1);
expect(mocks.listSessionEntriesReadOnly).toHaveBeenCalledWith({
agentId: "mybot",
storePath: MYBOT_STORE_PATH,
clone: false,
});
});
it("returns the selected entry when session is found in a non-primary agent store", () => {
const mybotStore = {
"agent:mybot:main": { sessionId: "target-session-id", updatedAt: 0 },
};
setupMainAndMybotStorePaths();
mockStoresByPath({
[MYBOT_STORE_PATH]: { ...mybotStore },
});
const result = resolveSessionKeyForRequest({
cfg: baseCfg,
sessionId: "target-session-id",
});
expect(result.sessionEntry?.sessionId).toBe("target-session-id");
});
it("returns a deterministic explicit sessionKey when sessionId not found in any store", () => {
setupMainAndMybotStorePaths();
mocks.listSessionEntriesReadOnly.mockReturnValue([]);
const result = resolveSessionKeyForRequest({
cfg: baseCfg,
sessionId: "nonexistent-id",
});
expect(result.sessionKey).toBe("agent:main:explicit:nonexistent-id");
});
it("does not search other stores when explicitSessionKey is set", () => {
mocks.listAgentIds.mockReturnValue(["main", "mybot"]);
mocks.resolveStorePath.mockReturnValue(MAIN_STORE_PATH);
mockStoresByPath({
[MAIN_STORE_PATH]: {
"agent:main:main": { sessionId: "other-id", updatedAt: 0 },
},
});
const result = resolveSessionKeyForRequest({
cfg: baseCfg,
sessionKey: "agent:main:main",
sessionId: "target-session-id",
});
// explicitSessionKey is set, so sessionKey comes from it, not from sessionId lookup
expect(result.sessionKey).toBe("agent:main:main");
});
it("searches other stores when --to derives a key that does not match --session-id", () => {
setupMainAndMybotStorePaths();
mockStoresByPath({
[MAIN_STORE_PATH]: {
"agent:main:main": { sessionId: "other-session-id", updatedAt: 0 },
},
[MYBOT_STORE_PATH]: {
"agent:mybot:main": { sessionId: "target-session-id", updatedAt: 0 },
},
});
const result = resolveSessionKeyForRequest({
cfg: baseCfg,
to: "+15551234567",
sessionId: "target-session-id",
});
// --to derives agent:main:main, but its sessionId doesn't match target-session-id,
// so the cross-store search finds it in the mybot store
expect(result.sessionKey).toBe("agent:mybot:main");
expect(result.storePath).toBe(MYBOT_STORE_PATH);
});
it("skips already-searched primary store when iterating agents", () => {
setupMainAndMybotStorePaths();
mocks.listSessionEntriesReadOnly.mockReturnValue([]);
resolveSessionKeyForRequest({
cfg: baseCfg,
sessionId: "nonexistent-id",
});
// listSessionEntriesReadOnly should be called twice: once for main, once for mybot
// (not twice for main)
const storePaths = mocks.listSessionEntriesReadOnly.mock.calls.map((call) =>
String(call[0]?.storePath),
);
expect(storePaths).toHaveLength(2);
expect(storePaths).toContain(MAIN_STORE_PATH);
expect(storePaths).toContain(MYBOT_STORE_PATH);
});
});
|