feat: per-channel responsePrefix override (#9001)
* feat: per-channel responsePrefix override
Add responsePrefix field to all channel config types and Zod schemas,
enabling per-channel and per-account outbound response prefix overrides.
Resolution cascade (most specific wins):
L1: channels.<ch>.accounts.<id>.responsePrefix
L2: channels.<ch>.responsePrefix
L3: (reserved for channels.defaults)
L4: messages.responsePrefix (existing global)
Semantics:
- undefined -> inherit from parent level
- empty string -> explicitly no prefix (stops cascade)
- "auto" -> derive [identity.name] from routed agent
Changes:
- Core logic: resolveResponsePrefix() in identity.ts accepts
optional channel/accountId and walks the cascade
- resolveEffectiveMessagesConfig() passes channel context through
- Types: responsePrefix added to WhatsApp, Telegram, Discord, Slack,
Signal, iMessage, Google Chat, MS Teams, Feishu, BlueBubbles configs
- Zod schemas: responsePrefix added for config validation
- All channel handlers wired: telegram, discord, slack, signal,
imessage, line, heartbeat runner, route-reply, native commands
- 23 new tests covering backward compat, channel/account levels,
full cascade, auto keyword, empty string stops, unknown fallthrough
Fully backward compatible - no existing config is affected.
Fixes #8857
* fix: address CI lint + review feedback
- Replace Record<string, any> with proper typed helpers (no-explicit-any)
- Add curly braces to single-line if returns (eslint curly)
- Fix JSDoc: 'Per-channel' → 'channel/account' on shared config types
- Extract getChannelConfig() helper for type-safe dynamic key access
* fix: finish responsePrefix overrides (#9001) (thanks @mudrii)
* fix: normalize prefix wiring and types (#9001) (thanks @mudrii)
---------
Co-authored-by: Gustavo Madeira Santana <gumadeiras@gmail.com>
2026-02-05 05:16:34 +08:00
|
|
|
import type { OpenClawConfig } from "openclaw/plugin-sdk";
|
|
|
|
|
import { createReplyPrefixOptions } from "openclaw/plugin-sdk";
|
2026-02-18 16:08:24 +00:00
|
|
|
import { beforeEach, describe, expect, it } from "vitest";
|
2026-01-23 00:19:23 +00:00
|
|
|
import { mattermostPlugin } from "./channel.js";
|
2026-02-18 16:08:24 +00:00
|
|
|
import { resetMattermostReactionBotUserCacheForTests } from "./mattermost/reactions.js";
|
|
|
|
|
import {
|
|
|
|
|
createMattermostReactionFetchMock,
|
|
|
|
|
createMattermostTestConfig,
|
|
|
|
|
withMockedGlobalFetch,
|
|
|
|
|
} from "./mattermost/reactions.test-helpers.js";
|
2026-01-23 00:19:23 +00:00
|
|
|
|
|
|
|
|
describe("mattermostPlugin", () => {
|
|
|
|
|
describe("messaging", () => {
|
|
|
|
|
it("keeps @username targets", () => {
|
|
|
|
|
const normalize = mattermostPlugin.messaging?.normalizeTarget;
|
2026-01-31 22:13:48 +09:00
|
|
|
if (!normalize) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
2026-01-23 00:19:23 +00:00
|
|
|
|
|
|
|
|
expect(normalize("@Alice")).toBe("@Alice");
|
|
|
|
|
expect(normalize("@alice")).toBe("@alice");
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("normalizes mattermost: prefix to user:", () => {
|
|
|
|
|
const normalize = mattermostPlugin.messaging?.normalizeTarget;
|
2026-01-31 22:13:48 +09:00
|
|
|
if (!normalize) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
2026-01-23 00:19:23 +00:00
|
|
|
|
|
|
|
|
expect(normalize("mattermost:USER123")).toBe("user:USER123");
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
describe("pairing", () => {
|
|
|
|
|
it("normalizes allowlist entries", () => {
|
|
|
|
|
const normalize = mattermostPlugin.pairing?.normalizeAllowEntry;
|
2026-01-31 22:13:48 +09:00
|
|
|
if (!normalize) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
2026-01-23 00:19:23 +00:00
|
|
|
|
|
|
|
|
expect(normalize("@Alice")).toBe("alice");
|
|
|
|
|
expect(normalize("user:USER123")).toBe("user123");
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
2026-02-17 09:30:35 -05:00
|
|
|
describe("capabilities", () => {
|
|
|
|
|
it("declares reactions support", () => {
|
|
|
|
|
expect(mattermostPlugin.capabilities?.reactions).toBe(true);
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
2026-02-16 17:14:08 -05:00
|
|
|
describe("messageActions", () => {
|
2026-02-18 16:08:24 +00:00
|
|
|
beforeEach(() => {
|
|
|
|
|
resetMattermostReactionBotUserCacheForTests();
|
|
|
|
|
});
|
|
|
|
|
|
2026-02-16 17:14:08 -05:00
|
|
|
it("exposes react when mattermost is configured", () => {
|
|
|
|
|
const cfg: OpenClawConfig = {
|
|
|
|
|
channels: {
|
|
|
|
|
mattermost: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
botToken: "test-token",
|
|
|
|
|
baseUrl: "https://chat.example.com",
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const actions = mattermostPlugin.actions?.listActions?.({ cfg }) ?? [];
|
|
|
|
|
expect(actions).toContain("react");
|
|
|
|
|
expect(actions).not.toContain("send");
|
|
|
|
|
expect(mattermostPlugin.actions?.supportsAction?.({ action: "react" })).toBe(true);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("hides react when mattermost is not configured", () => {
|
|
|
|
|
const cfg: OpenClawConfig = {
|
|
|
|
|
channels: {
|
|
|
|
|
mattermost: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const actions = mattermostPlugin.actions?.listActions?.({ cfg }) ?? [];
|
|
|
|
|
expect(actions).toEqual([]);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("hides react when actions.reactions is false", () => {
|
|
|
|
|
const cfg: OpenClawConfig = {
|
|
|
|
|
channels: {
|
|
|
|
|
mattermost: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
botToken: "test-token",
|
|
|
|
|
baseUrl: "https://chat.example.com",
|
|
|
|
|
actions: { reactions: false },
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const actions = mattermostPlugin.actions?.listActions?.({ cfg }) ?? [];
|
|
|
|
|
expect(actions).not.toContain("react");
|
|
|
|
|
expect(actions).not.toContain("send");
|
|
|
|
|
});
|
|
|
|
|
|
2026-02-16 17:34:36 -05:00
|
|
|
it("respects per-account actions.reactions in listActions", () => {
|
|
|
|
|
const cfg: OpenClawConfig = {
|
|
|
|
|
channels: {
|
|
|
|
|
mattermost: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
actions: { reactions: false },
|
|
|
|
|
accounts: {
|
|
|
|
|
default: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
botToken: "test-token",
|
|
|
|
|
baseUrl: "https://chat.example.com",
|
|
|
|
|
actions: { reactions: true },
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const actions = mattermostPlugin.actions?.listActions?.({ cfg }) ?? [];
|
|
|
|
|
expect(actions).toContain("react");
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it("blocks react when default account disables reactions and accountId is omitted", async () => {
|
|
|
|
|
const cfg: OpenClawConfig = {
|
|
|
|
|
channels: {
|
|
|
|
|
mattermost: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
actions: { reactions: true },
|
|
|
|
|
accounts: {
|
|
|
|
|
default: {
|
|
|
|
|
enabled: true,
|
|
|
|
|
botToken: "test-token",
|
|
|
|
|
baseUrl: "https://chat.example.com",
|
|
|
|
|
actions: { reactions: false },
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
await expect(
|
|
|
|
|
mattermostPlugin.actions?.handleAction?.({
|
|
|
|
|
channel: "mattermost",
|
|
|
|
|
action: "react",
|
|
|
|
|
params: { messageId: "POST1", emoji: "thumbsup" },
|
|
|
|
|
cfg,
|
|
|
|
|
} as any),
|
|
|
|
|
).rejects.toThrow("Mattermost reactions are disabled in config");
|
|
|
|
|
});
|
|
|
|
|
|
2026-02-16 17:14:08 -05:00
|
|
|
it("handles react by calling Mattermost reactions API", async () => {
|
2026-02-18 16:08:24 +00:00
|
|
|
const cfg = createMattermostTestConfig();
|
|
|
|
|
const fetchImpl = createMattermostReactionFetchMock({
|
|
|
|
|
mode: "add",
|
|
|
|
|
postId: "POST1",
|
|
|
|
|
emojiName: "thumbsup",
|
2026-02-16 17:14:08 -05:00
|
|
|
});
|
|
|
|
|
|
2026-02-18 16:08:24 +00:00
|
|
|
const result = await withMockedGlobalFetch(fetchImpl as unknown as typeof fetch, async () => {
|
2026-02-16 17:14:08 -05:00
|
|
|
const result = await mattermostPlugin.actions?.handleAction?.({
|
|
|
|
|
channel: "mattermost",
|
|
|
|
|
action: "react",
|
|
|
|
|
params: { messageId: "POST1", emoji: "thumbsup" },
|
|
|
|
|
cfg,
|
|
|
|
|
accountId: "default",
|
|
|
|
|
} as any);
|
|
|
|
|
|
2026-02-18 16:08:24 +00:00
|
|
|
return result;
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(result?.content).toEqual([{ type: "text", text: "Reacted with :thumbsup: on POST1" }]);
|
|
|
|
|
expect(result?.details).toEqual({});
|
2026-02-16 17:14:08 -05:00
|
|
|
});
|
2026-02-17 02:55:46 +01:00
|
|
|
|
|
|
|
|
it("only treats boolean remove flag as removal", async () => {
|
2026-02-18 16:08:24 +00:00
|
|
|
const cfg = createMattermostTestConfig();
|
|
|
|
|
const fetchImpl = createMattermostReactionFetchMock({
|
|
|
|
|
mode: "add",
|
|
|
|
|
postId: "POST1",
|
|
|
|
|
emojiName: "thumbsup",
|
2026-02-17 02:55:46 +01:00
|
|
|
});
|
|
|
|
|
|
2026-02-18 16:08:24 +00:00
|
|
|
const result = await withMockedGlobalFetch(fetchImpl as unknown as typeof fetch, async () => {
|
2026-02-17 02:55:46 +01:00
|
|
|
const result = await mattermostPlugin.actions?.handleAction?.({
|
|
|
|
|
channel: "mattermost",
|
|
|
|
|
action: "react",
|
|
|
|
|
params: { messageId: "POST1", emoji: "thumbsup", remove: "true" },
|
|
|
|
|
cfg,
|
|
|
|
|
accountId: "default",
|
|
|
|
|
} as any);
|
|
|
|
|
|
2026-02-18 16:08:24 +00:00
|
|
|
return result;
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(result?.content).toEqual([{ type: "text", text: "Reacted with :thumbsup: on POST1" }]);
|
2026-02-17 02:55:46 +01:00
|
|
|
});
|
2026-02-16 17:14:08 -05:00
|
|
|
});
|
|
|
|
|
|
2026-01-23 00:19:23 +00:00
|
|
|
describe("config", () => {
|
|
|
|
|
it("formats allowFrom entries", () => {
|
2026-02-17 10:12:34 +09:00
|
|
|
const formatAllowFrom = mattermostPlugin.config.formatAllowFrom!;
|
2026-01-23 00:19:23 +00:00
|
|
|
|
|
|
|
|
const formatted = formatAllowFrom({
|
2026-02-17 10:12:34 +09:00
|
|
|
cfg: {} as OpenClawConfig,
|
2026-01-23 00:19:23 +00:00
|
|
|
allowFrom: ["@Alice", "user:USER123", "mattermost:BOT999"],
|
|
|
|
|
});
|
|
|
|
|
expect(formatted).toEqual(["@alice", "user123", "bot999"]);
|
|
|
|
|
});
|
feat: per-channel responsePrefix override (#9001)
* feat: per-channel responsePrefix override
Add responsePrefix field to all channel config types and Zod schemas,
enabling per-channel and per-account outbound response prefix overrides.
Resolution cascade (most specific wins):
L1: channels.<ch>.accounts.<id>.responsePrefix
L2: channels.<ch>.responsePrefix
L3: (reserved for channels.defaults)
L4: messages.responsePrefix (existing global)
Semantics:
- undefined -> inherit from parent level
- empty string -> explicitly no prefix (stops cascade)
- "auto" -> derive [identity.name] from routed agent
Changes:
- Core logic: resolveResponsePrefix() in identity.ts accepts
optional channel/accountId and walks the cascade
- resolveEffectiveMessagesConfig() passes channel context through
- Types: responsePrefix added to WhatsApp, Telegram, Discord, Slack,
Signal, iMessage, Google Chat, MS Teams, Feishu, BlueBubbles configs
- Zod schemas: responsePrefix added for config validation
- All channel handlers wired: telegram, discord, slack, signal,
imessage, line, heartbeat runner, route-reply, native commands
- 23 new tests covering backward compat, channel/account levels,
full cascade, auto keyword, empty string stops, unknown fallthrough
Fully backward compatible - no existing config is affected.
Fixes #8857
* fix: address CI lint + review feedback
- Replace Record<string, any> with proper typed helpers (no-explicit-any)
- Add curly braces to single-line if returns (eslint curly)
- Fix JSDoc: 'Per-channel' → 'channel/account' on shared config types
- Extract getChannelConfig() helper for type-safe dynamic key access
* fix: finish responsePrefix overrides (#9001) (thanks @mudrii)
* fix: normalize prefix wiring and types (#9001) (thanks @mudrii)
---------
Co-authored-by: Gustavo Madeira Santana <gumadeiras@gmail.com>
2026-02-05 05:16:34 +08:00
|
|
|
|
|
|
|
|
it("uses account responsePrefix overrides", () => {
|
|
|
|
|
const cfg: OpenClawConfig = {
|
|
|
|
|
channels: {
|
|
|
|
|
mattermost: {
|
|
|
|
|
responsePrefix: "[Channel]",
|
|
|
|
|
accounts: {
|
|
|
|
|
default: { responsePrefix: "[Account]" },
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
const prefixContext = createReplyPrefixOptions({
|
|
|
|
|
cfg,
|
|
|
|
|
agentId: "main",
|
|
|
|
|
channel: "mattermost",
|
|
|
|
|
accountId: "default",
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(prefixContext.responsePrefix).toBe("[Account]");
|
|
|
|
|
});
|
2026-01-23 00:19:23 +00:00
|
|
|
});
|
|
|
|
|
});
|