Files
openclaw/extensions/telegram/src/bot-native-commands.menu-test-support.ts
2026-04-04 03:57:47 +09:00

129 lines
4.6 KiB
TypeScript

import type { RuntimeEnv } from "openclaw/plugin-sdk/runtime-env";
import { expect, vi, type Mock } from "vitest";
import type { OpenClawConfig } from "../runtime-api.js";
import type { TelegramNativeCommandDeps } from "./bot-native-command-deps.runtime.js";
import {
createNativeCommandTestParams as createBaseNativeCommandTestParams,
createTelegramPrivateCommandContext,
type NativeCommandTestParams as RegisterTelegramNativeCommandsParams,
} from "./bot-native-commands.fixture-test-support.js";
type RegisteredCommand = {
command: string;
description: string;
};
type UnknownMock = Mock<(...args: unknown[]) => unknown>;
type CreateCommandBotResult = {
bot: RegisterTelegramNativeCommandsParams["bot"];
commandHandlers: Map<string, (ctx: unknown) => Promise<void>>;
sendMessage: ReturnType<typeof vi.fn>;
deleteMessage: ReturnType<typeof vi.fn>;
setMyCommands: ReturnType<typeof vi.fn>;
};
const skillCommandMocks = vi.hoisted(() => ({
listSkillCommandsForAgents: vi.fn<TelegramNativeCommandDeps["listSkillCommandsForAgents"]>(
() => [],
),
}));
const deliveryMocks = vi.hoisted(() => ({
deliverReplies: vi.fn(async () => ({ delivered: true })),
editMessageTelegram: vi.fn(async () => ({ ok: true as const, messageId: "999", chatId: "100" })),
emitTelegramMessageSentHooks: vi.fn(),
}));
export const listSkillCommandsForAgents = skillCommandMocks.listSkillCommandsForAgents;
export const deliverReplies = deliveryMocks.deliverReplies;
export const editMessageTelegram = deliveryMocks.editMessageTelegram;
export const emitTelegramMessageSentHooks: UnknownMock = deliveryMocks.emitTelegramMessageSentHooks;
vi.mock("./bot/delivery.js", () => ({
deliverReplies,
emitTelegramMessageSentHooks,
}));
vi.mock("./bot/delivery.replies.js", () => ({
deliverReplies,
}));
export async function waitForRegisteredCommands(
setMyCommands: ReturnType<typeof vi.fn>,
): Promise<RegisteredCommand[]> {
await vi.waitFor(() => {
expect(setMyCommands).toHaveBeenCalled();
});
return setMyCommands.mock.calls[0]?.[0] as RegisteredCommand[];
}
export function resetNativeCommandMenuMocks() {
listSkillCommandsForAgents.mockClear();
listSkillCommandsForAgents.mockReturnValue([]);
deliverReplies.mockClear();
deliverReplies.mockResolvedValue({ delivered: true });
editMessageTelegram.mockClear();
editMessageTelegram.mockResolvedValue({ ok: true as const, messageId: "999", chatId: "100" });
emitTelegramMessageSentHooks.mockClear();
}
export function createCommandBot(): CreateCommandBotResult {
const commandHandlers = new Map<string, (ctx: unknown) => Promise<void>>();
const sendMessage = vi.fn().mockResolvedValue({ message_id: 999 });
const deleteMessage = vi.fn().mockResolvedValue(true);
const setMyCommands = vi.fn().mockResolvedValue(undefined);
const bot = {
api: {
setMyCommands,
sendMessage,
deleteMessage,
},
command: vi.fn((name: string, cb: (ctx: unknown) => Promise<void>) => {
commandHandlers.set(name, cb);
}),
} as unknown as RegisterTelegramNativeCommandsParams["bot"];
return { bot, commandHandlers, sendMessage, deleteMessage, setMyCommands };
}
export function createNativeCommandTestParams(
cfg: OpenClawConfig,
params: Partial<RegisterTelegramNativeCommandsParams> = {},
): RegisterTelegramNativeCommandsParams {
const dispatchResult: Awaited<
ReturnType<TelegramNativeCommandDeps["dispatchReplyWithBufferedBlockDispatcher"]>
> = {
queuedFinal: false,
counts: { block: 0, final: 0, tool: 0 },
};
const telegramDeps: TelegramNativeCommandDeps = {
loadConfig: vi.fn(() => cfg) as TelegramNativeCommandDeps["loadConfig"],
readChannelAllowFromStore: vi.fn(
async () => [],
) as TelegramNativeCommandDeps["readChannelAllowFromStore"],
dispatchReplyWithBufferedBlockDispatcher: vi.fn(
async () => dispatchResult,
) as TelegramNativeCommandDeps["dispatchReplyWithBufferedBlockDispatcher"],
listSkillCommandsForAgents,
syncTelegramMenuCommands: vi.fn(({ bot, commandsToRegister }) => {
if (commandsToRegister.length === 0) {
return undefined;
}
return bot.api.setMyCommands(commandsToRegister);
}) as TelegramNativeCommandDeps["syncTelegramMenuCommands"],
editMessageTelegram,
};
return createBaseNativeCommandTestParams({
cfg,
runtime: params.runtime ?? ({} as RuntimeEnv),
nativeSkillsEnabled: true,
telegramDeps,
...params,
});
}
export function createPrivateCommandContext(
params?: Parameters<typeof createTelegramPrivateCommandContext>[0],
) {
return createTelegramPrivateCommandContext(params);
}