Enable removal of comments from SQL templates (#1134)

* Enable removal of comments from SQL templates

* Determine removal based on comment content

Author: nakamura-to

doma-core/src/main/java/org/seasar/doma/internal/jdbc/sql/SqlParser.java

@@ -48,6 +48,7 @@
 import org.seasar.doma.internal.util.StringUtil;
 import org.seasar.doma.jdbc.JdbcException;
 import org.seasar.doma.jdbc.SqlNode;
+import org.seasar.doma.jdbc.SqlParserConfig;
 import org.seasar.doma.message.Message;
 
 public class SqlParser {
@@ -59,6 +60,8 @@ public class SqlParser {
 
   protected final String sql;
 
+  protected final SqlParserConfig config;
+
   protected final SqlTokenizer tokenizer;
 
   protected final AnonymousNode rootNode;
@@ -68,8 +71,13 @@ public class SqlParser {
   protected String token;
 
   public SqlParser(String sql) {
-    assertNotNull(sql);
+    this(sql, SqlParserConfig.DEFAULT);
+  }
+
+  public SqlParser(String sql, SqlParserConfig config) {
+    assertNotNull(sql, config);
     this.sql = sql;
+    this.config = config;
     tokenizer = new SqlTokenizer(sql);
     rootNode = new AnonymousNode();
     nodeStack.push(rootNode);
@@ -227,9 +235,13 @@ public SqlNode parse() {
             break;
           }
         case BLOCK_COMMENT:
+          {
+            parseBlockComment();
+            break;
+          }
         case LINE_COMMENT:
           {
-            parseComment();
+            parseLineComment();
             break;
           }
         case OTHER:
@@ -411,9 +423,18 @@ protected void parseDistinctWord() {
     appendNode(node);
   }
 
-  protected void parseComment() {
-    CommentNode node = new CommentNode(token);
-    appendNode(node);
+  protected void parseBlockComment() {
+    if (!config.shouldRemoveBlockComment(token)) {
+      CommentNode node = new CommentNode(token);
+      appendNode(node);
+    }
+  }
+
+  protected void parseLineComment() {
+    if (!config.shouldRemoveLineComment(token)) {
+      CommentNode node = new CommentNode(token);
+      appendNode(node);
+    }
   }
 
   protected void parseOpenedParens() {

doma-core/src/main/java/org/seasar/doma/jdbc/AbstractSqlFileRepository.java

@@ -16,6 +16,16 @@
 /** A skeletal implementation of the {@link SqlFileRepository} interface. */
 public abstract class AbstractSqlFileRepository implements SqlFileRepository {
 
+  protected final SqlParserConfig sqlParserConfig;
+
+  protected AbstractSqlFileRepository() {
+    this(SqlParserConfig.DEFAULT);
+  }
+
+  protected AbstractSqlFileRepository(SqlParserConfig sqlParserConfig) {
+    this.sqlParserConfig = Objects.requireNonNull(sqlParserConfig);
+  }
+
   @Override
   public final SqlFile getSqlFile(Method method, String path, Dialect dialect) {
     if (method == null) {
@@ -100,7 +110,7 @@ protected final String getPrimaryPath(String path, Dialect dialect) {
    * @return the SQL node
    */
   protected final SqlNode parse(String sql) {
-    SqlParser parser = new SqlParser(sql);
+    SqlParser parser = new SqlParser(sql, sqlParserConfig);
     return parser.parse();
   }
 

doma-core/src/main/java/org/seasar/doma/jdbc/GreedyCacheSqlFileRepository.java

@@ -10,6 +10,12 @@ public class GreedyCacheSqlFileRepository extends AbstractSqlFileRepository {
 
   protected final ConcurrentMap<CacheKey, SqlFile> sqlFileMap = new ConcurrentHashMap<>(200);
 
+  public GreedyCacheSqlFileRepository() {}
+
+  public GreedyCacheSqlFileRepository(SqlParserConfig sqlParserConfig) {
+    super(sqlParserConfig);
+  }
+
   @Override
   protected SqlFile getSqlFileWithCacheControl(Method method, String path, Dialect dialect) {
     CacheKey key = new CacheKey(method, path);

doma-core/src/main/java/org/seasar/doma/jdbc/NoCacheSqlFileRepository.java

@@ -6,6 +6,12 @@
 /** An SQL file repository that does not cache the results of SQL parsing. */
 public class NoCacheSqlFileRepository extends AbstractSqlFileRepository {
 
+  public NoCacheSqlFileRepository() {}
+
+  public NoCacheSqlFileRepository(SqlParserConfig sqlParserConfig) {
+    super(sqlParserConfig);
+  }
+
   @Override
   protected SqlFile getSqlFileWithCacheControl(Method method, String path, Dialect dialect) {
     return createSqlFile(method, path, dialect);

doma-core/src/main/java/org/seasar/doma/jdbc/SqlParserConfig.java

@@ -0,0 +1,35 @@
+package org.seasar.doma.jdbc;
+
+/** A configuration for SQL parser. */
+public interface SqlParserConfig {
+
+  /** The default implementation. */
+  SqlParserConfig DEFAULT =
+      new SqlParserConfig() {
+        @Override
+        public boolean shouldRemoveBlockComment(String comment) {
+          return false;
+        }
+
+        @Override
+        public boolean shouldRemoveLineComment(String comment) {
+          return false;
+        }
+      };
+
+  /**
+   * Returns whether block comments should be removed.
+   *
+   * @param comment the block comment
+   * @return whether block comments should be removed
+   */
+  boolean shouldRemoveBlockComment(String comment);
+
+  /**
+   * Returns whether line comments should be removed.
+   *
+   * @param comment the line comment
+   * @return whether line comments should be removed
+   */
+  boolean shouldRemoveLineComment(String comment);
+}

doma-core/src/test/java/org/seasar/doma/internal/jdbc/sql/SqlParserTest.java

@@ -22,6 +22,7 @@
 import org.seasar.doma.jdbc.SqlKind;
 import org.seasar.doma.jdbc.SqlLogType;
 import org.seasar.doma.jdbc.SqlNode;
+import org.seasar.doma.jdbc.SqlParserConfig;
 import org.seasar.doma.message.Message;
 
 public class SqlParserTest {
@@ -967,6 +968,54 @@ public void testDelimiter() {
     assertEquals("select 1;", sql.getRawSql());
   }
 
+  @Test
+  public void testSqlParserConfig_default() {
+    ExpressionEvaluator evaluator = new ExpressionEvaluator();
+    evaluator.add("name", new Value(String.class, "hoge"));
+    evaluator.add("salary", new Value(BigDecimal.class, new BigDecimal(10000)));
+    String testSql =
+        "select * from aaa where ename = /** block comment */bbb -- line comment 1\norder by ccc-- line comment 2";
+    SqlParser parser = new SqlParser(testSql, SqlParserConfig.DEFAULT);
+    SqlNode sqlNode = parser.parse();
+    PreparedSql sql =
+        new NodePreparedSqlBuilder(
+                config, SqlKind.SELECT, "dummyPath", evaluator, SqlLogType.FORMATTED)
+            .build(sqlNode, Function.identity());
+    assertEquals(
+        "select * from aaa where ename = /** block comment */bbb -- line comment 1\norder by ccc-- line comment 2",
+        sql.getRawSql());
+  }
+
+  @Test
+  public void testSqlParserConfig_removeAllComments() {
+    SqlParserConfig sqlParserConfig =
+        new SqlParserConfig() {
+
+          @Override
+          public boolean shouldRemoveBlockComment(String comment) {
+            return true;
+          }
+
+          @Override
+          public boolean shouldRemoveLineComment(String comment) {
+            return true;
+          }
+        };
+
+    ExpressionEvaluator evaluator = new ExpressionEvaluator();
+    evaluator.add("name", new Value(String.class, "hoge"));
+    evaluator.add("salary", new Value(BigDecimal.class, new BigDecimal(10000)));
+    String testSql =
+        "select * from aaa where ename = /** block comment */bbb -- line comment 1\norder by ccc-- line comment 2";
+    SqlParser parser = new SqlParser(testSql, sqlParserConfig);
+    SqlNode sqlNode = parser.parse();
+    PreparedSql sql =
+        new NodePreparedSqlBuilder(
+                config, SqlKind.SELECT, "dummyPath", evaluator, SqlLogType.FORMATTED)
+            .build(sqlNode, Function.identity());
+    assertEquals("select * from aaa where ename = bbb \norder by ccc", sql.getRawSql());
+  }
+
   public enum MyEnum {
     AAA,
     BBB,

integration-test-common/src/main/java/org/seasar/doma/it/AppConfig.java

@@ -3,10 +3,12 @@
 import java.util.Objects;
 import javax.sql.DataSource;
 import org.seasar.doma.jdbc.Config;
+import org.seasar.doma.jdbc.GreedyCacheSqlFileRepository;
 import org.seasar.doma.jdbc.JdbcLogger;
 import org.seasar.doma.jdbc.Naming;
 import org.seasar.doma.jdbc.RequiresNewController;
 import org.seasar.doma.jdbc.SimpleDataSource;
+import org.seasar.doma.jdbc.SqlFileRepository;
 import org.seasar.doma.jdbc.dialect.Dialect;
 import org.seasar.doma.jdbc.tx.LocalTransaction;
 import org.seasar.doma.jdbc.tx.LocalTransactionDataSource;
@@ -28,6 +30,9 @@ public class AppConfig implements Config {
 
   private final LocalTransactionManager transactionManager;
 
+  private final SqlFileRepository sqlFileRepository =
+      new GreedyCacheSqlFileRepository(new LineCommentRemovalSqlParserConfig());
+
   public AppConfig(Dialect dialect, Dbms dbms, String url, String user, String password) {
     Objects.requireNonNull(dialect);
     Objects.requireNonNull(dbms);
@@ -101,4 +106,9 @@ public Naming getNaming() {
   public JdbcLogger getJdbcLogger() {
     return jdbcLogger;
   }
+
+  @Override
+  public SqlFileRepository getSqlFileRepository() {
+    return sqlFileRepository;
+  }
 }

integration-test-common/src/main/java/org/seasar/doma/it/LineCommentRemovalSqlParserConfig.java

@@ -0,0 +1,16 @@
+package org.seasar.doma.it;
+
+import org.seasar.doma.jdbc.SqlParserConfig;
+
+public class LineCommentRemovalSqlParserConfig implements SqlParserConfig {
+
+  @Override
+  public boolean shouldRemoveBlockComment(String comment) {
+    return false;
+  }
+
+  @Override
+  public boolean shouldRemoveLineComment(String comment) {
+    return true;
+  }
+}

integration-test-java/src/main/resources/META-INF/org/seasar/doma/it/dao/EmployeeDao/selectById.sql

@@ -1 +1,9 @@
-select * from EMPLOYEE where EMPLOYEE_ID = /*employeeId*/0
+/**
+ * This comment will not be removed
+ */
+select
+  * 
+from
+  EMPLOYEE -- this comment will be removed
+where  
+  EMPLOYEE_ID = /*employeeId*/0 -- this comment will be also removed