Merge pull request #505 from koala73/feat/whatsapp-media-max-size
feat(whatsapp): add configurable media max size
This commit is contained in:
@@ -38,6 +38,7 @@
|
|||||||
- Doctor: repair gateway service entrypoint when switching between npm and git installs; add Docker e2e coverage. — thanks @steipete
|
- Doctor: repair gateway service entrypoint when switching between npm and git installs; add Docker e2e coverage. — thanks @steipete
|
||||||
- Daemon: align generated systemd unit with docs for network-online + restart delay. (#479) — thanks @azade-c
|
- Daemon: align generated systemd unit with docs for network-online + restart delay. (#479) — thanks @azade-c
|
||||||
- Daemon: add KillMode=process to systemd units to avoid podman restart hangs. (#541) — thanks @ogulcancelik
|
- Daemon: add KillMode=process to systemd units to avoid podman restart hangs. (#541) — thanks @ogulcancelik
|
||||||
|
- WhatsApp: make inbound media size cap configurable (default 50 MB). (#505) — thanks @koala73
|
||||||
- Doctor: run legacy state migrations in non-interactive mode without prompts.
|
- Doctor: run legacy state migrations in non-interactive mode without prompts.
|
||||||
- Cron: parse Telegram topic targets for isolated delivery. (#478) — thanks @nachoiacovino
|
- Cron: parse Telegram topic targets for isolated delivery. (#478) — thanks @nachoiacovino
|
||||||
- Outbound: default Telegram account selection for config-only tokens; remove heartbeat-specific accountId handling. (follow-up #516) — thanks @YuriNachos
|
- Outbound: default Telegram account selection for config-only tokens; remove heartbeat-specific accountId handling. (follow-up #516) — thanks @YuriNachos
|
||||||
|
|||||||
@@ -265,7 +265,8 @@ For groups, use `whatsapp.groupPolicy` + `whatsapp.groupAllowFrom`.
|
|||||||
whatsapp: {
|
whatsapp: {
|
||||||
dmPolicy: "pairing", // pairing | allowlist | open | disabled
|
dmPolicy: "pairing", // pairing | allowlist | open | disabled
|
||||||
allowFrom: ["+15555550123", "+447700900123"],
|
allowFrom: ["+15555550123", "+447700900123"],
|
||||||
textChunkLimit: 4000 // optional outbound chunk size (chars)
|
textChunkLimit: 4000, // optional outbound chunk size (chars)
|
||||||
|
mediaMaxMb: 50 // optional inbound media cap (MB)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -151,7 +151,8 @@ Behavior:
|
|||||||
|
|
||||||
## Limits
|
## Limits
|
||||||
- Outbound text is chunked to `whatsapp.textChunkLimit` (default 4000).
|
- Outbound text is chunked to `whatsapp.textChunkLimit` (default 4000).
|
||||||
- Media items are capped by `agents.defaults.mediaMaxMb` (default 5 MB).
|
- Inbound media saves are capped by `whatsapp.mediaMaxMb` (default 50 MB).
|
||||||
|
- Outbound media items are capped by `agents.defaults.mediaMaxMb` (default 5 MB).
|
||||||
|
|
||||||
## Outbound send (text + media)
|
## Outbound send (text + media)
|
||||||
- Uses active web listener; error if gateway not running.
|
- Uses active web listener; error if gateway not running.
|
||||||
@@ -166,7 +167,7 @@ Behavior:
|
|||||||
- Gateway: `send` params include `gifPlayback: true`
|
- Gateway: `send` params include `gifPlayback: true`
|
||||||
|
|
||||||
## Media limits + optimization
|
## Media limits + optimization
|
||||||
- Default cap: 5 MB (per media item).
|
- Default outbound cap: 5 MB (per media item).
|
||||||
- Override: `agents.defaults.mediaMaxMb`.
|
- Override: `agents.defaults.mediaMaxMb`.
|
||||||
- Images are auto-optimized to JPEG under cap (resize + quality sweep).
|
- Images are auto-optimized to JPEG under cap (resize + quality sweep).
|
||||||
- Oversize media => error; media reply falls back to text warning.
|
- Oversize media => error; media reply falls back to text warning.
|
||||||
@@ -187,7 +188,9 @@ Behavior:
|
|||||||
- `whatsapp.dmPolicy` (DM policy: pairing/allowlist/open/disabled).
|
- `whatsapp.dmPolicy` (DM policy: pairing/allowlist/open/disabled).
|
||||||
- `whatsapp.selfChatMode` (same-phone setup; suppress pairing replies for outbound DMs).
|
- `whatsapp.selfChatMode` (same-phone setup; suppress pairing replies for outbound DMs).
|
||||||
- `whatsapp.allowFrom` (DM allowlist).
|
- `whatsapp.allowFrom` (DM allowlist).
|
||||||
|
- `whatsapp.mediaMaxMb` (inbound media save cap).
|
||||||
- `whatsapp.accounts.<accountId>.*` (per-account settings + optional `authDir`).
|
- `whatsapp.accounts.<accountId>.*` (per-account settings + optional `authDir`).
|
||||||
|
- `whatsapp.accounts.<accountId>.mediaMaxMb` (per-account inbound media cap).
|
||||||
- `whatsapp.groupAllowFrom` (group sender allowlist).
|
- `whatsapp.groupAllowFrom` (group sender allowlist).
|
||||||
- `whatsapp.groupPolicy` (group policy).
|
- `whatsapp.groupPolicy` (group policy).
|
||||||
- `whatsapp.groups` (group allowlist + mention gating defaults; use `"*"` to allow all)
|
- `whatsapp.groups` (group allowlist + mention gating defaults; use `"*"` to allow all)
|
||||||
|
|||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -131,6 +131,8 @@ export type WhatsAppConfig = {
|
|||||||
groupPolicy?: GroupPolicy;
|
groupPolicy?: GroupPolicy;
|
||||||
/** Outbound text chunk size (chars). Default: 4000. */
|
/** Outbound text chunk size (chars). Default: 4000. */
|
||||||
textChunkLimit?: number;
|
textChunkLimit?: number;
|
||||||
|
/** Maximum media file size in MB. Default: 50. */
|
||||||
|
mediaMaxMb?: number;
|
||||||
/** Disable block streaming for this account. */
|
/** Disable block streaming for this account. */
|
||||||
blockStreaming?: boolean;
|
blockStreaming?: boolean;
|
||||||
/** Merge streamed block replies before sending. */
|
/** Merge streamed block replies before sending. */
|
||||||
@@ -160,6 +162,7 @@ export type WhatsAppAccountConfig = {
|
|||||||
groupAllowFrom?: string[];
|
groupAllowFrom?: string[];
|
||||||
groupPolicy?: GroupPolicy;
|
groupPolicy?: GroupPolicy;
|
||||||
textChunkLimit?: number;
|
textChunkLimit?: number;
|
||||||
|
mediaMaxMb?: number;
|
||||||
blockStreaming?: boolean;
|
blockStreaming?: boolean;
|
||||||
/** Merge streamed block replies before sending. */
|
/** Merge streamed block replies before sending. */
|
||||||
blockStreamingCoalesce?: BlockStreamingCoalesceConfig;
|
blockStreamingCoalesce?: BlockStreamingCoalesceConfig;
|
||||||
|
|||||||
@@ -1227,6 +1227,7 @@ export const ClawdbotSchema = z.object({
|
|||||||
groupAllowFrom: z.array(z.string()).optional(),
|
groupAllowFrom: z.array(z.string()).optional(),
|
||||||
groupPolicy: GroupPolicySchema.optional().default("open"),
|
groupPolicy: GroupPolicySchema.optional().default("open"),
|
||||||
textChunkLimit: z.number().int().positive().optional(),
|
textChunkLimit: z.number().int().positive().optional(),
|
||||||
|
mediaMaxMb: z.number().int().positive().optional(),
|
||||||
blockStreaming: z.boolean().optional(),
|
blockStreaming: z.boolean().optional(),
|
||||||
blockStreamingCoalesce: BlockStreamingCoalesceSchema.optional(),
|
blockStreamingCoalesce: BlockStreamingCoalesceSchema.optional(),
|
||||||
groups: z
|
groups: z
|
||||||
@@ -1262,6 +1263,7 @@ export const ClawdbotSchema = z.object({
|
|||||||
groupAllowFrom: z.array(z.string()).optional(),
|
groupAllowFrom: z.array(z.string()).optional(),
|
||||||
groupPolicy: GroupPolicySchema.optional().default("open"),
|
groupPolicy: GroupPolicySchema.optional().default("open"),
|
||||||
textChunkLimit: z.number().int().positive().optional(),
|
textChunkLimit: z.number().int().positive().optional(),
|
||||||
|
mediaMaxMb: z.number().int().positive().optional().default(50),
|
||||||
blockStreaming: z.boolean().optional(),
|
blockStreaming: z.boolean().optional(),
|
||||||
blockStreamingCoalesce: BlockStreamingCoalesceSchema.optional(),
|
blockStreamingCoalesce: BlockStreamingCoalesceSchema.optional(),
|
||||||
actions: z
|
actions: z
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ export type ResolvedWhatsAppAccount = {
|
|||||||
groupPolicy?: GroupPolicy;
|
groupPolicy?: GroupPolicy;
|
||||||
dmPolicy?: DmPolicy;
|
dmPolicy?: DmPolicy;
|
||||||
textChunkLimit?: number;
|
textChunkLimit?: number;
|
||||||
|
mediaMaxMb?: number;
|
||||||
blockStreaming?: boolean;
|
blockStreaming?: boolean;
|
||||||
groups?: WhatsAppAccountConfig["groups"];
|
groups?: WhatsAppAccountConfig["groups"];
|
||||||
};
|
};
|
||||||
@@ -120,6 +121,7 @@ export function resolveWhatsAppAccount(params: {
|
|||||||
groupPolicy: accountCfg?.groupPolicy ?? params.cfg.whatsapp?.groupPolicy,
|
groupPolicy: accountCfg?.groupPolicy ?? params.cfg.whatsapp?.groupPolicy,
|
||||||
textChunkLimit:
|
textChunkLimit:
|
||||||
accountCfg?.textChunkLimit ?? params.cfg.whatsapp?.textChunkLimit,
|
accountCfg?.textChunkLimit ?? params.cfg.whatsapp?.textChunkLimit,
|
||||||
|
mediaMaxMb: accountCfg?.mediaMaxMb ?? params.cfg.whatsapp?.mediaMaxMb,
|
||||||
blockStreaming:
|
blockStreaming:
|
||||||
accountCfg?.blockStreaming ?? params.cfg.whatsapp?.blockStreaming,
|
accountCfg?.blockStreaming ?? params.cfg.whatsapp?.blockStreaming,
|
||||||
groups: accountCfg?.groups ?? params.cfg.whatsapp?.groups,
|
groups: accountCfg?.groups ?? params.cfg.whatsapp?.groups,
|
||||||
|
|||||||
@@ -788,6 +788,7 @@ export async function monitorWebProvider(
|
|||||||
groupAllowFrom: account.groupAllowFrom,
|
groupAllowFrom: account.groupAllowFrom,
|
||||||
groupPolicy: account.groupPolicy,
|
groupPolicy: account.groupPolicy,
|
||||||
textChunkLimit: account.textChunkLimit,
|
textChunkLimit: account.textChunkLimit,
|
||||||
|
mediaMaxMb: account.mediaMaxMb,
|
||||||
blockStreaming: account.blockStreaming,
|
blockStreaming: account.blockStreaming,
|
||||||
groups: account.groups,
|
groups: account.groups,
|
||||||
},
|
},
|
||||||
@@ -1305,6 +1306,7 @@ export async function monitorWebProvider(
|
|||||||
verbose,
|
verbose,
|
||||||
accountId: account.accountId,
|
accountId: account.accountId,
|
||||||
authDir: account.authDir,
|
authDir: account.authDir,
|
||||||
|
mediaMaxMb: account.mediaMaxMb,
|
||||||
onMessage: async (msg) => {
|
onMessage: async (msg) => {
|
||||||
handledMessages += 1;
|
handledMessages += 1;
|
||||||
lastMessageAt = Date.now();
|
lastMessageAt = Date.now();
|
||||||
|
|||||||
@@ -3,12 +3,21 @@ import fs from "node:fs/promises";
|
|||||||
import os from "node:os";
|
import os from "node:os";
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
|
|
||||||
import { afterAll, beforeAll, describe, expect, it, vi } from "vitest";
|
import {
|
||||||
|
afterAll,
|
||||||
|
beforeAll,
|
||||||
|
beforeEach,
|
||||||
|
describe,
|
||||||
|
expect,
|
||||||
|
it,
|
||||||
|
vi,
|
||||||
|
} from "vitest";
|
||||||
|
|
||||||
const readAllowFromStoreMock = vi.fn().mockResolvedValue([]);
|
const readAllowFromStoreMock = vi.fn().mockResolvedValue([]);
|
||||||
const upsertPairingRequestMock = vi
|
const upsertPairingRequestMock = vi
|
||||||
.fn()
|
.fn()
|
||||||
.mockResolvedValue({ code: "PAIRCODE", created: true });
|
.mockResolvedValue({ code: "PAIRCODE", created: true });
|
||||||
|
const saveMediaBufferSpy = vi.fn();
|
||||||
|
|
||||||
vi.mock("../config/config.js", async (importOriginal) => {
|
vi.mock("../config/config.js", async (importOriginal) => {
|
||||||
const actual = await importOriginal<typeof import("../config/config.js")>();
|
const actual = await importOriginal<typeof import("../config/config.js")>();
|
||||||
@@ -33,6 +42,19 @@ vi.mock("../pairing/pairing-store.js", () => ({
|
|||||||
upsertPairingRequestMock(...args),
|
upsertPairingRequestMock(...args),
|
||||||
}));
|
}));
|
||||||
|
|
||||||
|
vi.mock("../media/store.js", async (importOriginal) => {
|
||||||
|
const actual = await importOriginal<typeof import("../media/store.js")>();
|
||||||
|
return {
|
||||||
|
...actual,
|
||||||
|
saveMediaBuffer: vi.fn(
|
||||||
|
async (...args: Parameters<typeof actual.saveMediaBuffer>) => {
|
||||||
|
saveMediaBufferSpy(...args);
|
||||||
|
return actual.saveMediaBuffer(...args);
|
||||||
|
},
|
||||||
|
),
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
const HOME = path.join(
|
const HOME = path.join(
|
||||||
os.tmpdir(),
|
os.tmpdir(),
|
||||||
`clawdbot-inbound-media-${crypto.randomUUID()}`,
|
`clawdbot-inbound-media-${crypto.randomUUID()}`,
|
||||||
@@ -87,6 +109,10 @@ vi.mock("./session.js", () => {
|
|||||||
import { monitorWebInbox } from "./inbound.js";
|
import { monitorWebInbox } from "./inbound.js";
|
||||||
|
|
||||||
describe("web inbound media saves with extension", () => {
|
describe("web inbound media saves with extension", () => {
|
||||||
|
beforeEach(() => {
|
||||||
|
saveMediaBufferSpy.mockClear();
|
||||||
|
});
|
||||||
|
|
||||||
beforeAll(async () => {
|
beforeAll(async () => {
|
||||||
await fs.rm(HOME, { recursive: true, force: true });
|
await fs.rm(HOME, { recursive: true, force: true });
|
||||||
});
|
});
|
||||||
@@ -182,4 +208,44 @@ describe("web inbound media saves with extension", () => {
|
|||||||
|
|
||||||
await listener.close();
|
await listener.close();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it("passes mediaMaxMb to saveMediaBuffer", async () => {
|
||||||
|
const onMessage = vi.fn();
|
||||||
|
const listener = await monitorWebInbox({
|
||||||
|
verbose: false,
|
||||||
|
onMessage,
|
||||||
|
mediaMaxMb: 1,
|
||||||
|
});
|
||||||
|
const { createWaSocket } = await import("./session.js");
|
||||||
|
const realSock = await (
|
||||||
|
createWaSocket as unknown as () => Promise<{
|
||||||
|
ev: import("node:events").EventEmitter;
|
||||||
|
}>
|
||||||
|
)();
|
||||||
|
|
||||||
|
const upsert = {
|
||||||
|
type: "notify",
|
||||||
|
messages: [
|
||||||
|
{
|
||||||
|
key: { id: "img3", fromMe: false, remoteJid: "222@s.whatsapp.net" },
|
||||||
|
message: { imageMessage: { mimetype: "image/jpeg" } },
|
||||||
|
messageTimestamp: 1_700_000_003,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
realSock.ev.emit("messages.upsert", upsert);
|
||||||
|
|
||||||
|
for (let i = 0; i < 10; i++) {
|
||||||
|
if (onMessage.mock.calls.length > 0) break;
|
||||||
|
await new Promise((resolve) => setTimeout(resolve, 5));
|
||||||
|
}
|
||||||
|
|
||||||
|
expect(onMessage).toHaveBeenCalledTimes(1);
|
||||||
|
expect(saveMediaBufferSpy).toHaveBeenCalled();
|
||||||
|
const lastCall = saveMediaBufferSpy.mock.calls.at(-1);
|
||||||
|
expect(lastCall?.[3]).toBe(1 * 1024 * 1024);
|
||||||
|
|
||||||
|
await listener.close();
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -83,6 +83,7 @@ export async function monitorWebInbox(options: {
|
|||||||
accountId: string;
|
accountId: string;
|
||||||
authDir: string;
|
authDir: string;
|
||||||
onMessage: (msg: WebInboundMessage) => Promise<void>;
|
onMessage: (msg: WebInboundMessage) => Promise<void>;
|
||||||
|
mediaMaxMb?: number;
|
||||||
}) {
|
}) {
|
||||||
const inboundLogger = getChildLogger({ module: "web-inbound" });
|
const inboundLogger = getChildLogger({ module: "web-inbound" });
|
||||||
const inboundConsoleLog = createSubsystemLogger(
|
const inboundConsoleLog = createSubsystemLogger(
|
||||||
@@ -375,9 +376,16 @@ export async function monitorWebInbox(options: {
|
|||||||
try {
|
try {
|
||||||
const inboundMedia = await downloadInboundMedia(msg, sock);
|
const inboundMedia = await downloadInboundMedia(msg, sock);
|
||||||
if (inboundMedia) {
|
if (inboundMedia) {
|
||||||
|
const maxMb =
|
||||||
|
typeof options.mediaMaxMb === "number" && options.mediaMaxMb > 0
|
||||||
|
? options.mediaMaxMb
|
||||||
|
: 50;
|
||||||
|
const maxBytes = maxMb * 1024 * 1024;
|
||||||
const saved = await saveMediaBuffer(
|
const saved = await saveMediaBuffer(
|
||||||
inboundMedia.buffer,
|
inboundMedia.buffer,
|
||||||
inboundMedia.mimetype,
|
inboundMedia.mimetype,
|
||||||
|
"inbound",
|
||||||
|
maxBytes,
|
||||||
);
|
);
|
||||||
mediaPath = saved.path;
|
mediaPath = saved.path;
|
||||||
mediaType = inboundMedia.mimetype;
|
mediaType = inboundMedia.mimetype;
|
||||||
|
|||||||
Reference in New Issue
Block a user