Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

feat(dynamodb): add ScanFilter support for Scan operation (#175)

Andreas Caravellafe4ffd1ee4f7
diff --git a/src/main/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbJsonHandler.java b/src/main/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbJsonHandler.java
index 4e5cddb6e7..bfe309018c 100644
--- a/src/main/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbJsonHandler.java
+++ b/src/main/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbJsonHandler.java
@@ -312,12 +312,14 @@ public class DynamoDbJsonHandler {
? request.get("ExpressionAttributeNames") : null;
JsonNode exprAttrValues = request.has("ExpressionAttributeValues")
? request.get("ExpressionAttributeValues") : null;
+ JsonNode scanFilter = request.has("ScanFilter")
+ ? request.get("ScanFilter") : null;
Integer limit = request.has("Limit") ? request.get("Limit").asInt() : null;
JsonNode exclusiveStartKey = request.has("ExclusiveStartKey")
? request.get("ExclusiveStartKey") : null;
DynamoDbService.ScanResult result = dynamoDbService.scan(
- tableName, filterExpr, exprAttrNames, exprAttrValues, limit, exclusiveStartKey, region);
+ tableName, filterExpr, exprAttrNames, exprAttrValues, scanFilter, limit, exclusiveStartKey, region);
ObjectNode response = objectMapper.createObjectNode();
ArrayNode itemsArray = objectMapper.createArrayNode();
diff --git a/src/main/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbService.java b/src/main/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbService.java
index 7db613cfd8..8c17ecab2c 100644
--- a/src/main/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbService.java
+++ b/src/main/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbService.java
@@ -513,21 +513,14 @@ public class DynamoDbService {
public ScanResult scan(String tableName, String filterExpression,
JsonNode expressionAttrNames, JsonNode expressionAttrValues,
- Integer limit, String startKey) {
+ JsonNode scanFilter, Integer limit, JsonNode exclusiveStartKey) {
return scan(tableName, filterExpression, expressionAttrNames, expressionAttrValues,
- limit, (JsonNode) null, regionResolver.getDefaultRegion());
+ scanFilter, limit, exclusiveStartKey, regionResolver.getDefaultRegion());
}
public ScanResult scan(String tableName, String filterExpression,
JsonNode expressionAttrNames, JsonNode expressionAttrValues,
- Integer limit, String startKey, String region) {
- return scan(tableName, filterExpression, expressionAttrNames, expressionAttrValues,
- limit, (JsonNode) null, region);
- }
-
- public ScanResult scan(String tableName, String filterExpression,
- JsonNode expressionAttrNames, JsonNode expressionAttrValues,
- Integer limit, JsonNode exclusiveStartKey, String region) {
+ JsonNode scanFilter, Integer limit, JsonNode exclusiveStartKey, String region) {
String storageKey = regionKey(region, tableName);
TableDefinition table = tableStore.get(storageKey)
.orElseThrow(() -> resourceNotFoundException(tableName));
@@ -551,10 +544,14 @@ public class DynamoDbService {
if (isExpired(item, table)) {
continue;
}
- if (filterExpression == null
- || matchesFilterExpression(item, filterExpression, expressionAttrNames, expressionAttrValues)) {
- results.add(item);
+ if (filterExpression != null
+ && !matchesFilterExpression(item, filterExpression, expressionAttrNames, expressionAttrValues)) {
+ continue;
+ }
+ if (scanFilter != null && !matchesScanFilter(item, scanFilter)) {
+ continue;
}
+ results.add(item);
}
JsonNode lastEvaluatedKey = null;
@@ -567,6 +564,20 @@ public class DynamoDbService {
return new ScanResult(results, totalScanned, lastEvaluatedKey);
}
+ private boolean matchesScanFilter(JsonNode item, JsonNode scanFilter) {
+ Iterator<Map.Entry<String, JsonNode>> fields = scanFilter.fields();
+ while (fields.hasNext()) {
+ var entry = fields.next();
+ String attrName = entry.getKey();
+ JsonNode condition = entry.getValue();
+ JsonNode attrValue = item.get(attrName);
+ if (!matchesKeyCondition(attrValue, condition)) {
+ return false;
+ }
+ }
+ return true;
+ }
+
// --- Batch Operations ---
public record BatchWriteResult(Map<String, List<JsonNode>> unprocessedItems) {}
@@ -1388,6 +1399,7 @@ public class DynamoDbService {
return null;
}
+ // NE, CONTAINS, NOT_CONTAINS, IN, NULL, NOT_NULL not yet supported
private boolean matchesKeyCondition(JsonNode attrValue, JsonNode condition) {
if (condition == null) return true;
String op = condition.has("ComparisonOperator") ? condition.get("ComparisonOperator").asText() : "EQ";
diff --git a/src/test/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbIntegrationTest.java
index c34aca707b..39bdcc0a1f 100644
--- a/src/test/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbIntegrationTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbIntegrationTest.java
@@ -435,6 +435,56 @@ class DynamoDbIntegrationTest {
@Test
@Order(16)
+ void scanWithScanFilter() {
+ given()
+ .header("X-Amz-Target", "DynamoDB_20120810.Scan")
+ .contentType(DYNAMODB_CONTENT_TYPE)
+ .body("""
+ {
+ "TableName": "TestTable",
+ "ScanFilter": {
+ "name": {
+ "AttributeValueList": [{"S": "Alice"}],
+ "ComparisonOperator": "EQ"
+ }
+ }
+ }
+ """)
+ .when()
+ .post("/")
+ .then()
+ .statusCode(200)
+ .body("Count", equalTo(1))
+ .body("Items[0].name.S", equalTo("Alice"));
+ }
+
+ @Test
+ @Order(17)
+ void scanWithScanFilterGE() {
+ given()
+ .header("X-Amz-Target", "DynamoDB_20120810.Scan")
+ .contentType(DYNAMODB_CONTENT_TYPE)
+ .body("""
+ {
+ "TableName": "TestTable",
+ "ScanFilter": {
+ "age": {
+ "AttributeValueList": [{"N": "30"}],
+ "ComparisonOperator": "GE"
+ }
+ }
+ }
+ """)
+ .when()
+ .post("/")
+ .then()
+ .statusCode(200)
+ .body("Count", equalTo(1))
+ .body("Items[0].name.S", equalTo("Alice"));
+ }
+
+ @Test
+ @Order(18)
void deleteItem() {
given()
.header("X-Amz-Target", "DynamoDB_20120810.DeleteItem")
@@ -474,7 +524,7 @@ class DynamoDbIntegrationTest {
}
@Test
- @Order(17)
+ @Order(19)
void deleteTable() {
given()
.header("X-Amz-Target", "DynamoDB_20120810.DeleteTable")
diff --git a/src/test/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbServiceTest.java b/src/test/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbServiceTest.java
index f49739773b..03f1ae7282 100644
--- a/src/test/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbServiceTest.java
+++ b/src/test/java/io/github/hectorvent/floci/services/dynamodb/DynamoDbServiceTest.java
@@ -333,10 +333,53 @@ class DynamoDbServiceTest {
service.putItem("Users", item("userId", "u2", "name", "Bob"));
service.putItem("Users", item("userId", "u3", "name", "Charlie"));
- DynamoDbService.ScanResult result = service.scan("Users", null, null, null, null, null);
+ DynamoDbService.ScanResult result = service.scan("Users", null, null, null, null, null, null);
assertEquals(3, result.items().size());
}
+ @Test
+ void scanWithScanFilter() {
+ createUsersTable();
+ service.putItem("Users", item("userId", "u1", "name", "Alice"));
+ service.putItem("Users", item("userId", "u2", "name", "Bob"));
+ service.putItem("Users", item("userId", "u3", "name", "Charlie"));
+
+ ObjectNode scanFilter = mapper.createObjectNode();
+ ObjectNode condition = mapper.createObjectNode();
+ condition.put("ComparisonOperator", "EQ");
+ var attrList = mapper.createArrayNode();
+ ObjectNode val = mapper.createObjectNode();
+ val.put("S", "Alice");
+ attrList.add(val);
+ condition.set("AttributeValueList", attrList);
+ scanFilter.set("name", condition);
+
+ DynamoDbService.ScanResult result = service.scan("Users", null, null, null, scanFilter, null, null);
+ assertEquals(1, result.items().size());
+ assertEquals("Alice", result.items().get(0).get("name").get("S").asText());
+ }
+
+ @Test
+ void scanWithScanFilterGE() {
+ createUsersTable();
+ service.putItem("Users", item("userId", "u1", "name", "Alice"));
+ service.putItem("Users", item("userId", "u2", "name", "Bob"));
+ service.putItem("Users", item("userId", "u3", "name", "Charlie"));
+
+ ObjectNode scanFilter = mapper.createObjectNode();
+ ObjectNode condition = mapper.createObjectNode();
+ condition.put("ComparisonOperator", "GE");
+ var attrList = mapper.createArrayNode();
+ ObjectNode val = mapper.createObjectNode();
+ val.put("S", "Bob");
+ attrList.add(val);
+ condition.set("AttributeValueList", attrList);
+ scanFilter.set("name", condition);
+
+ DynamoDbService.ScanResult result = service.scan("Users", null, null, null, scanFilter, null, null);
+ assertEquals(2, result.items().size());
+ }
+
@Test
void scanWithLimit() {
createUsersTable();
@@ -344,7 +387,7 @@ class DynamoDbServiceTest {
service.putItem("Users", item("userId", "u2"));
service.putItem("Users", item("userId", "u3"));
- DynamoDbService.ScanResult result = service.scan("Users", null, null, null, 2, null);
+ DynamoDbService.ScanResult result = service.scan("Users", null, null, null, null, 2, null);
assertEquals(2, result.items().size());
}
@@ -354,7 +397,7 @@ class DynamoDbServiceTest {
assertThrows(AwsException.class, () -> service.getItem("NoTable", item("id", "1")));
assertThrows(AwsException.class, () -> service.deleteItem("NoTable", item("id", "1")));
assertThrows(AwsException.class, () -> service.query("NoTable", null, null, null, null, null));
- assertThrows(AwsException.class, () -> service.scan("NoTable", null, null, null, null, null));
+ assertThrows(AwsException.class, () -> service.scan("NoTable", null, null, null, null, null, null));
}
@Test
@@ -531,7 +574,7 @@ class DynamoDbServiceTest {
ObjectNode exprValues = mapper.createObjectNode();
exprValues.set(":d", boolAttributeValue(true));
- DynamoDbService.ScanResult result = service.scan("Users", "deleted <> :d", null, exprValues, null, null);
+ DynamoDbService.ScanResult result = service.scan("Users", "deleted <> :d", null, exprValues, null, null, null);
assertEquals(2, result.items().size());
}
@@ -553,7 +596,7 @@ class DynamoDbServiceTest {
ObjectNode exprValues = mapper.createObjectNode();
exprValues.set(":v", attributeValue("S", "a"));
- DynamoDbService.ScanResult result = service.scan("Users", "contains(tags, :v)", null, exprValues, null, null);
+ DynamoDbService.ScanResult result = service.scan("Users", "contains(tags, :v)", null, exprValues, null, null, null);
assertEquals(2, result.items().size());
}
@@ -571,7 +614,7 @@ class DynamoDbServiceTest {
ObjectNode exprValues = mapper.createObjectNode();
exprValues.set(":r", attributeValue("S", "admin"));
- DynamoDbService.ScanResult result = service.scan("Users", "contains(roles, :r)", null, exprValues, null, null);
+ DynamoDbService.ScanResult result = service.scan("Users", "contains(roles, :r)", null, exprValues, null, null, null);
assertEquals(1, result.items().size());
}
@@ -596,10 +639,10 @@ class DynamoDbServiceTest {
ObjectNode exprNames = mapper.createObjectNode();
exprNames.put("#n", "name");
- DynamoDbService.ScanResult result = service.scan("Users", "attribute_exists(info.#n)", exprNames, null, null, null);
+ DynamoDbService.ScanResult result = service.scan("Users", "attribute_exists(info.#n)", exprNames, null, null, null, null);
assertEquals(2, result.items().size());
- DynamoDbService.ScanResult result2 = service.scan("Users", "attribute_not_exists(info.#n)", exprNames, null, null, null);
+ DynamoDbService.ScanResult result2 = service.scan("Users", "attribute_not_exists(info.#n)", exprNames, null, null, null, null);
assertEquals(1, result2.items().size());
}
@@ -672,7 +715,7 @@ class DynamoDbServiceTest {
ObjectNode exprValues = mapper.createObjectNode();
exprValues.set(":v", attributeValue("N", "1.0"));
- DynamoDbService.ScanResult result = service.scan("Users", "contains(scores, :v)", null, exprValues, null, null);
+ DynamoDbService.ScanResult result = service.scan("Users", "contains(scores, :v)", null, exprValues, null, null, null);
assertEquals(1, result.items().size(), "contains() on NS should match 1.0 == 1 numerically");
}
@@ -690,7 +733,7 @@ class DynamoDbServiceTest {
ObjectNode exprValues = mapper.createObjectNode();
exprValues.set(":v", attributeValue("B", "AQID"));
- DynamoDbService.ScanResult result = service.scan("Users", "contains(bins, :v)", null, exprValues, null, null);
+ DynamoDbService.ScanResult result = service.scan("Users", "contains(bins, :v)", null, exprValues, null, null, null);
assertEquals(1, result.items().size());
}
@@ -718,7 +761,7 @@ class DynamoDbServiceTest {
ObjectNode exprValues = mapper.createObjectNode();
exprValues.set(":v", attributeValue("N", "10.0"));
- DynamoDbService.ScanResult result = service.scan("Users", "contains(values, :v)", null, exprValues, null, null);
+ DynamoDbService.ScanResult result = service.scan("Users", "contains(values, :v)", null, exprValues, null, null, null);
assertEquals(1, result.items().size(), "contains() on List with N elements should use type-aware numeric comparison");
}
}