tqcq/openclaw
0
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-02-16 23:29:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(test-harness): annotate vitest mocks to avoid TS2742

Browse Source
This commit is contained in:
Peter Steinberger
2026-02-14 18:26:37 +01:00
parent baa3bf270b
commit fc5d147d1b
2 changed files with 85 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
src/commands/doctor.e2e-harness.ts
View File

@@ -19,25 +19,28 @@ function setStdinTty(value: boolean | undefined) {
}
}
export const readConfigFileSnapshot = vi.fn();
export const confirm = vi.fn().mockResolvedValue(true);
export const select = vi.fn().mockResolvedValue("node");
export const note = vi.fn();
export const writeConfigFile = vi.fn().mockResolvedValue(undefined);
export const resolveOpenClawPackageRoot = vi.fn().mockResolvedValue(null);
export const runGatewayUpdate = vi.fn().mockResolvedValue({
export const readConfigFileSnapshot: ReturnType<typeof vi.fn> = vi.fn();
export const confirm: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(true);
export const select: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue("node");
export const note: ReturnType<typeof vi.fn> = vi.fn();
export const writeConfigFile: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(undefined);
export const resolveOpenClawPackageRoot: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(null);
export const runGatewayUpdate: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue({
status: "skipped",
mode: "unknown",
steps: [],
durationMs: 0,
});
export const migrateLegacyConfig = vi.fn((raw: unknown) => ({
export const migrateLegacyConfig: ReturnType<typeof vi.fn> = vi.fn((raw: unknown) => ({
config: raw as Record<string, unknown>,
changes: ["Moved routing.allowFrom → channels.whatsapp.allowFrom."],
}));
export const runExec = vi.fn().mockResolvedValue({ stdout: "", stderr: "" });
export const runCommandWithTimeout = vi.fn().mockResolvedValue({
export const runExec: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue({
stdout: "",
stderr: "",
});
export const runCommandWithTimeout: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue({
stdout: "",
stderr: "",
code: 0,
@@ -45,9 +48,11 @@ export const runCommandWithTimeout = vi.fn().mockResolvedValue({
killed: false,
});
export const ensureAuthProfileStore = vi.fn().mockReturnValue({ version: 1, profiles: {} });
export const ensureAuthProfileStore: ReturnType<typeof vi.fn> = vi
.fn()
.mockReturnValue({ version: 1, profiles: {} });
export const legacyReadConfigFileSnapshot = vi.fn().mockResolvedValue({
export const legacyReadConfigFileSnapshot: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue({
path: "/tmp/openclaw.json",
exists: false,
raw: null,
@@ -57,23 +62,29 @@ export const legacyReadConfigFileSnapshot = vi.fn().mockResolvedValue({
issues: [],
legacyIssues: [],
});
export const createConfigIO = vi.fn(() => ({
export const createConfigIO: ReturnType<typeof vi.fn> = vi.fn(() => ({
readConfigFileSnapshot: legacyReadConfigFileSnapshot,
}));
export const findLegacyGatewayServices = vi.fn().mockResolvedValue([]);
export const uninstallLegacyGatewayServices = vi.fn().mockResolvedValue([]);
export const findExtraGatewayServices = vi.fn().mockResolvedValue([]);
export const renderGatewayServiceCleanupHints = vi.fn().mockReturnValue(["cleanup"]);
export const resolveGatewayProgramArguments = vi.fn().mockResolvedValue({
export const findLegacyGatewayServices: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue([]);
export const uninstallLegacyGatewayServices: ReturnType<typeof vi.fn> = vi
.fn()
.mockResolvedValue([]);
export const findExtraGatewayServices: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue([]);
export const renderGatewayServiceCleanupHints: ReturnType<typeof vi.fn> = vi
.fn()
.mockReturnValue(["cleanup"]);
export const resolveGatewayProgramArguments: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue({
programArguments: ["node", "cli", "gateway", "--port", "18789"],
});
export const serviceInstall = vi.fn().mockResolvedValue(undefined);
export const serviceIsLoaded = vi.fn().mockResolvedValue(false);
export const serviceStop = vi.fn().mockResolvedValue(undefined);
export const serviceRestart = vi.fn().mockResolvedValue(undefined);
export const serviceUninstall = vi.fn().mockResolvedValue(undefined);
export const callGateway = vi.fn().mockRejectedValue(new Error("gateway closed"));
export const serviceInstall: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(undefined);
export const serviceIsLoaded: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(false);
export const serviceStop: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(undefined);
export const serviceRestart: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(undefined);
export const serviceUninstall: ReturnType<typeof vi.fn> = vi.fn().mockResolvedValue(undefined);
export const callGateway: ReturnType<typeof vi.fn> = vi
.fn()
.mockRejectedValue(new Error("gateway closed"));
vi.mock("@clack/prompts", () => ({
confirm,

85
src/telegram/bot.create-telegram-bot.test-harness.ts
View File

@@ -1,15 +1,23 @@
import { beforeEach, vi } from "vitest";
import { beforeEach, vi, type Mock } from "vitest";
import { resetInboundDedupe } from "../auto-reply/reply/inbound-dedupe.js";
type AnyMock = Mock<(...args: unknown[]) => unknown>;
type AnyAsyncMock = Mock<(...args: unknown[]) => Promise<unknown>>;
type ReplyOpts =
| {
onReplyStart?: () => void | Promise<void>;
}
| undefined;
const { sessionStorePath } = vi.hoisted(() => ({
sessionStorePath: `/tmp/openclaw-telegram-${Math.random().toString(16).slice(2)}.json`,
}));
const { loadWebMedia } = vi.hoisted(() => ({
const { loadWebMedia } = vi.hoisted((): { loadWebMedia: AnyMock } => ({
loadWebMedia: vi.fn(),
}));
export function getLoadWebMediaMock() {
export function getLoadWebMediaMock(): AnyMock {
return loadWebMedia;
}
@@ -17,11 +25,11 @@ vi.mock("../web/media.js", () => ({
loadWebMedia,
}));
const { loadConfig } = vi.hoisted(() => ({
const { loadConfig } = vi.hoisted((): { loadConfig: AnyMock } => ({
loadConfig: vi.fn(() => ({})),
}));
export function getLoadConfigMock() {
export function getLoadConfigMock(): AnyMock {
return loadConfig;
}
vi.mock("../config/config.js", async (importOriginal) => {
@@ -40,19 +48,24 @@ vi.mock("../config/sessions.js", async (importOriginal) => {
};
});
const { readChannelAllowFromStore, upsertChannelPairingRequest } = vi.hoisted(() => ({
readChannelAllowFromStore: vi.fn(async () => [] as string[]),
upsertChannelPairingRequest: vi.fn(async () => ({
code: "PAIRCODE",
created: true,
})),
}));
const { readChannelAllowFromStore, upsertChannelPairingRequest } = vi.hoisted(
(): {
readChannelAllowFromStore: AnyAsyncMock;
upsertChannelPairingRequest: AnyAsyncMock;
} => ({
readChannelAllowFromStore: vi.fn(async () => [] as string[]),
upsertChannelPairingRequest: vi.fn(async () => ({
code: "PAIRCODE",
created: true,
})),
}),
);
export function getReadChannelAllowFromStoreMock() {
export function getReadChannelAllowFromStoreMock(): AnyAsyncMock {
return readChannelAllowFromStore;
}
export function getUpsertChannelPairingRequestMock() {
export function getUpsertChannelPairingRequestMock(): AnyAsyncMock {
return upsertChannelPairingRequest;
}
@@ -61,24 +74,24 @@ vi.mock("../pairing/pairing-store.js", () => ({
upsertChannelPairingRequest,
}));
export const useSpy = vi.fn();
export const middlewareUseSpy = vi.fn();
export const onSpy = vi.fn();
export const stopSpy = vi.fn();
export const commandSpy = vi.fn();
export const botCtorSpy = vi.fn();
export const answerCallbackQuerySpy = vi.fn(async () => undefined);
export const sendChatActionSpy = vi.fn();
export const setMessageReactionSpy = vi.fn(async () => undefined);
export const setMyCommandsSpy = vi.fn(async () => undefined);
export const deleteMyCommandsSpy = vi.fn(async () => undefined);
export const getMeSpy = vi.fn(async () => ({
export const useSpy: Mock<(arg: unknown) => void> = vi.fn();
export const middlewareUseSpy: Mock<(...args: unknown[]) => unknown> = vi.fn();
export const onSpy: Mock<(...args: unknown[]) => unknown> = vi.fn();
export const stopSpy: Mock<(...args: unknown[]) => unknown> = vi.fn();
export const commandSpy: Mock<(...args: unknown[]) => unknown> = vi.fn();
export const botCtorSpy: Mock<(...args: unknown[]) => unknown> = vi.fn();
export const answerCallbackQuerySpy: AnyAsyncMock = vi.fn(async () => undefined);
export const sendChatActionSpy: AnyMock = vi.fn();
export const setMessageReactionSpy: AnyAsyncMock = vi.fn(async () => undefined);
export const setMyCommandsSpy: AnyAsyncMock = vi.fn(async () => undefined);
export const deleteMyCommandsSpy: AnyAsyncMock = vi.fn(async () => undefined);
export const getMeSpy: AnyAsyncMock = vi.fn(async () => ({
username: "openclaw_bot",
has_topics_enabled: true,
}));
export const sendMessageSpy = vi.fn(async () => ({ message_id: 77 }));
export const sendAnimationSpy = vi.fn(async () => ({ message_id: 78 }));
export const sendPhotoSpy = vi.fn(async () => ({ message_id: 79 }));
export const sendMessageSpy: AnyAsyncMock = vi.fn(async () => ({ message_id: 77 }));
export const sendAnimationSpy: AnyAsyncMock = vi.fn(async () => ({ message_id: 78 }));
export const sendPhotoSpy: AnyAsyncMock = vi.fn(async () => ({ message_id: 79 }));
type ApiStub = {
config: { use: (arg: unknown) => void };
@@ -126,7 +139,7 @@ vi.mock("grammy", () => ({
}));
const sequentializeMiddleware = vi.fn();
export const sequentializeSpy = vi.fn(() => sequentializeMiddleware);
export const sequentializeSpy: AnyMock = vi.fn(() => sequentializeMiddleware);
export let sequentializeKey: ((ctx: unknown) => string) | undefined;
vi.mock("@grammyjs/runner", () => ({
sequentialize: (keyFn: (ctx: unknown) => string) => {
@@ -135,16 +148,18 @@ vi.mock("@grammyjs/runner", () => ({
},
}));
export const throttlerSpy = vi.fn(() => "throttler");
export const throttlerSpy: AnyMock = vi.fn(() => "throttler");
vi.mock("@grammyjs/transformer-throttler", () => ({
apiThrottler: () => throttlerSpy(),
}));
export const replySpy = vi.fn(async (_ctx, opts) => {
await opts?.onReplyStart?.();
return undefined;
});
export const replySpy: Mock<(ctx: unknown, opts?: ReplyOpts) => Promise<void>> = vi.fn(
async (_ctx, opts) => {
await opts?.onReplyStart?.();
return undefined;
},
);
vi.mock("../auto-reply/reply.js", () => ({
getReplyFromConfig: replySpy,