protobuf 3.2.1 → 3.3.0

data/lib/protobuf/cli.rb

@@ -1,12 +1,13 @@
 require 'thor'
 require 'protobuf/version'
-require 'protobuf/logger'
+require 'protobuf/logging'
 require 'protobuf/rpc/servers/socket_runner'
 require 'protobuf/rpc/servers/zmq_runner'
 
 module Protobuf
   class CLI < ::Thor
     include ::Thor::Actions
+    include ::Protobuf::Logging
 
     attr_accessor :runner, :mode
 
@@ -21,7 +22,7 @@ module Protobuf
     option :threshold,                  :type => :numeric, :default => 100, :aliases => %w(-t), :desc => 'Multi-threaded Socket Server cleanup threshold.'
     option :threads,                    :type => :numeric, :default => 5, :aliases => %w(-r), :desc => 'Number of worker threads to run. Only applicable in --zmq mode.'
 
-    option :log,                        :type => :string, :aliases => %w(-l), :desc => 'Log file or device. Default is STDOUT.'
+    option :log,                        :type => :string, :default => STDOUT, :aliases => %w(-l), :desc => 'Log file or device. Default is STDOUT.'
     option :level,                      :type => :numeric, :default => ::Logger::INFO, :aliases => %w(-v), :desc => 'Log level to use, 0-5 (see http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/)'
 
     option :socket,                     :type => :boolean, :aliases => %w(-s), :desc => 'Socket Mode for server and client connections.'
@@ -86,12 +87,14 @@ module Protobuf
       # Setup the protobuf logger.
       def configure_logger
         debug_say('Configuring logger')
-        ::Protobuf::Logger.configure({ :file => options.log || STDOUT,
-                                     :level => options.debug? ? ::Logger::DEBUG : options.level })
+
+        log_level = options.debug? ? ::Logger::DEBUG : options.level
+
+        ::Protobuf::Logging.initialize_logger(options.log, log_level)
 
         # Debug output the server options to the log file.
-        ::Protobuf::Logger.debug { 'Debugging options:' }
-        ::Protobuf::Logger.debug { options.inspect }
+        logger.debug { 'Debugging options:' }
+        logger.debug { options.inspect }
       end
 
       # Re-write the $0 var to have a nice process name in ps.
@@ -185,15 +188,16 @@ module Protobuf
       end
 
       def say_and_exit(message, exception = nil)
-        message = set_color(message, :red) if ::Protobuf::Logger.file == STDOUT
+        message = set_color(message, :red) if options.log == STDOUT
+
+        logger.error { message }
 
-        ::Protobuf::Logger.error { message }
         if exception
           $stderr.puts "[#{exception.class.name}] #{exception.message}"
           $stderr.puts exception.backtrace.join("\n")
 
-          ::Protobuf::Logger.error { "[#{exception.class.name}] #{exception.message}" }
-          ::Protobuf::Logger.debug { exception.backtrace.join("\n") }
+          logger.error { "[#{exception.class.name}] #{exception.message}" }
+          logger.debug { exception.backtrace.join("\n") }
         end
 
         exit(1)
@@ -212,10 +216,10 @@ module Protobuf
       end
 
       def shutdown_server
-        ::Protobuf::Logger.info { 'RPC Server shutting down...' }
+        logger.info { 'RPC Server shutting down...' }
         @runner.try(:stop)
         ::Protobuf::Rpc::ServiceDirectory.instance.stop
-        ::Protobuf::Logger.info { 'Shutdown complete' }
+        logger.info { 'Shutdown complete' }
       end
 
       # Start the runner and log the relevant options.
@@ -223,7 +227,7 @@ module Protobuf
         debug_say('Running server')
 
         @runner.run do
-          ::Protobuf::Logger.info {
+          logger.info {
             "pid #{::Process.pid} -- #{@runner_mode} RPC Server listening at #{options.host}:#{options.port}"
           }
 

data/lib/protobuf/field/base_field.rb

@@ -1,9 +1,11 @@
-require 'protobuf/wire_type'
 require 'protobuf/field/field_array'
+require 'protobuf/logging'
+require 'protobuf/wire_type'
 
 module Protobuf
   module Field
     class BaseField
+      include ::Protobuf::Logging
 
       ##
       # Constants

data/lib/protobuf/field/bytes_field.rb

@@ -67,8 +67,8 @@ module Protobuf
                 raise TypeError, "Unacceptable value #{val} for field #{field.name} of type #{field.type_class}"
               end
             rescue NoMethodError => ex
-              ::Protobuf::Logger.error { ex.message }
-              ::Protobuf::Logger.error { ex.backtrace.join("\n") }
+              logger.error { ex.message }
+              logger.error { ex.backtrace.join("\n") }
               raise TypeError, "Got NoMethodError attempting to set #{val} for field #{field.name} of type #{field.type_class}: #{ex.message}"
             end
           end

data/lib/protobuf/lifecycle.rb

@@ -1,6 +1,6 @@
 module Protobuf
   class Lifecycle
-    include ::Protobuf::Logger::LogMethods
+    include ::Protobuf::Logging
 
     def self.register(event_name, &blk)
       raise "Lifecycle register must have a block" unless block_given?

data/lib/protobuf/logging.rb

@@ -0,0 +1,49 @@
+module Protobuf
+  module Logging
+    def self.initialize_logger(log_target=$stdout, log_level=::Logger::INFO)
+      @counter ||= 0
+      @counter = @counter + 1
+      old_logger = defined?(@logger) ? @logger : nil
+      @logger = Logger.new(log_target)
+      @logger.level = log_level
+      old_logger.close if old_logger and close_old_logger?
+      @logger
+    end
+
+    def self.close_old_logger=(boolean)
+      @close_old_logger = !!boolean
+    end
+
+    def self.close_old_logger?
+      defined?(@close_old_logger) ? @close_old_logger : true
+    end
+
+    def self.logger
+      defined?(@logger) ? @logger : initialize_logger
+    end
+
+    def self.logger=(new_logger)
+      @logger = new_logger
+    end
+
+    def logger
+      ::Protobuf::Logging.logger
+    end
+
+    def log_exception(ex)
+      logger.error { ex.message }
+      logger.error { ex.backtrace[0..5].join("\n") }
+      logger.debug { ex.backtrace.join("\n") }
+    end
+
+    def log_signature
+      @_log_signature ||= "[#{self.class == Class ? self.name : self.class.name}]"
+    end
+
+    def sign_message(message)
+      "#{log_signature} #{message}"
+    end
+  end
+end
+
+# Inspired by [mperham](https://github.com/mperham/sidekiq)

data/lib/protobuf/rpc/client.rb

@@ -1,6 +1,6 @@
 require 'forwardable'
 require 'protobuf'
-require 'protobuf/logger'
+require 'protobuf/logging'
 require 'protobuf/rpc/error'
 require 'protobuf/rpc/connector'
 
@@ -8,7 +8,7 @@ module Protobuf
   module Rpc
     class Client
       extend Forwardable
-      include Protobuf::Logger::LogMethods
+      include Protobuf::Logging
 
       def_delegators :@connector, :options, :complete_cb, :success_cb, :failure_cb
       attr_reader :connector
@@ -29,7 +29,7 @@ module Protobuf
       def initialize(options = {})
         raise "Invalid client configuration. Service must be defined." if options[:service].nil?
         @connector = Connector.connector_for_client.new(options)
-        log_debug { sign_message("Initialized with options: #{options.inspect}") }
+        logger.debug { sign_message("Initialized with options: #{options.inspect}") }
       end
 
       def log_signature
@@ -106,28 +106,28 @@ module Protobuf
       def method_missing(method_name, *params)
         service = options[:service]
         unless service.rpc_method?(method_name)
-          log_error { sign_message("#{service.name}##{method_name.to_s} not rpc method, passing to super") }
+          logger.error { sign_message("#{service.name}##{method_name.to_s} not rpc method, passing to super") }
           super(method_name, *params)
         else
-          log_debug { sign_message("#{service.name}##{method_name.to_s}") }
+          logger.debug { sign_message("#{service.name}##{method_name.to_s}") }
           rpc = service.rpcs[method_name.to_sym]
 
           options[:request_type] = rpc.request_type
-          log_debug { sign_message("Request Type: #{options[:request_type].name}") }
+          logger.debug { sign_message("Request Type: #{options[:request_type].name}") }
 
           options[:response_type] = rpc.response_type
-          log_debug { sign_message("Response Type: #{options[:response_type].name}") }
+          logger.debug { sign_message("Response Type: #{options[:response_type].name}") }
 
           options[:method] = method_name.to_s
           options[:request] = params[0].is_a?(Hash) ? options[:request_type].new(params[0]) : params[0]
-          log_debug { sign_message("Request Data: #{options[:request].inspect}") }
+          logger.debug { sign_message("Request Data: #{options[:request].inspect}") }
 
           # Call client to setup on_success and on_failure event callbacks
           if block_given?
-            log_debug { sign_message("client setup callback given, invoking") }
+            logger.debug { sign_message("client setup callback given, invoking") }
             yield(self)
           else
-            log_debug { sign_message("no block given for callbacks") }
+            logger.debug { sign_message("no block given for callbacks") }
           end
 
           send_request

data/lib/protobuf/rpc/connectors/base.rb

@@ -1,5 +1,5 @@
 require 'timeout'
-require 'protobuf/logger'
+require 'protobuf/logging'
 require 'protobuf/rpc/rpc.pb'
 require 'protobuf/rpc/buffer'
 require 'protobuf/rpc/error'
@@ -23,7 +23,7 @@ module Protobuf
       }
 
       class Base
-        include Protobuf::Logger::LogMethods
+        include Protobuf::Logging
 
         attr_reader :options
         attr_accessor :success_cb, :failure_cb, :complete_cb

data/lib/protobuf/rpc/connectors/common.rb

@@ -19,17 +19,17 @@ module Protobuf
 
         def complete
           @stats.stop
-          log_info { @stats.to_s }
-          log_debug { sign_message('Response proceessing complete') }
+          logger.info { @stats.to_s }
+          logger.debug { sign_message('Response proceessing complete') }
           @complete_cb.call(self) unless @complete_cb.nil?
         rescue => e
-          log_error { sign_message('Complete callback error encountered') }
+          logger.error { sign_message('Complete callback error encountered') }
           log_exception(e)
           raise
         end
 
         def data_callback(data)
-          log_debug { sign_message('Using data_callback') }
+          logger.debug { sign_message('Using data_callback') }
           @used_data_callback = true
           @data = data
         end
@@ -42,11 +42,11 @@ module Protobuf
           @error =  ClientError.new
           @error.code = Protobuf::Socketrpc::ErrorReason.fetch(code)
           @error.message = message
-          log_debug { sign_message("Server failed request (invoking on_failure): #{@error.inspect}") }
+          logger.debug { sign_message("Server failed request (invoking on_failure): #{@error.inspect}") }
 
           @failure_cb.call(@error) unless @failure_cb.nil?
         rescue => e
-          log_error { sign_message("Failure callback error encountered") }
+          logger.error { sign_message("Failure callback error encountered") }
           log_exception(e)
           raise
         ensure
@@ -71,7 +71,7 @@ module Protobuf
           # Close up the connection as we no longer need it
           close_connection
 
-          log_debug { sign_message("Parsing response from server (connection closed)") }
+          logger.debug { sign_message("Parsing response from server (connection closed)") }
 
           # Parse out the raw response
           @stats.response_size = @response_data.size unless @response_data.nil?
@@ -79,13 +79,13 @@ module Protobuf
 
           # Determine success or failure based on parsed data
           if response_wrapper.has_field?(:error_reason)
-            log_debug { sign_message("Error response parsed") }
+            logger.debug { sign_message("Error response parsed") }
 
             # fail the call if we already know the client is failed
             # (don't try to parse out the response payload)
             fail(response_wrapper.error_reason, response_wrapper.error)
           else
-            log_debug { sign_message("Successful response parsed") }
+            logger.debug { sign_message("Successful response parsed") }
 
             # Ensure client_response is an instance
             parsed = @options[:response_type].decode(response_wrapper.response_proto.to_s)
@@ -125,10 +125,10 @@ module Protobuf
         end
 
         def succeed(response)
-          log_debug { sign_message("Server succeeded request (invoking on_success)") }
+          logger.debug { sign_message("Server succeeded request (invoking on_success)") }
           @success_cb.call(response) unless @success_cb.nil?
         rescue => e
-          log_error { sign_message("Success callback error encountered") }
+          logger.error { sign_message("Success callback error encountered") }
           log_exception(e)
           fail(:RPC_ERROR, "An exception occurred while calling on_success: #{e.message}")
         ensure
@@ -153,7 +153,7 @@ module Protobuf
 
         def verify_callbacks
           unless any_callbacks?
-            log_debug { sign_message("No callbacks set, using data_callback") }
+            logger.debug { sign_message("No callbacks set, using data_callback") }
             @success_cb = @failure_cb = self.method(:data_callback)
           end
         end

data/lib/protobuf/rpc/connectors/socket.rb

@@ -5,7 +5,7 @@ module Protobuf
     module Connectors
       class Socket < Base
         include Protobuf::Rpc::Connectors::Common
-        include Protobuf::Logger::LogMethods
+        include Protobuf::Logging
 
         def send_request
           timeout_wrap do
@@ -24,18 +24,18 @@ module Protobuf
 
         def close_connection
           @socket.close
-          log_debug { sign_message('Connector closed')  }
+          logger.debug { sign_message('Connector closed')  }
         end
 
         def connect_to_rpc_server
           @socket = TCPSocket.new(options[:host], options[:port])
-          log_debug { sign_message("Connection established #{options[:host]}:#{options[:port]}")  }
+          logger.debug { sign_message("Connection established #{options[:host]}:#{options[:port]}")  }
         end
 
         # Method to determine error state, must be used with Connector api
         def error?
           return true if @error
-          log_debug { sign_message("Error state : #{@socket.closed?}")  }
+          logger.debug { sign_message("Error state : #{@socket.closed?}")  }
           @socket.closed?
         end
 
@@ -51,7 +51,7 @@ module Protobuf
         end
 
         def read_response
-          log_debug { sign_message("error? is #{error?}") }
+          logger.debug { sign_message("error? is #{error?}") }
           return if error?
           response_buffer = ::Protobuf::Rpc::Buffer.new(:read)
           response_buffer << read_data
@@ -65,7 +65,7 @@ module Protobuf
           request_buffer.set_data(@request_data)
           @socket.write(request_buffer.write)
           @socket.flush
-          log_debug { sign_message("write closed") }
+          logger.debug { sign_message("write closed") }
         end
       end
     end

data/lib/protobuf/rpc/connectors/zmq.rb

@@ -12,7 +12,7 @@ module Protobuf
         # Included Modules
         #
         include Protobuf::Rpc::Connectors::Common
-        include Protobuf::Logger::LogMethods
+        include Protobuf::Logging
 
         ##
         # Class Constants
@@ -71,9 +71,9 @@ module Protobuf
             if socket # Make sure the context builds the socket
               socket.setsockopt(::ZMQ::LINGER, 0)
 
-              log_debug { sign_message("Establishing connection: #{server_uri}") }
+              logger.debug { sign_message("Establishing connection: #{server_uri}") }
               zmq_error_check(socket.connect(server_uri), :socket_connect)
-              log_debug { sign_message("Connection established to #{server_uri}") }
+              logger.debug { sign_message("Connection established to #{server_uri}") }
 
               if first_alive_load_balance?
                 begin
@@ -123,6 +123,8 @@ module Protobuf
         def host_alive?(host)
           return true unless ping_port_enabled?
           socket = TCPSocket.new(host, ping_port.to_i)
+          socket.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, 1)
+          socket.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_LINGER, [1,0].pack('ii'))
 
           true
         rescue
@@ -155,21 +157,21 @@ module Protobuf
           poller = ::ZMQ::Poller.new
           poller.register_readable(socket)
 
-          log_debug { sign_message("Sending Request (attempt #{attempt}, #{socket})") }
+          logger.debug { sign_message("Sending Request (attempt #{attempt}, #{socket})") }
           zmq_error_check(socket.send_string(@request_data), :socket_send_string)
-          log_debug { sign_message("Waiting #{timeout} seconds for response (attempt #{attempt}, #{socket})") }
+          logger.debug { sign_message("Waiting #{timeout} seconds for response (attempt #{attempt}, #{socket})") }
 
           if poller.poll(timeout * 1000) == 1
             zmq_error_check(socket.recv_string(@response_data = ""), :socket_recv_string)
-            log_debug { sign_message("Response received (attempt #{attempt}, #{socket})") }
+            logger.debug { sign_message("Response received (attempt #{attempt}, #{socket})") }
           else
-            log_debug { sign_message("Timed out waiting for response (attempt #{attempt}, #{socket})") }
+            logger.debug { sign_message("Timed out waiting for response (attempt #{attempt}, #{socket})") }
             raise RequestTimeout
           end
         ensure
-          log_debug { sign_message("Closing Socket")  }
+          logger.debug { sign_message("Closing Socket")  }
           zmq_error_check(socket.close, :socket_close) if socket
-          log_debug { sign_message("Socket closed")  }
+          logger.debug { sign_message("Socket closed")  }
         end
 
         # The service we're attempting to connect to

data/lib/protobuf/rpc/middleware/exception_handler.rb

@@ -2,7 +2,7 @@ module Protobuf
   module Rpc
     module Middleware
       class ExceptionHandler
-        include ::Protobuf::Logger::LogMethods
+        include ::Protobuf::Logging
 
         attr_reader :app
 

data/lib/protobuf/rpc/middleware/logger.rb

@@ -42,7 +42,7 @@ module Protobuf
           attr_reader :env
 
           def flush(env)
-            Protobuf::Logger.info { to_s(env) }
+            ::Protobuf::Logging.logger.info { to_s(env) }
           end
 
           def start