unicorn-soft-timeout 0.0.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e8e7534c2f58736c14c45d873c8b789f758946f
+  data.tar.gz: 65be8d82059bca947dbfd2129fe077b5c33903ad
+SHA512:
+  metadata.gz: 446843280c827b22e27f8a71c4f885f145c5d8afa4180009a74d8720471315270d861095681fcafc2738be416b68d9b9ee06057f601e7fea54591167c2518df6
+  data.tar.gz: 3f87ef723bb1c9664352596ef13adfabaddca50821b7dd19ff07d202526387a8d28595918ac2033118486a7b2d4e50571ddefe8644aad89a1300cb774eae11e2

data/.gitignore

@@ -1,6 +1,7 @@
 *.swp
 *.gem
 *.rbc
+*.log
 .bundle
 .config
 .yardoc

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+cache: bundler
+before_install:
+  - gem install bundler
+rvm:
+  - 2.3
+  - 2.4
+  - ruby-head
+  - jruby-23mode
+  - jruby-head
+  - rubinius-3
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-23mode
+    - rvm: rubinius-3
+  fast_finish: true

data/README.md

@@ -1,11 +1,15 @@
-# Unicorn::SoftTimeout
+# unicorn-soft-timeout
 
-This gem adds support for soft timeout in Unicorn. By default
-requests which are taking longer than configured **timeout** are
+This gem adds support for **soft timeout** in [Unicorn](http://unicorn.bogomips.org/)
+configurations, by default requests which are taking longer than configured `timeout` are
 [SIGKILL-ed](http://unicorn.bogomips.org/Unicorn/Configurator.html#method-i-timeout).
-In some cases we need to intercept those requests to display a
-custom content instead of the error page.
 
+In some cases we need to intercept requests which will reach `timeout` to display a
+custom content instead of the error page. This extension will raise `Timeout::Error`
+when reaching the soft timeout and will restart the worker sending a `SIGQUIT`
+signal to it.
+
+  - [![Build Status](https://travis-ci.org/vitalie/unicorn-soft-timeout.svg?branch=master)](https://travis-ci.org/vitalie/unicorn-soft-timeout)
 
 ## Installation
 
@@ -30,10 +34,13 @@ Edit your config.ru file and load the Unicorn::SoftTimeout middleware:
 
     # Specify your soft timeout (default 12 seconds), it should
     # be a lower value than **timeout** specified in your unicorn config.
-    # This extension will raise Timeout::Error when reaching
-    # the **soft timeout**.
     use Unicorn::SoftTimeout, 10
 
+## Credits
+
+* [Kazuki Ohta](https://github.com/kzk)
+* [Pierre Baillet](https://github.com/octplane)
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,17 @@
+# encoding: UTF-8
 require "bundler/gem_tasks"
+require "rake/testtask"
+require "rdoc/task"
+
+desc "Default: run tests."
+task default: :test
+
+
+desc "Run unit tests."
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = Dir[ "test/*_test.rb" ]
+  t.verbose = true
+end
+

data/lib/unicorn/soft_timeout.rb

@@ -1,4 +1,4 @@
-require "unicorn/soft_timeout/version"
+require 'unicorn/soft_timeout/version'
 
 module Unicorn
   module SoftTimeout
@@ -18,7 +18,7 @@ module Unicorn
         sleep(@_soft_timeout)
         logger.warn "#{self}: worker (pid: #{worker_pid}) exceeds soft timeout (limit: #{@_soft_timeout})"
         Process.kill :QUIT, worker_pid # graceful shutdown
-        current_thread.raise Timeout::Error.new("Soft timeout exceeded")
+        current_thread.raise Timeout::Error.new('Soft timeout exceeded')
       end
 
       super(client) # Unicorn::HttpServer#process_client
@@ -26,4 +26,3 @@ module Unicorn
     end
   end
 end
-

data/lib/unicorn/soft_timeout/version.rb

@@ -1,5 +1,5 @@
 module Unicorn
   module SoftTimeout
-    VERSION = "0.0.1"
+    VERSION = '0.2.0'
   end
 end

data/test/test_helper.rb

@@ -0,0 +1,65 @@
+require 'unicorn'
+require 'unicorn/soft_timeout'
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'net/http'
+
+STDIN.sync = STDOUT.sync = STDERR.sync = true
+
+DEFAULT_TRIES = 100
+DEFAULT_RES = 0.2
+
+def redirect_test_io
+  orig_err = STDERR.dup
+  orig_out = STDOUT.dup
+  STDERR.reopen("test_stderr.#{$$}.log", "a")
+  STDOUT.reopen("test_stdout.#{$$}.log", "a")
+  STDERR.sync = STDOUT.sync = true
+
+  at_exit do
+    File.unlink("test_stderr.#{$$}.log") rescue nil
+    File.unlink("test_stdout.#{$$}.log") rescue nil
+  end
+
+  begin
+    yield
+  ensure
+    STDERR.reopen(orig_err)
+    STDOUT.reopen(orig_out)
+  end
+end
+
+def wait_workers_ready(path, nr_workers)
+  tries = DEFAULT_TRIES
+  lines = []
+  while (tries -= 1) > 0
+    begin
+      lines = File.readlines(path).grep(/worker=\d+ ready/)
+      lines.size == nr_workers and return
+    rescue Errno::ENOENT
+    end
+    sleep DEFAULT_RES
+  end
+  raise "#{nr_workers} workers never became ready:" \
+        "\n\t#{lines.join("\n\t")}\n"
+end
+
+def hit(uris)
+  results = []
+  uris.each do |u|
+    res = nil
+
+    if u.kind_of? String
+      u = 'http://127.0.0.1:8080/' if u == 'http://0.0.0.0:8080/'
+      res = Net::HTTP.get(URI.parse(u))
+    else
+      url = URI.parse(u[0])
+      res = Net::HTTP.new(url.host, url.port).start {|h| h.request(u[1]) }
+    end
+
+    assert res != nil, "Didn't get a response: #{u}"
+    results << res
+  end
+
+  return results
+end

data/test/unicorn_soft_timeout_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+include Unicorn
+
+class TestHandler
+  def call(env)
+    while env['rack.input'].read(4096)
+    end
+    sleep 5
+    [200, { 'Content-Type' => 'text/plain' }, ['hello!\n']]
+  rescue Timeout::Error
+    [200, { 'Content-Type' => 'text/plain' }, ['timeout!\n']]
+  rescue Unicorn::ClientShutdown, Unicorn::HttpParserError => e
+    $stderr.syswrite("#{e.class}: #{e.message} #{e.backtrace.empty?}\n")
+    raise e
+  end
+end
+
+class UnicornSoftTimeoutTest < Minitest::Test
+  def setup
+    @port = 5000
+    @tester = TestHandler.new
+    redirect_test_io do
+      @server = Unicorn::HttpServer.new(@tester, listeners: ["127.0.0.1:#{@port}"])
+      @tester = Unicorn::SoftTimeout.new(@tester, 3)
+      @server.start
+    end
+  end
+
+  def teardown
+    redirect_test_io do
+      wait_workers_ready("test_stderr.#$$.log", 1)
+      File.truncate("test_stderr.#$$.log", 0)
+      @server.stop(false)
+    end
+  end
+
+  def test_simple_server
+    results = hit(["http://localhost:#{@port}/test"])
+    assert_equal 'timeout!\n', results[0], "Handler didn't really run"
+  end
+end

data/unicorn-soft-timeout.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "unicorn", "~> 4"
+  spec.add_dependency "unicorn", "~> 5"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "minitest"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "bump"
 end

metadata

@@ -1,62 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: unicorn-soft-timeout
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Vitalie Cherpec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-12 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicorn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Graceful handling of requests which are reaching the timeout limit to
@@ -67,37 +74,41 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/unicorn/soft_timeout.rb
 - lib/unicorn/soft_timeout/version.rb
+- test/test_helper.rb
+- test/unicorn_soft_timeout_test.rb
 - unicorn-soft-timeout.gemspec
 homepage: https://github.com/vitalie/unicorn-soft-timeout
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Unicorn soft timeout
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/unicorn_soft_timeout_test.rb