WL#16284: Update the Python Protobuf version

oscpache · oscpache · commit be7098d1b999 · 2024-05-31T16:23:01.000-06:00
Utilizing an older version than Protobuf 4.25.1 leads to segmentation fault issues as reported in protocolbuffers/protobuf#12047. As a consequence, this work log updates the Python Protobuf version. Change-Id: If3c23a6cd4ff0b0ee0417c333a40ea29d1840968
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -13,6 +13,7 @@ v9.0.0
 
 - WL#16350: Update dnspython version
 - WL#16318: Deprecate Cursors Prepared Raw and Named Tuple
+- WL#16284: Update the Python Protobuf version
 - WL#16283: Remove OpenTelemetry Bundled Installation
 - BUG#36664998: Packets out of order error is raised while changing user in aio
 - BUG#36611371: Update dnspython required versions to allow latest 2.6.1
diff --git a/mysqlx-connector-python/cpydist/__init__.py b/mysqlx-connector-python/cpydist/__init__.py
@@ -52,6 +52,62 @@
 
 from .utils import ARCH, write_info_bin, write_info_src
 
+# Abseil libraries to link in the later stage
+ABSL_LIBS_EXT = "lib" if os.name == "nt" else "a"
+ABSL_LIBS = (
+    "absl_str_format_internal",
+    "absl_strings",
+    "absl_strings_internal",
+    "absl_string_view",
+    "absl_log_initialize",
+    "absl_log_entry",
+    "absl_log_flags",
+    "absl_log_severity",
+    "absl_log_internal_check_op",
+    "absl_log_internal_conditions",
+    "absl_log_internal_message",
+    "absl_log_internal_nullguard",
+    "absl_log_internal_proto",
+    "absl_log_internal_format",
+    "absl_log_internal_globals",
+    "absl_log_internal_log_sink_set",
+    "absl_log_sink",
+    "absl_raw_logging_internal",
+    "absl_log_globals",
+    "utf8_validity",
+    "absl_cord",
+    "absl_cordz_info",
+    "absl_cordz_handle",
+    "absl_cordz_functions",
+    "absl_cord_internal",
+    "absl_crc_cord_state",
+    "absl_crc32c",
+    "absl_crc_internal",
+    "absl_exponential_biased",
+    "absl_synchronization",
+    "absl_graphcycles_internal",
+    "absl_kernel_timeout_internal",
+    "absl_time",
+    "absl_time_zone",
+    "absl_int128",
+    "absl_examine_stack",
+    "absl_stacktrace",
+    "absl_symbolize",
+    "absl_demangle_internal",
+    "absl_debugging_internal",
+    "absl_malloc_internal",
+    "absl_throw_delegate",
+    "absl_strerror",
+    "absl_raw_hash_set",
+    "absl_hash",
+    "absl_city",
+    "absl_low_level_hash",
+    "absl_base",
+    "absl_spinlock_wait",
+    "absl_status",
+    "absl_statusor",
+    "absl_bad_optional_access",
+)
 # Load version information
 VERSION = [999, 0, 0, "a", 0]
 VERSION_TEXT = "999.0.0"
@@ -243,7 +299,17 @@ def _finalize_protobuf(self):
 
         self.log.info("Copying Protobuf libraries")
 
+        # load protobuf-related static libraries
         libs = glob(os.path.join(self.with_protobuf_lib_dir, "libprotobuf*"))
+
+        # load absl-related static libraries
+        libs += glob(
+            os.path.join(self.with_protobuf_lib_dir, f"*absl_*.{ABSL_LIBS_EXT}")
+        )
+        libs += glob(
+            os.path.join(self.with_protobuf_lib_dir, f"*utf8_*.{ABSL_LIBS_EXT}")
+        )
+
         for lib in libs:
             if os.path.isfile(lib):
                 self.log.info("copying %s -> %s", lib, self._build_protobuf_lib_dir)
@@ -302,29 +368,25 @@ def run(self):
         disabled = []  # Extensions to be disabled
         for ext in self.extensions:
             # Add Protobuf include and library dirs
-            if ext.name == "_mysqlxpb":
-                if not self.with_mysqlxpb_cext:
-                    self.log.warning("The '_mysqlxpb' C extension will not be built")
-                    disabled.append(ext)
-                    continue
-                if platform.system() == "Darwin":
-                    symbol_file = tempfile.NamedTemporaryFile()
-                    ext.extra_link_args.extend(
-                        ["-exported_symbols_list", symbol_file.name]
-                    )
-                    with open(symbol_file.name, "w") as fp:
-                        fp.write("_PyInit__mysqlxpb")
-                        fp.write("\n")
-                ext.include_dirs.append(self.with_protobuf_include_dir)
-                ext.library_dirs.append(self._build_protobuf_lib_dir)
-                ext.libraries.append("libprotobuf" if os.name == "nt" else "protobuf")
-                # Add -std=c++11 needed for Protobuf 3.6.1
-                ext.extra_compile_args.append("-std=c++11")
-                self._run_protoc()
-
-            if ext.name != "_mysqlxpb":
+            if not self.with_mysqlxpb_cext:
+                self.log.warning("The '_mysqlxpb' C extension will not be built")
                 disabled.append(ext)
                 continue
+            if platform.system() == "Darwin":
+                symbol_file = tempfile.NamedTemporaryFile()
+                ext.extra_link_args.extend(["-exported_symbols_list", symbol_file.name])
+                with open(symbol_file.name, "w") as fp:
+                    fp.write("_PyInit__mysqlxpb")
+                    fp.write("\n")
+            ext.include_dirs.append(self.with_protobuf_include_dir)
+            ext.library_dirs.append(self._build_protobuf_lib_dir)
+            ext.libraries.append("libprotobuf" if os.name == "nt" else "protobuf")
+            ext.libraries.extend(ABSL_LIBS)
+
+            if os.name != "nt":
+                # Add -std=c++14 needed for Protobuf 4.25.3
+                ext.extra_compile_args.append("-std=c++14")
+            self._run_protoc()
 
             # Suppress unknown pragmas
             if os.name == "posix":
diff --git a/mysqlx-connector-python/docs/mysqlx/requirements.rst b/mysqlx-connector-python/docs/mysqlx/requirements.rst
@@ -3,8 +3,8 @@ Requirements
 
 * MySQL 8.0.0 or higher, with the X Plugin enabled
 * Python >= 3.8
-* Protobuf C++ (version >= 4.21.1, <= 4.21.12)
-* Python Protobuf (version >= 4.21.1, <= 4.21.12)
+* Protobuf C++ (version == 4.25.3)
+* Python Protobuf (version == 4.25.3)
 * dnspython (version == 2.6.1) for DNS SRV support
 * lz4 (version >= 2.1.6, <= 4.3.2) for connection compression support
 * zstandard (version >= 0.12.0, <= 0.19.0) for connection compression support
diff --git a/mysqlx-connector-python/setup.py b/mysqlx-connector-python/setup.py
@@ -141,7 +141,7 @@ def main() -> None:
         ext_modules=EXTENSIONS,
         cmdclass=COMMAND_CLASSES,
         python_requires=">=3.8",
-        install_requires=["protobuf>=4.21.1,<=4.21.12"],
+        install_requires=["protobuf==4.25.3"],
         extras_require={
             "dns-srv": ["dnspython==2.6.1"],
             "compression": ["lz4>=2.1.6,<=4.3.2", "zstandard>=0.12.0,<=0.19.0"],
diff --git a/mysqlx-connector-python/src/mysqlxpb/mysqlxpb.cc b/mysqlx-connector-python/src/mysqlxpb/mysqlxpb.cc
@@ -440,14 +440,14 @@ static void AddPyListToMessageRepeatedString(
     google::protobuf::Message& message,
     const google::protobuf::FieldDescriptor& field,
     PyObject* list) {
-  google::protobuf::MutableRepeatedFieldRef<google::protobuf::string> mutable_field =
+  google::protobuf::MutableRepeatedFieldRef<std::string> mutable_field =
       message.GetReflection()->
-      GetMutableRepeatedFieldRef<google::protobuf::string>(&message, &field);
+      GetMutableRepeatedFieldRef<std::string>(&message, &field);
   Py_ssize_t list_size = PyList_Size(list);
 
   if (list_size > 0) {
     for (Py_ssize_t idx = 0; idx < list_size; ++idx) {
-      mutable_field.Add(google::protobuf::string(
+      mutable_field.Add(std::string(
           python_cast<std::string>(PyList_GetItem(list, idx))));
     }
   }
diff --git a/mysqlx-connector-python/tests/requirements.txt b/mysqlx-connector-python/tests/requirements.txt
@@ -1,5 +1,4 @@
-protobuf>=4.21.1,<=4.21.12
+protobuf==4.25.3
 dnspython==2.6.1
 lz4>=2.1.6,<=4.3.2
 zstandard>=0.12.0,<=0.19.0
-
