@openclaw/msteams 2026.5.2 → 2026.5.3-beta.2

package/src/feedback-reflection.test.ts

@@ -1,237 +0,0 @@
-import { mkdtemp, rm, writeFile } from "node:fs/promises";
-import os from "node:os";
-import path from "node:path";
-import { afterEach, describe, expect, it, vi } from "vitest";
-import { storeSessionLearning } from "./feedback-reflection-store.js";
-import {
-  buildFeedbackEvent,
-  buildReflectionPrompt,
-  clearReflectionCooldowns,
-  isReflectionAllowed,
-  loadSessionLearnings,
-  parseReflectionResponse,
-  recordReflectionTime,
-} from "./feedback-reflection.js";
-
-describe("buildFeedbackEvent", () => {
-  it("builds a well-formed custom event", () => {
-    const event = buildFeedbackEvent({
-      messageId: "msg-123",
-      value: "negative",
-      comment: "too verbose",
-      sessionKey: "msteams:user1",
-      agentId: "default",
-      conversationId: "19:abc",
-    });
-
-    expect(event.type).toBe("custom");
-    expect(event.event).toBe("feedback");
-    expect(event.value).toBe("negative");
-    expect(event.comment).toBe("too verbose");
-    expect(event.messageId).toBe("msg-123");
-    expect(event.ts).toBeGreaterThan(0);
-  });
-
-  it("omits comment when not provided", () => {
-    const event = buildFeedbackEvent({
-      messageId: "msg-123",
-      value: "positive",
-      sessionKey: "msteams:user1",
-      agentId: "default",
-      conversationId: "19:abc",
-    });
-
-    expect(event.comment).toBeUndefined();
-    expect(event.value).toBe("positive");
-  });
-});
-
-describe("buildReflectionPrompt", () => {
-  it("includes the thumbed-down response", () => {
-    const prompt = buildReflectionPrompt({
-      thumbedDownResponse: "Here is a long explanation...",
-    });
-
-    expect(prompt).toContain("previous response wasn't helpful");
-    expect(prompt).toContain("Here is a long explanation...");
-    expect(prompt).toContain("reflect");
-  });
-
-  it("truncates long responses", () => {
-    const longResponse = "x".repeat(600);
-    const prompt = buildReflectionPrompt({
-      thumbedDownResponse: longResponse,
-    });
-
-    expect(prompt).toContain("...");
-    expect(prompt.length).toBeLessThan(longResponse.length + 500);
-  });
-
-  it("includes user comment when provided", () => {
-    const prompt = buildReflectionPrompt({
-      thumbedDownResponse: "Some response",
-      userComment: "Too wordy",
-    });
-
-    expect(prompt).toContain('User\'s comment: "Too wordy"');
-  });
-
-  it("works without optional params", () => {
-    const prompt = buildReflectionPrompt({});
-    expect(prompt).toContain("previous response wasn't helpful");
-    expect(prompt).toContain('"followUp":false');
-  });
-});
-
-describe("parseReflectionResponse", () => {
-  it("parses strict JSON output", () => {
-    expect(
-      parseReflectionResponse(
-        '{"learning":"Be more direct next time.","followUp":true,"userMessage":"Sorry about that. I will keep it tighter."}',
-      ),
-    ).toEqual({
-      learning: "Be more direct next time.",
-      followUp: true,
-      userMessage: "Sorry about that. I will keep it tighter.",
-    });
-  });
-
-  it("parses JSON inside markdown fences", () => {
-    expect(
-      parseReflectionResponse(
-        '```json\n{"learning":"Ask a clarifying question first.","followUp":false,"userMessage":""}\n```',
-      ),
-    ).toEqual({
-      learning: "Ask a clarifying question first.",
-      followUp: false,
-      userMessage: undefined,
-    });
-  });
-
-  it("falls back to internal-only learning when parsing fails", () => {
-    expect(parseReflectionResponse("Be more concise.\nFollow up: yes.")).toEqual({
-      learning: "Be more concise.\nFollow up: yes.",
-      followUp: false,
-    });
-  });
-});
-
-describe("reflection cooldown", () => {
-  afterEach(() => {
-    clearReflectionCooldowns();
-    vi.restoreAllMocks();
-  });
-
-  it("allows first reflection", () => {
-    expect(isReflectionAllowed("session-1")).toBe(true);
-  });
-
-  it("blocks reflection within cooldown", () => {
-    recordReflectionTime("session-1");
-    expect(isReflectionAllowed("session-1", 60_000)).toBe(false);
-  });
-
-  it("allows reflection after cooldown expires", () => {
-    // Manually set a past timestamp
-    recordReflectionTime("session-1");
-    // Override the map entry to simulate time passing
-    clearReflectionCooldowns();
-    expect(isReflectionAllowed("session-1", 1)).toBe(true);
-  });
-
-  it("tracks sessions independently", () => {
-    recordReflectionTime("session-1");
-    expect(isReflectionAllowed("session-1", 60_000)).toBe(false);
-    expect(isReflectionAllowed("session-2", 60_000)).toBe(true);
-  });
-
-  it("keeps longer custom cooldown entries during pruning", () => {
-    vi.spyOn(Date, "now").mockReturnValue(0);
-    recordReflectionTime("target", 600_000);
-
-    vi.spyOn(Date, "now").mockReturnValue(301_000);
-    for (let index = 0; index <= 500; index += 1) {
-      recordReflectionTime(`session-${index}`, 600_000);
-    }
-
-    expect(isReflectionAllowed("target", 600_000)).toBe(false);
-  });
-});
-
-describe("loadSessionLearnings", () => {
-  let tmpDir: string;
-
-  afterEach(async () => {
-    if (tmpDir) {
-      await rm(tmpDir, { recursive: true, force: true });
-    }
-  });
-
-  it("returns empty array when file doesn't exist", async () => {
-    tmpDir = await mkdtemp(path.join(os.tmpdir(), "learnings-test-"));
-    const learnings = await loadSessionLearnings(tmpDir, "nonexistent");
-    expect(learnings).toEqual([]);
-  });
-
-  it("reads existing learnings", async () => {
-    tmpDir = await mkdtemp(path.join(os.tmpdir(), "learnings-test-"));
-    const safeKey = Buffer.from("msteams:user1", "utf8").toString("base64url");
-    const filePath = path.join(tmpDir, `${safeKey}.learnings.json`);
-    await writeFile(filePath, JSON.stringify(["Be concise", "Use examples"]), "utf-8");
-
-    const learnings = await loadSessionLearnings(tmpDir, "msteams:user1");
-    expect(learnings).toEqual(["Be concise", "Use examples"]);
-  });
-
-  it("keeps distinct session keys isolated across the filename persistence boundary", async () => {
-    tmpDir = await mkdtemp(path.join(os.tmpdir(), "learnings-test-"));
-
-    await storeSessionLearning({
-      storePath: tmpDir,
-      sessionKey: "msteams:user1",
-      learning: "Use bullets",
-    });
-    await storeSessionLearning({
-      storePath: tmpDir,
-      sessionKey: "msteams/user1",
-      learning: "Avoid bullets",
-    });
-
-    await expect(loadSessionLearnings(tmpDir, "msteams:user1")).resolves.toEqual(["Use bullets"]);
-    await expect(loadSessionLearnings(tmpDir, "msteams/user1")).resolves.toEqual(["Avoid bullets"]);
-  });
-
-  it("reads and migrates legacy sanitized session learning files", async () => {
-    tmpDir = await mkdtemp(path.join(os.tmpdir(), "learnings-test-"));
-    const legacyFile = path.join(tmpDir, "msteams_user1.learnings.json");
-    await writeFile(legacyFile, JSON.stringify(["Legacy learning"]), "utf-8");
-
-    await expect(loadSessionLearnings(tmpDir, "msteams:user1")).resolves.toEqual([
-      "Legacy learning",
-    ]);
-
-    await storeSessionLearning({
-      storePath: tmpDir,
-      sessionKey: "msteams:user1",
-      learning: "New learning",
-    });
-
-    const migratedFile = path.join(
-      tmpDir,
-      `${Buffer.from("msteams:user1", "utf8").toString("base64url")}.learnings.json`,
-    );
-    await expect(loadSessionLearnings(tmpDir, "msteams:user1")).resolves.toEqual([
-      "Legacy learning",
-      "New learning",
-    ]);
-    await expect(rm(legacyFile, { force: false })).rejects.toMatchObject({ code: "ENOENT" });
-    await expect(loadSessionLearnings(tmpDir, "msteams:user1")).resolves.toEqual([
-      "Legacy learning",
-      "New learning",
-    ]);
-    await expect(loadSessionLearnings(tmpDir, "msteams/user1")).resolves.toEqual([]);
-    await expect(
-      import("node:fs/promises").then((fs) => fs.readFile(migratedFile, "utf-8")),
-    ).resolves.toContain("Legacy learning");
-  });
-});

package/src/feedback-reflection.ts

@@ -1,283 +0,0 @@
-/**
- * Background reflection triggered by negative user feedback (thumbs-down).
- *
- * Flow:
- * 1. User thumbs-down -> invoke handler acks immediately
- * 2. This module runs in the background (fire-and-forget)
- * 3. Reads recent session context
- * 4. Sends a synthetic reflection prompt to the agent
- * 5. Stores the derived learning in session
- * 6. Optionally sends a proactive follow-up to the user
- */
-
-import { normalizeOptionalLowercaseString } from "openclaw/plugin-sdk/text-runtime";
-import {
-  dispatchReplyFromConfigWithSettledDispatcher,
-  type OpenClawConfig,
-} from "../runtime-api.js";
-import type { StoredConversationReference } from "./conversation-store.js";
-import { formatUnknownError } from "./errors.js";
-import { buildReflectionPrompt, parseReflectionResponse } from "./feedback-reflection-prompt.js";
-import {
-  DEFAULT_COOLDOWN_MS,
-  clearReflectionCooldowns,
-  isReflectionAllowed,
-  loadSessionLearnings,
-  recordReflectionTime,
-  storeSessionLearning,
-} from "./feedback-reflection-store.js";
-import type { MSTeamsAdapter } from "./messenger.js";
-import { buildConversationReference } from "./messenger.js";
-import type { MSTeamsMonitorLogger } from "./monitor-types.js";
-import { getMSTeamsRuntime } from "./runtime.js";
-
-type FeedbackEvent = {
-  type: "custom";
-  event: "feedback";
-  ts: number;
-  messageId: string;
-  value: "positive" | "negative";
-  comment?: string;
-  sessionKey: string;
-  agentId: string;
-  conversationId: string;
-  reflectionLearning?: string;
-};
-
-export function buildFeedbackEvent(params: {
-  messageId: string;
-  value: "positive" | "negative";
-  comment?: string;
-  sessionKey: string;
-  agentId: string;
-  conversationId: string;
-}): FeedbackEvent {
-  return {
-    type: "custom",
-    event: "feedback",
-    ts: Date.now(),
-    messageId: params.messageId,
-    value: params.value,
-    comment: params.comment,
-    sessionKey: params.sessionKey,
-    agentId: params.agentId,
-    conversationId: params.conversationId,
-  };
-}
-
-type RunFeedbackReflectionParams = {
-  cfg: OpenClawConfig;
-  adapter: MSTeamsAdapter;
-  appId: string;
-  conversationRef: StoredConversationReference;
-  sessionKey: string;
-  agentId: string;
-  conversationId: string;
-  feedbackMessageId: string;
-  thumbedDownResponse?: string;
-  userComment?: string;
-  log: MSTeamsMonitorLogger;
-};
-
-function buildReflectionContext(params: {
-  cfg: OpenClawConfig;
-  conversationId: string;
-  sessionKey: string;
-  reflectionPrompt: string;
-}) {
-  const core = getMSTeamsRuntime();
-  const envelopeOptions = core.channel.reply.resolveEnvelopeFormatOptions(params.cfg);
-  const body = core.channel.reply.formatAgentEnvelope({
-    channel: "Teams",
-    from: "system",
-    body: params.reflectionPrompt,
-    envelope: envelopeOptions,
-  });
-
-  return {
-    ctxPayload: core.channel.reply.finalizeInboundContext({
-      Body: body,
-      BodyForAgent: params.reflectionPrompt,
-      RawBody: params.reflectionPrompt,
-      CommandBody: params.reflectionPrompt,
-      From: `msteams:system:${params.conversationId}`,
-      To: `conversation:${params.conversationId}`,
-      SessionKey: params.sessionKey,
-      ChatType: "direct" as const,
-      SenderName: "system",
-      SenderId: "system",
-      Provider: "msteams" as const,
-      Surface: "msteams" as const,
-      Timestamp: Date.now(),
-      WasMentioned: true,
-      CommandAuthorized: false,
-      OriginatingChannel: "msteams" as const,
-      OriginatingTo: `conversation:${params.conversationId}`,
-    }),
-  };
-}
-
-function createReflectionCaptureDispatcher(params: {
-  cfg: OpenClawConfig;
-  agentId: string;
-  log: MSTeamsMonitorLogger;
-}) {
-  const core = getMSTeamsRuntime();
-  let response = "";
-  const noopTypingCallbacks = {
-    onReplyStart: async () => {},
-    onIdle: () => {},
-    onCleanup: () => {},
-  };
-
-  const { dispatcher, replyOptions } = core.channel.reply.createReplyDispatcherWithTyping({
-    deliver: async (payload) => {
-      if (payload.text) {
-        response += (response ? "\n" : "") + payload.text;
-      }
-    },
-    typingCallbacks: noopTypingCallbacks,
-    humanDelay: core.channel.reply.resolveHumanDelayConfig(params.cfg, params.agentId),
-    onError: (err) => {
-      params.log.debug?.("reflection reply error", { error: formatUnknownError(err) });
-    },
-  });
-
-  return {
-    dispatcher,
-    replyOptions,
-    readResponse: () => response,
-  };
-}
-
-async function sendReflectionFollowUp(params: {
-  adapter: MSTeamsAdapter;
-  appId: string;
-  conversationRef: StoredConversationReference;
-  userMessage: string;
-}): Promise<void> {
-  const baseRef = buildConversationReference(params.conversationRef);
-  const proactiveRef = { ...baseRef, activityId: undefined };
-
-  await params.adapter.continueConversation(params.appId, proactiveRef, async (ctx) => {
-    await ctx.sendActivity({
-      type: "message",
-      text: params.userMessage,
-    });
-  });
-}
-
-/**
- * Run a background reflection after negative feedback.
- * This is designed to be called fire-and-forget (don't await in the invoke handler).
- */
-export async function runFeedbackReflection(params: RunFeedbackReflectionParams): Promise<void> {
-  const { cfg, log, sessionKey } = params;
-  const cooldownMs = cfg.channels?.msteams?.feedbackReflectionCooldownMs ?? DEFAULT_COOLDOWN_MS;
-  if (!isReflectionAllowed(sessionKey, cooldownMs)) {
-    log.debug?.("skipping reflection (cooldown active)", { sessionKey });
-    return;
-  }
-
-  const reflectionPrompt = buildReflectionPrompt({
-    thumbedDownResponse: params.thumbedDownResponse,
-    userComment: params.userComment,
-  });
-  const runtime = getMSTeamsRuntime();
-  const storePath = runtime.channel.session.resolveStorePath(cfg.session?.store, {
-    agentId: params.agentId,
-  });
-  const { ctxPayload } = buildReflectionContext({
-    cfg,
-    conversationId: params.conversationId,
-    sessionKey: params.sessionKey,
-    reflectionPrompt,
-  });
-
-  const capture = createReflectionCaptureDispatcher({
-    cfg,
-    agentId: params.agentId,
-    log,
-  });
-
-  try {
-    await dispatchReplyFromConfigWithSettledDispatcher({
-      ctxPayload,
-      cfg,
-      dispatcher: capture.dispatcher,
-      onSettled: () => {},
-      replyOptions: capture.replyOptions,
-    });
-  } catch (err) {
-    log.error("reflection dispatch failed", { error: formatUnknownError(err) });
-    return;
-  }
-
-  const reflectionResponse = capture.readResponse().trim();
-  if (!reflectionResponse) {
-    log.debug?.("reflection produced no output");
-    return;
-  }
-
-  const parsedReflection = parseReflectionResponse(reflectionResponse);
-  if (!parsedReflection) {
-    log.debug?.("reflection produced no structured output");
-    return;
-  }
-
-  recordReflectionTime(sessionKey, cooldownMs);
-  log.info("reflection complete", {
-    sessionKey,
-    responseLength: reflectionResponse.length,
-    followUp: parsedReflection.followUp,
-  });
-
-  try {
-    await storeSessionLearning({
-      storePath,
-      sessionKey: params.sessionKey,
-      learning: parsedReflection.learning,
-    });
-  } catch (err) {
-    log.debug?.("failed to store reflection learning", { error: formatUnknownError(err) });
-  }
-
-  const conversationType = normalizeOptionalLowercaseString(
-    params.conversationRef.conversation?.conversationType,
-  );
-  const shouldNotify =
-    conversationType === "personal" &&
-    parsedReflection.followUp &&
-    Boolean(parsedReflection.userMessage);
-
-  if (!shouldNotify) {
-    if (parsedReflection.followUp && conversationType !== "personal") {
-      log.debug?.("skipping reflection follow-up outside direct message", {
-        sessionKey,
-        conversationType,
-      });
-    }
-    return;
-  }
-
-  try {
-    await sendReflectionFollowUp({
-      adapter: params.adapter,
-      appId: params.appId,
-      conversationRef: params.conversationRef,
-      userMessage: parsedReflection.userMessage!,
-    });
-    log.info("sent reflection follow-up", { sessionKey });
-  } catch (err) {
-    log.debug?.("failed to send reflection follow-up", { error: formatUnknownError(err) });
-  }
-}
-
-export {
-  buildReflectionPrompt,
-  clearReflectionCooldowns,
-  isReflectionAllowed,
-  loadSessionLearnings,
-  parseReflectionResponse,
-  recordReflectionTime,
-};