Files
openclaw/src/plugin-sdk/channel-route.test.ts
Peter Steinberger 0b8aabe864 docs: document auth profile failure policy contract (#89613)
* docs: document markdown marker renderer

* docs: document rendered markdown chunking

* docs: document markdown text chunking

* docs: document shared text chunking

* docs: document plugin text chunking exports

* docs: document avatar policy constants

* docs: document node match candidates

* docs: document scoped expiring id cache

* docs: document runtime import normalization

* docs: document string sample summaries

* docs: document session usage timeseries types

* docs: document session usage response types

* docs: document manifest frontmatter shapes

* docs: document channel route input metadata

* docs: document pair loop guard settings

* docs: document migration config patch helpers

* docs: document api provider registry

* docs: document tool call repair payloads

* docs: document plugin tool payload helpers

* docs: document lazy promise loader

* docs: document store writer queue state

* docs: document thread binding lifecycle

* docs: document concurrency helper contract

* docs: document gateway client info contract

* docs: document delivery context contracts

* docs: document secret ref defaults contract

* docs: document command gating contract

* docs: document avatar policy contract

* docs: document node match policy

* docs: document message channel normalization

* docs: document boolean parsing contract

* docs: document zod parse helpers

* docs: document direct dm guard policy

* docs: document fixed window limiter contract

* docs: document node presence event contract

* docs: document secret normalization contract

* docs: document progress draft line removal

* docs: document usage formatting contracts

* docs: document agent run status contract

* docs: document runtime import helpers

* docs: document provider utility ownership

* docs: document invalid config helpers

* docs: document json compat parser

* docs: document channel config metadata ownership

* docs: document channel logging helpers

* docs: document sender identity validation ownership

* docs: document string sampling helper

* docs: document global singleton helpers

* docs: document transcript tool helpers

* docs: document exec safe-bin normalization

* docs: document reaction level resolver

* docs: document account snapshot redaction boundary

* docs: document messaging target helpers

* docs: document thread binding messages

* docs: document conversation binding context

* docs: document conversation resolution helper

* docs: document owner display secret retention

* docs: document provider request config types

* docs: document skills config types

* docs: document memory config types

* docs: document imessage config types

* docs: document crestodian config types

* docs: document tools config policies

* docs: document shared config base types

* docs: document channel config contracts

* docs: document openclaw config state types

* docs: document model config contracts

* docs: document shared agent config types

* docs: document agent defaults config types

* docs: document secret input contracts

* docs: document auth config contracts

* docs: document gateway config contracts

* docs: document tool call stream repair contracts

* docs: document memory host facades

* docs: document llm core contracts

* docs: document markdown core contracts

* docs: document gateway connect error contracts

* docs: document gateway protocol primitives

* docs: document gateway frame schemas

* docs: document gateway device schemas

* docs: document gateway environment schemas

* docs: document gateway push schemas

* docs: document gateway plugin schemas

* docs: document gateway artifact schemas

* docs: document gateway command schemas

* docs: document gateway task schemas

* docs: document gateway exec approval schemas

* docs: document gateway secret schemas

* docs: document gateway config schemas

* docs: document gateway snapshot schemas

* docs: document gateway chat schemas

* docs: document gateway wizard schemas

* docs: document gateway node schemas

* docs: document gateway plugin approval schemas

* docs: document gateway talk schemas

* docs: document gateway agent schemas

* docs: document gateway session schemas

* docs: document gateway cron schemas

* docs: document gateway agent model skill schemas

* docs: document gateway skill proposal tool schemas

* docs: document gateway protocol registry

* docs: document gateway channel status schemas

* docs: document gateway schema regression tests

* docs: document gateway schema barrel

* docs: document gateway validator tests

* docs: document gateway primitive push tests

* docs: document gateway contract tests

* docs: document native protocol guard

* docs: document channel schema tests

* docs: document gateway protocol smoke tests

* docs: document gateway protocol entrypoint

* docs: document gateway protocol type exports

* docs: document gateway error codes

* docs: document protocol schema registry

* docs: document talk audio codec

* docs: document talk activation names

* docs: document talk consult questions

* docs: document talk consult tool

* docs: document talk run control contracts

* docs: document talk run control adapter

* docs: document talkback consult queue

* docs: document talk consult transcript guard

* docs: document talk fast context runtime

* docs: document forced talk consult coordinator

* docs: document talk output activity tracker

* docs: document talk event metrics

* docs: document talk diagnostics

* docs: document talk observability hook

* docs: document talk provider resolver

* docs: document talk provider registry

* docs: document talk runtime primitives

* docs: document talk consult controller logs

* docs: document channel identity helpers

* docs: document channel account allowlist helpers

* docs: document channel metadata draft controls

* docs: document channel ingress policy

* docs: document channel sender access gates

* docs: document channel catalog message contracts

* docs: document channel account plugin helpers

* docs: document configured binding helpers

* docs: document channel acp approval config helpers

* docs: document channel bundled config write helpers

* docs: document channel plugin utility contracts

* docs: document channel config access helpers

* docs: document channel message action helpers

* docs: document channel outbound runtime helpers

* docs: document channel pairing promotion helpers

* docs: document channel registry helpers

* docs: document channel setup wizard helpers

* docs: document channel lifecycle status helpers

* docs: document channel target thread helpers

* docs: document channel session binding helpers

* docs: document channel package module probes

* docs: document channel setup wizard contracts

* docs: document channel plugin API barrels

* docs: document channel contract test helpers

* docs: document channel core helpers

* docs: document small core facades

* docs: document provider runtime helpers

* docs: document persistence and realtime helpers

* docs: document mcp and state helpers

* docs: document tool planner contracts

* docs: document music generation runtime

* docs: document crestodian command flow

* docs: document utility helpers

* docs: document node host helpers

* docs: document transcript contracts

* docs: document trajectory export contracts

* docs: document image generation contracts

* docs: document routing helper contracts

* docs: document session helper contracts

* docs: document video generation contracts

* docs: document model catalog contracts

* docs: document proxy capture contracts

* docs: document status rendering contracts

* docs: document test helper contracts

* docs: document wizard setup contracts

* docs: document process contracts

* docs: document memory host sdk contracts

* docs: document tts contracts

* docs: document secrets runtime contracts

* docs: document shared helper contracts

* docs: document hook runtime contracts

* docs: document security audit contracts

* docs: document flow contracts

* docs: document media understanding contracts

* docs: document tui contracts

* docs: document logging contracts

* docs: document llm contracts

* docs: document cron contracts

* docs: document daemon contracts

* docs: document task contracts

* docs: document acp contracts

* docs: document test utility contracts

* docs: document skill contracts

* docs: document config contracts

* docs: document outbound infra contracts

* docs: document command analysis contracts

* docs: document provider usage infra contracts

* docs: document file safety infra contracts

* docs: document exec approval infra contracts

* docs: document gateway runtime infra contracts

* docs: document infra utility contracts

* docs: document infra queue storage contracts

* docs: document heartbeat infra contracts

* docs: document remaining infra contracts

* docs: document gateway auth contracts

* docs: document gateway display helpers

* docs: document gateway http helpers

* docs: document gateway node helpers

* docs: document gateway mcp helpers

* docs: document gateway support helpers

* docs: document gateway server runtime helpers

* docs: document gateway runtime bootstrap helpers

* docs: document gateway session events

* docs: document gateway utility helpers

* docs: document gateway talk helpers

* docs: document gateway helper contracts

* docs: document gateway server method helpers

* docs: document gateway server auth helpers

* docs: document gateway server tests

* docs: document gateway test helpers

* docs: document gateway node tests

* docs: document gateway channel tests

* docs: document gateway session tests

* docs: document gateway server startup tests

* docs: document gateway tool test helpers

* docs: document gateway server test helpers

* docs: document gateway server method tests

* docs: document remaining gateway tests

* docs: document plugin sdk public subpaths

* docs: document plugin sdk runtime helpers

* docs: document plugin sdk memory provider helpers

* docs: document plugin sdk runtime facades

* docs: document plugin sdk command approval helpers

* docs: document plugin sdk runtime types

* docs: document plugin sdk browser account helpers

* docs: document plugin sdk media memory helpers

* docs: document plugin sdk core tests

* docs: document plugin sdk contract helpers

* docs: document plugin sdk test helpers

* docs: document remaining plugin sdk tests

* docs: document cli utility helpers

* docs: document cli runtime helpers

* docs: document cli command registration helpers

* docs: document node cli helpers

* docs: document cli program registration

* docs: document message cli registration

* docs: document daemon cli helpers

* docs: document cli route parsers
2026-06-03 15:20:39 -07:00

208 lines
5.1 KiB
TypeScript

/**
* Tests channel route helpers and session route resolution.
*/
import { describe, expect, it } from "vitest";
import {
channelRouteCompactKey,
channelRouteDedupeKey,
channelRouteIdentityKey,
channelRouteKey,
channelRouteTargetsMatchExact,
channelRouteTargetsShareConversation,
channelRoutesMatchExact,
channelRoutesShareConversation,
normalizeChannelRouteRef,
resolveChannelRouteTargetWithParser,
stringifyRouteThreadId,
} from "./channel-route.js";
describe("plugin-sdk channel-route", () => {
it("normalizes target, account, and thread fields", () => {
expect(
normalizeChannelRouteRef({
channel: " Slack ",
accountId: " Work ",
rawTo: " channel:C1 ",
to: " C1 ",
threadId: " 171234.567 ",
}),
).toEqual({
channel: "slack",
accountId: "work",
target: {
rawTo: "channel:C1",
to: "C1",
},
thread: {
id: "171234.567",
},
});
});
it("normalizes numeric thread ids for route keys", () => {
const route = normalizeChannelRouteRef({
channel: "telegram",
to: "-100123",
threadId: 42.9,
});
expect(stringifyRouteThreadId(route?.thread?.id)).toBe("42");
expect(channelRouteCompactKey(route)).toBe("telegram|-100123||42");
expect(channelRouteKey(route)).toBe(channelRouteCompactKey(route));
});
it("builds compact route keys from raw route-like input", () => {
expect(
channelRouteCompactKey({
channel: " Slack ",
to: " C1 ",
accountId: " Work ",
threadId: " 171234.567 ",
}),
).toBe("slack|C1|work|171234.567");
});
it("builds a stable dedupe key from route-like input", () => {
expect(
channelRouteDedupeKey({
channel: " Telegram ",
to: " -100123 ",
accountId: " Work ",
threadId: 42.9,
}),
).toBe(
channelRouteDedupeKey({
channel: "telegram",
to: "-100123",
accountId: "work",
threadId: "42",
}),
);
});
it("keeps deprecated identity key alias wired to the dedupe key", () => {
const input = {
channel: "telegram",
to: "-100123",
accountId: "work",
threadId: "42",
};
expect(channelRouteIdentityKey(input)).toBe(channelRouteDedupeKey(input));
});
it("matches exact routes when numeric and string thread ids are equivalent", () => {
expect(
channelRoutesMatchExact({
left: normalizeChannelRouteRef({
channel: "telegram",
to: "-100123",
threadId: 42,
}),
right: normalizeChannelRouteRef({
channel: "telegram",
to: "-100123",
threadId: "42",
}),
}),
).toBe(true);
expect(
channelRouteTargetsMatchExact({
left: {
channel: "telegram",
to: "-100123",
threadId: 42,
},
right: {
channel: "telegram",
to: "-100123",
threadId: "42",
},
}),
).toBe(true);
});
it("requires account equality for exact route matches", () => {
expect(
channelRouteTargetsMatchExact({
left: {
channel: "telegram",
to: "-100123",
accountId: "work",
},
right: {
channel: "telegram",
to: "-100123",
},
}),
).toBe(false);
});
it("shares conversation when one side is the parent route", () => {
expect(
channelRoutesShareConversation({
left: normalizeChannelRouteRef({
channel: "slack",
to: "channel:C1",
threadId: "171234.567",
}),
right: normalizeChannelRouteRef({
channel: "slack",
to: "channel:C1",
}),
}),
).toBe(true);
expect(
channelRouteTargetsShareConversation({
left: {
channel: "slack",
to: "channel:C1",
threadId: "171234.567",
},
right: {
channel: "slack",
to: "channel:C1",
},
}),
).toBe(true);
});
it("does not share different child threads", () => {
expect(
channelRoutesShareConversation({
left: normalizeChannelRouteRef({
channel: "matrix",
to: "room:!abc:example.org",
threadId: "$root-1",
}),
right: normalizeChannelRouteRef({
channel: "matrix",
to: "room:!abc:example.org",
threadId: "$root-2",
}),
}),
).toBe(false);
});
it("keeps deprecated parser wrapper wired for public SDK compatibility", () => {
expect(
resolveChannelRouteTargetWithParser({
channel: "Mock",
rawTarget: " room-a:topic:77 ",
fallbackThreadId: 11,
parseExplicitTarget: (_channel, rawTarget) => {
const match = /^(.*):topic:(\d+)$/u.exec(rawTarget);
return match
? { to: match[1] ?? rawTarget, threadId: Number.parseInt(match[2] ?? "", 10) }
: null;
},
}),
).toEqual({
channel: "mock",
rawTo: "room-a:topic:77",
to: "room-a",
threadId: 77,
chatType: undefined,
});
});
});