BUG19549363: Raise error when compression used with reset_session

peeyushgupta · Geert Vanderkelen · commit 740912f0ef87 · 2014-10-10T20:23:13.000+02:00
Change user command raises packets out of order error when used with compression. This causes error when a pooled connection tries to reset session which internally sends change user command for MySQL server 5.7.2 or earlier. We fix this by raising a NotSupportedError whenever someone tries to reset a session on MySQL server earlier than 5.7.3. A test case has been added for BUG#19549363. (cherry picked from commit 1b412b7)
diff --git a/lib/mysql/connector/connection.py b/lib/mysql/connector/connection.py
@@ -123,6 +123,7 @@ def __init__(self, *args, **kwargs):
         self._ssl_active = False
         self._auth_plugin = None
         self._pool_config_version = None
+        self._compress = False
 
         if len(kwargs) > 0:
             self.connect(**kwargs)
@@ -271,6 +272,7 @@ def config(self, **kwargs):
 
         try:
             if config['compress']:
+                self._compress = True
                 self.set_client_flags([ClientFlag.COMPRESS])
         except KeyError:
             pass  # Missing compress argument is OK
@@ -884,6 +886,10 @@ def cmd_change_user(self, username='', password='', database='',
         if self.unread_result:
             raise errors.InternalError("Unread result found.")
 
+        if self._compress:
+            raise errors.NotSupportedError("Change user is not supported with "
+                                           "compression.")
+
         packet = self._protocol.make_change_user(
             handshake=self._handshake,
             username=username, password=password, database=database,
@@ -943,8 +949,13 @@ def reset_session(self, user_variables=None, session_variables=None):
         try:
             self.cmd_reset_connection()
         except errors.NotSupportedError:
-            self.cmd_change_user(self._user, self._password,
-                                 self._database, self._charset_id)
+            if self._compress:
+                raise errors.NotSupportedError(
+                    "Reset session is not supported with compression for "
+                    "MySQL server version 5.7.2 or earlier.")
+            else:
+                self.cmd_change_user(self._user, self._password,
+                                     self._database, self._charset_id)
 
         cur = self.cursor()
         if user_variables:
diff --git a/lib/mysql/connector/pooling.py b/lib/mysql/connector/pooling.py
@@ -269,6 +269,17 @@ def add_connection(self, cnx=None):
 
             if not cnx:
                 cnx = MySQLConnection(**self._cnx_config)
+                try:
+                    if (self._reset_session and self._cnx_config['compress']
+                            and cnx.get_server_version() < (5, 7, 3)):
+                        raise errors.NotSupportedError("Pool reset session is "
+                                                       "not supported with "
+                                                       "compression for MySQL "
+                                                       "server version 5.7.2 "
+                                                       "or earlier.")
+                except KeyError:
+                    pass
+
                 # pylint: disable=W0201,W0212
                 cnx._pool_config_version = self._config_version
                 # pylint: enable=W0201,W0212
diff --git a/tests/test_bugs.py b/tests/test_bugs.py
@@ -2960,3 +2960,70 @@ def test_row_to_python(self):
         cur.execute("INSERT INTO {0} (c1) VALUES (?)".format(self.tbl), (data,))
         self.cur.execute("SELECT * FROM {0}".format(self.tbl))
         self.assertEqual((data,), self.cur.fetchone())
+
+
+class BugOra19500097(tests.MySQLConnectorTests):
+    """BUG#19500097: BETTER SUPPORT FOR RAW/BINARY DATA
+    """
+    def setUp(self):
+        config = tests.get_mysql_config()
+        self.cnx = connection.MySQLConnection(**config)
+        self.cur = self.cnx.cursor()
+
+        self.tbl = 'Bug19500097'
+        self.cur.execute("DROP TABLE IF EXISTS {0}".format(self.tbl))
+
+        create = ("CREATE TABLE {0} (col1 VARCHAR(10), col2 INT) "
+                  "DEFAULT CHARSET latin1".format(self.tbl))
+        self.cur.execute(create)
+
+    def tearDown(self):
+        self.cur.execute("DROP TABLE IF EXISTS {0}".format(self.tbl))
+        self.cur.close()
+        self.cnx.close()
+
+    def test_binary_charset(self):
+
+        sql = "INSERT INTO {0} VALUES(%s, %s)".format(self.tbl)
+        self.cur.execute(sql, ('foo', 1))
+        self.cur.execute(sql, ('ëëë', 2))
+        self.cur.execute(sql, (u'ááá', 5))
+
+        self.cnx.set_charset_collation('binary')
+        self.cur.execute(sql, ('bar', 3))
+        self.cur.execute(sql, ('ëëë', 4))
+        self.cur.execute(sql, (u'ááá', 6))
+
+        exp = [
+            (bytearray(b'foo'), 1),
+            (bytearray(b'\xeb\xeb\xeb'), 2),
+            (bytearray(b'\xe1\xe1\xe1'), 5),
+            (bytearray(b'bar'), 3),
+            (bytearray(b'\xc3\xab\xc3\xab\xc3\xab'), 4),
+            (bytearray(b'\xc3\xa1\xc3\xa1\xc3\xa1'), 6)
+        ]
+
+        self.cur.execute("SELECT * FROM {0}".format(self.tbl))
+        self.assertEqual(exp, self.cur.fetchall())
+
+
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 3),
+                 "MySQL {0} does not support COM_RESET_CONNECTION".format(
+                 tests.MYSQL_VERSION_TXT))
+class BugOra19549363(tests.MySQLConnectorTests):
+    """BUG#19549363: Compression does not work with Change User
+    """
+    def test_compress(self):
+        config = tests.get_mysql_config()
+        config['compress'] = True
+
+        mysql.connector._CONNECTION_POOLS = {}
+        config['pool_name'] = 'mypool'
+        config['pool_size'] = 3
+        config['pool_reset_session'] = True
+        cnx1 = mysql.connector.connect(**config)
+
+        try:
+            cnx1.close()
+        except:
+            self.fail("Reset session with compression test failed.")
