slowpoke 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b602f89b54077d5e970bb549ce1ad3e57db8d1ab6f15bf62ea3dbae868d6ca5
-  data.tar.gz: 60cb3a0c463ebadeb4abec48794ffaa2b33b22af406c672ba2ac351f7134fbed
+  metadata.gz: 196837a764b30dcd76bd206904b4f019a3dc77149a9ab472c9aaa062f5e00584
+  data.tar.gz: 410bd79283dc9921762ca886d54978f2adac2496e2ad0c6e8a381157e5318dc2
 SHA512:
-  metadata.gz: 94352be6969f60055f4f6121f9b087fb5a4b2e144014b973fe6aa772cb7c4c9bd4cc5922a51dc3a41ce9a70bcd97f5f1bd0516ec764d002e410a0578cf1ffb25
-  data.tar.gz: bf7c814b78e54a679798107f013083a596fab63fab960734fa5d32ba689e35128b33da7430aa560f789c56d3982d6e58f226f960828e985828793db11549e404
+  metadata.gz: 46f0c622df519a853f40660bcdaa644e1e3586eeb8607ffd09420456a4b10d4a7b536154eb8b911d5131b9d8dca6afe0b6521f48191438176a7924cf6dec3b3d
+  data.tar.gz: 8ab0b75f01bd8f0662ba21ca4f130ff6926e2f5f5f11dedb296aec35ad2f06f957067d68c4defdf52774da5cdb756a2f590261b28193498ecb1128067ac34843

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.3.0
+
+- Use proper signal for Puma
+- Dropped support for rack-timeout < 0.4
+- Dropped support for migration timeouts
+- Dropped support for Rails < 5
+
 ## 0.2.1
 
 - Don’t kill server in test environment

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Andrew Kane
+Copyright (c) 2014-2019 Andrew Kane
 
 MIT License
 

data/README.md

@@ -1,10 +1,9 @@
 # Slowpoke
 
-[Rack::Timeout](https://github.com/heroku/rack-timeout) is great. Slowpoke makes it better with:
+[Rack::Timeout](https://github.com/heroku/rack-timeout) enhancements for Rails
 
 - custom error pages
 - [safer service timeouts](https://github.com/heroku/rack-timeout/issues/39)
-- wait timeouts that don’t kill your web server
 
 ## Installation
 
@@ -22,24 +21,29 @@ rails generate slowpoke:install
 
 This creates a `public/503.html` you can customize.
 
-## How to Use
+## Trying It in Development
 
-The default timeout is 15 seconds. Change this with:
+Temporarily add to `config/environments/development.rb`:
 
 ```ruby
-Slowpoke.timeout = 10
+config.slowpoke.timeout = 1
+config.consider_all_requests_local = false
 ```
 
-or set:
+And add a `sleep` call to one of your actions:
 
 ```ruby
-ENV["REQUEST_TIMEOUT"]
+sleep(2)
 ```
 
-Test by adding a `sleep` call to one of your actions:
+The custom error page should appear.
+
+## Configuring It for Production
+
+The default timeout is 15 seconds. You can change this in `config/environments/production.rb` with:
 
 ```ruby
-sleep(20)
+config.slowpoke.timeout = 5
 ```
 
 Subscribe to timeouts with:
@@ -50,41 +54,37 @@ ActiveSupport::Notifications.subscribe "timeout.slowpoke" do |name, start, finis
 end
 ```
 
-To learn more, see the [Rack::Timeout documentation](https://github.com/heroku/rack-timeout#the-rabbit-hole).
+To learn more, see the [Rack::Timeout documentation](https://github.com/heroku/rack-timeout).
+
+## Threaded Servers
+
+The only safe way to recover from a request timeout is to spawn a new process. For threaded servers like Puma, this means killing all threads when any one of them times out. This can have a significant impact on performance.
 
 ## Database Timeouts
 
-For PostgreSQL, set connect and statement timeouts in `config/database.yml`:
+It’s a good idea to set a [statement timeout](https://github.com/ankane/the-ultimate-guide-to-ruby-timeouts/#statement-timeouts-1) and a [connect timeout](https://github.com/ankane/the-ultimate-guide-to-ruby-timeouts/#activerecord).
 
-```yaml
-production:
-  connect_timeout: 1 # sec
-  variables:
-    statement_timeout: 250 # ms
-```
+## Upgrading
+
+### 0.3.0
 
-To use a different statement timeout for migrations, set:
+If you set the timeout with:
 
 ```ruby
-ENV["MIGRATION_STATEMENT_TIMEOUT"] = 60000 # ms
+Slowpoke.timeout = 5
 ```
 
-Test connect timeouts by setting your database host to an [unroutable IP](https://stackoverflow.com/questions/100841/artificially-create-a-connection-timeout-error).
+Remove it and add to `config/environments/production.rb`:
 
-```yaml
-development:
-  host: 10.255.255.1
+```ruby
+config.slowpoke.timeout = 5
 ```
 
-Test statement timeouts with the [pg_sleep](https://www.postgresql.org/docs/current/static/functions-datetime.html#FUNCTIONS-DATETIME-DELAY) function.
+If you use migration timeouts, check out [this guide](https://github.com/ankane/the-ultimate-guide-to-ruby-timeouts/#statement-timeouts-1) for how to configure them directly in `config/database.yml`.
 
-```sql
-SELECT pg_sleep(20);
-```
-
-## Upgrading
+### 0.1.0
 
-`0.1.0` removes database timeouts, since Rails supports them by default.  To restore the previous behavior, use:
+`0.1.0` removes database timeouts, since Rails supports them by default. To restore the previous behavior, use:
 
 ```yaml
 production:

data/lib/slowpoke.rb

@@ -1,26 +1,12 @@
 require "slowpoke/version"
 require "rack/timeout/base"
 require "slowpoke/middleware"
-require "slowpoke/migration"
 require "slowpoke/railtie"
 require "action_dispatch/middleware/exception_wrapper"
 require "action_controller/base"
 
 module Slowpoke
   ENV_KEY = "slowpoke.timed_out".freeze
-
-  def self.timeout
-    @timeout ||= (ENV["REQUEST_TIMEOUT"] || ENV["TIMEOUT"] || 15).to_i
-  end
-
-  def self.timeout=(timeout)
-    timeout = timeout.to_i if timeout.respond_to?(:to_i)
-    @timeout = Rack::Timeout.service_timeout = timeout
-  end
-
-  def self.migration_statement_timeout
-    ENV["MIGRATION_STATEMENT_TIMEOUT"]
-  end
 end
 
 # custom error page

data/lib/slowpoke/middleware.rb

@@ -14,6 +14,8 @@ module Slowpoke
         # can't do in timed_out state consistently
         if defined?(::PhusionPassenger)
           `passenger-config detach-process #{Process.pid}`
+        elsif defined?(::Puma)
+          Process.kill("TERM", Process.pid)
         else
           Process.kill("QUIT", Process.pid)
         end

data/lib/slowpoke/railtie.rb

@@ -1,12 +1,15 @@
 module Slowpoke
   class Railtie < Rails::Railtie
+    config.slowpoke = ActiveSupport::OrderedOptions.new
+
     initializer "slowpoke" do |app|
-      Rack::Timeout.service_timeout = Slowpoke.timeout
-      if Rails::VERSION::MAJOR >= 5
-        app.config.middleware.insert_after ActionDispatch::DebugExceptions, Rack::Timeout
-      else
-        app.config.middleware.insert_before ActionDispatch::RemoteIp, Rack::Timeout
-      end
+      service_timeout = app.config.slowpoke.timeout
+      service_timeout ||= ENV["RACK_TIMEOUT_SERVICE_TIMEOUT"] || ENV["REQUEST_TIMEOUT"] || ENV["TIMEOUT"] || 15
+      service_timeout = service_timeout.to_i
+
+      app.config.middleware.insert_after ActionDispatch::DebugExceptions, Rack::Timeout,
+        service_timeout: service_timeout
+
       app.config.middleware.insert(0, Slowpoke::Middleware) unless Rails.env.development? || Rails.env.test?
     end
   end

data/lib/slowpoke/version.rb

@@ -1,3 +1,3 @@
 module Slowpoke
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slowpoke
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-21 00:00:00.000000000 Z
+date: 2019-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -44,20 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -87,26 +81,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: 
-email:
-- andrew@chartkick.com
+email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/generators/slowpoke/install_generator.rb
 - lib/generators/slowpoke/templates/503.html
 - lib/slowpoke.rb
 - lib/slowpoke/middleware.rb
-- lib/slowpoke/migration.rb
 - lib/slowpoke/railtie.rb
 - lib/slowpoke/version.rb
-- slowpoke.gemspec
 homepage: https://github.com/ankane/slowpoke
 licenses:
 - MIT
@@ -119,16 +107,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Rack::Timeout is great. Slowpoke makes it better.
+summary: Rack::Timeout enhancements for Rails
 test_files: []

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/Gemfile

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

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/lib/slowpoke/migration.rb

@@ -1,16 +0,0 @@
-module Slowpoke
-  module Migration
-    def connection
-      connection = super
-      if Slowpoke.migration_statement_timeout && !@migration_statement_timeout_set
-        connection.execute("SET statement_timeout = #{Slowpoke.migration_statement_timeout.to_i}")
-        @migration_statement_timeout_set = true
-      end
-      connection
-    end
-  end
-end
-
-ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Migration.prepend(Slowpoke::Migration)
-end

data/slowpoke.gemspec

@@ -1,26 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "slowpoke/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "slowpoke"
-  spec.version       = Slowpoke::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-  spec.summary       = "Rack::Timeout is great. Slowpoke makes it better."
-  spec.homepage      = "https://github.com/ankane/slowpoke"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "railties"
-  spec.add_dependency "actionpack"
-  spec.add_dependency "rack-timeout", ">= 0.3.0", "< 0.5.0"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-end