slowpoke 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29835ce4edb81b06635ee82405908c32d490623a
-  data.tar.gz: 8653542563bcee20f8c5288b327a2bc6337f707b
+  metadata.gz: c5f0a6122b30b1ab9e451cb58a294368a13e9925
+  data.tar.gz: 9970da3afc5dab294ebdd817c6b412faebbc6577
 SHA512:
-  metadata.gz: a24ee1b1e5f943bbc462a0f3ace64178f2a5ae9bf219fce257e4d97193e760179babc07bb80d79bddeca82343f68a0e2b158a9510dee91f22e943e67e7498024
-  data.tar.gz: bc81cadcc3aaa7b54bf549e84d79c1e773f91895b3a795f4fd69e3f34845753f24358204a22c625d720fdcb98f9db08b43a526d14d58d3c01e0f8c1554239498
+  metadata.gz: bcd4a2ff4292b535615947f440cbef41037a0aaa4e61d9f8d478158875172f76c79dff4f4bbba3751cba7c1e674918e150053520aab52864fc45ece66a6bcb44
+  data.tar.gz: cf6a6cf5030ce46c9a45dd661472865fd6af88844027ad2ab38c35e8988ad4fca4fd9d797e4bb545684a204cdd14782447b363748cc09b9c43e194485205b9a6

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.1.1
+
+- Fixed safer service timeouts
+- Added migration statement timeout

data/README.md

@@ -36,6 +36,12 @@ or set:
 ENV["REQUEST_TIMEOUT"]
 ```
 
+Test by adding a `sleep` call to one of your actions:
+
+```ruby
+sleep(20)
+```
+
 Subscribe to timeouts with:
 
 ```ruby
@@ -48,17 +54,47 @@ To learn more, see the [Rack::Timeout documentation](https://github.com/heroku/r
 
 ## Database Timeouts
 
-For PostgreSQL, set a statement timeout in `config/database.yml`:
+For PostgreSQL, set connect and statement timeouts in `config/database.yml`:
 
 ```yaml
 production:
+  connect_timeout: 1 # sec
   variables:
-    statement_timeout: 30000 # ms
+    statement_timeout: 250 # ms
+```
+
+To use a different statement timeout for migrations, set:
+
+```ruby
+ENV["MIGRATION_STATEMENT_TIMEOUT"] = 60000 # ms
+```
+
+Test connect timeouts by setting your database host to an [unroutable IP](http://stackoverflow.com/questions/100841/artificially-create-a-connection-timeout-error).
+
+```yaml
+development:
+  host: 10.255.255.1
+```
+
+Test statement timeouts with the [pg_sleep](http://www.postgresql.org/docs/9.0/static/functions-datetime.html#FUNCTIONS-DATETIME-DELAY) function.
+
+```sql
+SELECT pg_sleep(20);
 ```
 
 ## Upgrading
 
-`0.1.0` removes database timeouts, since Rails supports them by default.
+`0.1.0` removes database timeouts, since Rails supports them by default.  To restore the previous behavior, use:
+
+```yaml
+production:
+  variables:
+    statement_timeout: <%= Slowpoke.timeout * 1000 %>
+```
+
+## History
+
+View the [changelog](https://github.com/ankane/slowpoke/blob/master/CHANGELOG.md)
 
 ## Contributing
 

data/lib/slowpoke.rb

@@ -2,6 +2,8 @@ require "slowpoke/version"
 require "rack-timeout"
 require "safely_block"
 require "slowpoke/controller"
+require "slowpoke/middleware"
+require "slowpoke/migration"
 require "slowpoke/railtie"
 require "action_dispatch/middleware/exception_wrapper"
 require "action_controller/base"
@@ -28,18 +30,11 @@ Rack::Timeout.unregister_state_change_observer(:logger)
 
 # process protection and notifications
 Rack::Timeout.register_state_change_observer(:slowpoke) do |env|
-  case env[Rack::Timeout::ENV_INFO_KEY].state
-  when :timed_out
+  if env[Rack::Timeout::ENV_INFO_KEY].state == :timed_out
     env[Slowpoke::ENV_KEY] = true
 
     # TODO better payload
     ActiveSupport::Notifications.instrument("timeout.slowpoke", {})
-  when :completed
-    # extremely important
-    # protect the process with a restart
-    # https://github.com/heroku/rack-timeout/issues/39
-    # can't do in timed_out state consistently
-    Process.kill("QUIT", Process.pid) if env[Slowpoke::ENV_KEY]
   end
 end
 

data/lib/slowpoke/middleware.rb

@@ -0,0 +1,23 @@
+module Slowpoke
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      response = @app.call(env)
+      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
+      response
+    end
+  end
+end

data/lib/slowpoke/migration.rb

@@ -0,0 +1,19 @@
+module Slowpoke
+  module Migration
+    def connection
+      if ENV["MIGRATION_STATEMENT_TIMEOUT"]
+        @connection_with_timeout ||= begin
+          config = ActiveRecord::Base.connection_config
+          config["variables"] ||= {}
+          config["variables"]["statement_timeout"] = ENV["MIGRATION_STATEMENT_TIMEOUT"].to_i
+          ActiveRecord::Base.establish_connection(config)
+          ActiveRecord::Base.connection
+        end
+      else
+        super
+      end
+    end
+  end
+end
+
+ActiveRecord::Migration.prepend(Slowpoke::Migration)

data/lib/slowpoke/railtie.rb

@@ -6,6 +6,7 @@ module Slowpoke
       # prevent RequestExpiryError from killing web server
       app.config.middleware.delete "Rack::Timeout"
       app.config.middleware.insert_before "ActionDispatch::RemoteIp", "Rack::Timeout"
+      app.config.middleware.insert 0, Slowpoke::Middleware
     end
   end
 end

data/lib/slowpoke/version.rb

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

data/slowpoke.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Slowpoke::VERSION
   spec.authors       = ["Andrew Kane"]
   spec.email         = ["andrew@chartkick.com"]
-  spec.summary       = "Timeouts made easy"
-  spec.description   = "Timeouts made easy"
+  spec.summary       = "Rack::Timeout is great. Slowpoke makes it better."
+  spec.description   = "Rack::Timeout is great. Slowpoke makes it better."
   spec.homepage      = "https://github.com/ankane/slowpoke"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slowpoke
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Timeouts made easy
+description: Rack::Timeout is great. Slowpoke makes it better.
 email:
 - andrew@chartkick.com
 executables: []
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -96,6 +97,8 @@ files:
 - lib/generators/slowpoke/templates/503.html
 - lib/slowpoke.rb
 - lib/slowpoke/controller.rb
+- lib/slowpoke/middleware.rb
+- lib/slowpoke/migration.rb
 - lib/slowpoke/railtie.rb
 - lib/slowpoke/version.rb
 - slowpoke.gemspec
@@ -122,6 +125,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Timeouts made easy
+summary: Rack::Timeout is great. Slowpoke makes it better.
 test_files: []
 has_rdoc: