Files
openclaw/src/plugin-sdk/provider-model-shared.test.ts
T
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

320 lines
9.5 KiB
TypeScript

/**
* Tests shared provider model id normalization helpers.
*/
import { describe, expect, it } from "vitest";
import {
ANTHROPIC_BY_MODEL_REPLAY_HOOKS,
buildProviderReplayFamilyHooks,
NATIVE_ANTHROPIC_REPLAY_HOOKS,
OPENAI_COMPATIBLE_REPLAY_HOOKS,
PASSTHROUGH_GEMINI_REPLAY_HOOKS,
resolveClaudeThinkingProfile,
} from "./provider-model-shared.js";
function expectFields(value: unknown, expected: Record<string, unknown>): void {
if (!value || typeof value !== "object") {
throw new Error("expected fields object");
}
const record = value as Record<string, unknown>;
for (const [key, expectedValue] of Object.entries(expected)) {
expect(record[key], key).toEqual(expectedValue);
}
}
function readLevelIds(profile: unknown): string[] {
const levels = (profile as { levels?: Array<{ id?: unknown }> } | undefined)?.levels;
expect(Array.isArray(levels)).toBe(true);
return (levels ?? []).map((level) => String(level.id));
}
function expectLevelIdsInclude(profile: unknown, expectedIds: readonly string[]): void {
const ids = readLevelIds(profile);
for (const id of expectedIds) {
expect(ids.includes(id), `level ${id}`).toBe(true);
}
}
describe("buildProviderReplayFamilyHooks", () => {
it("covers the replay family matrix", () => {
const cases = [
{
family: "openai-compatible" as const,
ctx: {
provider: "xai",
modelApi: "openai-completions",
modelId: "grok-4",
},
match: {
sanitizeToolCallIds: true,
applyAssistantFirstOrderingFix: true,
validateGeminiTurns: true,
dropReasoningFromHistory: true,
},
hasSanitizeReplayHistory: false,
reasoningMode: undefined,
},
{
family: "anthropic-by-model" as const,
ctx: {
provider: "anthropic-vertex",
modelApi: "anthropic-messages",
modelId: "claude-sonnet-4-6",
},
match: {
validateAnthropicTurns: true,
},
absent: ["dropThinkingBlocks"],
hasSanitizeReplayHistory: false,
reasoningMode: undefined,
},
{
family: "native-anthropic-by-model" as const,
ctx: {
provider: "anthropic",
modelApi: "anthropic-messages",
modelId: "claude-sonnet-4-6",
},
match: {
sanitizeMode: "full",
preserveNativeAnthropicToolUseIds: true,
preserveSignatures: true,
repairToolUseResultPairing: true,
validateAnthropicTurns: true,
allowSyntheticToolResults: true,
},
absent: ["dropThinkingBlocks"],
hasSanitizeReplayHistory: false,
reasoningMode: undefined,
},
{
family: "google-gemini" as const,
ctx: {
provider: "google",
modelApi: "google-generative-ai",
modelId: "gemini-3.1-pro-preview",
},
match: {
validateGeminiTurns: true,
allowSyntheticToolResults: true,
},
hasSanitizeReplayHistory: true,
reasoningMode: "tagged",
},
{
family: "passthrough-gemini" as const,
ctx: {
provider: "openrouter",
modelApi: "openai-completions",
modelId: "gemini-2.5-pro",
},
match: {
applyAssistantFirstOrderingFix: false,
validateGeminiTurns: false,
validateAnthropicTurns: false,
sanitizeThoughtSignatures: {
allowBase64Only: true,
includeCamelCase: true,
},
},
hasSanitizeReplayHistory: false,
reasoningMode: undefined,
},
{
family: "hybrid-anthropic-openai" as const,
options: {
anthropicModelDropThinkingBlocks: true,
},
ctx: {
provider: "minimax",
modelApi: "anthropic-messages",
modelId: "claude-sonnet-4-6",
},
match: {
validateAnthropicTurns: true,
},
absent: ["dropThinkingBlocks"],
hasSanitizeReplayHistory: false,
reasoningMode: undefined,
},
];
for (const testCase of cases) {
const hooks = buildProviderReplayFamilyHooks(
testCase.options
? {
family: testCase.family,
...testCase.options,
}
: { family: testCase.family },
);
const policy = hooks.buildReplayPolicy?.(testCase.ctx as never);
expectFields(policy, testCase.match);
if ((testCase as { absent?: string[] }).absent) {
for (const key of (testCase as { absent: string[] }).absent) {
expect(policy).not.toHaveProperty(key);
}
}
expect(Boolean(hooks.sanitizeReplayHistory)).toBe(testCase.hasSanitizeReplayHistory);
expect(hooks.resolveReasoningOutputMode?.(testCase.ctx as never)).toBe(
testCase.reasoningMode,
);
}
});
it("keeps google-gemini replay sanitation on the bootstrap path", async () => {
const hooks = buildProviderReplayFamilyHooks({
family: "google-gemini",
});
const sanitized = await hooks.sanitizeReplayHistory?.({
provider: "google",
modelApi: "google-generative-ai",
modelId: "gemini-3.1-pro-preview",
sessionId: "session-1",
messages: [
{
role: "assistant",
content: [{ type: "text", text: "hello" }],
},
],
sessionState: {
getCustomEntries: () => [],
appendCustomEntry: () => {},
},
} as never);
expectFields(sanitized?.[0], {
role: "user",
content: "(session bootstrap)",
});
});
it("keeps anthropic-by-model replay family scoped to claude ids", () => {
const hooks = buildProviderReplayFamilyHooks({
family: "anthropic-by-model",
});
expect(
hooks.buildReplayPolicy?.({
provider: "amazon-bedrock",
modelApi: "anthropic-messages",
modelId: "amazon.nova-pro-v1",
} as never),
).not.toHaveProperty("dropThinkingBlocks");
});
it("exposes canonical replay hooks for reused provider families", () => {
expectFields(
OPENAI_COMPATIBLE_REPLAY_HOOKS.buildReplayPolicy?.({
provider: "xai",
modelApi: "openai-completions",
modelId: "google/gemma-4-26b-a4b-it",
} as never),
{
sanitizeToolCallIds: true,
applyAssistantFirstOrderingFix: true,
validateGeminiTurns: true,
dropReasoningFromHistory: true,
},
);
const nativeIdsHooks = buildProviderReplayFamilyHooks({
family: "openai-compatible",
sanitizeToolCallIds: false,
dropReasoningFromHistory: false,
});
const nativeIdsPolicy = nativeIdsHooks.buildReplayPolicy?.({
provider: "moonshot",
modelApi: "openai-completions",
modelId: "kimi-k2.6",
} as never);
expectFields(nativeIdsPolicy, {
applyAssistantFirstOrderingFix: true,
validateGeminiTurns: true,
validateAnthropicTurns: true,
});
expect(nativeIdsPolicy).not.toHaveProperty("sanitizeToolCallIds");
expect(nativeIdsPolicy).not.toHaveProperty("toolCallIdMode");
expectFields(
PASSTHROUGH_GEMINI_REPLAY_HOOKS.buildReplayPolicy?.({
provider: "openrouter",
modelApi: "openai-completions",
modelId: "gemini-2.5-pro",
} as never),
{
applyAssistantFirstOrderingFix: false,
validateGeminiTurns: false,
validateAnthropicTurns: false,
sanitizeThoughtSignatures: {
allowBase64Only: true,
includeCamelCase: true,
},
},
);
expectFields(
ANTHROPIC_BY_MODEL_REPLAY_HOOKS.buildReplayPolicy?.({
provider: "amazon-bedrock",
modelApi: "bedrock-converse-stream",
modelId: "claude-sonnet-4-6",
} as never),
{
validateAnthropicTurns: true,
repairToolUseResultPairing: true,
},
);
expectFields(
NATIVE_ANTHROPIC_REPLAY_HOOKS.buildReplayPolicy?.({
provider: "anthropic",
modelApi: "anthropic-messages",
modelId: "claude-sonnet-4-6",
} as never),
{
preserveNativeAnthropicToolUseIds: true,
preserveSignatures: true,
validateAnthropicTurns: true,
},
);
});
});
describe("resolveClaudeThinkingProfile", () => {
it("leaves Opus 4.8 thinking off by default with xhigh/adaptive/max options", () => {
const profile = resolveClaudeThinkingProfile("claude-opus-4-8");
expectFields(profile, {
defaultLevel: "off",
});
expectLevelIdsInclude(profile, ["xhigh", "adaptive", "max"]);
});
it("exposes Opus 4.7 thinking levels for direct and proxied Claude providers", () => {
const directProfile = resolveClaudeThinkingProfile("claude-opus-4-7");
expectFields(directProfile, {
defaultLevel: "off",
});
expectLevelIdsInclude(directProfile, ["xhigh", "adaptive", "max"]);
const proxiedProfile = resolveClaudeThinkingProfile("claude-opus-4.7-20260219");
expectFields(proxiedProfile, {
defaultLevel: "off",
});
expectLevelIdsInclude(proxiedProfile, ["xhigh", "adaptive", "max"]);
});
it("keeps adaptive-only Claude variants from advertising xhigh or max", () => {
const profile = resolveClaudeThinkingProfile("claude-sonnet-4-6");
expectFields(profile, {
defaultLevel: "adaptive",
});
expectLevelIdsInclude(profile, ["adaptive"]);
const fixedBudgetLevels = profile.levels.filter(
(level) => level.id === "xhigh" || level.id === "max",
);
expect(fixedBudgetLevels).toStrictEqual([]);
});
});