Expose compiled SQL for SqlTemplate to improve transparency (#1610) (#1613)

See #1609

The compiled SQL query is computed as soon as the template is created.
It can be exposed for inspection by users (e.g. logging).

Signed-off-by: Thomas Segismont <tsegismont@gmail.com>

Author: tsegismont

vertx-sql-client-templates/src/main/java/io/vertx/sqlclient/templates/SqlTemplate.java

@@ -69,6 +69,12 @@ static SqlTemplate<Map<String, Object>, SqlResult<Void>> forUpdate(SqlClient cli
     return new SqlTemplateImpl<>(client, sqlTemplate, query -> query.collecting(SqlTemplateImpl.NULL_COLLECTOR), sqlTemplate::mapTuple);
   }
 
+
+  /**
+   * @return the computed SQL for this template
+   */
+  String getSql();
+
   /**
    * Set a parameters user defined mapping function.
    *

vertx-sql-client-templates/src/main/java/io/vertx/sqlclient/templates/impl/SqlTemplateImpl.java

@@ -4,12 +4,7 @@
 import io.vertx.core.Future;
 import io.vertx.core.Handler;
 import io.vertx.core.json.JsonObject;
-import io.vertx.sqlclient.PreparedQuery;
-import io.vertx.sqlclient.Row;
-import io.vertx.sqlclient.RowSet;
-import io.vertx.sqlclient.SqlClient;
-import io.vertx.sqlclient.SqlResult;
-import io.vertx.sqlclient.Tuple;
+import io.vertx.sqlclient.*;
 import io.vertx.sqlclient.templates.RowMapper;
 import io.vertx.sqlclient.templates.TupleMapper;
 
@@ -39,6 +34,11 @@ public SqlTemplateImpl(SqlClient client,
     this.tupleMapper = tupleMapper;
   }
 
+  @Override
+  public String getSql() {
+    return sqlTemplate.getSql();
+  }
+
   @Override
   public <T> io.vertx.sqlclient.templates.SqlTemplate<T, R> mapFrom(TupleMapper<T> mapper) {
     return new SqlTemplateImpl<>(client, sqlTemplate, queryMapper, params -> mapper.map(sqlTemplate, sqlTemplate.numberOfParams(), params));

vertx-sql-client-templates/src/test/java/io/vertx/sqlclient/templates/PgTemplateTestBase.java

@@ -6,7 +6,6 @@
 import io.vertx.ext.unit.junit.VertxUnitRunner;
 import io.vertx.pgclient.PgConnectOptions;
 import io.vertx.pgclient.PgConnection;
-import io.vertx.sqlclient.Row;
 import io.vertx.sqlclient.RowSet;
 import org.junit.After;
 import org.junit.AfterClass;
@@ -15,7 +14,6 @@
 import org.junit.runner.RunWith;
 import org.testcontainers.containers.PostgreSQLContainer;
 
-import java.util.Map;
 import java.util.function.Function;
 
 @RunWith(VertxUnitRunner.class)
@@ -84,11 +82,15 @@ protected <P, T, V> void testGet(TestContext ctx,
                                    Function<T, V> extractor,
                                    String column) {
     Async async = ctx.async();
+    String query = "SELECT %s :: %s \"%s\"";
     SqlTemplate<P, RowSet<T>> template = SqlTemplate
-      .forQuery(connection, "SELECT #{" + paramName + "} :: " + sqlType + " \"" + column + "\"")
+      .forQuery(connection, String.format(query, "#{" + paramName + "}", sqlType, column))
       .mapFrom(paramsMapper)
       .mapTo(rowMapper);
-    template.execute(params, ctx.asyncAssertSuccess(result -> {
+    ctx.assertEquals(String.format(query, "$1", sqlType, column), template.getSql());
+    template
+      .execute(params)
+      .onComplete(ctx.asyncAssertSuccess(result -> {
       ctx.assertEquals(1, result.size());
       ctx.assertEquals(expected, extractor.apply(result.iterator().next()));
       async.complete();