carrot_rpc 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b377cb46e74db89d8b6bcd97d305a26a0964d539
-  data.tar.gz: 266101d5211ce7409438a958dc5f9629e20cd43e
+  metadata.gz: 3aa31c8e652cfb85ca9ac63bfaff6139a0a76363
+  data.tar.gz: 54258fe17ecb45ff2fcfb35438cc5247c38087c6
 SHA512:
-  metadata.gz: 4b42e357b5212e94d321a9ef2448567f23d905330a931218046f5920a39c818dadf20f3ad940d20da7b63841bb0a9e97595b911da978ae78d6305fa12c1b8dd7
-  data.tar.gz: a23da7aca020a9b0dfc1e17a521aea69a2675db343a1065c152b628d72d90e04c47655c8a6f9b218480174e16bb282112ab6664decd22ad6ec7b0bde07a51b07
+  metadata.gz: 8b6f9404881d86dbecbc93ca34c717e6b3b173e71e4a35a2bf5925554397cf87307f74a87765c80d7e509999766c0422a3e9eee79667357dd66b214dcfc05be0
+  data.tar.gz: c628f3b026f123530d3abe3ba5f5b5b49464a38e84814a06df73915d130b7f254caf98cd539852d3b13e4c8363cd1a7ba1316f0bc74fb0fcaab341ef602cd5fb

data/CHANGELOG.md

@@ -3,43 +3,55 @@
 **Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
 
 - [Changelog](#changelog)
-  - [v0.5.1](#v051)
+  - [v0.7.0](#v070)
     - [Bug Fixes](#bug-fixes)
-  - [v0.5.0](#v050)
-    - [Enhancements](#enhancements)
     - [Incompatible Changes](#incompatible-changes)
-  - [v0.4.1](#v041)
+  - [v0.6.0](#v060)
+    - [Enhancements](#enhancements)
+  - [v0.5.1](#v051)
     - [Bug Fixes](#bug-fixes-1)
-  - [v0.4.0](#v040)
+  - [v0.5.0](#v050)
     - [Enhancements](#enhancements-1)
-    - [Bug Fixes](#bug-fixes-2)
     - [Incompatible Changes](#incompatible-changes-1)
-  - [v0.3.0](#v030)
+  - [v0.4.1](#v041)
+    - [Bug Fixes](#bug-fixes-2)
+  - [v0.4.0](#v040)
     - [Enhancements](#enhancements-2)
     - [Bug Fixes](#bug-fixes-3)
-  - [v0.2.3](#v023)
+    - [Incompatible Changes](#incompatible-changes-2)
+  - [v0.3.0](#v030)
     - [Enhancements](#enhancements-3)
     - [Bug Fixes](#bug-fixes-4)
+  - [v0.2.3](#v023)
+    - [Enhancements](#enhancements-4)
+    - [Bug Fixes](#bug-fixes-5)
     - [Upgrading](#upgrading)
   - [v0.2.1](#v021)
-    - [Bug Fixes](#bug-fixes-5)
-  - [v0.2.0](#v020)
-    - [Enhancements](#enhancements-4)
     - [Bug Fixes](#bug-fixes-6)
-    - [Incompatible Changes](#incompatible-changes-2)
-  - [v0.1.2](#v012)
+  - [v0.2.0](#v020)
     - [Enhancements](#enhancements-5)
     - [Bug Fixes](#bug-fixes-7)
-  - [v0.1.1](#v011)
+    - [Incompatible Changes](#incompatible-changes-3)
+  - [v0.1.2](#v012)
     - [Enhancements](#enhancements-6)
     - [Bug Fixes](#bug-fixes-8)
-    - [Incompatible Changes](#incompatible-changes-3)
+  - [v0.1.1](#v011)
+    - [Enhancements](#enhancements-7)
+    - [Bug Fixes](#bug-fixes-9)
+    - [Incompatible Changes](#incompatible-changes-4)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 # Changelog
 All significant changes in the project are documented here.
 
+## v0.7.0
+### Bug Fixes
+* [#38](https://github.com/C-S-D/carrot_rpc/pull/38) - The `until quit` busy-wait loop consumes ~1 core for each instance of `carrot_rpc` as the default `sleep 0` does the minimal amount of sleep before waking up to check the boolean `quit`.  I've replaced it with an `IO.pipe` and `IO.select` that does not consume any resources while it waits. **NOTE: A Queue could not be used here because the MRI VM blocks use of Mutexes inside signal handlers to prevent deadlocks because the Mutex code is not-reentrant (i.e signal-interrupt-safe).  If a Queue is used the thread silently fails with an exception and the signal is ignored.** - [@KronicDeth](https://github.com/KronicDeth)
+
+### Incompatible Changes
+* [#38](https://github.com/C-S-D/carrot_rpc/pull/38) - Removal of the busy-wait removes the `-s` (`--runloop_sleep`) option as it is no longer needed. - [@KronicDeth](https://github.com/KronicDeth)
+
 ## v0.6.0
 ### Enhancements
 * [#34](https://github.com/C-S-D/carrot_rpc/pull/34) - `--server_test_mode` options for `carrot_rpc` sets `CarrotRpc.configuration.server_test_mode` to `true`.  When `server_test_mode` is true, `_test` is appended to the queue name used by `CarrotRpc::RpcServer` and `CarrotRpc::RpcClient`, so that tests don't use the same queue as production or development. - [@shamil614](https://github.com/C-S-D/carrot_rpc/pull/34)

data/README.md

@@ -10,6 +10,7 @@
   - [Usage](#usage)
     - [Writing Servers](#writing-servers)
     - [Writing Clients](#writing-clients)
+      - [Using request threading in clients](#using-request-threading-in-clients)
     - [Support for JSONAPI::Resources](#support-for-jsonapiresources)
   - [Development](#development)
   - [Contributing](#contributing)
@@ -55,7 +56,6 @@ Usage: server [options]
 Process options:
     -d, --daemonize               run daemonized in the background (default: false)
         --pidfile PIDFILE         the pid filename
-    -s, --runloop_sleep VALUE     Configurable sleep time in the runloop
         --autoload_rails VALUE    loads rails env by default. Uses Rails Logger by default.
         --logfile VALUE           relative path and name for Log file. Overrides Rails logger.
         --loglevel VALUE          levels of loggin: DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN
@@ -98,7 +98,6 @@ CarrotRpc.configure do |config|
   # Don't use. Server implementation only. The values below are set via CLI:
   # config.logfile = nil
   # config.pidfile = nil
-  # config.runloop_sleep = 0
   # config.thread_request_variable = nil
 end
 ```

data/bin/carrot_rpc

@@ -14,6 +14,5 @@ end
 config = CarrotRpc.configuration
 config.bunny.start
 
-runner = CarrotRpc::ServerRunner.new(pidfile: config.pidfile, runloop_sleep: config.runloop_sleep,
-                                     daemonize: config.daemonize)
+runner = CarrotRpc::ServerRunner.new(pidfile: config.pidfile, daemonize: config.daemonize)
 runner.run!

data/lib/carrot_rpc/cli.rb

@@ -34,10 +34,6 @@ module CarrotRpc::CLI
       CarrotRpc.configuration.pidfile = value
     end
 
-    option_parser.on("-s", "--runloop_sleep VALUE", Float, "Configurable sleep time in the runloop") do |value|
-      CarrotRpc.configuration.runloop_sleep = value
-    end
-
     stm_msg = "runs servers with '_test' appended to queue names." \
               "Set Rails Rack env vars to 'test' when used in conjunction with '--autoload_rails'"
     option_parser.on(" ", "--server_test_mode", stm_msg) do

data/lib/carrot_rpc/configuration.rb

@@ -1,6 +1,6 @@
 # Global configuration for {CarrotRpc}.  Access with {CarrotRpc.configuration}.
 class CarrotRpc::Configuration
-  attr_accessor :logger, :logfile, :loglevel, :daemonize, :pidfile, :runloop_sleep, :autoload_rails, :bunny,
+  attr_accessor :logger, :logfile, :loglevel, :daemonize, :pidfile, :autoload_rails, :bunny,
                 :before_request, :rpc_client_timeout, :rpc_client_response_key_format, :rpc_client_request_key_format,
                 :server_test_mode, :client_test_mode, :thread_request_variable
 
@@ -12,7 +12,6 @@ class CarrotRpc::Configuration
     @logger = nil
     @daemonize = false
     @pidfile = nil
-    @runloop_sleep = 0
     @autoload_rails = true
     @bunny = nil
     @before_request = nil

data/lib/carrot_rpc/server_runner/signal.rb

@@ -0,0 +1,60 @@
+# Stores a signal and allows for it to be waited on
+class CarrotRpc::ServerRunner::Signal
+  #
+  # Attributes
+  #
+
+  attr_reader :name
+
+  def initialize
+    self.reader, self.writer = IO.pipe
+  end
+
+  #
+  # Instance Methods
+  #
+
+  # Traps all {CarrotRpc::ServerRunner::Signals}.
+  #
+  # @return [void]
+  def trap
+    CarrotRpc::ServerRunner::Signals.trap do |name|
+      # @note can't log from a trap context: since Ruby 2.0 traps don't allow mutexes as it could lead to a dead lock,
+      #   so `logger.info` here would return "log writing failed. can't be called from trap context"
+      receive(name)
+    end
+  end
+
+  # Waits for a signal trapped by {#trap} to be received.
+  #
+  # @return [String]
+  def wait
+    loop do
+      # Wait {#receive}.  IO.select can wake up
+      read_ready, _write_ready, _error_ready = IO.select([reader])
+
+      next unless read_ready.include? reader
+
+      reader.read_nonblock(1)
+
+      break name
+    end
+  end
+
+  private
+
+  attr_writer :name
+
+  attr_accessor :reader,
+                :writer
+
+  # Sets `name` as the received signal
+  #
+  # @param name [String] name of the signal that was received from the trap
+  # @return [void]
+  def receive(name)
+    self.name = name
+    # any single byte works
+    writer.write_nonblock(".")
+  end
+end

data/lib/carrot_rpc/server_runner.rb

@@ -7,11 +7,13 @@ class CarrotRpc::ServerRunner
   autoload :AutoloadRails
   autoload :Logger
   autoload :Pid
+  autoload :Signal
   autoload :Signals
 
   # Attributes
 
-  attr_reader :quit, :servers
+  attr_reader :signal,
+              :servers
 
   # @return [CarrotRpc::ServerRunner::Pid]
   attr_reader :pid
@@ -19,13 +21,13 @@ class CarrotRpc::ServerRunner
   # Methods
 
   # Instantiate the ServerRunner.
-  def initialize(rails_path: ".", pidfile: nil, runloop_sleep: 0, daemonize: false)
-    @runloop_sleep = runloop_sleep
+  def initialize(rails_path: ".", pidfile: nil, daemonize: false)
+    self.signal = CarrotRpc::ServerRunner::Signal.new
+
     @daemonize = daemonize
     @servers = []
 
     CarrotRpc::ServerRunner::AutoloadRails.conditionally_load_root(rails_path, logger: logger)
-    trap_signals
 
     @pid = CarrotRpc::ServerRunner::Pid.new(
       path:   pidfile,
@@ -35,24 +37,20 @@ class CarrotRpc::ServerRunner
 
   # Start the servers and the run loop.
   def run!
+    signal.trap
+
     pid.check
     daemonize && suppress_output if daemonize?
     pid.ensure_written
 
     # Initialize the servers. Set logger.
     run_servers
-
-    # Sleep for a split second.
-    until quit
-      sleep @runloop_sleep
-    end
-    # When runtime gets here, quit signal is received.
-    stop_servers
+    stop_servers(signal.wait)
   end
 
   # Shutdown all servers defined.
-  def stop_servers
-    logger.info "#{@siginal_name} signal received!"
+  def stop_servers(signal_name)
+    logger.info "#{signal_name} signal received!"
     @servers.each do |s|
       logger.info "Shutting Down Server Queue: #{s.server_queue.name}"
       s.channel.close
@@ -130,23 +128,10 @@ class CarrotRpc::ServerRunner
     $stdout.reopen($stderr)
   end
 
-  # Set a value to signal shutdown.
-  def shutdown(name)
-    @signal_name = name
-    @quit = true
-  end
-
-  # Handle signal events.
-  def trap_signals
-    CarrotRpc::ServerRunner::Signals.trap do |name|
-      # @note can't log from a trap context: since Ruby 2.0 traps don't allow mutexes as it could lead to a dead lock,
-      #   so `logger.info` here would return "log writing failed. can't be called from trap context"
-      shutdown(name)
-    end
-  end
-
   private
 
+  attr_writer :signal
+
   # Determine how to create logger. Config can specify log file.
   def set_logger
     logger = CarrotRpc::ServerRunner::Logger.configured
@@ -154,4 +139,17 @@ class CarrotRpc::ServerRunner
 
     logger
   end
+
+  def wait_for_shutdown
+    loop do
+      # Wait for quit message
+      read_ready, _write_ready, _error_ready = IO.select([shutdown_reader])
+
+      next unless read_ready.include? shutdown_reader
+
+      shutdown_reader.read_nonblock(1)
+      # When runtime gets here, quit signal is received.
+      stop_servers
+    end
+  end
 end

data/lib/carrot_rpc/version.rb

@@ -1,3 +1,3 @@
 module CarrotRpc
-  VERSION = "0.6.0".freeze
+  VERSION = "0.7.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrot_rpc
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Scott Hamilton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-17 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,6 +170,7 @@ files:
 - lib/carrot_rpc/server_runner/autoload_rails.rb
 - lib/carrot_rpc/server_runner/logger.rb
 - lib/carrot_rpc/server_runner/pid.rb
+- lib/carrot_rpc/server_runner/signal.rb
 - lib/carrot_rpc/server_runner/signals.rb
 - lib/carrot_rpc/tagged_log.rb
 - lib/carrot_rpc/version.rb