Quelle  channel.actions.test.ts

import type { OpenClawConfig } from "openclaw/plugin-sdk/config-runtime";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { msteamsActionsAdapter } from "./actions.js";
import { msteamsPlugin } from "./channel.js";

const {
  editMessageMSTeamsMock,
  deleteMessageMSTeamsMock,
  getChannelInfoMSTeamsMock,
  getMemberInfoMSTeamsMock,
  getMessageMSTeamsMock,
  listChannelsMSTeamsMock,
  listReactionsMSTeamsMock,
  pinMessageMSTeamsMock,
  reactMessageMSTeamsMock,
  searchMessagesMSTeamsMock,
  sendAdaptiveCardMSTeamsMock,
  sendMessageMSTeamsMock,
  unpinMessageMSTeamsMock,
} = vi.hoisted(() => ({
  editMessageMSTeamsMock: vi.fn(),
  deleteMessageMSTeamsMock: vi.fn(),
  getChannelInfoMSTeamsMock: vi.fn(),
  getMemberInfoMSTeamsMock: vi.fn(),
  getMessageMSTeamsMock: vi.fn(),
  listChannelsMSTeamsMock: vi.fn(),
  listReactionsMSTeamsMock: vi.fn(),
  pinMessageMSTeamsMock: vi.fn(),
  reactMessageMSTeamsMock: vi.fn(),
  searchMessagesMSTeamsMock: vi.fn(),
  sendAdaptiveCardMSTeamsMock: vi.fn(),
  sendMessageMSTeamsMock: vi.fn(),
  unpinMessageMSTeamsMock: vi.fn(),
}));

vi.mock("./channel.runtime.js", () => ({
  msTeamsChannelRuntime: {
    editMessageMSTeams: editMessageMSTeamsMock,
    deleteMessageMSTeams: deleteMessageMSTeamsMock,
    getChannelInfoMSTeams: getChannelInfoMSTeamsMock,
    getMemberInfoMSTeams: getMemberInfoMSTeamsMock,
    getMessageMSTeams: getMessageMSTeamsMock,
    listChannelsMSTeams: listChannelsMSTeamsMock,
    listReactionsMSTeams: listReactionsMSTeamsMock,
    pinMessageMSTeams: pinMessageMSTeamsMock,
    reactMessageMSTeams: reactMessageMSTeamsMock,
    searchMessagesMSTeams: searchMessagesMSTeamsMock,
    sendAdaptiveCardMSTeams: sendAdaptiveCardMSTeamsMock,
    sendMessageMSTeams: sendMessageMSTeamsMock,
    unpinMessageMSTeams: unpinMessageMSTeamsMock,
  },
}));

const actionMocks = [
  editMessageMSTeamsMock,
  deleteMessageMSTeamsMock,
  getChannelInfoMSTeamsMock,
  getMemberInfoMSTeamsMock,
  getMessageMSTeamsMock,
  listChannelsMSTeamsMock,
  listReactionsMSTeamsMock,
  pinMessageMSTeamsMock,
  reactMessageMSTeamsMock,
  searchMessagesMSTeamsMock,
  sendAdaptiveCardMSTeamsMock,
  sendMessageMSTeamsMock,
  unpinMessageMSTeamsMock,
];
const currentChannelId = "conversation:19:ctx@thread.tacv2";
const reactChannelId = "conversation:19:react@thread.tacv2";
const targetChannelId = "conversation:19:target@thread.tacv2";
const editedConversationId = "19:edited@thread.tacv2";
const editedMessageId = "msg-edit-1";
const readMessage = { id: "msg-1", text: "hello" };
const reactionType = "like";
const updatedText = "updated text";
const reactionTypes = ["like", "heart", "laugh", "surprised", "sad", "angry"];
const deleteMissingTargetError = "Delete requires a target (to) and messageId.";
const reactionsMissingTargetError = "Reactions requires a target (to) and messageId.";
const presentationSendMissingTargetError = "Card send requires a target (to).";
const reactMissingEmojiError =
  "React requires an emoji (reaction type). Valid types: like, heart, laugh, surprised, sad, angry.";
const reactMissingEmojiDetail = "React requires an emoji (reaction type).";
const searchMissingQueryError = "Search requires a target (to) and query.";

function padded(value: string) {
  return ` ${value} `;
}

function msteamsActionDetails(action: string, details?: Record<string, unknown>) {
  return {
    channel: "msteams",
    action,
    ...details,
  };
}

function okMSTeamsActionDetails(action: string, details?: Record<string, unknown>) {
  return msteamsActionDetails(action, { ok: true, ...details });
}

function requireMSTeamsHandleAction() {
  const handleAction = msteamsActionsAdapter.handleAction;
  if (!handleAction) {
    throw new Error("msteams actions.handleAction unavailable");
  }
  return handleAction;
}

async function runAction(params: {
  action: string;
  cfg?: Record<string, unknown>;
  params?: Record<string, unknown>;
  toolContext?: Record<string, unknown>;
  mediaLocalRoots?: readonly string[];
  mediaReadFile?: (filePath: string) => Promise<Buffer>;
}) {
  const handleAction = requireMSTeamsHandleAction();
  return await handleAction({
    channel: "msteams",
    action: params.action,
    cfg: params.cfg ?? {},
    params: params.params ?? {},
    mediaLocalRoots: params.mediaLocalRoots,
    mediaReadFile: params.mediaReadFile,
    toolContext: params.toolContext,
  } as Parameters<ReturnType<typeof requireMSTeamsHandleAction>>[0]);
}

async function expectActionError(
  params: Parameters<typeof runAction>[0],
  expectedMessage: string,
  expectedDetails?: Record<string, unknown>,
) {
  await expect(runAction(params)).resolves.toEqual({
    isError: true,
    content: [{ type: "text", text: expectedMessage }],
    details: expectedDetails ?? { error: expectedMessage },
  });
}

async function expectActionParamError(
  action: Parameters<typeof runAction>[0]["action"],
  params: Record<string, unknown>,
  expectedMessage: string,
  expectedDetails?: Record<string, unknown>,
) {
  await expectActionError({ action, params }, expectedMessage, expectedDetails);
}

function expectActionSuccess(
  result: Awaited<ReturnType<typeof runAction>>,
  details: Record<string, unknown>,
  contentDetails: Record<string, unknown> = details,
) {
  expect(result).toEqual({
    content: [
      {
        type: "text",
        text: JSON.stringify(contentDetails),
      },
    ],
    details,
  });
}

function expectActionRuntimeCall(
  mockFn: ReturnType<typeof vi.fn>,
  params: Record<string, unknown>,
) {
  expect(mockFn).toHaveBeenCalledWith({
    cfg: {},
    ...params,
  });
}

async function expectSuccessfulAction(params: {
  mockFn: ReturnType<typeof vi.fn>;
  mockResult: unknown;
  action: Parameters<typeof runAction>[0]["action"];
  actionParams?: Parameters<typeof runAction>[0]["params"];
  toolContext?: Parameters<typeof runAction>[0]["toolContext"];
  mediaLocalRoots?: Parameters<typeof runAction>[0]["mediaLocalRoots"];
  mediaReadFile?: Parameters<typeof runAction>[0]["mediaReadFile"];
  runtimeParams: Record<string, unknown>;
  details: Record<string, unknown>;
  contentDetails?: Record<string, unknown>;
}) {
  params.mockFn.mockResolvedValue(params.mockResult);
  const result = await runAction({
    action: params.action,
    params: params.actionParams,
    mediaLocalRoots: params.mediaLocalRoots,
    mediaReadFile: params.mediaReadFile,
    toolContext: params.toolContext,
  });
  expectActionRuntimeCall(params.mockFn, params.runtimeParams);
  expectActionSuccess(result, params.details, params.contentDetails);
}

describe("msteamsPlugin message actions", () => {
  beforeEach(() => {
    for (const mockFn of actionMocks) {
      mockFn.mockReset();
    }
  });

  it("falls back to toolContext.currentChannelId for read actions", async () => {
    await expectSuccessfulAction({
      mockFn: getMessageMSTeamsMock,
      mockResult: readMessage,
      action: "read",
      actionParams: {
        messageId: padded("msg-1"),
      },
      toolContext: {
        currentChannelId: padded(currentChannelId),
      },
      runtimeParams: {
        to: currentChannelId,
        messageId: "msg-1",
      },
      details: okMSTeamsActionDetails("read", {
        message: readMessage,
      }),
      contentDetails: {
        ok: true,
        channel: "msteams",
        action: "read",
        message: readMessage,
      },
    });
  });

  it("advertises upload-file in the message tool surface", () => {
    expect(
      msteamsActionsAdapter.describeMessageTool?.({
        cfg: {
          channels: {
            msteams: {
              appId: "app-id",
              appPassword: "secret",
              tenantId: "tenant-id",
            },
          },
        } as OpenClawConfig,
      })?.actions,
    ).toContain("upload-file");
  });

  it("routes upload-file through sendMessageMSTeams with filename override", async () => {
    const mediaReadFile = vi.fn(async () => Buffer.from("pdf"));
    await expectSuccessfulAction({
      mockFn: sendMessageMSTeamsMock,
      mockResult: {
        messageId: "msg-upload-1",
        conversationId: "conv-upload-1",
      },
      action: "upload-file",
      actionParams: {
        target: padded(targetChannelId),
        path: " /tmp/report.pdf ",
        message: "Quarterly report",
        filename: "Q1-report.pdf",
      },
      mediaLocalRoots: ["/tmp"],
      mediaReadFile,
      runtimeParams: {
        to: targetChannelId,
        text: "Quarterly report",
        mediaUrl: " /tmp/report.pdf ",
        filename: "Q1-report.pdf",
        mediaLocalRoots: ["/tmp"],
        mediaReadFile,
      },
      details: {
        ok: true,
        channel: "msteams",
        messageId: "msg-upload-1",
      },
      contentDetails: {
        ok: true,
        channel: "msteams",
        action: "upload-file",
        messageId: "msg-upload-1",
        conversationId: "conv-upload-1",
      },
    });
  });

  it("routes member-info through the Teams runtime", async () => {
    await expectSuccessfulAction({
      mockFn: getMemberInfoMSTeamsMock,
      mockResult: { member: { id: "user-1" } },
      action: "member-info",
      actionParams: { userId: " user-1 " },
      runtimeParams: { userId: "user-1" },
      details: okMSTeamsActionDetails("member-info", {
        member: { id: "user-1" },
      }),
      contentDetails: {
        ok: true,
        channel: "msteams",
        action: "member-info",
        member: { id: "user-1" },
      },
    });
  });

  it("routes channel-list through the Teams runtime", async () => {
    await expectSuccessfulAction({
      mockFn: listChannelsMSTeamsMock,
      mockResult: { channels: [{ id: "channel-1" }] },
      action: "channel-list",
      actionParams: { teamId: " team-1 " },
      runtimeParams: { teamId: "team-1" },
      details: okMSTeamsActionDetails("channel-list", {
        channels: [{ id: "channel-1" }],
      }),
      contentDetails: {
        ok: true,
        channel: "msteams",
        action: "channel-list",
        channels: [{ id: "channel-1" }],
      },
    });
  });

  it("routes channel-info through the Teams runtime", async () => {
    await expectSuccessfulAction({
      mockFn: getChannelInfoMSTeamsMock,
      mockResult: { channel: { id: "channel-1" } },
      action: "channel-info",
      actionParams: {
        teamId: " team-1 ",
        channelId: " channel-1 ",
      },
      runtimeParams: {
        teamId: "team-1",
        channelId: "channel-1",
      },
      details: okMSTeamsActionDetails("channel-info", {
        channelInfo: { id: "channel-1" },
      }),
      contentDetails: {
        ok: true,
        channel: "msteams",
        action: "channel-info",
        channelInfo: { id: "channel-1" },
      },
    });
  });

  it("accepts target as an alias for pin actions", async () => {
    await expectSuccessfulAction({
      mockFn: pinMessageMSTeamsMock,
      mockResult: { ok: true, pinnedMessageId: "pin-1" },
      action: "pin",
      actionParams: {
        target: padded(targetChannelId),
        messageId: padded("msg-2"),
      },
      runtimeParams: {
        to: targetChannelId,
        messageId: "msg-2",
      },
      details: okMSTeamsActionDetails("pin", {
        pinnedMessageId: "pin-1",
      }),
    });
  });

  it("falls back from content to message fields for edit actions", async () => {
    await expectSuccessfulAction({
      mockFn: editMessageMSTeamsMock,
      mockResult: { conversationId: editedConversationId },
      action: "edit",
      actionParams: {
        to: targetChannelId,
        messageId: editedMessageId,
        content: updatedText,
      },
      runtimeParams: {
        to: targetChannelId,
        activityId: editedMessageId,
        text: updatedText,
      },
      details: {
        ok: true,
        channel: "msteams",
      },
      contentDetails: {
        ok: true,
        channel: "msteams",
        conversationId: editedConversationId,
      },
    });
  });

  it("falls back from pinnedMessageId to messageId for unpin actions", async () => {
    await expectSuccessfulAction({
      mockFn: unpinMessageMSTeamsMock,
      mockResult: { ok: true },
      action: "unpin",
      actionParams: {
        target: padded(targetChannelId),
        messageId: padded("pin-2"),
      },
      runtimeParams: {
        to: targetChannelId,
        pinnedMessageId: "pin-2",
      },
      details: okMSTeamsActionDetails("unpin"),
    });
  });

  it("uses explicit pinnedMessageId over messageId for unpin actions", async () => {
    await expectSuccessfulAction({
      mockFn: unpinMessageMSTeamsMock,
      mockResult: { ok: true },
      action: "unpin",
      actionParams: {
        target: padded(targetChannelId),
        pinnedMessageId: padded("pinned-resource-99"),
        messageId: padded("msg-99"),
      },
      runtimeParams: {
        to: targetChannelId,
        pinnedMessageId: "pinned-resource-99",
      },
      details: okMSTeamsActionDetails("unpin"),
    });
  });

  it("returns an error when unpin is called without pinnedMessageId or messageId", async () => {
    await expectActionParamError(
      "unpin",
      { target: targetChannelId },
      "Unpin requires a target (to) and pinnedMessageId.",
    );
  });

  it("exposes pinnedMessageId in the tool schema", () => {
    const discovery = msteamsPlugin.actions?.describeMessageTool?.({
      cfg: {
        channels: {
          msteams: {
            appId: "app-id",
            appPassword: "secret",
            tenantId: "tenant-id",
          },
        },
      } as OpenClawConfig,
    });
    const schema = discovery?.schema;
    expect(schema).toBeTruthy();
    const properties = Array.isArray(schema)
      ? schema[0]?.properties
      : (schema as { properties: Record<string, unknown> })?.properties;
    expect(properties).toHaveProperty("pinnedMessageId");
  });

  it("reuses currentChannelId fallback for react actions", async () => {
    await expectSuccessfulAction({
      mockFn: reactMessageMSTeamsMock,
      mockResult: { ok: true },
      action: "react",
      actionParams: {
        messageId: padded("msg-3"),
        emoji: padded(reactionType),
      },
      toolContext: {
        currentChannelId: padded(reactChannelId),
      },
      runtimeParams: {
        to: reactChannelId,
        messageId: "msg-3",
        reactionType,
      },
      details: okMSTeamsActionDetails("react", {
        reactionType,
      }),
      contentDetails: {
        channel: "msteams",
        action: "react",
        reactionType,
        ok: true,
      },
    });
  });

  it("shares the missing target and messageId validation across actions", async () => {
    await expectActionParamError("delete", {}, deleteMissingTargetError);

    await expectActionParamError("reactions", { to: targetChannelId }, reactionsMissingTargetError);
  });

  it("keeps presentation-card target validation shared", async () => {
    await expectActionParamError(
      "send",
      { presentation: { blocks: [{ type: "text", text: "hello" }] } },
      presentationSendMissingTargetError,
    );
  });

  it("preserves message text when sending presentation cards", async () => {
    await expectSuccessfulAction({
      mockFn: sendAdaptiveCardMSTeamsMock,
      mockResult: {
        messageId: "msg-card-1",
        conversationId: "conv-card-1",
      },
      action: "send",
      actionParams: {
        to: targetChannelId,
        message: "Deploy finished",
        presentation: {
          blocks: [
            {
              type: "buttons",
              buttons: [{ label: "Open", value: "open" }],
            },
          ],
        },
      },
      runtimeParams: {
        to: targetChannelId,
        card: {
          type: "AdaptiveCard",
          version: "1.4",
          body: [{ type: "TextBlock", text: "Deploy finished", wrap: true }],
          actions: [
            { type: "Action.Submit", title: "Open", data: { value: "open", label: "Open" } },
          ],
        },
      },
      details: {
        ok: true,
        channel: "msteams",
        messageId: "msg-card-1",
      },
      contentDetails: {
        ok: true,
        channel: "msteams",
        messageId: "msg-card-1",
        conversationId: "conv-card-1",
      },
    });
  });

  it("reports the allowed reaction types when emoji is missing", async () => {
    await expectActionParamError(
      "react",
      {
        to: targetChannelId,
        messageId: "msg-4",
      },
      reactMissingEmojiError,
      {
        error: reactMissingEmojiDetail,
        validTypes: reactionTypes,
      },
    );
  });

  it("requires a non-empty search query after trimming", async () => {
    await expectActionParamError(
      "search",
      {
        to: targetChannelId,
        query: "   ",
      },
      searchMissingQueryError,
    );
  });

  it("routes channel fallback targets via teamId/channelId for react actions", async () => {
    // When an action is invoked in a Teams channel context and `target` is
    // omitted, the action handler falls back to `toolContext.currentChannelId`.
    // For channel turns, buildToolContext populates that field with the
    // compound `teamId/channelId` form (see buildToolContext below), so the
    // runtime call must receive that compound form — NOT a bare
    // `conversation:<id>` — so Graph API routes through
    // `/teams/{teamId}/channels/{channelId}` rather than `/chats/{id}`.
    const teamChannelTarget = "team-1/19:channel-abc@thread.tacv2";
    await expectSuccessfulAction({
      mockFn: reactMessageMSTeamsMock,
      mockResult: { ok: true },
      action: "react",
      actionParams: {
        messageId: "msg-channel-react",
        emoji: reactionType,
      },
      toolContext: {
        currentChannelId: "conversation:19:channel-abc@thread.tacv2",
        currentGraphChannelId: teamChannelTarget,
      },
      runtimeParams: {
        to: teamChannelTarget,
        messageId: "msg-channel-react",
        reactionType,
      },
      details: okMSTeamsActionDetails("react", {
        reactionType,
      }),
      contentDetails: {
        channel: "msteams",
        action: "react",
        reactionType,
        ok: true,
      },
    });
  });

  it("preserves explicit teamId/channelId target over toolContext fallback", async () => {
    // Even in a channel context with a compound currentChannelId, an
    // explicit `target` param must take precedence.
    const teamChannelTarget = "team-2/19:channel-def@thread.tacv2";
    const explicitTarget = "team-explicit/19:other@thread.tacv2";
    await expectSuccessfulAction({
      mockFn: reactMessageMSTeamsMock,
      mockResult: { ok: true },
      action: "react",
      actionParams: {
        target: explicitTarget,
        messageId: "msg-explicit",
        emoji: reactionType,
      },
      toolContext: {
        currentChannelId: teamChannelTarget,
        currentGraphChannelId: teamChannelTarget,
      },
      runtimeParams: {
        to: explicitTarget,
        messageId: "msg-explicit",
        reactionType,
      },
      details: okMSTeamsActionDetails("react", {
        reactionType,
      }),
      contentDetails: {
        channel: "msteams",
        action: "react",
        reactionType,
        ok: true,
      },
    });
  });

  it("keeps chat conversation fallback targets as-is for DM react actions", async () => {
    // DM/group-chat turns continue to set currentChannelId to a
    // `conversation:<id>` string (no `teamId/` prefix), which the runtime
    // will resolve through `/chats/{id}`.
    const dmFallback = "conversation:19:chat-dm@thread.skype";
    await expectSuccessfulAction({
      mockFn: reactMessageMSTeamsMock,
      mockResult: { ok: true },
      action: "react",
      actionParams: {
        messageId: "msg-dm-react",
        emoji: reactionType,
      },
      toolContext: {
        currentChannelId: dmFallback,
      },
      runtimeParams: {
        to: dmFallback,
        messageId: "msg-dm-react",
        reactionType,
      },
      details: okMSTeamsActionDetails("react", {
        reactionType,
      }),
      contentDetails: {
        channel: "msteams",
        action: "react",
        reactionType,
        ok: true,
      },
    });
  });
});

describe("msteamsPlugin.threading.buildToolContext", () => {
  function callBuildToolContext(context: {
    To?: string;
    NativeChannelId?: string;
    ReplyToId?: string;
  }) {
    const build = msteamsPlugin.threading?.buildToolContext;
    if (!build) {
      throw new Error("msteams threading.buildToolContext unavailable");
    }
    return build({
      cfg: {} as OpenClawConfig,
      accountId: undefined,
      context,
    });
  }

  it("uses NativeChannelId for channel turns so actions route via teamId/channelId", () => {
    // Teams channel inbound messages carry the compound `teamId/channelId`
    // on NativeChannelId. buildToolContext must prefer it over the bare
    // `conversation:<id>` in To so action fallbacks route via
    // `/teams/{teamId}/channels/{channelId}`.
    const result = callBuildToolContext({
      To: "conversation:19:channel-abc@thread.tacv2",
      NativeChannelId: "team-1/19:channel-abc@thread.tacv2",
      ReplyToId: "reply-1",
    });
    expect(result?.currentChannelId).toBe("conversation:19:channel-abc@thread.tacv2");
    expect(result?.currentGraphChannelId).toBe("team-1/19:channel-abc@thread.tacv2");
    expect(result?.currentThreadTs).toBe("reply-1");
  });

  it("falls back to To for DM turns (no NativeChannelId)", () => {
    const result = callBuildToolContext({
      To: "user:aad-user-1",
    });
    expect(result?.currentChannelId).toBe("user:aad-user-1");
    expect(result?.currentGraphChannelId).toBeUndefined();
  });

  it("falls back to To for group chat turns (no NativeChannelId)", () => {
    const result = callBuildToolContext({
      To: "conversation:19:groupchat@thread.v2",
    });
    expect(result?.currentChannelId).toBe("conversation:19:groupchat@thread.v2");
    expect(result?.currentGraphChannelId).toBeUndefined();
  });

  it("ignores NativeChannelId that does not encode a teamId/channelId pair", () => {
    // Safety: only compound forms (with "/") should preempt the To fallback.
    // A bare native id without a team prefix must not accidentally route
    // through channel Graph paths.
    const result = callBuildToolContext({
      To: "conversation:19:chat@thread.v2",
      NativeChannelId: "19:chat@thread.v2",
    });
    expect(result?.currentChannelId).toBe("conversation:19:chat@thread.v2");
    expect(result?.currentGraphChannelId).toBeUndefined();
  });
});