mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-10 03:52:42 +00:00
fix: deliver tool result media when verbose is off (#16679)
Merged via /review-pr -> /prepare-pr -> /merge-pr.
Prepared head SHA: 6e16feb164
Co-authored-by: christianklotz <69443+christianklotz@users.noreply.github.com>
Co-authored-by: christianklotz <69443+christianklotz@users.noreply.github.com>
Reviewed-by: @christianklotz
This commit is contained in:
174
src/agents/pi-embedded-subscribe.handlers.tools.media.test.ts
Normal file
174
src/agents/pi-embedded-subscribe.handlers.tools.media.test.ts
Normal file
@@ -0,0 +1,174 @@
|
||||
import { describe, expect, it, vi } from "vitest";
|
||||
import type { EmbeddedPiSubscribeContext } from "./pi-embedded-subscribe.handlers.types.js";
|
||||
import { handleToolExecutionEnd } from "./pi-embedded-subscribe.handlers.tools.js";
|
||||
|
||||
// Minimal mock context factory. Only the fields needed for the media emission path.
|
||||
function createMockContext(overrides?: {
|
||||
shouldEmitToolOutput?: boolean;
|
||||
onToolResult?: ReturnType<typeof vi.fn>;
|
||||
}): EmbeddedPiSubscribeContext {
|
||||
const onToolResult = overrides?.onToolResult ?? vi.fn();
|
||||
return {
|
||||
params: {
|
||||
runId: "test-run",
|
||||
onToolResult,
|
||||
onAgentEvent: vi.fn(),
|
||||
},
|
||||
state: {
|
||||
toolMetaById: new Map(),
|
||||
toolMetas: [],
|
||||
toolSummaryById: new Set(),
|
||||
pendingMessagingTexts: new Map(),
|
||||
pendingMessagingTargets: new Map(),
|
||||
messagingToolSentTexts: [],
|
||||
messagingToolSentTextsNormalized: [],
|
||||
messagingToolSentTargets: [],
|
||||
},
|
||||
log: { debug: vi.fn(), warn: vi.fn() },
|
||||
shouldEmitToolResult: vi.fn(() => false),
|
||||
shouldEmitToolOutput: vi.fn(() => overrides?.shouldEmitToolOutput ?? false),
|
||||
emitToolSummary: vi.fn(),
|
||||
emitToolOutput: vi.fn(),
|
||||
trimMessagingToolSent: vi.fn(),
|
||||
hookRunner: undefined,
|
||||
// Fill in remaining required fields with no-ops.
|
||||
blockChunker: null,
|
||||
noteLastAssistant: vi.fn(),
|
||||
stripBlockTags: vi.fn((t: string) => t),
|
||||
emitBlockChunk: vi.fn(),
|
||||
flushBlockReplyBuffer: vi.fn(),
|
||||
emitReasoningStream: vi.fn(),
|
||||
consumeReplyDirectives: vi.fn(() => null),
|
||||
consumePartialReplyDirectives: vi.fn(() => null),
|
||||
resetAssistantMessageState: vi.fn(),
|
||||
resetForCompactionRetry: vi.fn(),
|
||||
finalizeAssistantTexts: vi.fn(),
|
||||
ensureCompactionPromise: vi.fn(),
|
||||
noteCompactionRetry: vi.fn(),
|
||||
resolveCompactionRetry: vi.fn(),
|
||||
maybeResolveCompactionWait: vi.fn(),
|
||||
recordAssistantUsage: vi.fn(),
|
||||
incrementCompactionCount: vi.fn(),
|
||||
getUsageTotals: vi.fn(() => undefined),
|
||||
getCompactionCount: vi.fn(() => 0),
|
||||
} as unknown as EmbeddedPiSubscribeContext;
|
||||
}
|
||||
|
||||
describe("handleToolExecutionEnd media emission", () => {
|
||||
it("emits media when verbose is off and tool result has MEDIA: path", async () => {
|
||||
const onToolResult = vi.fn();
|
||||
const ctx = createMockContext({ shouldEmitToolOutput: false, onToolResult });
|
||||
|
||||
await handleToolExecutionEnd(ctx, {
|
||||
type: "tool_execution_end",
|
||||
toolName: "browser",
|
||||
toolCallId: "tc-1",
|
||||
isError: false,
|
||||
result: {
|
||||
content: [
|
||||
{ type: "text", text: "MEDIA:/tmp/screenshot.png" },
|
||||
{ type: "image", data: "base64", mimeType: "image/png" },
|
||||
],
|
||||
details: { path: "/tmp/screenshot.png" },
|
||||
},
|
||||
});
|
||||
|
||||
expect(onToolResult).toHaveBeenCalledWith({
|
||||
mediaUrls: ["/tmp/screenshot.png"],
|
||||
});
|
||||
});
|
||||
|
||||
it("does NOT emit media when verbose is full (emitToolOutput handles it)", async () => {
|
||||
const onToolResult = vi.fn();
|
||||
const ctx = createMockContext({ shouldEmitToolOutput: true, onToolResult });
|
||||
|
||||
await handleToolExecutionEnd(ctx, {
|
||||
type: "tool_execution_end",
|
||||
toolName: "browser",
|
||||
toolCallId: "tc-1",
|
||||
isError: false,
|
||||
result: {
|
||||
content: [
|
||||
{ type: "text", text: "MEDIA:/tmp/screenshot.png" },
|
||||
{ type: "image", data: "base64", mimeType: "image/png" },
|
||||
],
|
||||
details: { path: "/tmp/screenshot.png" },
|
||||
},
|
||||
});
|
||||
|
||||
// onToolResult should NOT be called by the new media path (emitToolOutput handles it).
|
||||
// It may be called by emitToolOutput, but the new block should not fire.
|
||||
// Verify emitToolOutput was called instead.
|
||||
expect(ctx.emitToolOutput).toHaveBeenCalled();
|
||||
// The direct media emission should not have been called with just mediaUrls.
|
||||
const directMediaCalls = onToolResult.mock.calls.filter(
|
||||
(call: unknown[]) =>
|
||||
call[0] &&
|
||||
typeof call[0] === "object" &&
|
||||
"mediaUrls" in (call[0] as Record<string, unknown>) &&
|
||||
!("text" in (call[0] as Record<string, unknown>)),
|
||||
);
|
||||
expect(directMediaCalls).toHaveLength(0);
|
||||
});
|
||||
|
||||
it("does NOT emit media for error results", async () => {
|
||||
const onToolResult = vi.fn();
|
||||
const ctx = createMockContext({ shouldEmitToolOutput: false, onToolResult });
|
||||
|
||||
await handleToolExecutionEnd(ctx, {
|
||||
type: "tool_execution_end",
|
||||
toolName: "browser",
|
||||
toolCallId: "tc-1",
|
||||
isError: true,
|
||||
result: {
|
||||
content: [
|
||||
{ type: "text", text: "MEDIA:/tmp/screenshot.png" },
|
||||
{ type: "image", data: "base64", mimeType: "image/png" },
|
||||
],
|
||||
details: { path: "/tmp/screenshot.png" },
|
||||
},
|
||||
});
|
||||
|
||||
expect(onToolResult).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("does NOT emit when tool result has no media", async () => {
|
||||
const onToolResult = vi.fn();
|
||||
const ctx = createMockContext({ shouldEmitToolOutput: false, onToolResult });
|
||||
|
||||
await handleToolExecutionEnd(ctx, {
|
||||
type: "tool_execution_end",
|
||||
toolName: "bash",
|
||||
toolCallId: "tc-1",
|
||||
isError: false,
|
||||
result: {
|
||||
content: [{ type: "text", text: "Command executed successfully" }],
|
||||
},
|
||||
});
|
||||
|
||||
expect(onToolResult).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("emits media from details.path fallback when no MEDIA: text", async () => {
|
||||
const onToolResult = vi.fn();
|
||||
const ctx = createMockContext({ shouldEmitToolOutput: false, onToolResult });
|
||||
|
||||
await handleToolExecutionEnd(ctx, {
|
||||
type: "tool_execution_end",
|
||||
toolName: "canvas",
|
||||
toolCallId: "tc-1",
|
||||
isError: false,
|
||||
result: {
|
||||
content: [
|
||||
{ type: "text", text: "Rendered canvas" },
|
||||
{ type: "image", data: "base64", mimeType: "image/png" },
|
||||
],
|
||||
details: { path: "/tmp/canvas-output.png" },
|
||||
},
|
||||
});
|
||||
|
||||
expect(onToolResult).toHaveBeenCalledWith({
|
||||
mediaUrls: ["/tmp/canvas-output.png"],
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user