slowpoke 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b602f89b54077d5e970bb549ce1ad3e57db8d1ab6f15bf62ea3dbae868d6ca5
-  data.tar.gz: 60cb3a0c463ebadeb4abec48794ffaa2b33b22af406c672ba2ac351f7134fbed
+  metadata.gz: b1f1038454b7897804fae9a78b8804de5ecd1d305929332fc544326df8ded0c4
+  data.tar.gz: 16c1ea1f4aea141681803f9f414620f4b12ffbf5dcb1ba5d8967ad3e6403ad6c
 SHA512:
-  metadata.gz: 94352be6969f60055f4f6121f9b087fb5a4b2e144014b973fe6aa772cb7c4c9bd4cc5922a51dc3a41ce9a70bcd97f5f1bd0516ec764d002e410a0578cf1ffb25
-  data.tar.gz: bf7c814b78e54a679798107f013083a596fab63fab960734fa5d32ba689e35128b33da7430aa560f789c56d3982d6e58f226f960828e985828793db11549e404
+  metadata.gz: 79c329a7bf360732c8ab05509b92502f7ebfea4025221568a6af4602897d7bc984a8a05f230d4bf1128221b172798ee3b436b5786e5e4b85119e737984a1fd64
+  data.tar.gz: 20dc8bc102e2fdcab2e3e896d0ff15a18f34009c0c18ea03ad56b1f26e37bb020c71aec4a7d8c6e66e338f0dbc63d222f65bda4e669d7c0efb4fb1ad428bfefb

data/CHANGELOG.md

@@ -1,24 +1,43 @@
-## 0.2.1
+## 0.4.0 (2022-10-01)
+
+- Dropped support for Ruby < 2.6 and Rails < 5.2
+
+## 0.3.2 (2019-12-23)
+
+- Added `on_timeout` method
+
+## 0.3.1 (2019-12-10)
+
+- Added support for dynamic timeouts
+
+## 0.3.0 (2019-05-31)
+
+- 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 (2018-05-21)
 
 - Don’t kill server in test environment
 - Require rack-timeout < 0.5
 
-## 0.2.0
+## 0.2.0 (2017-11-05)
 
 - Fixed custom error pages for Rails 5.1
 - Fixed migration statement timeout
 - Don’t kill server in development
 
-## 0.1.3
+## 0.1.3 (2016-08-03)
 
 - Fixed deprecation warning in Rails 5
 - No longer requires ActiveRecord
 
-## 0.1.2
+## 0.1.2 (2016-02-10)
 
 - Updated to latest version of rack-timeout, removing the need to bubble timeouts
 
-## 0.1.1
+## 0.1.1 (2015-08-02)
 
 - Fixed safer service timeouts
 - Added migration statement timeout

data/LICENSE.txt

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

data/README.md

@@ -1,17 +1,17 @@
 # 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
 
+- safer service timeouts
+- dynamic timeouts
 - custom error pages
-- [safer service timeouts](https://github.com/heroku/rack-timeout/issues/39)
-- wait timeouts that don’t kill your web server
 
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'slowpoke'
+gem "slowpoke"
 ```
 
 And run:
@@ -22,24 +22,38 @@ rails generate slowpoke:install
 
 This creates a `public/503.html` you can customize.
 
-## How to Use
+## Development
 
-The default timeout is 15 seconds. Change this with:
+To try out custom error pages in development, 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.
+
+## Production
+
+The default timeout is 15 seconds. You can change this in `config/environments/production.rb` with:
 
 ```ruby
-sleep(20)
+config.slowpoke.timeout = 5
+```
+
+For dynamic timeouts, use:
+
+```ruby
+config.slowpoke.timeout = lambda do |env|
+  request = Rack::Request.new(env)
+  request.path.start_with?("/admin") ? 15 : 5
+end
 ```
 
 Subscribe to timeouts with:
@@ -50,41 +64,65 @@ 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).
+
+## Safer Service Timeouts
+
+Rack::Timeout can raise an exception at any point in the code, which can leave your app in an [unclean state](https://www.schneems.com/2017/02/21/the-oldest-bug-in-ruby-why-racktimeout-might-hose-your-server/). The safest way to recover from a request timeout is to spawn a new process. This is the default behavior for Slowpoke.
+
+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.
+
+You can customize this behavior with:
+
+```ruby
+Slowpoke.on_timeout do |env|
+  next if Rails.env.development? || Rails.env.test?
+
+  exception = env["action_dispatch.exception"]
+  if exception && exception.backtrace.first.include?("/active_record/")
+    Slowpoke.kill
+  end
+end
+```
+
+Note: To access `env["action_dispatch.exception"]` in development, temporarily add to `config/environments/development.rb`:
+
+```ruby
+config.consider_all_requests_local = false
+```
 
 ## 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). For Postgres, your `config/database.yml` should include something like:
 
-```yaml
+```yml
 production:
-  connect_timeout: 1 # sec
+  connect_timeout: 3 # sec
   variables:
-    statement_timeout: 250 # ms
+    statement_timeout: 5s
 ```
 
-To use a different statement timeout for migrations, set:
+## Upgrading
 
-```ruby
-ENV["MIGRATION_STATEMENT_TIMEOUT"] = 60000 # ms
-```
+### 0.3.0
 
-Test connect timeouts by setting your database host to an [unroutable IP](https://stackoverflow.com/questions/100841/artificially-create-a-connection-timeout-error).
+If you set the timeout with:
 
-```yaml
-development:
-  host: 10.255.255.1
+```ruby
+Slowpoke.timeout = 5
 ```
 
-Test statement timeouts with the [pg_sleep](https://www.postgresql.org/docs/current/static/functions-datetime.html#FUNCTIONS-DATETIME-DELAY) function.
+Remove it and add to `config/environments/production.rb`:
 
-```sql
-SELECT pg_sleep(20);
+```ruby
+config.slowpoke.timeout = 5
 ```
 
-## Upgrading
+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`.
+
+### 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:
@@ -104,3 +142,11 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/slowpoke/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/slowpoke.git
+cd slowpoke
+bundle install
+```

data/lib/generators/slowpoke/templates/503.html

@@ -4,7 +4,7 @@
   <title>This page took too long to load (503)</title>
   <meta name="viewport" content="width=device-width,initial-scale=1">
   <style>
-  body {
+  .rails-default-error-page {
     background-color: #EFEFEF;
     color: #2E2F30;
     text-align: center;
@@ -12,13 +12,13 @@
     margin: 0;
   }
 
-  div.dialog {
+  .rails-default-error-page div.dialog {
     width: 95%;
     max-width: 33em;
     margin: 4em auto 0;
   }
 
-  div.dialog > div {
+  .rails-default-error-page div.dialog > div {
     border: 1px solid #CCC;
     border-right-color: #999;
     border-left-color: #999;
@@ -31,13 +31,13 @@
     box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
   }
 
-  h1 {
+  .rails-default-error-page h1 {
     font-size: 100%;
     color: #730E15;
     line-height: 1.5em;
   }
 
-  div.dialog > p {
+  .rails-default-error-page div.dialog > p {
     margin: 0 0 1em;
     padding: 1em;
     background-color: #F7F7F7;
@@ -54,7 +54,7 @@
   </style>
 </head>
 
-<body>
+<body class="rails-default-error-page">
   <!-- This file lives in public/503.html -->
   <div class="dialog">
     <div>

data/lib/slowpoke/middleware.rb

@@ -7,17 +7,11 @@ module Slowpoke
     def call(env)
       @app.call(env)
     ensure
-      if env[Slowpoke::ENV_KEY]
-        # extremely important
-        # protect the process with a restart
-        # https://github.com/heroku/rack-timeout/issues/39
-        # can't do in timed_out state consistently
-        if defined?(::PhusionPassenger)
-          `passenger-config detach-process #{Process.pid}`
-        else
-          Process.kill("QUIT", Process.pid)
-        end
-      end
+      # extremely important
+      # protect the process with a restart
+      # https://github.com/heroku/rack-timeout/issues/39
+      # can't do in timed_out state consistently
+      Slowpoke.on_timeout.call(env) if env[Slowpoke::ENV_KEY]
     end
   end
 end

data/lib/slowpoke/railtie.rb

@@ -1,13 +1,26 @@
 module Slowpoke
   class Railtie < Rails::Railtie
+    config.slowpoke = ActiveSupport::OrderedOptions.new
+
+    # must happen outside initializer (so it runs earlier)
+    config.action_dispatch.rescue_responses.merge!(
+      "Rack::Timeout::RequestTimeoutError" => :service_unavailable,
+      "Rack::Timeout::RequestExpiryError" => :service_unavailable
+    )
+
     initializer "slowpoke" do |app|
-      Rack::Timeout.service_timeout = Slowpoke.timeout
-      if Rails::VERSION::MAJOR >= 5
-        app.config.middleware.insert_after ActionDispatch::DebugExceptions, Rack::Timeout
+      service_timeout = app.config.slowpoke.timeout
+      service_timeout ||= ENV["RACK_TIMEOUT_SERVICE_TIMEOUT"] || ENV["REQUEST_TIMEOUT"] || ENV["TIMEOUT"] || 15
+
+      if service_timeout.respond_to?(:call)
+        app.config.middleware.insert_after ActionDispatch::DebugExceptions, Slowpoke::Timeout,
+          service_timeout: service_timeout
       else
-        app.config.middleware.insert_before ActionDispatch::RemoteIp, Rack::Timeout
+        app.config.middleware.insert_after ActionDispatch::DebugExceptions, Rack::Timeout,
+          service_timeout: service_timeout.to_i
       end
-      app.config.middleware.insert(0, Slowpoke::Middleware) unless Rails.env.development? || Rails.env.test?
+
+      app.config.middleware.insert(0, Slowpoke::Middleware)
     end
   end
 end

data/lib/slowpoke/timeout.rb

@@ -0,0 +1,18 @@
+module Slowpoke
+  class Timeout
+    def initialize(app, service_timeout:)
+      @app = app
+      @service_timeout = service_timeout
+      @middleware = {}
+    end
+
+    def call(env)
+      service_timeout = @service_timeout.call(env)
+      if service_timeout
+        (@middleware[service_timeout] ||= Rack::Timeout.new(@app, service_timeout: service_timeout)).call(env)
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/slowpoke/version.rb

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

data/lib/slowpoke.rb

@@ -1,32 +1,40 @@
-require "slowpoke/version"
+# dependencies
 require "rack/timeout/base"
+
+# modules
 require "slowpoke/middleware"
-require "slowpoke/migration"
 require "slowpoke/railtie"
-require "action_dispatch/middleware/exception_wrapper"
-require "action_controller/base"
+require "slowpoke/timeout"
+require "slowpoke/version"
 
 module Slowpoke
   ENV_KEY = "slowpoke.timed_out".freeze
 
-  def self.timeout
-    @timeout ||= (ENV["REQUEST_TIMEOUT"] || ENV["TIMEOUT"] || 15).to_i
+  def self.kill
+    if defined?(::PhusionPassenger)
+      `passenger-config detach-process #{Process.pid}`
+    elsif defined?(::Puma)
+      Process.kill("TERM", Process.pid)
+    else
+      Process.kill("QUIT", Process.pid)
+    end
   end
 
-  def self.timeout=(timeout)
-    timeout = timeout.to_i if timeout.respond_to?(:to_i)
-    @timeout = Rack::Timeout.service_timeout = timeout
+  def self.on_timeout(&block)
+    if block_given?
+      @on_timeout = block
+    else
+      @on_timeout
+    end
   end
 
-  def self.migration_statement_timeout
-    ENV["MIGRATION_STATEMENT_TIMEOUT"]
+  on_timeout do |env|
+    next if Rails.env.development? || Rails.env.test?
+
+    Slowpoke.kill
   end
 end
 
-# custom error page
-ActionDispatch::ExceptionWrapper.rescue_responses["Rack::Timeout::RequestTimeoutError"] = :service_unavailable
-ActionDispatch::ExceptionWrapper.rescue_responses["Rack::Timeout::RequestExpiryError"] = :service_unavailable
-
 # remove noisy logger
 Rack::Timeout.unregister_state_change_observer(:logger)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slowpoke
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-21 00:00:00.000000000 Z
+date: 2022-01-11 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.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -44,74 +44,35 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.4'
   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
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    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: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email:
-- andrew@chartkick.com
+        version: '0.4'
+description:
+email: andrew@ankane.org
 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/timeout.rb
 - lib/slowpoke/version.rb
-- slowpoke.gemspec
 homepage: https://github.com/ankane/slowpoke
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,16 +80,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.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