From 7a76d3eec53f74545bfd7a086d2ec2fc826dc5fe Mon Sep 17 00:00:00 2001 From: Aaron Morton Date: Wed, 24 Jul 2024 14:27:10 +1200 Subject: [PATCH 1/6] Added ValidatableCommandClause POC Encapsulates behavior for clauses that can be validated and better supports schema object types. --- .../command/ValidatableCommandClause.java | 128 ++++++++++++++++++ .../command/clause/filter/FilterClause.java | 42 +++--- .../model/command/clause/sort/SortClause.java | 41 +++--- .../FilterClauseDeserializer.java | 7 +- .../resolver/DeleteOneCommandResolver.java | 7 +- .../service/resolver/FindCommandResolver.java | 8 +- .../FindOneAndDeleteCommandResolver.java | 6 +- .../FindOneAndReplaceCommandResolver.java | 6 +- .../FindOneAndUpdateCommandResolver.java | 6 +- .../resolver/FindOneCommandResolver.java | 6 +- .../resolver/UpdateOneCommandResolver.java | 6 +- .../resolver/matcher/FilterableResolver.java | 8 +- .../sgv2/jsonapi/util/SortClauseUtil.java | 1 + 13 files changed, 193 insertions(+), 79 deletions(-) create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/api/model/command/ValidatableCommandClause.java diff --git a/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/ValidatableCommandClause.java b/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/ValidatableCommandClause.java new file mode 100644 index 0000000000..eab99aa2af --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/ValidatableCommandClause.java @@ -0,0 +1,128 @@ +package io.stargate.sgv2.jsonapi.api.model.command; + +import io.stargate.sgv2.jsonapi.service.cqldriver.executor.*; + +/** + * Interface for any clause of a {@link Command} to implement if it can be validated against a + * {@link SchemaObject}. + * + *

Code that wants to validate a clause should call {@link #maybeValidate(CommandContext, + * ValidatableCommandClause)} with the clause. + * + *

Example: + * + * 

+ *  ValidatableCommandClause.maybeValidate(commandContext, command.filterClause());
+ *
+ */ +public interface ValidatableCommandClause { + + /** + * Calls the supplied validatable clause to validate against the {@link SchemaObject} from the + * {@link CommandContext} using one of the dedicated validate*Command methods on the interface. + * + *

NOTE: Classes that want to validate a clause should call this method, not the non-static + * methods on the interface directly. + * + * @param commandContext The context the command is running against, including the {@link + * SchemaObject} + * @param validatable An object that implements {@link ValidatableCommandClause}, may be null + * @param Type of the {@link SchemaObject} + */ + static void maybeValidate( + CommandContext commandContext, ValidatableCommandClause validatable) { + if (validatable == null) { + return; + } + + switch (commandContext.schemaObject().type) { + case COLLECTION: + validatable.validateCollectionCommand(commandContext.asCollectionContext()); + break; + case TABLE: + validatable.validateTableCommand(commandContext.asTableContext()); + break; + case KEYSPACE: + validatable.validateNamespaceCommand(commandContext.asKeyspaceContext()); + break; + case DATABASE: + validatable.validateDatabaseCommand(commandContext.asDatabaseContext()); + break; + default: + throw new UnsupportedOperationException( + String.format("Unsupported schema type: %s", commandContext.schemaObject().type)); + } + } + + /** + * Implementations should implement this method if they support validation against a {@link + * CollectionSchemaObject}. + * + *

Only implement this method if the clause supports Collections, the default implementation is + * to fail. + * + * @param commandContext {@link CommandContext} to validate against + */ + default void validateCollectionCommand(CommandContext commandContext) { + // there error is a fallback to make sure it is implemented if it should be + // commands are tested well + throw new UnsupportedOperationException( + String.format( + "%s Clause does not support validating for Collections, target was %s", + getClass().getSimpleName(), commandContext.schemaObject().name)); + } + + /** + * Implementations should implement this method if they support validation against a {@link + * TableSchemaObject}. + * + *

Only implement this method if the clause supports Tables, the default implementation is to + * fail. + * + * @param commandContext {@link CommandContext} to validate against + */ + default void validateTableCommand(CommandContext commandContext) { + // there error is a fallback to make sure it is implemented if it should be + // commands are tested well + throw new UnsupportedOperationException( + String.format( + "%s Clause does not support validating for Tables, target was %s", + getClass().getSimpleName(), commandContext.schemaObject().name)); + } + + /** + * Implementations should implement this method if they support validation against a {@link + * KeyspaceSchemaObject}. + * + *

Only implement this method if the clause supports Keyspaces, the default implementation is + * to fail. + * + * @param commandContext {@link CommandContext} to validate against + */ + default void validateNamespaceCommand(CommandContext commandContext) { + // there error is a fallback to make sure it is implemented if it should be + // commands are tested well + throw new UnsupportedOperationException( + String.format( + "%s Clause does not support validating for Namespaces, target was %s", + getClass().getSimpleName(), commandContext.schemaObject().name)); + } + + /** + * Implementations should implement this method if they support validation against a {@link + * DatabaseSchemaObject}. + * + *

Only implement this method if the clause supports Databases, the default implementation is + * to fail. + * + * @param commandContext {@link CommandContext} to validate against + */ + default void validateDatabaseCommand(CommandContext commandContext) { + // there error is a fallback to make sure it is implemented if it should be + // commands are tested well + throw new UnsupportedOperationException( + String.format( + "%s Clause does not support validating for Databases, target was %s", + getClass().getSimpleName(), commandContext.schemaObject().name)); + } +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/filter/FilterClause.java b/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/filter/FilterClause.java index 85d20f2739..8c79a37248 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/filter/FilterClause.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/filter/FilterClause.java @@ -2,6 +2,7 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; +import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; import io.stargate.sgv2.jsonapi.api.model.command.deserializers.FilterClauseDeserializer; import io.stargate.sgv2.jsonapi.config.constants.DocumentConstants; import io.stargate.sgv2.jsonapi.exception.ErrorCode; @@ -20,35 +21,32 @@ """ {"name": "Aaron", "country": "US"} """) -public record FilterClause(LogicalExpression logicalExpression) { +public record FilterClause(LogicalExpression logicalExpression) + implements ValidatableCommandClause { - public void validate(CommandContext commandContext) { + @Override + public void validateCollectionCommand(CommandContext commandContext) { - if (commandContext.schemaObject().type != CollectionSchemaObject.TYPE) { - return; - } - - IndexingProjector indexingProjector = - commandContext.asCollectionContext().schemaObject().indexingProjector(); + IndexingProjector indexingProjector = commandContext.schemaObject().indexingProjector(); // If nothing specified, everything indexed if (indexingProjector.isIdentityProjection()) { return; } - validateLogicalExpression(logicalExpression, indexingProjector); + validateCollectionLogicalExpression(logicalExpression, indexingProjector); } - public void validateLogicalExpression( + private void validateCollectionLogicalExpression( LogicalExpression logicalExpression, IndexingProjector indexingProjector) { for (LogicalExpression subLogicalExpression : logicalExpression.logicalExpressions) { - validateLogicalExpression(subLogicalExpression, indexingProjector); + validateCollectionLogicalExpression(subLogicalExpression, indexingProjector); } for (ComparisonExpression subComparisonExpression : logicalExpression.comparisonExpressions) { - validateComparisonExpression(subComparisonExpression, indexingProjector); + validateCollectionComparisonExpression(subComparisonExpression, indexingProjector); } } - public void validateComparisonExpression( + private void validateCollectionComparisonExpression( ComparisonExpression comparisonExpression, IndexingProjector indexingProjector) { String path = comparisonExpression.getPath(); boolean isPathIndexed = @@ -79,15 +77,16 @@ public void validateComparisonExpression( // If path is an object (like address), validate the incremental path (like address.city) if (operand.type() == JsonType.ARRAY || operand.type() == JsonType.SUB_DOC) { if (operand.value() instanceof Map map) { - validateMap(indexingProjector, map, path); + validateCollectionMap(indexingProjector, map, path); } if (operand.value() instanceof List list) { - validateList(indexingProjector, list, path); + validateCollectionList(indexingProjector, list, path); } } } - private void validateMap(IndexingProjector indexingProjector, Map map, String currentPath) { + private void validateCollectionMap( + IndexingProjector indexingProjector, Map map, String currentPath) { for (Map.Entry entry : map.entrySet()) { String incrementalPath = currentPath + "." + entry.getKey(); if (!indexingProjector.isPathIncluded(incrementalPath)) { @@ -96,21 +95,22 @@ private void validateMap(IndexingProjector indexingProjector, Map map, Str } // continue build the incremental path if the value is a map if (entry.getValue() instanceof Map valueMap) { - validateMap(indexingProjector, valueMap, incrementalPath); + validateCollectionMap(indexingProjector, valueMap, incrementalPath); } // continue build the incremental path if the value is a list if (entry.getValue() instanceof List list) { - validateList(indexingProjector, list, incrementalPath); + validateCollectionList(indexingProjector, list, incrementalPath); } } } - private void validateList(IndexingProjector indexingProjector, List list, String currentPath) { + private void validateCollectionList( + IndexingProjector indexingProjector, List list, String currentPath) { for (Object element : list) { if (element instanceof Map map) { - validateMap(indexingProjector, map, currentPath); + validateCollectionMap(indexingProjector, map, currentPath); } else if (element instanceof List sublList) { - validateList(indexingProjector, sublList, currentPath); + validateCollectionList(indexingProjector, sublList, currentPath); } else if (element instanceof String) { // no need to build incremental path, validate current path if (!indexingProjector.isPathIncluded(currentPath)) { diff --git a/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/sort/SortClause.java b/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/sort/SortClause.java index 9fb9a7c6a1..31db2bfb70 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/sort/SortClause.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/sort/SortClause.java @@ -2,9 +2,11 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; +import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; import io.stargate.sgv2.jsonapi.api.model.command.deserializers.SortClauseDeserializer; import io.stargate.sgv2.jsonapi.config.constants.DocumentConstants; import io.stargate.sgv2.jsonapi.exception.ErrorCode; +import io.stargate.sgv2.jsonapi.service.cqldriver.executor.CollectionSchemaObject; import io.stargate.sgv2.jsonapi.service.projection.IndexingProjector; import jakarta.validation.Valid; import java.util.List; @@ -25,7 +27,8 @@ """ {"user.age" : -1, "user.name" : 1} """) -public record SortClause(@Valid List sortExpressions) { +public record SortClause(@Valid List sortExpressions) + implements ValidatableCommandClause { public boolean hasVsearchClause() { return sortExpressions != null @@ -42,28 +45,20 @@ public boolean hasVectorizeSearchClause() { .equals(DocumentConstants.Fields.VECTOR_EMBEDDING_TEXT_FIELD); } - public void validate(CommandContext commandContext) { - - switch (commandContext.schemaObject().type) { - case COLLECTION: - IndexingProjector indexingProjector = - commandContext.asCollectionContext().schemaObject().indexingProjector(); - // If nothing specified, everything indexed - if (indexingProjector.isIdentityProjection()) { - return; - } - // validate each path in sortExpressions - for (SortExpression sortExpression : sortExpressions) { - if (!indexingProjector.isPathIncluded(sortExpression.path())) { - throw ErrorCode.UNINDEXED_SORT_PATH.toApiException( - "sort path '%s' is not indexed", sortExpression.path()); - } - } - break; - default: - throw ErrorCode.SERVER_INTERNAL_ERROR.toApiException( - "SortClause validation is not supported for schemaObject type: %s", - commandContext.schemaObject().type); + @Override + public void validateCollectionCommand(CommandContext commandContext) { + IndexingProjector indexingProjector = + commandContext.asCollectionContext().schemaObject().indexingProjector(); + // If nothing specified, everything indexed + if (indexingProjector.isIdentityProjection()) { + return; + } + // validate each path in sortExpressions + for (SortExpression sortExpression : sortExpressions) { + if (!indexingProjector.isPathIncluded(sortExpression.path())) { + throw ErrorCode.UNINDEXED_SORT_PATH.toApiException( + "sort path '%s' is not indexed", sortExpression.path()); + } } } } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/deserializers/FilterClauseDeserializer.java b/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/deserializers/FilterClauseDeserializer.java index e3266e889c..3de1dda7b5 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/deserializers/FilterClauseDeserializer.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/deserializers/FilterClauseDeserializer.java @@ -22,7 +22,12 @@ import java.util.*; import org.eclipse.microprofile.config.ConfigProvider; -/** {@link StdDeserializer} for the {@link FilterClause}. */ +/** + * {@link StdDeserializer} for the {@link FilterClause}. + * + *

TIDY: this class has a lot of string constants for filter operations that we have defined as + * constants elsewhere + */ public class FilterClauseDeserializer extends StdDeserializer { private final OperationsConfig operationsConfig; diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteOneCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteOneCommandResolver.java index aa24f093a5..62f16513ef 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteOneCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteOneCommandResolver.java @@ -3,6 +3,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import io.micrometer.core.instrument.MeterRegistry; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; +import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.LogicalExpression; import io.stargate.sgv2.jsonapi.api.model.command.clause.sort.SortClause; import io.stargate.sgv2.jsonapi.api.model.command.impl.DeleteOneCommand; @@ -68,11 +69,9 @@ private FindCollectionOperation getFindOperation( CommandContext commandContext, DeleteOneCommand command) { LogicalExpression logicalExpression = resolve(commandContext, command); + final SortClause sortClause = command.sortClause(); - // validate sort path - if (sortClause != null) { - sortClause.validate(commandContext); - } + ValidatableCommandClause.maybeValidate(commandContext, sortClause); float[] vector = SortClauseUtil.resolveVsearch(sortClause); var indexUsage = commandContext.schemaObject().newCollectionIndexUsage(); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java index 8a83910a58..e9b4f9b4c3 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java @@ -3,6 +3,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import io.micrometer.core.instrument.MeterRegistry; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; +import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.LogicalExpression; import io.stargate.sgv2.jsonapi.api.model.command.clause.sort.SortClause; import io.stargate.sgv2.jsonapi.api.model.command.impl.FindCommand; @@ -93,13 +94,8 @@ public Operation resolveCollectionCommand( includeSortVector = options.includeSortVector(); } - // resolve sort clause SortClause sortClause = command.sortClause(); - - // validate sort path - if (sortClause != null) { - sortClause.validate(ctx); - } + ValidatableCommandClause.maybeValidate(ctx, sortClause); // if vector search float[] vector = SortClauseUtil.resolveVsearch(sortClause); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndDeleteCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndDeleteCommandResolver.java index dec6f58ad4..95187f9b6b 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndDeleteCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndDeleteCommandResolver.java @@ -3,6 +3,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import io.micrometer.core.instrument.MeterRegistry; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; +import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.LogicalExpression; import io.stargate.sgv2.jsonapi.api.model.command.clause.sort.SortClause; import io.stargate.sgv2.jsonapi.api.model.command.impl.FindOneAndDeleteCommand; @@ -71,10 +72,7 @@ private FindCollectionOperation getFindOperation( LogicalExpression logicalExpression = resolve(commandContext, command); final SortClause sortClause = command.sortClause(); - // validate sort path - if (sortClause != null) { - sortClause.validate(commandContext); - } + ValidatableCommandClause.maybeValidate(commandContext, sortClause); float[] vector = SortClauseUtil.resolveVsearch(sortClause); var indexUsage = commandContext.schemaObject().newCollectionIndexUsage(); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndReplaceCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndReplaceCommandResolver.java index 33f56dc2af..1ceb116ba5 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndReplaceCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndReplaceCommandResolver.java @@ -3,6 +3,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import io.micrometer.core.instrument.MeterRegistry; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; +import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.LogicalExpression; import io.stargate.sgv2.jsonapi.api.model.command.clause.sort.SortClause; import io.stargate.sgv2.jsonapi.api.model.command.impl.FindOneAndReplaceCommand; @@ -89,10 +90,7 @@ private FindCollectionOperation getFindOperation( LogicalExpression logicalExpression = resolve(ctx, command); final SortClause sortClause = command.sortClause(); - // validate sort path - if (sortClause != null) { - sortClause.validate(ctx); - } + ValidatableCommandClause.maybeValidate(ctx, sortClause); float[] vector = SortClauseUtil.resolveVsearch(sortClause); var indexUsage = ctx.schemaObject().newCollectionIndexUsage(); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndUpdateCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndUpdateCommandResolver.java index e8a332509f..46d25d9cd2 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndUpdateCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndUpdateCommandResolver.java @@ -3,6 +3,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import io.micrometer.core.instrument.MeterRegistry; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; +import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.LogicalExpression; import io.stargate.sgv2.jsonapi.api.model.command.clause.sort.SortClause; import io.stargate.sgv2.jsonapi.api.model.command.impl.FindOneAndUpdateCommand; @@ -91,10 +92,7 @@ private FindCollectionOperation getFindOperation( LogicalExpression logicalExpression = resolve(commandContext, command); final SortClause sortClause = command.sortClause(); - // validate sort path - if (sortClause != null) { - sortClause.validate(commandContext); - } + ValidatableCommandClause.maybeValidate(commandContext, sortClause); float[] vector = SortClauseUtil.resolveVsearch(sortClause); var indexUsage = commandContext.schemaObject().newCollectionIndexUsage(); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java index d2d4e65323..809137e489 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java @@ -3,6 +3,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import io.micrometer.core.instrument.MeterRegistry; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; +import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.LogicalExpression; import io.stargate.sgv2.jsonapi.api.model.command.clause.sort.SortClause; import io.stargate.sgv2.jsonapi.api.model.command.impl.FindOneCommand; @@ -66,10 +67,7 @@ public Operation resolveCollectionCommand( LogicalExpression logicalExpression = resolve(ctx, command); final SortClause sortClause = command.sortClause(); - // validate sort path - if (sortClause != null) { - sortClause.validate(ctx); - } + ValidatableCommandClause.maybeValidate(ctx, sortClause); float[] vector = SortClauseUtil.resolveVsearch(sortClause); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateOneCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateOneCommandResolver.java index 12ad774789..f7b7d22456 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateOneCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateOneCommandResolver.java @@ -3,6 +3,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import io.micrometer.core.instrument.MeterRegistry; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; +import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.LogicalExpression; import io.stargate.sgv2.jsonapi.api.model.command.clause.sort.SortClause; import io.stargate.sgv2.jsonapi.api.model.command.impl.UpdateOneCommand; @@ -87,10 +88,7 @@ private FindCollectionOperation getFindOperation( LogicalExpression logicalExpression = resolve(ctx, command); final SortClause sortClause = command.sortClause(); - // validate sort path - if (sortClause != null) { - sortClause.validate(ctx); - } + ValidatableCommandClause.maybeValidate(ctx, sortClause); float[] vector = SortClauseUtil.resolveVsearch(sortClause); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterableResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterableResolver.java index 9cd91b82e5..e8e7983389 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterableResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterableResolver.java @@ -3,6 +3,7 @@ import io.stargate.sgv2.jsonapi.api.model.command.Command; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; import io.stargate.sgv2.jsonapi.api.model.command.Filterable; +import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.*; import io.stargate.sgv2.jsonapi.config.OperationsConfig; import io.stargate.sgv2.jsonapi.config.constants.DocumentConstants; @@ -142,10 +143,9 @@ public FilterableResolver() { } protected LogicalExpression resolve(CommandContext commandContext, T command) { - // verify if filter fields are in deny list or not in allow list - if (commandContext != null && command.filterClause() != null) { - command.filterClause().validate(commandContext); - } + + ValidatableCommandClause.maybeValidate(commandContext, command.filterClause()); + LogicalExpression filter = matchRules.apply(commandContext, command); if (filter.getTotalComparisonExpressionCount() > operationsConfig.maxFilterObjectProperties()) { throw ErrorCode.FILTER_FIELDS_LIMIT_VIOLATION.toApiException( diff --git a/src/main/java/io/stargate/sgv2/jsonapi/util/SortClauseUtil.java b/src/main/java/io/stargate/sgv2/jsonapi/util/SortClauseUtil.java index 268f73fe0d..9175ffc903 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/util/SortClauseUtil.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/util/SortClauseUtil.java @@ -5,6 +5,7 @@ import java.util.List; import java.util.stream.Collectors; +// TIDY : rename or refactor to remove a "Util" class, this probably has a better home public class SortClauseUtil { public static List resolveOrderBy(SortClause sortClause) { if (sortClause == null || sortClause.sortExpressions().isEmpty()) return null; From e76652103ae237893d2f94493fe0450a4223dbbd Mon Sep 17 00:00:00 2001 From: Aaron Morton Date: Fri, 26 Jul 2024 09:54:24 +1200 Subject: [PATCH 2/6] POC for table filters with codecs for findOne This PR refactors how we process filters by moving the base class FilterableResolver that was used by command resolvers to be standalone class FilterResolver that has CollectionFilterResolver and TableFilterResolver subclasses. The changes to the resolvers are mostly to handle this change, other than findOne. The next part is findOne updated to process the filter for a table. Using the TableFilterResolver to make filters, which then use the NativeTypeTableFilter and JSONCodec to map from the types used for JSOn into what CQL expects. This is POC work, we then need to expand this to handle all the situations we expect. --- .../command/clause/filter/FilterClause.java | 7 + .../cqldriver/executor/NamespaceCache.java | 2 +- .../cqldriver/executor/TableSchemaObject.java | 19 ++- .../builder/BuiltConditionPredicate.java | 7 +- .../filters/table/ColumnTableFilter.java | 36 ----- .../filters/table/NativeTypeTableFilter.java | 126 ++++++++++++++++ .../filters/table/NumberTableFilter.java | 7 +- .../operation/filters/table/TableFilter.java | 33 ++++- .../filters/table/TextTableFilter.java | 9 ++ .../table/codecs/FromJavaCodecException.java | 24 ++++ .../filters/table/codecs/JSONCodec.java | 135 ++++++++++++++++++ .../table/codecs/JSONCodecRegistry.java | 113 +++++++++++++++ .../operation/tables/FindTableOperation.java | 48 +++++-- .../CountDocumentsCommandResolver.java | 11 +- .../resolver/DeleteManyCommandResolver.java | 16 ++- .../resolver/DeleteOneCommandResolver.java | 12 +- .../service/resolver/FindCommandResolver.java | 15 +- .../FindOneAndDeleteCommandResolver.java | 12 +- .../FindOneAndReplaceCommandResolver.java | 11 +- .../FindOneAndUpdateCommandResolver.java | 11 +- .../resolver/FindOneCommandResolver.java | 16 ++- .../resolver/UpdateManyCommandResolver.java | 12 +- .../resolver/UpdateOneCommandResolver.java | 11 +- ...ver.java => CollectionFilterResolver.java} | 55 ++++--- .../resolver/matcher/FilterMatchRules.java | 10 +- .../resolver/matcher/FilterResolver.java | 72 ++++++++++ .../resolver/matcher/TableFilterResolver.java | 92 ++++++++++++ .../matcher/FilterMatchRulesTest.java | 4 +- .../resolver/matcher/FilterMatcherTest.java | 23 +-- 29 files changed, 800 insertions(+), 149 deletions(-) delete mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/ColumnTableFilter.java create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/TextTableFilter.java create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/FromJavaCodecException.java create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java rename src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/{FilterableResolver.java => CollectionFilterResolver.java} (89%) create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterResolver.java create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/TableFilterResolver.java diff --git a/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/filter/FilterClause.java b/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/filter/FilterClause.java index 8c79a37248..45b1bb9d82 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/filter/FilterClause.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/api/model/command/clause/filter/FilterClause.java @@ -7,6 +7,7 @@ import io.stargate.sgv2.jsonapi.config.constants.DocumentConstants; import io.stargate.sgv2.jsonapi.exception.ErrorCode; import io.stargate.sgv2.jsonapi.service.cqldriver.executor.CollectionSchemaObject; +import io.stargate.sgv2.jsonapi.service.cqldriver.executor.TableSchemaObject; import io.stargate.sgv2.jsonapi.service.projection.IndexingProjector; import java.util.List; import java.util.Map; @@ -24,6 +25,12 @@ public record FilterClause(LogicalExpression logicalExpression) implements ValidatableCommandClause { + @Override + public void validateTableCommand(CommandContext commandContext) { + // TODO HACK AARON - this is a temporary fix to allow the tests to pass + return; + } + @Override public void validateCollectionCommand(CommandContext commandContext) { diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/cqldriver/executor/NamespaceCache.java b/src/main/java/io/stargate/sgv2/jsonapi/service/cqldriver/executor/NamespaceCache.java index 0871db86a6..d1e3b00478 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/cqldriver/executor/NamespaceCache.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/cqldriver/executor/NamespaceCache.java @@ -109,7 +109,7 @@ private Uni loadSchemaObject( } if (apiTablesEnabled) { - return new TableSchemaObject(namespace, collectionName); + return new TableSchemaObject(table); } // Target is not a collection and we are not supporting tables diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/cqldriver/executor/TableSchemaObject.java b/src/main/java/io/stargate/sgv2/jsonapi/service/cqldriver/executor/TableSchemaObject.java index 6587929b0b..23e9986240 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/cqldriver/executor/TableSchemaObject.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/cqldriver/executor/TableSchemaObject.java @@ -1,21 +1,26 @@ package io.stargate.sgv2.jsonapi.service.cqldriver.executor; +import com.datastax.oss.driver.api.core.metadata.schema.TableMetadata; + public class TableSchemaObject extends SchemaObject { public static final SchemaObjectType TYPE = SchemaObjectType.TABLE; /** Represents missing schema, e.g. when we are running a create table. */ - public static final TableSchemaObject MISSING = new TableSchemaObject(SchemaObjectName.MISSING); + // public static final TableSchemaObject MISSING = new + // TableSchemaObject(SchemaObjectName.MISSING); + + public final TableMetadata tableMetadata; // TODO: hold the table meta data, need to work out how we handle mock tables in test etc. // public final TableMetadata tableMetadata; - public TableSchemaObject(String keyspace, String name) { - this(new SchemaObjectName(keyspace, name)); - } - - public TableSchemaObject(SchemaObjectName name) { - super(TYPE, name); + public TableSchemaObject(TableMetadata tableMetadata) { + super( + TYPE, + new SchemaObjectName( + tableMetadata.getKeyspace().asCql(false), tableMetadata.getName().asCql(false))); + this.tableMetadata = tableMetadata; } @Override diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/builder/BuiltConditionPredicate.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/builder/BuiltConditionPredicate.java index 9af5c22128..b283cf256a 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/builder/BuiltConditionPredicate.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/builder/BuiltConditionPredicate.java @@ -10,15 +10,16 @@ public enum BuiltConditionPredicate { IN("IN"), CONTAINS("CONTAINS"), NOT_CONTAINS("NOT CONTAINS"), - CONTAINS_KEY("CONTAINS KEY"), - ; + CONTAINS_KEY("CONTAINS KEY"); - private final String cql; + public final String cql; BuiltConditionPredicate(String cql) { this.cql = cql; } + // TIDY - remove this use of toString() it should be used for log msg's etc, not core + // functionality. This is called to build the CQL string we execute. @Override public String toString() { return cql; diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/ColumnTableFilter.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/ColumnTableFilter.java deleted file mode 100644 index 86b78d164d..0000000000 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/ColumnTableFilter.java +++ /dev/null @@ -1,36 +0,0 @@ -package io.stargate.sgv2.jsonapi.service.operation.filters.table; - -import io.stargate.sgv2.jsonapi.service.operation.builder.BuiltCondition; -import io.stargate.sgv2.jsonapi.service.operation.builder.BuiltConditionPredicate; -import io.stargate.sgv2.jsonapi.service.operation.builder.LiteralTerm; - -abstract class ColumnTableFilter extends TableFilter { - - /** The operations that can be performed to filter a column */ - public enum Operator { - EQ(BuiltConditionPredicate.EQ); - - final BuiltConditionPredicate predicate; - - Operator(BuiltConditionPredicate predicate) { - this.predicate = predicate; - } - } - - protected final Operator operator; - protected final T columnValue; - protected final LiteralTerm columnValueTerm; - - protected ColumnTableFilter(String path, Operator operator, T columnValue) { - super(path); - this.columnValue = columnValue; - this.columnValueTerm = new LiteralTerm<>(columnValue); - this.operator = operator; - } - - @Override - public BuiltCondition get() { - - return BuiltCondition.of(path, operator.predicate, columnValueTerm); - } -} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java new file mode 100644 index 0000000000..8480a1022b --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java @@ -0,0 +1,126 @@ +package io.stargate.sgv2.jsonapi.service.operation.filters.table; + +import static com.datastax.oss.driver.api.querybuilder.QueryBuilder.bindMarker; + +import com.datastax.oss.driver.api.querybuilder.relation.Relation; +import com.datastax.oss.driver.api.querybuilder.select.Select; +import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.ValueComparisonOperator; +import io.stargate.sgv2.jsonapi.service.cqldriver.executor.TableSchemaObject; +import io.stargate.sgv2.jsonapi.service.operation.builder.BuiltCondition; +import io.stargate.sgv2.jsonapi.service.operation.builder.BuiltConditionPredicate; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.FromJavaCodecException; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.JSONCodecRegistry; +import java.util.List; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * A DB Filter that can be applied on columns in a CQL Tables that use the `native-type` 's as + * defined in the CQL specification. + * + * 

+ *    ::= ascii
+ *                 | bigint
+ *                 | blob
+ *                 | boolean
+ *                 | counter
+ *                 | date
+ *                 | decimal
+ *                 | double
+ *                 | duration
+ *                 | float
+ *                 | inet
+ *                 | int
+ *                 | smallint
+ *                 | text
+ *                 | time
+ *                 | timestamp
+ *                 | timeuuid
+ *                 | tinyint
+ *                 | uuid
+ *                 | varchar
+ *                 | varint
+ *
+ * + * @param The JSON Type , BigDecimal, String etc + */ +public abstract class NativeTypeTableFilter extends TableFilter { + + private static final Logger LOGGER = LoggerFactory.getLogger(NativeTypeTableFilter.class); + + /** + * The operations that can be performed to filter a column TIDY: we have operations defined in + * multiple places, once we have refactored the collection operations we should centralize these + * operator definitions + */ + public enum Operator { + EQ(BuiltConditionPredicate.EQ), + LT(BuiltConditionPredicate.LT), + GT(BuiltConditionPredicate.GT), + LTE(BuiltConditionPredicate.LTE), + GTE(BuiltConditionPredicate.GTE); + + final BuiltConditionPredicate predicate; + + Operator(BuiltConditionPredicate predicate) { + this.predicate = predicate; + } + + public static Operator from(ValueComparisonOperator operator) { + return switch (operator) { + case EQ -> EQ; + case GT -> GT; + case GTE -> GTE; + case LT -> LT; + case LTE -> LTE; + default -> throw new IllegalArgumentException("Unsupported operator: " + operator); + }; + } + } + + protected final Operator operator; + protected final T columnValue; + + protected NativeTypeTableFilter(String path, Operator operator, T columnValue) { + super(path); + this.columnValue = columnValue; + this.operator = operator; + } + + @Override + public BuiltCondition get() { + throw new UnsupportedOperationException( + "No supported - will be modified when we migrate collections filters java driver"); + } + + @Override + public Select apply( + TableSchemaObject tableSchemaObject, Select select, List positionalValues) { + + // TODO: AARON return the correct errors, this is POC work now + var column = + tableSchemaObject + .tableMetadata + .getColumn(path) + .orElseThrow(() -> new IllegalArgumentException("Column not found: " + path)); + + var codec = + JSONCodecRegistry.codecFor(column.getType(), columnValue) + .orElseThrow( + () -> + new RuntimeException( + String.format( + "No Codec for a value of type %s with table column %s it has CQL type %s", + columnValue.getClass(), + column.getName(), + column.getType().asCql(true, false)))); + + try { + positionalValues.add(codec.apply(columnValue)); + } catch (FromJavaCodecException e) { + throw new RuntimeException("Error applying codec", e); + } + + return select.where(Relation.column(path).build(operator.predicate.cql, bindMarker())); + } +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NumberTableFilter.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NumberTableFilter.java index c0523423a6..eb27916791 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NumberTableFilter.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NumberTableFilter.java @@ -1,8 +1,11 @@ package io.stargate.sgv2.jsonapi.service.operation.filters.table; -public class NumberTableFilter extends ColumnTableFilter { +import java.math.BigDecimal; - public NumberTableFilter(String path, Operator operator, T value) { +/** Filter to use any JSON number against a table column. */ +public class NumberTableFilter extends NativeTypeTableFilter { + + public NumberTableFilter(String path, Operator operator, BigDecimal value) { super(path, operator, value); } } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/TableFilter.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/TableFilter.java index 86e64440b6..15c959d98a 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/TableFilter.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/TableFilter.java @@ -1,11 +1,42 @@ package io.stargate.sgv2.jsonapi.service.operation.filters.table; +import com.datastax.oss.driver.api.querybuilder.select.Select; import io.stargate.sgv2.jsonapi.service.cqldriver.executor.IndexUsage; +import io.stargate.sgv2.jsonapi.service.cqldriver.executor.TableSchemaObject; import io.stargate.sgv2.jsonapi.service.operation.filters.DBFilterBase; +import java.util.List; +/** + * A {@link DBFilterBase} that is applied to a table (i.e. not a Collection) to filter the rows to + * read. + */ public abstract class TableFilter extends DBFilterBase { - // TODO- the path is the column name here, maybe rename ? + + // TIDY - the path is the column name here, maybe rename ? protected TableFilter(String path) { super(path, IndexUsage.NO_OP); } + + /** + * Call to have the filter applied to the select statement using the {@link + * com.datastax.oss.driver.api.querybuilder.QueryBuilder} from the Java driver. + * + *

NOTE: use this method rather than {@link DBFilterBase#get()} which is build to work with the + * old gRPC bridge query builder. + * + *

TIDY: Refactor DBFilterBase to use this method when we move collection filters to use the + * java driver. + * + * @param tableSchemaObject The table the filter is being applied to. + * @param select The select statement to apply the filter to, see docs for {@link + * com.datastax.oss.driver.api.querybuilder.QueryBuilder} + * @param positionalValues Mutatable array of values that are used when the {@link + * com.datastax.oss.driver.api.querybuilder.QueryBuilder#bindMarker()} method is used, the + * values are added to the select statement using {@link Select#build(Object...)} + * @return The {@link Select} to use to continue building the query. NOTE: the query builder is a + * fluent builder that returns immutable that are used in a chain, see the + * https://docs.datastax.com/en/developer/java-driver/4.3/manual/query_builder/index.html + */ + public abstract Select apply( + TableSchemaObject tableSchemaObject, Select select, List positionalValues); } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/TextTableFilter.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/TextTableFilter.java new file mode 100644 index 0000000000..58b2c0bda3 --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/TextTableFilter.java @@ -0,0 +1,9 @@ +package io.stargate.sgv2.jsonapi.service.operation.filters.table; + +/** Filter to use any JSON string value against a table column. */ +public class TextTableFilter extends NativeTypeTableFilter { + + public TextTableFilter(String path, Operator operator, String value) { + super(path, operator, value); + } +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/FromJavaCodecException.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/FromJavaCodecException.java new file mode 100644 index 0000000000..dfa21ae264 --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/FromJavaCodecException.java @@ -0,0 +1,24 @@ +package io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs; + +import com.datastax.oss.driver.api.core.type.DataType; + +public class FromJavaCodecException extends Exception { + + public final Object value; + public final DataType targetCQLType; + + /** + * TODO: confirm we want / need this, the idea is to encapsulate any exception when doing the + * conversion to to the type CQL expects. This would be a checked exception, and not something we + * expect to return to the user + * + * @param value + * @param targetCQLType + * @param cause + */ + public FromJavaCodecException(Object value, DataType targetCQLType, Exception cause) { + super("Error trying to convert value " + value + " to " + targetCQLType, cause); + this.value = value; + this.targetCQLType = targetCQLType; + } +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java new file mode 100644 index 0000000000..53d4a7cfd3 --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java @@ -0,0 +1,135 @@ +package io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs; + +import com.datastax.oss.driver.api.core.type.DataType; +import com.datastax.oss.driver.api.core.type.reflect.GenericType; +import java.util.function.BiPredicate; +import java.util.function.Function; + +/** + * Handles the conversation between the in memory Java representation of a value from a JSON + * document and the Java type that the driver expects for the CQL type of the column. + * + *

This is codec sitting above the codec the Java C* driver uses. + * + *

The path is: + * + *

    + *
  • JSON Document + *
  • Jackson parses and turns into Java Object (e.g. BigInteger) + *
  • JSONCodec (this class) turns Java Object into the Java type the C* driver expects (e.g. + * Short + *
  • C* driver codec turns Java type into C* type + *
+ * + * TODO: expand this idea to be map to and from the CQL representation, we can use it to build the + * JSON doc from reading a row and to use it for writing a row. + * + * @param javaType {@link GenericType} of the Java object that needs to be transformed into the type + * CQL expects. + * @param targetCQLType {@link DataType} of the CQL column type the Java object needs to be + * transformed into. + * @param fromJava Function that transforms the Java object into the CQL object + * @param The type of the Java object that needs to be transformed into the type CQL expects + * @param The type Java object the CQL driver expects + */ +public record JSONCodec( + GenericType javaType, DataType targetCQLType, FromJava fromJava) + implements BiPredicate { + + /** + * Call to check if this codec can convert the type of the `value` into the type needed for a + * column of the `targetCQLType`. + * + *

Used to filter the list of codecs to find one that works, which can then be unchecked cast + * using {@link JSONCodec#unchecked(JSONCodec)} + * + * @param targetCQLType {@link DataType} of the CQL column the value will be written to. + * @param value Instance of a Java value that will be written to the column. + * @return True if the codec can convert the value into the type needed for the column. + */ + @Override + public boolean test(DataType targetCQLType, Object value) { + // java value tests comes from TypeCodec.accepts(Object value) in the driver + return this.targetCQLType.equals(targetCQLType) + && javaType.getRawType().isAssignableFrom(value.getClass()); + } + + /** + * Applies the codec to the value. + * + * @param value Json value of type {@link JavaT} that needs to be transformed into the type CQL + * expects. + * @return Value of type {@link CqlT} that the CQL driver expects. + * @throws FromJavaCodecException if there was an error converting the value. + */ + public CqlT apply(JavaT value) throws FromJavaCodecException { + return fromJava.apply(value, targetCQLType); + } + + @SuppressWarnings("unchecked") + public static JSONCodec unchecked(JSONCodec codec) { + return (JSONCodec) codec; + } + + /** + * Function interface that is used by the codec to convert the Java value to the value CQL + * expects. + * + *

The interface is used so the conversation function can throw the checked {@link + * FromJavaCodecException} and the function is also passed the target type so it can construct a + * better exception. + * + *

Use the static constructors on the interface to get instances, see it's use in the {@link + * JSONCodecRegistry} + * + * @param The type of the Java object that needs to be transformed into the type CQL expects + * @param The type Java object the CQL driver expects + */ + @FunctionalInterface + public interface FromJava { + + /** + * Convers the current Java value to the type CQL expects. + * + * @param t + * @param targetType The type of the CQL column the value will be written to, passed so it can + * be used when creating an exception if there was a error doing the transformation. + * @return + * @throws FromJavaCodecException + */ + R apply(T t, DataType targetType) throws FromJavaCodecException; + + /** + * Returns an instance that just returns the value passed in, the same as {@link + * Function#identity()} + * + *

Unsafe because it does not catch any errors from the conversion, because there are none. + * + * @return + * @param + */ + static FromJava unsafeIdentity() { + return (t, targetType) -> t; + } + + /** + * Returns an instance that converts the value to the target type, catching any arithmetic + * exceptions and throwing them as a {@link FromJavaCodecException} + * + * @param function the function that does the conversion, it is expected it may throw a {@link + * ArithmeticException} + * @return + * @param + * @param + */ + static FromJava safeNumber(Function function) { + return (t, targetType) -> { + try { + return function.apply(t); + } catch (ArithmeticException e) { + throw new FromJavaCodecException(t, targetType, e); + } + }; + } + } +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java new file mode 100644 index 0000000000..ea1467d72c --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java @@ -0,0 +1,113 @@ +package io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs; + +import com.datastax.oss.driver.api.core.type.DataType; +import com.datastax.oss.driver.api.core.type.DataTypes; +import com.datastax.oss.driver.api.core.type.reflect.GenericType; +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.List; +import java.util.Optional; + +/** + * Builds and manages the {@link JSONCodec} instances that are used to convert Java objects into the + * objects expected by the CQL driver for specific CQL data types. + * + *

See {@link #codecFor(DataType, Object)} + * + *

IMPORTANT: There must be a codec for every CQL data type we want to write to, even if the + * translation is an identity translation. This is so we know if the translation can happen, and + * then if it was done correctly with the actual value. See {@link + * JSONCodec.FromJava#unsafeIdentity()} for the identity mapping, and example usage in {@link #TEXT} + * codec. + */ +public class JSONCodecRegistry { + + // Internal list of all codes + // IMPORTANT: any codec must be added to the list to be available to {@ink #codecFor(DataType, + // Object)} + // They are added in a static block at the end of the file + private static final List> CODECS; + + /** + * Returns a codec that can convert a Java object into the object expected by the CQL driver for a + * specific CQL data type. + * + *

+ * + * @param targetCQLType CQL type of the target column we want to write to. + * @param javaValue Java object that we want to write to the column. + * @return Optional of the codec that can convert the Java object into the object expected by the + * CQL driver. If no codec is found, the optional is empty. + * @param Type of the Java object we want to convert. + * @param Type fo the Java object the CQL driver expects. + */ + public static Optional> codecFor( + DataType targetCQLType, JavaT javaValue) { + + return Optional.ofNullable( + JSONCodec.unchecked( + CODECS.stream() + .filter(codec -> codec.test(targetCQLType, javaValue)) + .findFirst() + .orElse(null))); + } + + // Numeric Codecs + public static final JSONCodec BIGINT = + new JSONCodec<>( + GenericType.BIG_DECIMAL, + DataTypes.BIGINT, + JSONCodec.FromJava.safeNumber(BigDecimal::longValueExact)); + + public static final JSONCodec DECIMAL = + new JSONCodec<>( + GenericType.BIG_DECIMAL, DataTypes.DECIMAL, JSONCodec.FromJava.unsafeIdentity()); + + public static final JSONCodec DOUBLE = + new JSONCodec<>( + GenericType.BIG_DECIMAL, + DataTypes.DOUBLE, + JSONCodec.FromJava.safeNumber(BigDecimal::doubleValue)); + + public static final JSONCodec FLOAT = + new JSONCodec<>( + GenericType.BIG_DECIMAL, + DataTypes.FLOAT, + JSONCodec.FromJava.safeNumber(BigDecimal::floatValue)); + + public static final JSONCodec INT = + new JSONCodec<>( + GenericType.BIG_DECIMAL, + DataTypes.INT, + JSONCodec.FromJava.safeNumber(BigDecimal::intValueExact)); + + public static final JSONCodec SMALLINT = + new JSONCodec<>( + GenericType.BIG_DECIMAL, + DataTypes.SMALLINT, + JSONCodec.FromJava.safeNumber(BigDecimal::shortValueExact)); + + public static final JSONCodec TINYINT = + new JSONCodec<>( + GenericType.BIG_DECIMAL, + DataTypes.TINYINT, + JSONCodec.FromJava.safeNumber(BigDecimal::byteValueExact)); + + public static final JSONCodec VARINT = + new JSONCodec<>( + GenericType.BIG_DECIMAL, + DataTypes.VARINT, + JSONCodec.FromJava.safeNumber(BigDecimal::toBigIntegerExact)); + + // Text Codecs + public static final JSONCodec ASCII = + new JSONCodec<>(GenericType.STRING, DataTypes.ASCII, JSONCodec.FromJava.unsafeIdentity()); + + public static final JSONCodec TEXT = + new JSONCodec<>(GenericType.STRING, DataTypes.TEXT, JSONCodec.FromJava.unsafeIdentity()); + + /** IMPORTANT: All codecs must be added to the list here. */ + static { + CODECS = List.of(BIGINT, DECIMAL, DOUBLE, FLOAT, INT, SMALLINT, TINYINT, VARINT, ASCII, TEXT); + } +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java index d37e3e6db1..657853a3f4 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java @@ -1,7 +1,9 @@ package io.stargate.sgv2.jsonapi.service.operation.tables; +import static com.datastax.oss.driver.api.querybuilder.QueryBuilder.*; + import com.datastax.oss.driver.api.core.cql.AsyncResultSet; -import com.datastax.oss.driver.api.core.cql.SimpleStatement; +import com.datastax.oss.driver.api.querybuilder.select.Select; import com.fasterxml.jackson.databind.ObjectMapper; import com.google.common.base.Preconditions; import io.smallrye.mutiny.Uni; @@ -14,13 +16,24 @@ import io.stargate.sgv2.jsonapi.service.cqldriver.executor.TableSchemaObject; import io.stargate.sgv2.jsonapi.service.operation.DocumentSource; import io.stargate.sgv2.jsonapi.service.operation.ReadOperationPage; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.TableFilter; +import java.util.ArrayList; +import java.util.List; import java.util.Objects; import java.util.Optional; import java.util.function.Supplier; import java.util.stream.StreamSupport; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +/** + * TODO: this is still a POC class, showing how we can build a filter still to do is order and + * projections + */ public class FindTableOperation extends TableReadOperation { + private static final Logger LOGGER = LoggerFactory.getLogger(FindTableOperation.class); + private final FindTableParams params; public FindTableOperation( @@ -35,13 +48,32 @@ public FindTableOperation( @Override public Uni> execute( DataApiRequestInfo dataApiRequestInfo, QueryExecutor queryExecutor) { - var cql = - "select JSON * from %s.%s limit %s;" - .formatted( - commandContext.schemaObject().name.keyspace(), - commandContext.schemaObject().name.table(), - params.limit()); - var statement = SimpleStatement.newInstance(cql); + + // Start the select + Select select = + selectFrom( + commandContext.schemaObject().tableMetadata.getKeyspace(), + commandContext.schemaObject().tableMetadata.getName()) + .json() + .all(); // TODO: this is where we would do the field selection / projection + + // BUG: this probably break order for nested expressions, for now enough to get this tested + var tableFilters = + logicalExpression.comparisonExpressions.stream() + .flatMap(comparisonExpression -> comparisonExpression.getDbFilters().stream()) + .map(dbFilter -> (TableFilter) dbFilter) + .toList(); + + // Add the where clause operations + List positonalValues = new ArrayList<>(); + for (TableFilter tableFilter : tableFilters) { + select = tableFilter.apply(commandContext.schemaObject(), select, positonalValues); + } + + select = select.limit(params.limit()); + + // Building a statment using the positional values added by the TableFilter + var statement = select.build(positonalValues.toArray()); // TODO: pageSize for FindTableOperation return queryExecutor diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/CountDocumentsCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/CountDocumentsCommandResolver.java index c01b216c8d..a80f04753c 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/CountDocumentsCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/CountDocumentsCommandResolver.java @@ -10,20 +10,21 @@ import io.stargate.sgv2.jsonapi.service.cqldriver.executor.CollectionSchemaObject; import io.stargate.sgv2.jsonapi.service.operation.Operation; import io.stargate.sgv2.jsonapi.service.operation.collections.CountCollectionOperation; -import io.stargate.sgv2.jsonapi.service.resolver.matcher.FilterableResolver; +import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; import jakarta.enterprise.context.ApplicationScoped; import jakarta.inject.Inject; /** Resolves the {@link CountDocumentsCommand } */ @ApplicationScoped -public class CountDocumentsCommandResolver extends FilterableResolver - implements CommandResolver { +public class CountDocumentsCommandResolver implements CommandResolver { private final OperationsConfig operationsConfig; private final MeterRegistry meterRegistry; private final DataApiRequestInfo dataApiRequestInfo; private final JsonApiMetricsConfig jsonApiMetricsConfig; + private final CollectionFilterResolver collectionFilterResolver; + @Inject public CountDocumentsCommandResolver( OperationsConfig operationsConfig, @@ -35,6 +36,8 @@ public CountDocumentsCommandResolver( this.meterRegistry = meterRegistry; this.dataApiRequestInfo = dataApiRequestInfo; this.jsonApiMetricsConfig = jsonApiMetricsConfig; + + this.collectionFilterResolver = new CollectionFilterResolver<>(operationsConfig); } @Override @@ -45,7 +48,7 @@ public Class getCommandClass() { @Override public Operation resolveCollectionCommand( CommandContext ctx, CountDocumentsCommand command) { - LogicalExpression logicalExpression = resolve(ctx, command); + LogicalExpression logicalExpression = collectionFilterResolver.resolve(ctx, command); addToMetrics( meterRegistry, dataApiRequestInfo, diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteManyCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteManyCommandResolver.java index 89fa083364..7fcca9ce53 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteManyCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteManyCommandResolver.java @@ -15,7 +15,7 @@ import io.stargate.sgv2.jsonapi.service.operation.collections.FindCollectionOperation; import io.stargate.sgv2.jsonapi.service.operation.collections.TruncateCollectionOperation; import io.stargate.sgv2.jsonapi.service.projection.DocumentProjector; -import io.stargate.sgv2.jsonapi.service.resolver.matcher.FilterableResolver; +import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; import jakarta.enterprise.context.ApplicationScoped; import jakarta.inject.Inject; @@ -24,8 +24,7 @@ * records to delete based on the filter condition and deletes it. */ @ApplicationScoped -public class DeleteManyCommandResolver extends FilterableResolver - implements CommandResolver { +public class DeleteManyCommandResolver implements CommandResolver { private final OperationsConfig operationsConfig; private final ObjectMapper objectMapper; @@ -34,6 +33,8 @@ public class DeleteManyCommandResolver extends FilterableResolver collectionFilterResolver; + @Inject public DeleteManyCommandResolver( OperationsConfig operationsConfig, @@ -41,12 +42,14 @@ public DeleteManyCommandResolver( MeterRegistry meterRegistry, DataApiRequestInfo dataApiRequestInfo, JsonApiMetricsConfig jsonApiMetricsConfig) { - super(); + this.operationsConfig = operationsConfig; this.objectMapper = objectMapper; this.meterRegistry = meterRegistry; this.dataApiRequestInfo = dataApiRequestInfo; this.jsonApiMetricsConfig = jsonApiMetricsConfig; + + this.collectionFilterResolver = new CollectionFilterResolver<>(operationsConfig); } @Override @@ -69,8 +72,9 @@ public Class getCommandClass() { return DeleteManyCommand.class; } - private FindCollectionOperation getFindOperation(CommandContext ctx, DeleteManyCommand command) { - LogicalExpression logicalExpression = resolve(ctx, command); + private FindCollectionOperation getFindOperation( + CommandContext ctx, DeleteManyCommand command) { + LogicalExpression logicalExpression = collectionFilterResolver.resolve(ctx, command); // Read One extra document than delete limit so return moreData flag addToMetrics( meterRegistry, diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteOneCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteOneCommandResolver.java index 62f16513ef..5ccaaa4a75 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteOneCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/DeleteOneCommandResolver.java @@ -16,7 +16,7 @@ import io.stargate.sgv2.jsonapi.service.operation.collections.DeleteCollectionOperation; import io.stargate.sgv2.jsonapi.service.operation.collections.FindCollectionOperation; import io.stargate.sgv2.jsonapi.service.projection.DocumentProjector; -import io.stargate.sgv2.jsonapi.service.resolver.matcher.FilterableResolver; +import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; import io.stargate.sgv2.jsonapi.util.SortClauseUtil; import jakarta.enterprise.context.ApplicationScoped; import jakarta.inject.Inject; @@ -27,8 +27,7 @@ * record to be deleted, Based on the filter condition a record will deleted */ @ApplicationScoped -public class DeleteOneCommandResolver extends FilterableResolver - implements CommandResolver { +public class DeleteOneCommandResolver implements CommandResolver { private final OperationsConfig operationsConfig; private final ObjectMapper objectMapper; @@ -37,6 +36,8 @@ public class DeleteOneCommandResolver extends FilterableResolver collectionFilterResolver; + @Inject public DeleteOneCommandResolver( OperationsConfig operationsConfig, @@ -44,11 +45,14 @@ public DeleteOneCommandResolver( MeterRegistry meterRegistry, DataApiRequestInfo dataApiRequestInfo, JsonApiMetricsConfig jsonApiMetricsConfig) { + this.operationsConfig = operationsConfig; this.objectMapper = objectMapper; this.meterRegistry = meterRegistry; this.dataApiRequestInfo = dataApiRequestInfo; this.jsonApiMetricsConfig = jsonApiMetricsConfig; + + this.collectionFilterResolver = new CollectionFilterResolver<>(operationsConfig); } @Override @@ -68,7 +72,7 @@ public Class getCommandClass() { private FindCollectionOperation getFindOperation( CommandContext commandContext, DeleteOneCommand command) { - LogicalExpression logicalExpression = resolve(commandContext, command); + LogicalExpression logicalExpression = collectionFilterResolver.resolve(commandContext, command); final SortClause sortClause = command.sortClause(); ValidatableCommandClause.maybeValidate(commandContext, sortClause); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java index e9b4f9b4c3..0ad7659cc7 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java @@ -17,7 +17,7 @@ import io.stargate.sgv2.jsonapi.service.operation.collections.CollectionReadType; import io.stargate.sgv2.jsonapi.service.operation.collections.FindCollectionOperation; import io.stargate.sgv2.jsonapi.service.operation.tables.FindTableOperation; -import io.stargate.sgv2.jsonapi.service.resolver.matcher.FilterableResolver; +import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; import io.stargate.sgv2.jsonapi.util.SortClauseUtil; import jakarta.enterprise.context.ApplicationScoped; import jakarta.inject.Inject; @@ -26,8 +26,7 @@ /** Resolves the {@link FindOneCommand } */ @ApplicationScoped -public class FindCommandResolver extends FilterableResolver - implements CommandResolver { +public class FindCommandResolver implements CommandResolver { private final OperationsConfig operationsConfig; private final ObjectMapper objectMapper; @@ -35,6 +34,8 @@ public class FindCommandResolver extends FilterableResolver private final DataApiRequestInfo dataApiRequestInfo; private final JsonApiMetricsConfig jsonApiMetricsConfig; + private final CollectionFilterResolver collectionFilterResolver; + @Inject public FindCommandResolver( OperationsConfig operationsConfig, @@ -42,13 +43,14 @@ public FindCommandResolver( MeterRegistry meterRegistry, DataApiRequestInfo dataApiRequestInfo, JsonApiMetricsConfig jsonApiMetricsConfig) { - super(); + this.objectMapper = objectMapper; this.operationsConfig = operationsConfig; - this.meterRegistry = meterRegistry; this.dataApiRequestInfo = dataApiRequestInfo; this.jsonApiMetricsConfig = jsonApiMetricsConfig; + + this.collectionFilterResolver = new CollectionFilterResolver<>(operationsConfig); } @Override @@ -72,7 +74,8 @@ public Operation resolveTableCommand(CommandContext ctx, Find @Override public Operation resolveCollectionCommand( CommandContext ctx, FindCommand command) { - final LogicalExpression resolvedLogicalExpression = resolve(ctx, command); + final LogicalExpression resolvedLogicalExpression = + collectionFilterResolver.resolve(ctx, command); // limit and page state defaults int limit = Integer.MAX_VALUE; int skip = 0; diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndDeleteCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndDeleteCommandResolver.java index 95187f9b6b..9809279ade 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndDeleteCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndDeleteCommandResolver.java @@ -16,7 +16,7 @@ import io.stargate.sgv2.jsonapi.service.operation.collections.DeleteCollectionOperation; import io.stargate.sgv2.jsonapi.service.operation.collections.FindCollectionOperation; import io.stargate.sgv2.jsonapi.service.projection.DocumentProjector; -import io.stargate.sgv2.jsonapi.service.resolver.matcher.FilterableResolver; +import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; import io.stargate.sgv2.jsonapi.service.shredding.collections.DocumentShredder; import io.stargate.sgv2.jsonapi.util.SortClauseUtil; import jakarta.enterprise.context.ApplicationScoped; @@ -25,8 +25,7 @@ /** Resolves the {@link FindOneAndDeleteCommand } */ @ApplicationScoped -public class FindOneAndDeleteCommandResolver extends FilterableResolver - implements CommandResolver { +public class FindOneAndDeleteCommandResolver implements CommandResolver { private final DocumentShredder documentShredder; private final OperationsConfig operationsConfig; private final ObjectMapper objectMapper; @@ -34,6 +33,8 @@ public class FindOneAndDeleteCommandResolver extends FilterableResolver collectionFilterResolver; + @Inject public FindOneAndDeleteCommandResolver( ObjectMapper objectMapper, @@ -42,7 +43,6 @@ public FindOneAndDeleteCommandResolver( MeterRegistry meterRegistry, DataApiRequestInfo dataApiRequestInfo, JsonApiMetricsConfig jsonApiMetricsConfig) { - super(); this.objectMapper = objectMapper; this.documentShredder = documentShredder; this.operationsConfig = operationsConfig; @@ -50,6 +50,8 @@ public FindOneAndDeleteCommandResolver( this.meterRegistry = meterRegistry; this.dataApiRequestInfo = dataApiRequestInfo; this.jsonApiMetricsConfig = jsonApiMetricsConfig; + + this.collectionFilterResolver = new CollectionFilterResolver<>(operationsConfig); } @Override @@ -69,7 +71,7 @@ public Operation resolveCollectionCommand( private FindCollectionOperation getFindOperation( CommandContext commandContext, FindOneAndDeleteCommand command) { - LogicalExpression logicalExpression = resolve(commandContext, command); + LogicalExpression logicalExpression = collectionFilterResolver.resolve(commandContext, command); final SortClause sortClause = command.sortClause(); ValidatableCommandClause.maybeValidate(commandContext, sortClause); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndReplaceCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndReplaceCommandResolver.java index 1ceb116ba5..e99b05915c 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndReplaceCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndReplaceCommandResolver.java @@ -16,7 +16,7 @@ import io.stargate.sgv2.jsonapi.service.operation.collections.FindCollectionOperation; import io.stargate.sgv2.jsonapi.service.operation.collections.ReadAndUpdateCollectionOperation; import io.stargate.sgv2.jsonapi.service.projection.DocumentProjector; -import io.stargate.sgv2.jsonapi.service.resolver.matcher.FilterableResolver; +import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; import io.stargate.sgv2.jsonapi.service.shredding.collections.DocumentShredder; import io.stargate.sgv2.jsonapi.service.updater.DocumentUpdater; import io.stargate.sgv2.jsonapi.util.SortClauseUtil; @@ -26,8 +26,7 @@ /** Resolves the {@link FindOneAndReplaceCommand } */ @ApplicationScoped -public class FindOneAndReplaceCommandResolver extends FilterableResolver - implements CommandResolver { +public class FindOneAndReplaceCommandResolver implements CommandResolver { private final DocumentShredder documentShredder; private final OperationsConfig operationsConfig; private final ObjectMapper objectMapper; @@ -35,6 +34,8 @@ public class FindOneAndReplaceCommandResolver extends FilterableResolver collectionFilterResolver; + @Inject public FindOneAndReplaceCommandResolver( ObjectMapper objectMapper, @@ -51,6 +52,8 @@ public FindOneAndReplaceCommandResolver( this.meterRegistry = meterRegistry; this.dataApiRequestInfo = dataApiRequestInfo; this.jsonApiMetricsConfig = jsonApiMetricsConfig; + + this.collectionFilterResolver = new CollectionFilterResolver<>(operationsConfig); } @Override @@ -87,7 +90,7 @@ public Operation resolveCollectionCommand( private FindCollectionOperation getFindOperation( CommandContext ctx, FindOneAndReplaceCommand command) { - LogicalExpression logicalExpression = resolve(ctx, command); + LogicalExpression logicalExpression = collectionFilterResolver.resolve(ctx, command); final SortClause sortClause = command.sortClause(); ValidatableCommandClause.maybeValidate(ctx, sortClause); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndUpdateCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndUpdateCommandResolver.java index 46d25d9cd2..6a80830d6c 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndUpdateCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneAndUpdateCommandResolver.java @@ -16,7 +16,7 @@ import io.stargate.sgv2.jsonapi.service.operation.collections.FindCollectionOperation; import io.stargate.sgv2.jsonapi.service.operation.collections.ReadAndUpdateCollectionOperation; import io.stargate.sgv2.jsonapi.service.projection.DocumentProjector; -import io.stargate.sgv2.jsonapi.service.resolver.matcher.FilterableResolver; +import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; import io.stargate.sgv2.jsonapi.service.shredding.collections.DocumentShredder; import io.stargate.sgv2.jsonapi.service.updater.DocumentUpdater; import io.stargate.sgv2.jsonapi.util.SortClauseUtil; @@ -26,8 +26,7 @@ /** Resolves the {@link FindOneAndUpdateCommand } */ @ApplicationScoped -public class FindOneAndUpdateCommandResolver extends FilterableResolver - implements CommandResolver { +public class FindOneAndUpdateCommandResolver implements CommandResolver { private final DocumentShredder documentShredder; private final OperationsConfig operationsConfig; private final ObjectMapper objectMapper; @@ -35,6 +34,8 @@ public class FindOneAndUpdateCommandResolver extends FilterableResolver collectionFilterResolver; + @Inject public FindOneAndUpdateCommandResolver( ObjectMapper objectMapper, @@ -51,6 +52,8 @@ public FindOneAndUpdateCommandResolver( this.meterRegistry = meterRegistry; this.dataApiRequestInfo = dataApiRequestInfo; this.jsonApiMetricsConfig = jsonApiMetricsConfig; + + this.collectionFilterResolver = new CollectionFilterResolver<>(operationsConfig); } @Override @@ -89,7 +92,7 @@ public Operation resolveCollectionCommand( private FindCollectionOperation getFindOperation( CommandContext commandContext, FindOneAndUpdateCommand command) { - LogicalExpression logicalExpression = resolve(commandContext, command); + LogicalExpression logicalExpression = collectionFilterResolver.resolve(commandContext, command); final SortClause sortClause = command.sortClause(); ValidatableCommandClause.maybeValidate(commandContext, sortClause); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java index 809137e489..f41191fad7 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java @@ -16,7 +16,8 @@ import io.stargate.sgv2.jsonapi.service.operation.collections.CollectionReadType; import io.stargate.sgv2.jsonapi.service.operation.collections.FindCollectionOperation; import io.stargate.sgv2.jsonapi.service.operation.tables.FindTableOperation; -import io.stargate.sgv2.jsonapi.service.resolver.matcher.FilterableResolver; +import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; +import io.stargate.sgv2.jsonapi.service.resolver.matcher.TableFilterResolver; import io.stargate.sgv2.jsonapi.util.SortClauseUtil; import jakarta.enterprise.context.ApplicationScoped; import jakarta.inject.Inject; @@ -24,14 +25,16 @@ /** Resolves the {@link FindOneCommand } */ @ApplicationScoped -public class FindOneCommandResolver extends FilterableResolver - implements CommandResolver { +public class FindOneCommandResolver implements CommandResolver { private final ObjectMapper objectMapper; private final OperationsConfig operationsConfig; private final MeterRegistry meterRegistry; private final DataApiRequestInfo dataApiRequestInfo; private final JsonApiMetricsConfig jsonApiMetricsConfig; + private final CollectionFilterResolver collectionFilterResolver; + private final TableFilterResolver tableFilterResolver; + @Inject public FindOneCommandResolver( ObjectMapper objectMapper, @@ -46,6 +49,9 @@ public FindOneCommandResolver( this.meterRegistry = meterRegistry; this.dataApiRequestInfo = dataApiRequestInfo; this.jsonApiMetricsConfig = jsonApiMetricsConfig; + + this.collectionFilterResolver = new CollectionFilterResolver<>(operationsConfig); + this.tableFilterResolver = new TableFilterResolver<>(operationsConfig); } @Override @@ -58,14 +64,14 @@ public Operation resolveTableCommand( CommandContext ctx, FindOneCommand command) { return new FindTableOperation( - ctx, LogicalExpression.and(), new FindTableOperation.FindTableParams(1)); + ctx, tableFilterResolver.resolve(ctx, command), new FindTableOperation.FindTableParams(1)); } @Override public Operation resolveCollectionCommand( CommandContext ctx, FindOneCommand command) { - LogicalExpression logicalExpression = resolve(ctx, command); + LogicalExpression logicalExpression = collectionFilterResolver.resolve(ctx, command); final SortClause sortClause = command.sortClause(); ValidatableCommandClause.maybeValidate(ctx, sortClause); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateManyCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateManyCommandResolver.java index 355f082311..08cee913d2 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateManyCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateManyCommandResolver.java @@ -14,7 +14,7 @@ import io.stargate.sgv2.jsonapi.service.operation.collections.FindCollectionOperation; import io.stargate.sgv2.jsonapi.service.operation.collections.ReadAndUpdateCollectionOperation; import io.stargate.sgv2.jsonapi.service.projection.DocumentProjector; -import io.stargate.sgv2.jsonapi.service.resolver.matcher.FilterableResolver; +import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; import io.stargate.sgv2.jsonapi.service.shredding.collections.DocumentShredder; import io.stargate.sgv2.jsonapi.service.updater.DocumentUpdater; import jakarta.enterprise.context.ApplicationScoped; @@ -22,8 +22,7 @@ /** Resolves the {@link UpdateManyCommand } */ @ApplicationScoped -public class UpdateManyCommandResolver extends FilterableResolver - implements CommandResolver { +public class UpdateManyCommandResolver implements CommandResolver { private final DocumentShredder documentShredder; private final OperationsConfig operationsConfig; private final ObjectMapper objectMapper; @@ -31,6 +30,8 @@ public class UpdateManyCommandResolver extends FilterableResolver collectionFilterResolver; + @Inject public UpdateManyCommandResolver( ObjectMapper objectMapper, @@ -39,7 +40,6 @@ public UpdateManyCommandResolver( MeterRegistry meterRegistry, DataApiRequestInfo dataApiRequestInfo, JsonApiMetricsConfig jsonApiMetricsConfig) { - super(); this.objectMapper = objectMapper; this.documentShredder = documentShredder; this.operationsConfig = operationsConfig; @@ -47,6 +47,8 @@ public UpdateManyCommandResolver( this.meterRegistry = meterRegistry; this.dataApiRequestInfo = dataApiRequestInfo; this.jsonApiMetricsConfig = jsonApiMetricsConfig; + + this.collectionFilterResolver = new CollectionFilterResolver<>(operationsConfig); } @Override @@ -81,7 +83,7 @@ public Operation resolveCollectionCommand( private FindCollectionOperation getFindOperation( CommandContext ctx, UpdateManyCommand command) { - LogicalExpression logicalExpression = resolve(ctx, command); + LogicalExpression logicalExpression = collectionFilterResolver.resolve(ctx, command); // TODO this did not track the vector usage, correct ? addToMetrics( diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateOneCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateOneCommandResolver.java index f7b7d22456..a85e8acb0e 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateOneCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/UpdateOneCommandResolver.java @@ -16,7 +16,7 @@ import io.stargate.sgv2.jsonapi.service.operation.collections.FindCollectionOperation; import io.stargate.sgv2.jsonapi.service.operation.collections.ReadAndUpdateCollectionOperation; import io.stargate.sgv2.jsonapi.service.projection.DocumentProjector; -import io.stargate.sgv2.jsonapi.service.resolver.matcher.FilterableResolver; +import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; import io.stargate.sgv2.jsonapi.service.shredding.collections.DocumentShredder; import io.stargate.sgv2.jsonapi.service.updater.DocumentUpdater; import io.stargate.sgv2.jsonapi.util.SortClauseUtil; @@ -26,8 +26,7 @@ /** Resolves the {@link UpdateOneCommand } */ @ApplicationScoped -public class UpdateOneCommandResolver extends FilterableResolver - implements CommandResolver { +public class UpdateOneCommandResolver implements CommandResolver { private final DocumentShredder documentShredder; private final OperationsConfig operationsConfig; private final ObjectMapper objectMapper; @@ -35,6 +34,8 @@ public class UpdateOneCommandResolver extends FilterableResolver collectionFilterResolver; + @Inject public UpdateOneCommandResolver( ObjectMapper objectMapper, @@ -51,6 +52,8 @@ public UpdateOneCommandResolver( this.meterRegistry = meterRegistry; this.dataApiRequestInfo = dataApiRequestInfo; this.jsonApiMetricsConfig = jsonApiMetricsConfig; + + this.collectionFilterResolver = new CollectionFilterResolver<>(operationsConfig); } @Override @@ -85,7 +88,7 @@ public Operation resolveCollectionCommand( private FindCollectionOperation getFindOperation( CommandContext ctx, UpdateOneCommand command) { - LogicalExpression logicalExpression = resolve(ctx, command); + LogicalExpression logicalExpression = collectionFilterResolver.resolve(ctx, command); final SortClause sortClause = command.sortClause(); ValidatableCommandClause.maybeValidate(ctx, sortClause); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterableResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/CollectionFilterResolver.java similarity index 89% rename from src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterableResolver.java rename to src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/CollectionFilterResolver.java index e8e7983389..1c094a98a8 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterableResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/CollectionFilterResolver.java @@ -1,33 +1,31 @@ package io.stargate.sgv2.jsonapi.service.resolver.matcher; import io.stargate.sgv2.jsonapi.api.model.command.Command; -import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; import io.stargate.sgv2.jsonapi.api.model.command.Filterable; -import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.*; import io.stargate.sgv2.jsonapi.config.OperationsConfig; import io.stargate.sgv2.jsonapi.config.constants.DocumentConstants; import io.stargate.sgv2.jsonapi.exception.ErrorCode; +import io.stargate.sgv2.jsonapi.service.cqldriver.executor.CollectionSchemaObject; import io.stargate.sgv2.jsonapi.service.operation.filters.DBFilterBase; import io.stargate.sgv2.jsonapi.service.operation.filters.collection.*; import io.stargate.sgv2.jsonapi.service.shredding.collections.DocValueHasher; import io.stargate.sgv2.jsonapi.service.shredding.collections.DocumentId; import io.stargate.sgv2.jsonapi.util.JsonUtil; -import jakarta.inject.Inject; import java.math.BigDecimal; import java.util.*; /** - * Base for resolvers that are {@link Filterable}, there are a number of commands like find, - * findOne, updateOne that all have a filter. + * A {@link FilterResolver} for resolving {@link FilterClause} against a {@link + * CollectionSchemaObject}. * - *

There will be some re-use, and some customisation to work out. + *

This understands how filter operations like `$size` work with Collections. * - *

T - type of the command we are resolving + *

TIDY: a lot of methods in this class a public for testing, change this TIDY: fix the unchecked + * casts, may need some interface changes */ -public abstract class FilterableResolver { - - private final FilterMatchRules matchRules = new FilterMatchRules<>(); +public class CollectionFilterResolver + extends FilterResolver { private static final Object ID_GROUP = new Object(); private static final Object ID_GROUP_IN = new Object(); @@ -45,25 +43,31 @@ public abstract class FilterableResolver { private static final Object ARRAY_EQUALS = new Object(); private static final Object SUB_DOC_EQUALS = new Object(); - @Inject OperationsConfig operationsConfig; + public CollectionFilterResolver(OperationsConfig operationsConfig) { + super(operationsConfig); + } + + @Override + protected FilterMatchRules buildMatchRules() { + var matchRules = new FilterMatchRules(); + + matchRules.addMatchRule( + CollectionFilterResolver::findNoFilter, FilterMatcher.MatchStrategy.EMPTY); - @Inject - public FilterableResolver() { - matchRules.addMatchRule(FilterableResolver::findNoFilter, FilterMatcher.MatchStrategy.EMPTY); matchRules - .addMatchRule(FilterableResolver::findById, FilterMatcher.MatchStrategy.STRICT) + .addMatchRule(CollectionFilterResolver::findById, FilterMatcher.MatchStrategy.STRICT) .matcher() .capture(ID_GROUP) .compareValues("_id", EnumSet.of(ValueComparisonOperator.EQ), JsonType.DOCUMENT_ID); matchRules - .addMatchRule(FilterableResolver::findById, FilterMatcher.MatchStrategy.STRICT) + .addMatchRule(CollectionFilterResolver::findById, FilterMatcher.MatchStrategy.STRICT) .matcher() .capture(ID_GROUP_IN) .compareValues("_id", EnumSet.of(ValueComparisonOperator.IN), JsonType.ARRAY); matchRules - .addMatchRule(FilterableResolver::findDynamic, FilterMatcher.MatchStrategy.GREEDY) + .addMatchRule(CollectionFilterResolver::findDynamic, FilterMatcher.MatchStrategy.GREEDY) .matcher() .capture(ID_GROUP) .compareValues( @@ -140,22 +144,11 @@ public FilterableResolver() { "*", EnumSet.of(ValueComparisonOperator.EQ, ValueComparisonOperator.NE), JsonType.SUB_DOC); - } - - protected LogicalExpression resolve(CommandContext commandContext, T command) { - ValidatableCommandClause.maybeValidate(commandContext, command.filterClause()); - - LogicalExpression filter = matchRules.apply(commandContext, command); - if (filter.getTotalComparisonExpressionCount() > operationsConfig.maxFilterObjectProperties()) { - throw ErrorCode.FILTER_FIELDS_LIMIT_VIOLATION.toApiException( - "filter has %d fields, exceeds maximum allowed %s", - filter.getTotalComparisonExpressionCount(), operationsConfig.maxFilterObjectProperties()); - } - return filter; + return matchRules; } - public static List findById(CaptureExpression captureExpression) { + private static List findById(CaptureExpression captureExpression) { List filters = new ArrayList<>(); for (FilterOperation filterOperation : captureExpression.filterOperations()) { if (captureExpression.marker() == ID_GROUP) { @@ -163,6 +156,7 @@ public static List findById(CaptureExpression captureExpression) { new IDCollectionFilter( IDCollectionFilter.Operator.EQ, (DocumentId) filterOperation.operand().value())); } + // TIDY: Resolve the unchecked cast (List) below and in other places in this file if (captureExpression.marker() == ID_GROUP_IN) { filters.add( new IDCollectionFilter( @@ -346,6 +340,7 @@ public static List findDynamic(CaptureExpression captureExpression return filters; } + // TIDY move these to the MapCollectionFilter etc enums private static MapCollectionFilter.Operator getMapFilterBaseOperator( FilterOperator filterOperator) { switch ((ValueComparisonOperator) filterOperator) { diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatchRules.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatchRules.java index 59651473ca..c8d26bfcad 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatchRules.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatchRules.java @@ -1,6 +1,5 @@ package io.stargate.sgv2.jsonapi.service.resolver.matcher; -import com.google.common.annotations.VisibleForTesting; import io.stargate.sgv2.jsonapi.api.model.command.Command; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; import io.stargate.sgv2.jsonapi.api.model.command.Filterable; @@ -72,8 +71,11 @@ public LogicalExpression apply(CommandContext commandContext, T command) { "Filter type not supported, unable to resolve to a filtering strategy")); } - @VisibleForTesting - protected List>> getMatchRules() { - return matchRules; + public boolean isEmpty() { + return matchRules.isEmpty(); + } + + public int size() { + return matchRules.size(); } } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterResolver.java new file mode 100644 index 0000000000..09b270132f --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterResolver.java @@ -0,0 +1,72 @@ +package io.stargate.sgv2.jsonapi.service.resolver.matcher; + +import com.google.common.base.Preconditions; +import io.stargate.sgv2.jsonapi.api.model.command.Command; +import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; +import io.stargate.sgv2.jsonapi.api.model.command.Filterable; +import io.stargate.sgv2.jsonapi.api.model.command.ValidatableCommandClause; +import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.LogicalExpression; +import io.stargate.sgv2.jsonapi.config.OperationsConfig; +import io.stargate.sgv2.jsonapi.exception.ErrorCode; +import io.stargate.sgv2.jsonapi.exception.JsonApiException; +import io.stargate.sgv2.jsonapi.service.cqldriver.executor.SchemaObject; + +/** + * Base for classes that turn a configured {@link + * io.stargate.sgv2.jsonapi.api.model.command.clause.filter.FilterClause} inot a {@link + * LogicalExpression} using the configured {@link FilterMatchRules}. + * + * @param The type od the {@link Command} that is being resolved. + * @param The typ of the {@link SchemaObject} that {@link Command} command is operating on. + */ +public abstract class FilterResolver { + + protected final OperationsConfig operationsConfig; + protected final FilterMatchRules matchRules; + + protected FilterResolver(OperationsConfig operationsConfig) { + Preconditions.checkNotNull(operationsConfig, "operationsConfig is required"); + this.operationsConfig = operationsConfig; + + matchRules = buildMatchRules(); + Preconditions.checkNotNull(matchRules, "buildMatchRules() must return non null"); + Preconditions.checkArgument( + !matchRules.isEmpty(), "buildMatchRules() must return non empty FilterMatchRules"); + } + + /** + * Subclasses must return a non-null and non-empty set of {@link FilterMatchRules} configured to + * match against the {@link io.stargate.sgv2.jsonapi.api.model.command.clause.filter.FilterClause} + * for the type of {@link SchemaObject} this resolver is for. + * + * @return {@link FilterMatchRules} + */ + protected abstract FilterMatchRules buildMatchRules(); + + /** + * Users of the class should call this function to convert the filer on the command into a {@link + * LogicalExpression}. + * + * @param commandContext + * @param command + * @return + */ + public LogicalExpression resolve(CommandContext commandContext, T command) { + Preconditions.checkNotNull(commandContext, "commandContext is required"); + Preconditions.checkNotNull(command, "command is required"); + + ValidatableCommandClause.maybeValidate(commandContext, command.filterClause()); + + LogicalExpression filter = matchRules.apply(commandContext, command); + if (filter.getTotalComparisonExpressionCount() > operationsConfig.maxFilterObjectProperties()) { + throw new JsonApiException( + ErrorCode.FILTER_FIELDS_LIMIT_VIOLATION, + String.format( + "%s: filter has %d fields, exceeds maximum allowed %s", + ErrorCode.FILTER_FIELDS_LIMIT_VIOLATION.getMessage(), + filter.getTotalComparisonExpressionCount(), + operationsConfig.maxFilterObjectProperties())); + } + return filter; + } +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/TableFilterResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/TableFilterResolver.java new file mode 100644 index 0000000000..b5376df29a --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/TableFilterResolver.java @@ -0,0 +1,92 @@ +package io.stargate.sgv2.jsonapi.service.resolver.matcher; + +import io.stargate.sgv2.jsonapi.api.model.command.Command; +import io.stargate.sgv2.jsonapi.api.model.command.Filterable; +import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.FilterOperation; +import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.JsonType; +import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.ValueComparisonOperator; +import io.stargate.sgv2.jsonapi.config.OperationsConfig; +import io.stargate.sgv2.jsonapi.service.cqldriver.executor.TableSchemaObject; +import io.stargate.sgv2.jsonapi.service.operation.filters.DBFilterBase; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.NativeTypeTableFilter; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.NumberTableFilter; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.TextTableFilter; +import java.math.BigDecimal; +import java.util.ArrayList; +import java.util.EnumSet; +import java.util.List; + +public class TableFilterResolver + extends FilterResolver { + + private static final Object DYNAMIC_TEXT_GROUP = new Object(); + private static final Object DYNAMIC_NUMBER_GROUP = new Object(); + + public TableFilterResolver(OperationsConfig operationsConfig) { + super(operationsConfig); + } + + @Override + protected FilterMatchRules buildMatchRules() { + var matchRules = new FilterMatchRules(); + + matchRules.addMatchRule(TableFilterResolver::findNoFilter, FilterMatcher.MatchStrategy.EMPTY); + + matchRules + .addMatchRule(TableFilterResolver::findDynamic, FilterMatcher.MatchStrategy.GREEDY) + .matcher() + .capture(DYNAMIC_TEXT_GROUP) + .compareValues( + "*", + EnumSet.of( + ValueComparisonOperator.EQ, + // ValueComparisonOperator.NE, // TODO: not sure this is supported + ValueComparisonOperator.GT, + ValueComparisonOperator.GTE, + ValueComparisonOperator.LT, + ValueComparisonOperator.LTE), + JsonType.STRING) + .capture(DYNAMIC_NUMBER_GROUP) + .compareValues( + "*", + EnumSet.of( + ValueComparisonOperator.EQ, + // ValueComparisonOperator.NE, - TODO - not supported + ValueComparisonOperator.GT, + ValueComparisonOperator.GTE, + ValueComparisonOperator.LT, + ValueComparisonOperator.LTE), + JsonType.NUMBER); + + return matchRules; + } + + private static List findNoFilter(CaptureExpression captureExpression) { + return List.of(); + } + + private static List findDynamic(CaptureExpression captureExpression) { + List filters = new ArrayList<>(); + + // TODO: How do we know what the T of the JsonLiteral from .value() is ? + for (FilterOperation filterOperation : captureExpression.filterOperations()) { + if (captureExpression.marker() == DYNAMIC_TEXT_GROUP) { + filters.add( + new TextTableFilter( + captureExpression.path(), + NativeTypeTableFilter.Operator.from( + (ValueComparisonOperator) filterOperation.operator()), + (String) filterOperation.operand().value())); + } else if (captureExpression.marker() == DYNAMIC_NUMBER_GROUP) { + filters.add( + new NumberTableFilter( + captureExpression.path(), + NativeTypeTableFilter.Operator.from( + (ValueComparisonOperator) filterOperation.operator()), + (BigDecimal) filterOperation.operand().value())); + } + } + + return filters; + } +} diff --git a/src/test/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatchRulesTest.java b/src/test/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatchRulesTest.java index 3ec08e43ea..dfffd3b668 100644 --- a/src/test/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatchRulesTest.java +++ b/src/test/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatchRulesTest.java @@ -87,7 +87,7 @@ public void addMatchRule() throws Exception { """; FindOneCommand findOneCommand = objectMapper.readValue(json, FindOneCommand.class); - FilterMatchRules filterMatchRules = new FilterMatchRules(); + FilterMatchRules filterMatchRules = new FilterMatchRules<>(); Function> resolveFunction = captureExpression -> filters; filterMatchRules @@ -100,7 +100,7 @@ public void addMatchRule() throws Exception { .capture("TEST1") .compareValues("*", EnumSet.of(ValueComparisonOperator.EQ), JsonType.STRING); - assertThat(filterMatchRules.getMatchRules()).hasSize(2); + assertThat(filterMatchRules.size()).isEqualTo(2); } } } diff --git a/src/test/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatcherTest.java b/src/test/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatcherTest.java index 453124e0f6..24da8701ed 100644 --- a/src/test/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatcherTest.java +++ b/src/test/java/io/stargate/sgv2/jsonapi/service/resolver/matcher/FilterMatcherTest.java @@ -35,7 +35,8 @@ public void applyWithNoFilter() throws Exception { FindOneCommand findOneCommand = objectMapper.readValue(json, FindOneCommand.class); FilterMatcher matcher = - new FilterMatcher<>(FilterMatcher.MatchStrategy.EMPTY, FilterableResolver::findNoFilter); + new FilterMatcher<>( + FilterMatcher.MatchStrategy.EMPTY, CollectionFilterResolver::findNoFilter); final Optional response = matcher.apply(findOneCommand); assertThat(response.isPresent()).isTrue(); } @@ -54,7 +55,8 @@ public void applyWithFilter() throws Exception { FindOneCommand findOneCommand = objectMapper.readValue(json, FindOneCommand.class); FilterMatcher matcher = - new FilterMatcher<>(FilterMatcher.MatchStrategy.EMPTY, FilterableResolver::findNoFilter); + new FilterMatcher<>( + FilterMatcher.MatchStrategy.EMPTY, CollectionFilterResolver::findNoFilter); final Optional response = matcher.apply(findOneCommand); assertThat(response.isPresent()).isFalse(); } @@ -75,7 +77,7 @@ public void applyWithNoFilter() throws Exception { FindOneCommand findOneCommand = objectMapper.readValue(json, FindOneCommand.class); FilterMatcher matcher = new FilterMatcher<>( - FilterMatcher.MatchStrategy.STRICT, FilterableResolver::findDynamic); + FilterMatcher.MatchStrategy.STRICT, CollectionFilterResolver::findDynamic); matcher .capture("TEST") .compareValues("*", EnumSet.of(ValueComparisonOperator.EQ), JsonType.STRING); @@ -98,7 +100,8 @@ public void applyWithFilterMatch() throws Exception { FindOneCommand findOneCommand = objectMapper.readValue(json, FindOneCommand.class); FilterMatcher matcher = - new FilterMatcher<>(FilterMatcher.MatchStrategy.STRICT, FilterableResolver::findDynamic); + new FilterMatcher<>( + FilterMatcher.MatchStrategy.STRICT, CollectionFilterResolver::findDynamic); matcher .capture("CAPTURE 1") .compareValues("*", EnumSet.of(ValueComparisonOperator.EQ), JsonType.STRING); @@ -123,7 +126,8 @@ public void applyWithFilterNotMatch() throws Exception { FindOneCommand findOneCommand = objectMapper.readValue(json, FindOneCommand.class); FilterMatcher matcher = - new FilterMatcher<>(FilterMatcher.MatchStrategy.STRICT, FilterableResolver::findDynamic); + new FilterMatcher<>( + FilterMatcher.MatchStrategy.STRICT, CollectionFilterResolver::findDynamic); matcher .capture("CAPTURE 1") .compareValues("*", EnumSet.of(ValueComparisonOperator.EQ), JsonType.STRING); @@ -150,7 +154,8 @@ public void applyWithNoFilter() throws Exception { FindOneCommand findOneCommand = objectMapper.readValue(json, FindOneCommand.class); FilterMatcher matcher = - new FilterMatcher<>(FilterMatcher.MatchStrategy.GREEDY, FilterableResolver::findDynamic); + new FilterMatcher<>( + FilterMatcher.MatchStrategy.GREEDY, CollectionFilterResolver::findDynamic); matcher .capture("TEST") .compareValues("*", EnumSet.of(ValueComparisonOperator.EQ), JsonType.STRING); @@ -172,7 +177,8 @@ public void applyWithFilterMatch() throws Exception { FindOneCommand findOneCommand = objectMapper.readValue(json, FindOneCommand.class); FilterMatcher matcher = - new FilterMatcher<>(FilterMatcher.MatchStrategy.GREEDY, FilterableResolver::findDynamic); + new FilterMatcher<>( + FilterMatcher.MatchStrategy.GREEDY, CollectionFilterResolver::findDynamic); matcher .capture("CAPTURE 1") .compareValues("*", EnumSet.of(ValueComparisonOperator.EQ), JsonType.STRING); @@ -197,7 +203,8 @@ public void applyWithFilterNoMatch() throws Exception { FindOneCommand findOneCommand = objectMapper.readValue(json, FindOneCommand.class); FilterMatcher matcher = - new FilterMatcher<>(FilterMatcher.MatchStrategy.GREEDY, FilterableResolver::findDynamic); + new FilterMatcher<>( + FilterMatcher.MatchStrategy.GREEDY, CollectionFilterResolver::findDynamic); matcher .capture("CAPTURE 1") .compareValues("*", EnumSet.of(ValueComparisonOperator.EQ), JsonType.STRING); From 1c209f39edcfc907af33aa3b9e5be219a89d3f90 Mon Sep 17 00:00:00 2001 From: Aaron Morton Date: Fri, 26 Jul 2024 10:08:51 +1200 Subject: [PATCH 3/6] POC for OperationProjection POC to show pushing the projection down how we build the select and how we build the document from the row. see OperationProjection --- .../operation/tables/AllJSONProjection.java | 39 +++++++++++++++ .../operation/tables/FindTableOperation.java | 31 ++++-------- .../operation/tables/OperationProjection.java | 50 +++++++++++++++++++ .../service/resolver/FindCommandResolver.java | 5 +- .../resolver/FindOneCommandResolver.java | 5 +- 5 files changed, 108 insertions(+), 22 deletions(-) create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/OperationProjection.java diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java new file mode 100644 index 0000000000..d70f3bcdd6 --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java @@ -0,0 +1,39 @@ +package io.stargate.sgv2.jsonapi.service.operation.tables; + +import com.datastax.oss.driver.api.core.cql.Row; +import com.datastax.oss.driver.api.querybuilder.select.Select; +import com.datastax.oss.driver.api.querybuilder.select.SelectFrom; +import com.fasterxml.jackson.databind.ObjectMapper; +import io.stargate.sgv2.jsonapi.service.operation.DocumentSource; +import org.apache.commons.lang3.NotImplementedException; + +/** + * POC implementation that represents a projection that includes all columns in the table, and does + * a CQL select AS JSON + */ +public record AllJSONProjection(ObjectMapper objectMapper) implements OperationProjection{ + + + /** + * POC implementation that selects all columns, and returns the result using CQL AS JSON + * @param select + * @return + */ + @Override + public Select forSelect(SelectFrom select) { + return select + .json() + .all(); + } + + @Override + public DocumentSource toDocument(Row row) { + return (DocumentSource) () -> { + try { + return objectMapper.readTree(row.getString("[json]")); + } catch (Exception e) { + throw new NotImplementedException("BANG " + e.getMessage()); + } + }; + } +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java index 657853a3f4..7310660563 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java @@ -34,15 +34,18 @@ public class FindTableOperation extends TableReadOperation { private static final Logger LOGGER = LoggerFactory.getLogger(FindTableOperation.class); + private final OperationProjection projection; private final FindTableParams params; public FindTableOperation( CommandContext commandContext, LogicalExpression logicalExpression, + OperationProjection projection, FindTableParams params) { super(commandContext, logicalExpression); - this.params = Objects.requireNonNull(params, "Params must not be null"); + this.params = Objects.requireNonNull(params, "params must not be null"); + this.projection = Objects.requireNonNull(projection, "projection must not be null"); } @Override @@ -50,12 +53,11 @@ public Uni> execute( DataApiRequestInfo dataApiRequestInfo, QueryExecutor queryExecutor) { // Start the select - Select select = + Select select = projection.forSelect( selectFrom( commandContext.schemaObject().tableMetadata.getKeyspace(), commandContext.schemaObject().tableMetadata.getName()) - .json() - .all(); // TODO: this is where we would do the field selection / projection + ); // BUG: this probably break order for nested expressions, for now enough to get this tested var tableFilters = @@ -65,15 +67,15 @@ public Uni> execute( .toList(); // Add the where clause operations - List positonalValues = new ArrayList<>(); + List positionalValues = new ArrayList<>(); for (TableFilter tableFilter : tableFilters) { - select = tableFilter.apply(commandContext.schemaObject(), select, positonalValues); + select = tableFilter.apply(commandContext.schemaObject(), select, positionalValues); } select = select.limit(params.limit()); // Building a statment using the positional values added by the TableFilter - var statement = select.build(positonalValues.toArray()); + var statement = select.build(positionalValues.toArray()); // TODO: pageSize for FindTableOperation return queryExecutor @@ -86,19 +88,8 @@ private ReadOperationPage toReadOperationPage(AsyncResultSet resultSet) { var objectMapper = new ObjectMapper(); - var docSources = - StreamSupport.stream(resultSet.currentPage().spliterator(), false) - .map( - row -> - (DocumentSource) - () -> { - try { - return objectMapper.readTree(row.getString("[json]")); - } catch (Exception e) { - throw ErrorCode.SERVER_INTERNAL_ERROR.toApiException( - e, "Failed to parse row JSON: %s", e.getMessage()); - } - }) + var docSources = StreamSupport.stream(resultSet.currentPage().spliterator(), false) + .map(projection::toDocument) .toList(); return new ReadOperationPage(docSources, params.isSingleResponse(), null, false, null); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/OperationProjection.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/OperationProjection.java new file mode 100644 index 0000000000..d3a9f987bd --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/OperationProjection.java @@ -0,0 +1,50 @@ +package io.stargate.sgv2.jsonapi.service.operation.tables; + +import com.datastax.oss.driver.api.core.cql.Row; +import com.datastax.oss.driver.api.querybuilder.select.Select; +import com.datastax.oss.driver.api.querybuilder.select.SelectFrom; +import io.stargate.sgv2.jsonapi.service.operation.DocumentSource; + + +/** + * POC of what pushing the projection down looks like. + * + * The idea is to encapsulate both what columns we pull from the table & how we then convert a row + * we read into a document into this one interface to a read operation can hand it all off. + * + * See {@link AllJSONProjection} for a POC that is how the initial Tables POC works + */ +public interface OperationProjection { + + /** + * Called by an operation when it wants the projection to add the columns it will select from the + * database to the {@link Select} from the Query builder. + * + * Implementations should add the columns they need by name from their internal state. The projection + * should already have been valided as valid to run against the table, all the columns in the projection + * should exist in the table. + * + * TODO: the select param should be a Select type, is only a SelectFrom because that is where the + * builder has json(), will change to select when we stop doing that. See AllJSONProjection + * @param select + * @return + */ + Select forSelect(SelectFrom select); + + /** + * Called by an opertion when it wants to get a {@link DocumentSource} implementation that when later called, + * will be able to convert the provided {@link Row} into a document to return to the user. + * + * Note: Implementations should not immediately create a JSON document, it should return an object that + * defers creating the document until asked. Defering the document creation allows the operation to + * be more efficient by only creating the document if it is needed. + * + * Implementations should use the {@link io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.JSONCodecRegistry} to + * map the columns in the row to the fields in the document. + * + * @param row + * @return + */ + DocumentSource toDocument(Row row); + +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java index 0ad7659cc7..3d64cf8b27 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java @@ -16,6 +16,7 @@ import io.stargate.sgv2.jsonapi.service.operation.Operation; import io.stargate.sgv2.jsonapi.service.operation.collections.CollectionReadType; import io.stargate.sgv2.jsonapi.service.operation.collections.FindCollectionOperation; +import io.stargate.sgv2.jsonapi.service.operation.tables.AllJSONProjection; import io.stargate.sgv2.jsonapi.service.operation.tables.FindTableOperation; import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; import io.stargate.sgv2.jsonapi.util.SortClauseUtil; @@ -68,7 +69,9 @@ public Operation resolveTableCommand(CommandContext ctx, Find .orElse(Integer.MAX_VALUE); return new FindTableOperation( - ctx, LogicalExpression.and(), new FindTableOperation.FindTableParams(limit)); + ctx, LogicalExpression.and(), + new AllJSONProjection(new ObjectMapper()), + new FindTableOperation.FindTableParams(limit)); } @Override diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java index f41191fad7..8a005333c4 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java @@ -15,6 +15,7 @@ import io.stargate.sgv2.jsonapi.service.operation.Operation; import io.stargate.sgv2.jsonapi.service.operation.collections.CollectionReadType; import io.stargate.sgv2.jsonapi.service.operation.collections.FindCollectionOperation; +import io.stargate.sgv2.jsonapi.service.operation.tables.AllJSONProjection; import io.stargate.sgv2.jsonapi.service.operation.tables.FindTableOperation; import io.stargate.sgv2.jsonapi.service.resolver.matcher.CollectionFilterResolver; import io.stargate.sgv2.jsonapi.service.resolver.matcher.TableFilterResolver; @@ -64,7 +65,9 @@ public Operation resolveTableCommand( CommandContext ctx, FindOneCommand command) { return new FindTableOperation( - ctx, tableFilterResolver.resolve(ctx, command), new FindTableOperation.FindTableParams(1)); + ctx, tableFilterResolver.resolve(ctx, command), + new AllJSONProjection(new ObjectMapper()), + new FindTableOperation.FindTableParams(1)); } @Override From f1024179ed863d73c366da3e1cf3932d32feef89 Mon Sep 17 00:00:00 2001 From: Aaron Morton Date: Fri, 26 Jul 2024 10:28:36 +1200 Subject: [PATCH 4/6] POC for using JSONCodec on inserts Tis commit changes the InsertTableOperation to use the same JSONCodec created to process data for a filter to transform the data from the incoming document into what the driver wants to write to the CQL column --- .../filters/table/NativeTypeTableFilter.java | 33 ++++---- .../table/codecs/JSONCodecRegistry.java | 76 ++++++++++++++----- .../codecs/MissingJSONCodecException.java | 31 ++++++++ .../table/codecs/UnknownColumnException.java | 25 ++++++ .../operation/tables/AllJSONProjection.java | 23 +++--- .../operation/tables/FindTableOperation.java | 13 ++-- .../tables/InsertTableOperation.java | 58 +++++++++++--- .../operation/tables/OperationProjection.java | 35 ++++----- .../operation/tables/TableInsertAttempt.java | 11 ++- .../service/resolver/FindCommandResolver.java | 3 +- .../resolver/FindOneCommandResolver.java | 3 +- .../resolver/InsertManyCommandResolver.java | 2 +- .../resolver/InsertOneCommandResolver.java | 2 +- .../service/shredding/tables/RowShredder.java | 54 +++++++------ 14 files changed, 255 insertions(+), 114 deletions(-) create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/UnknownColumnException.java diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java index 8480a1022b..201cac79bc 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java @@ -2,6 +2,7 @@ import static com.datastax.oss.driver.api.querybuilder.QueryBuilder.bindMarker; +import com.datastax.oss.driver.api.core.CqlIdentifier; import com.datastax.oss.driver.api.querybuilder.relation.Relation; import com.datastax.oss.driver.api.querybuilder.select.Select; import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.ValueComparisonOperator; @@ -10,6 +11,8 @@ import io.stargate.sgv2.jsonapi.service.operation.builder.BuiltConditionPredicate; import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.FromJavaCodecException; import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.JSONCodecRegistry; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.MissingJSONCodecException; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.UnknownColumnException; import java.util.List; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -97,28 +100,20 @@ public BuiltCondition get() { public Select apply( TableSchemaObject tableSchemaObject, Select select, List positionalValues) { - // TODO: AARON return the correct errors, this is POC work now - var column = - tableSchemaObject - .tableMetadata - .getColumn(path) - .orElseThrow(() -> new IllegalArgumentException("Column not found: " + path)); - - var codec = - JSONCodecRegistry.codecFor(column.getType(), columnValue) - .orElseThrow( - () -> - new RuntimeException( - String.format( - "No Codec for a value of type %s with table column %s it has CQL type %s", - columnValue.getClass(), - column.getName(), - column.getType().asCql(true, false)))); - try { + var codec = + JSONCodecRegistry.codecFor( + tableSchemaObject.tableMetadata, CqlIdentifier.fromCql(path), columnValue); positionalValues.add(codec.apply(columnValue)); + } catch (UnknownColumnException e) { + // TODO AARON - Handle error + throw new RuntimeException(e); + } catch (MissingJSONCodecException e) { + // TODO AARON - Handle error + throw new RuntimeException(e); } catch (FromJavaCodecException e) { - throw new RuntimeException("Error applying codec", e); + // TODO AARON - Handle error + throw new RuntimeException(e); } return select.where(Relation.column(path).build(operator.predicate.cql, bindMarker())); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java index ea1467d72c..d6483665c9 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java @@ -1,18 +1,20 @@ package io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs; +import com.datastax.oss.driver.api.core.CqlIdentifier; +import com.datastax.oss.driver.api.core.metadata.schema.TableMetadata; import com.datastax.oss.driver.api.core.type.DataType; import com.datastax.oss.driver.api.core.type.DataTypes; import com.datastax.oss.driver.api.core.type.reflect.GenericType; +import com.google.common.base.Preconditions; import java.math.BigDecimal; import java.math.BigInteger; import java.util.List; -import java.util.Optional; /** * Builds and manages the {@link JSONCodec} instances that are used to convert Java objects into the * objects expected by the CQL driver for specific CQL data types. * - *

See {@link #codecFor(DataType, Object)} + *

See {@link #codecFor(TableMetadata, CqlIdentifier, Object)} for the main entry point. * *

IMPORTANT: There must be a codec for every CQL data type we want to write to, even if the * translation is an identity translation. This is so we know if the translation can happen, and @@ -23,8 +25,7 @@ public class JSONCodecRegistry { // Internal list of all codes - // IMPORTANT: any codec must be added to the list to be available to {@ink #codecFor(DataType, - // Object)} + // IMPORTANT: any codec must be added to the list to be available! // They are added in a static block at the end of the file private static final List> CODECS; @@ -34,24 +35,61 @@ public class JSONCodecRegistry { * *

* - * @param targetCQLType CQL type of the target column we want to write to. - * @param javaValue Java object that we want to write to the column. - * @return Optional of the codec that can convert the Java object into the object expected by the - * CQL driver. If no codec is found, the optional is empty. + * @param table {@link TableMetadata} to find the column definition in + * @param column {@link CqlIdentifier} for the column we want to get the codec for. + * @param value The value to be written to the column * @param Type of the Java object we want to convert. * @param Type fo the Java object the CQL driver expects. + * @return The {@link JSONCodec} that can convert the value to the expected type for the column, + * or an exception if the codec cannot be found. + * @throws UnknownColumnException If the column is not found in the table. + * @throws MissingJSONCodecException If no codec is found for the column and type of the value. */ - public static Optional> codecFor( - DataType targetCQLType, JavaT javaValue) { - - return Optional.ofNullable( - JSONCodec.unchecked( - CODECS.stream() - .filter(codec -> codec.test(targetCQLType, javaValue)) - .findFirst() - .orElse(null))); + public static JSONCodec codecFor( + TableMetadata table, CqlIdentifier column, Object value) + throws UnknownColumnException, MissingJSONCodecException { + + Preconditions.checkNotNull(table, "table must not be null"); + Preconditions.checkNotNull(column, "column must not be null"); + Preconditions.checkNotNull(value, "value must not be null"); + + // BUG: needs to handle NULl value + var columnMetadata = + table.getColumn(column).orElseThrow(() -> new UnknownColumnException(table, column)); + + // compiler telling me we need to use the unchecked assignment again like the codecFor does + JSONCodec codec = + JSONCodec.unchecked(internalCodecFor(columnMetadata.getType(), value)); + if (codec != null) { + return codec; + } + throw new MissingJSONCodecException(table, columnMetadata, value.getClass(), value); } + /** + * Internal only method to find a codec for the specified type and value. + * + *

The return type is {@code JSONCodec} because type erasure means that returning {@code + * JSONCodec} would be erased. Therefore, we need to use {@link JSONCodec#unchecked} + * anyway, which results in this method returning {@code }. However, you are guaranteed that + * it will match the types you wanted, due to the call to the codec to test. + * + * @param targetCQLType + * @param javaValue + * @return The codec, or `null` if none found. + */ + private static JSONCodec internalCodecFor(DataType targetCQLType, Object javaValue) { + // BUG: needs to handle NULl value + return CODECS.stream() + .filter(codec -> codec.test(targetCQLType, javaValue)) + .findFirst() + .orElse(null); + } + + // Boolean + public static final JSONCodec BOOLEAN = + new JSONCodec<>(GenericType.BOOLEAN, DataTypes.BOOLEAN, JSONCodec.FromJava.unsafeIdentity()); + // Numeric Codecs public static final JSONCodec BIGINT = new JSONCodec<>( @@ -108,6 +146,8 @@ public static Optional> codecFor( /** IMPORTANT: All codecs must be added to the list here. */ static { - CODECS = List.of(BIGINT, DECIMAL, DOUBLE, FLOAT, INT, SMALLINT, TINYINT, VARINT, ASCII, TEXT); + CODECS = + List.of( + BOOLEAN, BIGINT, DECIMAL, DOUBLE, FLOAT, INT, SMALLINT, TINYINT, VARINT, ASCII, TEXT); } } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java new file mode 100644 index 0000000000..f9922ab640 --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java @@ -0,0 +1,31 @@ +package io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs; + +import com.datastax.oss.driver.api.core.metadata.schema.ColumnMetadata; +import com.datastax.oss.driver.api.core.metadata.schema.TableMetadata; + +/** + * Checked exception thrown when we cannot find a codec for a column that matches the types we are + * using. + * + *

Not intended to be returned on the API, usage of the JSONCodec's should catch this and turn it + * into the appropriate API error. + */ +public class MissingJSONCodecException extends Exception { + + public final TableMetadata table; + public final ColumnMetadata column; + public final Class javaType; + public final Object value; + + public MissingJSONCodecException( + TableMetadata table, ColumnMetadata column, Class javaType, Object value) { + super( + String.format( + "No JSONCodec found for table %s column %s with java type %s and value %s", + table.getName(), column.getName(), javaType, value)); + this.table = table; + this.column = column; + this.javaType = javaType; + this.value = value; + } +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/UnknownColumnException.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/UnknownColumnException.java new file mode 100644 index 0000000000..829660d06c --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/UnknownColumnException.java @@ -0,0 +1,25 @@ +package io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs; + +import com.datastax.oss.driver.api.core.CqlIdentifier; +import com.datastax.oss.driver.api.core.metadata.schema.TableMetadata; + +/** + * Exception thrown when we cannot find a column in a table. Used in the operations, which expect + * that a column with a name should be available in the table. + * + *

Not intended to be returned on the API, usage of the JSONCodec's should catch this and turn it + * into the appropriate API error. + */ +public class UnknownColumnException extends RuntimeException { + + public final TableMetadata table; + public final CqlIdentifier column; + + public UnknownColumnException(TableMetadata table, CqlIdentifier column) { + super( + String.format( + "No column found for table %s with name %s", table.getName(), column.asInternal())); + this.table = table; + this.column = column; + } +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java index d70f3bcdd6..17bd875eeb 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java @@ -11,29 +11,28 @@ * POC implementation that represents a projection that includes all columns in the table, and does * a CQL select AS JSON */ -public record AllJSONProjection(ObjectMapper objectMapper) implements OperationProjection{ - +public record AllJSONProjection(ObjectMapper objectMapper) implements OperationProjection { /** * POC implementation that selects all columns, and returns the result using CQL AS JSON + * * @param select * @return */ @Override public Select forSelect(SelectFrom select) { - return select - .json() - .all(); + return select.json().all(); } @Override public DocumentSource toDocument(Row row) { - return (DocumentSource) () -> { - try { - return objectMapper.readTree(row.getString("[json]")); - } catch (Exception e) { - throw new NotImplementedException("BANG " + e.getMessage()); - } - }; + return (DocumentSource) + () -> { + try { + return objectMapper.readTree(row.getString("[json]")); + } catch (Exception e) { + throw new NotImplementedException("BANG " + e.getMessage()); + } + }; } } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java index 7310660563..6c8ee53fc4 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/FindTableOperation.java @@ -11,10 +11,8 @@ import io.stargate.sgv2.jsonapi.api.model.command.CommandResult; import io.stargate.sgv2.jsonapi.api.model.command.clause.filter.LogicalExpression; import io.stargate.sgv2.jsonapi.api.request.DataApiRequestInfo; -import io.stargate.sgv2.jsonapi.exception.ErrorCode; import io.stargate.sgv2.jsonapi.service.cqldriver.executor.QueryExecutor; import io.stargate.sgv2.jsonapi.service.cqldriver.executor.TableSchemaObject; -import io.stargate.sgv2.jsonapi.service.operation.DocumentSource; import io.stargate.sgv2.jsonapi.service.operation.ReadOperationPage; import io.stargate.sgv2.jsonapi.service.operation.filters.table.TableFilter; import java.util.ArrayList; @@ -53,11 +51,11 @@ public Uni> execute( DataApiRequestInfo dataApiRequestInfo, QueryExecutor queryExecutor) { // Start the select - Select select = projection.forSelect( - selectFrom( + Select select = + projection.forSelect( + selectFrom( commandContext.schemaObject().tableMetadata.getKeyspace(), - commandContext.schemaObject().tableMetadata.getName()) - ); + commandContext.schemaObject().tableMetadata.getName())); // BUG: this probably break order for nested expressions, for now enough to get this tested var tableFilters = @@ -88,7 +86,8 @@ private ReadOperationPage toReadOperationPage(AsyncResultSet resultSet) { var objectMapper = new ObjectMapper(); - var docSources = StreamSupport.stream(resultSet.currentPage().spliterator(), false) + var docSources = + StreamSupport.stream(resultSet.currentPage().spliterator(), false) .map(projection::toDocument) .toList(); diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/InsertTableOperation.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/InsertTableOperation.java index 67b4599498..5f6b4d4ce6 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/InsertTableOperation.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/InsertTableOperation.java @@ -4,7 +4,9 @@ import com.datastax.oss.driver.api.core.CqlIdentifier; import com.datastax.oss.driver.api.core.cql.SimpleStatement; -import com.datastax.oss.driver.api.querybuilder.term.Term; +import com.datastax.oss.driver.api.querybuilder.insert.InsertInto; +import com.datastax.oss.driver.api.querybuilder.insert.RegularInsert; +import com.google.common.base.Preconditions; import io.smallrye.mutiny.Multi; import io.smallrye.mutiny.Uni; import io.stargate.sgv2.jsonapi.api.model.command.CommandContext; @@ -13,14 +15,21 @@ import io.stargate.sgv2.jsonapi.service.cqldriver.executor.QueryExecutor; import io.stargate.sgv2.jsonapi.service.cqldriver.executor.TableSchemaObject; import io.stargate.sgv2.jsonapi.service.operation.InsertOperationPage; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.FromJavaCodecException; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.JSONCodecRegistry; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.MissingJSONCodecException; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.UnknownColumnException; import io.stargate.sgv2.jsonapi.service.shredding.tables.WriteableTableRow; +import java.util.ArrayList; import java.util.List; import java.util.Map; import java.util.function.Function; import java.util.function.Supplier; -import java.util.stream.Collectors; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; public class InsertTableOperation extends TableMutationOperation { + private static final Logger LOGGER = LoggerFactory.getLogger(InsertTableOperation.class); private final List insertAttempts; @@ -82,14 +91,43 @@ private Uni insertRow( private SimpleStatement buildInsertStatement(QueryExecutor queryExecutor, WriteableTableRow row) { - Map colValues = - row.allColumnValues().entrySet().stream() - .collect(Collectors.toMap(Map.Entry::getKey, e -> literal(e.getValue()))); + Preconditions.checkArgument( + !row.allColumnValues().isEmpty(), "Row must have at least one column to insert"); - return insertInto( - commandContext.schemaObject().name.keyspace(), - commandContext.schemaObject().name.table()) - .valuesByIds(colValues) - .build(); + InsertInto insertInto = + insertInto( + commandContext.schemaObject().tableMetadata.getKeyspace(), + commandContext.schemaObject().tableMetadata.getName()); + + List positionalValues = new ArrayList<>(row.allColumnValues().size()); + RegularInsert ongoingInsert = null; + + for (Map.Entry entry : row.allColumnValues().entrySet()) { + try { + var codec = + JSONCodecRegistry.codecFor( + commandContext.schemaObject().tableMetadata, entry.getKey(), entry.getValue()); + positionalValues.add(codec.apply(entry.getValue())); + } catch (UnknownColumnException e) { + // TODO AARON - Handle error + throw new RuntimeException(e); + } catch (MissingJSONCodecException e) { + // TODO AARON - Handle error + throw new RuntimeException(e); + } catch (FromJavaCodecException e) { + // TODO AARON - Handle error + throw new RuntimeException(e); + } + + // need to switch from the InertInto interface to the RegularInsert to get to the + // asCQL() later. + ongoingInsert = + ongoingInsert == null + ? insertInto.value(entry.getKey(), bindMarker()) + : ongoingInsert.value(entry.getKey(), bindMarker()); + } + + assert ongoingInsert != null; + return SimpleStatement.newInstance(ongoingInsert.asCql(), positionalValues.toArray()); } } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/OperationProjection.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/OperationProjection.java index d3a9f987bd..75a01843b7 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/OperationProjection.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/OperationProjection.java @@ -5,14 +5,13 @@ import com.datastax.oss.driver.api.querybuilder.select.SelectFrom; import io.stargate.sgv2.jsonapi.service.operation.DocumentSource; - /** * POC of what pushing the projection down looks like. * - * The idea is to encapsulate both what columns we pull from the table & how we then convert a row - * we read into a document into this one interface to a read operation can hand it all off. + *

The idea is to encapsulate both what columns we pull from the table & how we then convert a + * row we read into a document into this one interface to a read operation can hand it all off. * - * See {@link AllJSONProjection} for a POC that is how the initial Tables POC works + *

See {@link AllJSONProjection} for a POC that is how the initial Tables POC works */ public interface OperationProjection { @@ -20,31 +19,33 @@ public interface OperationProjection { * Called by an operation when it wants the projection to add the columns it will select from the * database to the {@link Select} from the Query builder. * - * Implementations should add the columns they need by name from their internal state. The projection - * should already have been valided as valid to run against the table, all the columns in the projection - * should exist in the table. + *

Implementations should add the columns they need by name from their internal state. The + * projection should already have been valided as valid to run against the table, all the columns + * in the projection should exist in the table. + * + *

TODO: the select param should be a Select type, is only a SelectFrom because that is where + * the builder has json(), will change to select when we stop doing that. See AllJSONProjection * - * TODO: the select param should be a Select type, is only a SelectFrom because that is where the - * builder has json(), will change to select when we stop doing that. See AllJSONProjection * @param select * @return */ Select forSelect(SelectFrom select); /** - * Called by an opertion when it wants to get a {@link DocumentSource} implementation that when later called, - * will be able to convert the provided {@link Row} into a document to return to the user. + * Called by an opertion when it wants to get a {@link DocumentSource} implementation that when + * later called, will be able to convert the provided {@link Row} into a document to return to the + * user. * - * Note: Implementations should not immediately create a JSON document, it should return an object that - * defers creating the document until asked. Defering the document creation allows the operation to - * be more efficient by only creating the document if it is needed. + *

Note: Implementations should not immediately create a JSON document, it should return an + * object that defers creating the document until asked. Defering the document creation allows the + * operation to be more efficient by only creating the document if it is needed. * - * Implementations should use the {@link io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.JSONCodecRegistry} to - * map the columns in the row to the fields in the document. + *

Implementations should use the {@link + * io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.JSONCodecRegistry} to map the + * columns in the row to the fields in the document. * * @param row * @return */ DocumentSource toDocument(Row row); - } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/TableInsertAttempt.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/TableInsertAttempt.java index 6a1e760b96..60198504d6 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/TableInsertAttempt.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/TableInsertAttempt.java @@ -1,6 +1,7 @@ package io.stargate.sgv2.jsonapi.service.operation.tables; import com.fasterxml.jackson.databind.JsonNode; +import io.stargate.sgv2.jsonapi.service.cqldriver.executor.TableSchemaObject; import io.stargate.sgv2.jsonapi.service.operation.InsertAttempt; import io.stargate.sgv2.jsonapi.service.shredding.DocRowIdentifer; import io.stargate.sgv2.jsonapi.service.shredding.tables.RowId; @@ -24,11 +25,13 @@ private TableInsertAttempt(int position, RowId rowId, WriteableTableRow row) { this.row = row; } - public static List create(RowShredder shredder, JsonNode document) { - return create(shredder, List.of(document)); + public static List create( + RowShredder shredder, TableSchemaObject table, JsonNode document) { + return create(shredder, table, List.of(document)); } - public static List create(RowShredder shredder, List documents) { + public static List create( + RowShredder shredder, TableSchemaObject table, List documents) { Objects.requireNonNull(shredder, "shredder cannot be null"); Objects.requireNonNull(documents, "documents cannot be null"); @@ -38,7 +41,7 @@ public static List create(RowShredder shredder, List { WriteableTableRow row; try { - row = shredder.shred(documents.get(i)); + row = shredder.shred(table, documents.get(i)); } catch (Exception e) { // TODO: need a shredding base excpetion to catch // TODO: we need to get the row id, so we can return it in the response diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java index 3d64cf8b27..7e2e1e75db 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindCommandResolver.java @@ -69,7 +69,8 @@ public Operation resolveTableCommand(CommandContext ctx, Find .orElse(Integer.MAX_VALUE); return new FindTableOperation( - ctx, LogicalExpression.and(), + ctx, + LogicalExpression.and(), new AllJSONProjection(new ObjectMapper()), new FindTableOperation.FindTableParams(limit)); } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java index 8a005333c4..476b90b57f 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/FindOneCommandResolver.java @@ -65,7 +65,8 @@ public Operation resolveTableCommand( CommandContext ctx, FindOneCommand command) { return new FindTableOperation( - ctx, tableFilterResolver.resolve(ctx, command), + ctx, + tableFilterResolver.resolve(ctx, command), new AllJSONProjection(new ObjectMapper()), new FindTableOperation.FindTableParams(1)); } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/InsertManyCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/InsertManyCommandResolver.java index 5f216e9798..c307732c0e 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/InsertManyCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/InsertManyCommandResolver.java @@ -72,6 +72,6 @@ public Operation resolveTableCommand( CommandContext ctx, InsertManyCommand command) { return new InsertTableOperation( - ctx, TableInsertAttempt.create(rowShredder, command.documents())); + ctx, TableInsertAttempt.create(rowShredder, ctx.schemaObject(), command.documents())); } } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/InsertOneCommandResolver.java b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/InsertOneCommandResolver.java index 8409188442..2ae1f92188 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/InsertOneCommandResolver.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/resolver/InsertOneCommandResolver.java @@ -51,6 +51,6 @@ public Operation resolveTableCommand( CommandContext ctx, InsertOneCommand command) { return new InsertTableOperation( - ctx, TableInsertAttempt.create(rowShredder, command.document())); + ctx, TableInsertAttempt.create(rowShredder, ctx.schemaObject(), command.document())); } } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/shredding/tables/RowShredder.java b/src/main/java/io/stargate/sgv2/jsonapi/service/shredding/tables/RowShredder.java index 68bbd3a804..355e51849e 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/shredding/tables/RowShredder.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/shredding/tables/RowShredder.java @@ -1,12 +1,13 @@ package io.stargate.sgv2.jsonapi.service.shredding.tables; import com.datastax.oss.driver.api.core.CqlIdentifier; -import com.fasterxml.jackson.core.JacksonException; +import com.datastax.oss.driver.api.core.metadata.schema.ColumnMetadata; import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import io.stargate.sgv2.jsonapi.api.v1.metrics.JsonProcessingMetricsReporter; import io.stargate.sgv2.jsonapi.config.DocumentLimitsConfig; -import io.stargate.sgv2.jsonapi.exception.ErrorCode; +import io.stargate.sgv2.jsonapi.service.cqldriver.executor.TableSchemaObject; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.UnknownColumnException; import jakarta.enterprise.context.ApplicationScoped; import jakarta.inject.Inject; import java.util.HashMap; @@ -39,33 +40,40 @@ public RowShredder( * @param document * @return */ - public WriteableTableRow shred(JsonNode document) { - - // HACK for now we assume the primary is a field called primary key. - - Object keyObject; - try { - keyObject = objectMapper.treeToValue(document.get("key"), Object.class); - } catch (JacksonException e) { - throw ErrorCode.SERVER_INTERNAL_ERROR.toApiException( - e, "Failed to convert row key: %s", e.getMessage()); - } + public WriteableTableRow shred(TableSchemaObject table, JsonNode document) { Map columnValues = new HashMap<>(); document .fields() .forEachRemaining( entry -> { - // using fromCQL so it is case-sensitive - try { - columnValues.put( - CqlIdentifier.fromCql(entry.getKey()), - objectMapper.treeToValue(entry.getValue(), Object.class)); - } catch (JacksonException e) { - throw ErrorCode.SERVER_INTERNAL_ERROR.toApiException( - e, "Failed to convert row value: %s", e.getMessage()); - } + // using fromCQL so it is case sensitive + + Object value = + switch (entry.getValue().getNodeType()) { + case NUMBER -> entry.getValue().decimalValue(); + case STRING -> entry.getValue().textValue(); + case BOOLEAN -> entry.getValue().booleanValue(); + case NULL -> null; + default -> throw new RuntimeException("Unsupported type"); + }; + columnValues.put(CqlIdentifier.fromCql(entry.getKey()), value); }); - return new WriteableTableRow(new RowId(new Object[] {keyObject}), columnValues); + + // the document should have been validated that all the fields present exist in the table + // and that all the primary key fields on the table have been included in the document. + var primaryKeyValues = + table.tableMetadata.getPrimaryKey().stream() + .map(ColumnMetadata::getName) + .map( + colIdentifier -> { + if (columnValues.containsKey(colIdentifier)) { + return columnValues.get(colIdentifier); + } + throw new UnknownColumnException(table.tableMetadata, colIdentifier); + }) + .toList(); + + return new WriteableTableRow(new RowId(primaryKeyValues.toArray()), columnValues); } } From b12038d892dc3b7a89ab8b94ab8161dca6f8d837 Mon Sep 17 00:00:00 2001 From: Aaron Morton Date: Fri, 26 Jul 2024 10:38:29 +1200 Subject: [PATCH 5/6] POC of JSONCodec for creating JSON Expands the JSONCode to support mapping toJSON from the objects the driver sent, to be used in the projection --- .../filters/table/NativeTypeTableFilter.java | 8 +- .../filters/table/codecs/JSONCodec.java | 146 ++++++++++++++---- .../table/codecs/JSONCodecRegistry.java | 92 ++++++++--- .../codecs/MissingJSONCodecException.java | 1 + ...xception.java => ToCQLCodecException.java} | 4 +- .../table/codecs/ToJSONCodecException.java | 25 +++ .../tables/InsertTableOperation.java | 8 +- 7 files changed, 222 insertions(+), 62 deletions(-) rename src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/{FromJavaCodecException.java => ToCQLCodecException.java} (82%) create mode 100644 src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/ToJSONCodecException.java diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java index 201cac79bc..d2a0e46bae 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/NativeTypeTableFilter.java @@ -9,9 +9,9 @@ import io.stargate.sgv2.jsonapi.service.cqldriver.executor.TableSchemaObject; import io.stargate.sgv2.jsonapi.service.operation.builder.BuiltCondition; import io.stargate.sgv2.jsonapi.service.operation.builder.BuiltConditionPredicate; -import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.FromJavaCodecException; import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.JSONCodecRegistry; import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.MissingJSONCodecException; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.ToCQLCodecException; import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.UnknownColumnException; import java.util.List; import org.slf4j.Logger; @@ -102,16 +102,16 @@ public Select apply( try { var codec = - JSONCodecRegistry.codecFor( + JSONCodecRegistry.codecToCQL( tableSchemaObject.tableMetadata, CqlIdentifier.fromCql(path), columnValue); - positionalValues.add(codec.apply(columnValue)); + positionalValues.add(codec.toCQL(columnValue)); } catch (UnknownColumnException e) { // TODO AARON - Handle error throw new RuntimeException(e); } catch (MissingJSONCodecException e) { // TODO AARON - Handle error throw new RuntimeException(e); - } catch (FromJavaCodecException e) { + } catch (ToCQLCodecException e) { // TODO AARON - Handle error throw new RuntimeException(e); } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java index 53d4a7cfd3..ed2e471b07 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java @@ -2,7 +2,8 @@ import com.datastax.oss.driver.api.core.type.DataType; import com.datastax.oss.driver.api.core.type.reflect.GenericType; -import java.util.function.BiPredicate; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; import java.util.function.Function; /** @@ -28,42 +29,71 @@ * CQL expects. * @param targetCQLType {@link DataType} of the CQL column type the Java object needs to be * transformed into. - * @param fromJava Function that transforms the Java object into the CQL object + * @param toCQL Function that transforms the Java object into the CQL object * @param The type of the Java object that needs to be transformed into the type CQL expects * @param The type Java object the CQL driver expects */ public record JSONCodec( - GenericType javaType, DataType targetCQLType, FromJava fromJava) - implements BiPredicate { + GenericType javaType, + DataType targetCQLType, + ToCQL toCQL, + ToJSON toJSON) { /** * Call to check if this codec can convert the type of the `value` into the type needed for a - * column of the `targetCQLType`. + * column of the `toCQLType`. * *

Used to filter the list of codecs to find one that works, which can then be unchecked cast * using {@link JSONCodec#unchecked(JSONCodec)} * - * @param targetCQLType {@link DataType} of the CQL column the value will be written to. + * @param toCQLType {@link DataType} of the CQL column the value will be written to. * @param value Instance of a Java value that will be written to the column. * @return True if the codec can convert the value into the type needed for the column. */ - @Override - public boolean test(DataType targetCQLType, Object value) { + public boolean testToCQL(DataType toCQLType, Object value) { // java value tests comes from TypeCodec.accepts(Object value) in the driver - return this.targetCQLType.equals(targetCQLType) + return this.targetCQLType.equals(toCQLType) && javaType.getRawType().isAssignableFrom(value.getClass()); } /** - * Applies the codec to the value. + * Applies the codec to the Java value read from a JSON document to convert it int the value the + * CQL driver expects. * * @param value Json value of type {@link JavaT} that needs to be transformed into the type CQL * expects. * @return Value of type {@link CqlT} that the CQL driver expects. - * @throws FromJavaCodecException if there was an error converting the value. + * @throws ToCQLCodecException if there was an error converting the value. */ - public CqlT apply(JavaT value) throws FromJavaCodecException { - return fromJava.apply(value, targetCQLType); + public CqlT toCQL(JavaT value) throws ToCQLCodecException { + return toCQL.apply(targetCQLType, value); + } + + /** + * Test if this codec can convert the CQL value into a JSON node. + * + *

See help for {@link #testToCQL(DataType, Object)} + * + * @param fromCQLType + * @return + */ + public boolean testToJSON(DataType fromCQLType) { + return this.targetCQLType.equals(fromCQLType); + } + + /** + * Applies the codec to the value read from the CQL Driver to create a JSON node representation of + * it. + * + * @param objectMapper {@link ObjectMapper} the codec should use if it needs one. + * @param value The value read from the CQL driver that needs to be transformed into a {@link + * JsonNode} + * @return {@link JsonNode} that represents the value only, this does not include the column name. + * @throws ToJSONCodecException Checked exception raised if any error happens, users of the codec + * should convert this into the appropriate exception for the use case. + */ + public JsonNode toJSON(ObjectMapper objectMapper, CqlT value) throws ToJSONCodecException { + return toJSON.apply(objectMapper, targetCQLType, value); } @SuppressWarnings("unchecked") @@ -76,28 +106,29 @@ public static JSONCodec unchecked(JSONCodec cod * expects. * *

The interface is used so the conversation function can throw the checked {@link - * FromJavaCodecException} and the function is also passed the target type so it can construct a - * better exception. + * ToCQLCodecException}, the function is also passed the target type, so it can construct a better + * exception. * *

Use the static constructors on the interface to get instances, see it's use in the {@link * JSONCodecRegistry} * - * @param The type of the Java object that needs to be transformed into the type CQL expects - * @param The type Java object the CQL driver expects + * @param The type of the Java object that needs to be transformed into the type CQL + * expects + * @param The type Java object the CQL driver expects */ @FunctionalInterface - public interface FromJava { + public interface ToCQL { /** - * Convers the current Java value to the type CQL expects. + * Converts the current Java value to the type CQL expects. * - * @param t - * @param targetType The type of the CQL column the value will be written to, passed so it can + * @param toCQLType The type of the CQL column the value will be written to, passed, so it can * be used when creating an exception if there was a error doing the transformation. + * @param value The Java value that needs to be transformed into the type CQL expects. * @return - * @throws FromJavaCodecException + * @throws ToCQLCodecException */ - R apply(T t, DataType targetType) throws FromJavaCodecException; + CqlT apply(DataType toCQLType, JavaT value) throws ToCQLCodecException; /** * Returns an instance that just returns the value passed in, the same as {@link @@ -106,30 +137,79 @@ public interface FromJava { *

Unsafe because it does not catch any errors from the conversion, because there are none. * * @return - * @param + * @param */ - static FromJava unsafeIdentity() { - return (t, targetType) -> t; + static ToCQL unsafeIdentity() { + return (toCQLType, value) -> value; } /** * Returns an instance that converts the value to the target type, catching any arithmetic - * exceptions and throwing them as a {@link FromJavaCodecException} + * exceptions and throwing them as a {@link ToCQLCodecException} * * @param function the function that does the conversion, it is expected it may throw a {@link * ArithmeticException} * @return - * @param - * @param + * @param + * @param */ - static FromJava safeNumber(Function function) { - return (t, targetType) -> { + static ToCQL safeNumber( + Function function) { + return (toCQLType, value) -> { try { - return function.apply(t); + return function.apply(value); } catch (ArithmeticException e) { - throw new FromJavaCodecException(t, targetType, e); + throw new ToCQLCodecException(value, toCQLType, e); } }; } } + + /** + * Function interface that is used by the codec to convert value returned by CQL into a {@link + * JsonNode} that can be used to construct the response document for a row. + * + *

The interface is used so the conversation function can throw the checked {@link + * ToJSONCodecException}, it is also given the CQL data type to make better exceptions. + * + *

Use the static constructors on the interface to get instances, see it's use in the {@link + * JSONCodecRegistry} + * + * @param The type Java object the CQL driver expects + */ + @FunctionalInterface + public interface ToJSON { + + /** + * Converts the value read from CQL to a {@link JsonNode} + * + * @param objectMapper A {@link ObjectMapper} to use to create the {@link JsonNode} if needed. + * @param fromCQLType The CQL {@link DataType} of the column that was read from CQL. + * @param value The value that was read from the CQL driver. + * @return A {@link JsonNode} that represents the value, this is just the value does not include + * the column name. + * @throws ToJSONCodecException Checked exception raised for any error, users of the function + * must catch and convert to the appropriate error for the use case. + */ + JsonNode apply(ObjectMapper objectMapper, DataType fromCQLType, CqlT value) + throws ToJSONCodecException; + + /** + * Returns an instance that will call the nodeFactoryMethod, this is typically a function from + * the {@link com.fasterxml.jackson.databind.node.JsonNodeFactory} that will create the correct + * type of node. + * + *

See usage in the {@link JSONCodecRegistry} + * + *

Unsafe because it does not catch any errors from the conversion. + * + * @param nodeFactoryMethod A function that will create a {@link JsonNode} from value of the + * {@param CqlT} type. + * @return + * @param The type of the Java value the driver returned. + */ + static ToJSON unsafeNodeFactory(Function nodeFactoryMethod) { + return (objectMapper, fromCQLType, value) -> nodeFactoryMethod.apply(value); + } + } } diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java index d6483665c9..fa6d0d02d7 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java @@ -5,6 +5,7 @@ import com.datastax.oss.driver.api.core.type.DataType; import com.datastax.oss.driver.api.core.type.DataTypes; import com.datastax.oss.driver.api.core.type.reflect.GenericType; +import com.fasterxml.jackson.databind.node.JsonNodeFactory; import com.google.common.base.Preconditions; import java.math.BigDecimal; import java.math.BigInteger; @@ -14,13 +15,12 @@ * Builds and manages the {@link JSONCodec} instances that are used to convert Java objects into the * objects expected by the CQL driver for specific CQL data types. * - *

See {@link #codecFor(TableMetadata, CqlIdentifier, Object)} for the main entry point. + *

See {@link #codecToCQL(TableMetadata, CqlIdentifier, Object)} for the main entry point. * *

IMPORTANT: There must be a codec for every CQL data type we want to write to, even if the * translation is an identity translation. This is so we know if the translation can happen, and - * then if it was done correctly with the actual value. See {@link - * JSONCodec.FromJava#unsafeIdentity()} for the identity mapping, and example usage in {@link #TEXT} - * codec. + * then if it was done correctly with the actual value. See {@link JSONCodec.ToCQL#unsafeIdentity()} + * for the identity mapping, and example usage in {@link #TEXT} codec. */ public class JSONCodecRegistry { @@ -45,7 +45,7 @@ public class JSONCodecRegistry { * @throws UnknownColumnException If the column is not found in the table. * @throws MissingJSONCodecException If no codec is found for the column and type of the value. */ - public static JSONCodec codecFor( + public static JSONCodec codecToCQL( TableMetadata table, CqlIdentifier column, Object value) throws UnknownColumnException, MissingJSONCodecException { @@ -59,13 +59,32 @@ public static JSONCodec codecFor( // compiler telling me we need to use the unchecked assignment again like the codecFor does JSONCodec codec = - JSONCodec.unchecked(internalCodecFor(columnMetadata.getType(), value)); + JSONCodec.unchecked(internalCodecForToCQL(columnMetadata.getType(), value)); if (codec != null) { return codec; } throw new MissingJSONCodecException(table, columnMetadata, value.getClass(), value); } + public static JSONCodec codecToJSON( + TableMetadata table, CqlIdentifier column) + throws UnknownColumnException, MissingJSONCodecException { + + Preconditions.checkNotNull(table, "table must not be null"); + Preconditions.checkNotNull(column, "column must not be null"); + + var columnMetadata = + table.getColumn(column).orElseThrow(() -> new UnknownColumnException(table, column)); + + // compiler telling me we need to use the unchecked assignment again like the codecFor does + JSONCodec codec = + JSONCodec.unchecked(internalCodecForToJSON(columnMetadata.getType())); + if (codec != null) { + return codec; + } + throw new MissingJSONCodecException(table, columnMetadata, null, null); + } + /** * Internal only method to find a codec for the specified type and value. * @@ -78,71 +97,106 @@ public static JSONCodec codecFor( * @param javaValue * @return The codec, or `null` if none found. */ - private static JSONCodec internalCodecFor(DataType targetCQLType, Object javaValue) { + private static JSONCodec internalCodecForToCQL(DataType targetCQLType, Object javaValue) { // BUG: needs to handle NULl value return CODECS.stream() - .filter(codec -> codec.test(targetCQLType, javaValue)) + .filter(codec -> codec.testToCQL(targetCQLType, javaValue)) + .findFirst() + .orElse(null); + } + + /** + * Same as {@link #internalCodecForToCQL(DataType, Object)} + * + * @param targetCQLType + * @return + */ + private static JSONCodec internalCodecForToJSON(DataType targetCQLType) { + return CODECS.stream() + .filter(codec -> codec.testToJSON(targetCQLType)) .findFirst() .orElse(null); } // Boolean public static final JSONCodec BOOLEAN = - new JSONCodec<>(GenericType.BOOLEAN, DataTypes.BOOLEAN, JSONCodec.FromJava.unsafeIdentity()); + new JSONCodec<>( + GenericType.BOOLEAN, + DataTypes.BOOLEAN, + JSONCodec.ToCQL.unsafeIdentity(), + JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::booleanNode)); // Numeric Codecs public static final JSONCodec BIGINT = new JSONCodec<>( GenericType.BIG_DECIMAL, DataTypes.BIGINT, - JSONCodec.FromJava.safeNumber(BigDecimal::longValueExact)); + JSONCodec.ToCQL.safeNumber(BigDecimal::longValueExact), + JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::numberNode)); public static final JSONCodec DECIMAL = new JSONCodec<>( - GenericType.BIG_DECIMAL, DataTypes.DECIMAL, JSONCodec.FromJava.unsafeIdentity()); + GenericType.BIG_DECIMAL, + DataTypes.DECIMAL, + JSONCodec.ToCQL.unsafeIdentity(), + JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::numberNode)); public static final JSONCodec DOUBLE = new JSONCodec<>( GenericType.BIG_DECIMAL, DataTypes.DOUBLE, - JSONCodec.FromJava.safeNumber(BigDecimal::doubleValue)); + JSONCodec.ToCQL.safeNumber(BigDecimal::doubleValue), + JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::numberNode)); public static final JSONCodec FLOAT = new JSONCodec<>( GenericType.BIG_DECIMAL, DataTypes.FLOAT, - JSONCodec.FromJava.safeNumber(BigDecimal::floatValue)); + JSONCodec.ToCQL.safeNumber(BigDecimal::floatValue), + JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::numberNode)); public static final JSONCodec INT = new JSONCodec<>( GenericType.BIG_DECIMAL, DataTypes.INT, - JSONCodec.FromJava.safeNumber(BigDecimal::intValueExact)); + JSONCodec.ToCQL.safeNumber(BigDecimal::intValueExact), + JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::numberNode)); public static final JSONCodec SMALLINT = new JSONCodec<>( GenericType.BIG_DECIMAL, DataTypes.SMALLINT, - JSONCodec.FromJava.safeNumber(BigDecimal::shortValueExact)); + JSONCodec.ToCQL.safeNumber(BigDecimal::shortValueExact), + JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::numberNode)); public static final JSONCodec TINYINT = new JSONCodec<>( GenericType.BIG_DECIMAL, DataTypes.TINYINT, - JSONCodec.FromJava.safeNumber(BigDecimal::byteValueExact)); + JSONCodec.ToCQL.safeNumber(BigDecimal::byteValueExact), + JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::numberNode)); public static final JSONCodec VARINT = new JSONCodec<>( GenericType.BIG_DECIMAL, DataTypes.VARINT, - JSONCodec.FromJava.safeNumber(BigDecimal::toBigIntegerExact)); + JSONCodec.ToCQL.safeNumber(BigDecimal::toBigIntegerExact), + JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::numberNode)); // Text Codecs public static final JSONCodec ASCII = - new JSONCodec<>(GenericType.STRING, DataTypes.ASCII, JSONCodec.FromJava.unsafeIdentity()); + new JSONCodec<>( + GenericType.STRING, + DataTypes.ASCII, + JSONCodec.ToCQL.unsafeIdentity(), + JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::textNode)); public static final JSONCodec TEXT = - new JSONCodec<>(GenericType.STRING, DataTypes.TEXT, JSONCodec.FromJava.unsafeIdentity()); + new JSONCodec<>( + GenericType.STRING, + DataTypes.TEXT, + JSONCodec.ToCQL.unsafeIdentity(), + JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::textNode)); /** IMPORTANT: All codecs must be added to the list here. */ static { diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java index f9922ab640..8df3767a71 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java @@ -12,6 +12,7 @@ */ public class MissingJSONCodecException extends Exception { + // TODO: both javTupe and value may be null when going toJSON public final TableMetadata table; public final ColumnMetadata column; public final Class javaType; diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/FromJavaCodecException.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/ToCQLCodecException.java similarity index 82% rename from src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/FromJavaCodecException.java rename to src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/ToCQLCodecException.java index dfa21ae264..415a2fd8fd 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/FromJavaCodecException.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/ToCQLCodecException.java @@ -2,7 +2,7 @@ import com.datastax.oss.driver.api.core.type.DataType; -public class FromJavaCodecException extends Exception { +public class ToCQLCodecException extends Exception { public final Object value; public final DataType targetCQLType; @@ -16,7 +16,7 @@ public class FromJavaCodecException extends Exception { * @param targetCQLType * @param cause */ - public FromJavaCodecException(Object value, DataType targetCQLType, Exception cause) { + public ToCQLCodecException(Object value, DataType targetCQLType, Exception cause) { super("Error trying to convert value " + value + " to " + targetCQLType, cause); this.value = value; this.targetCQLType = targetCQLType; diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/ToJSONCodecException.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/ToJSONCodecException.java new file mode 100644 index 0000000000..dabdc3797b --- /dev/null +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/ToJSONCodecException.java @@ -0,0 +1,25 @@ +package io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs; + +import com.datastax.oss.driver.api.core.type.DataType; + +public class ToJSONCodecException extends Exception { + + public final Object value; + public final DataType fromCqlType; + + /** + * TODO: confirm we want / need this, the idea is to encapsulate any exception when doing the + * conversion to to the type CQL expects. This would be a checked exception, and not something we + * expect to return to the user + * + * @param value + * @param fromCqlType + * @param cause + */ + public ToJSONCodecException(Object value, DataType fromCqlType, Exception cause) { + super( + "Error trying to convert value " + value + " from " + fromCqlType + " to JSONNode", cause); + this.value = value; + this.fromCqlType = fromCqlType; + } +} diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/InsertTableOperation.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/InsertTableOperation.java index 5f6b4d4ce6..593951296e 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/InsertTableOperation.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/InsertTableOperation.java @@ -15,9 +15,9 @@ import io.stargate.sgv2.jsonapi.service.cqldriver.executor.QueryExecutor; import io.stargate.sgv2.jsonapi.service.cqldriver.executor.TableSchemaObject; import io.stargate.sgv2.jsonapi.service.operation.InsertOperationPage; -import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.FromJavaCodecException; import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.JSONCodecRegistry; import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.MissingJSONCodecException; +import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.ToCQLCodecException; import io.stargate.sgv2.jsonapi.service.operation.filters.table.codecs.UnknownColumnException; import io.stargate.sgv2.jsonapi.service.shredding.tables.WriteableTableRow; import java.util.ArrayList; @@ -105,16 +105,16 @@ private SimpleStatement buildInsertStatement(QueryExecutor queryExecutor, Writea for (Map.Entry entry : row.allColumnValues().entrySet()) { try { var codec = - JSONCodecRegistry.codecFor( + JSONCodecRegistry.codecToCQL( commandContext.schemaObject().tableMetadata, entry.getKey(), entry.getValue()); - positionalValues.add(codec.apply(entry.getValue())); + positionalValues.add(codec.toCQL(entry.getValue())); } catch (UnknownColumnException e) { // TODO AARON - Handle error throw new RuntimeException(e); } catch (MissingJSONCodecException e) { // TODO AARON - Handle error throw new RuntimeException(e); - } catch (FromJavaCodecException e) { + } catch (ToCQLCodecException e) { // TODO AARON - Handle error throw new RuntimeException(e); } From f8511baad7206bab436bc25f9ddb6de7307b3241 Mon Sep 17 00:00:00 2001 From: Yuqi Du Date: Mon, 29 Jul 2024 12:16:03 -0700 Subject: [PATCH 6/6] fix comments and leave todos --- .../service/operation/filters/table/codecs/JSONCodec.java | 8 ++++++-- .../operation/filters/table/codecs/JSONCodecRegistry.java | 4 ++++ .../filters/table/codecs/MissingJSONCodecException.java | 2 +- .../service/operation/tables/AllJSONProjection.java | 2 +- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java index ed2e471b07..8bc3584b2a 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodec.java @@ -30,11 +30,15 @@ * @param targetCQLType {@link DataType} of the CQL column type the Java object needs to be * transformed into. * @param toCQL Function that transforms the Java object into the CQL object + * @param toJSON Function that transforms the value returned by CQL into a JsonNode * @param The type of the Java object that needs to be transformed into the type CQL expects * @param The type Java object the CQL driver expects */ public record JSONCodec( GenericType javaType, + // TODO Mahesh, The codec looks fine for primitive type. Needs a revisit when we doing complex + // types where only few fields will need to be returned. Will we be creating custom Codec based + // on user requests? DataType targetCQLType, ToCQL toCQL, ToJSON toJSON) { @@ -93,7 +97,7 @@ public boolean testToJSON(DataType fromCQLType) { * should convert this into the appropriate exception for the use case. */ public JsonNode toJSON(ObjectMapper objectMapper, CqlT value) throws ToJSONCodecException { - return toJSON.apply(objectMapper, targetCQLType, value); + return toJSON.toJson(objectMapper, targetCQLType, value); } @SuppressWarnings("unchecked") @@ -191,7 +195,7 @@ public interface ToJSON { * @throws ToJSONCodecException Checked exception raised for any error, users of the function * must catch and convert to the appropriate error for the use case. */ - JsonNode apply(ObjectMapper objectMapper, DataType fromCQLType, CqlT value) + JsonNode toJson(ObjectMapper objectMapper, DataType fromCQLType, CqlT value) throws ToJSONCodecException; /** diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java index fa6d0d02d7..ee75f06f30 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/JSONCodecRegistry.java @@ -133,6 +133,10 @@ public static JSONCodec codecToJSON( DataTypes.BIGINT, JSONCodec.ToCQL.safeNumber(BigDecimal::longValueExact), JSONCodec.ToJSON.unsafeNodeFactory(JsonNodeFactory.instance::numberNode)); + // TODO Tatu For performance reasons we could also consider only converting FP values into + // BigDecimal JsonNode -- but converting CQL integer values into long-valued JsonNode. + // I think our internal handling can deal with Integer and Long valued JsonNodes and this avoids + // some of BigDecimal overhead (avoids conversion overhead, serialization is faster). public static final JSONCodec DECIMAL = new JSONCodec<>( diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java index 8df3767a71..b7ccc3b549 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/filters/table/codecs/MissingJSONCodecException.java @@ -12,7 +12,7 @@ */ public class MissingJSONCodecException extends Exception { - // TODO: both javTupe and value may be null when going toJSON + // TODO: both javaType and value may be null when going toJSON public final TableMetadata table; public final ColumnMetadata column; public final Class javaType; diff --git a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java index 17bd875eeb..f898c7dec7 100644 --- a/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java +++ b/src/main/java/io/stargate/sgv2/jsonapi/service/operation/tables/AllJSONProjection.java @@ -31,7 +31,7 @@ public DocumentSource toDocument(Row row) { try { return objectMapper.readTree(row.getString("[json]")); } catch (Exception e) { - throw new NotImplementedException("BANG " + e.getMessage()); + throw new NotImplementedException("Not implemented " + e.getMessage()); } }; }