File size: 15,221 Bytes
fc93158 | 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 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 | import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import {
clearInternalHooks,
createInternalHookEvent,
getRegisteredEventKeys,
isAgentBootstrapEvent,
isGatewayStartupEvent,
isMessageReceivedEvent,
isMessageSentEvent,
registerInternalHook,
triggerInternalHook,
unregisterInternalHook,
type AgentBootstrapHookContext,
type GatewayStartupHookContext,
type MessageReceivedHookContext,
type MessageSentHookContext,
} from "./internal-hooks.js";
describe("hooks", () => {
beforeEach(() => {
clearInternalHooks();
});
afterEach(() => {
clearInternalHooks();
});
describe("registerInternalHook", () => {
it("should register a hook handler", () => {
const handler = vi.fn();
registerInternalHook("command:new", handler);
const keys = getRegisteredEventKeys();
expect(keys).toContain("command:new");
});
it("should allow multiple handlers for the same event", () => {
const handler1 = vi.fn();
const handler2 = vi.fn();
registerInternalHook("command:new", handler1);
registerInternalHook("command:new", handler2);
const keys = getRegisteredEventKeys();
expect(keys).toContain("command:new");
});
});
describe("unregisterInternalHook", () => {
it("should unregister a specific handler", () => {
const handler1 = vi.fn();
const handler2 = vi.fn();
registerInternalHook("command:new", handler1);
registerInternalHook("command:new", handler2);
unregisterInternalHook("command:new", handler1);
const event = createInternalHookEvent("command", "new", "test-session");
void triggerInternalHook(event);
expect(handler1).not.toHaveBeenCalled();
expect(handler2).toHaveBeenCalled();
});
it("should clean up empty handler arrays", () => {
const handler = vi.fn();
registerInternalHook("command:new", handler);
unregisterInternalHook("command:new", handler);
const keys = getRegisteredEventKeys();
expect(keys).not.toContain("command:new");
});
});
describe("triggerInternalHook", () => {
it("should trigger handlers for general event type", async () => {
const handler = vi.fn();
registerInternalHook("command", handler);
const event = createInternalHookEvent("command", "new", "test-session");
await triggerInternalHook(event);
expect(handler).toHaveBeenCalledWith(event);
});
it("should trigger handlers for specific event action", async () => {
const handler = vi.fn();
registerInternalHook("command:new", handler);
const event = createInternalHookEvent("command", "new", "test-session");
await triggerInternalHook(event);
expect(handler).toHaveBeenCalledWith(event);
});
it("should trigger both general and specific handlers", async () => {
const generalHandler = vi.fn();
const specificHandler = vi.fn();
registerInternalHook("command", generalHandler);
registerInternalHook("command:new", specificHandler);
const event = createInternalHookEvent("command", "new", "test-session");
await triggerInternalHook(event);
expect(generalHandler).toHaveBeenCalledWith(event);
expect(specificHandler).toHaveBeenCalledWith(event);
});
it("should handle async handlers", async () => {
const handler = vi.fn(async () => {
await Promise.resolve();
});
registerInternalHook("command:new", handler);
const event = createInternalHookEvent("command", "new", "test-session");
await triggerInternalHook(event);
expect(handler).toHaveBeenCalledWith(event);
});
it("should catch and log errors from handlers", async () => {
const errorHandler = vi.fn(() => {
throw new Error("Handler failed");
});
const successHandler = vi.fn();
registerInternalHook("command:new", errorHandler);
registerInternalHook("command:new", successHandler);
const event = createInternalHookEvent("command", "new", "test-session");
await triggerInternalHook(event);
expect(errorHandler).toHaveBeenCalled();
expect(successHandler).toHaveBeenCalled();
});
it("should not throw if no handlers are registered", async () => {
const event = createInternalHookEvent("command", "new", "test-session");
await expect(triggerInternalHook(event)).resolves.not.toThrow();
});
it("stores handlers in the global singleton registry", async () => {
const globalHooks = globalThis as typeof globalThis & {
__openclaw_internal_hook_handlers__?: Map<string, Array<(event: unknown) => unknown>>;
};
const handler = vi.fn();
registerInternalHook("command:new", handler);
const event = createInternalHookEvent("command", "new", "test-session");
await triggerInternalHook(event);
expect(handler).toHaveBeenCalledWith(event);
expect(globalHooks.__openclaw_internal_hook_handlers__?.has("command:new")).toBe(true);
const injectedHandler = vi.fn();
globalHooks.__openclaw_internal_hook_handlers__?.set("command:new", [injectedHandler]);
await triggerInternalHook(event);
expect(injectedHandler).toHaveBeenCalledWith(event);
});
});
describe("createInternalHookEvent", () => {
it("should create a properly formatted event", () => {
const event = createInternalHookEvent("command", "new", "test-session", {
foo: "bar",
});
expect(event.type).toBe("command");
expect(event.action).toBe("new");
expect(event.sessionKey).toBe("test-session");
expect(event.context).toEqual({ foo: "bar" });
expect(event.timestamp).toBeInstanceOf(Date);
});
it("should use empty context if not provided", () => {
const event = createInternalHookEvent("command", "new", "test-session");
expect(event.context).toEqual({});
});
});
describe("isAgentBootstrapEvent", () => {
const cases: Array<{
name: string;
event: ReturnType<typeof createInternalHookEvent>;
expected: boolean;
}> = [
{
name: "returns true for agent:bootstrap events with expected context",
event: createInternalHookEvent("agent", "bootstrap", "test-session", {
workspaceDir: "/tmp",
bootstrapFiles: [],
} satisfies AgentBootstrapHookContext),
expected: true,
},
{
name: "returns false for non-bootstrap events",
event: createInternalHookEvent("command", "new", "test-session"),
expected: false,
},
];
for (const testCase of cases) {
it(testCase.name, () => {
expect(isAgentBootstrapEvent(testCase.event)).toBe(testCase.expected);
});
}
});
describe("isGatewayStartupEvent", () => {
const cases: Array<{
name: string;
event: ReturnType<typeof createInternalHookEvent>;
expected: boolean;
}> = [
{
name: "returns true for gateway:startup events with expected context",
event: createInternalHookEvent("gateway", "startup", "gateway:startup", {
cfg: {},
} satisfies GatewayStartupHookContext),
expected: true,
},
{
name: "returns false for non-startup gateway events",
event: createInternalHookEvent("gateway", "shutdown", "gateway:shutdown", {}),
expected: false,
},
];
for (const testCase of cases) {
it(testCase.name, () => {
expect(isGatewayStartupEvent(testCase.event)).toBe(testCase.expected);
});
}
});
describe("isMessageReceivedEvent", () => {
const cases: Array<{
name: string;
event: ReturnType<typeof createInternalHookEvent>;
expected: boolean;
}> = [
{
name: "returns true for message:received events with expected context",
event: createInternalHookEvent("message", "received", "test-session", {
from: "+1234567890",
content: "Hello world",
channelId: "whatsapp",
conversationId: "chat-123",
timestamp: Date.now(),
} satisfies MessageReceivedHookContext),
expected: true,
},
{
name: "returns false for message:sent events",
event: createInternalHookEvent("message", "sent", "test-session", {
to: "+1234567890",
content: "Hello world",
success: true,
channelId: "whatsapp",
} satisfies MessageSentHookContext),
expected: false,
},
];
for (const testCase of cases) {
it(testCase.name, () => {
expect(isMessageReceivedEvent(testCase.event)).toBe(testCase.expected);
});
}
});
describe("isMessageSentEvent", () => {
const cases: Array<{
name: string;
event: ReturnType<typeof createInternalHookEvent>;
expected: boolean;
}> = [
{
name: "returns true for message:sent events with expected context",
event: createInternalHookEvent("message", "sent", "test-session", {
to: "+1234567890",
content: "Hello world",
success: true,
channelId: "telegram",
conversationId: "chat-456",
messageId: "msg-789",
} satisfies MessageSentHookContext),
expected: true,
},
{
name: "returns true when success is false (error case)",
event: createInternalHookEvent("message", "sent", "test-session", {
to: "+1234567890",
content: "Hello world",
success: false,
error: "Network error",
channelId: "whatsapp",
} satisfies MessageSentHookContext),
expected: true,
},
{
name: "returns false for message:received events",
event: createInternalHookEvent("message", "received", "test-session", {
from: "+1234567890",
content: "Hello world",
channelId: "whatsapp",
} satisfies MessageReceivedHookContext),
expected: false,
},
];
for (const testCase of cases) {
it(testCase.name, () => {
expect(isMessageSentEvent(testCase.event)).toBe(testCase.expected);
});
}
});
describe("message type-guard shared negatives", () => {
it("returns false for non-message and missing-context shapes", () => {
const cases: Array<{
match: (event: ReturnType<typeof createInternalHookEvent>) => boolean;
}> = [
{
match: isMessageReceivedEvent,
},
{
match: isMessageSentEvent,
},
];
const nonMessageEvent = createInternalHookEvent("command", "new", "test-session");
const missingReceivedContext = createInternalHookEvent(
"message",
"received",
"test-session",
{
from: "+1234567890",
// missing channelId
},
);
const missingSentContext = createInternalHookEvent("message", "sent", "test-session", {
to: "+1234567890",
channelId: "whatsapp",
// missing success
});
for (const testCase of cases) {
expect(testCase.match(nonMessageEvent)).toBe(false);
}
expect(isMessageReceivedEvent(missingReceivedContext)).toBe(false);
expect(isMessageSentEvent(missingSentContext)).toBe(false);
});
});
describe("message hooks", () => {
it("should trigger message:received handlers", async () => {
const handler = vi.fn();
registerInternalHook("message:received", handler);
const context: MessageReceivedHookContext = {
from: "+1234567890",
content: "Hello world",
channelId: "whatsapp",
conversationId: "chat-123",
};
const event = createInternalHookEvent("message", "received", "test-session", context);
await triggerInternalHook(event);
expect(handler).toHaveBeenCalledWith(event);
});
it("should trigger message:sent handlers", async () => {
const handler = vi.fn();
registerInternalHook("message:sent", handler);
const context: MessageSentHookContext = {
to: "+1234567890",
content: "Hello world",
success: true,
channelId: "telegram",
messageId: "msg-123",
};
const event = createInternalHookEvent("message", "sent", "test-session", context);
await triggerInternalHook(event);
expect(handler).toHaveBeenCalledWith(event);
});
it("should trigger general message handlers for both received and sent", async () => {
const handler = vi.fn();
registerInternalHook("message", handler);
const receivedContext: MessageReceivedHookContext = {
from: "+1234567890",
content: "Hello",
channelId: "whatsapp",
};
const receivedEvent = createInternalHookEvent(
"message",
"received",
"test-session",
receivedContext,
);
await triggerInternalHook(receivedEvent);
const sentContext: MessageSentHookContext = {
to: "+1234567890",
content: "World",
success: true,
channelId: "whatsapp",
};
const sentEvent = createInternalHookEvent("message", "sent", "test-session", sentContext);
await triggerInternalHook(sentEvent);
expect(handler).toHaveBeenCalledTimes(2);
expect(handler).toHaveBeenNthCalledWith(1, receivedEvent);
expect(handler).toHaveBeenNthCalledWith(2, sentEvent);
});
it("should handle hook errors without breaking message processing", async () => {
const errorHandler = vi.fn(() => {
throw new Error("Hook failed");
});
const successHandler = vi.fn();
registerInternalHook("message:received", errorHandler);
registerInternalHook("message:received", successHandler);
const context: MessageReceivedHookContext = {
from: "+1234567890",
content: "Hello",
channelId: "whatsapp",
};
const event = createInternalHookEvent("message", "received", "test-session", context);
await triggerInternalHook(event);
// Both handlers were called
expect(errorHandler).toHaveBeenCalled();
expect(successHandler).toHaveBeenCalled();
});
});
describe("getRegisteredEventKeys", () => {
it("should return all registered event keys", () => {
registerInternalHook("command:new", vi.fn());
registerInternalHook("command:stop", vi.fn());
registerInternalHook("session:start", vi.fn());
const keys = getRegisteredEventKeys();
expect(keys).toContain("command:new");
expect(keys).toContain("command:stop");
expect(keys).toContain("session:start");
});
it("should return empty array when no handlers are registered", () => {
const keys = getRegisteredEventKeys();
expect(keys).toEqual([]);
});
});
describe("clearInternalHooks", () => {
it("should remove all registered handlers", () => {
registerInternalHook("command:new", vi.fn());
registerInternalHook("command:stop", vi.fn());
clearInternalHooks();
const keys = getRegisteredEventKeys();
expect(keys).toEqual([]);
});
});
});
|