diff --git a/client/transport/rest/src/main/java/org/a2aproject/sdk/client/transport/rest/RestTransport.java b/client/transport/rest/src/main/java/org/a2aproject/sdk/client/transport/rest/RestTransport.java index d51549c70..9e9a97a76 100644 --- a/client/transport/rest/src/main/java/org/a2aproject/sdk/client/transport/rest/RestTransport.java +++ b/client/transport/rest/src/main/java/org/a2aproject/sdk/client/transport/rest/RestTransport.java @@ -100,7 +100,7 @@ public EventKind sendMessage(MessageSendParams messageSendParams, @Nullable Clie try { String httpResponseBody = sendPostRequest(Utils.buildBaseUrl(agentInterface, messageSendParams.tenant()) + "/message:send", payloadAndHeaders); org.a2aproject.sdk.grpc.SendMessageResponse.Builder responseBuilder = org.a2aproject.sdk.grpc.SendMessageResponse.newBuilder(); - JsonFormat.parser().merge(httpResponseBody, responseBuilder); + ProtoJsonUtils.mergeIgnoringUnknownFields(httpResponseBody, responseBuilder); if (responseBuilder.hasMessage()) { return ProtoUtils.FromProto.message(responseBuilder.getMessage()); } @@ -166,7 +166,7 @@ public Task getTask(TaskQueryParams taskQueryParams, @Nullable ClientCallContext } String httpResponseBody = response.body(); org.a2aproject.sdk.grpc.Task.Builder responseBuilder = org.a2aproject.sdk.grpc.Task.newBuilder(); - JsonFormat.parser().merge(httpResponseBody, responseBuilder); + ProtoJsonUtils.mergeIgnoringUnknownFields(httpResponseBody, responseBuilder); return ProtoUtils.FromProto.task(responseBuilder); } catch (A2AClientException e) { throw e; @@ -183,7 +183,7 @@ public Task cancelTask(CancelTaskParams taskIdParams, @Nullable ClientCallContex try { String httpResponseBody = sendPostRequest(Utils.buildBaseUrl(agentInterface, taskIdParams.tenant()) + String.format("/tasks/%1s:cancel", taskIdParams.id()), payloadAndHeaders); org.a2aproject.sdk.grpc.Task.Builder responseBuilder = org.a2aproject.sdk.grpc.Task.newBuilder(); - JsonFormat.parser().merge(httpResponseBody, responseBuilder); + ProtoJsonUtils.mergeIgnoringUnknownFields(httpResponseBody, responseBuilder); return ProtoUtils.FromProto.task(responseBuilder); } catch (A2AClientException e) { throw e; @@ -243,7 +243,7 @@ public ListTasksResult listTasks(ListTasksParams request, @Nullable ClientCallCo } String httpResponseBody = response.body(); org.a2aproject.sdk.grpc.ListTasksResponse.Builder responseBuilder = org.a2aproject.sdk.grpc.ListTasksResponse.newBuilder(); - JsonFormat.parser().merge(httpResponseBody, responseBuilder); + ProtoJsonUtils.mergeIgnoringUnknownFields(httpResponseBody, responseBuilder); return new ListTasksResult( responseBuilder.getTasksList().stream() @@ -306,7 +306,7 @@ public TaskPushNotificationConfig createTaskPushNotificationConfiguration(TaskPu try { String httpResponseBody = sendPostRequest(Utils.buildBaseUrl(agentInterface, request.tenant()) + String.format("/tasks/%1s/pushNotificationConfigs", request.taskId()), payloadAndHeaders); org.a2aproject.sdk.grpc.TaskPushNotificationConfig.Builder responseBuilder = org.a2aproject.sdk.grpc.TaskPushNotificationConfig.newBuilder(); - JsonFormat.parser().merge(httpResponseBody, responseBuilder); + ProtoJsonUtils.mergeIgnoringUnknownFields(httpResponseBody, responseBuilder); return ProtoUtils.FromProto.taskPushNotificationConfig(responseBuilder); } catch (A2AClientException e) { throw e; @@ -341,7 +341,7 @@ public TaskPushNotificationConfig getTaskPushNotificationConfiguration(GetTaskPu } String httpResponseBody = response.body(); org.a2aproject.sdk.grpc.TaskPushNotificationConfig.Builder responseBuilder = org.a2aproject.sdk.grpc.TaskPushNotificationConfig.newBuilder(); - JsonFormat.parser().merge(httpResponseBody, responseBuilder); + ProtoJsonUtils.mergeIgnoringUnknownFields(httpResponseBody, responseBuilder); return ProtoUtils.FromProto.taskPushNotificationConfig(responseBuilder); } catch (A2AClientException e) { throw e; @@ -379,7 +379,7 @@ public ListTaskPushNotificationConfigsResult listTaskPushNotificationConfigurati } String httpResponseBody = response.body(); org.a2aproject.sdk.grpc.ListTaskPushNotificationConfigsResponse.Builder responseBuilder = org.a2aproject.sdk.grpc.ListTaskPushNotificationConfigsResponse.newBuilder(); - JsonFormat.parser().merge(httpResponseBody, responseBuilder); + ProtoJsonUtils.mergeIgnoringUnknownFields(httpResponseBody, responseBuilder); return ProtoUtils.FromProto.listTaskPushNotificationConfigsResult(responseBuilder); } catch (A2AClientException e) { throw e; diff --git a/client/transport/rest/src/main/java/org/a2aproject/sdk/client/transport/rest/sse/SSEEventListener.java b/client/transport/rest/src/main/java/org/a2aproject/sdk/client/transport/rest/sse/SSEEventListener.java index 0efe85f62..6e3a42dd6 100644 --- a/client/transport/rest/src/main/java/org/a2aproject/sdk/client/transport/rest/sse/SSEEventListener.java +++ b/client/transport/rest/src/main/java/org/a2aproject/sdk/client/transport/rest/sse/SSEEventListener.java @@ -4,12 +4,15 @@ import java.util.function.Consumer; import java.util.logging.Logger; +import com.google.gson.JsonElement; +import com.google.gson.JsonParseException; +import com.google.gson.JsonParser; import com.google.protobuf.InvalidProtocolBufferException; -import com.google.protobuf.util.JsonFormat; import org.a2aproject.sdk.client.http.ServerSentEvent; import org.a2aproject.sdk.client.transport.spi.sse.AbstractSSEEventListener; import org.a2aproject.sdk.client.transport.rest.RestErrorMapper; import org.a2aproject.sdk.grpc.StreamResponse; +import org.a2aproject.sdk.grpc.utils.ProtoJsonUtils; import org.a2aproject.sdk.grpc.utils.ProtoUtils; import org.a2aproject.sdk.spec.StreamingEventKind; import org.jspecify.annotations.Nullable; @@ -37,13 +40,27 @@ public void onMessage(ServerSentEvent event, @Nullable Future completableF try { LOGGER.fine("REST SSE raw data: " + event.data()); org.a2aproject.sdk.grpc.StreamResponse.Builder builder = org.a2aproject.sdk.grpc.StreamResponse.newBuilder(); - JsonFormat.parser().merge(event.data(), builder); + ProtoJsonUtils.mergeIgnoringUnknownFields(event.data(), builder); + if (builder.getPayloadCase() == StreamResponse.PayloadCase.PAYLOAD_NOT_SET && isErrorEvent(event.data())) { + // Unknown fields are ignored, so an error event parses to an empty response. + signalTerminal(RestErrorMapper.mapRestError(event.data(), 500)); + return; + } parseAndHandleMessage(builder.build(), completableFuture); } catch (InvalidProtocolBufferException e) { signalTerminal(RestErrorMapper.mapRestError(event.data(), 500)); } } + private static boolean isErrorEvent(String data) { + try { + JsonElement json = JsonParser.parseString(data); + return json.isJsonObject() && json.getAsJsonObject().has("error"); + } catch (JsonParseException e) { + return false; + } + } + /** * Parses a StreamResponse protobuf message and delegates to the base class for event handling. * diff --git a/client/transport/rest/src/test/java/org/a2aproject/sdk/client/transport/rest/RestTransportTest.java b/client/transport/rest/src/test/java/org/a2aproject/sdk/client/transport/rest/RestTransportTest.java index 74311ee9b..6172b1146 100644 --- a/client/transport/rest/src/test/java/org/a2aproject/sdk/client/transport/rest/RestTransportTest.java +++ b/client/transport/rest/src/test/java/org/a2aproject/sdk/client/transport/rest/RestTransportTest.java @@ -19,6 +19,7 @@ import static org.junit.jupiter.api.Assertions.assertInstanceOf; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.mockserver.model.HttpRequest.request; import static org.mockserver.model.HttpResponse.response; @@ -174,6 +175,79 @@ public void testSendMessage() throws Exception { assertNull(history.referenceTaskIds()); } + @Test + public void testSendMessageIgnoresUnknownResponseFields() throws Exception { + Message message = Message.builder() + .role(Message.Role.ROLE_USER) + .parts(Collections.singletonList(new TextPart("tell me a joke"))) + .contextId("context-1234") + .messageId("message-1234") + .build(); + this.server.when( + request() + .withMethod("POST") + .withPath("/message:send") + ) + .respond( + response() + .withStatusCode(200) + .withBody(""" + { + "task": { + "id": "task-1234", + "contextId": "context-1234", + "status": { + "state": "TASK_STATE_SUBMITTED" + }, + "unknownTaskField": "ignored" + }, + "unknownResponseField": 42 + }""") + ); + MessageSendParams messageSendParams = new MessageSendParams(message, null, null, ""); + + RestTransport instance = new RestTransport(CARD); + Task task = (Task) instance.sendMessage(messageSendParams, null); + assertEquals("task-1234", task.id()); + assertEquals(TaskState.TASK_STATE_SUBMITTED, task.status().state()); + } + + @Test + public void testSendMessageRejectsUnrecognizedEnumValueInResponse() throws Exception { + Message message = Message.builder() + .role(Message.Role.ROLE_USER) + .parts(Collections.singletonList(new TextPart("tell me a joke"))) + .contextId("context-1234") + .messageId("message-1234") + .build(); + this.server.when( + request() + .withMethod("POST") + .withPath("/message:send") + ) + .respond( + response() + .withStatusCode(200) + .withBody(""" + { + "task": { + "id": "task-1234", + "contextId": "context-1234", + "status": { + "state": "NOT_A_TASK_STATE" + }, + "unknownTaskField": "ignored" + } + }""") + ); + MessageSendParams messageSendParams = new MessageSendParams(message, null, null, ""); + + RestTransport instance = new RestTransport(CARD); + A2AClientException exception = assertThrows(A2AClientException.class, + () -> instance.sendMessage(messageSendParams, null)); + assertTrue(exception.getMessage().contains("NOT_A_TASK_STATE"), exception.getMessage()); + } + /** * Test of cancelTask method, of class JSONRestTransport. */ diff --git a/client/transport/rest/src/test/java/org/a2aproject/sdk/client/transport/rest/sse/SSEEventListenerTest.java b/client/transport/rest/src/test/java/org/a2aproject/sdk/client/transport/rest/sse/SSEEventListenerTest.java index e703c3969..22a83b5ec 100644 --- a/client/transport/rest/src/test/java/org/a2aproject/sdk/client/transport/rest/sse/SSEEventListenerTest.java +++ b/client/transport/rest/src/test/java/org/a2aproject/sdk/client/transport/rest/sse/SSEEventListenerTest.java @@ -1,6 +1,7 @@ package org.a2aproject.sdk.client.transport.rest.sse; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertSame; @@ -13,9 +14,11 @@ import java.util.concurrent.atomic.AtomicReference; import org.a2aproject.sdk.client.http.ServerSentEvent; +import org.a2aproject.sdk.spec.A2AClientException; import org.a2aproject.sdk.spec.Message; import org.a2aproject.sdk.spec.StreamingEventKind; import org.a2aproject.sdk.spec.Task; +import org.a2aproject.sdk.spec.TaskNotFoundError; import org.a2aproject.sdk.spec.TaskState; import org.a2aproject.sdk.spec.TaskStatusUpdateEvent; import org.a2aproject.sdk.spec.TextPart; @@ -98,6 +101,36 @@ public void testOnMessageWithTaskResult() { assertEquals(TaskState.TASK_STATE_WORKING, task.status().state()); } + @Test + public void testOnMessageIgnoresUnknownFields() { + AtomicReference receivedEvent = new AtomicReference<>(); + AtomicReference receivedError = new AtomicReference<>(); + SSEEventListener listener = new SSEEventListener(receivedEvent::set, receivedError::set); + + String jsonMessage = """ + { + "task": { + "id": "task-123", + "contextId": "context-456", + "status": { + "state": "TASK_STATE_WORKING", + "unknownStatusField": true + }, + "unknownTaskField": "ignored" + }, + "unknownResponseField": 42 + } + """; + + listener.onMessage(new ServerSentEvent(jsonMessage), null); + + assertNull(receivedError.get()); + Task task = (Task) receivedEvent.get(); + assertNotNull(task); + assertEquals("task-123", task.id()); + assertEquals(TaskState.TASK_STATE_WORKING, task.status().state()); + } + @Test public void testOnMessageWithMessageResult() { // Set up event handler @@ -275,6 +308,48 @@ public void testOnMessageWithInvalidJsonThenOnCompleteKeepsTheError() { assertSame(firstError, receivedError.get()); } + @Test + public void testOnMessageWithErrorEventMapsTheError() { + AtomicReference receivedError = new AtomicReference<>(); + SSEEventListener listener = new SSEEventListener(event -> {}, receivedError::set); + + String errorEvent = """ + {"error": {"code": 404, "status": "NOT_FOUND", "message": "Task not found", + "details": [{"reason": "TASK_NOT_FOUND"}]}} + """; + + listener.onMessage(new ServerSentEvent(errorEvent), null); + + A2AClientException error = assertInstanceOf(A2AClientException.class, receivedError.get()); + assertInstanceOf(TaskNotFoundError.class, error.getCause()); + } + + @Test + public void testOnMessageWithUnrecognizedEnumValueSignalsError() { + AtomicReference receivedEvent = new AtomicReference<>(); + AtomicReference receivedError = new AtomicReference<>(); + SSEEventListener listener = new SSEEventListener(receivedEvent::set, receivedError::set); + + // Unknown field names are ignored, but an unrecognized enum value is not dropped. + String jsonMessage = """ + { + "task": { + "id": "task-123", + "contextId": "context-456", + "status": { + "state": "NOT_A_TASK_STATE" + }, + "unknownTaskField": "ignored" + } + } + """; + + listener.onMessage(new ServerSentEvent(jsonMessage), null); + + assertNull(receivedEvent.get()); + assertNotNull(receivedError.get()); + } + @Test public void testOnMessageWithInvalidPayloadCaseThenOnCompleteKeepsTheError() { // Set up error handler diff --git a/spec-grpc/src/main/java/org/a2aproject/sdk/grpc/utils/JSONRPCUtils.java b/spec-grpc/src/main/java/org/a2aproject/sdk/grpc/utils/JSONRPCUtils.java index e42535c90..554aac588 100644 --- a/spec-grpc/src/main/java/org/a2aproject/sdk/grpc/utils/JSONRPCUtils.java +++ b/spec-grpc/src/main/java/org/a2aproject/sdk/grpc/utils/JSONRPCUtils.java @@ -263,7 +263,7 @@ private static A2ARequest parseMethodRequest(String version, Object id, Strin } case SEND_MESSAGE_METHOD -> { org.a2aproject.sdk.grpc.SendMessageRequest.Builder builder = org.a2aproject.sdk.grpc.SendMessageRequest.newBuilder(); - parseSendMessageParams(params, builder, id); + parseRequestBody(params, builder, id); setTenantIfAbsent(builder::getTenant, builder::setTenant, tenant); return new SendMessageRequest(version, id, ProtoUtils.FromProto.messageSendParams(builder)); } @@ -293,7 +293,7 @@ private static A2ARequest parseMethodRequest(String version, Object id, Strin } case SEND_STREAMING_MESSAGE_METHOD -> { org.a2aproject.sdk.grpc.SendMessageRequest.Builder builder = org.a2aproject.sdk.grpc.SendMessageRequest.newBuilder(); - parseSendMessageParams(params, builder, id); + parseRequestBody(params, builder, id); setTenantIfAbsent(builder::getTenant, builder::setTenant, tenant); return new SendStreamingMessageRequest(version, id, ProtoUtils.FromProto.messageSendParams(builder)); } @@ -465,14 +465,9 @@ private static A2AError processError(JsonObject error) { } protected static void parseRequestBody(JsonElement jsonRpc, com.google.protobuf.Message.Builder builder, Object id) throws JsonProcessingException { - parseJsonString(jsonRpc.toString(), builder, id); - } - - // SendMessage permits extra top-level operation parameters; nested protocol objects remain strict. - private static void parseSendMessageParams(JsonElement jsonRpc, com.google.protobuf.Message.Builder builder, Object id) - throws JsonProcessingException { - JsonElement params = ProtoJsonUtils.retainKnownFields(jsonRpc, builder.getDescriptorForType()); - parseJsonString(params.toString(), builder, id); + // Spec Section 5.7: ignore unrecognized field names for forward compatibility. The values + // of recognized fields, such as enum values, are still checked by the strict parser. + parseJsonString(ProtoJsonUtils.removeUnknownFields(jsonRpc, builder.getDescriptorForType()).toString(), builder, id); } public static void parseJsonString(String body, com.google.protobuf.Message.Builder builder, Object id) throws JsonProcessingException { diff --git a/spec-grpc/src/main/java/org/a2aproject/sdk/grpc/utils/ProtoJsonUtils.java b/spec-grpc/src/main/java/org/a2aproject/sdk/grpc/utils/ProtoJsonUtils.java index 95f009893..d9b4f6050 100644 --- a/spec-grpc/src/main/java/org/a2aproject/sdk/grpc/utils/ProtoJsonUtils.java +++ b/spec-grpc/src/main/java/org/a2aproject/sdk/grpc/utils/ProtoJsonUtils.java @@ -1,11 +1,19 @@ package org.a2aproject.sdk.grpc.utils; +import java.util.HashMap; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; + import com.google.gson.JsonArray; import com.google.gson.JsonElement; import com.google.gson.JsonObject; +import com.google.gson.JsonParseException; import com.google.gson.JsonParser; import com.google.protobuf.Descriptors.Descriptor; +import com.google.protobuf.Descriptors.FieldDescriptor; import com.google.protobuf.InvalidProtocolBufferException; +import com.google.protobuf.Message; import com.google.protobuf.MessageOrBuilder; import com.google.protobuf.util.JsonFormat; import org.a2aproject.sdk.util.Assert; @@ -13,26 +21,42 @@ import org.jspecify.annotations.Nullable; /** - * Protobuf-to-JSON serialization without HTML escaping. + * Protobuf JSON helpers. *

* {@link JsonFormat#printer()} delegates to Gson's {@link com.google.gson.stream.JsonWriter} - * which HTML-escapes {@code <}, {@code >}, and {@code &} by default. This utility - * removes those escape sequences via {@link HtmlEscapeUtils#removeHtmlEscaping(String)}. + * which HTML-escapes {@code <}, {@code >}, and {@code &} by default. {@link #toJson} removes + * those escape sequences via {@link HtmlEscapeUtils#removeHtmlEscaping(String)}. + *

+ * {@link #mergeIgnoringUnknownFields} parses JSON while ignoring unrecognized field names, + * as A2A Section 5.7 asks, without accepting unrecognized values for recognized fields. */ public final class ProtoJsonUtils { - private ProtoJsonUtils() { - } + /** + * Well-known types with a special JSON mapping. Their JSON is not an object of their + * declared fields, so it is passed to the parser unchanged. + */ + private static final Set SPECIAL_JSON_TYPES = Set.of( + "google.protobuf.Any", + "google.protobuf.Struct", + "google.protobuf.Value", + "google.protobuf.ListValue", + "google.protobuf.Timestamp", + "google.protobuf.Duration", + "google.protobuf.FieldMask", + "google.protobuf.DoubleValue", + "google.protobuf.FloatValue", + "google.protobuf.Int64Value", + "google.protobuf.UInt64Value", + "google.protobuf.Int32Value", + "google.protobuf.UInt32Value", + "google.protobuf.BoolValue", + "google.protobuf.StringValue", + "google.protobuf.BytesValue"); - /** Removes unknown top-level fields while preserving nested objects for strict parsing. */ - public static JsonElement retainKnownFields(JsonElement json, Descriptor descriptor) { - if (!json.isJsonObject()) { - return json; - } - JsonObject result = json.getAsJsonObject().deepCopy(); - result.keySet().removeIf(name -> descriptor.findFieldByName(name) == null - && descriptor.getFields().stream().noneMatch(field -> field.getJsonName().equals(name))); - return result; + private static final Map> FIELDS_BY_JSON_KEY = new ConcurrentHashMap<>(); + + private ProtoJsonUtils() { } /** @@ -94,4 +118,99 @@ public static String omitEmptyMessageTaskId(String json) { } return json; } + + /** + * Merges JSON into a builder, ignoring object keys that name no field of the target message. + *

+ * Unlike {@link JsonFormat.Parser#ignoringUnknownFields()}, this keeps the strict parser's + * checks on the values of recognized fields: an unrecognized enum value is still rejected + * instead of being dropped. Unknown keys are removed at every level of nesting, using the + * descriptors of the target message. Well-known types with a special JSON mapping, such as + * {@code google.protobuf.Struct}, are passed through unchanged, since their JSON is not an + * object of their declared fields. + * + * @param json the JSON to parse + * @param builder the builder to merge into + * @throws InvalidProtocolBufferException if the JSON is malformed or a recognized field has an invalid value + */ + public static void mergeIgnoringUnknownFields(String json, Message.Builder builder) throws InvalidProtocolBufferException { + Assert.checkNotNullParam("json", json); + Assert.checkNotNullParam("builder", builder); + JsonElement element; + try { + element = JsonParser.parseString(json); + } catch (JsonParseException e) { + // Let the protobuf parser report malformed JSON the way it always has. + JsonFormat.parser().merge(json, builder); + return; + } + JsonFormat.parser().merge(removeUnknownFields(element, builder.getDescriptorForType()).toString(), builder); + } + + /** + * Returns a copy of {@code json} without the object keys that name no field of + * {@code descriptor}, recursively. The input is not modified. A value that does not have + * the shape the field expects is kept as it is, so that the protobuf parser reports it. + * + * @param json the JSON value for a message of type {@code descriptor} + * @param descriptor the message type + * @return the JSON without unknown keys + */ + public static JsonElement removeUnknownFields(JsonElement json, Descriptor descriptor) { + Assert.checkNotNullParam("json", json); + Assert.checkNotNullParam("descriptor", descriptor); + if (!json.isJsonObject() || SPECIAL_JSON_TYPES.contains(descriptor.getFullName())) { + return json; + } + Map fields = fieldsByJsonKey(descriptor); + JsonObject result = new JsonObject(); + for (Map.Entry entry : json.getAsJsonObject().entrySet()) { + FieldDescriptor field = fields.get(entry.getKey()); + if (field != null) { + result.add(entry.getKey(), removeUnknownFieldsFromValue(entry.getValue(), field)); + } + } + return result; + } + + private static JsonElement removeUnknownFieldsFromValue(JsonElement value, FieldDescriptor field) { + if (field.getJavaType() != FieldDescriptor.JavaType.MESSAGE) { + return value; + } + if (field.isMapField()) { + FieldDescriptor valueField = field.getMessageType().findFieldByName("value"); + if (!value.isJsonObject() || valueField == null + || valueField.getJavaType() != FieldDescriptor.JavaType.MESSAGE) { + return value; + } + JsonObject result = new JsonObject(); + for (Map.Entry entry : value.getAsJsonObject().entrySet()) { + result.add(entry.getKey(), removeUnknownFields(entry.getValue(), valueField.getMessageType())); + } + return result; + } + if (field.isRepeated()) { + if (!value.isJsonArray()) { + return value; + } + JsonArray result = new JsonArray(); + for (JsonElement element : value.getAsJsonArray()) { + result.add(removeUnknownFields(element, field.getMessageType())); + } + return result; + } + return removeUnknownFields(value, field.getMessageType()); + } + + private static Map fieldsByJsonKey(Descriptor descriptor) { + return FIELDS_BY_JSON_KEY.computeIfAbsent(descriptor, d -> { + // JsonFormat accepts both the JSON name and the original proto name of a field. + Map fields = new HashMap<>(); + for (FieldDescriptor field : d.getFields()) { + fields.put(field.getJsonName(), field); + fields.put(field.getName(), field); + } + return fields; + }); + } } diff --git a/spec-grpc/src/test/java/org/a2aproject/sdk/grpc/utils/JSONRPCUtilsTest.java b/spec-grpc/src/test/java/org/a2aproject/sdk/grpc/utils/JSONRPCUtilsTest.java index 530d4412c..6e04753af 100644 --- a/spec-grpc/src/test/java/org/a2aproject/sdk/grpc/utils/JSONRPCUtilsTest.java +++ b/spec-grpc/src/test/java/org/a2aproject/sdk/grpc/utils/JSONRPCUtilsTest.java @@ -42,6 +42,7 @@ import org.a2aproject.sdk.jsonrpc.common.wrappers.GetExtendedAgentCardRequest; import org.a2aproject.sdk.jsonrpc.common.wrappers.GetTaskPushNotificationConfigRequest; import org.a2aproject.sdk.jsonrpc.common.wrappers.GetTaskPushNotificationConfigResponse; +import org.a2aproject.sdk.jsonrpc.common.wrappers.GetTaskRequest; import org.a2aproject.sdk.jsonrpc.common.wrappers.GetTaskResponse; import org.a2aproject.sdk.jsonrpc.common.wrappers.ListTasksRequest; import org.a2aproject.sdk.jsonrpc.common.wrappers.ListTasksResponse; @@ -409,7 +410,7 @@ public void testParseInvalidProtoStructure_ThrowsInvalidParamsJsonMappingExcepti "method": "CreateTaskPushNotificationConfig", "id": "4", "params": { - "invalid_field": "value" + "authentication": "not-an-object" } } """; @@ -419,7 +420,7 @@ public void testParseInvalidProtoStructure_ThrowsInvalidParamsJsonMappingExcepti () -> JSONRPCUtils.parseRequestBody(invalidStructure, null) ); assertEquals("4", exception.getId()); - assertEquals(ERROR_MESSAGE.formatted("invalid_field in message lf.a2a.v1.TaskPushNotificationConfig"), exception.getMessage()); + assertEquals(ERROR_MESSAGE.formatted("message object"), exception.getMessage()); } @Test @@ -488,8 +489,8 @@ public void testParseMissingField_ThrowsInvalidParamsError() throws JsonMappingE } @Test - public void testParseUnknownField_ThrowsJsonMappingException() throws JsonMappingException { - String unknownFieldMessage= """ + public void testParseUnknownFields_AreIgnored() throws JsonProcessingException { + String unknownFieldMessage = """ { "jsonrpc":"2.0", "method":"SendMessage", @@ -506,16 +507,42 @@ public void testParseUnknownField_ThrowsJsonMappingException() throws JsonMappin } ], "metadata":{ - + } - } + }, + "unknownParam": 42 } }"""; - JsonMappingException exception = assertThrows( - JsonMappingException.class, - () -> JSONRPCUtils.parseRequestBody(unknownFieldMessage, null) - ); - assertEquals(ERROR_MESSAGE.formatted("unknown in message lf.a2a.v1.Message"), exception.getMessage()); + SendMessageRequest request = assertInstanceOf(SendMessageRequest.class, + JSONRPCUtils.parseRequestBody(unknownFieldMessage, null)); + assertEquals("18", request.getId()); + assertEquals("message-1234", request.getParams().message().messageId()); + assertEquals(Message.Role.ROLE_AGENT, request.getParams().message().role()); + } + + @Test + public void testParseResponseUnknownFields_AreIgnored() throws JsonProcessingException { + String json = """ + { + "jsonrpc": "2.0", + "id": "1", + "result": { + "id": "task-1", + "contextId": "context-1", + "status": { + "state": "TASK_STATE_COMPLETED", + "unknownStatusField": true + }, + "unknownTaskField": {"nested": "value"} + } + } + """; + GetTaskResponse response = assertInstanceOf(GetTaskResponse.class, + JSONRPCUtils.parseResponseBody(json, GET_TASK_METHOD)); + Task task = response.getResult(); + assertNotNull(task); + assertEquals("task-1", task.id()); + assertEquals("context-1", task.contextId()); } @Test @@ -544,7 +571,7 @@ public void testStreamingMessageAcceptsExtraRequestParameter() throws Exception } @Test - public void testSendMessageStillRequiresMessageAndRejectsNestedExtras() { + public void testSendMessageStillRequiresMessageAndIgnoresNestedExtras() throws Exception { for (String method : List.of("SendMessage", "SendStreamingMessage")) { String missing = "{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"" + method + "\",\"params\":{\"extra\":true}}"; @@ -552,17 +579,23 @@ public void testSendMessageStillRequiresMessageAndRejectsNestedExtras() { String nested = "{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"" + method + "\",\"params\":{\"message\":{\"role\":\"ROLE_USER\",\"messageId\":\"m\"," + "\"parts\":[{\"text\":\"hello\"}],\"extra\":true}}}"; - assertThrows(JsonProcessingException.class, () -> JSONRPCUtils.parseRequestBody(nested, null)); + A2ARequest request = JSONRPCUtils.parseRequestBody(nested, null); + MessageSendParams params = request instanceof SendMessageRequest send + ? send.getParams() + : assertInstanceOf(SendStreamingMessageRequest.class, request).getParams(); + assertEquals("m", params.message().messageId()); } } @Test - void rejectsExtraParametersForOtherMethods() { + void ignoresExtraParametersForOtherMethods() throws Exception { String json = """ {"jsonrpc":"2.0","id":1,"method":"GetTask", "params":{"id":"task-1","histroyLength":2}} """; - assertThrows(JsonMappingException.class, () -> JSONRPCUtils.parseRequestBody(json, null)); + GetTaskRequest request = assertInstanceOf(GetTaskRequest.class, JSONRPCUtils.parseRequestBody(json, null)); + assertEquals("task-1", request.getParams().id()); + assertNull(request.getParams().historyLength()); } @Test @@ -577,6 +610,91 @@ void streamingMessageWithoutTaskIdOmitsItFromJsonRpcResult() { assertEquals("context", resultMessage.get("contextId").getAsString()); } + @Test + public void testParseListTasks_UnknownFieldIgnoredAndStatusKept() throws JsonProcessingException { + String request = """ + { + "jsonrpc": "2.0", + "method": "ListTasks", + "id": "20", + "params": { + "status": "TASK_STATE_WORKING", + "unknownParam": 42 + } + } + """; + ListTasksRequest parsed = assertInstanceOf(ListTasksRequest.class, + JSONRPCUtils.parseRequestBody(request, null)); + assertEquals(TaskState.TASK_STATE_WORKING, parsed.getParams().status()); + } + + @Test + public void testParseListTasks_UnrecognizedStatusValue_ThrowsInvalidParams() { + // Unknown field names are ignored, but an unrecognized value for a known enum field is + // still rejected. Dropping it would turn the status filter into no filter at all. + String request = """ + { + "jsonrpc": "2.0", + "method": "ListTasks", + "id": "21", + "params": { + "status": "NOT_A_TASK_STATE" + } + } + """; + InvalidParamsJsonMappingException exception = assertThrows( + InvalidParamsJsonMappingException.class, + () -> JSONRPCUtils.parseRequestBody(request, null) + ); + assertEquals("21", exception.getId()); + } + + @Test + public void testParseResponse_UnrecognizedEnumValue_Throws() { + String json = """ + { + "jsonrpc": "2.0", + "id": "1", + "result": { + "id": "task-1", + "contextId": "context-1", + "status": { + "state": "NOT_A_TASK_STATE" + }, + "unknownTaskField": true + } + } + """; + assertThrows( + JsonProcessingException.class, + () -> JSONRPCUtils.parseResponseBody(json, GET_TASK_METHOD) + ); + } + + @Test + public void testParseResponseEvent_UnrecognizedEnumValue_Throws() { + String json = """ + { + "jsonrpc": "2.0", + "id": "1", + "result": { + "statusUpdate": { + "taskId": "task-1", + "contextId": "context-1", + "status": { + "state": "NOT_A_TASK_STATE" + }, + "unknownEventField": true + } + } + } + """; + assertThrows( + JsonProcessingException.class, + () -> JSONRPCUtils.parseResponseEvent(json) + ); + } + @Test public void testParseInvalidTypeWithNullId_UsesEmptyStringSentinel() throws Exception { // Test the low-level convertProtoBufExceptionToJsonProcessingException with null ID diff --git a/spec-grpc/src/test/java/org/a2aproject/sdk/grpc/utils/ProtoJsonUtilsTest.java b/spec-grpc/src/test/java/org/a2aproject/sdk/grpc/utils/ProtoJsonUtilsTest.java index f5d944c97..eb9337c10 100644 --- a/spec-grpc/src/test/java/org/a2aproject/sdk/grpc/utils/ProtoJsonUtilsTest.java +++ b/spec-grpc/src/test/java/org/a2aproject/sdk/grpc/utils/ProtoJsonUtilsTest.java @@ -2,12 +2,19 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertThrows; import static org.junit.jupiter.api.Assertions.assertTrue; import java.util.Collections; +import com.google.gson.JsonElement; +import com.google.gson.JsonParser; +import com.google.protobuf.InvalidProtocolBufferException; import com.google.protobuf.util.JsonFormat; +import org.a2aproject.sdk.grpc.AgentCard; +import org.a2aproject.sdk.grpc.Role; +import org.a2aproject.sdk.grpc.SendMessageRequest; import org.a2aproject.sdk.spec.Message; import org.a2aproject.sdk.spec.MessageSendParams; import org.a2aproject.sdk.spec.TextPart; @@ -108,4 +115,94 @@ public void toJson_keepsALiteralBackslashBeforeUEscapeInMessageText() throws Exc JsonFormat.parser().merge(json, parsed); assertEquals(text, parsed.getMessage().getParts(0).getText()); } + + @Test + public void removeUnknownFields_removesUnknownKeysAtEveryLevel() { + JsonElement json = JsonParser.parseString(""" + { + "message": { + "messageId": "message-1234", + "context_id": "context-1234", + "role": "ROLE_USER", + "parts": [{"text": "hi", "unknownPartField": 1}], + "metadata": {"unknownLooking": {"nested": true}}, + "unknownMessageField": "x" + }, + "unknownParam": 42 + } + """); + String before = json.toString(); + + JsonElement result = ProtoJsonUtils.removeUnknownFields(json, SendMessageRequest.getDescriptor()); + + // Both the JSON name and the proto name of a field are kept, and the contents of a + // google.protobuf.Struct are not described by a descriptor, so they are kept too. + assertEquals(JsonParser.parseString(""" + { + "message": { + "messageId": "message-1234", + "context_id": "context-1234", + "role": "ROLE_USER", + "parts": [{"text": "hi"}], + "metadata": {"unknownLooking": {"nested": true}} + } + } + """), result); + assertEquals(before, json.toString(), "the input must not be modified"); + } + + @Test + public void removeUnknownFields_removesUnknownKeysInMapValues() { + JsonElement json = JsonParser.parseString(""" + { + "name": "agent", + "securitySchemes": { + "bearer": { + "httpAuthSecurityScheme": {"scheme": "Bearer", "unknownSchemeField": 1}, + "unknownSecuritySchemeField": 2 + } + } + } + """); + + JsonElement result = ProtoJsonUtils.removeUnknownFields(json, AgentCard.getDescriptor()); + + assertEquals(JsonParser.parseString(""" + { + "name": "agent", + "securitySchemes": { + "bearer": { + "httpAuthSecurityScheme": {"scheme": "Bearer"} + } + } + } + """), result); + } + + @Test + public void mergeIgnoringUnknownFields_ignoresUnknownFields() throws Exception { + SendMessageRequest.Builder builder = SendMessageRequest.newBuilder(); + + ProtoJsonUtils.mergeIgnoringUnknownFields(""" + {"message": {"messageId": "m1", "role": "ROLE_USER", "parts": [{"text": "hi"}], "unknown": 1}, "unknownParam": 2} + """, builder); + + assertEquals("m1", builder.getMessage().getMessageId()); + assertEquals(Role.ROLE_USER, builder.getMessage().getRole()); + } + + @Test + public void mergeIgnoringUnknownFields_rejectsUnrecognizedEnumValue() { + InvalidProtocolBufferException exception = assertThrows(InvalidProtocolBufferException.class, + () -> ProtoJsonUtils.mergeIgnoringUnknownFields(""" + {"message": {"messageId": "m1", "role": "NOT_A_ROLE", "parts": [{"text": "hi"}]}} + """, SendMessageRequest.newBuilder())); + assertTrue(exception.getMessage().contains("NOT_A_ROLE"), exception.getMessage()); + } + + @Test + public void mergeIgnoringUnknownFields_rejectsMalformedJson() { + assertThrows(InvalidProtocolBufferException.class, + () -> ProtoJsonUtils.mergeIgnoringUnknownFields("{\"message\": ", SendMessageRequest.newBuilder())); + } } diff --git a/transport/rest/src/main/java/org/a2aproject/sdk/transport/rest/handler/RestHandler.java b/transport/rest/src/main/java/org/a2aproject/sdk/transport/rest/handler/RestHandler.java index bad06cd56..3d3327e6d 100644 --- a/transport/rest/src/main/java/org/a2aproject/sdk/transport/rest/handler/RestHandler.java +++ b/transport/rest/src/main/java/org/a2aproject/sdk/transport/rest/handler/RestHandler.java @@ -764,10 +764,8 @@ private void parseRequestBody(String body, com.google.protobuf.Message.Builder b throw new InvalidRequestError("Request body is required"); } validate(body); - if (builder instanceof org.a2aproject.sdk.grpc.SendMessageRequest.Builder) { - body = ProtoJsonUtils.retainKnownFields(JsonParser.parseString(body), builder.getDescriptorForType()).toString(); - } - JsonFormat.parser().merge(body, builder); + // Spec Section 5.7: ignore unrecognized field names for forward compatibility. + ProtoJsonUtils.mergeIgnoringUnknownFields(body, builder); } catch (InvalidProtocolBufferException e) { LOGGER.log(Level.SEVERE, "Error parsing JSON request body (length={0})", body != null ? body.length() : 0); diff --git a/transport/rest/src/test/java/org/a2aproject/sdk/transport/rest/handler/RestHandlerTest.java b/transport/rest/src/test/java/org/a2aproject/sdk/transport/rest/handler/RestHandlerTest.java index 0699a028f..87dd38006 100644 --- a/transport/rest/src/test/java/org/a2aproject/sdk/transport/rest/handler/RestHandlerTest.java +++ b/transport/rest/src/test/java/org/a2aproject/sdk/transport/rest/handler/RestHandlerTest.java @@ -227,6 +227,32 @@ public void testDirectMessageOmitsTaskId() { Assertions.assertFalse(message.has("taskId")); } + @Test + public void testSendMessageIgnoresUnknownFields() { + RestHandler handler = new RestHandler(CARD, createCacheMetadata(), requestHandler, internalExecutor); + agentExecutorExecute = (context, agentEmitter) -> { + agentEmitter.sendMessage(context.getMessage()); + }; + String requestBody = """ + { + "message": + { + "messageId": "message-1234", + "contextId": "context-1234", + "role": "ROLE_USER", + "parts": [{ + "text": "tell me a joke" + }], + "unknownMessageField": "ignored" + }, + "unknownParam": 42 + }"""; + + RestHandler.HTTPRestResponse response = handler.sendMessage(callContext, "", requestBody); + Assertions.assertEquals(200, response.getStatusCode(), response.toString()); + Assertions.assertTrue(response.getBody().contains("message-1234"), response.getBody()); + } + @Test public void testSendMessageInvalidBody() { RestHandler handler = new RestHandler(CARD, createCacheMetadata(), requestHandler, internalExecutor); @@ -239,7 +265,7 @@ public void testSendMessageInvalidBody() { } @Test - public void testSendMessageAllowsExtraTopLevelFieldsOnly() { + public void testSendMessageIgnoresExtraFieldsButRequiresMessage() { RestHandler handler = new RestHandler(CARD, createCacheMetadata(), requestHandler, internalExecutor); agentExecutorExecute = (context, emitter) -> emitter.sendMessage("response"); String message = "\"message\":{\"messageId\":\"message-1\",\"role\":\"ROLE_USER\",\"parts\":[{\"text\":\"hello\"}]}"; @@ -251,8 +277,9 @@ public void testSendMessageAllowsExtraTopLevelFieldsOnly() { String nested = "{\"message\":{\"messageId\":\"message-1\",\"role\":\"ROLE_USER\"," + "\"parts\":[{\"text\":\"hello\"}],\"extra\":true}}"; - Assertions.assertEquals(422, handler.sendMessage(callContext, "", nested).getStatusCode()); - assertStreamingError(handler.sendStreamingMessage(callContext, "", nested)); + Assertions.assertEquals(200, handler.sendMessage(callContext, "", nested).getStatusCode()); + Assertions.assertInstanceOf(RestHandler.HTTPRestStreamingResponse.class, + handler.sendStreamingMessage(callContext, "", nested)); Assertions.assertNotEquals(200, handler.sendMessage(callContext, "", "{\"extra\":true}").getStatusCode()); assertStreamingError(handler.sendStreamingMessage(callContext, "", "{\"extra\":true}")); } @@ -589,10 +616,10 @@ public void testPushNotificationConfigParseError_DoesNotLogSensitiveData() { "scheme": "Bearer", "credentials": "oauth-secret-67890" }, - "unknownField": "trigger-parse-error" + "tenant": {"invalid": "trigger-parse-error"} }""".formatted(MINIMAL_TASK.id()); - // Request body with sensitive data and an unknown field to trigger parse error + // Request body with sensitive data and a wrongly typed field to trigger parse error java.util.logging.Logger logger = java.util.logging.Logger.getLogger(RestHandler.class.getName()); LogCaptureAssertions.assertSensitiveDataNotLogged(logger, () -> Assertions.assertEquals(422,