slowpoke 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 386bc598cac17cf2094f6260750e204fae2f1eb3
-  data.tar.gz: dbc8b84fbeb145cfc78ef211d033b7706a704287
+  metadata.gz: 29835ce4edb81b06635ee82405908c32d490623a
+  data.tar.gz: 8653542563bcee20f8c5288b327a2bc6337f707b
 SHA512:
-  metadata.gz: e8f0ec80ef1ee5c638ca7cddc25fd0592da42920dbcb5c5daaefb6b0cfb8de9afae611f69795e76a394a13c994f58b7ea171fc6dd5e9f1398296885be9ae0655
-  data.tar.gz: fcc475c88fcb9374ba26c1c7bd14bf132a378698300661d50709f0f3a2ace41a2ab94292f3098b8f31a6e4ad2fcc4500f6139c7e46451418d12bb03b03c52e03
+  metadata.gz: a24ee1b1e5f943bbc462a0f3ace64178f2a5ae9bf219fce257e4d97193e760179babc07bb80d79bddeca82343f68a0e2b158a9510dee91f22e943e67e7498024
+  data.tar.gz: bc81cadcc3aaa7b54bf549e84d79c1e773f91895b3a795f4fd69e3f34845753f24358204a22c625d720fdcb98f9db08b43a526d14d58d3c01e0f8c1554239498

data/Gemfile

@@ -2,3 +2,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in slowpoke.gemspec
 gemspec
+
+gem "makara", github: "taskrabbit/makara"

data/README.md

@@ -1,10 +1,10 @@
 # Slowpoke
 
-Timeouts made easy
+[Rack::Timeout](https://github.com/heroku/rack-timeout) is great. Slowpoke makes it better with:
 
-- custom error page
-- database timeouts
-- notifications
+- 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,47 +22,43 @@ rails generate slowpoke:install
 
 This creates a `public/503.html` you can customize.
 
+## How to Use
+
 The default timeout is 15 seconds. Change this with:
 
 ```ruby
-Slowpoke.timeout = 10 # or set ENV["REQUEST_TIMEOUT"]
+Slowpoke.timeout = 10
 ```
 
-Subscribe to timeouts
+or set:
 
 ```ruby
-ActiveSupport::Notifications.subscribe "timeout.slowpoke" do |name, start, finish, id, payload|
-  # report timeout
-end
+ENV["REQUEST_TIMEOUT"]
 ```
 
-### Dynamic Timeouts
-
-Add this line to your application’s Gemfile:
+Subscribe to timeouts with:
 
 ```ruby
-gem 'rack-timeout', github: 'ankane/rack-timeout'
+ActiveSupport::Notifications.subscribe "timeout.slowpoke" do |name, start, finish, id, payload|
+  # report timeout
+end
 ```
 
-And use:
+To learn more, see the [Rack::Timeout documentation](https://github.com/heroku/rack-timeout#the-rabbit-hole).
 
-```ruby
-Slowpoke.timeout = proc{|env| env["REQUEST_PATH"].start_with?("/admin") ? 15 : 5 }
-```
+## Database Timeouts
 
-### Database Timeouts
+For PostgreSQL, set a statement timeout in `config/database.yml`:
 
-For ActiveRecord (PostgreSQL only), change the database timeout with:
-
-```ruby
-Slowpoke.database_timeout = 10 # or set ENV["DATABASE_TIMEOUT"]
+```yaml
+production:
+  variables:
+    statement_timeout: 30000 # ms
 ```
 
-Defaults to the request timeout (or no timeout if you use dynamic timeouts).
-
-## TODO
+## Upgrading
 
-- block to bypass or change database timeout
+`0.1.0` removes database timeouts, since Rails supports them by default.
 
 ## Contributing
 

data/lib/slowpoke.rb

@@ -2,7 +2,6 @@ require "slowpoke/version"
 require "rack-timeout"
 require "safely_block"
 require "slowpoke/controller"
-require "slowpoke/postgres"
 require "slowpoke/railtie"
 require "action_dispatch/middleware/exception_wrapper"
 require "action_controller/base"
@@ -10,10 +9,6 @@ require "action_controller/base"
 module Slowpoke
   ENV_KEY = "slowpoke.timed_out".freeze
 
-  class << self
-    attr_writer :database_timeout
-  end
-
   def self.timeout
     @timeout ||= (ENV["REQUEST_TIMEOUT"] || ENV["TIMEOUT"] || 15).to_i
   end
@@ -22,14 +17,11 @@ module Slowpoke
     timeout = timeout.to_i if timeout.respond_to?(:to_i)
     @timeout = Rack::Timeout.timeout = timeout
   end
-
-  def self.database_timeout
-    @database_timeout ||= ENV["DATABASE_TIMEOUT"].to_i if ENV["DATABASE_TIMEOUT"]
-  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)
@@ -53,9 +45,3 @@ end
 
 # bubble exceptions for error reporting libraries
 ActionController::Base.send(:include, Slowpoke::Controller)
-
-if defined?(PG)
-  require "active_record/connection_adapters/postgresql_adapter"
-  # database timeout
-  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send(:include, Slowpoke::Postgres)
-end

data/lib/slowpoke/railtie.rb

@@ -1,8 +1,11 @@
 module Slowpoke
   class Railtie < Rails::Railtie
-    initializer "slowpoke" do
+    initializer "slowpoke" do |app|
       Rack::Timeout.timeout = Slowpoke.timeout
-      ActiveRecord::Base.logger.class.send(:include, ::LoggerSilence) if ActiveRecord::Base.logger
+
+      # prevent RequestExpiryError from killing web server
+      app.config.middleware.delete "Rack::Timeout"
+      app.config.middleware.insert_before "ActionDispatch::RemoteIp", "Rack::Timeout"
     end
   end
 end

data/lib/slowpoke/version.rb

@@ -1,3 +1,3 @@
 module Slowpoke
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/slowpoke.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rails"
   spec.add_dependency "rack-timeout", ">= 0.1.0"
   spec.add_dependency "safely_block"
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: slowpoke
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-06-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-timeout
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +96,6 @@ files:
 - lib/generators/slowpoke/templates/503.html
 - lib/slowpoke.rb
 - lib/slowpoke/controller.rb
-- lib/slowpoke/postgres.rb
 - lib/slowpoke/railtie.rb
 - lib/slowpoke/version.rb
 - slowpoke.gemspec

data/lib/slowpoke/postgres.rb

@@ -1,25 +0,0 @@
-module Slowpoke
-  module Postgres
-    extend ActiveSupport::Concern
-
-    included do
-      alias_method_chain :configure_connection, :statement_timeout
-    end
-
-    def configure_connection_with_statement_timeout
-      configure_connection_without_statement_timeout
-      safely do
-        timeout = Slowpoke.database_timeout || Slowpoke.timeout
-        if timeout && !timeout.respond_to?(:call)
-          if ActiveRecord::Base.logger
-            ActiveRecord::Base.logger.silence do
-              execute("SET statement_timeout = #{timeout * 1000}")
-            end
-          else
-            execute("SET statement_timeout = #{timeout * 1000}")
-          end
-        end
-      end
-    end
-  end
-end