uninterruptible 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ffdc9d6870a2bf9ae5573fbf9cc5b0e8a4d3f86
+  data.tar.gz: 81019ac427f4af4e182c8cf367ce9c807cef97a6
+SHA512:
+  metadata.gz: 163f49c6706ade360df9626e817c92af5e0c6276d6867a2dab5a6b5ab4582e5ff7e25209316a778add47b8bf45629e0abae3c02f170c47c6b98db2e5a7f55370
+  data.tar.gz: 7dd7aa37124bde1196b48f6884d62b1db6214c695ac1f8e4b7c1ff1832d0f015c03829c6b502705857be79b29f8f156bdf4d4b05c1f280fdd1c6513765839097

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uninterruptible.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dan Wentworth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# Uninterruptible
+
+Uninterruptible gives you zero downtime restarts for your TCP servers with nearly zero effort. Sounds good? Read on...
+
+Small socket servers are great, sometimes you need a quick and efficient way of moving data between servers (or even
+processes on the same machine). Restarting these processes can be a bit hairy though, you either need to build your
+clients smart enough to keep trying to connect, potentially backing up traffic or you just leave your server and
+hope for the best.
+
+You _know_ that you'll need to restart it one day and cross your fingers that you can kill the old one and start the
+new one before anyone notices. Not ideal at all.
+
+![Just a quick switch](http://i.imgur.com/aFyJJM6.jpg)
+
+Uninterruptible gives your socket server magic restarting powers. Send your running Uninterruptible server USR1 and
+it will start a brand new copy of itself which will immediately start handling new requests while the old server stays
+alive until all of it's active connections are complete.
+
+## Basic Usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uninterruptible'
+```
+
+To build your server all you need to do is include `Uninterruptible::Server` and implement `handle_request`. Let's build
+a simple echo server:
+
+```ruby
+# echo_server.rb
+class EchoServer
+  include Uninterruptible::Server
+
+  def handle_request(client_socket)
+    received_data = client_socket.gets
+    client_socket.puts(received_data)
+  end
+end
+```
+
+To turn this into a running server you only need to configure a port to listen on and the command used to start the
+server and call `run`:
+
+```ruby
+echo_server = EchoServer.new
+echo_server.configure do |config|
+  config.bind_port = 6789
+  config.start_command = 'ruby echo_server.rb'
+end
+echo_server.run
+```
+
+To restart the server just send `USR1`, a new server will start listening on your port, the old one will quit once it's
+finished processing all of it's existing connections. To kill the server (allowing for all connections to finish) call
+`TERM`.
+
+## Configuration Options
+
+```ruby
+echo_server.configure do |config|
+  config.start_command = 'ruby echo_server.rb' # *Required* Command to execute to start a new server process
+  config.bind_port = 6789 # *Required* Port to listen on, falls back to ENV['PORT']
+  config.bind_address = '::' # Address to listen on
+  config.pidfile_path = 'tmp/pids/echoserver.pid' # Location to write a pidfile, falls back to ENV['PID_FILE']
+  config.log_path = 'log/echoserver.log' # Location to write logfile, defaults to STDOUT
+  config.log_level = Logger::INFO # Log writing severity, defaults to Logger::INFO
+end
+```
+
+## The Magic
+
+Upon receiving `USR1`, your server will spawn a new copy of itself and pass the file descriptor of the open socket to
+the new server. The new server attaches itself to the file descriptor then sends a `TERM` signal to the original
+process. The original server stops listening on the socket and shuts itself down once all ongoing requests have
+completed.
+
+![Restart Flow](http://i.imgur.com/k8uNP55.png)
+
+## Concurrency
+
+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
+`process_request` tracks the number of active connections to the 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
+      Thread.new { worker_loop }
+    end
+
+    threads.each(&:join)
+  end
+
+  def worker_loop
+    loop do
+      client_socket = tcp_server.accept
+      process_request(client_socket)
+    end
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/darkphnx/uninterruptible.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "uninterruptible"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/uninterruptible/configuration.rb

@@ -0,0 +1,47 @@
+module Uninterruptible
+  # Configuration parameters for an individual instance of a server.
+  #
+  # See {Server#configure} for usage instructions.
+  class Configuration
+    attr_writer :bind_port, :bind_address, :pidfile_path, :start_command, :log_path, :log_level
+
+    # Available TCP Port for the server to bind to (required). Falls back to environment variable PORT if set.
+    #
+    # @return [Integer] Port number to bind to
+    def bind_port
+      port = (@bind_port || ENV["PORT"])
+      raise ConfigurationError, "You must configure a bind_port" if port.nil?
+      port.to_i
+    end
+
+    # Address to bind the server to (defaults to +::+).
+    def bind_address
+      @bind_address || "::"
+    end
+
+    # Location to write the pid of the current server to. If blank pidfile will not be written. Falls back to
+    # environment variable PID_FILE if set.
+    def pidfile_path
+      @pidfile_path || ENV["PID_FILE"]
+    end
+
+    # Command that should be used to reexecute the server (required). Note: +bundle exec+ will be automatically added.
+    #
+    # @example
+    #   rake app:run_server
+    def start_command
+      raise ConfigurationError, "You must configure a start_command" unless @start_command
+      @start_command
+    end
+
+    # Where should log output be written to? (defaults to STDOUT)
+    def log_path
+      @log_path || STDOUT
+    end
+
+    # Severity of entries written to the log, should be one of Logger::Severity (default Logger::INFO)
+    def log_level
+      @log_level || Logger::INFO
+    end
+  end
+end

data/lib/uninterruptible/server.rb

@@ -0,0 +1,181 @@
+require 'socket'
+require 'logger'
+
+module Uninterruptible
+  # The meat and potatoes of uninterruptible, include this in your server, configure it and override #handle_request.
+  #
+  # Calling #run will listen on the configured port and start a blocking server. Send that server signal USR1 to
+  # begin a hot-restart and TERM to start a graceful shutdown. Send TERM again for an immediate shutdown.
+  #
+  # @example
+  #   class HelloServer
+  #     include Uninterruptible::Server
+  #
+  #     def handle_request(client_socket)
+  #       name = client_socket.read
+  #       client_socket.write("Hello #{name}!")
+  #     end
+  #   end
+  #
+  # To then use this server, call #configure on it to set the port and restart command, then call #run to start.
+  #
+  # @example
+  #   hello_server = HelloServer.new
+  #   hello_server.configure do |config|
+  #     config.start_command = 'rake my_app:hello_server'
+  #     config.port = 7000
+  #   end
+  #   hello_server.run
+  #
+  module Server
+    def self.included(base)
+      base.class_eval do
+        attr_reader :active_connections, :tcp_server, :mutex
+      end
+    end
+
+    # Configure the server, see {Uninterruptible::Configuration} for full options.
+    #
+    # @yield [Uninterruptible::Configuration] the current configuration for this server instance
+    #
+    # @return [Uninterruptible::Configuration] the current configuration (after yield)
+    def configure
+      yield server_configuration if block_given?
+      server_configuration
+    end
+
+    # Starts the server, this is a blocking operation. Bind to the address and port specified in the configuration,
+    # write the pidfile (if configured) and start accepting new connections for processing.
+    def run
+      @active_connections = 0
+      @mutex = Mutex.new
+
+      logger.info "Starting server on #{server_configuration.bind_address}:#{server_configuration.bind_port}"
+
+      establish_tcp_server
+      write_pidfile
+      setup_signal_traps
+      accept_connections
+    end
+
+    # @abstract Override this method to process incoming requests. Each request is handled in it's own thread.
+    # Socket will be automatically closed after completion.
+    #
+    # @param [TCPSocket] client_socket Incoming socket from the client
+    def handle_request(client_socket)
+      raise NotImplementedError
+    end
+
+    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
+      loop do
+        Thread.start(tcp_server.accept) do |client_socket|
+          logger.debug "Accepted connection from #{client_socket.peeraddr.last}"
+          process_request(client_socket)
+        end
+      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.
+    #
+    # @param [TCPSocket] client_socket Incoming socket from the client connection
+    def process_request(client_socket)
+      mutex.synchronize { @active_connections += 1 }
+      begin
+        handle_request(client_socket)
+      ensure
+        client_socket.close
+        mutex.synchronize { @active_connections -= 1 }
+      end
+    end
+
+    # Listen (or reconnect) to the bind address and port specified in the config. If TCP_SERVER_FD is set in the env,
+    # reconnect to that file descriptor. Once @tcp_server is set, write the file descriptor ID to the env.
+    def establish_tcp_server
+      if ENV['TCP_SERVER_FD']
+        # If there's a file descriptor present, take over from a previous instance of this server and kill it off
+        logger.debug "Reconnecting to file descriptor..."
+        @tcp_server = TCPServer.for_fd(ENV['TCP_SERVER_FD'].to_i)
+        kill_parent
+      else
+        logger.debug "Opening new socket..."
+        @tcp_server = TCPServer.open(server_configuration.bind_address, server_configuration.bind_port)
+      end
+
+      @tcp_server.autoclose = false
+      @tcp_server.close_on_exec = false
+
+      ENV["TCP_SERVER_FD"] = @tcp_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
+    # by another instance of this server.
+    def kill_parent
+      logger.debug "Killing parent process #{Process.ppid}"
+      Process.kill('TERM', Process.ppid)
+    end
+
+    # Write the current pid out to pidfile_path if configured
+    def write_pidfile
+      return unless server_configuration.pidfile_path
+
+      logger.debug "Writing pid to #{server_configuration.pidfile_path}"
+      File.write(server_configuration.pidfile_path, Process.pid.to_s)
+    end
+
+    # Catch TERM and USR1 signals which control the lifecycle of the server.
+    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
+
+        $shutdown = true
+        graceful_shutdown
+      end
+
+      # On USR1 begin a hot restart
+      Signal.trap('USR1') do
+        hot_restart
+      end
+    end
+
+    # Stop listening on tcp_server, wait until all active connections have finished processing and exit with 0.
+    def graceful_shutdown
+      tcp_server.close unless tcp_server.closed?
+
+      until active_connections.zero?
+        sleep 0.5
+      end
+
+      Process.exit(0)
+    end
+
+    # Start a new copy of this server, maintaining all current file descriptors and env.
+    def hot_restart
+      fork do
+        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)
+      end
+    end
+
+    # The current configuration of this server
+    #
+    # @return [Uninterruptible::Configuration] Current or new configuration if unset.
+    def server_configuration
+      @server_configuration ||= Uninterruptible::Configuration.new
+    end
+
+    def logger
+      @logger ||= begin
+        log = Logger.new(server_configuration.log_path)
+        log.level = server_configuration.log_level
+        log
+      end
+    end
+  end
+end

data/lib/uninterruptible/version.rb

@@ -0,0 +1,3 @@
+module Uninterruptible
+  VERSION = "1.0.0"
+end

data/lib/uninterruptible.rb

@@ -0,0 +1,8 @@
+require "uninterruptible/version"
+require 'uninterruptible/configuration'
+require 'uninterruptible/server'
+
+# All of the interesting stuff is in Uninterruptible::Server
+module Uninterruptible
+  class ConfigurationError < StandardError; end
+end

data/uninterruptible.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uninterruptible/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "uninterruptible"
+  spec.version       = Uninterruptible::VERSION
+  spec.authors       = ["Dan Wentworth"]
+  spec.email         = ["dan@atechmedia.com"]
+
+  spec.summary       = "Zero-downtime restarts for your trivial TCP servers"
+  spec.description   = "Uninterruptible gives your socket server magic restarting powers. Send your running "\
+     "Uninterruptible server USR1 and it will start a brand new copy of itself which will immediately start handling "\
+     "new requests while the old server stays alive until all of it's active connections are complete."
+  spec.homepage      = "https://github.com/darkphnx/uninterruptible"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: uninterruptible
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dan Wentworth
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Uninterruptible gives your socket server magic restarting powers. Send
+  your running Uninterruptible server USR1 and it will start a brand new copy of itself
+  which will immediately start handling new requests while the old server stays alive
+  until all of it's active connections are complete.
+email:
+- dan@atechmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/uninterruptible.rb
+- lib/uninterruptible/configuration.rb
+- lib/uninterruptible/server.rb
+- lib/uninterruptible/version.rb
+- uninterruptible.gemspec
+homepage: https://github.com/darkphnx/uninterruptible
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Zero-downtime restarts for your trivial TCP servers
+test_files: []