Light, fluffy, and always free - The AWS Local Emulator alternative
fix(sagemaker): honor ListModels sorting and pagination (#6643)
Jimmy Liu Jiab89b6da1a4bd
diff --git a/pom.xml b/pom.xmlindex 493dfbce64..8a00e94370 100644--- a/pom.xml+++ b/pom.xml@@ -330,6 +330,12 @@</dependency><!-- Testing -->+ <dependency>+ <groupId>software.amazon.awssdk</groupId>+ <artifactId>sagemaker</artifactId>+ <version>${aws.sdk.version}</version>+ <scope>test</scope>+ </dependency><dependency><groupId>software.amazon.awssdk</groupId><artifactId>eventbridge</artifactId>diff --git a/src/main/java/io/github/hectorvent/floci/services/sagemaker/SageMakerService.java b/src/main/java/io/github/hectorvent/floci/services/sagemaker/SageMakerService.javaindex 06a7ba1b75..05e583eb1d 100644--- a/src/main/java/io/github/hectorvent/floci/services/sagemaker/SageMakerService.java+++ b/src/main/java/io/github/hectorvent/floci/services/sagemaker/SageMakerService.java@@ -1,5 +1,6 @@package io.github.hectorvent.floci.services.sagemaker;+import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.core.type.TypeReference;import com.fasterxml.jackson.databind.JsonNode;import com.fasterxml.jackson.databind.ObjectMapper;@@ -7,7 +8,9 @@ import com.fasterxml.jackson.databind.node.ArrayNode;import com.fasterxml.jackson.databind.node.ObjectNode;import io.github.hectorvent.floci.core.common.AwsArnUtils;import io.github.hectorvent.floci.core.common.AwsException;+import io.github.hectorvent.floci.core.common.Base64Url;import io.github.hectorvent.floci.core.common.RegionResolver;+import io.github.hectorvent.floci.core.common.SmithyValidationErrors;import io.github.hectorvent.floci.core.storage.StorageBackend;import io.github.hectorvent.floci.core.storage.StorageFactory;import io.github.hectorvent.floci.services.sagemaker.model.SageMakerEntities.EndpointConfigResource;@@ -140,17 +143,33 @@ public class SageMakerService {}public ObjectNode listModels(JsonNode request, String region) {- List<ModelResource> models = modelStore.scan(k -> k.startsWith(region + "::")).stream()- .sorted(Comparator.comparing(m -> m.modelName)).toList();+ String sortBy = text(request, "SortBy");+ String sortOrder = text(request, "SortOrder");+ List<String> violations = new ArrayList<>();+ if (sortBy != null && !sortBy.equals("Name") && !sortBy.equals("CreationTime")) {+ violations.add(SmithyValidationErrors.notInEnum(sortBy, "sortBy", List.of("Name", "CreationTime")));+ }+ if (sortOrder != null && !sortOrder.equals("Ascending") && !sortOrder.equals("Descending")) {+ violations.add(SmithyValidationErrors.notInEnum(sortOrder, "sortOrder", List.of("Ascending", "Descending")));+ }+ if (!violations.isEmpty()) {+ throw SmithyValidationErrors.validationException(violations);+ }+ Comparator<ModelResource> comparator = "Name".equals(sortBy)+ ? Comparator.comparing(m -> m.modelName)+ : Comparator.comparingLong((ModelResource m) -> m.creationTime).thenComparing(m -> m.modelName);+ if (sortOrder == null || sortOrder.equals("Descending")) {+ comparator = comparator.reversed();+ }+ List<ModelResource> models = modelStore.scan(k -> k.startsWith(region + "::")).stream().sorted(comparator).toList();String nameContains = text(request, "NameContains");if (nameContains != null && !nameContains.isBlank()) {models = models.stream().filter(m -> m.modelName.contains(nameContains)).toList();}- return paginate(models, request, m -> m.modelName, (m, n) -> {- n.put("ModelName", m.modelName);- n.put("ModelArn", m.modelArn);- n.put("CreationTime", epoch(m.creationTime));- }, "Models");+ return paginateModels(models, request, comparator, region,+ sortBy == null ? "CreationTime" : sortBy,+ sortOrder == null ? "Descending" : sortOrder,+ nameContains == null || nameContains.isBlank() ? "" : nameContains);}public synchronized ObjectNode createEndpointConfig(JsonNode request, String region) {@@ -607,12 +626,7 @@ public class SageMakerService {return arr;}- /**- * Applies AWS's {@code MaxResults}/{@code NextToken} contract to an already-filtered,- * name-sorted list: {@code MaxResults} (1-100, default {@value #DEFAULT_LIMIT}) caps the- * page, and an opaque {@code NextToken} (the last name returned) resumes strictly after it,- * matching the sort the caller applied.- */+ /** Applies name-ascending pagination for the existing endpoint and training-job lists. */private <T> ObjectNode paginate(List<T> sorted, JsonNode request, Function<T, String> nameOf,BiConsumer<T, ObjectNode> render, String itemsField) {int max = maxResults(request);@@ -621,6 +635,71 @@ public class SageMakerService {if (nextToken != null && !nextToken.isBlank()) {remaining = remaining.stream().dropWhile(v -> nameOf.apply(v).compareTo(nextToken) <= 0).toList();}+ return page(remaining, max, render, itemsField, nameOf);+ }++ private ObjectNode paginateModels(List<ModelResource> sorted, JsonNode request,+ Comparator<ModelResource> comparator, String region,+ String sortBy, String sortOrder, String nameContains) {+ int max = maxResults(request);+ String nextToken = text(request, "NextToken");+ List<ModelResource> remaining = sorted;+ if (nextToken != null && !nextToken.isBlank()) {+ ModelResource anchor;+ if (sortBy.equals("Name")) {+ anchor = new ModelResource();+ anchor.modelName = nextToken;+ } else {+ anchor = decodeModelCursor(nextToken, region, sortOrder, nameContains);+ }+ remaining = remaining.stream().dropWhile(m -> comparator.compare(m, anchor) <= 0).toList();+ }+ return page(remaining, max, (m, n) -> {+ n.put("ModelName", m.modelName);+ n.put("ModelArn", m.modelArn);+ n.put("CreationTime", epoch(m.creationTime));+ }, "Models", m -> sortBy.equals("Name") ? m.modelName+ : encodeModelCursor(m, region, sortOrder, nameContains));+ }++ private String encodeModelCursor(ModelResource model, String region, String sortOrder, String nameContains) {+ ObjectNode cursor = mapper.createObjectNode();+ cursor.put("version", 1);+ cursor.put("region", region);+ cursor.put("sortBy", "CreationTime");+ cursor.put("sortOrder", sortOrder);+ cursor.put("nameContains", nameContains);+ cursor.put("creationTime", model.creationTime);+ cursor.put("modelName", model.modelName);+ return Base64Url.encode(cursor.toString());+ }++ private ModelResource decodeModelCursor(String token, String region, String sortOrder, String nameContains) {+ JsonNode cursor;+ try {+ cursor = mapper.readTree(Base64Url.decode(token));+ } catch (IllegalArgumentException | JsonProcessingException e) {+ throw validation("Invalid NextToken.");+ }+ if (cursor == null || !cursor.path("version").isInt() || cursor.path("version").asInt() != 1+ || !region.equals(cursor.path("region").asText(null))+ || !"CreationTime".equals(cursor.path("sortBy").asText(null))+ || !sortOrder.equals(cursor.path("sortOrder").asText(null))+ || !nameContains.equals(cursor.path("nameContains").asText(null))+ || !cursor.path("creationTime").isIntegralNumber()+ || !cursor.path("creationTime").canConvertToLong()+ || !cursor.path("modelName").isTextual()+ || cursor.path("modelName").asText().isBlank()) {+ throw validation("Invalid NextToken.");+ }+ ModelResource anchor = new ModelResource();+ anchor.creationTime = cursor.path("creationTime").asLong();+ anchor.modelName = cursor.path("modelName").asText();+ return anchor;+ }++ private <T> ObjectNode page(List<T> remaining, int max, BiConsumer<T, ObjectNode> render,+ String itemsField, Function<T, String> tokenOf) {List<T> page = remaining.stream().limit(max).toList();ArrayNode arr = mapper.createArrayNode();page.forEach(v -> {@@ -631,7 +710,7 @@ public class SageMakerService {ObjectNode out = mapper.createObjectNode();out.set(itemsField, arr);if (page.size() == max && remaining.size() > max) {- out.put("NextToken", nameOf.apply(page.get(page.size() - 1)));+ out.put("NextToken", tokenOf.apply(page.get(page.size() - 1)));}return out;}diff --git a/src/test/java/io/github/hectorvent/floci/services/sagemaker/SageMakerIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/sagemaker/SageMakerIntegrationTest.javaindex a2a2189695..394b080533 100644--- a/src/test/java/io/github/hectorvent/floci/services/sagemaker/SageMakerIntegrationTest.java+++ b/src/test/java/io/github/hectorvent/floci/services/sagemaker/SageMakerIntegrationTest.java@@ -2,13 +2,27 @@ package io.github.hectorvent.floci.services.sagemaker;import io.github.hectorvent.floci.testing.RestAssuredJsonUtils;import io.quarkus.test.junit.QuarkusTest;+import io.restassured.RestAssured;import org.junit.jupiter.api.BeforeAll;import org.junit.jupiter.api.Test;+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.sagemaker.SageMakerClient;+import software.amazon.awssdk.services.sagemaker.model.ListModelsResponse;++import java.net.URI;import static io.restassured.RestAssured.given;+import static org.hamcrest.Matchers.contains;import static org.hamcrest.Matchers.equalTo;import static org.hamcrest.Matchers.hasSize;import static org.hamcrest.Matchers.notNullValue;+import static org.junit.jupiter.api.Assertions.assertEquals;+import static org.junit.jupiter.api.Assertions.assertNotEquals;+import static org.junit.jupiter.api.Assertions.assertNotNull;+import static org.junit.jupiter.api.Assertions.assertNull;@QuarkusTestclass SageMakerIntegrationTest {@@ -57,6 +71,73 @@ class SageMakerIntegrationTest {.then().statusCode(400).body("__type", equalTo("ValidationException"));}+ @Test+ void listModelsReportsAllInvalidSortEnums() {+ String sortByError = "Value 'BadBy' at 'sortBy' failed to satisfy constraint: "+ + "Member must satisfy enum value set: [Name, CreationTime]";+ String sortOrderError = "Value 'BadOrder' at 'sortOrder' failed to satisfy constraint: "+ + "Member must satisfy enum value set: [Ascending, Descending]";++ post("SageMaker.ListModels", "{\"SortBy\":\"BadBy\",\"SortOrder\":\"BadOrder\"}")+ .then().statusCode(400)+ .body("__type", equalTo("ValidationException"))+ .body("message", equalTo("2 validation errors detected: " + sortByError + "; " + sortOrderError));+ post("SageMaker.ListModels", "{\"SortBy\":\"BadBy\"}")+ .then().statusCode(400)+ .body("__type", equalTo("ValidationException"))+ .body("message", equalTo("1 validation error detected: " + sortByError));+ post("SageMaker.ListModels", "{\"SortOrder\":\"BadOrder\"}")+ .then().statusCode(400)+ .body("__type", equalTo("ValidationException"))+ .body("message", equalTo("1 validation error detected: " + sortOrderError));+ }++ @Test+ void listModels_respectsRequestedNameDescendingOrder() {+ String suffix = Long.toString(System.nanoTime(), 36);+ String first = "a-model-" + suffix;+ String second = "z-model-" + suffix;+ for (String name : new String[] {first, second}) {+ post("SageMaker.CreateModel", """+ {"ModelName":"%s","PrimaryContainer":{"Image":"busybox:stable"}}+ """.formatted(name)).then().statusCode(200);+ }++ post("SageMaker.ListModels", """+ {"NameContains":"%s","SortBy":"Name","SortOrder":"Descending"}+ """.formatted(suffix))+ .then().statusCode(200)+ .body("Models.ModelName", contains(second, first));++ try (SageMakerClient client = SageMakerClient.builder()+ .endpointOverride(URI.create("http://localhost:" + RestAssured.port))+ .httpClientBuilder(UrlConnectionHttpClient.builder())+ .region(Region.US_EAST_1)+ .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create("test", "test")))+ .build()) {+ ListModelsResponse firstPage = client.listModels(r -> r.nameContains(suffix)+ .sortBy("Name").sortOrder("Descending").maxResults(1));+ assertEquals(second, firstPage.models().get(0).modelName());+ assertNotNull(firstPage.nextToken());++ ListModelsResponse secondPage = client.listModels(r -> r.nameContains(suffix)+ .sortBy("Name").sortOrder("Descending").maxResults(1)+ .nextToken(firstPage.nextToken()));+ assertEquals(first, secondPage.models().get(0).modelName());+ assertNull(secondPage.nextToken());++ ListModelsResponse defaultPage = client.listModels(r -> r.nameContains(suffix).maxResults(1));+ assertNotNull(defaultPage.nextToken());+ ListModelsResponse defaultNext = client.listModels(r -> r.nameContains(suffix)+ .maxResults(1).nextToken(defaultPage.nextToken()));+ assertEquals(1, defaultNext.models().size());+ assertNotEquals(defaultPage.models().get(0).modelName(), defaultNext.models().get(0).modelName());+ } finally {+ post("SageMaker.DeleteModel", "{\"ModelName\":\"%s\"}".formatted(first)).then().statusCode(200);+ post("SageMaker.DeleteModel", "{\"ModelName\":\"%s\"}".formatted(second)).then().statusCode(200);+ }+ }+private io.restassured.response.Response post(String target, String body) {return given().header("Authorization", AUTH).header("X-Amz-Target", target)diff --git a/src/test/java/io/github/hectorvent/floci/services/sagemaker/SageMakerServiceTest.java b/src/test/java/io/github/hectorvent/floci/services/sagemaker/SageMakerServiceTest.javaindex 0138653a9e..0e2635f8ce 100644--- a/src/test/java/io/github/hectorvent/floci/services/sagemaker/SageMakerServiceTest.java+++ b/src/test/java/io/github/hectorvent/floci/services/sagemaker/SageMakerServiceTest.java@@ -11,6 +11,7 @@ import io.github.hectorvent.floci.services.sagemaker.model.SageMakerEntities.Modimport io.github.hectorvent.floci.services.sagemaker.model.SageMakerEntities.TrainingJobResource;import org.junit.jupiter.api.Test;+import java.util.ArrayList;import java.util.List;import static org.junit.jupiter.api.Assertions.assertEquals;@@ -79,19 +80,149 @@ class SageMakerServiceTest {() -> service.listModels(mapper.readTree("{\"MaxResults\":0}"), "us-east-1"));assertEquals("ValidationException", badMax.getErrorCode());- JsonNode firstPage = service.listModels(mapper.readTree("{\"MaxResults\":2}"), "us-east-1");+ JsonNode firstPage = service.listModels(mapper.readTree("{\"MaxResults\":2,\"SortBy\":\"Name\",\"SortOrder\":\"Ascending\"}"), "us-east-1");assertEquals(2, firstPage.path("Models").size());assertEquals("a", firstPage.path("Models").get(0).path("ModelName").asText());String nextToken = firstPage.path("NextToken").asText();assertEquals("b", nextToken);JsonNode secondPage = service.listModels(- mapper.readTree("{\"MaxResults\":2,\"NextToken\":\"" + nextToken + "\"}"), "us-east-1");+ mapper.readTree("{\"MaxResults\":2,\"SortBy\":\"Name\",\"SortOrder\":\"Ascending\",\"NextToken\":\"" + nextToken + "\"}"), "us-east-1");assertEquals(1, secondPage.path("Models").size());assertEquals("c", secondPage.path("Models").get(0).path("ModelName").asText());assertTrue(secondPage.path("NextToken").isMissingNode());}+ @Test+ void listModelsSortsByRequestedKeyAndResumesInDescendingOrder() throws Exception {+ InMemoryStorage<String, ModelResource> models = new InMemoryStorage<>();+ for (String name : List.of("a", "m", "z")) {+ ModelResource model = new ModelResource();+ model.modelName = name;+ model.creationTime = switch (name) {+ case "a" -> 2000L;+ case "m" -> 1000L;+ default -> 3000L;+ };+ models.put("us-east-1::" + name, model);+ }+ SageMakerService service = new SageMakerService(models,+ new InMemoryStorage<String, EndpointConfigResource>(),+ new InMemoryStorage<String, EndpointResource>(),+ new InMemoryStorage<String, TrainingJobResource>(),+ new RegionResolver("us-east-1", "000000000000"), mapper,+ mock(SageMakerEndpointManager.class), mock(SageMakerTrainingRunner.class));++ JsonNode defaultOrder = service.listModels(mapper.readTree("{}"), "us-east-1");+ assertEquals(List.of("z", "a", "m"), modelNames(defaultOrder));+ JsonNode newestPage = service.listModels(mapper.readTree("{\"MaxResults\":2}"), "us-east-1");+ assertEquals(List.of("z", "a"), modelNames(newestPage));+ String creationCursor = newestPage.path("NextToken").asText();+ JsonNode olderPage = service.listModels(+ mapper.createObjectNode().put("MaxResults", 2).put("NextToken", creationCursor), "us-east-1");+ assertEquals(List.of("m"), modelNames(olderPage));+ JsonNode oldestFirst = service.listModels(mapper.readTree("{\"SortBy\":\"CreationTime\",\"SortOrder\":\"Ascending\"}"), "us-east-1");+ assertEquals(List.of("m", "a", "z"), modelNames(oldestFirst));++ JsonNode firstPage = service.listModels(mapper.readTree("{\"SortBy\":\"Name\",\"SortOrder\":\"Descending\",\"MaxResults\":2}"), "us-east-1");+ assertEquals(List.of("z", "m"), modelNames(firstPage));+ JsonNode secondPage = service.listModels(mapper.readTree("{\"SortBy\":\"Name\",\"SortOrder\":\"Descending\",\"MaxResults\":2,\"NextToken\":\"m\"}"), "us-east-1");+ assertEquals(List.of("a"), modelNames(secondPage));+ assertTrue(secondPage.path("NextToken").isMissingNode());++ models.delete("us-east-1::m");+ JsonNode afterCursorDeletion = service.listModels(mapper.readTree("{\"SortBy\":\"Name\",\"SortOrder\":\"Descending\",\"MaxResults\":2,\"NextToken\":\"m\"}"), "us-east-1");+ assertEquals(List.of("a"), modelNames(afterCursorDeletion));+ }++ @Test+ void listModelsCreationTimeCursorResumesEqualTimeTiesAfterDeletion() throws Exception {+ InMemoryStorage<String, ModelResource> models = new InMemoryStorage<>();+ for (String name : List.of("a", "m", "z")) {+ ModelResource model = new ModelResource();+ model.modelName = name;+ model.creationTime = name.equals("z") ? 3000L : 2000L;+ models.put("us-east-1::" + name, model);+ }+ SageMakerService service = new SageMakerService(models,+ new InMemoryStorage<String, EndpointConfigResource>(),+ new InMemoryStorage<String, EndpointResource>(),+ new InMemoryStorage<String, TrainingJobResource>(),+ new RegionResolver("us-east-1", "000000000000"), mapper,+ mock(SageMakerEndpointManager.class), mock(SageMakerTrainingRunner.class));++ JsonNode firstAscending = service.listModels(+ mapper.createObjectNode().put("MaxResults", 1).put("SortOrder", "Ascending"), "us-east-1");+ assertEquals(List.of("a"), modelNames(firstAscending));+ models.delete("us-east-1::a");+ JsonNode nextAscending = service.listModels(mapper.createObjectNode()+ .put("MaxResults", 1).put("SortOrder", "Ascending")+ .put("NextToken", firstAscending.path("NextToken").asText()), "us-east-1");+ assertEquals(List.of("m"), modelNames(nextAscending));++ JsonNode firstDescending = service.listModels(mapper.createObjectNode().put("MaxResults", 1), "us-east-1");+ assertEquals(List.of("z"), modelNames(firstDescending));+ models.delete("us-east-1::z");+ JsonNode nextDescending = service.listModels(mapper.createObjectNode()+ .put("MaxResults", 1).put("NextToken", firstDescending.path("NextToken").asText()), "us-east-1");+ assertEquals(List.of("m"), modelNames(nextDescending));+ }++ @Test+ void listModelsCreationTimeCursorRejectsChangedRequestContext() throws Exception {+ SageMakerService service = service();+ for (String name : List.of("a", "b")) {+ service.createModel(mapper.readTree(+ "{\"ModelName\":\"" + name + "\",\"PrimaryContainer\":{\"Image\":\"busybox:stable\"}}"), "us-east-1");+ }+ JsonNode first = service.listModels(mapper.createObjectNode().put("MaxResults", 1), "us-east-1");+ String token = first.path("NextToken").asText();++ AwsException changedRegion = assertThrows(AwsException.class, () -> service.listModels(+ mapper.createObjectNode().put("MaxResults", 1).put("NextToken", token), "us-west-2"));+ assertEquals("ValidationException", changedRegion.getErrorCode());+ AwsException changedOrder = assertThrows(AwsException.class, () -> service.listModels(+ mapper.createObjectNode().put("MaxResults", 1).put("SortOrder", "Ascending")+ .put("NextToken", token), "us-east-1"));+ assertEquals("ValidationException", changedOrder.getErrorCode());+ AwsException changedFilter = assertThrows(AwsException.class, () -> service.listModels(+ mapper.createObjectNode().put("MaxResults", 1).put("NameContains", "b")+ .put("NextToken", token), "us-east-1"));+ assertEquals("ValidationException", changedFilter.getErrorCode());+ AwsException invalidToken = assertThrows(AwsException.class, () -> service.listModels(+ mapper.createObjectNode().put("NextToken", "invalid%"), "us-east-1"));+ assertEquals("ValidationException", invalidToken.getErrorCode());+ }++ private static List<String> modelNames(JsonNode response) {+ List<String> names = new ArrayList<>();+ response.path("Models").forEach(model -> names.add(model.path("ModelName").asText()));+ return names;+ }++ @Test+ void listEndpointConfigsStillPaginatesByName() throws Exception {+ InMemoryStorage<String, EndpointConfigResource> configs = new InMemoryStorage<>();+ for (String name : List.of("a", "b")) {+ EndpointConfigResource config = new EndpointConfigResource();+ config.endpointConfigName = name;+ configs.put("us-east-1::" + name, config);+ }+ SageMakerService service = new SageMakerService(new InMemoryStorage<String, ModelResource>(), configs,+ new InMemoryStorage<String, EndpointResource>(),+ new InMemoryStorage<String, TrainingJobResource>(),+ new RegionResolver("us-east-1", "000000000000"), mapper,+ mock(SageMakerEndpointManager.class), mock(SageMakerTrainingRunner.class));++ JsonNode firstPage = service.listEndpointConfigs(mapper.readTree("{\"MaxResults\":1}"), "us-east-1");+ assertEquals("a", firstPage.path("EndpointConfigs").get(0).path("EndpointConfigName").asText());+ assertEquals("a", firstPage.path("NextToken").asText());+ configs.delete("us-east-1::a");+ JsonNode secondPage = service.listEndpointConfigs(mapper.readTree("{\"MaxResults\":1,\"NextToken\":\"a\"}"), "us-east-1");+ assertEquals("b", secondPage.path("EndpointConfigs").get(0).path("EndpointConfigName").asText());+ assertTrue(secondPage.path("NextToken").isMissingNode());+ }+@Testvoid deleteEndpointConfigRequiresExistingConfig() throws Exception {SageMakerService service = service();