BUG#23575086 - X PLUGIN STARTUP ERROR MESSAGES

Description:
  X Plugin startup messages could be confusing without knowing
  source code

Solution:
  Cleanup of startup messages was already done under wl 9306,
  one missing thing is the reference to documentation. Added
  following trace in case of error while setting up I/O interface:
  'Please see the MySQL documentation for '%s' system variable to fix the error'

RB: 13565
Reviewed-by: Grzegorz Szwarc <[email protected]>

Author: lkotula

rapid/plugin/x/mysqlx_variables.cmake

@@ -24,6 +24,7 @@ STRING(SUBSTRING ${MYSQLX_PLUGIN_NAME} 1 -1 MYSQLX_PLUGIN_NAME_REST)
 STRING(TOUPPER ${MYSQLX_PLUGIN_NAME_FIRST_LETTER} MYSQLX_PLUGIN_NAME_FIRST_LETTER)
 
 SET(MYSQLX_STATUS_VARIABLE_NAME "${MYSQLX_PLUGIN_NAME_FIRST_LETTER}${MYSQLX_PLUGIN_NAME_REST}")
+SET(MYSQLX_SYSTEM_VARIABLE_NAME "${MYSQLX_PLUGIN_NAME}")
 
 SET(MYSQLX_TCP_PORT 33060)
 

rapid/plugin/x/ngs/include/ngs/interface/listener_factory_interface.h

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2016 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 as
+ * published by the Free Software Foundation; version 2 of the
+ * License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301  USA
+ */
+
+#ifndef _NGS_LISTENER_FACTORY_INTERFACE_H_
+#define _NGS_LISTENER_FACTORY_INTERFACE_H_
+
+#include "ngs/interface/listener_interface.h"
+#include "ngs/memory.h"
+
+
+namespace ngs
+{
+
+class Time_and_socket_events;
+typedef Memory_new<Listener_interface>::Unique_ptr Listener_interface_ptr;
+
+class Listener_factory_interface
+{
+public:
+
+  virtual ~Listener_factory_interface() {}
+
+  virtual Listener_interface_ptr create_unix_socket_listener(const std::string &unix_socket_path, Time_and_socket_events &event) = 0;
+  virtual Listener_interface_ptr create_tcp_socket_listener(const unsigned short port, Time_and_socket_events &event) = 0;
+};
+
+} // namespace ngs
+
+#endif // _NGS_LISTENER_FACTORY_INTERFACE_H_

rapid/plugin/x/ngs/include/ngs/interface/listener_interface.h

@@ -48,7 +48,8 @@ class Listener_interface
 
   virtual Sync_variable_state &get_state() = 0;
   virtual std::string get_last_error() = 0;
-  virtual std::string get_description() = 0;
+  virtual std::string get_name_and_configuration() const = 0;
+  virtual std::string get_configuration_variable() const = 0;
   virtual bool is_handled_by_socket_event() = 0;
 
   virtual bool setup_listener(On_connection) = 0;

rapid/plugin/x/ngs/include/ngs/server.h

@@ -54,7 +54,6 @@ class Server_task_interface;
 class Connection_acceptor_interface;
 class Incoming_queue;
 class Scheduler_dynamic;
-class Named_pipe_listener;
 class Server_acceptors;
 
 class Server: public Server_interface

rapid/plugin/x/ngs/include/ngs/server_acceptors.h

@@ -21,6 +21,7 @@
 #define _NGS_SERVER_ACCEPTORS_
 
 #include "ngs/interface/listener_interface.h"
+#include "ngs/interface/listener_factory_interface.h"
 #include "ngs/interface/server_task_interface.h"
 #include "ngs/time_socket_events.h"
 #include <string>
@@ -38,7 +39,8 @@ class Server_acceptors
 public:
   typedef Listener_interface::On_connection On_connection;
 
-  Server_acceptors(const unsigned short tcp_port,
+  Server_acceptors(Listener_factory_interface &listener_factory,
+                   const unsigned short tcp_port,
                    const std::string &unix_socket_file_or_named_pipe);
 
   bool prepare(On_connection on_connection, const bool skip_networking, const bool use_unix_sockets_or_named_pipes);
@@ -62,8 +64,8 @@ class Server_acceptors
   static void close_listener(Listener_interface *listener);
   static void report_listener_status(Listener_interface *listener);
 
-  boost::scoped_ptr<Listener_interface> m_tcp_socket;
-  boost::scoped_ptr<Listener_interface> m_unix_socket;
+  Listener_interface_ptr m_tcp_socket;
+  Listener_interface_ptr m_unix_socket;
 
   Listener_interface::Sync_variable_state m_time_and_event_state;
   boost::shared_ptr<Server_task_time_and_event> m_time_and_event_task;

rapid/plugin/x/ngs/src/server_acceptors.cc

@@ -35,163 +35,6 @@ using namespace ngs;
 namespace details
 {
 
-class Tcp_listener: public Listener_interface
-{
-public:
-  Tcp_listener(const unsigned short port, Time_and_socket_events &event)
-  : m_state(State_listener_initializing),
-    m_port(port),
-    m_event(event)
-  {
-    m_tcp_socket = ngs::Connection_vio::create_and_bind_socket(port, m_last_error);
-  }
-
-  ~Tcp_listener()
-  {
-    Connection_vio::close_socket(m_tcp_socket);
-  }
-
-  Sync_variable_state &get_state()
-  {
-    return m_state;
-  }
-
-  bool is_handled_by_socket_event()
-  {
-    return true;
-  }
-
-  std::string get_last_error()
-  {
-    return m_last_error;
-  }
-
-  std::string get_description()
-  {
-    char to_string_buffer[32];
-
-    sprintf(to_string_buffer, "%i", m_port);
-
-    std::string result = "TCP (port:";
-
-    result += to_string_buffer;
-    result += ")";
-
-    return result;
-  }
-
-  bool setup_listener(On_connection on_connection)
-  {
-    if (INVALID_SOCKET == m_tcp_socket)
-      return false;
-
-    if (m_event.listen(m_tcp_socket, on_connection))
-    {
-      m_state.set(State_listener_prepared);
-      return true;
-    }
-
-    return false;
-  }
-
-  void close_listener()
-  {
-    Connection_vio::close_socket(m_tcp_socket);
-  }
-
-  void loop()
-  {
-  }
-
-private:
-  Sync_variable_state m_state;
-  const unsigned short m_port;
-  my_socket m_tcp_socket;
-  Time_and_socket_events &m_event;
-  std::string m_last_error;
-};
-
-
-class Unix_socket_listener: public Listener_interface
-{
-public:
-  Unix_socket_listener(const std::string &unix_socket_path, Time_and_socket_events &event)
-  : m_state(State_listener_initializing),
-    m_unix_socket_path(unix_socket_path),
-    m_event(event)
-  {
-#if !defined(HAVE_SYS_UN_H)
-    m_state.set(State_listener_stopped);
-#else
-    m_unix_socket = ngs::Connection_vio::create_and_bind_socket(unix_socket_path, m_last_error);
-#endif // !defined(HAVE_SYS_UN_H)
-  }
-
-  ~Unix_socket_listener()
-  {
-    Connection_vio::close_socket(m_unix_socket);
-  }
-
-  Sync_variable_state &get_state()
-  {
-    return m_state;
-  }
-
-  bool is_handled_by_socket_event()
-  {
-    return true;
-  }
-
-  std::string get_description()
-  {
-    std::string result = "UNIX socket (";
-
-    result += m_unix_socket_path;
-    result += ")";
-
-    return result;
-  }
-
-  std::string get_last_error()
-  {
-    return m_last_error;
-  }
-
-  bool setup_listener(On_connection on_connection)
-  {
-    if (!m_state.is(State_listener_initializing))
-      return false;
-
-    if (INVALID_SOCKET == m_unix_socket)
-      return false;
-
-    if (m_event.listen(m_unix_socket, on_connection))
-    {
-      m_state.set(State_listener_prepared);
-      return true;
-    }
-
-    return false;
-  }
-
-  void close_listener()
-  {
-    Connection_vio::close_socket(m_unix_socket);
-  }
-
-  void loop()
-  {
-  }
-
-private:
-  Sync_variable_state m_state;
-  const std::string m_unix_socket_path;
-  my_socket m_unix_socket;
-  Time_and_socket_events &m_event;
-  std::string m_last_error;
-};
-
-
 class Server_task_listener: public Server_task_interface
 {
 public:
@@ -275,11 +118,12 @@ class Server_acceptors::Server_task_time_and_event: public Server_task_interface
 
 
 Server_acceptors::Server_acceptors(
+    Listener_factory_interface &listener_factory,
     const unsigned short tcp_port,
     const std::string &unix_socket_file_or_named_pipe)
-: m_tcp_socket(new details::Tcp_listener(tcp_port, m_event)),
+: m_tcp_socket(listener_factory.create_tcp_socket_listener(tcp_port, m_event)),
 #if defined(HAVE_SYS_UN_H)
-  m_unix_socket(new details::Unix_socket_listener(unix_socket_file_or_named_pipe, m_event)),
+  m_unix_socket(listener_factory.create_unix_socket_listener(unix_socket_file_or_named_pipe, m_event)),
 #endif
   m_time_and_event_state(State_listener_initializing),
   m_time_and_event_task(new Server_task_time_and_event(m_event, m_time_and_event_state))
@@ -298,7 +142,7 @@ bool Server_acceptors::prepare_impl(On_connection on_connection, const bool skip
 
   if (listeners.empty())
   {
-    log_warning("All IO interfaces are disabled, X Protocol won't be accessible");
+    log_warning("All I/O interfaces are disabled, X Protocol won't be accessible");
 
     return false;
   }
@@ -312,7 +156,7 @@ bool Server_acceptors::prepare_impl(On_connection on_connection, const bool skip
   {
     abort();
 
-    log_error("Preparation of IO interfaces failed, X Protocol won't be accessible");
+    log_error("Preparation of I/O interfaces failed, X Protocol won't be accessible");
 
     return false;
   }
@@ -452,10 +296,18 @@ void Server_acceptors::report_listener_status(Listener_interface *listener)
 {
   if (!listener->get_state().is(State_listener_prepared))
   {
-    log_error("X Plugin failed to setup %s, with:", listener->get_description().c_str());
+    log_error("X Plugin failed to setup %s, with:", listener->get_name_and_configuration().c_str());
     log_error("%s", listener->get_last_error().c_str());
+
+    const std::string listener_configuration_variable = listener->get_configuration_variable();
+
+    if (!listener_configuration_variable.empty())
+    {
+      log_info("Please see the MySQL documentation for '%s' system variable to fix the error", listener_configuration_variable.c_str());
+    }
+
     return;
   }
 
-  log_info("X Plugin listens at %s", listener->get_description().c_str());
+  log_info("X Plugin listens on %s", listener->get_name_and_configuration().c_str());
 }

rapid/plugin/x/source_files.cmake

@@ -52,6 +52,8 @@ SET(xplugin_HDRS
   "${MYSQLX_PROJECT_DIR}/src/xpl_global_status_variables.h"
   "${MYSQLX_PROJECT_DIR}/src/xpl_session_status_variables.h"
   "${MYSQLX_PROJECT_DIR}/src/xpl_replication_observer.h"
+  "${MYSQLX_PROJECT_DIR}/src/xpl_log.h"
+  "${MYSQLX_PROJECT_DIR}/src/xpl_regex.h"
   "${MYSQLX_PROJECT_DIR}/src/auth_plain.h"
   "${MYSQLX_PROJECT_DIR}/src/auth_mysql41.h"
   "${MYSQLX_PROJECT_DIR}/src/admin_cmd_handler.h"
@@ -67,15 +69,13 @@ SET(xplugin_HDRS
   "${MYSQLX_PROJECT_DIR}/src/sql_user_require.h"
   "${MYSQLX_PROJECT_DIR}/src/json_utils.h"
   "${MYSQLX_PROJECT_DIR}/src/expect.h"
-  "${MYSQLX_PROJECT_DIR}/src/xpl_log.h"
   "${MYSQLX_PROJECT_DIR}/src/statement_builder.h"
   "${MYSQLX_PROJECT_DIR}/src/update_statement_builder.h"
   "${MYSQLX_PROJECT_DIR}/src/find_statement_builder.h"
   "${MYSQLX_PROJECT_DIR}/src/insert_statement_builder.h"
   "${MYSQLX_PROJECT_DIR}/src/delete_statement_builder.h"
   "${MYSQLX_PROJECT_DIR}/src/notices.h"
   "${MYSQLX_PROJECT_DIR}/src/cap_handles_expired_passwords.h"
-  "${MYSQLX_PROJECT_DIR}/src/xpl_regex.h"
   ${ngs_HDRS}
 )
 
@@ -87,6 +87,8 @@ SET(xplugin_SRC
   "${MYSQLX_PROJECT_DIR}/src/xpl_dispatcher.cc"
   "${MYSQLX_PROJECT_DIR}/src/xpl_system_variables.cc"
   "${MYSQLX_PROJECT_DIR}/src/xpl_replication_observer.cc"
+  "${MYSQLX_PROJECT_DIR}/src/xpl_regex.cc"
+  "${MYSQLX_PROJECT_DIR}/src/xpl_listener_factory.cc"
   "${MYSQLX_PROJECT_DIR}/src/mysql_variables.cc"
   "${MYSQLX_PROJECT_DIR}/src/mysql_function_names.cc"
   "${MYSQLX_PROJECT_DIR}/src/mysql_show_variable_wrapper.cc"
@@ -110,7 +112,6 @@ SET(xplugin_SRC
   "${MYSQLX_PROJECT_DIR}/src/delete_statement_builder.cc"
   "${MYSQLX_PROJECT_DIR}/src/insert_statement_builder.cc"
   "${MYSQLX_PROJECT_DIR}/src/notices.cc"
-  "${MYSQLX_PROJECT_DIR}/src/xpl_regex.cc"
   ${ngs_SRC} 
 )
 

rapid/plugin/x/src/mysqlx_version.h.in

@@ -28,6 +28,7 @@
 
 #define MYSQLX_PLUGIN_NAME "@MYSQLX_PLUGIN_NAME@"
 #define MYSQLX_STATUS_VARIABLE_PREFIX(NAME) "@MYSQLX_STATUS_VARIABLE_NAME@_" NAME
+#define MYSQLX_SYSTEM_VARIABLE_PREFIX(NAME) "@MYSQLX_SYSTEM_VARIABLE_NAME@_" NAME
 
 #define MYSQLX_TCP_PORT             @MYSQLX_TCP_PORT@U
 #define MYSQLX_UNIX_ADDR            "@MYSQLX_UNIX_ADDR@"