uninterruptible 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 946193e9e88ddc165ab4f49e026e9666c6ccb517
-  data.tar.gz: e8caf941d6da770c6b0f5ffcda039ac111de879e
+  metadata.gz: 7f8d400309d6f9bf1354f04b9002aad29d077d2e
+  data.tar.gz: 3cb256b49089b46fdf7820594a6919c71e9d4d9f
 SHA512:
-  metadata.gz: 3515b11f919831fb45515313d9a46435ce810e84d97f9430dbee0206a32bb326b666f3c62421dc83a2560fc5feee4824c9b1598830a63875541b7559004cff8d
-  data.tar.gz: 8a90dba066c52a6840e7efb0a20106e8656b1526f84dc0273830742b733f35500d20eb04cc9be4d33a45a50b9555ca1b84001e83ad15c7857c101a5004a3b6e7
+  metadata.gz: 4649cdbf7b3eff9fff3709f343513cf36a21814e03c1092c0d09d4a6ff4905bfdfb32ae61866a41caf513867623689429c44dfe5a8df57e824c2173699c52c63
+  data.tar.gz: d05d7c375ab9bd546691516abbbc7205a4221cfa60ffa8ddd3ea072fa9028fb12e51dc1951f83053605e7dd37ef9793dbf9c06e29631d7d00425128495ff82bb

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+# 2.0.0
+* Use an internal pipe for delivering signals to the main thread.
+* `accept_connections` retired in favour of a select loop and `accept_client_connection` being called for each waiting connection
+* Logging when shutting down or restarting

data/README.md

@@ -90,18 +90,20 @@ completed.
 By default, Uninterruptible operates on a very simple one thread per connection concurrency model. If you'd like to use
 something more advanced such as a threadpool or an event driven pattern you can define this in your server class.
 
-By overriding `accept_connections` you can change how connections are accepted and handled. It is recommended that you
-call `process_request` from this method and still implement `handle_request` to do the bulk of the work since
+By overriding `accept_client_connection` you can change how connections are accepted and handled. It is recommended
+that you call `process_request` from this method and still implement `handle_request` to do the bulk of the work since
 `process_request` tracks the number of active connections to the server.
 
+`accept_client_connection` is called whenever a connection is waiting to be accepted on the socket server.
+
 If you wanted to implement a threadpool to process your requests you could do the following:
 
 ```ruby
 class EchoServer
   # ...
 
-  def accept_connections
-    threads = 4.times.map do
+  def accept_client_connection
+    @worker_threads ||= 4.times.map do
       Thread.new { worker_loop }
     end
 

data/lib/uninterruptible/server.rb

@@ -30,7 +30,7 @@ module Uninterruptible
   module Server
     def self.included(base)
       base.class_eval do
-        attr_reader :active_connections, :socket_server, :mutex
+        attr_reader :active_connections, :socket_server, :signal_pipe_r, :signal_pipe_w, :mutex
       end
     end
 
@@ -55,7 +55,7 @@ module Uninterruptible
       establish_socket_server
       write_pidfile
       setup_signal_traps
-      accept_connections
+      select_loop
     end
 
     # @abstract Override this method to process incoming requests. Each request is handled in it's own thread.
@@ -68,17 +68,32 @@ module Uninterruptible
 
     private
 
-    # Start a blocking loop which accepts new connections and hands them off to #process_request. Override this to
-    # use a different concurrency pattern, a thread per connection is the default.
-    def accept_connections
+    # Start a blocking loop which awaits new connections before calling #accept_client_connection. Also monitors
+    # signal_pipe_r for processing any signals sent to the process.
+    def select_loop
       loop do
-        Thread.start(socket_server.accept) do |client_socket|
-          logger.debug "Accepted connection from #{client_socket.peeraddr.last}"
-          process_request(client_socket)
+        readable, = IO.select([socket_server, signal_pipe_r])
+        readable.each do |reader|
+          if reader == socket_server
+            accept_client_connection
+          elsif reader == signal_pipe_r
+            signal = reader.gets.chomp
+            process_signal(signal)
+          end
         end
       end
     end
 
+    # Accept a waiting connection. Should only be called when it is known a connection is waiting, from an IO.select
+    # loop for example. By default this creates one thread per connection. Override this method to provide a new
+    # concurrency model.
+    def accept_client_connection
+      Thread.start(socket_server.accept_nonblock) do |client_socket|
+        logger.debug "Accepted connection from #{client_socket.peeraddr.last}"
+        process_request(client_socket)
+      end
+    end
+
     # Keeps a track of the number of active connections and passes the client connection to #handle_request for the
     # user to do with as they wish. Automatically closes a connection once #handle_request has completed.
     #
@@ -121,18 +136,35 @@ module Uninterruptible
       File.write(server_configuration.pidfile_path, Process.pid.to_s)
     end
 
-    # Catch TERM and USR1 signals which control the lifecycle of the server.
+    # Catch TERM and USR1 signals which control the lifecycle of the server. These get written to an internal pipe
+    # which will be picked up by the main accept_connection loop and passed to #process_signal
     def setup_signal_traps
-      # On TERM begin a graceful shutdown, if a second TERM is received shutdown immediately with an exit code of 1
-      Signal.trap('TERM') do
-        Process.exit(1) if $shutdown
+      @signal_pipe_r, @signal_pipe_w = IO.pipe
 
-        $shutdown = true
-        graceful_shutdown
+      %w(TERM USR1).each do |signal_name|
+        trap(signal_name) do
+          @signal_pipe_w.puts(signal_name)
+        end
       end
+    end
 
-      # On USR1 begin a hot restart
-      Signal.trap('USR1') do
+    # When a signal has been caught, it should be passed here for the appropriate action to be taken
+    # On TERM begin a graceful shutdown, if a second TERM is received shutdown immediately with an exit code of 1
+    # On USR1 begin a hot restart which will bring up a new copy of the server and then shut down the old one
+    #
+    # @param [String] signal_name Signal to process
+    def process_signal(signal_name)
+      if signal_name == 'TERM'
+        if $shutdown
+          logger.info "TERM received again, exiting immediately"
+          Process.exit(1) if $shutdown
+        else
+          logger.info "TERM received, starting graceful shutdown"
+          $shutdown = true
+          graceful_shutdown
+        end
+      elsif signal_name == 'USR1'
+        logger.info "USR1 received, hot restart in progress"
         hot_restart
       end
     end
@@ -142,9 +174,12 @@ module Uninterruptible
       socket_server.close unless socket_server.closed?
 
       until active_connections.zero?
+        logger.debug "#{active_connections} connections still active"
         sleep 0.5
       end
 
+      logger.debug "No more active connections. Exiting'"
+
       Process.exit(0)
     end
 

data/lib/uninterruptible/version.rb

@@ -1,3 +1,3 @@
 module Uninterruptible
-  VERSION = "1.1.1"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uninterruptible
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Dan Wentworth
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,6 +65,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md