revert: "fix(listen): normalize interrupt tool returns for websocket parity" (#1291)
This commit is contained in:
@@ -1,103 +0,0 @@
|
||||
import { describe, expect, test } from "bun:test";
|
||||
import type { ApprovalCreate } from "@letta-ai/letta-client/resources/agents/messages";
|
||||
import type { ApprovalResult } from "../../agent/approval-execution";
|
||||
import {
|
||||
normalizeApprovalResultsForPersistence,
|
||||
normalizeOutgoingApprovalMessages,
|
||||
} from "../../agent/approval-result-normalization";
|
||||
import { INTERRUPTED_BY_USER } from "../../constants";
|
||||
|
||||
describe("normalizeApprovalResultsForPersistence", () => {
|
||||
test("forces status=error for structured interrupted tool_call_ids", () => {
|
||||
const approvals: ApprovalResult[] = [
|
||||
{
|
||||
type: "tool",
|
||||
tool_call_id: "call-1",
|
||||
tool_return: "some return",
|
||||
status: "success",
|
||||
} as ApprovalResult,
|
||||
];
|
||||
|
||||
const normalized = normalizeApprovalResultsForPersistence(approvals, {
|
||||
interruptedToolCallIds: ["call-1"],
|
||||
});
|
||||
|
||||
expect(normalized[0]).toMatchObject({
|
||||
type: "tool",
|
||||
tool_call_id: "call-1",
|
||||
status: "error",
|
||||
});
|
||||
});
|
||||
|
||||
test("does not modify non-interrupted tool results", () => {
|
||||
const approvals: ApprovalResult[] = [
|
||||
{
|
||||
type: "tool",
|
||||
tool_call_id: "call-2",
|
||||
tool_return: "ok",
|
||||
status: "success",
|
||||
} as ApprovalResult,
|
||||
];
|
||||
|
||||
const normalized = normalizeApprovalResultsForPersistence(approvals, {
|
||||
interruptedToolCallIds: ["other-id"],
|
||||
});
|
||||
|
||||
expect(normalized[0]).toMatchObject({
|
||||
type: "tool",
|
||||
tool_call_id: "call-2",
|
||||
status: "success",
|
||||
});
|
||||
});
|
||||
|
||||
test("supports legacy fallback on interrupt text when explicitly enabled", () => {
|
||||
const approvals: ApprovalResult[] = [
|
||||
{
|
||||
type: "tool",
|
||||
tool_call_id: "call-3",
|
||||
tool_return: [{ type: "text", text: INTERRUPTED_BY_USER }],
|
||||
status: "success",
|
||||
} as ApprovalResult,
|
||||
];
|
||||
|
||||
const normalized = normalizeApprovalResultsForPersistence(approvals, {
|
||||
allowInterruptTextFallback: true,
|
||||
});
|
||||
|
||||
expect(normalized[0]).toMatchObject({
|
||||
type: "tool",
|
||||
tool_call_id: "call-3",
|
||||
status: "error",
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("normalizeOutgoingApprovalMessages", () => {
|
||||
test("normalizes approvals and preserves non-approval messages", () => {
|
||||
const approvalMessage: ApprovalCreate = {
|
||||
type: "approval",
|
||||
approvals: [
|
||||
{
|
||||
type: "tool",
|
||||
tool_call_id: "call-7",
|
||||
tool_return: "foo",
|
||||
status: "success",
|
||||
} as ApprovalResult,
|
||||
],
|
||||
};
|
||||
|
||||
const messages = normalizeOutgoingApprovalMessages(
|
||||
[{ role: "user", content: "hello" }, approvalMessage],
|
||||
{ interruptedToolCallIds: ["call-7"] },
|
||||
);
|
||||
|
||||
expect(messages[0]).toMatchObject({ role: "user", content: "hello" });
|
||||
const normalizedApproval = messages[1] as ApprovalCreate;
|
||||
const approvals = normalizedApproval.approvals ?? [];
|
||||
expect(approvals[0]).toMatchObject({
|
||||
type: "tool",
|
||||
tool_call_id: "call-7",
|
||||
status: "error",
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -640,44 +640,3 @@ describe("listen-client post-stop approval recovery policy", () => {
|
||||
expect(shouldRecover).toBe(false);
|
||||
});
|
||||
});
|
||||
|
||||
describe("listen-client tool_return wire normalization", () => {
|
||||
test("normalizes legacy top-level tool return fields to canonical tool_returns[]", () => {
|
||||
const normalized = __listenClientTestUtils.normalizeToolReturnWireMessage({
|
||||
message_type: "tool_return_message",
|
||||
id: "message-1",
|
||||
run_id: "run-1",
|
||||
tool_call_id: "call-1",
|
||||
status: "error",
|
||||
tool_return: [{ type: "text", text: "Interrupted by user" }],
|
||||
});
|
||||
|
||||
expect(normalized).toEqual({
|
||||
message_type: "tool_return_message",
|
||||
id: "message-1",
|
||||
run_id: "run-1",
|
||||
tool_returns: [
|
||||
{
|
||||
tool_call_id: "call-1",
|
||||
status: "error",
|
||||
tool_return: "Interrupted by user",
|
||||
},
|
||||
],
|
||||
});
|
||||
expect(normalized).not.toHaveProperty("tool_call_id");
|
||||
expect(normalized).not.toHaveProperty("status");
|
||||
expect(normalized).not.toHaveProperty("tool_return");
|
||||
});
|
||||
|
||||
test("returns null for tool_return_message when no canonical status is available", () => {
|
||||
const normalized = __listenClientTestUtils.normalizeToolReturnWireMessage({
|
||||
message_type: "tool_return_message",
|
||||
id: "message-2",
|
||||
run_id: "run-2",
|
||||
tool_call_id: "call-2",
|
||||
tool_return: "maybe done",
|
||||
});
|
||||
|
||||
expect(normalized).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
@@ -178,29 +178,6 @@ describe("extractInterruptToolReturns", () => {
|
||||
]);
|
||||
});
|
||||
|
||||
test("converts multimodal tool_return content into displayable text", () => {
|
||||
const results: ApprovalResult[] = [
|
||||
{
|
||||
type: "tool",
|
||||
tool_call_id: "call-multimodal",
|
||||
status: "error",
|
||||
tool_return: [
|
||||
{ type: "text", text: "Interrupted by user" },
|
||||
{ type: "image", image_url: "https://example.com/image.png" },
|
||||
],
|
||||
} as ApprovalResult,
|
||||
];
|
||||
|
||||
const mapped = extractInterruptToolReturns(results);
|
||||
expect(mapped).toEqual([
|
||||
{
|
||||
tool_call_id: "call-multimodal",
|
||||
status: "error",
|
||||
tool_return: "Interrupted by user",
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
test("emitInterruptToolReturnMessage emits deterministic per-tool terminal messages", () => {
|
||||
const runtime = createRuntime();
|
||||
const socket = new MockSocket(WebSocket.OPEN) as unknown as WebSocket;
|
||||
@@ -231,26 +208,16 @@ describe("extractInterruptToolReturns", () => {
|
||||
expect(toolReturnFrames).toHaveLength(2);
|
||||
expect(toolReturnFrames[0]).toMatchObject({
|
||||
run_id: "run-1",
|
||||
tool_returns: [
|
||||
{ tool_call_id: "call-a", status: "success", tool_return: "704" },
|
||||
],
|
||||
tool_call_id: "call-a",
|
||||
status: "success",
|
||||
tool_returns: [{ tool_call_id: "call-a", status: "success" }],
|
||||
});
|
||||
expect(toolReturnFrames[1]).toMatchObject({
|
||||
run_id: "run-1",
|
||||
tool_returns: [
|
||||
{
|
||||
tool_call_id: "call-b",
|
||||
status: "error",
|
||||
tool_return: "User interrupted the stream",
|
||||
},
|
||||
],
|
||||
tool_call_id: "call-b",
|
||||
status: "error",
|
||||
tool_returns: [{ tool_call_id: "call-b", status: "error" }],
|
||||
});
|
||||
expect(toolReturnFrames[0]).not.toHaveProperty("tool_call_id");
|
||||
expect(toolReturnFrames[0]).not.toHaveProperty("status");
|
||||
expect(toolReturnFrames[0]).not.toHaveProperty("tool_return");
|
||||
expect(toolReturnFrames[1]).not.toHaveProperty("tool_call_id");
|
||||
expect(toolReturnFrames[1]).not.toHaveProperty("status");
|
||||
expect(toolReturnFrames[1]).not.toHaveProperty("tool_return");
|
||||
});
|
||||
});
|
||||
|
||||
@@ -338,14 +305,13 @@ describe("Path A: cancel during tool execution → next turn consumes actual res
|
||||
// Cancel fires: populateInterruptQueue (Path A — has execution results)
|
||||
const populated = populateInterruptQueue(runtime, {
|
||||
lastExecutionResults: executionResults,
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: ["call-1", "call-2"],
|
||||
agentId,
|
||||
conversationId,
|
||||
});
|
||||
|
||||
expect(populated).toBe(true);
|
||||
expect(runtime.pendingInterruptedResults).toEqual(executionResults);
|
||||
expect(runtime.pendingInterruptedResults).toBe(executionResults);
|
||||
expect(runtime.pendingInterruptedContext).toMatchObject({
|
||||
agentId,
|
||||
conversationId,
|
||||
@@ -357,7 +323,7 @@ describe("Path A: cancel during tool execution → next turn consumes actual res
|
||||
|
||||
expect(consumed).not.toBeNull();
|
||||
expect(consumed?.type).toBe("approval");
|
||||
expect(consumed?.approvals).toEqual(executionResults);
|
||||
expect(consumed?.approvals).toBe(executionResults);
|
||||
expect(consumed?.approvals).toHaveLength(2);
|
||||
|
||||
// Queue is atomically cleared after consumption
|
||||
@@ -376,7 +342,6 @@ describe("Path A: cancel during tool execution → next turn consumes actual res
|
||||
|
||||
const populated = populateInterruptQueue(runtime, {
|
||||
lastExecutionResults: executionResults,
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: ["call-1"],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
@@ -388,85 +353,9 @@ describe("Path A: cancel during tool execution → next turn consumes actual res
|
||||
approve: true, // Path A preserves actual approval state
|
||||
});
|
||||
});
|
||||
|
||||
test("normalizes interrupted tool results to error via structured tool_call_id", () => {
|
||||
const runtime = createRuntime();
|
||||
const executionResults: ApprovalResult[] = [
|
||||
{
|
||||
type: "tool",
|
||||
tool_call_id: "call-1",
|
||||
status: "success",
|
||||
tool_return: "result text does not matter when ID is interrupted",
|
||||
} as unknown as ApprovalResult,
|
||||
];
|
||||
|
||||
const populated = populateInterruptQueue(runtime, {
|
||||
lastExecutionResults: executionResults,
|
||||
lastExecutingToolCallIds: ["call-1"],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
});
|
||||
|
||||
expect(populated).toBe(true);
|
||||
expect(runtime.pendingInterruptedResults?.[0]).toMatchObject({
|
||||
type: "tool",
|
||||
tool_call_id: "call-1",
|
||||
status: "error",
|
||||
});
|
||||
});
|
||||
|
||||
test("keeps legacy text fallback for interrupted tool return normalization", () => {
|
||||
const runtime = createRuntime();
|
||||
const executionResults: ApprovalResult[] = [
|
||||
{
|
||||
type: "tool",
|
||||
tool_call_id: "call-legacy",
|
||||
status: "success",
|
||||
tool_return: [{ type: "text", text: "Interrupted by user" }],
|
||||
} as unknown as ApprovalResult,
|
||||
];
|
||||
|
||||
const populated = populateInterruptQueue(runtime, {
|
||||
lastExecutionResults: executionResults,
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
});
|
||||
|
||||
expect(populated).toBe(true);
|
||||
expect(runtime.pendingInterruptedResults?.[0]).toMatchObject({
|
||||
type: "tool",
|
||||
tool_call_id: "call-legacy",
|
||||
status: "error",
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("Path B: cancel during approval wait → next turn consumes synthesized denials", () => {
|
||||
test("prefers synthesized tool-error results when execution was already in-flight", () => {
|
||||
const runtime = createRuntime();
|
||||
|
||||
const populated = populateInterruptQueue(runtime, {
|
||||
lastExecutionResults: null,
|
||||
lastExecutingToolCallIds: ["call-running-1"],
|
||||
lastNeedsUserInputToolCallIds: ["call-running-1"],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
});
|
||||
|
||||
expect(populated).toBe(true);
|
||||
expect(runtime.pendingInterruptedResults).toEqual([
|
||||
{
|
||||
type: "tool",
|
||||
tool_call_id: "call-running-1",
|
||||
tool_return: "Interrupted by user",
|
||||
status: "error",
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
test("full sequence: populate from batch map IDs → consume synthesized denials", () => {
|
||||
const runtime = createRuntime();
|
||||
const agentId = "agent-abc";
|
||||
@@ -482,7 +371,6 @@ describe("Path B: cancel during approval wait → next turn consumes synthesized
|
||||
// Cancel fires during approval wait: no execution results
|
||||
const populated = populateInterruptQueue(runtime, {
|
||||
lastExecutionResults: null,
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId,
|
||||
conversationId,
|
||||
@@ -521,7 +409,6 @@ describe("Path B: cancel during approval wait → next turn consumes synthesized
|
||||
// No batch map entries, but we have the snapshot IDs
|
||||
const populated = populateInterruptQueue(runtime, {
|
||||
lastExecutionResults: null,
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: ["call-a", "call-b"],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
@@ -540,7 +427,6 @@ describe("Path B: cancel during approval wait → next turn consumes synthesized
|
||||
|
||||
const populated = populateInterruptQueue(runtime, {
|
||||
lastExecutionResults: null,
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
@@ -567,7 +453,6 @@ describe("post-cancel next turn: queue consumed exactly once (no error loop)", (
|
||||
reason: "cancelled",
|
||||
},
|
||||
],
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId,
|
||||
conversationId: convId,
|
||||
@@ -591,7 +476,6 @@ describe("post-cancel next turn: queue consumed exactly once (no error loop)", (
|
||||
lastExecutionResults: [
|
||||
{ type: "approval", tool_call_id: "call-1", approve: true },
|
||||
],
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId,
|
||||
conversationId: convId,
|
||||
@@ -612,7 +496,6 @@ describe("idempotency: first cancel populates, second is no-op", () => {
|
||||
lastExecutionResults: [
|
||||
{ type: "approval", tool_call_id: "call-first", approve: true },
|
||||
],
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
@@ -628,7 +511,6 @@ describe("idempotency: first cancel populates, second is no-op", () => {
|
||||
reason: "x",
|
||||
},
|
||||
],
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
@@ -648,7 +530,6 @@ describe("idempotency: first cancel populates, second is no-op", () => {
|
||||
lastExecutionResults: [
|
||||
{ type: "approval", tool_call_id: "call-1", approve: true },
|
||||
],
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
@@ -662,7 +543,6 @@ describe("idempotency: first cancel populates, second is no-op", () => {
|
||||
lastExecutionResults: [
|
||||
{ type: "approval", tool_call_id: "call-2", approve: true },
|
||||
],
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
@@ -684,7 +564,6 @@ describe("epoch guard: stale context discarded on consume", () => {
|
||||
lastExecutionResults: [
|
||||
{ type: "approval", tool_call_id: "call-1", approve: true },
|
||||
],
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
@@ -708,7 +587,6 @@ describe("epoch guard: stale context discarded on consume", () => {
|
||||
lastExecutionResults: [
|
||||
{ type: "approval", tool_call_id: "call-1", approve: true },
|
||||
],
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-old",
|
||||
conversationId: "conv-1",
|
||||
@@ -727,7 +605,6 @@ describe("epoch guard: stale context discarded on consume", () => {
|
||||
lastExecutionResults: [
|
||||
{ type: "approval", tool_call_id: "call-1", approve: true },
|
||||
],
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-old",
|
||||
@@ -746,7 +623,6 @@ describe("stale Path-B IDs: clearing after successful send prevents re-denial",
|
||||
// Also batch map should be cleared by clearPendingApprovalBatchIds
|
||||
const populated = populateInterruptQueue(runtime, {
|
||||
lastExecutionResults: null,
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [], // cleared after send
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
@@ -764,7 +640,6 @@ describe("stale Path-B IDs: clearing after successful send prevents re-denial",
|
||||
|
||||
const populated = populateInterruptQueue(runtime, {
|
||||
lastExecutionResults: null,
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [], // cleared from previous send
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
@@ -841,7 +716,6 @@ describe("consume clears pendingApprovalBatchByToolCallId", () => {
|
||||
lastExecutionResults: [
|
||||
{ type: "approval", tool_call_id: "call-1", approve: true },
|
||||
],
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-1",
|
||||
conversationId: "conv-1",
|
||||
@@ -860,7 +734,6 @@ describe("consume clears pendingApprovalBatchByToolCallId", () => {
|
||||
lastExecutionResults: [
|
||||
{ type: "approval", tool_call_id: "call-1", approve: true },
|
||||
],
|
||||
lastExecutingToolCallIds: [],
|
||||
lastNeedsUserInputToolCallIds: [],
|
||||
agentId: "agent-old",
|
||||
conversationId: "conv-old",
|
||||
|
||||
Reference in New Issue
Block a user