diff --git a/compat-0.3/client/transport/rest/src/main/java/org/a2aproject/sdk/compat03/client/transport/rest/RestTransport_v0_3.java b/compat-0.3/client/transport/rest/src/main/java/org/a2aproject/sdk/compat03/client/transport/rest/RestTransport_v0_3.java index fc5e051d0..10501348d 100644 --- a/compat-0.3/client/transport/rest/src/main/java/org/a2aproject/sdk/compat03/client/transport/rest/RestTransport_v0_3.java +++ b/compat-0.3/client/transport/rest/src/main/java/org/a2aproject/sdk/compat03/client/transport/rest/RestTransport_v0_3.java @@ -48,6 +48,8 @@ import org.a2aproject.sdk.compat03.spec.SetTaskPushNotificationConfigRequest_v0_3; import org.a2aproject.sdk.compat03.json.JsonUtil_v0_3; import java.io.IOException; +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; import java.util.Collections; import java.util.List; import java.util.logging.Level; @@ -138,14 +140,14 @@ public Task_v0_3 getTask(TaskQueryParams_v0_3 taskQueryParams, @Nullable ClientC checkNotNullParam("taskQueryParams", taskQueryParams); GetTaskRequest.Builder builder = GetTaskRequest.newBuilder(); builder.setName("tasks/" + taskQueryParams.id()); + builder.setHistoryLength(taskQueryParams.historyLength()); PayloadAndHeaders_v0_3 payloadAndHeaders = applyInterceptors(GetTaskRequest_v0_3.METHOD, builder, agentCard, context); try { - String url; - if (taskQueryParams.historyLength() > 0) { - url = agentUrl + String.format("/v1/tasks/%s?historyLength=%d", taskQueryParams.id(), taskQueryParams.historyLength()); - } else { - url = agentUrl + String.format("/v1/tasks/%1s", taskQueryParams.id()); + org.a2aproject.sdk.compat03.grpc.GetTaskRequestOrBuilder effective = effectivePayload(payloadAndHeaders, org.a2aproject.sdk.compat03.grpc.GetTaskRequestOrBuilder.class); + String url = resourceUrl(effective.getName()); + if (effective.getHistoryLength() > 0) { + url += "?historyLength=" + effective.getHistoryLength(); } A2AHttpClient.GetBuilder getBuilder = httpClient.createGet().url(url); if (payloadAndHeaders.getHeaders() != null) { @@ -176,7 +178,8 @@ public Task_v0_3 cancelTask(TaskIdParams_v0_3 taskIdParams, @Nullable ClientCall PayloadAndHeaders_v0_3 payloadAndHeaders = applyInterceptors(CancelTaskRequest_v0_3.METHOD, builder, agentCard, context); try { - String httpResponseBody = sendPostRequest(agentUrl + String.format("/v1/tasks/%1s:cancel", taskIdParams.id()), payloadAndHeaders); + org.a2aproject.sdk.compat03.grpc.CancelTaskRequestOrBuilder effective = effectivePayload(payloadAndHeaders, org.a2aproject.sdk.compat03.grpc.CancelTaskRequestOrBuilder.class); + String httpResponseBody = sendPostRequest(resourceUrl(effective.getName()) + ":cancel", payloadAndHeaders); org.a2aproject.sdk.compat03.grpc.Task.Builder responseBuilder = org.a2aproject.sdk.compat03.grpc.Task.newBuilder(); JsonFormat.parser().merge(httpResponseBody, responseBuilder); return ProtoUtils_v0_3.FromProto.task(responseBuilder); @@ -198,7 +201,8 @@ public TaskPushNotificationConfig_v0_3 setTaskPushNotificationConfiguration(Task } PayloadAndHeaders_v0_3 payloadAndHeaders = applyInterceptors(SetTaskPushNotificationConfigRequest_v0_3.METHOD, builder, agentCard, context); try { - String httpResponseBody = sendPostRequest(agentUrl + String.format("/v1/tasks/%1s/pushNotificationConfigs", request.taskId()), payloadAndHeaders); + org.a2aproject.sdk.compat03.grpc.CreateTaskPushNotificationConfigRequestOrBuilder effective = effectivePayload(payloadAndHeaders, org.a2aproject.sdk.compat03.grpc.CreateTaskPushNotificationConfigRequestOrBuilder.class); + String httpResponseBody = sendPostRequest(resourceUrl(effective.getParent()) + "/pushNotificationConfigs", payloadAndHeaders); org.a2aproject.sdk.compat03.grpc.TaskPushNotificationConfig.Builder responseBuilder = org.a2aproject.sdk.compat03.grpc.TaskPushNotificationConfig.newBuilder(); JsonFormat.parser().merge(httpResponseBody, responseBuilder); return ProtoUtils_v0_3.FromProto.taskPushNotificationConfig(responseBuilder); @@ -219,7 +223,8 @@ public TaskPushNotificationConfig_v0_3 getTaskPushNotificationConfiguration(GetT PayloadAndHeaders_v0_3 payloadAndHeaders = applyInterceptors(GetTaskPushNotificationConfigRequest_v0_3.METHOD, builder, agentCard, context); try { - String url = agentUrl + String.format("/v1/tasks/%1s/pushNotificationConfigs/%2s", request.id(), configId); + org.a2aproject.sdk.compat03.grpc.GetTaskPushNotificationConfigRequestOrBuilder effective = effectivePayload(payloadAndHeaders, org.a2aproject.sdk.compat03.grpc.GetTaskPushNotificationConfigRequestOrBuilder.class); + String url = resourceUrl(effective.getName()); A2AHttpClient.GetBuilder getBuilder = httpClient.createGet().url(url); if (payloadAndHeaders.getHeaders() != null) { for (Map.Entry entry : payloadAndHeaders.getHeaders().entrySet()) { @@ -245,11 +250,18 @@ public TaskPushNotificationConfig_v0_3 getTaskPushNotificationConfiguration(GetT public List listTaskPushNotificationConfigurations(ListTaskPushNotificationConfigParams_v0_3 request, @Nullable ClientCallContext_v0_3 context) throws A2AClientException_v0_3 { checkNotNullParam("request", request); ListTaskPushNotificationConfigRequest.Builder builder = ListTaskPushNotificationConfigRequest.newBuilder(); - builder.setParent(String.format("tasks/%1s/pushNotificationConfigs", request.id())); + builder.setParent(String.format("tasks/%1s", request.id())); PayloadAndHeaders_v0_3 payloadAndHeaders = applyInterceptors(ListTaskPushNotificationConfigRequest_v0_3.METHOD, builder, agentCard, context); try { - String url = agentUrl + String.format("/v1/tasks/%1s/pushNotificationConfigs", request.id()); + org.a2aproject.sdk.compat03.grpc.ListTaskPushNotificationConfigRequestOrBuilder effective = effectivePayload(payloadAndHeaders, org.a2aproject.sdk.compat03.grpc.ListTaskPushNotificationConfigRequestOrBuilder.class); + String url = resourceUrl(effective.getParent()) + "/pushNotificationConfigs"; + if (effective.getPageSize() != 0) { + url += "?pageSize=" + effective.getPageSize(); + } + if (!effective.getPageToken().isEmpty()) { + url += (url.contains("?") ? "&" : "?") + "pageToken=" + URLEncoder.encode(effective.getPageToken(), StandardCharsets.UTF_8); + } A2AHttpClient.GetBuilder getBuilder = httpClient.createGet().url(url); if (payloadAndHeaders.getHeaders() != null) { for (Map.Entry entry : payloadAndHeaders.getHeaders().entrySet()) { @@ -274,11 +286,13 @@ public List listTaskPushNotificationConfigurati @Override public void deleteTaskPushNotificationConfigurations(DeleteTaskPushNotificationConfigParams_v0_3 request, @Nullable ClientCallContext_v0_3 context) throws A2AClientException_v0_3 { checkNotNullParam("request", request); - org.a2aproject.sdk.compat03.grpc.DeleteTaskPushNotificationConfigRequestOrBuilder builder = org.a2aproject.sdk.compat03.grpc.DeleteTaskPushNotificationConfigRequest.newBuilder(); + org.a2aproject.sdk.compat03.grpc.DeleteTaskPushNotificationConfigRequest.Builder builder = org.a2aproject.sdk.compat03.grpc.DeleteTaskPushNotificationConfigRequest.newBuilder() + .setName(String.format("tasks/%1s/pushNotificationConfigs/%2s", request.id(), request.pushNotificationConfigId())); PayloadAndHeaders_v0_3 payloadAndHeaders = applyInterceptors(DeleteTaskPushNotificationConfigRequest_v0_3.METHOD, builder, agentCard, context); try { - String url = agentUrl + String.format("/v1/tasks/%1s/pushNotificationConfigs/%2s", request.id(), request.pushNotificationConfigId()); + org.a2aproject.sdk.compat03.grpc.DeleteTaskPushNotificationConfigRequestOrBuilder effective = effectivePayload(payloadAndHeaders, org.a2aproject.sdk.compat03.grpc.DeleteTaskPushNotificationConfigRequestOrBuilder.class); + String url = resourceUrl(effective.getName()); A2AHttpClient.DeleteBuilder deleteBuilder = httpClient.createDelete().url(url); if (payloadAndHeaders.getHeaders() != null) { for (Map.Entry entry : payloadAndHeaders.getHeaders().entrySet()) { @@ -307,7 +321,8 @@ public void resubscribe(TaskIdParams_v0_3 request, Consumer> ref = new AtomicReference<>(); RestSSEEventListener_v0_3 sseEventListener = new RestSSEEventListener_v0_3(eventConsumer, errorConsumer); try { - String url = agentUrl + String.format("/v1/tasks/%1s:subscribe", request.id()); + org.a2aproject.sdk.compat03.grpc.TaskSubscriptionRequestOrBuilder effective = effectivePayload(payloadAndHeaders, org.a2aproject.sdk.compat03.grpc.TaskSubscriptionRequestOrBuilder.class); + String url = resourceUrl(effective.getName()) + ":subscribe"; A2AHttpClient.PostBuilder postBuilder = createPostBuilder(url, payloadAndHeaders); CompletableFuture streamFuture = postBuilder.postAsyncSSE( event -> sseEventListener.onMessage(event.data(), ref.get()), @@ -368,6 +383,14 @@ public void close() { // no-op } + private String resourceUrl(String name) { + return agentUrl + "/v1" + (name.startsWith("/") ? name : "/" + name); + } + + private static T effectivePayload(PayloadAndHeaders_v0_3 payload, Class type) { + return type.cast(checkNotNullParam("interceptor payload", payload.getPayload())); + } + private PayloadAndHeaders_v0_3 applyInterceptors(String methodName, @Nullable MessageOrBuilder payload, AgentCard_v0_3 agentCard, @Nullable ClientCallContext_v0_3 clientCallContext) { PayloadAndHeaders_v0_3 payloadAndHeaders = new PayloadAndHeaders_v0_3(payload, getHttpHeaders(clientCallContext)); diff --git a/compat-0.3/client/transport/rest/src/test/java/org/a2aproject/sdk/compat03/client/transport/rest/RestTransport_v0_3_Test.java b/compat-0.3/client/transport/rest/src/test/java/org/a2aproject/sdk/compat03/client/transport/rest/RestTransport_v0_3_Test.java index 9b62af938..606fb0007 100644 --- a/compat-0.3/client/transport/rest/src/test/java/org/a2aproject/sdk/compat03/client/transport/rest/RestTransport_v0_3_Test.java +++ b/compat-0.3/client/transport/rest/src/test/java/org/a2aproject/sdk/compat03/client/transport/rest/RestTransport_v0_3_Test.java @@ -17,6 +17,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; @@ -35,6 +36,7 @@ import java.util.logging.Logger; import org.a2aproject.sdk.compat03.client.transport.spi.interceptors.ClientCallContext_v0_3; +import org.a2aproject.sdk.compat03.client.transport.spi.interceptors.ClientCallInterceptor_v0_3; import org.a2aproject.sdk.compat03.spec.AgentCapabilities_v0_3; import org.a2aproject.sdk.compat03.spec.AgentCard_v0_3; import org.a2aproject.sdk.compat03.spec.AgentSkill_v0_3; @@ -109,6 +111,130 @@ public void tearDown() { public RestTransport_v0_3_Test() { } + @Test + public void getTaskUsesInterceptorResourceName() throws Exception { + this.server.when(request().withMethod("GET").withPath("/v1/tasks/changed")) + .respond(response().withStatusCode(200).withBody(GET_TASK_TEST_RESPONSE)); + ClientCallInterceptor_v0_3 interceptor = new ClientCallInterceptor_v0_3() { + @Override + public org.a2aproject.sdk.compat03.client.transport.spi.interceptors.PayloadAndHeaders_v0_3 intercept( + String method, Object payload, Map headers, AgentCard_v0_3 card, + ClientCallContext_v0_3 context) { + ((org.a2aproject.sdk.compat03.grpc.GetTaskRequest.Builder) payload).setName("tasks/changed"); + return new org.a2aproject.sdk.compat03.client.transport.spi.interceptors.PayloadAndHeaders_v0_3(payload, null); + } + }; + RestTransport_v0_3 client = new RestTransport_v0_3(null, CARD, CARD.url(), List.of(interceptor)); + client.getTask(new TaskQueryParams_v0_3("original"), null); + } + + @Test + public void urlBoundFieldsFollowInterceptorBuilderAndImmutableMessages() throws Exception { + this.server.when(request().withMethod("GET").withPath("/v1/tasks/changed") + .withQueryStringParameter("historyLength", "5")) + .respond(response().withStatusCode(200).withBody(GET_TASK_TEST_RESPONSE)); + this.server.when(request().withMethod("POST").withPath("/v1/tasks/changed:cancel")) + .respond(response().withStatusCode(200).withBody(CANCEL_TASK_TEST_RESPONSE)); + this.server.when(request().withMethod("POST").withPath("/v1/tasks/changed/pushNotificationConfigs")) + .respond(response().withStatusCode(200).withBody(SET_TASK_PUSH_NOTIFICATION_CONFIG_TEST_RESPONSE)); + this.server.when(request().withMethod("GET").withPath("/v1/tasks/changed/pushNotificationConfigs/other")) + .respond(response().withStatusCode(200).withBody(GET_TASK_PUSH_NOTIFICATION_CONFIG_TEST_RESPONSE)); + this.server.when(request().withMethod("GET").withPath("/v1/tasks/changed/pushNotificationConfigs") + .withQueryStringParameter("pageSize", "12").withQueryStringParameter("pageToken", "a b")) + .respond(response().withStatusCode(200).withBody(LIST_TASK_PUSH_NOTIFICATION_CONFIG_TEST_RESPONSE)); + this.server.when(request().withMethod("DELETE").withPath("/v1/tasks/changed/pushNotificationConfigs/other")) + .respond(response().withStatusCode(200)); + this.server.when(request().withMethod("POST").withPath("/v1/tasks/changed:subscribe")) + .respond(response().withStatusCode(200).withHeader("Content-Type", "text/event-stream") + .withBody(TASK_RESUBSCRIPTION_REQUEST_TEST_RESPONSE)); + for (boolean immutable : new boolean[] { false, true }) { + ClientCallInterceptor_v0_3 interceptor = new ClientCallInterceptor_v0_3() { + @Override + public org.a2aproject.sdk.compat03.client.transport.spi.interceptors.PayloadAndHeaders_v0_3 intercept( + String method, Object payload, Map headers, AgentCard_v0_3 card, + ClientCallContext_v0_3 context) { + Object result = payload; + if (payload instanceof org.a2aproject.sdk.compat03.grpc.GetTaskRequest.Builder b) { + b.setName("tasks/changed").setHistoryLength(5); result = immutable ? b.build() : b; + } else if (payload instanceof org.a2aproject.sdk.compat03.grpc.CancelTaskRequest.Builder b) { + b.setName("tasks/changed"); result = immutable ? b.build() : b; + } else if (payload instanceof org.a2aproject.sdk.compat03.grpc.CreateTaskPushNotificationConfigRequest.Builder b) { + b.setParent("tasks/changed"); result = immutable ? b.build() : b; + } else if (payload instanceof org.a2aproject.sdk.compat03.grpc.GetTaskPushNotificationConfigRequest.Builder b) { + b.setName("tasks/changed/pushNotificationConfigs/other"); result = immutable ? b.build() : b; + } else if (payload instanceof org.a2aproject.sdk.compat03.grpc.ListTaskPushNotificationConfigRequest.Builder b) { + b.setParent("tasks/changed").setPageSize(12).setPageToken("a b"); result = immutable ? b.build() : b; + } else if (payload instanceof org.a2aproject.sdk.compat03.grpc.DeleteTaskPushNotificationConfigRequest.Builder b) { + b.setName("tasks/changed/pushNotificationConfigs/other"); result = immutable ? b.build() : b; + } else if (payload instanceof org.a2aproject.sdk.compat03.grpc.TaskSubscriptionRequest.Builder b) { + b.setName("tasks/changed"); result = immutable ? b.build() : b; + } + return new org.a2aproject.sdk.compat03.client.transport.spi.interceptors.PayloadAndHeaders_v0_3(result, headers); + } + }; + RestTransport_v0_3 client = new RestTransport_v0_3(null, CARD, CARD.url(), List.of(interceptor)); + client.getTask(new TaskQueryParams_v0_3("original", 2), null); + client.cancelTask(new TaskIdParams_v0_3("original"), null); + client.setTaskPushNotificationConfiguration(new TaskPushNotificationConfig_v0_3("original", + new PushNotificationConfig_v0_3.Builder().url("https://example.com/callback").build()), null); + client.getTaskPushNotificationConfiguration(new GetTaskPushNotificationConfigParams_v0_3("original", "old", null), null); + client.listTaskPushNotificationConfigurations(new ListTaskPushNotificationConfigParams_v0_3("original"), null); + client.deleteTaskPushNotificationConfigurations(new DeleteTaskPushNotificationConfigParams_v0_3("original", "old"), null); + CountDownLatch latch = new CountDownLatch(1); + client.resubscribe(new TaskIdParams_v0_3("original"), event -> latch.countDown(), error -> {}, null); + assertTrue(latch.await(10, TimeUnit.SECONDS)); + } + } + + @Test + public void urlBoundOperationsRejectNullInterceptorPayloadBeforeSending() throws Exception { + ClientCallInterceptor_v0_3 interceptor = new ClientCallInterceptor_v0_3() { + @Override + public org.a2aproject.sdk.compat03.client.transport.spi.interceptors.PayloadAndHeaders_v0_3 intercept( + String method, Object payload, Map headers, AgentCard_v0_3 card, + ClientCallContext_v0_3 context) { + return new org.a2aproject.sdk.compat03.client.transport.spi.interceptors.PayloadAndHeaders_v0_3(null, null); + } + }; + RestTransport_v0_3 client = new RestTransport_v0_3(null, CARD, CARD.url(), List.of(interceptor)); + List calls = List.of( + () -> client.getTask(new TaskQueryParams_v0_3("original", 2), null), + () -> client.cancelTask(new TaskIdParams_v0_3("original"), null), + () -> client.setTaskPushNotificationConfiguration(new TaskPushNotificationConfig_v0_3("original", + new PushNotificationConfig_v0_3.Builder().url("https://example.com/callback").build()), null), + () -> client.getTaskPushNotificationConfiguration(new GetTaskPushNotificationConfigParams_v0_3("original", "old", null), null), + () -> client.listTaskPushNotificationConfigurations(new ListTaskPushNotificationConfigParams_v0_3("original"), null), + () -> client.deleteTaskPushNotificationConfigurations(new DeleteTaskPushNotificationConfigParams_v0_3("original", "old"), null), + () -> client.resubscribe(new TaskIdParams_v0_3("original"), event -> {}, error -> {}, null)); + for (org.junit.jupiter.api.function.Executable call : calls) { + IllegalArgumentException error = assertThrows(IllegalArgumentException.class, call); + assertTrue(error.getMessage().contains("interceptor payload")); + } + assertEquals(0, server.retrieveRecordedRequests(request()).length); + } + + @Test + public void authenticatedExtendedCardAllowsNullPayloadAndHeaders() throws Exception { + server.when(request().withMethod("GET").withPath("/.well-known/agent-card.json")) + .respond(response().withStatusCode(200).withBody(JsonRestMessages_v0_3.AGENT_CARD_SUPPORTS_EXTENDED)); + server.when(request().withMethod("GET").withPath("/v1/card")) + .respond(response().withStatusCode(200).withBody(JsonRestMessages_v0_3.AUTHENTICATION_EXTENDED_AGENT_CARD)); + AtomicInteger calls = new AtomicInteger(); + ClientCallInterceptor_v0_3 interceptor = new ClientCallInterceptor_v0_3() { + @Override + public org.a2aproject.sdk.compat03.client.transport.spi.interceptors.PayloadAndHeaders_v0_3 intercept( + String method, Object payload, Map headers, AgentCard_v0_3 card, + ClientCallContext_v0_3 context) { + assertNull(payload); + calls.incrementAndGet(); + return new org.a2aproject.sdk.compat03.client.transport.spi.interceptors.PayloadAndHeaders_v0_3(null, null); + } + }; + RestTransport_v0_3 client = new RestTransport_v0_3(null, null, CARD.url(), List.of(interceptor)); + assertEquals("GeoSpatial Route Planner Agent Extended", client.getAgentCard(null).name()); + assertEquals(1, calls.get()); + } + /** * Test of sendMessage method, of class JSONRestTransport. */