Merge lp:~massimo-siani/mariadb-java-client/CONJ-116 into lp:mariadb-java-client

[Massimo Siani]

CONJ-116:

Make SQLException prettier when too large packet is sent to the server.

Example from Connector/J:
Packet for query is too large (1106929 > 1048576). You can change this value on the server by setting the max_allowed_packet' variable.

[lp:~massimo-siani/mariadb-java-client/CONJ-116]

537. By Massimo Siani on 2014-12-12

Fix for CONJ-116: Make SQLException prettier when too large packet is sent to the server

[Massimo Siani (massimo-siani)]

Sorry, there was a bug in the previous one. Now should be fine.

[Vladislav Vaintroub (wlad-montyprogram)]

Does not seem very efficient, creating a new String and converting to UTF8 bytes.

Also not entirely correct, especially for blobs, as blob bytes are not UTF8, and some bytes need escaping, and the escape byte needs to be taken into acccount.

If at all, the check is be better done in PacketOutputStream , before sending .For example, in PacketOutputStream.internalFlush() if dataLen exceeds max_allowed_packet, reset seqNo and position, and throw "exceeds max_allowed_packet" from there.

=== modified file 'src/main/java/org/mariadb/jdbc/internal/common/packet/commands/StreamedQueryPacket.java'
--- src/main/java/org/mariadb/jdbc/internal/common/packet/commands/StreamedQueryPacket.java	2012-12-21 18:15:36 +0000
+++ src/main/java/org/mariadb/jdbc/internal/common/packet/commands/StreamedQueryPacket.java	2014-12-12 12:33:01 +0000
@@ -66,7 +66,6 @@
     public StreamedQueryPacket(final Query query)
     {
         this.query = query;
-
     }
 
     public int send(final OutputStream ostream) throws IOException,
@@ -79,4 +78,8 @@
         pos.finishPacket();
         return 0;
     }
+    
+    public int getPacketLength() {
+    	return query.getPacketLength();
+    }
 }
\ No newline at end of file

=== modified file 'src/main/java/org/mariadb/jdbc/internal/common/query/MySQLParameterizedQuery.java'
--- src/main/java/org/mariadb/jdbc/internal/common/query/MySQLParameterizedQuery.java	2014-10-21 15:41:04 +0000
+++ src/main/java/org/mariadb/jdbc/internal/common/query/MySQLParameterizedQuery.java	2014-12-12 12:33:01 +0000
@@ -199,4 +199,27 @@
 		}
 	}
 
+	private String toSQL2() throws UnsupportedEncodingException {
+        if(queryPartsArray.length == 0) {
+            return "";
+        }
+        String result;
+        result = new String(queryPartsArray[0], "UTF-8");
+        for(int i = 1; i<queryPartsArray.length; i++) {
+            result += parameters[i-1];
+            if(queryPartsArray[i].length != 0)
+                result += new String(queryPartsArray[i], "UTF-8");
+        }
+		return result;
+    }
+	
+	@Override
+	public int getPacketLength() {
+		try {
+			return toSQL2().getBytes("UTF-8").length;
+		} catch (UnsupportedEncodingException e) {
+			return -1;
+		}
+	}
+
 }

=== modified file 'src/main/java/org/mariadb/jdbc/internal/common/query/MySQLQuery.java'
--- src/main/java/org/mariadb/jdbc/internal/common/query/MySQLQuery.java	2012-12-21 18:15:36 +0000
+++ src/main/java/org/mariadb/jdbc/internal/common/query/MySQLQuery.java	2014-12-12 12:33:01 +0000
@@ -115,5 +115,10 @@
         return query;
     }
 
+	@Override
+	public int getPacketLength() {
+		return length();
+	}
+
 
 }

=== modified file 'src/main/java/org/mariadb/jdbc/internal/common/query/Query.java'
--- src/main/java/org/mariadb/jdbc/internal/common/query/Query.java	2012-12-21 18:15:36 +0000
+++ src/main/java/org/mariadb/jdbc/internal/common/query/Query.java	2014-12-12 12:33:01 +0000
@@ -60,4 +60,5 @@
     String getQuery();
     QueryType getQueryType();
     void validate() throws QueryException;
+    int getPacketLength();
 }

=== modified file 'src/main/java/org/mariadb/jdbc/internal/mysql/MySQLProtocol.java'
--- src/main/java/org/mariadb/jdbc/internal/mysql/MySQLProtocol.java	2014-12-09 15:02:39 +0000
+++ src/main/java/org/mariadb/jdbc/internal/mysql/MySQLProtocol.java	2014-12-12 12:33:01 +0000
@@ -1020,6 +1020,16 @@
         this.moreResults = false;
         final StreamedQueryPacket packet = new StreamedQueryPacket(dQuery);
 
+        int packetLength = packet.getPacketLength();
+    	if (this.maxAllowedPacket > 0 && packetLength > 0 && packetLength > this.maxAllowedPacket) {
+    		throw new QueryException("Packet for query is too large ("
+    				+ packetLength
+    				+ " > "
+    				+ this.maxAllowedPacket
+    				+ "). You can change this value on the server by setting the max_allowed_packet' variable.",
+    				-1, SQLExceptionMapper.SQLStates.UNDEFINED_SQLSTATE.getSqlState());
+    	}
+        
         try {
             packet.send(writer);
         } catch (IOException e) {

=== modified file 'src/test/java/org/mariadb/jdbc/ConnectionTest.java'
--- src/test/java/org/mariadb/jdbc/ConnectionTest.java	2014-12-09 10:28:02 +0000
+++ src/test/java/org/mariadb/jdbc/ConnectionTest.java	2014-12-12 12:33:01 +0000
@@ -2,8 +2,13 @@
 
 import static org.junit.Assert.*;
 
+<<<<<<< TREE
 import java.lang.reflect.Field;
 import java.sql.Connection;
+=======
+import java.io.UnsupportedEncodingException;
+import java.sql.ResultSet;
+>>>>>>> MERGE-SOURCE
 import java.sql.SQLException;
 import java.sql.SQLPermission;
 import java.sql.Statement;
@@ -75,6 +80,7 @@
 			stmt.close();
 		}
 	}
+<<<<<<< TREE
 	
 	
 	/**
@@ -198,5 +204,46 @@
 		long threadId = serverThreadIdField.getLong(protocol);
 		return threadId;
 	}
+=======
+	
+	/**
+	 * CONJ-116: Make SQLException prettier when too large packet is sent to the server
+	 * @throws SQLException
+	 * @throws UnsupportedEncodingException 
+	 */
+	@Test
+	public void maxAllowedPackedExceptionIsPrettyTest() throws SQLException, UnsupportedEncodingException {
+		int maxAllowedPacket = 1024 * 1024;
+		Statement statement = connection.createStatement();
+		ResultSet rs = statement.executeQuery("SHOW VARIABLES LIKE 'max_allowed_packet'");
+		if (rs.next()) {
+			maxAllowedPacket = rs.getInt(2);
+		}
+		rs.close();
+		statement.execute("DROP TABLE IF EXISTS dummy");
+		statement.execute("CREATE TABLE dummy (a BLOB)");
+		//Create a SQL packet bigger than maxAllowedPacket
+		StringBuilder sb = new StringBuilder();
+		String rowData = "('this is a dummy row values')";
+		int rowsToWrite = (maxAllowedPacket / rowData.getBytes("UTF-8").length) + 1;
+		for (int row = 1;  row <= rowsToWrite; row++) {
+			if (row >= 2) {
+				sb.append(", ");
+			}
+			sb.append(rowData);
+		}
+		String sql = "INSERT INTO dummy VALUES " + sb.toString();
+		try {
+			statement.executeUpdate(sql);
+			fail("The previous statement should throw an SQLException");
+		} catch (SQLException e) {
+			assertTrue(e.getMessage().contains("max_allowed_packet"));
+		} catch (Exception e) {
+			fail("The previous statement should throw an SQLException not a general Exception");
+		} finally {
+			statement.execute("DROP TABLE dummy");
+		}
+	}
+>>>>>>> MERGE-SOURCE
 
 }

=== modified file 'src/test/java/org/mariadb/jdbc/DriverTest.java'
--- src/test/java/org/mariadb/jdbc/DriverTest.java	2014-10-21 15:21:12 +0000
+++ src/test/java/org/mariadb/jdbc/DriverTest.java	2014-12-12 12:33:01 +0000
@@ -1603,8 +1603,8 @@
     @Test
     public void createDbWithSpacesTest() throws SQLException {
     	String oldDb = mDatabase;
+    	setParameters("&createDB=true");
     	setDatabase("test with spaces");
-    	setConnection("&createDB=true");
         DatabaseMetaData dbmd = connection.getMetaData();
         ResultSet rs = dbmd.getCatalogs();
         boolean foundDb = false;