Skip to content

feat(agui): propagate userId from forwardedProps to RuntimeContext #2277

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

Closed
jujn wants to merge 2 commits into from
+79 −0
Closed

feat(agui): propagate userId from forwardedProps to RuntimeContext #2277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61a18aa
feat(agui): propagate userId from forwardedProps to RuntimeContext
ningmeng0503 Jul 7, 2026
5fd7cc3
fix: normalize userId
jujn Jul 18, 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
14 changes: 14 additions & 0 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 @@ -79,6 +79,7 @@ public class AguiAgentAdapter {
public static final String RUNTIME_CONTEXT_CONTEXT_KEY = "agui.context";
public static final String RUNTIME_CONTEXT_STATE_KEY = "agui.state";
public static final String RUNTIME_CONTEXT_FORWARDED_PROPS_KEY = "agui.forwardedProps";
public static final String FORWARDED_PROP_USER_ID_KEY = "userId";

private final Agent agent;
private final AguiAdapterConfig config;
Expand Down Expand Up @@ -162,6 +163,7 @@ public Flux<AguiEvent> run(RunAgentInput input) {
private RuntimeContext buildRuntimeContext(RunAgentInput input) {
return RuntimeContext.builder()
.sessionId(input.getThreadId())
.userId(normalizeUserId(input.getForwardedProp(FORWARDED_PROP_USER_ID_KEY)))

@zouyx zouyx Jul 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这样直接获取是否会存在身份伪造的风险？

@ningmeng0503 ningmeng0503 Jul 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

您说得很有道理，我完全认同RunAgentInput的参数确实需要校验，因为它们直接来自用户。不过我在想，是否可以把校验逻辑放在adapter之外的其他层来处理，这样职责会更清晰一些。

另外关于userId，我也觉得放在后台接口层从header或其他上下文中获取，再手动设置到RunAgentInput中，可能比让前端直接传递更合适，也更安全。

@jujn jujn Jul 20, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ningmeng0503
Can you take charge of this? You can wait until the event mechanism is upgraded to 2.0. I originally wanted to add a submission to your PR, but it can't be edited. You can continue in: #2044

@ningmeng0503 ningmeng0503 Jul 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jujn
I'd be happy to. I'll continue to follow up in #2044.

.put(RunAgentInput.class, input)
.put(RUNTIME_CONTEXT_THREAD_ID_KEY, input.getThreadId())
.put(RUNTIME_CONTEXT_RUN_ID_KEY, input.getRunId())
Expand All @@ -173,6 +175,18 @@ private RuntimeContext buildRuntimeContext(RunAgentInput input) {
.build();
}

private static String normalizeUserId(Object value) {
if (value == null) {
return null;
}
String userId = value.toString();
if (userId == null) {
return null;
Comment on lines +183 to +184

@AgentScopeJavaBot AgentScopeJavaBot Jul 19, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit] Dead code: Object.toString() is guaranteed by the Java Language Specification to never return null, so the if (userId == null) branch is unreachable. You can safely remove lines 183-185 and simplify to:

private static String normalizeUserId(Object value) {
    if (value == null) {
        return null;
    }
    String userId = value.toString().trim();
    return userId.isEmpty() ? null : userId;
}

Comment on lines +183 to +184

@AgentScopeJavaBot AgentScopeJavaBot Jul 19, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit] Dead code: Object.toString() is guaranteed by the Java Language Specification to never return null, so the if (userId == null) branch is unreachable. You can safely remove lines 183-185 and simplify to:

private static String normalizeUserId(Object value) {
    if (value == null) {
        return null;
    }
    String userId = value.toString().trim();
    return userId.isEmpty() ? null : userId;
}

}
userId = userId.trim();
return userId.isEmpty() ? null : userId;
}

private ToolInjection injectFrontendTools(RunAgentInput input) {
if (!input.hasTools()) {
return ToolInjection.empty();
Expand Down
65 changes: 65 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 @@ -70,6 +70,71 @@ void setUp() {
adapter = new AguiAgentAdapter(mockAgent, AguiAdapterConfig.defaultConfig());
}

@Test
void testRunSetsUserIdFromForwardedPropsIntoRuntimeContext() {
ArgumentCaptor<RuntimeContext> contextCaptor =
ArgumentCaptor.forClass(RuntimeContext.class);
when(mockAgent.stream(anyList(), any(StreamOptions.class), contextCaptor.capture()))
.thenReturn(Flux.empty());

RunAgentInput input =
RunAgentInput.builder()
.threadId("thread-user")
.runId("run-user")
.messages(List.of(AguiMessage.userMessage("msg-1", "Hello")))
.forwardedProps(
Map.of(AguiAgentAdapter.FORWARDED_PROP_USER_ID_KEY, "user-123"))
.build();

adapter.run(input).collectList().block();

RuntimeContext context = contextCaptor.getValue();
assertEquals("user-123", context.getUserId());
assertSame(input.getForwardedProps(), context.get("agui.forwardedProps"));
}

@Test
void testRunConvertsNonStringUserIdFromForwardedProps() {
ArgumentCaptor<RuntimeContext> contextCaptor =
ArgumentCaptor.forClass(RuntimeContext.class);
when(mockAgent.stream(anyList(), any(StreamOptions.class), contextCaptor.capture()))
.thenReturn(Flux.empty());

RunAgentInput input =
RunAgentInput.builder()
.threadId("thread-user-long")
.runId("run-user-long")
.messages(List.of(AguiMessage.userMessage("msg-1", "Hello")))
.forwardedProps(Map.of(AguiAgentAdapter.FORWARDED_PROP_USER_ID_KEY, 12345L))
.build();

adapter.run(input).collectList().block();

RuntimeContext context = contextCaptor.getValue();
assertEquals("12345", context.getUserId());
}

@Test

@AgentScopeJavaBot AgentScopeJavaBot Jul 19, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit] The normalizeUserId method has explicit trim + empty-check logic, but no test exercises the blank/whitespace-only userId edge cases (e.g. "" or " "). Consider adding a test like:

@Test
void testRunNormalizesBlankUserIdToNull() {
    // ... setup ...
    RunAgentInput input = RunAgentInput.builder()
        .threadId("t").runId("r")
        .messages(List.of(AguiMessage.userMessage("m", "hi")))
        .forwardedProps(Map.of(AguiAgentAdapter.FORWARDED_PROP_USER_ID_KEY, "  "))
        .build();
    adapter.run(input).collectList().block();
    assertNull(contextCaptor.getValue().getUserId());
}

This would give full branch coverage for the normalization helper.

@AgentScopeJavaBot AgentScopeJavaBot Jul 19, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nit] The normalizeUserId method has explicit trim + empty-check logic, but no test exercises the blank/whitespace-only userId edge cases (e.g. "" or " "). Consider adding a test like:

@Test
void testRunNormalizesBlankUserIdToNull() {
    // ... setup ...
    RunAgentInput input = RunAgentInput.builder()
        .threadId("t").runId("r")
        .messages(List.of(AguiMessage.userMessage("m", "hi")))
        .forwardedProps(Map.of(AguiAgentAdapter.FORWARDED_PROP_USER_ID_KEY, "  "))
        .build();
    adapter.run(input).collectList().block();
    assertNull(contextCaptor.getValue().getUserId());
}

This would give full branch coverage for the normalization helper.

void testRunKeepsUserIdNullWhenForwardedPropsMissingUserId() {
ArgumentCaptor<RuntimeContext> contextCaptor =
ArgumentCaptor.forClass(RuntimeContext.class);
when(mockAgent.stream(anyList(), any(StreamOptions.class), contextCaptor.capture()))
.thenReturn(Flux.empty());

RunAgentInput input =
RunAgentInput.builder()
.threadId("thread-no-user")
.runId("run-no-user")
.messages(List.of(AguiMessage.userMessage("msg-1", "Hello")))
.forwardedProps(Map.of("tenant", "demo"))
.build();

adapter.run(input).collectList().block();

RuntimeContext context = contextCaptor.getValue();
assertNull(context.getUserId());
}

@Test
void testRunInjectsRunInputIntoRuntimeContext() {
ArgumentCaptor<RuntimeContext> contextCaptor =
Expand Down
Loading