import fs from "node:fs/promises"; import os from "node:os"; import path from "node:path"; import { describe, expect, it, vi } from "vitest"; import type { OpenClawConfig } from "../config/config.js"; import type { GroupKeyResolution } from "../config/sessions.js"; import { createInboundDebouncer } from "./inbound-debounce.js"; import { resolveGroupRequireMention } from "./reply/groups.js"; import { finalizeInboundContext } from "./reply/inbound-context.js"; import { buildInboundDedupeKey, resetInboundDedupe, shouldSkipDuplicateInbound, } from "./reply/inbound-dedupe.js"; import { normalizeInboundTextNewlines } from "./reply/inbound-text.js"; import { buildMentionRegexes, matchesMentionPatterns, normalizeMentionText, } from "./reply/mentions.js"; import { initSessionState } from "./reply/session.js"; import { applyTemplate, type MsgContext, type TemplateContext } from "./templating.js"; describe("applyTemplate", () => { it("renders primitive values", () => { const ctx = { MessageSid: "sid", IsNewSession: "no" } as TemplateContext; const overrides = ctx as Record; overrides.MessageSid = 42; overrides.IsNewSession = true; expect(applyTemplate("sid={{MessageSid}} new={{IsNewSession}}", ctx)).toBe("sid=42 new=true"); }); it("renders arrays of primitives", () => { const ctx = { MediaPaths: ["a"] } as TemplateContext; (ctx as Record).MediaPaths = ["a", 2, true, null, { ok: false }]; expect(applyTemplate("paths={{MediaPaths}}", ctx)).toBe("paths=a,2,true"); }); it("drops object values", () => { const ctx: TemplateContext = { CommandArgs: { raw: "go" } }; expect(applyTemplate("args={{CommandArgs}}", ctx)).toBe("args="); }); it("renders missing placeholders as empty", () => { const ctx: TemplateContext = {}; expect(applyTemplate("missing={{Missing}}", ctx)).toBe("missing="); }); }); describe("normalizeInboundTextNewlines", () => { it("keeps real newlines", () => { expect(normalizeInboundTextNewlines("a\nb")).toBe("a\nb"); }); it("normalizes CRLF/CR to LF", () => { expect(normalizeInboundTextNewlines("a\r\nb")).toBe("a\nb"); expect(normalizeInboundTextNewlines("a\rb")).toBe("a\nb"); }); it("preserves literal backslash-n sequences (Windows paths)", () => { // Windows paths like C:\Work\nxxx should NOT have \n converted to newlines expect(normalizeInboundTextNewlines("a\\nb")).toBe("a\\nb"); expect(normalizeInboundTextNewlines("C:\\Work\\nxxx")).toBe("C:\\Work\\nxxx"); }); }); describe("finalizeInboundContext", () => { it("fills BodyForAgent/BodyForCommands and normalizes newlines", () => { const ctx: MsgContext = { // Use actual CRLF for newline normalization test, not literal \n sequences Body: "a\r\nb\r\nc", RawBody: "raw\r\nline", ChatType: "channel", From: "whatsapp:group:123@g.us", GroupSubject: "Test", }; const out = finalizeInboundContext(ctx); expect(out.Body).toBe("a\nb\nc"); expect(out.RawBody).toBe("raw\nline"); // Prefer clean text over legacy envelope-shaped Body when RawBody is present. expect(out.BodyForAgent).toBe("raw\nline"); expect(out.BodyForCommands).toBe("raw\nline"); expect(out.CommandAuthorized).toBe(false); expect(out.ChatType).toBe("channel"); expect(out.ConversationLabel).toContain("Test"); }); it("preserves literal backslash-n in Windows paths", () => { const ctx: MsgContext = { Body: "C:\\Work\\nxxx\\README.md", RawBody: "C:\\Work\\nxxx\\README.md", ChatType: "direct", From: "web:user", }; const out = finalizeInboundContext(ctx); expect(out.Body).toBe("C:\\Work\\nxxx\\README.md"); expect(out.BodyForAgent).toBe("C:\\Work\\nxxx\\README.md"); expect(out.BodyForCommands).toBe("C:\\Work\\nxxx\\README.md"); }); it("can force BodyForCommands to follow updated CommandBody", () => { const ctx: MsgContext = { Body: "base", BodyForCommands: "", CommandBody: "say hi", From: "signal:+15550001111", ChatType: "direct", }; finalizeInboundContext(ctx, { forceBodyForCommands: true }); expect(ctx.BodyForCommands).toBe("say hi"); }); it("fills MediaType/MediaTypes defaults only when media exists", () => { const withMedia: MsgContext = { Body: "hi", MediaPath: "/tmp/file.bin", }; const outWithMedia = finalizeInboundContext(withMedia); expect(outWithMedia.MediaType).toBe("application/octet-stream"); expect(outWithMedia.MediaTypes).toEqual(["application/octet-stream"]); const withoutMedia: MsgContext = { Body: "hi" }; const outWithoutMedia = finalizeInboundContext(withoutMedia); expect(outWithoutMedia.MediaType).toBeUndefined(); expect(outWithoutMedia.MediaTypes).toBeUndefined(); }); it("pads MediaTypes to match MediaPaths/MediaUrls length", () => { const ctx: MsgContext = { Body: "hi", MediaPaths: ["/tmp/a", "/tmp/b"], MediaTypes: ["image/png"], }; const out = finalizeInboundContext(ctx); expect(out.MediaType).toBe("image/png"); expect(out.MediaTypes).toEqual(["image/png", "application/octet-stream"]); }); it("derives MediaType from MediaTypes when missing", () => { const ctx: MsgContext = { Body: "hi", MediaPath: "/tmp/a", MediaTypes: ["image/jpeg"], }; const out = finalizeInboundContext(ctx); expect(out.MediaType).toBe("image/jpeg"); expect(out.MediaTypes).toEqual(["image/jpeg"]); }); }); describe("inbound dedupe", () => { it("builds a stable key when MessageSid is present", () => { const ctx: MsgContext = { Provider: "telegram", OriginatingChannel: "telegram", OriginatingTo: "telegram:123", MessageSid: "42", }; expect(buildInboundDedupeKey(ctx)).toBe("telegram|telegram:123|42"); }); it("skips duplicates with the same key", () => { resetInboundDedupe(); const ctx: MsgContext = { Provider: "whatsapp", OriginatingChannel: "whatsapp", OriginatingTo: "whatsapp:+1555", MessageSid: "msg-1", }; expect(shouldSkipDuplicateInbound(ctx, { now: 100 })).toBe(false); expect(shouldSkipDuplicateInbound(ctx, { now: 200 })).toBe(true); }); it("does not dedupe when the peer changes", () => { resetInboundDedupe(); const base: MsgContext = { Provider: "whatsapp", OriginatingChannel: "whatsapp", MessageSid: "msg-1", }; expect( shouldSkipDuplicateInbound({ ...base, OriginatingTo: "whatsapp:+1000" }, { now: 100 }), ).toBe(false); expect( shouldSkipDuplicateInbound({ ...base, OriginatingTo: "whatsapp:+2000" }, { now: 200 }), ).toBe(false); }); it("does not dedupe across session keys", () => { resetInboundDedupe(); const base: MsgContext = { Provider: "whatsapp", OriginatingChannel: "whatsapp", OriginatingTo: "whatsapp:+1555", MessageSid: "msg-1", }; expect( shouldSkipDuplicateInbound({ ...base, SessionKey: "agent:alpha:main" }, { now: 100 }), ).toBe(false); expect( shouldSkipDuplicateInbound({ ...base, SessionKey: "agent:bravo:main" }, { now: 200 }), ).toBe(false); expect( shouldSkipDuplicateInbound({ ...base, SessionKey: "agent:alpha:main" }, { now: 300 }), ).toBe(true); }); }); describe("createInboundDebouncer", () => { it("debounces and combines items", async () => { vi.useFakeTimers(); const calls: Array = []; const debouncer = createInboundDebouncer<{ key: string; id: string }>({ debounceMs: 10, buildKey: (item) => item.key, onFlush: async (items) => { calls.push(items.map((entry) => entry.id)); }, }); await debouncer.enqueue({ key: "a", id: "1" }); await debouncer.enqueue({ key: "a", id: "2" }); expect(calls).toEqual([]); await vi.advanceTimersByTimeAsync(10); expect(calls).toEqual([["1", "2"]]); vi.useRealTimers(); }); it("flushes buffered items before non-debounced item", async () => { vi.useFakeTimers(); const calls: Array = []; const debouncer = createInboundDebouncer<{ key: string; id: string; debounce: boolean }>({ debounceMs: 50, buildKey: (item) => item.key, shouldDebounce: (item) => item.debounce, onFlush: async (items) => { calls.push(items.map((entry) => entry.id)); }, }); await debouncer.enqueue({ key: "a", id: "1", debounce: true }); await debouncer.enqueue({ key: "a", id: "2", debounce: false }); expect(calls).toEqual([["1"], ["2"]]); vi.useRealTimers(); }); it("supports per-item debounce windows when default debounce is disabled", async () => { vi.useFakeTimers(); const calls: Array = []; const debouncer = createInboundDebouncer<{ key: string; id: string; windowMs: number }>({ debounceMs: 0, buildKey: (item) => item.key, resolveDebounceMs: (item) => item.windowMs, onFlush: async (items) => { calls.push(items.map((entry) => entry.id)); }, }); await debouncer.enqueue({ key: "forward", id: "1", windowMs: 30 }); await debouncer.enqueue({ key: "forward", id: "2", windowMs: 30 }); expect(calls).toEqual([]); await vi.advanceTimersByTimeAsync(30); expect(calls).toEqual([["1", "2"]]); vi.useRealTimers(); }); }); describe("initSessionState BodyStripped", () => { it("prefers BodyForAgent over Body for group chats", async () => { const root = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-sender-meta-")); const storePath = path.join(root, "sessions.json"); const cfg = { session: { store: storePath } } as OpenClawConfig; const result = await initSessionState({ ctx: { Body: "[WhatsApp 123@g.us] ping", BodyForAgent: "ping", ChatType: "group", SenderName: "Bob", SenderE164: "+222", SenderId: "222@s.whatsapp.net", SessionKey: "agent:main:whatsapp:group:123@g.us", }, cfg, commandAuthorized: true, }); expect(result.sessionCtx.BodyStripped).toBe("ping"); }); it("prefers BodyForAgent over Body for direct chats", async () => { const root = await fs.mkdtemp(path.join(os.tmpdir(), "openclaw-sender-meta-direct-")); const storePath = path.join(root, "sessions.json"); const cfg = { session: { store: storePath } } as OpenClawConfig; const result = await initSessionState({ ctx: { Body: "[WhatsApp +1] ping", BodyForAgent: "ping", ChatType: "direct", SenderName: "Bob", SenderE164: "+222", SessionKey: "agent:main:whatsapp:dm:+222", }, cfg, commandAuthorized: true, }); expect(result.sessionCtx.BodyStripped).toBe("ping"); }); }); describe("mention helpers", () => { it("builds regexes and skips invalid patterns", () => { const regexes = buildMentionRegexes({ messages: { groupChat: { mentionPatterns: ["\\bopenclaw\\b", "(invalid"] }, }, }); expect(regexes).toHaveLength(1); expect(regexes[0]?.test("openclaw")).toBe(true); }); it("normalizes zero-width characters", () => { expect(normalizeMentionText("open\u200bclaw")).toBe("openclaw"); }); it("matches patterns case-insensitively", () => { const regexes = buildMentionRegexes({ messages: { groupChat: { mentionPatterns: ["\\bopenclaw\\b"] } }, }); expect(matchesMentionPatterns("OPENCLAW: hi", regexes)).toBe(true); }); it("uses per-agent mention patterns when configured", () => { const regexes = buildMentionRegexes( { messages: { groupChat: { mentionPatterns: ["\\bglobal\\b"] }, }, agents: { list: [ { id: "work", groupChat: { mentionPatterns: ["\\bworkbot\\b"] }, }, ], }, }, "work", ); expect(matchesMentionPatterns("workbot: hi", regexes)).toBe(true); expect(matchesMentionPatterns("global: hi", regexes)).toBe(false); }); }); describe("resolveGroupRequireMention", () => { it("respects Discord guild/channel requireMention settings", () => { const cfg: OpenClawConfig = { channels: { discord: { guilds: { "145": { requireMention: false, channels: { general: { allow: true }, }, }, }, }, }, }; const ctx: TemplateContext = { Provider: "discord", From: "discord:group:123", GroupChannel: "#general", GroupSpace: "145", }; const groupResolution: GroupKeyResolution = { key: "discord:group:123", channel: "discord", id: "123", chatType: "group", }; expect(resolveGroupRequireMention({ cfg, ctx, groupResolution })).toBe(false); }); it("respects Slack channel requireMention settings", () => { const cfg: OpenClawConfig = { channels: { slack: { channels: { C123: { requireMention: false }, }, }, }, }; const ctx: TemplateContext = { Provider: "slack", From: "slack:channel:C123", GroupSubject: "#general", }; const groupResolution: GroupKeyResolution = { key: "slack:group:C123", channel: "slack", id: "C123", chatType: "group", }; expect(resolveGroupRequireMention({ cfg, ctx, groupResolution })).toBe(false); }); });