Bug#34833655: MySQL command services component API fails on Windows

gkodinov · gkodinov · commit ad564df86de2 · 2023-01-05T14:34:40.000+02:00
Added a service to access the field metadata info.
Added a test for it.

Change-Id: I9f7b45e70150bc81e5b35cb85a1818f6e9d89eb5
diff --git a/components/test/test_mysql_command_services.cc b/components/test/test_mysql_command_services.cc
@@ -43,6 +43,8 @@ REQUIRES_SERVICE_PLACEHOLDER_AS(mysql_command_query_result,
                                 cmd_query_result_srv);
 REQUIRES_SERVICE_PLACEHOLDER_AS(mysql_command_field_info, cmd_field_info_srv);
 REQUIRES_SERVICE_PLACEHOLDER_AS(mysql_command_error_info, cmd_error_info_srv);
+REQUIRES_SERVICE_PLACEHOLDER_AS(mysql_command_field_metadata,
+                                cmd_field_meta_srv);
 
 BEGIN_COMPONENT_PROVIDES(test_mysql_command_services)
 END_COMPONENT_PROVIDES();
@@ -59,6 +61,7 @@ REQUIRES_SERVICE_AS(udf_registration, udf_srv),
     REQUIRES_SERVICE_AS(mysql_command_query_result, cmd_query_result_srv),
     REQUIRES_SERVICE_AS(mysql_command_field_info, cmd_field_info_srv),
     REQUIRES_SERVICE_AS(mysql_command_error_info, cmd_error_info_srv),
+    REQUIRES_SERVICE_AS(mysql_command_field_metadata, cmd_field_meta_srv),
     END_COMPONENT_REQUIRES();
 
 MYSQL_H mysql_h = nullptr;
@@ -121,21 +124,46 @@ static char *test_mysql_command_services_udf(UDF_INIT *, UDF_ARGS *args,
       goto err;
     }
 
-    for (uint64_t i = 0; i < row_count; i++) {
-      if (cmd_query_result_srv->fetch_row(mysql_res, &row)) {
+    if (field_count > 0) {
+      if (cmd_field_info_srv->fetch_field(mysql_res, &field_h)) {
         result = nullptr;
         goto err;
       }
-      if (cmd_field_info_srv->fetch_field(mysql_res, &field_h)) {
+      if (cmd_field_info_srv->fetch_fields(mysql_res, &fields_h)) {
         result = nullptr;
         goto err;
       }
-      if (cmd_field_info_srv->fetch_fields(mysql_res, &fields_h)) {
+
+      const char *field_name = nullptr, *table_name = nullptr,
+                 *db_name = nullptr;
+      if (cmd_field_meta_srv->get(field_h, MYSQL_COMMAND_FIELD_METADATA_NAME,
+                                  &field_name) ||
+          !field_name) {
+        result = nullptr;
+        goto err;
+      }
+      if (cmd_field_meta_srv->get(
+              field_h, MYSQL_COMMAND_FIELD_METADATA_TABLE_NAME, &table_name)) {
+        result = nullptr;
+        goto err;
+      }
+      if (cmd_field_meta_srv->get(
+              field_h, MYSQL_COMMAND_FIELD_METADATA_TABLE_DB_NAME, &db_name)) {
+        result = nullptr;
+        goto err;
+      }
+    }
+
+    for (uint64_t i = 0; i < row_count; i++) {
+      if (cmd_query_result_srv->fetch_row(mysql_res, &row)) {
         result = nullptr;
         goto err;
       }
       ulong *length = nullptr;
-      cmd_query_result_srv->fetch_lengths(mysql_res, &length);
+      if (cmd_query_result_srv->fetch_lengths(mysql_res, &length)) {
+        result = nullptr;
+        goto err;
+      }
       for (unsigned int j = 0; j < num_column; j++) {
         result_set += row[j];
       }
diff --git a/include/mysql/components/services/mysql_command_services.h b/include/mysql/components/services/mysql_command_services.h
@@ -394,6 +394,44 @@ DECLARE_BOOL_METHOD(fetch_fields,
 DECLARE_BOOL_METHOD(field_count, (MYSQL_H mysql_h, unsigned int *num_fields));
 END_SERVICE_DEFINITION(mysql_command_field_info)
 
+#define MYSQL_COMMAND_FIELD_METADATA_NAME 0
+#define MYSQL_COMMAND_FIELD_METADATA_TABLE_NAME 1
+#define MYSQL_COMMAND_FIELD_METADATA_TABLE_DB_NAME 2
+
+/**
+  @ingroup group_components_services_inventory
+
+  Fetch the metadata of a service.
+
+  Usually used as follows:
+
+*/
+BEGIN_SERVICE_DEFINITION(mysql_command_field_metadata)
+/**
+  Retrieves the metadata for the field.
+
+  @param[in]  mysql_field_h A valid mysql field handle object.
+  @param[in]  metadata A metadata ID to fetch. Can be one of:
+
+--------------+-------------------------------------------+--------------------------------+
+     Type     |    Option                                 |Explanation |
+--------------+-------------------------------------------+--------------------------------+
+const char *  |MYSQL_COMMAND_FIELD_METADATA_NAME          |The field name. |
+--------------+-------------------------------------------+--------------------------------+
+const char *  |MYSQL_COMMAND_FIELD_METADATA_TABLE_NAME    |The table name. |
+--------------+-------------------------------------------+--------------------------------+
+const char *  |MYSQL_COMMAND_FIELD_METADATA_TABLE_DB_NAME |The table database
+name.        |
+--------------+-------------------------------------------+--------------------------------+
+
+  @param[out] data A buffer to receive the data fetched.
+  @retval true    failure
+  @retval false   success
+*/
+DECLARE_BOOL_METHOD(get,
+                    (MYSQL_FIELD_H mysql_field_h, int metadata, void *data));
+END_SERVICE_DEFINITION(mysql_command_field_metadata)
+
 /**
   @ingroup group_components_services_inventory
 
diff --git a/sql/server_component/mysql_command_services_imp.cc b/sql/server_component/mysql_command_services_imp.cc
@@ -1105,3 +1105,25 @@ DEFINE_BOOL_METHOD(mysql_command_services_imp::sql_state,
   }
   return false;
 }
+
+DEFINE_BOOL_METHOD(mysql_command_services_imp::field_metadata_get,
+                   (MYSQL_FIELD_H field_h, int metadata, void *data))
+try {
+  MYSQL_FIELD *fld = reinterpret_cast<MYSQL_FIELD *>(field_h);
+
+  switch (metadata) {
+    case MYSQL_COMMAND_FIELD_METADATA_NAME:
+      *reinterpret_cast<const char **>(data) = fld->name;
+      return false;
+    case MYSQL_COMMAND_FIELD_METADATA_TABLE_NAME:
+      *reinterpret_cast<const char **>(data) = fld->table;
+      return false;
+    case MYSQL_COMMAND_FIELD_METADATA_TABLE_DB_NAME:
+      *reinterpret_cast<const char **>(data) = fld->db;
+      return false;
+  }
+  return true;
+} catch (...) {
+  mysql_components_handle_std_exception(__func__);
+  return true;
+}
diff --git a/sql/server_component/mysql_command_services_imp.h b/sql/server_component/mysql_command_services_imp.h
@@ -127,6 +127,10 @@ class mysql_command_services_imp {
   static DEFINE_BOOL_METHOD(sql_error, (MYSQL_H mysql_h, char **errmsg));
   static DEFINE_BOOL_METHOD(sql_state,
                             (MYSQL_H mysql_h, char **sqlstate_errmsg));
+
+  /* mysql_command_field_metadata service APIs */
+  static DEFINE_BOOL_METHOD(field_metadata_get,
+                            (MYSQL_FIELD_H field_h, int metadata, void *data));
 };
 
 /** This is a wrapper class of all the mysql_text_consumer services refs */
diff --git a/sql/server_component/server_component.cc b/sql/server_component/server_component.cc
@@ -484,6 +484,9 @@ mysql_command_services_imp::fetch_field, mysql_command_services_imp::num_fields,
     mysql_command_services_imp::fetch_fields,
     mysql_command_services_imp::field_count END_SERVICE_IMPLEMENTATION();
 
+BEGIN_SERVICE_IMPLEMENTATION(mysql_server, mysql_command_field_metadata)
+mysql_command_services_imp::field_metadata_get END_SERVICE_IMPLEMENTATION();
+
 BEGIN_SERVICE_IMPLEMENTATION(mysql_server, mysql_command_error_info)
 mysql_command_services_imp::sql_errno, mysql_command_services_imp::sql_error,
     mysql_command_services_imp::sql_state END_SERVICE_IMPLEMENTATION();
@@ -696,6 +699,7 @@ PROVIDES_SERVICE(mysql_server_path_filter, dynamic_loader_scheme_file),
     PROVIDES_SERVICE(mysql_server, mysql_text_consumer_get_string_v1),
     PROVIDES_SERVICE(mysql_server, mysql_text_consumer_client_capabilities_v1),
     PROVIDES_SERVICE(mysql_server, mysql_status_variable_string),
+    PROVIDES_SERVICE(mysql_server, mysql_command_field_metadata),
     END_COMPONENT_PROVIDES();
 
 static BEGIN_COMPONENT_REQUIRES(mysql_server) END_COMPONENT_REQUIRES();
