WL13531: Remove xplugin namespace

MySQL 8.0.19 removes the deprecated namespace 'xplugin', used in
Mysqlx.Sql.StmtExecute messages.

This worklog replaces the 'xplugin' namespace by 'mysqlx'.
This change breaks compatibility with versions of MySQL older than 5.7.14
with X protocol enabled.

Since the 'xplugin' namespace is removed by MySQL 8.0.19, users should
upgrade Connector/Python to 8.0.19.

The internal API was changed and tests skipped for this replacement.

Author: nmariz

lib/mysqlx/connection.py

@@ -640,12 +640,11 @@ def _execute_prepared_pipeline(self, msg_type, msg, statement):
         statement.increment_exec_counter()
 
     @catch_network_exception
-    def send_sql(self, statement, *args):
+    def send_sql(self, statement):
         """Execute a SQL statement.
 
         Args:
             sql (str): The SQL statement.
-            *args: Arbitrary arguments.
 
         Raises:
             :class:`mysqlx.ProgrammingError`: If the SQL statement is not a
@@ -658,10 +657,10 @@ def send_sql(self, statement, *args):
             raise ProgrammingError("The SQL statement is not a valid string")
         if not PY3 and isinstance(sql, UNICODE_TYPES):
             msg_type, msg = self.protocol.build_execute_statement(
-                "sql", bytes(bytearray(sql, "utf-8")), args)
+                "sql", bytes(bytearray(sql, "utf-8")))
         else:
             msg_type, msg = self.protocol.build_execute_statement(
-                "sql", sql, args)
+                "sql", sql)
         self.protocol.send_msg_without_ps(msg_type, msg, statement)
         return SqlResult(self)
 
@@ -732,14 +731,14 @@ def send_update(self, statement):
         return Result(self)
 
     @catch_network_exception
-    def execute_nonquery(self, namespace, cmd, raise_on_fail, *args):
+    def execute_nonquery(self, namespace, cmd, raise_on_fail, fields=None):
         """Execute a non query command.
 
         Args:
             namespace (str): The namespace.
             cmd (str): The command.
             raise_on_fail (bool): `True` to raise on fail.
-            *args: Arbitrary arguments.
+            fields (Optional[dict]): The message fields.
 
         Raises:
             :class:`mysqlx.OperationalError`: On errors.
@@ -749,28 +748,27 @@ def execute_nonquery(self, namespace, cmd, raise_on_fail, *args):
         """
         try:
             msg_type, msg = \
-                self.protocol.build_execute_statement(namespace, cmd, args)
+                self.protocol.build_execute_statement(namespace, cmd, fields)
             self.protocol.send_msg(msg_type, msg)
             return Result(self)
         except OperationalError:
             if raise_on_fail:
                 raise
 
     @catch_network_exception
-    def execute_sql_scalar(self, sql, *args):
+    def execute_sql_scalar(self, sql):
         """Execute a SQL scalar.
 
         Args:
             sql (str): The SQL statement.
-            *args: Arbitrary arguments.
 
         Raises:
             :class:`mysqlx.InterfaceError`: If no data found.
 
         Returns:
             :class:`mysqlx.Result`: The result.
         """
-        msg_type, msg = self.protocol.build_execute_statement("sql", sql, args)
+        msg_type, msg = self.protocol.build_execute_statement("sql", sql)
         self.protocol.send_msg(msg_type, msg)
         result = RowResult(self)
         result.fetch_all()
@@ -779,18 +777,18 @@ def execute_sql_scalar(self, sql, *args):
         return result[0][0]
 
     @catch_network_exception
-    def get_row_result(self, cmd, *args):
+    def get_row_result(self, cmd, fields):
         """Returns the row result.
 
         Args:
             cmd (str): The command.
-            *args: Arbitrary arguments.
+            fields (dict): The message fields.
 
         Returns:
             :class:`mysqlx.RowResult`: The result object.
         """
         msg_type, msg = \
-            self.protocol.build_execute_statement("xplugin", cmd, args)
+            self.protocol.build_execute_statement("mysqlx", cmd, fields)
         self.protocol.send_msg(msg_type, msg)
         return RowResult(self)
 

lib/mysqlx/crud.py

@@ -177,7 +177,8 @@ def get_collections(self):
         Returns:
             `list`: List of Collection objects.
         """
-        rows = self._connection.get_row_result("list_objects", self._name)
+        rows = self._connection.get_row_result("list_objects",
+                                               {"schema": self._name})
         rows.fetch_all()
         collections = []
         for row in rows:
@@ -205,7 +206,8 @@ def get_tables(self):
         Returns:
             `list`: List of Table objects.
         """
-        rows = self._connection.get_row_result("list_objects", self._name)
+        rows = self._connection.get_row_result("list_objects",
+                                               {"schema": self._name})
         rows.fetch_all()
         tables = []
         object_types = ("TABLE", "VIEW",)
@@ -283,8 +285,9 @@ def create_collection(self, name, reuse=False):
             raise ProgrammingError("Collection name is invalid")
         collection = Collection(self, name)
         if not collection.exists_in_database():
-            self._connection.execute_nonquery("xplugin", "create_collection",
-                                              True, self._name, name)
+            self._connection.execute_nonquery("mysqlx", "create_collection",
+                                              True, {"schema": self._name,
+                                                     "name": name})
         elif not reuse:
             raise ProgrammingError("Collection already exists")
         return collection
@@ -413,9 +416,10 @@ def drop_index(self, index_name):
         Args:
             index_name (str): Index name.
         """
-        self._connection.execute_nonquery("xplugin", "drop_collection_index",
-                                          False, self._schema.name, self._name,
-                                          index_name)
+        self._connection.execute_nonquery("mysqlx", "drop_collection_index",
+                                          False, {"schema": self._schema.name,
+                                                  "collection": self._name,
+                                                  "name": index_name})
 
     def replace_one(self, doc_id, doc):
         """Replaces the Document matching the document ID with a new document

lib/mysqlx/protocol.py

@@ -679,13 +679,13 @@ def build_delete(self, stmt):
         self._apply_filter(msg, stmt)
         return "Mysqlx.ClientMessages.Type.CRUD_DELETE", msg
 
-    def build_execute_statement(self, namespace, stmt, args):
+    def build_execute_statement(self, namespace, stmt, fields=None):
         """Build execute statement.
 
         Args:
             namespace (str): The namespace.
             stmt (Statement): A `Statement` based type object.
-            args (iterable): An iterable object.
+            fields (Optional[dict]): The message fields.
 
         Returns:
             (tuple): Tuple containing:
@@ -698,23 +698,15 @@ def build_execute_statement(self, namespace, stmt, args):
         msg = Message("Mysqlx.Sql.StmtExecute", namespace=namespace, stmt=stmt,
                       compact_metadata=False)
 
-        if namespace == "mysqlx":
-            # mysqlx namespace behavior: one object with a list of arguments
-            items = args[0].items() if isinstance(args, (list, tuple)) else \
-                    args.items()
+        if fields:
             obj_flds = []
-            for key, value in items:
+            for key, value in fields.items():
                 obj_fld = Message("Mysqlx.Datatypes.Object.ObjectField",
                                   key=key, value=self._create_any(value))
                 obj_flds.append(obj_fld.get_message())
             msg_obj = Message("Mysqlx.Datatypes.Object", fld=obj_flds)
             msg_any = Message("Mysqlx.Datatypes.Any", type=2, obj=msg_obj)
             msg["args"] = [msg_any.get_message()]
-        else:
-            # xplugin namespace behavior: list of arguments
-            for arg in args:
-                value = self._create_any(arg)
-                msg["args"].extend([value.get_message()])
 
         return "Mysqlx.ClientMessages.Type.SQL_STMT_EXECUTE", msg
 

tests/test_mysqlx_connection.py

@@ -262,7 +262,7 @@ def send_auth_ok(self):
             "Mysqlx.ServerMessages.Type.SESS_AUTHENTICATE_OK"), msg)
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class MySQLxSessionTests(tests.MySQLxTests):
 
     def setUp(self):
@@ -1174,7 +1174,7 @@ def test_connection_attributes(self):
                          "while was specified to not do so: {}".format(rows))
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class MySQLxInnitialNoticeTests(tests.MySQLxTests):
 
     def setUp(self):

tests/test_mysqlx_crud.py

@@ -73,7 +73,7 @@ def drop_view(schema, view_name):
     schema.get_session().sql(query).execute()
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class MySQLxDbDocTests(tests.MySQLxTests):
 
     def setUp(self):
@@ -115,7 +115,7 @@ def test_dbdoc_creation(self):
         doc_6 = doc_5.copy()
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class MySQLxSchemaTests(tests.MySQLxTests):
 
     def setUp(self):
@@ -254,7 +254,7 @@ def test_drop_collection(self):
         self.schema.drop_collection(collection_name)
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class MySQLxCollectionTests(tests.MySQLxTests):
 
     def setUp(self):
@@ -2305,7 +2305,7 @@ def test_prepared_statements(self):
         session.close()
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class MySQLxTableTests(tests.MySQLxTests):
 
     def setUp(self):
@@ -2882,7 +2882,7 @@ def test_prepared_statements(self):
         session.close()
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class MySQLxViewTests(tests.MySQLxTests):
 
     def setUp(self):

tests/test_mysqlx_errorcode.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -36,7 +36,7 @@
 from mysqlx import errorcode
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class ErrorCodeTests(tests.MySQLxTests):
 
     def test__MYSQL_VERSION(self):

tests/test_mysqlx_errors.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -36,7 +36,7 @@
 from mysqlx import errors
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class ErrorsTests(tests.MySQLxTests):
 
     def test_get_mysql_exception(self):

tests/test_mysqlx_pooling.py

@@ -64,7 +64,7 @@ def get_current_connections(session):
     return connections
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class MySQLxClientTests(tests.MySQLxTests):
     def setUp(self):
         self.connect_kwargs = tests.get_mysqlx_config()
@@ -423,7 +423,7 @@ def test_reset_get_new_connection(self):
         # No errors should raise from closing client.
         client.close()
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class MySQLxClientPoolingTests(tests.MySQLxTests):
     def setUp(self):
         settings = tests.get_mysqlx_config()
@@ -510,7 +510,7 @@ def test_pools_are_not_shared(self):
         client2.close()
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class MySQLxConnectionPoolingTests(tests.MySQLxTests):
     def setUp(self):
         settings = tests.get_mysqlx_config()
@@ -739,7 +739,7 @@ def test_connection_attributes(self):
                                  expected_attrs[row.get_string('ATTR_NAME')]))
 
 
-@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 12), "XPlugin not compatible")
+@unittest.skipIf(tests.MYSQL_VERSION < (5, 7, 14), "XPlugin not compatible")
 class MySQLxPoolingSessionTests(tests.MySQLxTests):
     def setUp(self):
         self.connect_kwargs = tests.get_mysqlx_config()