Skip to content

fix(agui): Fix duplicate TextMessageEnd emission (#562) #586

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xingmengxian wants to merge 3 commits into
base: main
Choose a base branch
from
+284 −4
Open

fix(agui): Fix duplicate TextMessageEnd emission (#562) #586

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ec149a
fix(agui): Fix duplicate TextMessageEnd emission (#562)
xingmengxian Jan 16, 2026
b135e4a
refactor(agui): clean up imports and streamline content initializatio…
xingmengxian Jan 16, 2026
46695f5
test(agui): Add test to cover hasEndedMessage check in TextMessageEnd
xingmengxian Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions ...scope-extensions-agui/src/main/java/io/agentscope/core/agui/adapter/AguiAgentAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,10 +150,12 @@ private List<AguiEvent> convertEvent(Event event, EventConversionState state) {
state.threadId, state.runId, messageId, text));
} else {
// End message if this is the last event
events.add(
new AguiEvent.TextMessageEnd(
state.threadId, state.runId, messageId));
state.endMessage(messageId);
if (!state.hasEndedMessage(messageId)) {
events.add(
new AguiEvent.TextMessageEnd(
state.threadId, state.runId, messageId));
state.endMessage(messageId);
}
}
}
} else if (block instanceof ToolUseBlock toolUse) {
Expand Down
278 changes: 278 additions & 0 deletions ...e-extensions-agui/src/test/java/io/agentscope/core/agui/adapter/AguiAgentAdapterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,4 +508,282 @@ void testReactiveStreamCompletion() {
.expectNextMatches(e -> e instanceof AguiEvent.RunFinished)
.verifyComplete();
}

@Test
void testTextMessageEndNotDuplicatedWhenLastEventAfterToolCall() {
// Test that when a text message is interrupted by a tool call and then the last event
// contains text blocks with the same message ID, only one TextMessageEnd is emitted
String msgId = "msg-text";
Msg firstMsg =
Msg.builder()
.id(msgId)
.role(MsgRole.ASSISTANT)
.content(List.of(TextBlock.builder().text("first part").build()))
.build();

Msg toolCall1 =
Msg.builder()
.id("msg-tc")
.role(MsgRole.ASSISTANT)
.content(
ToolUseBlock.builder()
.id("tc-1")
.name("tool")
.input(Map.of())
.build())
.build();
Msg lastMsg =
Msg.builder()
.id(msgId)
.role(MsgRole.ASSISTANT)
.content(List.of(TextBlock.builder().text("last part").build()))
.build();

Event firstEvent = new Event(EventType.REASONING, firstMsg, false);
Event toolCallEvent = new Event(EventType.REASONING, toolCall1, false);
Event lastEvent = new Event(EventType.REASONING, lastMsg, true);
when(mockAgent.stream(anyList(), any(StreamOptions.class)))
.thenReturn(Flux.just(firstEvent, toolCallEvent, lastEvent));

RunAgentInput input =
RunAgentInput.builder()
.threadId("thread-1")
.runId("run-1")
.messages(List.of(AguiMessage.userMessage("msg-1", "Test")))
.build();

List<AguiEvent> events = adapter.run(input).collectList().block();

assertNotNull(events);

// Should have exactly one TextMessageEnd for the same message ID
long textEndCount =
events.stream()
.filter(e -> e instanceof AguiEvent.TextMessageEnd)
.filter(
e -> {
AguiEvent.TextMessageEnd end = (AguiEvent.TextMessageEnd) e;
return msgId.equals(end.messageId());
})
.count();
assertEquals(1, textEndCount, "Should have exactly 1 TextMessageEnd per message ID");
}

@Test
void testTextMessageEndWithLastEventDirectly() {
// Test that when the last event contains text blocks and the message hasn't been ended,
// the TextMessageEnd is emitted through the new hasEndedMessage check
// This test specifically covers the new code path at lines 153-158
String msgId = "msg-text";
Msg textMsg =
Msg.builder()
.id(msgId)
.role(MsgRole.ASSISTANT)
.content(List.of(TextBlock.builder().text("Hello world").build()))
.build();

// Create a last event directly (isLast = true) without any prior events
Event lastEvent = new Event(EventType.REASONING, textMsg, true);
when(mockAgent.stream(anyList(), any(StreamOptions.class)))
.thenReturn(Flux.just(lastEvent));

RunAgentInput input =
RunAgentInput.builder()
.threadId("thread-1")
.runId("run-1")
.messages(List.of(AguiMessage.userMessage("msg-1", "Test")))
.build();

List<AguiEvent> events = adapter.run(input).collectList().block();

assertNotNull(events);

// Verify that TextMessageEnd is emitted exactly once
long textEndCount =
events.stream()
.filter(e -> e instanceof AguiEvent.TextMessageEnd)
.filter(
e -> {
AguiEvent.TextMessageEnd end = (AguiEvent.TextMessageEnd) e;
return msgId.equals(end.messageId());
})
.count();
assertEquals(1, textEndCount, "Should have exactly 1 TextMessageEnd");

// Verify the event sequence
assertInstanceOf(AguiEvent.RunStarted.class, events.get(0));
assertInstanceOf(AguiEvent.TextMessageStart.class, events.get(1));
assertInstanceOf(AguiEvent.TextMessageEnd.class, events.get(2));
assertInstanceOf(AguiEvent.RunFinished.class, events.get(3));
}

@Test
void testExtractToolResultTextWithMultipleTextBlocks() {
// Test extractToolResultText with multiple TextBlocks (should add newlines)
Msg toolResultMsg =
Msg.builder()
.id("msg-tr1")
.role(MsgRole.TOOL)
.content(
ToolResultBlock.builder()
.id("tc-1")
.output(
List.of(
TextBlock.builder().text("Line 1").build(),
TextBlock.builder().text("Line 2").build(),
TextBlock.builder().text("Line 3").build()))
.build())
.build();

Event toolResultEvent = new Event(EventType.TOOL_RESULT, toolResultMsg, true);

when(mockAgent.stream(anyList(), any(StreamOptions.class)))
.thenReturn(Flux.just(toolResultEvent));

RunAgentInput input =
RunAgentInput.builder()
.threadId("thread-1")
.runId("run-1")
.messages(List.of(AguiMessage.userMessage("msg-1", "Test")))
.build();

List<AguiEvent> events = adapter.run(input).collectList().block();

assertNotNull(events);

AguiEvent.ToolCallResult toolResult =
events.stream()
.filter(e -> e instanceof AguiEvent.ToolCallResult)
.map(e -> (AguiEvent.ToolCallResult) e)
.findFirst()
.orElse(null);

assertNotNull(toolResult, "Should have ToolCallResult");
// Should contain newlines between text blocks
assertTrue(toolResult.content().contains("\n"), "Should have newlines between text blocks");
assertTrue(toolResult.content().contains("Line 1"), "Should contain Line 1");
assertTrue(toolResult.content().contains("Line 2"), "Should contain Line 2");
assertTrue(toolResult.content().contains("Line 3"), "Should contain Line 3");
}

@Test
void testExtractToolResultTextWithEmptyOutput() {
// Test extractToolResultText with empty output
Msg toolResultMsg =
Msg.builder()
.id("msg-tr1")
.role(MsgRole.TOOL)
.content(ToolResultBlock.builder().id("tc-1").output(List.of()).build())
.build();

Event toolResultEvent = new Event(EventType.TOOL_RESULT, toolResultMsg, true);

when(mockAgent.stream(anyList(), any(StreamOptions.class)))
.thenReturn(Flux.just(toolResultEvent));

RunAgentInput input =
RunAgentInput.builder()
.threadId("thread-1")
.runId("run-1")
.messages(List.of(AguiMessage.userMessage("msg-1", "Test")))
.build();

List<AguiEvent> events = adapter.run(input).collectList().block();

assertNotNull(events);

AguiEvent.ToolCallResult toolResult =
events.stream()
.filter(e -> e instanceof AguiEvent.ToolCallResult)
.map(e -> (AguiEvent.ToolCallResult) e)
.findFirst()
.orElse(null);

assertNotNull(toolResult, "Should have ToolCallResult");
// When output is empty, result should be null
assertTrue(toolResult.content() == null || toolResult.content().isEmpty());
}

@Test
void testToolUseBlockWithNullId() {
// Test that when ToolUseBlock has null ID, a UUID is generated
Msg toolCallMsg =
Msg.builder()
.id("msg-tc1")
.role(MsgRole.ASSISTANT)
.content(
ToolUseBlock.builder()
.id(null) // null ID
.name("test_tool")
.input(Map.of("param", "value"))
.build())
.build();

Event toolCallEvent = new Event(EventType.REASONING, toolCallMsg, false);
when(mockAgent.stream(anyList(), any(StreamOptions.class)))
.thenReturn(Flux.just(toolCallEvent));

RunAgentInput input =
RunAgentInput.builder()
.threadId("thread-1")
.runId("run-1")
.messages(List.of(AguiMessage.userMessage("msg-1", "Test")))
.build();

List<AguiEvent> events = adapter.run(input).collectList().block();

assertNotNull(events);

AguiEvent.ToolCallStart toolStart =
events.stream()
.filter(e -> e instanceof AguiEvent.ToolCallStart)
.map(e -> (AguiEvent.ToolCallStart) e)
.findFirst()
.orElse(null);

assertNotNull(toolStart, "Should have ToolCallStart");
// Should have generated a UUID (non-null, non-empty string)
assertNotNull(toolStart.toolCallId(), "Tool call ID should not be null");
assertTrue(!toolStart.toolCallId().isEmpty(), "Tool call ID should not be empty");
}

@Test
void testToolUseBlockWithNullOrEmptyContent() {
// Test that when ToolUseBlock has null or empty content, ToolCallArgs is not emitted
Msg toolCallMsg =
Msg.builder()
.id("msg-tc1")
.role(MsgRole.ASSISTANT)
.content(
ToolUseBlock.builder()
.id("tc-1")
.name("test_tool")
.input(Map.of("param", "value"))
.content(null) // null content
.build())
.build();

Event toolCallEvent = new Event(EventType.REASONING, toolCallMsg, false);
when(mockAgent.stream(anyList(), any(StreamOptions.class)))
.thenReturn(Flux.just(toolCallEvent));

RunAgentInput input =
RunAgentInput.builder()
.threadId("thread-1")
.runId("run-1")
.messages(List.of(AguiMessage.userMessage("msg-1", "Test")))
.build();

List<AguiEvent> events = adapter.run(input).collectList().block();

assertNotNull(events);

// Should still have ToolCallStart
boolean hasToolStart = events.stream().anyMatch(e -> e instanceof AguiEvent.ToolCallStart);
assertTrue(hasToolStart, "Should have ToolCallStart");

// Should NOT have ToolCallArgs when content is null
boolean hasToolArgs = events.stream().anyMatch(e -> e instanceof AguiEvent.ToolCallArgs);
assertTrue(!hasToolArgs, "Should NOT have ToolCallArgs when content is null");
}
}
Loading