@openclaw/zalo 2026.3.13 → 2026.5.1-beta.2

package/src/monitor.polling.media-reply.test.ts

@@ -0,0 +1,425 @@
+import { chmod, mkdir, writeFile } from "node:fs/promises";
+import type { ServerResponse } from "node:http";
+import { join } from "node:path";
+import {
+  createEmptyPluginRegistry,
+  createRuntimeEnv,
+  setActivePluginRegistry,
+} from "openclaw/plugin-sdk/plugin-test-runtime";
+import { resolvePreferredOpenClawTmpDir } from "openclaw/plugin-sdk/temp-path";
+import { afterAll, beforeEach, describe, expect, it, vi } from "vitest";
+import type { PluginRuntime } from "../runtime-api.js";
+import {
+  createLifecycleMonitorSetup,
+  createTextUpdate,
+  settleAsyncWork,
+} from "./test-support/lifecycle-test-support.js";
+import {
+  getUpdatesMock,
+  loadCachedLifecycleMonitorModule,
+  resetLifecycleTestState,
+  sendPhotoMock,
+  setLifecycleRuntimeCore,
+} from "./test-support/monitor-mocks-test-support.js";
+
+const prepareHostedZaloMediaUrlMock = vi.fn();
+
+vi.mock("./outbound-media.js", async () => {
+  const actual = await vi.importActual<typeof import("./outbound-media.js")>("./outbound-media.js");
+  return {
+    ...actual,
+    prepareHostedZaloMediaUrl: (...args: unknown[]) => prepareHostedZaloMediaUrlMock(...args),
+  };
+});
+
+import { clearHostedZaloMediaForTest } from "./outbound-media.js";
+
+const ZALO_OUTBOUND_MEDIA_DIR = join(
+  resolvePreferredOpenClawTmpDir(),
+  "openclaw-zalo-outbound-media",
+);
+
+async function writeHostedZaloMediaFixture(params: {
+  id: string;
+  routePath: string;
+  token: string;
+  buffer: Buffer;
+  contentType?: string;
+}): Promise<void> {
+  await mkdir(ZALO_OUTBOUND_MEDIA_DIR, { recursive: true, mode: 0o700 });
+  await chmod(ZALO_OUTBOUND_MEDIA_DIR, 0o700).catch(() => undefined);
+  await Promise.all([
+    writeFile(
+      join(ZALO_OUTBOUND_MEDIA_DIR, `${params.id}.json`),
+      JSON.stringify({
+        routePath: params.routePath,
+        token: params.token,
+        contentType: params.contentType,
+        expiresAt: Date.now() + 60_000,
+      }),
+      { encoding: "utf8", mode: 0o600 },
+    ),
+    writeFile(join(ZALO_OUTBOUND_MEDIA_DIR, `${params.id}.bin`), params.buffer, { mode: 0o600 }),
+  ]);
+}
+
+function createHostedMediaResponse() {
+  const headers = new Map<string, string>();
+  const res = {
+    statusCode: 200,
+    headersSent: false,
+    setHeader(name: string, value: string) {
+      headers.set(name, value);
+    },
+    end: vi.fn((body?: unknown) => {
+      res.headersSent = true;
+      return body;
+    }),
+  };
+  return { headers, res: res as unknown as ServerResponse & { end: ReturnType<typeof vi.fn> } };
+}
+
+describe("Zalo polling media replies", () => {
+  const finalizeInboundContextMock = vi.fn((ctx: Record<string, unknown>) => ctx);
+  const recordInboundSessionMock = vi.fn(async () => undefined);
+  const resolveAgentRouteMock = vi.fn(() => ({
+    agentId: "main",
+    channel: "zalo",
+    accountId: "acct-zalo-polling-media",
+    sessionKey: "agent:main:zalo:direct:dm-chat-1",
+    mainSessionKey: "agent:main:main",
+    matchedBy: "default",
+  }));
+  const dispatchReplyWithBufferedBlockDispatcherMock = vi.fn();
+
+  beforeEach(async () => {
+    await resetLifecycleTestState();
+    clearHostedZaloMediaForTest();
+    prepareHostedZaloMediaUrlMock.mockReset();
+    prepareHostedZaloMediaUrlMock.mockResolvedValue(
+      "https://example.com/hooks/zalo/media/abc123abc123abc123abc123?token=secret",
+    );
+    dispatchReplyWithBufferedBlockDispatcherMock.mockReset();
+    dispatchReplyWithBufferedBlockDispatcherMock.mockImplementation(
+      async (params: {
+        dispatcherOptions: {
+          deliver: (payload: { text: string; mediaUrl: string }) => Promise<void>;
+        };
+      }) => {
+        await params.dispatcherOptions.deliver({
+          text: "caption text",
+          mediaUrl: "https://example.com/reply-image.png",
+        });
+      },
+    );
+    setLifecycleRuntimeCore({
+      routing: {
+        resolveAgentRoute:
+          resolveAgentRouteMock as unknown as PluginRuntime["channel"]["routing"]["resolveAgentRoute"],
+      },
+      reply: {
+        finalizeInboundContext:
+          finalizeInboundContextMock as unknown as PluginRuntime["channel"]["reply"]["finalizeInboundContext"],
+        dispatchReplyWithBufferedBlockDispatcher:
+          dispatchReplyWithBufferedBlockDispatcherMock as unknown as PluginRuntime["channel"]["reply"]["dispatchReplyWithBufferedBlockDispatcher"],
+      },
+      session: {
+        recordInboundSession:
+          recordInboundSessionMock as unknown as PluginRuntime["channel"]["session"]["recordInboundSession"],
+      },
+    });
+  });
+
+  afterAll(async () => {
+    clearHostedZaloMediaForTest();
+    await resetLifecycleTestState();
+  });
+
+  it("hosts and sends media replies while polling when a webhook URL is configured", async () => {
+    const registry = createEmptyPluginRegistry();
+    setActivePluginRegistry(registry);
+    getUpdatesMock
+      .mockResolvedValueOnce({
+        ok: true,
+        result: createTextUpdate({
+          messageId: "polling-media-1",
+          userId: "user-1",
+          userName: "User One",
+          chatId: "dm-chat-1",
+          text: "send media",
+        }),
+      })
+      .mockImplementation(() => new Promise(() => {}));
+
+    const { monitorZaloProvider } = await loadCachedLifecycleMonitorModule(
+      "zalo-polling-media-reply",
+    );
+    const abort = new AbortController();
+    const runtime = createRuntimeEnv();
+    const { account, config } = createLifecycleMonitorSetup({
+      accountId: "acct-zalo-polling-media",
+      dmPolicy: "open",
+      webhookUrl: "https://example.com/hooks/zalo",
+    });
+    const run = monitorZaloProvider({
+      token: "zalo-token",
+      account,
+      config,
+      runtime,
+      abortSignal: abort.signal,
+    });
+
+    try {
+      await settleAsyncWork();
+      expect(sendPhotoMock).toHaveBeenCalledTimes(1);
+
+      expect(registry.httpRoutes).toHaveLength(1);
+      expect(prepareHostedZaloMediaUrlMock).toHaveBeenCalledWith({
+        mediaUrl: "https://example.com/reply-image.png",
+        webhookUrl: "https://example.com/hooks/zalo",
+        webhookPath: "/hooks/zalo",
+        maxBytes: 5 * 1024 * 1024,
+        proxyUrl: undefined,
+      });
+      expect(sendPhotoMock).toHaveBeenCalledWith(
+        "zalo-token",
+        {
+          chat_id: "dm-chat-1",
+          photo: "https://example.com/hooks/zalo/media/abc123abc123abc123abc123?token=secret",
+          caption: "caption text",
+        },
+        undefined,
+      );
+    } finally {
+      abort.abort();
+      await run;
+    }
+
+    expect(registry.httpRoutes).toHaveLength(0);
+  });
+
+  it("sends media replies directly when webhook hosting is not configured", async () => {
+    const registry = createEmptyPluginRegistry();
+    setActivePluginRegistry(registry);
+    getUpdatesMock
+      .mockResolvedValueOnce({
+        ok: true,
+        result: createTextUpdate({
+          messageId: "polling-media-2",
+          userId: "user-2",
+          userName: "User Two",
+          chatId: "dm-chat-2",
+          text: "send media directly",
+        }),
+      })
+      .mockImplementation(() => new Promise(() => {}));
+
+    const { monitorZaloProvider } = await loadCachedLifecycleMonitorModule(
+      "zalo-polling-media-reply",
+    );
+    const abort = new AbortController();
+    const runtime = createRuntimeEnv();
+    const { account, config } = createLifecycleMonitorSetup({
+      accountId: "acct-zalo-polling-direct-media",
+      dmPolicy: "open",
+      webhookUrl: "",
+    });
+    const run = monitorZaloProvider({
+      token: "zalo-token",
+      account,
+      config,
+      runtime,
+      abortSignal: abort.signal,
+    });
+
+    try {
+      await settleAsyncWork();
+      expect(sendPhotoMock).toHaveBeenCalledTimes(1);
+
+      expect(prepareHostedZaloMediaUrlMock).not.toHaveBeenCalled();
+      expect(sendPhotoMock).toHaveBeenCalledWith(
+        "zalo-token",
+        {
+          chat_id: "dm-chat-2",
+          photo: "https://example.com/reply-image.png",
+          caption: "caption text",
+        },
+        undefined,
+      );
+    } finally {
+      abort.abort();
+      await run;
+    }
+  });
+
+  it("shares one hosted media route across accounts on the same path", async () => {
+    const registry = createEmptyPluginRegistry();
+    setActivePluginRegistry(registry);
+    getUpdatesMock.mockImplementation(() => new Promise(() => {}));
+
+    const { monitorZaloProvider } = await loadCachedLifecycleMonitorModule(
+      "zalo-polling-media-reply",
+    );
+    const firstAbort = new AbortController();
+    const firstRuntime = createRuntimeEnv();
+    const firstSetup = createLifecycleMonitorSetup({
+      accountId: "acct-zalo-polling-media-one",
+      dmPolicy: "open",
+      webhookUrl: "https://example.com/hooks/zalo",
+    });
+    const firstRun = monitorZaloProvider({
+      token: "zalo-token-one",
+      account: firstSetup.account,
+      config: firstSetup.config,
+      runtime: firstRuntime,
+      abortSignal: firstAbort.signal,
+    });
+
+    const secondAbort = new AbortController();
+    let secondRun: Promise<void> | undefined;
+
+    try {
+      await settleAsyncWork();
+      const firstHostedMediaRoutes = registry.httpRoutes.filter(
+        (route) => route.source === "zalo-hosted-media",
+      );
+      expect(firstHostedMediaRoutes).toHaveLength(1);
+      const hostedMediaRoute = firstHostedMediaRoutes[0];
+      expect(hostedMediaRoute).toEqual(
+        expect.objectContaining({
+          path: "/hooks/zalo/media",
+          pluginId: "zalo",
+        }),
+      );
+
+      const secondRuntime = createRuntimeEnv();
+      const secondSetup = createLifecycleMonitorSetup({
+        accountId: "acct-zalo-polling-media-two",
+        dmPolicy: "open",
+        webhookUrl: "https://example.com/hooks/zalo",
+      });
+      secondRun = monitorZaloProvider({
+        token: "zalo-token-two",
+        account: secondSetup.account,
+        config: secondSetup.config,
+        runtime: secondRuntime,
+        abortSignal: secondAbort.signal,
+      });
+
+      await settleAsyncWork();
+      const hostedMediaRoutes = registry.httpRoutes.filter(
+        (route) => route.source === "zalo-hosted-media",
+      );
+      expect(hostedMediaRoutes).toHaveLength(1);
+      expect(hostedMediaRoutes[0]).toBe(hostedMediaRoute);
+
+      await writeHostedZaloMediaFixture({
+        id: "abc123abc123abc123abc123",
+        routePath: "/hooks/zalo/media/",
+        token: "route-token-one",
+        buffer: Buffer.from("first-image-bytes"),
+        contentType: "image/png",
+      });
+      const firstFetch = createHostedMediaResponse();
+      await hostedMediaRoute.handler(
+        {
+          method: "GET",
+          url: "/hooks/zalo/media/abc123abc123abc123abc123?token=route-token-one",
+        } as never,
+        firstFetch.res as never,
+      );
+      expect(firstFetch.res.statusCode).toBe(200);
+      expect(firstFetch.headers.get("Content-Type")).toBe("image/png");
+      expect(firstFetch.headers.get("Cache-Control")).toBe("no-store");
+      expect(firstFetch.res.end).toHaveBeenCalledWith(Buffer.from("first-image-bytes"));
+
+      firstAbort.abort();
+      await firstRun;
+      expect(registry.httpRoutes.filter((route) => route.source === "zalo-hosted-media")).toEqual([
+        hostedMediaRoute,
+      ]);
+
+      await writeHostedZaloMediaFixture({
+        id: "def456def456def456def456",
+        routePath: "/hooks/zalo/media/",
+        token: "route-token-two",
+        buffer: Buffer.from("second-image-bytes"),
+        contentType: "image/jpeg",
+      });
+      const secondFetch = createHostedMediaResponse();
+      await hostedMediaRoute.handler(
+        {
+          method: "GET",
+          url: "/hooks/zalo/media/def456def456def456def456?token=route-token-two",
+        } as never,
+        secondFetch.res as never,
+      );
+      expect(secondFetch.res.statusCode).toBe(200);
+      expect(secondFetch.headers.get("Content-Type")).toBe("image/jpeg");
+      expect(secondFetch.res.end).toHaveBeenCalledWith(Buffer.from("second-image-bytes"));
+    } finally {
+      firstAbort.abort();
+      secondAbort.abort();
+      await firstRun;
+      await secondRun;
+    }
+
+    expect(
+      registry.httpRoutes.filter((route) => route.source === "zalo-hosted-media"),
+    ).toHaveLength(0);
+  });
+
+  it("re-registers the hosted media route after the active registry swaps", async () => {
+    const firstRegistry = createEmptyPluginRegistry();
+    setActivePluginRegistry(firstRegistry);
+    getUpdatesMock.mockImplementation(() => new Promise(() => {}));
+
+    const { monitorZaloProvider } = await loadCachedLifecycleMonitorModule(
+      "zalo-polling-media-reply",
+    );
+    const firstAbort = new AbortController();
+    const firstRuntime = createRuntimeEnv();
+    const { account, config } = createLifecycleMonitorSetup({
+      accountId: "acct-zalo-polling-media",
+      dmPolicy: "open",
+      webhookUrl: "https://example.com/hooks/zalo",
+    });
+    const firstRun = monitorZaloProvider({
+      token: "zalo-token",
+      account,
+      config,
+      runtime: firstRuntime,
+      abortSignal: firstAbort.signal,
+    });
+
+    const secondRegistry = createEmptyPluginRegistry();
+    const secondAbort = new AbortController();
+    const secondRuntime = createRuntimeEnv();
+    let secondRun: Promise<void> | undefined;
+
+    try {
+      await settleAsyncWork();
+      expect(firstRegistry.httpRoutes).toHaveLength(1);
+
+      setActivePluginRegistry(secondRegistry);
+      secondRun = monitorZaloProvider({
+        token: "zalo-token",
+        account,
+        config,
+        runtime: secondRuntime,
+        abortSignal: secondAbort.signal,
+      });
+
+      await settleAsyncWork();
+      expect(secondRegistry.httpRoutes).toHaveLength(1);
+    } finally {
+      firstAbort.abort();
+      secondAbort.abort();
+      await firstRun;
+      await secondRun;
+    }
+
+    expect(firstRegistry.httpRoutes).toHaveLength(0);
+    expect(secondRegistry.httpRoutes).toHaveLength(0);
+  });
+});

package/src/monitor.reply-once.lifecycle.test.ts

@@ -0,0 +1,171 @@
+import { withServer } from "openclaw/plugin-sdk/test-env";
+import { afterAll, beforeEach, describe, expect, it, vi } from "vitest";
+import type { PluginRuntime } from "../runtime-api.js";
+import {
+  createLifecycleMonitorSetup,
+  createTextUpdate,
+  postWebhookReplay,
+  settleAsyncWork,
+} from "./test-support/lifecycle-test-support.js";
+import {
+  resetLifecycleTestState,
+  sendMessageMock,
+  setLifecycleRuntimeCore,
+  startWebhookLifecycleMonitor,
+} from "./test-support/monitor-mocks-test-support.js";
+
+describe("Zalo reply-once lifecycle", () => {
+  const finalizeInboundContextMock = vi.fn((ctx: Record<string, unknown>) => ctx);
+  const recordInboundSessionMock = vi.fn(async () => undefined);
+  const resolveAgentRouteMock = vi.fn(() => ({
+    agentId: "main",
+    channel: "zalo",
+    accountId: "acct-zalo-lifecycle",
+    sessionKey: "agent:main:zalo:direct:dm-chat-1",
+    mainSessionKey: "agent:main:main",
+    matchedBy: "default",
+  }));
+  const dispatchReplyWithBufferedBlockDispatcherMock = vi.fn();
+
+  beforeEach(async () => {
+    await resetLifecycleTestState();
+    setLifecycleRuntimeCore({
+      routing: {
+        resolveAgentRoute:
+          resolveAgentRouteMock as unknown as PluginRuntime["channel"]["routing"]["resolveAgentRoute"],
+      },
+      reply: {
+        finalizeInboundContext:
+          finalizeInboundContextMock as unknown as PluginRuntime["channel"]["reply"]["finalizeInboundContext"],
+        dispatchReplyWithBufferedBlockDispatcher:
+          dispatchReplyWithBufferedBlockDispatcherMock as unknown as PluginRuntime["channel"]["reply"]["dispatchReplyWithBufferedBlockDispatcher"],
+      },
+      session: {
+        recordInboundSession:
+          recordInboundSessionMock as unknown as PluginRuntime["channel"]["session"]["recordInboundSession"],
+      },
+    });
+  });
+
+  afterAll(async () => {
+    await resetLifecycleTestState();
+  });
+
+  function createReplyOnceMonitorSetup() {
+    return createLifecycleMonitorSetup({
+      accountId: "acct-zalo-lifecycle",
+      dmPolicy: "open",
+    });
+  }
+
+  it("routes one accepted webhook event to one visible reply across duplicate replay", async () => {
+    dispatchReplyWithBufferedBlockDispatcherMock.mockImplementation(
+      async ({ dispatcherOptions }) => {
+        await dispatcherOptions.deliver({ text: "zalo reply once" });
+      },
+    );
+
+    const monitor = await startWebhookLifecycleMonitor({
+      ...createReplyOnceMonitorSetup(),
+      cacheKey: "zalo-reply-once-lifecycle",
+    });
+
+    try {
+      await withServer(
+        (req, res) => monitor.route.handler(req, res),
+        async (baseUrl) => {
+          const { first, replay } = await postWebhookReplay({
+            baseUrl,
+            path: "/hooks/zalo",
+            secret: "supersecret",
+            payload: createTextUpdate({
+              messageId: `zalo-replay-${Date.now()}`,
+              userId: "user-1",
+              userName: "User One",
+              chatId: "dm-chat-1",
+            }),
+          });
+
+          expect(first.status).toBe(200);
+          expect(replay.status).toBe(200);
+          await settleAsyncWork();
+        },
+      );
+
+      expect(recordInboundSessionMock).toHaveBeenCalledTimes(1);
+      expect(recordInboundSessionMock).toHaveBeenCalledWith(
+        expect.objectContaining({
+          sessionKey: "agent:main:zalo:direct:dm-chat-1",
+          ctx: expect.objectContaining({
+            AccountId: "acct-zalo-lifecycle",
+            SessionKey: "agent:main:zalo:direct:dm-chat-1",
+            MessageSid: expect.stringContaining("zalo-replay-"),
+            From: "zalo:user-1",
+            To: "zalo:dm-chat-1",
+          }),
+        }),
+      );
+      expect(sendMessageMock).toHaveBeenCalledTimes(1);
+      expect(sendMessageMock).toHaveBeenCalledWith(
+        "zalo-token",
+        expect.objectContaining({
+          chat_id: "dm-chat-1",
+          text: "zalo reply once",
+        }),
+        undefined,
+      );
+    } finally {
+      await monitor.stop();
+    }
+  });
+
+  it("does not emit a second visible reply when replay arrives after a post-send failure", async () => {
+    let dispatchAttempts = 0;
+    dispatchReplyWithBufferedBlockDispatcherMock.mockImplementation(
+      async ({ dispatcherOptions }) => {
+        dispatchAttempts += 1;
+        await dispatcherOptions.deliver({ text: "zalo reply after failure" });
+        if (dispatchAttempts === 1) {
+          throw new Error("post-send failure");
+        }
+      },
+    );
+
+    const monitor = await startWebhookLifecycleMonitor({
+      ...createReplyOnceMonitorSetup(),
+      cacheKey: "zalo-reply-once-lifecycle",
+    });
+
+    try {
+      await withServer(
+        (req, res) => monitor.route.handler(req, res),
+        async (baseUrl) => {
+          const { first, replay } = await postWebhookReplay({
+            baseUrl,
+            path: "/hooks/zalo",
+            secret: "supersecret",
+            payload: createTextUpdate({
+              messageId: `zalo-retry-${Date.now()}`,
+              userId: "user-1",
+              userName: "User One",
+              chatId: "dm-chat-1",
+            }),
+            settleBeforeReplay: true,
+          });
+
+          expect(first.status).toBe(200);
+          expect(replay.status).toBe(200);
+          await settleAsyncWork();
+        },
+      );
+
+      expect(dispatchReplyWithBufferedBlockDispatcherMock).toHaveBeenCalledTimes(1);
+      expect(sendMessageMock).toHaveBeenCalledTimes(1);
+      expect(monitor.runtime.error).toHaveBeenCalledWith(
+        expect.stringContaining("Zalo webhook failed: Error: post-send failure"),
+      );
+    } finally {
+      await monitor.stop();
+    }
+  });
+});