server-starter 0.2.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 172f969ecca0954a1b3f5a44df94ad9e391893cf
-  data.tar.gz: 414f7dc2679b28e65d4d8ebc289032540476d83f
+SHA256:
+  metadata.gz: 5ee6c5c725642797b8cfe87cc099dd5182f2059b901b3ac494b41f80116dd297
+  data.tar.gz: 5bcdb4c9c064b5af13983c6fe174b2612f22d5bed975d412db19fe8ab6025e6a
 SHA512:
-  metadata.gz: f5e0704849bf69e29e582cea3681bdf3f5578ead49cea74f87cb919ecbafafe975dd537f6e60dfdb42378dc124f98a14c0d8eb46bf76b32793d7b4628621dae8
-  data.tar.gz: d2f77e9459789f62758b8f0a24bd090a295646e5e4b3d681e9cec992824234a661cf7f10737b8cad5810c7d1cf99de5ab3ee4dcaed56b09354912d91b59c3d82
+  metadata.gz: c875da7e9d71f1bb0cb8f25601248f046355690865ad5ce8336b34499602c5e330c50486b96f8b1f17d94be3008f8fc2903e6dfb7e4207ed8e2059a12e045600
+  data.tar.gz: 2d98c0cdb9aa6959e8a871032877f0ec3a41a525543c4fee416de38b687883a98789adbb6c7eed85843e4509ac77b7d7e6e459c70df20ebc66807dac123dc110

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.3.2 (2022/05/09)
+
+Enhancements:
+
+* Support puma5 (thanks to limitusus)
+
+## 0.3.1 (2016/08/26)
+
+Enhancements:
+
+* Support [resque_starter](https://github.com/sonots/resque_starter)
+
+## 0.3.0 (2016/04/03)
+
+Fixes:
+
+* Fix a critial bug. It was not killing old workers on HUP :scream:
+
 ## 0.2.1 (2016/04/03)
 
 Fixes:

data/README.md

@@ -24,8 +24,13 @@ Following is an example to run unicorn server under ```Server::Starter```.
 The command line example:
 
 ```
-bundle exec start_server.rb --port=10080 --signal-on-hup=CONT --dir=/path/to/app \
-  --status-file=/path/to/app/log/start_server.stat --pid-file=/path/to/app/log/start_server.pid -- \
+bundle exec start_server.rb \
+  --port=10080 \
+  --signal-on-hup=CONT \
+  --dir=/path/to/app \
+  --status-file=/path/to/app/log/start_server.stat \
+  --pid-file=/path/to/app/log/start_server.pid \
+  -- \
   bundle exec --keep-file-descriptors unicorn -c config/unicorn.conf.rb config.ru
 ```
 
@@ -71,6 +76,121 @@ after_fork do |server, worker|
 end
 ```
 
+# Puma
+
+Following is an example to run puma server under ```Server::Starter```.
+
+The command line example:
+
+```
+bundle exec start_server.rb \
+  --port=0.0.0.0:10080 \
+  --dir=/path/to/app \
+  --interval=1 \
+  --signal-on-hup=TERM \
+  --signal-on-TERM=TERM \
+  --pid-file=/path/to/app/log/start_server.pid \
+  --status-file=/path/to/app/log/start_server.stat \
+  --envdir=env \
+  --enable-auto-restart \
+  --auto-restart-interval=100 \
+  --kill-old-delay=10 \
+  --backlog=100 \
+  -- \
+  bundle exec --keep-file-descriptors start_puma.rb puma -C config/puma.rb config.ru
+```
+
+An example of config/puma.rb:
+
+```ruby
+
+require 'server/starter/puma_listener'
+listener = ::Server::Starter::PumaListener
+
+APP_ROOT = File.expand_path('../..', __FILE__)
+status_file = File.join(APP_ROOT, 'log/start_server.stat')
+
+pidfile File.join(APP_ROOT, 'log/puma.pid')
+state_path File.join(APP_ROOT, 'log/puma.state')
+
+# prune_bundler # need to tweak lib/puma/launher to add { close_others: false } opts to Kernel.exec
+preload_app!
+
+# Configure "min" to be the minimum number of threads to use to answer
+# requests and "max" the maximum.
+# The default is "0, 16".
+threads 0, 16
+
+# How many worker processes to run. The default is "0".
+workers 2
+
+# Run puma via start_puma.rb to configure PUMA_INHERIT_\d ENV from SERVER_STARTER_PORT ENV as
+# $ bundle exec --keep-file-descriptors start_puma.rb puma -C config/puma.conf.rb config.ru
+if ENV['SERVER_STARTER_PORT']
+  puma_inherits = listener.listen
+  puma_inherits.each do |puma_inherit|
+    bind puma_inherit[:url]
+  end
+else
+  puts '[WARN] Fallback to 0.0.0.0:10080 since not running under Server::Starter'
+  bind 'tcp://0.0.0.0:10080'
+end
+
+# Code to run before doing a restart. This code should
+# close log files, database connections, etc.
+# This can be called multiple times to add code each time.
+on_restart do
+  puts 'On restart...'
+end
+
+# Code to run when a worker boots to setup the process before booting
+# the app. This can be called multiple times to add hooks.
+on_worker_boot do
+  defined?(ActiveRecord::Base) and ActiveRecord::Base.connection.disconnect!
+end
+
+# Code to run when a worker boots to setup the process after booting
+# the app. This can be called multiple times to add hooks.
+after_worker_boot do
+  defined?(ActiveRecord::Base) and ActiveRecord::Base.establish_connection
+end
+
+# Code to run when a worker shutdown.
+on_worker_shutdown do
+  puts 'On worker shutdown...'
+end
+```
+
+## Options
+
+To be written
+
+### --envdir [dir]
+
+Configure environment variables from files on given directory, and reload on restarting.
+
+The directory structure is inspired from [envdir](https://cr.yp.to/daemontools/envdir.html) of daemontools.
+The filename is the environment variable name, and its content (first line) is the value of the environment variable.
+
+Example)
+
+```
+$ find env
+env/RAILS_ENV
+env/LANG
+```
+
+```
+$ cat env/RAILS_ENV
+production
+$ cat env/LANG
+en_US.UTF-8
+```
+
+which are equivalent with `env RAILS_ENV=production LANG=en_US.UTF-8` in shell.
+
+Please note that environment variables are updated on restarting, which means deleted files are not affected.
+
 ## See Also
 
 * [「Server::Starterに対応するとはどういうことか」の補足](http://blog.livedoor.jp/sonots/archives/40248661.html) (Japanese)

data/example/resque/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'server-starter', path: '../../'
+gem 'resque_starter', git: 'https://github.com/sonots/resque_starter'
+gem 'pry'
+gem 'pry-nav'

data/example/resque/config/resque.conf.rb

@@ -0,0 +1,34 @@
+require 'server/starter/resque_listener'
+listener = Server::Starter::ResqueListener
+APP_ROOT = File.expand_path('../..', __FILE__)
+
+concurrency 2
+queues ['test']
+pid_file File.join(APP_ROOT, 'log/start_resque.pid')
+status_file File.join(APP_ROOT, 'log/start_resque.stat')
+
+# preload rails app
+# require File.join(APP_ROOT, 'config/environment')
+# Rails.application.eager_load!
+
+start_server_status_file = File.join(APP_ROOT, 'log/start_server.stat')
+
+before_fork do |starter, worker, worker_nr|
+  defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.connection.disconnect!
+
+  sleep 1
+end
+
+after_fork do |starter, worker, worker_nr|
+  defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.establish_connection
+
+  # Graceful restart
+  #
+  # This allows a new master process to incrementally
+  # phase out the old master process with SIGTTOU.
+  # The last worker spawned # will then kill off the old master
+  # process with a SIGQUIT.
+  listener.graceful_restart(starter, worker, worker_nr, start_server_status_file)
+end

data/example/resque/env/TEST

@@ -0,0 +1 @@
+foo

data/example/resque/my_job.rb

@@ -0,0 +1,7 @@
+class MyJob
+  @queue = :test
+
+  def self.perform(params)
+    puts params
+  end
+end

data/example/resque/restart_server

@@ -0,0 +1,7 @@
+#!/bin/sh
+# sends SIGHUP
+bundle exec start_server.rb \
+  --restart \
+  --dir=$(pwd) \
+  --pid-file=$(pwd)/log/start_server.pid \
+  --status-file=$(pwd)/log/start_server.stat

data/example/resque/start_server

@@ -0,0 +1,14 @@
+#!/bin/sh
+bundle exec start_server.rb \
+  --dir=$(pwd) \
+  --interval=1 \
+  --signal-on-hup=CONT \
+  --signal-on-TERM=TERM \
+  --pid-file=$(pwd)/log/start_server.pid \
+  --status-file=$(pwd)/log/start_server.stat \
+  --envdir=env \
+  --enable-auto-restart \
+  --auto-restart-interval=100 \
+  --kill-old-delay=1 \
+  -- \
+  bundle exec --keep-file-descriptors start_resque.rb -c config/resque.conf.rb 2>&1

data/example/unicorn/config/{unicorn.conf → unicorn.conf.rb}

@@ -14,7 +14,8 @@ unless fd
 end
  
 before_fork do |server, worker|
-  defined?(ActiveRecord::Base) and ActiveRecord::Base.connection.disconnect!
+  defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.connection.disconnect!
  
   # Throttle the master from forking too quickly by sleeping.  Due
   # to the implementation of standard Unix signal handlers, this
@@ -24,7 +25,8 @@ before_fork do |server, worker|
 end
  
 after_fork do |server, worker|
-  defined?(ActiveRecord::Base) and ActiveRecord::Base.establish_connection
+  defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.establish_connection
 
   # This is optional
   #

data/example/unicorn/start_server

@@ -13,4 +13,4 @@ bundle exec start_server.rb \
   --kill-old-delay=1 \
   --backlog=100 \
   -- \
-  bundle exec --keep-file-descriptors unicorn -c config/unicorn.conf config.ru 2>&1
+  bundle exec --keep-file-descriptors unicorn -c config/unicorn.conf.rb config.ru 2>&1

data/lib/server/starter/puma_listener.rb

@@ -1,4 +1,5 @@
 require 'server/starter/version'
+require 'puma/const'
 
 class Server::Starter
   class PumaListener
@@ -11,7 +12,12 @@ class Server::Starter
         else
           url = "unix://#{path_or_port}"
         end
-        ENV["PUMA_INHERIT_#{i}"] = "#{fd}:#{url}"
+        if Gem::Version.new(Puma::Const::PUMA_VERSION) < Gem::Version.new('5')
+          ENV["PUMA_INHERIT_#{i}"] = "#{fd}:#{url}"
+        else
+          ENV['LISTEN_FDS'] = '1'
+          ENV['LISTEN_PID'] = Process.pid.to_s
+        end
         { fd: fd, url: url }
       end
     end

data/lib/server/starter/resque_listener.rb

@@ -0,0 +1,25 @@
+require 'server/starter/version'
+
+class Server::Starter
+  class ResqueListener
+    # This allows a new master process to incrementally
+    # phase out the old master process with SIGTTOU.
+    # The last worker spawned will then kill off the old master
+    # process with a SIGQUIT.
+    #
+    # @param starter [ResqueStarter]
+    # @param worker [Resque::Worker]
+    # @param worker_nr [Integer] worker number
+    # @param status_file [String] path to Server::Starter status file (--status-file)
+    def self.graceful_restart(starter, worker, worker_nr, status_file)
+      pids = File.readlines(status_file).map {|_| _.chomp.split(':') }.to_h
+      old_gen = ENV['SERVER_STARTER_GENERATION'].to_i - 1
+      if old_pid = pids[old_gen.to_s]
+        sig = (worker_nr + 1) >= starter.num_workers ? :QUIT : :TTOU
+        Process.kill(sig, old_pid.to_i)
+      end
+    rescue Errno::ENOENT, Errno::ESRCH => e
+      $stderr.puts "#{e.class} #{e.message}"
+    end
+  end
+end

data/lib/server/starter/version.rb

@@ -1,5 +1,5 @@
 class Server
   class Starter
-    VERSION = '0.2.1'
+    VERSION = '0.3.2'
   end
 end

data/lib/server/starter.rb

@@ -313,7 +313,7 @@ class Server::Starter
             sleep kill_old_delay
           end
           $stderr.puts "killing old workers"
-          @old_workers.keys.sort {|pid| Process.kill(opts[:signal_on_hup], pid) }
+          @old_workers.keys.sort.each {|pid| Process.kill(opts[:signal_on_hup], pid) }
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: server-starter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-03 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -48,9 +48,16 @@ files:
 - example/puma/log/.gitkeep
 - example/puma/restart_server
 - example/puma/start_server
+- example/resque/Gemfile
+- example/resque/config/resque.conf.rb
+- example/resque/env/TEST
+- example/resque/log/.gitkeep
+- example/resque/my_job.rb
+- example/resque/restart_server
+- example/resque/start_server
 - example/unicorn/Gemfile
 - example/unicorn/config.ru
-- example/unicorn/config/unicorn.conf
+- example/unicorn/config/unicorn.conf.rb
 - example/unicorn/env/TEST
 - example/unicorn/log/.gitkeep
 - example/unicorn/restart_server
@@ -58,6 +65,7 @@ files:
 - lib/server/starter.rb
 - lib/server/starter/helper.rb
 - lib/server/starter/puma_listener.rb
+- lib/server/starter/resque_listener.rb
 - lib/server/starter/unicorn_listener.rb
 - lib/server/starter/version.rb
 - server-starter.gemspec
@@ -80,8 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: a superdaemon for hot-deploying server programs (ruby port of p5-Server-Starter)