Bug#31048451 RECOVERY FRAMEWORK IS UNABLE TO DETECT FAILURE OF RECOVERY JOBS

Problem
=======
Recovery Framework in RAPID plugin issues 'ALTER TABLE <table-name>
SECONDARY_LOAD' commands to automatically load tables. Framework uses MySQL
service to issue these queries in local sessions. Specifically
command_service_run_command() is called, and it's return value is checked to
know if load successfully happened or not. Along with the return value, the
error value set in thd variable of the session is also checked. Understanding
is that return value does not account all runtime errors.

Analysis
========
WL#13357 introduced a modification in the session service query execution method
that clears THD's Diagnostic Area at the end. Query execution failures could not
be detected anymore.

Fix
===
Modificaion in the command_service_run_command function was rolled back.
The X plugin was modified not to rely on the Diagnostic Area when generating
connection message audit event on authentication error.

RB: 24103

Reviewed-by: Georgi 'Joro' Kodinov <[email protected]>
Reviewed-by: Łukasz Kotula <[email protected]>

Author: maras007

include/mysql/components/services/audit_api_connection_service.h

@@ -57,4 +57,45 @@ DECLARE_METHOD(int, emit, (void *thd, mysql_event_connection_subclass_t type));
 
 END_SERVICE_DEFINITION(mysql_audit_api_connection)
 
+/**
+  @ingroup group_components_services_inventory
+
+  A service to generate Audit API events of the connection class
+  (MYSQL_AUDIT_CONNECTION_CLASS) with the explicitly specified error code
+  value.
+
+  This service should ONLY be used if we cannot set the THD's Statement
+  Diagnostic Area result code, which is passed along the audit notification
+  chain. The preferred way of generating the event is to rely on THD's internal
+  data as much as possible (mysql_audit_api_connection service)
+
+  The emit method generates the event in the synchronous way, causing
+  all subscribers to receive it.
+
+  @sa @ref mysql_audit_api_connection_imp
+*/
+BEGIN_SERVICE_DEFINITION(mysql_audit_api_connection_with_error)
+
+/**
+  Method that emits event of the MYSQL_AUDIT_CONNECTION_CLASS class
+  and the specified type with the explicitly specified error code value.
+
+  @sa mysql_event_connection_subclass_t
+
+  @param thd     Session THD that generates connection event.
+  @param type    Connection event type.
+  @param errcode Error code that replaces Statement Diagnostic Area result
+                 value, which is simply bypassed by calling this method.
+
+  @return Plugin that receives Audit API event can return event processing
+          value. The code that generates the event can take custom action
+          based on the returned value. 0 value is returned if no action is
+          required on the event generation side.
+`*/
+DECLARE_METHOD(int, emit,
+               (void *thd, mysql_event_connection_subclass_t type,
+                int errcode));
+
+END_SERVICE_DEFINITION(mysql_audit_api_connection_with_error)
+
 #endif /* AUDIT_API_CONNECTION_H */

plugin/x/source_files.cmake

@@ -82,7 +82,6 @@ SET(xplugin_SRC
   src/services/service_registry_registration.cc
   src/services/service_sys_variables.cc
   src/services/service_audit_api_connection.cc
-  src/services/service_runtime_error.cc
   src/services/services.cc
   src/services/service_udf_registration.cc
   src/xpl_plugin.cc

plugin/x/src/interface/service_audit_api_connection.h

@@ -52,6 +52,19 @@ class Service_audit_api_connection {
   */
   virtual int emit(void *thd, mysql_event_connection_subclass_t type) = 0;
 
+  /*
+    Generate audit event of the connection class.
+
+    @param[in] thd     THD used for error reporting.
+    @param[in] type    Connection event subtype.
+    @param[in] errcode Error code that replaces Diagnostic Area result code.
+
+    @return Value returned by the Audit API handling mechanism.
+  */
+  virtual int emit_with_errorcode(void *thd,
+                                  mysql_event_connection_subclass_t type,
+                                  int errcode) = 0;
+
   /*
     Check validity of the object.
 

plugin/x/src/interface/service_runtime_error.h

@@ -33,19 +33,36 @@ Service_audit_api_connection::Service_audit_api_connection(
   m_audit_api =
       reinterpret_cast<SERVICE_TYPE_NO_CONST(mysql_audit_api_connection) *>(
           m_registry->acquire("mysql_audit_api_connection"));
+
+  if (m_audit_api == nullptr) return;
+
+  m_audit_api_error = reinterpret_cast<SERVICE_TYPE_NO_CONST(
+      mysql_audit_api_connection_with_error) *>(
+      m_registry->acquire("mysql_audit_api_connection_with_error"));
+
+  if (m_audit_api_error == nullptr) {
+    m_registry->release(reinterpret_cast<my_h_service>(m_audit_api));
+    m_audit_api = nullptr;
+  }
 }
 
 Service_audit_api_connection::~Service_audit_api_connection() {
   m_registry->release(reinterpret_cast<my_h_service>(m_audit_api));
+  m_registry->release(reinterpret_cast<my_h_service>(m_audit_api_error));
 }
 
 int Service_audit_api_connection::emit(void *thd,
                                        mysql_event_connection_subclass_t type) {
   return m_audit_api->emit(thd, type);
 }
 
+int Service_audit_api_connection::emit_with_errorcode(
+    void *thd, mysql_event_connection_subclass_t type, int errcode) {
+  return m_audit_api_error->emit(thd, type, errcode);
+}
+
 bool Service_audit_api_connection::is_valid() const {
-  return nullptr != m_audit_api;
+  return nullptr != m_audit_api && nullptr != m_audit_api_error;
 }
 
 }  // namespace xpl

plugin/x/src/services/service_audit_api_connection.cc

@@ -50,13 +50,23 @@ class Service_audit_api_connection
   /*
     Generate audit event of the connection class using the service.
 
-    @param[in] thd  THD used for error reporting.
-    @param[in] type Connection event subtype.
+    @param[in] thd     THD used for error reporting.
+    @param[in] type    Connection event subtype.
 
     @return Value returned by the Audit API handling mechanism.
   */
   int emit(void *thd, mysql_event_connection_subclass_t type) override;
+  /*
+    Generate audit event of the connection class using the service.
 
+    @param[in] thd     THD used for error reporting.
+    @param[in] type    Connection event subtype.
+    @param[in] errcode Error code.
+
+    @return Value returned by the Audit API handling mechanism.
+  */
+  int emit_with_errorcode(void *thd, mysql_event_connection_subclass_t type,
+                          int errcode) override;
   /*
     Check validity of the object.
 
@@ -74,6 +84,11 @@ class Service_audit_api_connection
     Audit API service pointer acquired during the object construction.
   */
   SERVICE_TYPE_NO_CONST(mysql_audit_api_connection) * m_audit_api;
+  /*
+    Audit API service pointer acquired during the object construction.
+  */
+  SERVICE_TYPE_NO_CONST(mysql_audit_api_connection_with_error) *
+      m_audit_api_error;
 };
 
 }  // namespace xpl

plugin/x/src/services/service_audit_api_connection.h

@@ -23,15 +23,13 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 #include "plugin/x/src/services/services.h"
 
 #include "plugin/x/src/services/service_audit_api_connection.h"
-#include "plugin/x/src/services/service_runtime_error.h"
 #include "plugin/x/src/services/service_sys_variables.h"
 
 namespace xpl {
 
 Services::Services() {
   m_system_variable_register.reset(new Service_sys_variables(&m_registry));
   m_audit_api.reset(new Service_audit_api_connection(&m_registry));
-  m_runtime_error.reset(new Service_runtime_error(&m_registry));
 }
 
 }  // namespace xpl

plugin/x/src/services/service_runtime_error.cc

@@ -26,7 +26,6 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
 #include <memory>
 
 #include "plugin/x/src/interface/service_audit_api_connection.h"
-#include "plugin/x/src/interface/service_runtime_error.h"
 #include "plugin/x/src/interface/service_sys_variables.h"
 #include "plugin/x/src/services/service_registry.h"
 
@@ -41,7 +40,6 @@ class Services {
  public:
   using Sys_variables_ptr = std::unique_ptr<iface::Service_sys_variables>;
   using Audit_api_ptr = std::unique_ptr<iface::Service_audit_api_connection>;
-  using Runtime_error_ptr = std::unique_ptr<iface::Service_runtime_error>;
 
  public:
   /*
@@ -53,8 +51,7 @@ class Services {
     Check, whether all services has been correctly acquired.
   */
   bool is_valid() const {
-    return m_system_variable_register->is_valid() && m_audit_api->is_valid() &&
-           m_runtime_error->is_valid();
+    return m_system_variable_register->is_valid() && m_audit_api->is_valid();
   }
 
   /*
@@ -69,10 +66,6 @@ class Services {
     Audit API service pointer.
   */
   Audit_api_ptr m_audit_api;
-  /*
-    Runtime error service pointer.
-  */
-  Runtime_error_ptr m_runtime_error;
 };
 
 }  // namespace xpl