uninterruptible 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 658c5837ae17777ac2f5d53223b61941444c26ca
-  data.tar.gz: db14a041c27690a14565f5938255856b1bfde528
+  metadata.gz: 6c0bee80d95f929271d75f691c59788a9716e8e3
+  data.tar.gz: 877066cf757d14caab769f7585713170f7db08e2
 SHA512:
-  metadata.gz: 5421a7627be91b402d0189ae4791dbcce3c5a2d259ffbcaaa3177a4e577d18d1b7a384a86d700dcdf8ae493e872516593f25b4f83daea6dc020a5ea24b847417
-  data.tar.gz: 214ded520ee70b7c87fbf8ed9efaf139803830db02d294189a56d9c9f0ecc76277159599ac950abb1338642e300d38bcf9c624327563364e7ff4c9106fa9dd7e
+  metadata.gz: 2f2f1edad24e0bad293acb8f70a3171388c98d73f266f025c570ed58fda332d47cf0f95c00cfd1f8b293b142b4d8882b496201daa5da30beada562363b8999df
+  data.tar.gz: 775f0729644939e948a87adb085105651a00500793d6db9b19b5965faf008f5bea4dbab21fb279bd030604f134c177530c65db64ea37530c4bf3f9f23ecfa543

data/CHANGELOG.md

@@ -1,22 +1,25 @@
 # Changelog
 
-# 2.3.0
+## 2.4.0
+* When restarting a server, the socket is passed to the new server via a UNIX socket instead of inheriting open file descriptors from the parent.
+
+## 2.3.0
 * Incoming connections can be restricted to certain networks by setting `allowed_networks` in the configuration.
 
-# 2.2.1
+## 2.2.1
 * Allow multiple certificates to be used in one build file
 
-# 2.2.0
+## 2.2.0
 * Verify client TLS certificates
 * Allow trusted client CA to be set
 
-# 2.1.1
+## 2.1.1
 * Prevent bad SSL handshakes from crashing server
 
-# 2.1.0
+## 2.1.0
 * Add TLS support for TCP connections
 
-# 2.0.0
+## 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/lib/uninterruptible/binder.rb

@@ -34,8 +34,8 @@ module Uninterruptible
     #
     # @return [TCPServer] Socket server for the configured address and port
     def bind_to_tcp_socket
-      if ENV[SERVER_FD_VAR]
-        TCPServer.for_fd(ENV[SERVER_FD_VAR].to_i)
+      if ENV[FILE_DESCRIPTOR_SERVER_VAR]
+        TCPServer.for_fd(read_file_descriptor_from_fds)
       else
         TCPServer.new(bind_uri.host, bind_uri.port)
       end
@@ -45,14 +45,16 @@ module Uninterruptible
     #
     # @return [UNIXServer] Socket server for the configured path
     def bind_to_unix_socket
-      if ENV[SERVER_FD_VAR]
-        UNIXServer.for_fd(ENV[SERVER_FD_VAR].to_i)
+      if ENV[FILE_DESCRIPTOR_SERVER_VAR]
+        UNIXServer.for_fd(read_file_descriptor_from_fds)
       else
         File.delete(bind_uri.path) if File.exist?(bind_uri.path)
         UNIXServer.new(bind_uri.path)
       end
     end
 
+    private
+
     # Parse the bind address in the configuration
     #
     # @param [String] bind_address The config for a server we're returning the socket for
@@ -65,5 +67,14 @@ module Uninterruptible
     rescue URI::Error
       raise Uninterruptible::ConfigurationError, "Couldn't parse the bind address: \"#{bind_address}\""
     end
+
+    # Open a connection to a running FileDesciptorServer on the parent of this server and obtain a file descriptor
+    # for the running socket server on there.
+    def read_file_descriptor_from_fds
+      fds_socket = UNIXSocket.new(ENV[FILE_DESCRIPTOR_SERVER_VAR])
+      socket_file_descriptor = fds_socket.recv_io
+      fds_socket.close
+      socket_file_descriptor.to_i
+    end
   end
 end

data/lib/uninterruptible/file_descriptor_server.rb

@@ -0,0 +1,51 @@
+require 'tmpdir'
+require 'socket'
+
+module Uninterruptible
+  class FileDescriptorServer
+    attr_reader :io_object, :socket_server
+
+    # Creates a new FileDescriptorServer and starts a listenting socket server
+    #
+    # @param [IO] Any IO object that will be shared by this server
+    def initialize(io_object)
+      @io_object = io_object
+
+      start_socket_server
+    end
+
+    # @return [String] Location on disk where socket server is listening
+    def socket_path
+      @socket_path ||= File.join(socket_directory, 'file_descriptor_server.sock')
+    end
+
+    # Accept the next client connection and send it the file descriptor
+    #
+    # @raise [RuntimeError] Raises a runtime error if the socket server is closed
+    def serve_file_descriptor
+      raise "File descriptor server has been closed" if socket_server.closed?
+
+      client = socket_server.accept
+      client.send_io(io_object)
+      client.close
+    end
+
+    # Close the socket server and tidy up any created files
+    def close
+      socket_server.close
+
+      File.delete(socket_path)
+      Dir.rmdir(socket_directory)
+    end
+
+    private
+
+    def socket_directory
+      @socket_directory ||= Dir.mktmpdir('uninterruptible-')
+    end
+
+    def start_socket_server
+      @socket_server = UNIXServer.new(socket_path)
+    end
+  end
+end

data/lib/uninterruptible/server.rb

@@ -113,12 +113,12 @@ module Uninterruptible
       end
     end
 
-    # Listen (or reconnect) to the bind address and port specified in the config. If SERVER_FD_VAR is set in the env,
-    # reconnect to that file descriptor. Once @socket_server is set, write the file descriptor ID to the env.
+    # Listen (or reconnect) to the bind address and port specified in the config. If FILE_DESCRIPTOR_SERVER_PATH is set
+    # in the env, reconnect to that file descriptor.
     def establish_socket_server
       @socket_server = Uninterruptible::Binder.new(server_configuration.bind).bind_to_socket
       # If there's a file descriptor present, take over from a previous instance of this server and kill it off
-      kill_parent if ENV[SERVER_FD_VAR]
+      kill_parent if ENV[FILE_DESCRIPTOR_SERVER_VAR]
 
       @socket_server.autoclose = false
       @socket_server.close_on_exec = false
@@ -126,8 +126,6 @@ module Uninterruptible
       if server_configuration.tls_enabled?
         @socket_server = Uninterruptible::TLSServerFactory.new(server_configuration).wrap_with_tls(@socket_server)
       end
-
-      ENV[SERVER_FD_VAR] = @socket_server.to_i.to_s
     end
 
     # Send a TERM signal to the parent process. This will be called by a newly spawned server if it has been started
@@ -194,11 +192,22 @@ module Uninterruptible
 
     # Start a new copy of this server, maintaining all current file descriptors and env.
     def hot_restart
+      # Start a FileDescriptorServer running on a unix socket
+      file_descriptor_server = FileDescriptorServer.new(socket_server)
+
       fork do
+        # Let the new server know where to find the file descriptor server
+        ENV[FILE_DESCRIPTOR_SERVER_VAR] = file_descriptor_server.socket_path
+
         Dir.chdir(ENV['APP_ROOT']) if ENV['APP_ROOT']
         ENV.delete('BUNDLE_GEMFILE') # Ensure a fresh bundle is used
-        exec("bundle exec --keep-file-descriptors #{server_configuration.start_command}", :close_others => false)
+
+        exec("bundle exec #{server_configuration.start_command}")
       end
+
+      # Provide the new server with the file descriptor for @socket_server
+      file_descriptor_server.serve_file_descriptor
+      file_descriptor_server.close
     end
 
     def network_restrictions

data/lib/uninterruptible/version.rb

@@ -1,3 +1,3 @@
 module Uninterruptible
-  VERSION = "2.3.1".freeze
+  VERSION = "2.4.0".freeze
 end

data/lib/uninterruptible.rb

@@ -5,6 +5,7 @@ require "uninterruptible/version"
 require 'uninterruptible/ssl_extensions'
 require 'uninterruptible/configuration'
 require 'uninterruptible/binder'
+require 'uninterruptible/file_descriptor_server'
 require 'uninterruptible/network_restrictions'
 require 'uninterruptible/tls_server_factory'
 require 'uninterruptible/server'
@@ -13,5 +14,5 @@ require 'uninterruptible/server'
 module Uninterruptible
   class ConfigurationError < StandardError; end
 
-  SERVER_FD_VAR = 'UNINTERRUPTIBLE_SERVER_FD'.freeze
+  FILE_DESCRIPTOR_SERVER_VAR = 'FILE_DESCRIPTOR_SERVER_PATH'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uninterruptible
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Dan Wentworth
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-19 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ files:
 - lib/uninterruptible.rb
 - lib/uninterruptible/binder.rb
 - lib/uninterruptible/configuration.rb
+- lib/uninterruptible/file_descriptor_server.rb
 - lib/uninterruptible/network_restrictions.rb
 - lib/uninterruptible/server.rb
 - lib/uninterruptible/ssl_extensions.rb
@@ -101,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: Zero-downtime restarts for your trivial socket servers