slowpoke 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 196837a764b30dcd76bd206904b4f019a3dc77149a9ab472c9aaa062f5e00584
-  data.tar.gz: 410bd79283dc9921762ca886d54978f2adac2496e2ad0c6e8a381157e5318dc2
+  metadata.gz: 5001012d6c99301ae24d91ab6d400e68d3bba3194829645bcd9334e05c630793
+  data.tar.gz: 750108765f01af869c4ed46796ce015dc9b8b82dd0f3f3f669387850ccc561d4
 SHA512:
-  metadata.gz: 46f0c622df519a853f40660bcdaa644e1e3586eeb8607ffd09420456a4b10d4a7b536154eb8b911d5131b9d8dca6afe0b6521f48191438176a7924cf6dec3b3d
-  data.tar.gz: 8ab0b75f01bd8f0662ba21ca4f130ff6926e2f5f5f11dedb296aec35ad2f06f957067d68c4defdf52774da5cdb756a2f590261b28193498ecb1128067ac34843
+  metadata.gz: be064a8afb4a84a37dc7282300a510a769dda19283b7a2d1f71867e10f4361ea333d8ff9aa414c3346be8da2abde724aa5376b685a2e137850189b3c33ba4842
+  data.tar.gz: e468660cfb1c056c10fa41cea26fc116802fb7aefde498c831bbf56b4bc76460925bb1c6f3be7f9a7f9f5a1f6344df5f42dd9808c9fda806caea2565cdce4420

data/CHANGELOG.md

@@ -1,31 +1,35 @@
-## 0.3.0
+## 0.3.1 (2019-12-10)
+
+- Added support for conditional 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
+## 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/README.md

@@ -2,6 +2,7 @@
 
 [Rack::Timeout](https://github.com/heroku/rack-timeout) enhancements for Rails
 
+- conditional timeouts
 - custom error pages
 - [safer service timeouts](https://github.com/heroku/rack-timeout/issues/39)
 
@@ -21,9 +22,9 @@ rails generate slowpoke:install
 
 This creates a `public/503.html` you can customize.
 
-## Trying It in Development
+## Development
 
-Temporarily add to `config/environments/development.rb`:
+To try out custom error pages in development, temporarily add to `config/environments/development.rb`:
 
 ```ruby
 config.slowpoke.timeout = 1
@@ -38,7 +39,7 @@ sleep(2)
 
 The custom error page should appear.
 
-## Configuring It for Production
+## Production
 
 The default timeout is 15 seconds. You can change this in `config/environments/production.rb` with:
 
@@ -46,6 +47,15 @@ The default timeout is 15 seconds. You can change this in `config/environments/p
 config.slowpoke.timeout = 5
 ```
 
+For conditional 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:
 
 ```ruby
@@ -62,7 +72,14 @@ The only safe way to recover from a request timeout is to spawn a new process. F
 
 ## Database Timeouts
 
-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).
+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:
+
+```yml
+production:
+  connect_timeout: 3 # sec
+  variables:
+    statement_timeout: 5s
+```
 
 ## Upgrading
 
@@ -104,3 +121,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/slowpoke.rb

@@ -1,18 +1,16 @@
-require "slowpoke/version"
+# dependencies
 require "rack/timeout/base"
+
+# modules
 require "slowpoke/middleware"
 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
 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)
 

data/lib/slowpoke/railtie.rb

@@ -2,13 +2,23 @@ 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|
       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
+      if service_timeout.respond_to?(:call)
+        app.config.middleware.insert_after ActionDispatch::DebugExceptions, Slowpoke::Timeout,
+          service_timeout: service_timeout
+      else
+        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?
     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.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slowpoke
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-01 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -94,6 +94,7 @@ files:
 - lib/slowpoke.rb
 - lib/slowpoke/middleware.rb
 - lib/slowpoke/railtie.rb
+- lib/slowpoke/timeout.rb
 - lib/slowpoke/version.rb
 homepage: https://github.com/ankane/slowpoke
 licenses: