Issue helidon-io#8613 - Consider missing named parameters values in the parameters Map as null

Signed-off-by: Tomáš Kraus <tomas.kraus@oracle.com>

Author: Tomáš Kraus

dbclient/dbclient/src/main/java/io/helidon/dbclient/DbClientBuilderBase.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2023, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,6 +39,7 @@ public abstract class DbClientBuilderBase<T extends DbClientBuilderBase<T>>
     private String url;
     private String username;
     private String password;
+    private boolean missingMapParametersAsNull;
     private DbStatements statements;
     private MapperManager mapperManager;
     private DbMapperManager dbMapperManager;
@@ -49,6 +50,7 @@ public abstract class DbClientBuilderBase<T extends DbClientBuilderBase<T>>
      */
     protected DbClientBuilderBase() {
         this.clientServices = new LinkedList<>();
+        this.missingMapParametersAsNull = false;
     }
 
     @Override
@@ -71,6 +73,7 @@ public DbClient build() {
 
     @Override
     public T config(Config config) {
+        config.get("missing-map-parameters-as-null").as(Boolean.class).ifPresent(this::missingMapParametersAsNull);
         config.get("statements").map(DbStatements::create).ifPresent(this::statements);
         return identity();
     }
@@ -93,6 +96,12 @@ public T password(String password) {
         return identity();
     }
 
+    @Override
+    public T missingMapParametersAsNull(boolean missingMapParametersAsNull) {
+        this.missingMapParametersAsNull = missingMapParametersAsNull;
+        return identity();
+    }
+
     @Override
     public T statements(DbStatements statements) {
         this.statements = statements;
@@ -185,6 +194,17 @@ public String password() {
         return password;
     }
 
+    /**
+     * Configured missing values in named parameters {@link java.util.Map} handling.
+     *
+     * @return when set to {@code true}, named parameters value missing in the {@code Map} is considered
+     *         as {@code null}, when set to {@code false}, any parameter value missing in the {@code Map}
+     *         will cause an exception.
+     */
+    public boolean missingMapParametersAsNull() {
+        return missingMapParametersAsNull;
+    }
+
     /**
      * Get configured statements to be used by database provider.
      *

dbclient/dbclient/src/main/java/io/helidon/dbclient/DbClientContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2020, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2020, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,6 +29,7 @@ public class DbClientContext implements DbContext {
     private final DbMapperManager dbMapperManager;
     private final MapperManager mapperManager;
     private final List<DbClientService> clientServices;
+    private final boolean missingMapParametersAsNull;
     private final DbStatements statements;
     private final String dbType;
 
@@ -42,10 +43,16 @@ protected DbClientContext(
         this.dbMapperManager = builder.dbMapperManager;
         this.mapperManager = builder.mapperManager;
         this.clientServices = builder.clientServices;
+        this.missingMapParametersAsNull = builder.missingMapParametersAsNull;
         this.statements = builder.statements;
         this.dbType = builder.dbType;
     }
 
+    @Override
+    public boolean missingMapParametersAsNull() {
+        return missingMapParametersAsNull;
+    }
+
     @Override
     public DbStatements statements() {
         return statements;
@@ -107,13 +114,15 @@ public abstract static class BuilderBase<B extends BuilderBase<B, T>, T extends
         private DbMapperManager dbMapperManager;
         private MapperManager mapperManager;
         private List<DbClientService> clientServices = List.of();
+        private boolean missingMapParametersAsNull;
         private DbStatements statements;
         private String dbType;
 
         /**
          * Creates an instance of base builder for {@link DbClientContext}.
          */
         protected BuilderBase() {
+            this.missingMapParametersAsNull = false;
         }
 
         /**
@@ -149,6 +158,20 @@ public B clientServices(List<DbClientService> clientServices) {
             return identity();
         }
 
+        /**
+         * Missing values in named parameters {@link java.util.Map} are considered as null values.
+         * When set to {@code true}, named parameters value missing in the {@code Map} is considered
+         * as {@code null}. When set to {@code false}, any parameter value missing in the {@code Map}
+         * will cause an exception.
+         * @param missingMapParametersAsNull whether missing values in named parameters {@code Map}
+         *                                   are considered as null values
+         * @return updated builder instance
+         */
+        public B missingMapParametersAsNull(boolean missingMapParametersAsNull) {
+            this.missingMapParametersAsNull = missingMapParametersAsNull;
+            return identity();
+        }
+
         /**
          * Configure the db statements to use.
          *

dbclient/dbclient/src/main/java/io/helidon/dbclient/DbContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2023, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,6 +24,15 @@
  */
 public interface DbContext {
 
+    /**
+     * Configured missing values in named parameters {@link java.util.Map} handling.
+     *
+     * @return when set to {@code true}, named parameters value missing in the {@code Map} is considered
+     *         as {@code null}, when set to {@code false}, any parameter value missing in the {@code Map}
+     *         will cause an exception.
+     */
+    boolean missingMapParametersAsNull();
+
     /**
      * Configured statements.
      *

dbclient/dbclient/src/main/java/io/helidon/dbclient/DbExecuteContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2023, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -58,6 +58,11 @@ public String statement() {
         return statement;
     }
 
+    @Override
+    public boolean missingMapParametersAsNull() {
+        return clientContext.missingMapParametersAsNull();
+    }
+
     @Override
     public DbStatements statements() {
         return clientContext.statements();

dbclient/dbclient/src/main/java/io/helidon/dbclient/spi/DbClientBuilder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2019, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -64,6 +64,17 @@ public interface DbClientBuilder<T extends DbClientBuilder<T>> extends Builder<T
      */
     T password(String password);
 
+    /**
+     * Missing values in named parameters {@link java.util.Map} are considered as null values.
+     * When set to {@code true}, named parameters value missing in the {@code Map} is considered
+     * as {@code null}. When set to {@code false}, any parameter value missing in the {@code Map}
+     * will cause an exception.
+     * @param missingMapParametersAsNull whether missing values in named parameters {@code Map}
+     *                                   are considered as null values
+     * @return updated builder instance
+     */
+    T missingMapParametersAsNull(boolean missingMapParametersAsNull);
+
     /**
      * Statements to use either from configuration
      * or manually configured.

dbclient/jdbc/src/main/java/io/helidon/dbclient/jdbc/JdbcClient.java

@@ -36,6 +36,7 @@ class JdbcClient extends DbClientBase implements DbClient {
      */
     JdbcClient(JdbcClientBuilder builder) {
         super(JdbcClientContext.jdbcBuilder()
+                .missingMapParametersAsNull(builder.missingMapParametersAsNull())
                 .statements(builder.statements())
                 .dbMapperManager(builder.dbMapperManager())
                 .mapperManager(builder.mapperManager())

dbclient/jdbc/src/main/java/io/helidon/dbclient/jdbc/JdbcStatement.java

@@ -152,7 +152,13 @@ private PreparedStatement prepareNamedStatement(String stmtName, String stmt, Ma
                     setParameter(preparedStatement, i, value);
                     i++;
                 } else {
-                    throw new DbClientException(namedStatementErrorMessage(namesOrder, parameters));
+                    if (context().missingMapParametersAsNull()) {
+                        LOGGER.log(Level.TRACE, String.format("Mapped parameter %d: %s -> null", i, name));
+                        setParameter(preparedStatement, i, null);
+                        i++;
+                    } else {
+                        throw new DbClientException(namedStatementErrorMessage(namesOrder, parameters));
+                    }
                 }
             }
             return preparedStatement;

tests/integration/dbclient/common/src/main/java/io/helidon/tests/integration/dbclient/common/tests/QueryStatementIT.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2019, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,6 +29,9 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 
 import static io.helidon.tests.integration.dbclient.common.utils.VerifyData.verifyPokemonsIdRange;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.hasSize;
+import static org.hamcrest.Matchers.notNullValue;
 
 /**
  * Test DbStatementQuery methods.
@@ -87,6 +90,19 @@ public void testQueryMapParams() {
         verifyPokemonsIdRange(rows, 1, 7);
     }
 
+    @Test
+    public void testQueryMapMissingParams() {
+        Map<String, Integer> params = new HashMap<>(2);
+        params.put("id", 1);
+        Stream<DbRow> rows = dbClient.execute()
+                .createNamedQuery("select-pokemons-idname-named-arg")
+                .params(params)
+                .execute();
+        assertThat(rows, notNullValue());
+        List<DbRow> rowsList = rows.toList();
+        assertThat(rowsList, hasSize(0));
+    }
+
     /**
      * Verify {@code addParam(Object parameter)} parameters setting method.
      */

tests/integration/dbclient/h2/pom.xml

@@ -129,27 +129,6 @@
                         <include>io.helidon.tests.integration.dbclient.common.tests.*IT</include>
                     </includes>
                 </configuration>
-                <executions>
-                    <execution>
-                        <id>test</id>
-                        <phase>integration-test</phase>
-                        <goals>
-                            <goal>integration-test</goal>
-                        </goals>
-                    </execution>
-                </executions>
-            </plugin>
-            <!--plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-failsafe-plugin</artifactId>
-                <configuration>
-                    <redirectTestOutputToFile>${maven.test.redirectTestOutputToFile}</redirectTestOutputToFile>
-                    <parallel>methods</parallel>
-                    <threadCount>10</threadCount>
-                    <systemPropertyVariables>
-                        <junit.jupiter.extensions.autodetection.enabled>true</junit.jupiter.extensions.autodetection.enabled>
-                    </systemPropertyVariables>
-                </configuration>
                 <executions>
                     <execution>
                         <id>test</id>
@@ -158,14 +137,9 @@
                             <goal>integration-test</goal>
                             <goal>verify</goal>
                         </goals>
-                        <configuration>
-                            <includes>
-                                <include>**/*SuiteIT</include>
-                            </includes>
-                        </configuration>
                     </execution>
                 </executions>
-            </plugin-->
+            </plugin>
         </plugins>
     </build>
 </project>

tests/integration/dbclient/h2/src/test/resources/h2.yaml

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2019, 2023 Oracle and/or its affiliates.
+# Copyright (c) 2019, 2024 Oracle and/or its affiliates.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -19,6 +19,7 @@ db:
   port: 9092
   password: "password"
   database: "test"
+  missing-map-parameters-as-null: true
   connection:
     url: jdbc:h2:tcp://${db.host}:${db.port}/${db.database};DATABASE_TO_UPPER=FALSE
   health-check:
@@ -56,6 +57,7 @@ db:
     select-pokemons-idrng-named-arg: "SELECT id, name FROM Pokemons WHERE id > :idmin AND id < :idmax"
     select-pokemons-idrng-order-arg: "SELECT id, name FROM Pokemons WHERE id > ? AND id < ?"
     select-pokemons-error-arg: "SELECT id, name FROM Pokemons WHERE id > :id AND name = ?"
+    select-pokemons-idname-named-arg: "SELECT id, name FROM Pokemons WHERE name=:name AND id=:id"
 
 test:
   ping-dml: false