elizaos--eliza/plugins/plugin-bluebubbles/__tests__/message-connector.test.ts

/**
 * Covers the message-connector registration BlueBubblesService performs:
 * `bluebubbles` plus `imessage` fallback with target hooks, empty-content and
 * missing-target guards, reply-guid threading, and reaction/edit/delete
 * mutation errors. Uses a stub runtime and mocked client — no live server.
 */
import type { IAgentRuntime, UUID } from "@elizaos/core";
import { describe, expect, it, vi } from "vitest";
import { BlueBubblesService } from "../src/service";
import type { BlueBubblesChat } from "../src/types";

type RuntimeSendHandler = Parameters<IAgentRuntime["registerSendHandler"]>[1];
type ConnectorTargetInfo = Parameters<RuntimeSendHandler>[1];
type ConnectorContent = Parameters<RuntimeSendHandler>[2];
type MessageConnectorRegistration = Parameters<
	IAgentRuntime["registerMessageConnector"]
>[0];

function makeRuntime(
	registrations: MessageConnectorRegistration[],
): IAgentRuntime {
	return {
		agentId: "agent-1" as UUID,
		registerMessageConnector: vi.fn(
			(registration: MessageConnectorRegistration) => {
				registrations.push(registration);
			},
		),
		getMessageConnectors: vi.fn(() =>
			registrations.map((registration) => ({
				source: registration.source,
			})),
		),
		registerSendHandler: vi.fn(),
		getRoom: vi.fn(async () => null),
		getMemoryById: vi.fn(async () => null),
		createMemory: vi.fn(async () => undefined),
	} as IAgentRuntime;
}

function makeDirectChat(): BlueBubblesChat {
	return {
		guid: "iMessage;-;+14155552671",
		chatIdentifier: "+1 (415) 555-2671",
		displayName: "Alice",
		participants: [
			{
				address: "+1 (415) 555-2671",
				service: "iMessage",
				country: null,
				originalROWID: 1,
				uncanonicalizedId: null,
			},
		],
		lastMessage: null,
		style: 45,
		isArchived: false,
		isFiltered: false,
		isPinned: false,
		hasUnreadMessages: false,
	};
}

describe("BlueBubbles message connector registration", () => {
	it("registers BlueBubbles plus iMessage fallback connectors with target hooks", async () => {
		const registrations: MessageConnectorRegistration[] = [];
		const runtime = makeRuntime(registrations);
		const service = {
			getIsRunning: vi.fn(() => true),
			listChats: vi.fn(async () => [makeDirectChat()]),
			getChatState: vi.fn(async () => ({
				chatGuid: "iMessage;-;+14155552671",
				chatIdentifier: "+14155552671",
				isGroup: false,
				participants: ["+14155552671"],
				displayName: "Alice",
				lastMessageAt: null,
				hasUnread: false,
			})),
			sendMessage: vi.fn(async () => ({ guid: "bb-1", dateCreated: 123 })),
		} as BlueBubblesService;

		BlueBubblesService.registerSendHandlers(runtime, service);

		expect(registrations.map((registration) => registration.source)).toEqual([
			"bluebubbles",
			"imessage",
		]);

		const connector = registrations.find(
			(registration) => registration.source === "bluebubbles",
		);
		expect(connector?.capabilities).toContain("send_message");
		expect(connector?.metadata?.aliases).toEqual(
			expect.arrayContaining(["bluebubbles", "imessage"]),
		);

		const targets = await connector?.resolveTargets?.("Alice", { runtime });
		expect(targets?.[0]).toEqual(
			expect.objectContaining({
				label: "Alice",
				kind: "phone",
				target: expect.objectContaining({
					channelId: "+14155552671",
				}),
			}),
		);

		await connector?.sendHandler(
			runtime,
			{
				source: "bluebubbles",
				entityId: "+1 (415) 555-2671" as UUID,
			} as ConnectorTargetInfo,
			{ text: "hello" } as ConnectorContent,
		);

		expect(service.sendMessage).toHaveBeenCalledWith(
			"+14155552671",
			"hello",
			undefined,
		);
	});

	it("does not send empty text content", async () => {
		const registrations: MessageConnectorRegistration[] = [];
		const runtime = makeRuntime(registrations);
		const service = {
			getIsRunning: vi.fn(() => true),
			listChats: vi.fn(async () => []),
			sendMessage: vi.fn(),
		} as unknown as BlueBubblesService;

		BlueBubblesService.registerSendHandlers(runtime, service);

		const connector = registrations.find(
			(registration) => registration.source === "bluebubbles",
		);
		await connector?.sendHandler(
			runtime,
			{ source: "bluebubbles", channelId: "+14155552671" },
			{ text: "   " } as ConnectorContent,
		);

		expect(service.sendMessage).not.toHaveBeenCalled();
	});

	it("throws when a non-empty send has no resolvable target", async () => {
		const registrations: MessageConnectorRegistration[] = [];
		const runtime = makeRuntime(registrations);
		const service = {
			getIsRunning: vi.fn(() => true),
			listChats: vi.fn(async () => []),
			sendMessage: vi.fn(),
		} as unknown as BlueBubblesService;

		BlueBubblesService.registerSendHandlers(runtime, service);

		const connector = registrations.find(
			(registration) => registration.source === "bluebubbles",
		);
		await expect(
			connector?.sendHandler(
				runtime,
				{ source: "bluebubbles" } as ConnectorTargetInfo,
				{ text: "hello" } as ConnectorContent,
			),
		).rejects.toThrow("BlueBubbles target is missing a chat GUID");
		expect(service.sendMessage).not.toHaveBeenCalled();
	});

	it("passes a reply message guid when replying to a BlueBubbles memory", async () => {
		const registrations: MessageConnectorRegistration[] = [];
		const runtime = {
			...makeRuntime(registrations),
			getMemoryById: vi.fn(async () => ({
				metadata: { bluebubblesMessageGuid: "message-to-reply-to" },
			})),
		} as unknown as IAgentRuntime;
		const service = {
			getIsRunning: vi.fn(() => true),
			listChats: vi.fn(async () => []),
			sendMessage: vi.fn(async () => ({ guid: "bb-2", dateCreated: 456 })),
		} as unknown as BlueBubblesService;

		BlueBubblesService.registerSendHandlers(runtime, service);

		const connector = registrations.find(
			(registration) => registration.source === "bluebubbles",
		);
		await connector?.sendHandler(
			runtime,
			{ source: "bluebubbles", channelId: "+14155552671" },
			{ text: "reply", inReplyTo: "memory-1" } as ConnectorContent,
		);

		expect(service.sendMessage).toHaveBeenCalledWith(
			"+14155552671",
			"reply",
			"message-to-reply-to",
		);
	});

	it("strips interaction markers before sending connector replies", async () => {
		const registrations: MessageConnectorRegistration[] = [];
		const runtime = {
			...makeRuntime(registrations),
			getSetting: vi.fn((key: string) =>
				key === "ELIZA_APP_URL" ? "https://app.test" : undefined,
			),
		} as unknown as IAgentRuntime;
		const service = {
			getIsRunning: vi.fn(() => true),
			listChats: vi.fn(async () => []),
			sendMessage: vi.fn(async () => ({ guid: "bb-3", dateCreated: 789 })),
		} as unknown as BlueBubblesService;

		BlueBubblesService.registerSendHandlers(runtime, service);

		const connector = registrations.find(
			(registration) => registration.source === "bluebubbles",
		);
		await connector?.sendHandler(
			runtime,
			{ source: "bluebubbles", channelId: "+14155552671" },
			{
				text: "Pick:\n[CHOICE:next id=c1]\ny=Yes\nn=No\n[/CHOICE]",
			} as ConnectorContent,
		);

		expect(service.sendMessage).toHaveBeenCalledWith(
			"+14155552671",
			"Pick:\n\n1. Yes\n2. No\nReply with a number.",
			undefined,
		);
	});

	it("rejects reaction mutations missing chat, message, or reaction values", async () => {
		const registrations: MessageConnectorRegistration[] = [];
		const runtime = makeRuntime(registrations);
		const service = {
			getIsRunning: vi.fn(() => true),
			listChats: vi.fn(async () => []),
			sendReaction: vi.fn(),
		} as unknown as BlueBubblesService;

		BlueBubblesService.registerSendHandlers(runtime, service);

		const connector = registrations.find(
			(registration) => registration.source === "bluebubbles",
		);
		await expect(
			connector?.reactHandler?.(runtime, {
				target: { source: "bluebubbles", channelId: "+14155552671" },
				messageGuid: "message-1",
			}),
		).rejects.toThrow(
			"BlueBubbles reactHandler requires chat, message guid, and reaction",
		);
		expect(service.sendReaction).not.toHaveBeenCalled();
	});

	it("surfaces failed BlueBubbles reactions", async () => {
		const registrations: MessageConnectorRegistration[] = [];
		const runtime = makeRuntime(registrations);
		const service = {
			getIsRunning: vi.fn(() => true),
			listChats: vi.fn(async () => []),
			sendReaction: vi.fn(async () => ({ success: false })),
		} as unknown as BlueBubblesService;

		BlueBubblesService.registerSendHandlers(runtime, service);

		const connector = registrations.find(
			(registration) => registration.source === "bluebubbles",
		);
		await expect(
			connector?.reactHandler?.(runtime, {
				target: { source: "bluebubbles", channelId: "+14155552671" },
				messageGuid: "message-1",
				reaction: "love",
			}),
		).rejects.toThrow("BlueBubbles reaction failed");
	});

	it("requires an initialized client before edit or delete mutations", async () => {
		const registrations: MessageConnectorRegistration[] = [];
		const runtime = makeRuntime(registrations);
		const service = {
			getIsRunning: vi.fn(() => true),
			listChats: vi.fn(async () => []),
		} as unknown as BlueBubblesService;

		BlueBubblesService.registerSendHandlers(runtime, service);

		const connector = registrations.find(
			(registration) => registration.source === "bluebubbles",
		);
		await expect(
			connector?.editHandler?.(runtime, {
				messageGuid: "message-1",
				text: "fixed",
			}),
		).rejects.toThrow("BlueBubbles client not initialized");
		await expect(
			connector?.deleteHandler?.(runtime, { messageGuid: "message-1" }),
		).rejects.toThrow("BlueBubbles client not initialized");
	});
});