Light, fluffy, and always free - The AWS Local Emulator alternative
fix(eventbridge): paginate ListConnections results (#6709)
Aniket Shuklaed77a1d4eee0
diff --git a/docs/services/eventbridge.md b/docs/services/eventbridge.mdindex ce7ddb1e24..4ecdc74635 100644--- a/docs/services/eventbridge.md+++ b/docs/services/eventbridge.md@@ -50,6 +50,10 @@| `ListReplays` | - |<!-- floci:actions:end -->+`ListRules` and `ListConnections` accept `NextToken` values of 1 to 2048+characters. Empty or overlong tokens return `ValidationException`; unrecognized+cursors within those bounds return `InvalidToken`.+## Configuration| Variable | Default | Description |@@ -159,6 +163,13 @@ IAM policies.A matching rule can send events directly to HTTP or HTTPS endpoints via API destinations. An API destination pairs an HTTP endpoint URL and HTTP method with an EventBridge Connection for authentication (API key, basic auth, or OAuth client credentials).+`ListConnections` applies its name-prefix and state filters before returning+name-ordered pages. `Limit` accepts 1 to 100; Floci uses 100 when it is omitted.+Pass the returned `NextToken` with the same filters to continue. Tokens are scoped+to the action, account, region, prefix and state; final pages omit the token.+A cursor remains resumable after its connection is deleted. Token lengths must+be 1 to 2048 characters, and unrecognized cursors return `InvalidToken`.+```bash# 1. Create a connection with API key authaws events create-connection \diff --git a/src/main/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeHandler.java b/src/main/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeHandler.javaindex a9f28cd1c0..92e89bde10 100644--- a/src/main/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeHandler.java+++ b/src/main/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeHandler.java@@ -8,6 +8,7 @@ import io.github.hectorvent.floci.core.common.AwsErrorResponse;import io.github.hectorvent.floci.core.common.AwsException;import io.github.hectorvent.floci.core.common.AwsJson11Controller;import io.github.hectorvent.floci.core.common.PaginatedResult;+import io.github.hectorvent.floci.core.common.Pagination;import io.github.hectorvent.floci.services.eventbridge.model.ApiDestination;import io.github.hectorvent.floci.services.eventbridge.model.Archive;import io.github.hectorvent.floci.services.eventbridge.model.ArchiveState;@@ -588,12 +589,17 @@ public class EventBridgeHandler {private Response handleListConnections(JsonNode request, String region) {String namePrefix = request.path("NamePrefix").asText(null);ConnectionState state = parseConnectionState(request.path("ConnectionState").asText(null));- List<Connection> connections = eventBridgeService.listConnections(namePrefix, state, region);+ Integer limit = readLimit(request.path("Limit"));+ String nextToken = Pagination.parseNextToken(request, "NextToken", "SerializationException");+ PaginatedResult<Connection> page = eventBridgeService.listConnections(namePrefix, state, limit, nextToken, region);ObjectNode response = objectMapper.createObjectNode();ArrayNode connectionsArray = response.putArray("Connections");- for (Connection connection : connections) {+ for (Connection connection : page.items()) {connectionsArray.add(buildConnectionNode(connection, false));}+ if (page.nextToken() != null) {+ response.put("NextToken", page.nextToken());+ }return Response.ok(response).build();}diff --git a/src/main/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeService.java b/src/main/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeService.javaindex d1c751c264..be947c7612 100644--- a/src/main/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeService.java+++ b/src/main/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeService.java@@ -58,6 +58,7 @@ import java.util.Map;import java.util.Optional;import java.util.Set;import java.util.UUID;+import java.util.function.Function;import java.util.regex.Pattern;@ApplicationScoped@@ -413,12 +414,19 @@ public class EventBridgeService implements ResourceProvider, StoredResourceArns*/public PaginatedResult<Rule> listRules(String busName, String namePrefix, Integer limit,String nextToken, String region) {+ return paginate(listRules(busName, namePrefix, region), Rule::getName, limit, nextToken, "rule");+ }++ private static <T> PaginatedResult<T> paginate(List<T> items, Function<T, String> cursorOf, Integer limit,+ String nextToken, String scope) {if (limit != null && (limit < 1 || limit > MAX_LIST_LIMIT)) {throw limitOutOfRange(limit.toString(), limit < 1);}- return Pagination.paginate(listRules(busName, namePrefix, region), Rule::getName,- limit != null ? limit : MAX_LIST_LIMIT, nextToken, "rule",- token -> new AwsException("InvalidToken", "Invalid NextToken: " + token, 400));+ if (nextToken != null && (nextToken.isEmpty() || nextToken.length() > 2048)) {+ throw new AwsException("ValidationException", "NextToken must contain 1 to 2048 characters.", 400);+ }+ return Pagination.paginate(items, cursorOf, limit == null ? MAX_LIST_LIMIT : limit, nextToken, scope,+ token -> new AwsException("InvalidToken", "Invalid NextToken.", 400));}static AwsException limitOutOfRange(String value, boolean belowMinimum) {@@ -1669,6 +1677,14 @@ public class EventBridgeService implements ResourceProvider, StoredResourceArns});}+ public PaginatedResult<Connection> listConnections(String namePrefix, ConnectionState state, Integer limit,+ String nextToken, String region) {+ String effectivePrefix = namePrefix == null || namePrefix.isBlank() ? "" : namePrefix;+ String scope = "events:ListConnections:" + regionResolver.getAccountId() + ":" + region+ + ":" + effectivePrefix + ":" + (state == null ? "" : state.name());+ return paginate(listConnections(namePrefix, state, region), Connection::getName, limit, nextToken, scope);+ }+private static void validateConnectionName(String name) {if (name == null || name.isBlank()) {throw new AwsException("ValidationException", "Connection name is required.", 400);diff --git a/src/test/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeListConnectionsPaginationIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeListConnectionsPaginationIntegrationTest.javanew file mode 100644index 0000000000..4f1f70c5af--- /dev/null+++ b/src/test/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeListConnectionsPaginationIntegrationTest.java@@ -0,0 +1,210 @@+package io.github.hectorvent.floci.services.eventbridge;++import io.github.hectorvent.floci.testing.RestAssuredJsonUtils;+import io.quarkus.test.junit.QuarkusTest;+import io.restassured.RestAssured;+import org.junit.jupiter.api.AfterEach;+import org.junit.jupiter.api.BeforeAll;+import org.junit.jupiter.api.BeforeEach;+import org.junit.jupiter.api.Test;+import org.junit.jupiter.params.ParameterizedTest;+import org.junit.jupiter.params.provider.ValueSource;+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;+import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient;+import software.amazon.awssdk.regions.Region;+import software.amazon.awssdk.services.eventbridge.EventBridgeClient;+import software.amazon.awssdk.services.eventbridge.model.Connection;+import software.amazon.awssdk.services.eventbridge.model.ConnectionAuthorizationType;+import software.amazon.awssdk.services.eventbridge.model.ConnectionState;+import software.amazon.awssdk.services.eventbridge.model.EventBridgeException;+import software.amazon.awssdk.services.eventbridge.model.ListConnectionsRequest;+import software.amazon.awssdk.services.eventbridge.model.ListConnectionsResponse;++import java.net.URI;+import java.util.ArrayList;+import java.util.List;+import java.util.Map;+import java.util.UUID;++import static io.restassured.RestAssured.given;+import static org.junit.jupiter.api.Assertions.assertEquals;+import static org.junit.jupiter.api.Assertions.assertFalse;+import static org.junit.jupiter.api.Assertions.assertNotNull;+import static org.junit.jupiter.api.Assertions.assertNull;+import static org.junit.jupiter.api.Assertions.assertThrows;++@QuarkusTest+class EventBridgeListConnectionsPaginationIntegrationTest {++ private static final String ACCOUNT = "741665000001";+ private static final Region REGION = Region.EU_NORTH_1;+ private final String prefix = "connections-" + UUID.randomUUID() + "-";+ private final List<String> created = new ArrayList<>();+ private EventBridgeClient client;++ @BeforeAll+ static void configureRestAssured() {+ RestAssuredJsonUtils.configureAwsContentTypes();+ }++ @BeforeEach+ void openClient() {+ client = client(ACCOUNT, REGION);+ }++ @AfterEach+ void cleanUp() {+ try {+ for (String name : created) {+ client.deleteConnection(request -> request.name(name));+ }+ } finally {+ client.close();+ }+ }++ @Test+ void sdkCallsWalkFilteredConnectionsInNameOrder() {+ create(prefix + "c");+ create(prefix + "a");+ create(prefix + "b");+ create("outside-" + UUID.randomUUID());+ ListConnectionsRequest request = ListConnectionsRequest.builder().namePrefix(prefix)+ .connectionState(ConnectionState.AUTHORIZED).limit(1).build();+ ListConnectionsResponse first = client.listConnections(request);+ assertEquals(1, first.connections().size());+ Connection connection = first.connections().getFirst();+ assertEquals(prefix + "a", connection.name());+ assertEquals(ConnectionAuthorizationType.API_KEY, connection.authorizationType());+ assertNotNull(connection.connectionArn());+ assertNotNull(connection.creationTime());+ assertNotNull(connection.lastModifiedTime());+ assertNotNull(first.nextToken());+ ListConnectionsResponse second = client.listConnections(request.toBuilder().nextToken(first.nextToken()).build());+ assertNotNull(second.nextToken());+ ListConnectionsResponse last = client.listConnections(request.toBuilder().nextToken(second.nextToken()).build());+ assertNull(last.nextToken());+ List<String> names = List.of(first, second, last).stream().flatMap(page -> page.connections().stream())+ .map(Connection::name).toList();+ assertEquals(List.of(prefix + "a", prefix + "b", prefix + "c"), names);+ }++ @Test+ void issuedCursorResumesAfterItsConnectionIsDeleted() {+ create(prefix + "a");+ create(prefix + "b");+ String token = client.listConnections(request -> request.namePrefix(prefix).limit(1)).nextToken();+ assertNotNull(token);+ client.deleteConnection(request -> request.name(prefix + "a"));+ created.remove(prefix + "a");+ ListConnectionsResponse last = client.listConnections(request -> request.namePrefix(prefix).limit(1).nextToken(token));+ assertEquals(List.of(prefix + "b"), last.connections().stream().map(Connection::name).toList());+ assertNull(last.nextToken());+ }++ @Test+ void omittedNullAndMaximumLimitUseABoundedPage() {+ for (int i = 0; i <= 100; i++) {+ create(prefix + "%03d".formatted(i));+ }+ ListConnectionsResponse first = client.listConnections(request -> request.namePrefix(prefix));+ assertEquals(100, first.connections().size());+ assertNotNull(first.nextToken());+ assertEquals(100, client.listConnections(request -> request.namePrefix(prefix).limit(100)).connections().size());+ assertEquals(100, ((List<?>) raw("{\"NamePrefix\":\"" + prefix + "\",\"Limit\":null}", 200).get("Connections")).size());+ ListConnectionsResponse last = client.listConnections(request -> request.namePrefix(prefix).nextToken(first.nextToken()));+ assertEquals(List.of(prefix + "100"), last.connections().stream().map(Connection::name).toList());+ assertNull(last.nextToken());+ }++ @Test+ void noMatchingStateReturnsAnEmptyFinalPage() {+ create(prefix + "a");+ create(prefix + "b");+ ListConnectionsResponse empty = client.listConnections(request -> request.namePrefix(prefix)+ .connectionState(ConnectionState.DEAUTHORIZED).limit(1));+ assertEquals(List.of(), empty.connections());+ assertNull(empty.nextToken());+ }++ @Test+ void issuedTokensCannotCrossAccountRegionPrefixOrState() {+ create(prefix + "a");+ create(prefix + "b");+ String token = client.listConnections(request -> request.namePrefix(prefix)+ .connectionState(ConnectionState.AUTHORIZED).limit(1)).nextToken();+ assertNotNull(token);+ assertInvalid(client, prefix + "other", ConnectionState.AUTHORIZED, token);+ assertInvalid(client, prefix, ConnectionState.DEAUTHORIZED, token);+ try (EventBridgeClient other = client("741665000002", REGION)) {+ assertInvalid(other, prefix, ConnectionState.AUTHORIZED, token);+ }+ try (EventBridgeClient other = client(ACCOUNT, Region.US_WEST_2)) {+ assertInvalid(other, prefix, ConnectionState.AUTHORIZED, token);+ }+ }++ @ParameterizedTest+ @ValueSource(strings = {"-1", "0", "101", "2147483648", "4294967297"})+ void outOfRangeLimitsReturnValidationException(String limit) {+ assertEquals("ValidationException", raw("{\"Limit\":" + limit + "}", 400).get("__type"));+ }++ @ParameterizedTest+ @ValueSource(strings = {"1.5", "true", "\"1\"", "{}", "[]"})+ void malformedLimitsReturnSerializationException(String limit) {+ assertEquals("SerializationException", raw("{\"Limit\":" + limit + "}", 400).get("__type"));+ }++ @ParameterizedTest+ @ValueSource(strings = {"%%%%", "not-a-cursor", "d3Jvbmc6Y3Vyc29y"})+ void malformedOrWrongScopeCursorsReturnInvalidToken(String token) {+ assertEquals("InvalidToken", raw("{\"NextToken\":\"" + token + "\"}", 400).get("__type"));+ }++ @ParameterizedTest+ @ValueSource(strings = {"1", "true", "{}", "[]"})+ void nonStringTokensReturnSerializationException(String token) {+ assertEquals("SerializationException", raw("{\"NextToken\":" + token + "}", 400).get("__type"));+ }++ @Test+ void emptyAndOverlongTokensFailValidation() {+ for (String token : List.of("", "a".repeat(2049))) {+ assertEquals("ValidationException", raw("{\"NextToken\":\"" + token + "\"}", 400).get("__type"));+ }+ }++ private void assertInvalid(EventBridgeClient sdk, String namePrefix, ConnectionState state, String token) {+ EventBridgeException error = assertThrows(EventBridgeException.class, () -> sdk.listConnections(request -> request+ .namePrefix(namePrefix).connectionState(state).limit(1).nextToken(token)));+ assertEquals(400, error.statusCode());+ assertEquals("InvalidToken", error.awsErrorDetails().errorCode());+ }++ private void create(String name) {+ client.createConnection(request -> request.name(name).authorizationType(ConnectionAuthorizationType.API_KEY)+ .authParameters(auth -> auth.apiKeyAuthParameters(key -> key.apiKeyName("x-fixture-key").apiKeyValue("fixture"))));+ created.add(name);+ }++ private EventBridgeClient client(String account, Region region) {+ return EventBridgeClient.builder().endpointOverride(URI.create("http://localhost:" + RestAssured.port))+ .httpClientBuilder(UrlConnectionHttpClient.builder()).region(region)+ .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create(account, "test"))).build();+ }++ private Map<String, Object> raw(String body, int status) {+ Map<String, Object> response = given().contentType("application/x-amz-json-1.1")+ .header("X-Amz-Target", "AWSEvents.ListConnections")+ .header("Authorization", "AWS4-HMAC-SHA256 Credential=" + ACCOUNT + "/20260101/" + REGION.id() + "/events/aws4_request")+ .body(body).post("/").then().statusCode(status).extract().jsonPath().getMap("");+ if (status == 200) {+ for (Object item : (List<?>) response.get("Connections")) {+ assertFalse(((Map<?, ?>) item).containsKey("AuthParameters"));+ }+ }+ return response;+ }+}diff --git a/src/test/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeListRulesPaginationIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeListRulesPaginationIntegrationTest.javaindex ddbaf906d3..b3214a6e3d 100644--- a/src/test/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeListRulesPaginationIntegrationTest.java+++ b/src/test/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeListRulesPaginationIntegrationTest.java@@ -140,6 +140,29 @@ class EventBridgeListRulesPaginationIntegrationTest {.body("{\"Limit\":1,\"NextToken\":\"not-a-token!\"}").when().post("/").then().statusCode(400)- .body("__type", equalTo("InvalidToken"));+ .body("__type", equalTo("InvalidToken"))+ .body("message", equalTo("Invalid NextToken."));+ }++ @ParameterizedTest+ @ValueSource(ints = {0, 2049})+ void outOfBoundsTokenLengthsFailValidation(int length) {+ given().contentType(CT).header("X-Amz-Target", "AWSEvents.ListRules")+ .body("{\"NextToken\":\"" + "a".repeat(length) + "\"}")+ .when().post("/")+ .then().statusCode(400)+ .body("__type", equalTo("ValidationException"))+ .body("message", equalTo("NextToken must contain 1 to 2048 characters."));+ }++ @ParameterizedTest+ @ValueSource(ints = {1, 2048})+ void inBoundsMalformedTokensReturnInvalidToken(int length) {+ given().contentType(CT).header("X-Amz-Target", "AWSEvents.ListRules")+ .body("{\"NextToken\":\"" + "a".repeat(length) + "\"}")+ .when().post("/")+ .then().statusCode(400)+ .body("__type", equalTo("InvalidToken"))+ .body("message", equalTo("Invalid NextToken."));}}