@openclaw/msteams 2026.5.2 → 2026.5.3-beta.2

package/src/file-consent-helpers.test.ts

@@ -1,326 +0,0 @@
-import { describe, expect, it, vi, beforeEach, afterEach } from "vitest";
-import { prepareFileConsentActivity, requiresFileConsent } from "./file-consent-helpers.js";
-import {
-  clearPendingUploads,
-  getPendingUpload,
-  getPendingUploadCount,
-  removePendingUpload,
-  storePendingUpload,
-} from "./pending-uploads.js";
-import * as pendingUploads from "./pending-uploads.js";
-
-describe("requiresFileConsent", () => {
-  const thresholdBytes = 4 * 1024 * 1024; // 4MB
-
-  it("returns true for personal chat with non-image", () => {
-    expect(
-      requiresFileConsent({
-        conversationType: "personal",
-        contentType: "application/pdf",
-        bufferSize: 1000,
-        thresholdBytes,
-      }),
-    ).toBe(true);
-  });
-
-  it("returns true for personal chat with large image", () => {
-    expect(
-      requiresFileConsent({
-        conversationType: "personal",
-        contentType: "image/png",
-        bufferSize: 5 * 1024 * 1024, // 5MB
-        thresholdBytes,
-      }),
-    ).toBe(true);
-  });
-
-  it("returns false for personal chat with small image", () => {
-    expect(
-      requiresFileConsent({
-        conversationType: "personal",
-        contentType: "image/png",
-        bufferSize: 1000,
-        thresholdBytes,
-      }),
-    ).toBe(false);
-  });
-
-  it("returns false for group chat with large non-image", () => {
-    expect(
-      requiresFileConsent({
-        conversationType: "groupChat",
-        contentType: "application/pdf",
-        bufferSize: 5 * 1024 * 1024,
-        thresholdBytes,
-      }),
-    ).toBe(false);
-  });
-
-  it("returns false for channel with large non-image", () => {
-    expect(
-      requiresFileConsent({
-        conversationType: "channel",
-        contentType: "application/pdf",
-        bufferSize: 5 * 1024 * 1024,
-        thresholdBytes,
-      }),
-    ).toBe(false);
-  });
-
-  it("handles case-insensitive conversation type", () => {
-    expect(
-      requiresFileConsent({
-        conversationType: "Personal",
-        contentType: "application/pdf",
-        bufferSize: 1000,
-        thresholdBytes,
-      }),
-    ).toBe(true);
-
-    expect(
-      requiresFileConsent({
-        conversationType: "PERSONAL",
-        contentType: "application/pdf",
-        bufferSize: 1000,
-        thresholdBytes,
-      }),
-    ).toBe(true);
-  });
-
-  it("returns false when conversationType is undefined", () => {
-    expect(
-      requiresFileConsent({
-        conversationType: undefined,
-        contentType: "application/pdf",
-        bufferSize: 1000,
-        thresholdBytes,
-      }),
-    ).toBe(false);
-  });
-
-  it("returns true for personal chat when contentType is undefined (non-image)", () => {
-    expect(
-      requiresFileConsent({
-        conversationType: "personal",
-        contentType: undefined,
-        bufferSize: 1000,
-        thresholdBytes,
-      }),
-    ).toBe(true);
-  });
-
-  it("returns true for personal chat with file exactly at threshold", () => {
-    expect(
-      requiresFileConsent({
-        conversationType: "personal",
-        contentType: "image/jpeg",
-        bufferSize: thresholdBytes, // exactly 4MB
-        thresholdBytes,
-      }),
-    ).toBe(true);
-  });
-
-  it("returns false for personal chat with file just below threshold", () => {
-    expect(
-      requiresFileConsent({
-        conversationType: "personal",
-        contentType: "image/jpeg",
-        bufferSize: thresholdBytes - 1, // 4MB - 1 byte
-        thresholdBytes,
-      }),
-    ).toBe(false);
-  });
-});
-
-describe("prepareFileConsentActivity", () => {
-  const mockUploadId = "test-upload-id-123";
-
-  beforeEach(() => {
-    vi.spyOn(pendingUploads, "storePendingUpload").mockReturnValue(mockUploadId);
-  });
-
-  afterEach(() => {
-    vi.restoreAllMocks();
-  });
-
-  it("creates activity with consent card attachment", () => {
-    const result = prepareFileConsentActivity({
-      media: {
-        buffer: Buffer.from("test content"),
-        filename: "test.pdf",
-        contentType: "application/pdf",
-      },
-      conversationId: "conv123",
-      description: "My file",
-    });
-
-    expect(result.uploadId).toBe(mockUploadId);
-    expect(result.activity.type).toBe("message");
-    expect(result.activity.attachments).toHaveLength(1);
-
-    const attachment = (result.activity.attachments as unknown[])[0] as Record<string, unknown>;
-    expect(attachment.contentType).toBe("application/vnd.microsoft.teams.card.file.consent");
-    expect(attachment.name).toBe("test.pdf");
-  });
-
-  it("stores pending upload with correct data", () => {
-    const buffer = Buffer.from("test content");
-    prepareFileConsentActivity({
-      media: {
-        buffer,
-        filename: "test.pdf",
-        contentType: "application/pdf",
-      },
-      conversationId: "conv123",
-      description: "My file",
-    });
-
-    expect(pendingUploads.storePendingUpload).toHaveBeenCalledWith({
-      buffer,
-      filename: "test.pdf",
-      contentType: "application/pdf",
-      conversationId: "conv123",
-    });
-  });
-
-  it("uses default description when not provided", () => {
-    const result = prepareFileConsentActivity({
-      media: {
-        buffer: Buffer.from("test"),
-        filename: "document.docx",
-        contentType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-      },
-      conversationId: "conv456",
-    });
-
-    const attachment = (result.activity.attachments as unknown[])[0] as Record<
-      string,
-      { description: string }
-    >;
-    expect(attachment.content.description).toBe("File: document.docx");
-  });
-
-  it("uses provided description", () => {
-    const result = prepareFileConsentActivity({
-      media: {
-        buffer: Buffer.from("test"),
-        filename: "report.pdf",
-        contentType: "application/pdf",
-      },
-      conversationId: "conv789",
-      description: "Q4 Financial Report",
-    });
-
-    const attachment = (result.activity.attachments as unknown[])[0] as Record<
-      string,
-      { description: string }
-    >;
-    expect(attachment.content.description).toBe("Q4 Financial Report");
-  });
-
-  it("includes uploadId in consent card context", () => {
-    const result = prepareFileConsentActivity({
-      media: {
-        buffer: Buffer.from("test"),
-        filename: "file.txt",
-        contentType: "text/plain",
-      },
-      conversationId: "conv000",
-    });
-
-    const attachment = (result.activity.attachments as unknown[])[0] as Record<
-      string,
-      { acceptContext: { uploadId: string } }
-    >;
-    expect(attachment.content.acceptContext.uploadId).toBe(mockUploadId);
-  });
-
-  it("handles media without contentType", () => {
-    const result = prepareFileConsentActivity({
-      media: {
-        buffer: Buffer.from("binary data"),
-        filename: "unknown.bin",
-      },
-      conversationId: "conv111",
-    });
-
-    expect(result.uploadId).toBe(mockUploadId);
-    expect(result.activity.type).toBe("message");
-  });
-});
-
-describe("msteams pending uploads", () => {
-  beforeEach(() => {
-    vi.useFakeTimers();
-    clearPendingUploads();
-  });
-
-  afterEach(() => {
-    clearPendingUploads();
-    vi.useRealTimers();
-  });
-
-  it("stores uploads, exposes them by id, and tracks count", () => {
-    const id = storePendingUpload({
-      buffer: Buffer.from("hello"),
-      filename: "hello.txt",
-      contentType: "text/plain",
-      conversationId: "conv-1",
-    });
-
-    expect(getPendingUploadCount()).toBe(1);
-    expect(getPendingUpload(id)).toEqual(
-      expect.objectContaining({
-        id,
-        filename: "hello.txt",
-        contentType: "text/plain",
-        conversationId: "conv-1",
-      }),
-    );
-  });
-
-  it("removes uploads explicitly and ignores empty ids", () => {
-    const id = storePendingUpload({
-      buffer: Buffer.from("hello"),
-      filename: "hello.txt",
-      conversationId: "conv-1",
-    });
-
-    removePendingUpload(undefined);
-    expect(getPendingUploadCount()).toBe(1);
-
-    removePendingUpload(id);
-    expect(getPendingUpload(id)).toBeUndefined();
-    expect(getPendingUploadCount()).toBe(0);
-  });
-
-  it("expires uploads by ttl even if the timeout callback has not been observed yet", () => {
-    const id = storePendingUpload({
-      buffer: Buffer.from("hello"),
-      filename: "hello.txt",
-      conversationId: "conv-1",
-    });
-
-    vi.advanceTimersByTime(5 * 60 * 1000 + 1);
-
-    expect(getPendingUpload(id)).toBeUndefined();
-    expect(getPendingUploadCount()).toBe(0);
-  });
-
-  it("clears all uploads for test cleanup", () => {
-    storePendingUpload({
-      buffer: Buffer.from("a"),
-      filename: "a.txt",
-      conversationId: "conv-1",
-    });
-    storePendingUpload({
-      buffer: Buffer.from("b"),
-      filename: "b.txt",
-      conversationId: "conv-2",
-    });
-
-    clearPendingUploads();
-
-    expect(getPendingUploadCount()).toBe(0);
-  });
-});

package/src/file-consent-helpers.ts

@@ -1,126 +0,0 @@
-/**
- * Shared helpers for FileConsentCard flow in MSTeams.
- *
- * FileConsentCard is required for:
- * - Personal (1:1) chats with large files (>=4MB)
- * - Personal chats with non-image files (PDFs, documents, etc.)
- *
- * This module consolidates the logic used by both send.ts (proactive sends)
- * and messenger.ts (reply path) to avoid duplication.
- */
-
-import { normalizeOptionalLowercaseString } from "openclaw/plugin-sdk/text-runtime";
-import { buildFileConsentCard } from "./file-consent.js";
-import { storePendingUploadFs } from "./pending-uploads-fs.js";
-import { storePendingUpload } from "./pending-uploads.js";
-
-type FileConsentMedia = {
-  buffer: Buffer;
-  filename: string;
-  contentType?: string;
-};
-
-type FileConsentActivityResult = {
-  activity: Record<string, unknown>;
-  uploadId: string;
-};
-
-function buildConsentActivity(params: {
-  media: FileConsentMedia;
-  description?: string;
-  uploadId: string;
-}): Record<string, unknown> {
-  const { media, description, uploadId } = params;
-  const consentCard = buildFileConsentCard({
-    filename: media.filename,
-    description: description || `File: ${media.filename}`,
-    sizeInBytes: media.buffer.length,
-    context: { uploadId },
-  });
-  return {
-    type: "message",
-    attachments: [consentCard],
-  };
-}
-
-/**
- * Prepare a FileConsentCard activity for large files or non-images in personal chats.
- * Returns the activity object and uploadId - caller is responsible for sending.
- *
- * This variant only writes to the in-memory store. Use it when the caller and
- * the `fileConsent/invoke` handler share the same process (for example the
- * messenger reply path). For proactive CLI sends where the invoke arrives in
- * a different process, use {@link prepareFileConsentActivityFs} instead.
- */
-export function prepareFileConsentActivity(params: {
-  media: FileConsentMedia;
-  conversationId: string;
-  description?: string;
-}): FileConsentActivityResult {
-  const { media, conversationId, description } = params;
-
-  const uploadId = storePendingUpload({
-    buffer: media.buffer,
-    filename: media.filename,
-    contentType: media.contentType,
-    conversationId,
-  });
-
-  const activity = buildConsentActivity({ media, description, uploadId });
-  return { activity, uploadId };
-}
-
-/**
- * Prepare a FileConsentCard activity and persist the pending upload to the
- * filesystem so a different process can read it when the user accepts.
- *
- * This is used by the proactive CLI `message send --media` path: the CLI
- * process sends the card and exits, but the `fileConsent/invoke` callback is
- * delivered to the long-lived gateway monitor process. The FS-backed store
- * bridges those two processes. The in-memory store is also populated so
- * same-process flows keep the fast path.
- */
-export async function prepareFileConsentActivityFs(params: {
-  media: FileConsentMedia;
-  conversationId: string;
-  description?: string;
-}): Promise<FileConsentActivityResult> {
-  const { media, conversationId, description } = params;
-
-  // Populate the in-memory store first so the uploadId is consistent, then
-  // mirror the same entry to the FS store under the same id so an invoke
-  // handler in another process can find it.
-  const uploadId = storePendingUpload({
-    buffer: media.buffer,
-    filename: media.filename,
-    contentType: media.contentType,
-    conversationId,
-  });
-
-  await storePendingUploadFs({
-    id: uploadId,
-    buffer: media.buffer,
-    filename: media.filename,
-    contentType: media.contentType,
-    conversationId,
-  });
-
-  const activity = buildConsentActivity({ media, description, uploadId });
-  return { activity, uploadId };
-}
-
-/**
- * Check if a file requires FileConsentCard flow.
- * True for: personal chat AND (large file OR non-image)
- */
-export function requiresFileConsent(params: {
-  conversationType: string | undefined;
-  contentType: string | undefined;
-  bufferSize: number;
-  thresholdBytes: number;
-}): boolean {
-  const isPersonal = normalizeOptionalLowercaseString(params.conversationType) === "personal";
-  const isImage = params.contentType?.startsWith("image/") ?? false;
-  const isLargeFile = params.bufferSize >= params.thresholdBytes;
-  return isPersonal && (isLargeFile || !isImage);
-}

package/src/file-consent-invoke.ts

@@ -1,150 +0,0 @@
-import { formatUnknownError } from "./errors.js";
-import { buildFileInfoCard, parseFileConsentInvoke, uploadToConsentUrl } from "./file-consent.js";
-import { normalizeMSTeamsConversationId } from "./inbound.js";
-import type { MSTeamsMonitorLogger } from "./monitor-types.js";
-import { getPendingUploadFs, removePendingUploadFs } from "./pending-uploads-fs.js";
-import { getPendingUpload, removePendingUpload } from "./pending-uploads.js";
-import { withRevokedProxyFallback } from "./revoked-context.js";
-import type { MSTeamsTurnContext } from "./sdk-types.js";
-
-/**
- * Handle fileConsent/invoke activities for large file uploads.
- */
-async function handleMSTeamsFileConsentInvoke(
-  context: MSTeamsTurnContext,
-  log: MSTeamsMonitorLogger,
-): Promise<boolean> {
-  const expiredUploadMessage =
-    "The file upload request has expired. Please try sending the file again.";
-  const activity = context.activity;
-  if (activity.type !== "invoke" || activity.name !== "fileConsent/invoke") {
-    return false;
-  }
-
-  const consentResponse = parseFileConsentInvoke(activity);
-  if (!consentResponse) {
-    log.debug?.("invalid file consent invoke", { value: activity.value });
-    return false;
-  }
-
-  const uploadId =
-    typeof consentResponse.context?.uploadId === "string"
-      ? consentResponse.context.uploadId
-      : undefined;
-  // Prefer the in-memory store (same-process reply path); fall back to the
-  // FS-backed store so CLI `message send --media` flows work even when the
-  // invoke callback is delivered to a different process.
-  const inMemoryFile = getPendingUpload(uploadId);
-  const fsFile = inMemoryFile ? undefined : await getPendingUploadFs(uploadId);
-  const pendingFile:
-    | {
-        buffer: Buffer;
-        filename: string;
-        contentType?: string;
-        conversationId: string;
-        consentCardActivityId?: string;
-      }
-    | undefined = inMemoryFile ?? fsFile;
-  if (pendingFile) {
-    const pendingConversationId = normalizeMSTeamsConversationId(pendingFile.conversationId);
-    const invokeConversationId = normalizeMSTeamsConversationId(activity.conversation?.id ?? "");
-    if (!invokeConversationId || pendingConversationId !== invokeConversationId) {
-      log.info("file consent conversation mismatch", {
-        uploadId,
-        expectedConversationId: pendingConversationId,
-        receivedConversationId: invokeConversationId || undefined,
-      });
-      if (consentResponse.action === "accept") {
-        await context.sendActivity(expiredUploadMessage);
-      }
-      return true;
-    }
-  }
-
-  if (consentResponse.action === "accept" && consentResponse.uploadInfo) {
-    if (pendingFile) {
-      log.debug?.("user accepted file consent, uploading", {
-        uploadId,
-        filename: pendingFile.filename,
-        size: pendingFile.buffer.length,
-      });
-
-      try {
-        await uploadToConsentUrl({
-          url: consentResponse.uploadInfo.uploadUrl,
-          buffer: pendingFile.buffer,
-          contentType: pendingFile.contentType,
-        });
-
-        const fileInfoCard = buildFileInfoCard({
-          filename: consentResponse.uploadInfo.name,
-          contentUrl: consentResponse.uploadInfo.contentUrl,
-          uniqueId: consentResponse.uploadInfo.uniqueId,
-          fileType: consentResponse.uploadInfo.fileType,
-        });
-
-        if (!pendingFile.consentCardActivityId) {
-          await context.sendActivity({
-            type: "message",
-            attachments: [fileInfoCard],
-          });
-        }
-
-        if (pendingFile.consentCardActivityId) {
-          try {
-            await context.updateActivity({
-              id: pendingFile.consentCardActivityId,
-              type: "message",
-              attachments: [fileInfoCard],
-            });
-          } catch {
-            await context.sendActivity({
-              type: "message",
-              attachments: [fileInfoCard],
-            });
-          }
-        }
-
-        log.info("file upload complete", {
-          uploadId,
-          filename: consentResponse.uploadInfo.name,
-          uniqueId: consentResponse.uploadInfo.uniqueId,
-        });
-      } catch (err) {
-        log.error("file upload failed", { uploadId, error: formatUnknownError(err) });
-        await context.sendActivity("File upload failed. Please try again.");
-      } finally {
-        removePendingUpload(uploadId);
-        await removePendingUploadFs(uploadId);
-      }
-    } else {
-      log.debug?.("pending file not found for consent", { uploadId });
-      await context.sendActivity(expiredUploadMessage);
-    }
-  } else {
-    log.debug?.("user declined file consent", { uploadId });
-    removePendingUpload(uploadId);
-    await removePendingUploadFs(uploadId);
-  }
-
-  return true;
-}
-
-export async function respondToMSTeamsFileConsentInvoke(
-  context: MSTeamsTurnContext,
-  log: MSTeamsMonitorLogger,
-): Promise<void> {
-  await context.sendActivity({ type: "invokeResponse", value: { status: 200 } });
-
-  try {
-    await withRevokedProxyFallback({
-      run: async () => await handleMSTeamsFileConsentInvoke(context, log),
-      onRevoked: async () => true,
-      onRevokedLog: () => {
-        log.debug?.("turn context revoked during file consent invoke; skipping delayed response");
-      },
-    });
-  } catch (err) {
-    log.debug?.("file consent handler error", { error: formatUnknownError(err) });
-  }
-}