Files
openclaw/src/discord/monitor/message-utils.test.ts
2026-02-21 23:02:29 +01:00

302 lines
8.2 KiB
TypeScript

import { ChannelType, type Client, type Message } from "@buape/carbon";
import { StickerFormatType } from "discord-api-types/v10";
import { beforeEach, describe, expect, it, vi } from "vitest";
const fetchRemoteMedia = vi.fn();
const saveMediaBuffer = vi.fn();
vi.mock("../../media/fetch.js", () => ({
fetchRemoteMedia: (...args: unknown[]) => fetchRemoteMedia(...args),
}));
vi.mock("../../media/store.js", () => ({
saveMediaBuffer: (...args: unknown[]) => saveMediaBuffer(...args),
}));
vi.mock("../../globals.js", () => ({
logVerbose: () => {},
}));
const {
__resetDiscordChannelInfoCacheForTest,
resolveDiscordChannelInfo,
resolveDiscordMessageChannelId,
resolveDiscordMessageText,
resolveForwardedMediaList,
resolveMediaList,
} = await import("./message-utils.js");
function asMessage(payload: Record<string, unknown>): Message {
return payload as unknown as Message;
}
describe("resolveDiscordMessageChannelId", () => {
it.each([
{
name: "uses message.channelId when present",
params: { message: asMessage({ channelId: " 123 " }) },
expected: "123",
},
{
name: "falls back to message.channel_id",
params: { message: asMessage({ channel_id: " 234 " }) },
expected: "234",
},
{
name: "falls back to message.rawData.channel_id",
params: { message: asMessage({ rawData: { channel_id: "456" } }) },
expected: "456",
},
{
name: "falls back to eventChannelId and coerces numeric values",
params: { message: asMessage({}), eventChannelId: 789 },
expected: "789",
},
] as const)("$name", ({ params, expected }) => {
expect(resolveDiscordMessageChannelId(params)).toBe(expected);
});
});
describe("resolveForwardedMediaList", () => {
beforeEach(() => {
fetchRemoteMedia.mockReset();
saveMediaBuffer.mockReset();
});
it("downloads forwarded attachments", async () => {
const attachment = {
id: "att-1",
url: "https://cdn.discordapp.com/attachments/1/image.png",
filename: "image.png",
content_type: "image/png",
};
fetchRemoteMedia.mockResolvedValueOnce({
buffer: Buffer.from("image"),
contentType: "image/png",
});
saveMediaBuffer.mockResolvedValueOnce({
path: "/tmp/image.png",
contentType: "image/png",
});
const result = await resolveForwardedMediaList(
asMessage({
rawData: {
message_snapshots: [{ message: { attachments: [attachment] } }],
},
}),
512,
);
expect(fetchRemoteMedia).toHaveBeenCalledTimes(1);
expect(fetchRemoteMedia).toHaveBeenCalledWith({
url: attachment.url,
filePathHint: attachment.filename,
maxBytes: 512,
});
expect(saveMediaBuffer).toHaveBeenCalledTimes(1);
expect(saveMediaBuffer).toHaveBeenCalledWith(expect.any(Buffer), "image/png", "inbound", 512);
expect(result).toEqual([
{
path: "/tmp/image.png",
contentType: "image/png",
placeholder: "<media:image>",
},
]);
});
it("downloads forwarded stickers", async () => {
const sticker = {
id: "sticker-1",
name: "wave",
format_type: StickerFormatType.PNG,
};
fetchRemoteMedia.mockResolvedValueOnce({
buffer: Buffer.from("sticker"),
contentType: "image/png",
});
saveMediaBuffer.mockResolvedValueOnce({
path: "/tmp/sticker.png",
contentType: "image/png",
});
const result = await resolveForwardedMediaList(
asMessage({
rawData: {
message_snapshots: [{ message: { sticker_items: [sticker] } }],
},
}),
512,
);
expect(fetchRemoteMedia).toHaveBeenCalledTimes(1);
expect(fetchRemoteMedia).toHaveBeenCalledWith({
url: "https://media.discordapp.net/stickers/sticker-1.png",
filePathHint: "wave.png",
maxBytes: 512,
});
expect(saveMediaBuffer).toHaveBeenCalledTimes(1);
expect(saveMediaBuffer).toHaveBeenCalledWith(expect.any(Buffer), "image/png", "inbound", 512);
expect(result).toEqual([
{
path: "/tmp/sticker.png",
contentType: "image/png",
placeholder: "<media:sticker>",
},
]);
});
it("returns empty when no snapshots are present", async () => {
const result = await resolveForwardedMediaList(asMessage({}), 512);
expect(result).toEqual([]);
expect(fetchRemoteMedia).not.toHaveBeenCalled();
});
it("skips snapshots without attachments", async () => {
const result = await resolveForwardedMediaList(
asMessage({
rawData: {
message_snapshots: [{ message: { content: "hello" } }],
},
}),
512,
);
expect(result).toEqual([]);
expect(fetchRemoteMedia).not.toHaveBeenCalled();
});
});
describe("resolveMediaList", () => {
beforeEach(() => {
fetchRemoteMedia.mockReset();
saveMediaBuffer.mockReset();
});
it("downloads stickers", async () => {
const sticker = {
id: "sticker-2",
name: "hello",
format_type: StickerFormatType.PNG,
};
fetchRemoteMedia.mockResolvedValueOnce({
buffer: Buffer.from("sticker"),
contentType: "image/png",
});
saveMediaBuffer.mockResolvedValueOnce({
path: "/tmp/sticker-2.png",
contentType: "image/png",
});
const result = await resolveMediaList(
asMessage({
stickers: [sticker],
}),
512,
);
expect(fetchRemoteMedia).toHaveBeenCalledTimes(1);
expect(fetchRemoteMedia).toHaveBeenCalledWith({
url: "https://media.discordapp.net/stickers/sticker-2.png",
filePathHint: "hello.png",
maxBytes: 512,
});
expect(saveMediaBuffer).toHaveBeenCalledTimes(1);
expect(saveMediaBuffer).toHaveBeenCalledWith(expect.any(Buffer), "image/png", "inbound", 512);
expect(result).toEqual([
{
path: "/tmp/sticker-2.png",
contentType: "image/png",
placeholder: "<media:sticker>",
},
]);
});
});
describe("resolveDiscordMessageText", () => {
it("includes forwarded message snapshots in body text", () => {
const text = resolveDiscordMessageText(
asMessage({
content: "",
rawData: {
message_snapshots: [
{
message: {
content: "forwarded hello",
embeds: [],
attachments: [],
author: {
id: "u2",
username: "Bob",
discriminator: "0",
},
},
},
],
},
}),
{ includeForwarded: true },
);
expect(text).toContain("[Forwarded message from @Bob]");
expect(text).toContain("forwarded hello");
});
it("uses sticker placeholders when content is empty", () => {
const text = resolveDiscordMessageText(
asMessage({
content: "",
stickers: [
{
id: "sticker-3",
name: "party",
format_type: StickerFormatType.PNG,
},
],
}),
);
expect(text).toBe("<media:sticker> (1 sticker)");
});
});
describe("resolveDiscordChannelInfo", () => {
beforeEach(() => {
__resetDiscordChannelInfoCacheForTest();
});
it("caches channel lookups between calls", async () => {
const fetchChannel = vi.fn().mockResolvedValue({
type: ChannelType.DM,
name: "dm",
});
const client = { fetchChannel } as unknown as Client;
const first = await resolveDiscordChannelInfo(client, "cache-channel-1");
const second = await resolveDiscordChannelInfo(client, "cache-channel-1");
expect(first).toEqual({
type: ChannelType.DM,
name: "dm",
topic: undefined,
parentId: undefined,
ownerId: undefined,
});
expect(second).toEqual(first);
expect(fetchChannel).toHaveBeenCalledTimes(1);
});
it("negative-caches missing channels", async () => {
const fetchChannel = vi.fn().mockResolvedValue(null);
const client = { fetchChannel } as unknown as Client;
const first = await resolveDiscordChannelInfo(client, "missing-channel");
const second = await resolveDiscordChannelInfo(client, "missing-channel");
expect(first).toBeNull();
expect(second).toBeNull();
expect(fetchChannel).toHaveBeenCalledTimes(1);
});
});