JAVA-2935: Make GetEntity and SetEntity methods resilient to incomplete data (#1556)

Author: adutra

changelog/README.md

@@ -4,6 +4,7 @@
 
 ### 4.12.0 (in progress)
 
+- [improvement] JAVA-2935: Make GetEntity and SetEntity methods resilient to incomplete data
 - [improvement] JAVA-2944: Upgrade MicroProfile Metrics to 3.0
 
 ### 4.11.2 (in progress)

core/src/main/java/com/datastax/oss/driver/api/core/cql/BoundStatementBuilder.java

@@ -99,6 +99,12 @@ public BoundStatementBuilder(@NonNull BoundStatement template) {
     this.node = template.getNode();
   }
 
+  /** The prepared statement that was used to create this statement. */
+  @NonNull
+  public PreparedStatement getPreparedStatement() {
+    return preparedStatement;
+  }
+
   @NonNull
   @Override
   public List<Integer> allIndicesOf(@NonNull CqlIdentifier id) {

examples/src/main/java/com/datastax/oss/driver/examples/mapper/killrvideo/user/CreateUserQueryProvider.java

@@ -116,14 +116,14 @@ private boolean insertCredentialsIfNotExists(String email, char[] password, UUID
     UserCredentials credentials =
         new UserCredentials(Objects.requireNonNull(email), passwordHash, userId);
     BoundStatementBuilder insertCredentials = preparedInsertCredentials.boundStatementBuilder();
-    credentialsHelper.set(credentials, insertCredentials, NullSavingStrategy.DO_NOT_SET);
+    credentialsHelper.set(credentials, insertCredentials, NullSavingStrategy.DO_NOT_SET, false);
     ResultSet resultSet = session.execute(insertCredentials.build());
     return resultSet.wasApplied();
   }
 
   private void insertUser(User user) {
     BoundStatementBuilder insertUser = preparedInsertUser.boundStatementBuilder();
-    userHelper.set(user, insertUser, NullSavingStrategy.DO_NOT_SET);
+    userHelper.set(user, insertUser, NullSavingStrategy.DO_NOT_SET, false);
     session.execute(insertUser.build());
   }
 }

examples/src/main/java/com/datastax/oss/driver/examples/mapper/killrvideo/user/LoginQueryProvider.java

@@ -62,7 +62,7 @@ Optional<User> login(String email, char[] password) {
                   throw new IllegalStateException(
                       "Should have found matching row for userid " + userid);
                 } else {
-                  return Optional.of(userHelper.get(userRow));
+                  return Optional.of(userHelper.get(userRow, false));
                 }
               } else {
                 return Optional.empty();

examples/src/main/java/com/datastax/oss/driver/examples/mapper/killrvideo/video/CreateVideoQueryProvider.java

@@ -95,7 +95,7 @@ private static <T> PreparedStatement prepareInsert(
   private static <T> BoundStatement bind(
       PreparedStatement preparedStatement, T entity, EntityHelper<T> entityHelper) {
     BoundStatementBuilder boundStatement = preparedStatement.boundStatementBuilder();
-    entityHelper.set(entity, boundStatement, NullSavingStrategy.DO_NOT_SET);
+    entityHelper.set(entity, boundStatement, NullSavingStrategy.DO_NOT_SET, false);
     return boundStatement.build();
   }
 

integration-tests/src/test/java/com/datastax/oss/driver/mapper/GetEntityIT.java

@@ -16,6 +16,7 @@
 package com.datastax.oss.driver.mapper;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.catchThrowable;
 
 import com.datastax.oss.driver.api.core.CqlIdentifier;
 import com.datastax.oss.driver.api.core.CqlSession;
@@ -25,6 +26,8 @@
 import com.datastax.oss.driver.api.core.cql.ResultSet;
 import com.datastax.oss.driver.api.core.cql.Row;
 import com.datastax.oss.driver.api.core.cql.SimpleStatement;
+import com.datastax.oss.driver.api.core.data.UdtValue;
+import com.datastax.oss.driver.api.core.type.UserDefinedType;
 import com.datastax.oss.driver.api.mapper.annotations.Dao;
 import com.datastax.oss.driver.api.mapper.annotations.DaoFactory;
 import com.datastax.oss.driver.api.mapper.annotations.DaoKeyspace;
@@ -38,6 +41,7 @@
 import com.datastax.oss.driver.categories.ParallelizableTests;
 import com.datastax.oss.driver.internal.core.util.concurrent.CompletableFutures;
 import com.datastax.oss.driver.shaded.guava.common.collect.Sets;
+import java.util.UUID;
 import java.util.stream.Stream;
 import org.junit.BeforeClass;
 import org.junit.ClassRule;
@@ -56,6 +60,8 @@ public class GetEntityIT extends InventoryITBase {
   @ClassRule
   public static final TestRule CHAIN = RuleChain.outerRule(CCM_RULE).around(SESSION_RULE);
 
+  private static final UUID PRODUCT_2D_ID = UUID.randomUUID();
+
   private static ProductDao dao;
 
   @BeforeClass
@@ -67,6 +73,18 @@ public static void setup() {
           SimpleStatement.builder(query).setExecutionProfile(SESSION_RULE.slowProfile()).build());
     }
 
+    UserDefinedType dimensions2d =
+        session
+            .getKeyspace()
+            .flatMap(ks -> session.getMetadata().getKeyspace(ks))
+            .flatMap(ks -> ks.getUserDefinedType("dimensions2d"))
+            .orElseThrow(AssertionError::new);
+    session.execute(
+        "INSERT INTO product2d (id, description, dimensions) VALUES (?, ?, ?)",
+        PRODUCT_2D_ID,
+        "2D product",
+        dimensions2d.newValue(12, 34));
+
     InventoryMapper inventoryMapper = new GetEntityIT_InventoryMapperBuilder(session).build();
     dao = inventoryMapper.productDao(SESSION_RULE.keyspace());
 
@@ -75,19 +93,98 @@ public static void setup() {
   }
 
   @Test
-  public void should_get_entity_from_row() {
+  public void should_get_entity_from_complete_row() {
     CqlSession session = SESSION_RULE.session();
     ResultSet rs =
         session.execute(
             SimpleStatement.newInstance(
-                "SELECT * FROM product WHERE id = ?", FLAMETHROWER.getId()));
+                "SELECT id, description, dimensions, now() FROM product WHERE id = ?",
+                FLAMETHROWER.getId()));
     Row row = rs.one();
     assertThat(row).isNotNull();
 
     Product product = dao.get(row);
     assertThat(product).isEqualTo(FLAMETHROWER);
   }
 
+  @Test
+  public void should_not_get_entity_from_partial_row_when_not_lenient() {
+    CqlSession session = SESSION_RULE.session();
+    ResultSet rs =
+        session.execute(
+            SimpleStatement.newInstance(
+                "SELECT id, description, now() FROM product WHERE id = ?", FLAMETHROWER.getId()));
+    Row row = rs.one();
+    assertThat(row).isNotNull();
+
+    Throwable error = catchThrowable(() -> dao.get(row));
+    assertThat(error).hasMessage("dimensions is not a column in this row");
+  }
+
+  @Test
+  public void should_get_entity_from_partial_row_when_lenient() {
+    CqlSession session = SESSION_RULE.session();
+    ResultSet rs =
+        session.execute(
+            SimpleStatement.newInstance(
+                "SELECT id, dimensions FROM product2d WHERE id = ?", PRODUCT_2D_ID));
+    Row row = rs.one();
+    assertThat(row).isNotNull();
+
+    Product product = dao.getLenient(row);
+    assertThat(product.getId()).isEqualTo(PRODUCT_2D_ID);
+    assertThat(product.getDescription()).isNull();
+    assertThat(product.getDimensions()).isNotNull();
+    assertThat(product.getDimensions().getWidth()).isEqualTo(12);
+    assertThat(product.getDimensions().getHeight()).isEqualTo(34);
+    assertThat(product.getDimensions().getLength()).isZero();
+  }
+
+  @Test
+  public void should_get_entity_from_complete_udt_value() {
+    CqlSession session = SESSION_RULE.session();
+    ResultSet rs =
+        session.execute(
+            SimpleStatement.newInstance(
+                "SELECT dimensions FROM product WHERE id = ?", FLAMETHROWER.getId()));
+    Row row = rs.one();
+    assertThat(row).isNotNull();
+
+    Dimensions dimensions = dao.get(row.getUdtValue(0));
+    assertThat(dimensions).isEqualTo(FLAMETHROWER.getDimensions());
+  }
+
+  @Test
+  public void should_not_get_entity_from_partial_udt_value_when_not_lenient() {
+    CqlSession session = SESSION_RULE.session();
+    ResultSet rs =
+        session.execute(
+            SimpleStatement.newInstance(
+                "SELECT dimensions FROM product2d WHERE id = ?", PRODUCT_2D_ID));
+    Row row = rs.one();
+    assertThat(row).isNotNull();
+
+    Throwable error = catchThrowable(() -> dao.get(row.getUdtValue(0)));
+    assertThat(error).hasMessage("length is not a field in this UDT");
+  }
+
+  @Test
+  public void should_get_entity_from_partial_udt_value_when_lenient() {
+    CqlSession session = SESSION_RULE.session();
+    ResultSet rs =
+        session.execute(
+            SimpleStatement.newInstance(
+                "SELECT dimensions FROM product2d WHERE id = ?", PRODUCT_2D_ID));
+    Row row = rs.one();
+    assertThat(row).isNotNull();
+
+    Dimensions dimensions = dao.getLenient(row.getUdtValue(0));
+    assertThat(dimensions).isNotNull();
+    assertThat(dimensions.getWidth()).isEqualTo(12);
+    assertThat(dimensions.getHeight()).isEqualTo(34);
+    assertThat(dimensions.getLength()).isZero();
+  }
+
   @Test
   public void should_get_entity_from_first_row_of_result_set() {
     CqlSession session = SESSION_RULE.session();
@@ -144,9 +241,19 @@ public interface InventoryMapper {
   @Dao
   @DefaultNullSavingStrategy(NullSavingStrategy.SET_TO_NULL)
   public interface ProductDao {
+
     @GetEntity
     Product get(Row row);
 
+    @GetEntity(lenient = true)
+    Product getLenient(Row row);
+
+    @GetEntity
+    Dimensions get(UdtValue row);
+
+    @GetEntity(lenient = true)
+    Dimensions getLenient(UdtValue row);
+
     @GetEntity
     PagingIterable<Product> get(ResultSet resultSet);
 

integration-tests/src/test/java/com/datastax/oss/driver/mapper/GuavaFutureProducerService.java

@@ -106,7 +106,7 @@ protected Object convert(
         @NonNull AsyncResultSet resultSet, @Nullable EntityHelper<?> entityHelper) {
       assert entityHelper != null;
       Row row = resultSet.one();
-      return (row == null) ? null : entityHelper.get(row);
+      return (row == null) ? null : entityHelper.get(row, false);
     }
   }
 }