slowpoke 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5001012d6c99301ae24d91ab6d400e68d3bba3194829645bcd9334e05c630793
-  data.tar.gz: 750108765f01af869c4ed46796ce015dc9b8b82dd0f3f3f669387850ccc561d4
+  metadata.gz: 79e082a34ab895956d7086764a63dc6f4dbedeee15f7557f727a5b23fa51ad08
+  data.tar.gz: e7b7aa0452587608fbf2a03f4dad9289562b9ece95a07fc98cf526e9ac3cfb5f
 SHA512:
-  metadata.gz: be064a8afb4a84a37dc7282300a510a769dda19283b7a2d1f71867e10f4361ea333d8ff9aa414c3346be8da2abde724aa5376b685a2e137850189b3c33ba4842
-  data.tar.gz: e468660cfb1c056c10fa41cea26fc116802fb7aefde498c831bbf56b4bc76460925bb1c6f3be7f9a7f9f5a1f6344df5f42dd9808c9fda806caea2565cdce4420
+  metadata.gz: 4e4d9eee0e505d0163b1d34e7a8a34b35f399261cacb216d422478b0a81d7637b54a967749d4feb8de04ff40e03ef88f6cb066dbed6fbdf168851e454aaed343
+  data.tar.gz: c2fb32575fc524033c39dc351022421da93cb928747251f463c53b6352adeca75ce635d02dbd35587af8c8b5e5a9d5e5092de798afab6171364ceaf9af7c7bee

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+## 0.3.2 (2019-12-23)
+
+- Added `on_timeout` method
+
 ## 0.3.1 (2019-12-10)
 
-- Added support for conditional timeouts
+- Added support for dynamic timeouts
 
 ## 0.3.0 (2019-05-31)
 

data/README.md

@@ -2,9 +2,9 @@
 
 [Rack::Timeout](https://github.com/heroku/rack-timeout) enhancements for Rails
 
-- conditional timeouts
+- safer service timeouts
+- dynamic timeouts
 - custom error pages
-- [safer service timeouts](https://github.com/heroku/rack-timeout/issues/39)
 
 ## Installation
 
@@ -47,7 +47,7 @@ The default timeout is 15 seconds. You can change this in `config/environments/p
 config.slowpoke.timeout = 5
 ```
 
-For conditional timeouts, use:
+For dynamic timeouts, use:
 
 ```ruby
 config.slowpoke.timeout = lambda do |env|
@@ -66,9 +66,30 @@ end
 
 To learn more, see the [Rack::Timeout documentation](https://github.com/heroku/rack-timeout).
 
-## Threaded Servers
+## Safer Service Timeouts
 
-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.
+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
 

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.rb

@@ -9,6 +9,30 @@ require "slowpoke/version"
 
 module Slowpoke
   ENV_KEY = "slowpoke.timed_out".freeze
+
+  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.on_timeout(&block)
+    if block_given?
+      @on_timeout = block
+    else
+      @on_timeout
+    end
+  end
+
+  on_timeout do |env|
+    next if Rails.env.development? || Rails.env.test?
+
+    Slowpoke.kill
+  end
 end
 
 # remove noisy logger

data/lib/slowpoke/middleware.rb

@@ -7,19 +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}`
-        elsif defined?(::Puma)
-          Process.kill("TERM", 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

@@ -20,7 +20,7 @@ module Slowpoke
           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/version.rb

@@ -1,3 +1,3 @@
 module Slowpoke
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slowpoke
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2019-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties