Skip to content

fix(jsonrpc): omit unset fields from JSON-RPC requests #1287

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
oscerd wants to merge 1 commit into from
Closed

fix(jsonrpc): omit unset fields from JSON-RPC requests #1287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions ...onrpc/src/test/java/org/a2aproject/sdk/client/transport/jsonrpc/JSONRPCTransportTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,14 +97,14 @@ public void tearDown() {
public void testListTasksWithDefaultBuilder() throws Exception {
JsonObject params = listTasksAndGetRequestParams(ListTasksParams.builder().build());

assertEquals("", params.get("tenant").getAsString());
assertFalse(params.has("tenant"));
}

@Test
public void testListTasksWithDefaultConstructor() throws Exception {
JsonObject params = listTasksAndGetRequestParams(new ListTasksParams());

assertEquals("", params.get("tenant").getAsString());
assertFalse(params.has("tenant"));
}

@Test
Expand Down
15 changes: 5 additions & 10 deletions ...sport/jsonrpc/src/test/java/org/a2aproject/sdk/client/transport/jsonrpc/JsonMessages.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,7 @@ public class JsonMessages {
"configuration":{
"acceptedOutputModes":[
"text"
],
"returnImmediately":false
]
},
"metadata":{

Expand Down Expand Up @@ -200,8 +199,7 @@ public class JsonMessages {
"configuration":{
"acceptedOutputModes":[
"text"
],
"returnImmediately":false
]
},
"metadata":{

Expand Down Expand Up @@ -384,8 +382,7 @@ public class JsonMessages {
"configuration":{
"acceptedOutputModes":[
"text"
],
"returnImmediately":false
]
},
"metadata":{

Expand Down Expand Up @@ -451,8 +448,7 @@ public class JsonMessages {
"configuration":{
"acceptedOutputModes":[
"text"
],
"returnImmediately":false
]
},
"metadata":{

Expand Down Expand Up @@ -522,8 +518,7 @@ public class JsonMessages {
"configuration":{
"acceptedOutputModes":[
"text"
],
"returnImmediately":false
]
},
"metadata":{

Expand Down
3 changes: 2 additions & 1 deletion spec-grpc/src/main/java/org/a2aproject/sdk/grpc/utils/JSONRPCUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,8 +581,9 @@ public static String toJsonRPCRequest(@Nullable String requestId, String method,
output.name("method").value(method);
}
if (payload != null) {
// Unlike responses, omit unset fields: receivers may treat "taskId": "" as a real value
String resultValue = ProtoJsonUtils.toJson(
JsonFormat.printer().alwaysPrintFieldsWithNoPresence().omittingInsignificantWhitespace(), payload);
JsonFormat.printer().omittingInsignificantWhitespace(), payload);
output.name("params").jsonValue(resultValue);
}
output.endObject();
Expand Down
26 changes: 26 additions & 0 deletions spec-grpc/src/test/java/org/a2aproject/sdk/grpc/utils/JSONRPCUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -762,6 +762,32 @@ public void testToJsonRPCRequest_doesNotHtmlEscapeAngleBrackets() {
"JSON must not contain HTML-escaped '>' (\\u003e) but got: " + json);
}

@Test
public void testToJsonRPCRequest_omitsUnsetFields() throws JsonProcessingException {
// Issue #770: unset taskId, contextId and tenant were sent as empty strings
MessageSendParams params = new MessageSendParams(
Message.builder()
.role(Message.Role.ROLE_USER)
.parts(Collections.singletonList(new TextPart("hello")))
.messageId("message-1234")
.build(),
null, null
);

String json = JSONRPCUtils.toJsonRPCRequest("test-id", SEND_MESSAGE_METHOD,
ProtoUtils.ToProto.sendMessageRequest(params));

JsonObject requestParams = JsonParser.parseString(json).getAsJsonObject().getAsJsonObject("params");
assertFalse(requestParams.has("tenant"), json);
JsonObject message = requestParams.getAsJsonObject("message");
assertFalse(message.has("taskId"), json);
assertFalse(message.has("contextId"), json);
Message parsed = assertInstanceOf(SendMessageRequest.class, JSONRPCUtils.parseRequestBody(json, null))
.getParams().message();
assertNull(parsed.taskId());
assertNull(parsed.contextId());
}

@Test
public void testToJsonRPCResultResponse_doesNotHtmlEscapeAngleBrackets() {
// Reproduce issue #892: server responses must also send literal angle brackets.
Expand Down
Loading