Merge pull request #1663 from YouUWd/master

fix queryCusor() fails in streaming mode of MySQL Connector/J (fetchSize=Integer.MIN_VALUE) #1654

This is a workaround for https://bugs.mysql.com/bug.php?id=96786

Author: harawata

pom.xml

@@ -252,6 +252,12 @@
       <version>42.2.5</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>mysql</groupId>
+      <artifactId>mysql-connector-java</artifactId>
+      <version>8.0.17</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>org.assertj</groupId>
       <artifactId>assertj-core</artifactId>
@@ -267,13 +273,19 @@
     <dependency>
       <groupId>org.testcontainers</groupId>
       <artifactId>junit-jupiter</artifactId>
-      <version>1.11.2</version>
+      <version>1.12.1</version>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.testcontainers</groupId>
       <artifactId>postgresql</artifactId>
-      <version>1.11.2</version>
+      <version>1.12.1</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.testcontainers</groupId>
+      <artifactId>mysql</artifactId>
+      <version>1.12.1</version>
       <scope>test</scope>
     </dependency>
   </dependencies>

src/main/java/org/apache/ibatis/executor/BatchExecutor.java

@@ -102,9 +102,10 @@ protected <E> Cursor<E> doQueryCursor(MappedStatement ms, Object parameter, RowB
     StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameter, rowBounds, null, boundSql);
     Connection connection = getConnection(ms.getStatementLog());
     Statement stmt = handler.prepare(connection, transaction.getTimeout());
-    stmt.closeOnCompletion();
     handler.parameterize(stmt);
-    return handler.queryCursor(stmt);
+    Cursor<E> cursor = handler.queryCursor(stmt);
+    stmt.closeOnCompletion();
+    return cursor;
   }
 
   @Override

src/main/java/org/apache/ibatis/executor/SimpleExecutor.java

@@ -71,8 +71,9 @@ protected <E> Cursor<E> doQueryCursor(MappedStatement ms, Object parameter, RowB
     Configuration configuration = ms.getConfiguration();
     StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameter, rowBounds, null, boundSql);
     Statement stmt = prepareStatement(handler, ms.getStatementLog());
+    Cursor<E> cursor = handler.queryCursor(stmt);
     stmt.closeOnCompletion();
-    return handler.queryCursor(stmt);
+    return cursor;
   }
 
   @Override

src/test/java/org/apache/ibatis/submitted/cursor_simple/Mapper.java

@@ -15,6 +15,7 @@
  */
 package org.apache.ibatis.submitted.cursor_simple;
 
+import org.apache.ibatis.annotations.Options;
 import org.apache.ibatis.annotations.Select;
 import org.apache.ibatis.cursor.Cursor;
 import org.apache.ibatis.session.RowBounds;
@@ -33,4 +34,8 @@ public interface Mapper {
     "select null id, null name from (values (0))"
   })
   Cursor<User> getNullUsers(RowBounds rowBounds);
+
+  @Select("select * from users")
+  @Options(fetchSize = Integer.MIN_VALUE)
+  Cursor<User> getUsersMysqlStream();
 }

src/test/java/org/apache/ibatis/submitted/cursor_simple/MysqlCursorTest.java

@@ -0,0 +1,84 @@
+/**
+ *    Copyright 2009-2019 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+package org.apache.ibatis.submitted.cursor_simple;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.io.IOException;
+import java.util.Iterator;
+
+import org.apache.ibatis.BaseDataTest;
+import org.apache.ibatis.cursor.Cursor;
+import org.apache.ibatis.mapping.Environment;
+import org.apache.ibatis.session.Configuration;
+import org.apache.ibatis.session.ExecutorType;
+import org.apache.ibatis.session.SqlSession;
+import org.apache.ibatis.session.SqlSessionFactory;
+import org.apache.ibatis.session.SqlSessionFactoryBuilder;
+import org.apache.ibatis.testcontainers.MysqlContainer;
+import org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Tag;
+import org.junit.jupiter.api.Test;
+
+@Tag("TestcontainersTests")
+class MysqlCursorTest {
+
+  private static SqlSessionFactory sqlSessionFactory;
+
+  @BeforeAll
+  static void setUp() throws Exception {
+    Configuration configuration = new Configuration();
+    Environment environment = new Environment("development", new JdbcTransactionFactory(),
+        MysqlContainer.getUnpooledDataSource());
+    configuration.setEnvironment(environment);
+    configuration.addMapper(Mapper.class);
+    sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);
+
+    BaseDataTest.runScript(sqlSessionFactory.getConfiguration().getEnvironment().getDataSource(),
+        "org/apache/ibatis/submitted/cursor_simple/CreateDB.sql");
+  }
+
+  @Test
+  void testMySqlStreamResultSet() throws IOException {
+    // #1654 and https://bugs.mysql.com/bug.php?id=96786
+    try (SqlSession sqlSession = sqlSessionFactory.openSession()) {
+      Mapper mapper = sqlSession.getMapper(Mapper.class);
+      {
+        Cursor<User> cursor = mapper.getUsersMysqlStream();
+        Iterator<User> iterator = cursor.iterator();
+        User user = iterator.next();
+        assertEquals("User1", user.getName());
+        cursor.close();
+      }
+    }
+  }
+
+  @Test
+  void testMySqlStreamResultSetBatch() throws IOException {
+    // #1654 and https://bugs.mysql.com/bug.php?id=96786
+    try (SqlSession sqlSession = sqlSessionFactory.openSession(ExecutorType.BATCH)) {
+      Mapper mapper = sqlSession.getMapper(Mapper.class);
+      {
+        Cursor<User> cursor = mapper.getUsersMysqlStream();
+        Iterator<User> iterator = cursor.iterator();
+        User user = iterator.next();
+        assertEquals("User1", user.getName());
+        cursor.close();
+      }
+    }
+  }
+}

src/test/java/org/apache/ibatis/testcontainers/MysqlContainer.java

@@ -0,0 +1,49 @@
+/**
+ *    Copyright 2009-2019 the original author or authors.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+package org.apache.ibatis.testcontainers;
+
+import javax.sql.DataSource;
+
+import org.apache.ibatis.datasource.unpooled.UnpooledDataSource;
+import org.testcontainers.containers.MySQLContainer;
+
+public class MysqlContainer {
+
+  private static final String DB_NAME = "mybatis_test";
+  private static final String USERNAME = "u";
+  private static final String PASSWORD = "p";
+  private static final String DRIVER = "com.mysql.cj.jdbc.Driver";
+
+  private static final MySQLContainer<?> INSTANCE = initContainer();
+
+  private static MySQLContainer<?> initContainer() {
+    @SuppressWarnings("resource")
+    MySQLContainer<?> container = new MySQLContainer<>().withDatabaseName(DB_NAME).withUsername(USERNAME)
+        .withPassword(PASSWORD);
+    container.start();
+    return container;
+  }
+
+  public static DataSource getUnpooledDataSource() {
+    return new UnpooledDataSource(MysqlContainer.DRIVER, INSTANCE.getJdbcUrl(), MysqlContainer.USERNAME,
+        MysqlContainer.PASSWORD);
+  }
+
+  private MysqlContainer() {
+    super();
+  }
+}