puma_worker_killer 0.0.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b5655d10238db0d4a493057719a99621386373a7
-  data.tar.gz: 853a84a27a47ea134bc5812fa7a6cd4f0e2de231
+SHA256:
+  metadata.gz: 656a49cbbcbc36e3735d20ade22027cc209213f029e51faa7f0f08c7dbcffb70
+  data.tar.gz: 5a328323d77f9ede2a44ab0c37577b6277a682c73ce1ad0f1bf167efb720a62d
 SHA512:
-  metadata.gz: 8e43e8ea674c6afafa5e693ffbcf12cb07785ee1176e3b33e30f00faa536fe277903782138172a285b4e44dc264e033358b6693308d84b3dca6bc6159130b687
-  data.tar.gz: 7f2575bbde18a5250049b7af098902bed20baf08ac5e7bcbb86443b3b2d3adb6c17a3a5acaa14cbd0c8ec7380da8ef3492fa347132e7b33fb197893f9a030168
+  metadata.gz: f77c25f16200fc313b7d230f852fcd2543f1f2ff1f40863c757c9288cbbc520c6b44f9ba3c51fef26693e1d233b66519100d0443b3020402f55ebee397babd09
+  data.tar.gz: df97c81b1e0d93a8ace45cd1b24a9e6de4fb2f94a85b181650a163f458aae754a6571b5b34721b6b718649059305c2637f0766597b0560f9412a57c56e91281a

data/.github/workflows/check_changelog.yml

@@ -0,0 +1,12 @@
+name: Check Changelog
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Check that CHANGELOG is touched
+      run: |
+        cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_from: .rubocop_todo.yml
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,24 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-04-03 13:12:53 +0200 using RuboCop version 0.81.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 21
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 32
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 252

data/.travis.yml

@@ -1,14 +1,22 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
   - ruby-head
-  - jruby-19mode
-  - rbx-19mode
+  - rbx
+before_install:
+  - gem install bundler -v 1.12.5
 
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: rbx-19mode
-    - rvm: jruby-19mode
+    - rvm: rbx
+
+install:
+  - bundle install
+
+script:
+  - bundle exec rubocop
+  - bundle exec rake test

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## Master
+
+## 0.2.0
+
+- Simplify workers memory calculation in PumaMemory‘s `get_total` method #81
+- Add rubocop in gemspec and CI, with offenses corrected and unnecessary cops disabled.
+- Add `pre_term`-like `rolling_pre_term` config for terminations caused by rolling restart (#86)
+- Fix compatibility with ruby version 2.3.X (#87)
+
+## 0.1.1
+
+- Allow PWK to be used with Puma 4 (#72)
+
+## 0.1.0
+
+- Emit extra data via `pre_term` callback before puma worker killer terminates a worker #49.
+
+## 0.0.7
+
+- Logging is configurable #41
+
+## 0.0.6
+
+- Log PID of worker insead of inspecting the worker #33
+
 ## 0.0.5
 
 - Support for Puma 3.x
@@ -9,3 +34,4 @@
 ## 0.0.3
 
 - Fix memory metrics in on linux
+

data/Gemfile

@@ -1,3 +1,7 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec
+
+gem 'rubocop', require: false

data/README.md

@@ -1,7 +1,24 @@
 # Puma Worker Killer
 
 [![Build Status](https://travis-ci.org/schneems/puma_worker_killer.png?branch=master)](https://travis-ci.org/schneems/puma_worker_killer)
+[![Help Contribute to Open Source](https://www.codetriage.com/schneems/puma_worker_killer/badges/users.svg)](https://www.codetriage.com/schneems/puma_worker_killer)
 
+## !!!!!!!!!!!!!!!! STOP !!!!!!!!!!!!!!!!
+
+Before you use this gem, know that it is dangerous. If you have a memory issue, you need to fix the issue. The original idea behind this gem is that it would act as a temporary band-aid to buy you time to allow you to fix your issues. If you turn this on and don't fix the underlying memory problems, then things will only get worse over time.
+
+This gem can also make your performance WORSE. When a worker is killed, and comes back it takes CPU cycles and time. If you are frequently restarting your workers then you're killing your performance.
+
+Here are some places to start improving your understanding of memory behvior in Ruby:
+
+- [Complete Guide to Rails Performance (Book)](https://www.railsspeed.com)
+- [How Ruby uses Memory](https://www.sitepoint.com/ruby-uses-memory/)
+- [Ruby Memory Use (Heroku Devcenter article I maintain)](https://devcenter.heroku.com/articles/ruby-memory-use)
+- [Jumping off the Ruby Memory Cliff](https://www.schneems.com/2017/04/12/jumping-off-the-memory-cliff/)
+- [How Ruby uses memory (Talk)](https://www.schneems.com/2015/05/11/how-ruby-uses-memory.html) (you can skip the first story in the video, the rest are about memory)
+- [Debugging a memory leak on Heroku](https://blog.codeship.com/debugging-a-memory-leak-on-heroku/)
+
+If you still need this gem, proceed with caution.
 
 ## What
 
@@ -9,7 +26,7 @@ If you have a memory leak in your code, finding and plugging it can be a hercule
 
 Puma worker killer can only function if you have enabled cluster mode or hybrid mode (threads + worker cluster). If you are only using threads (and not workers) then puma worker killer cannot help keep your memory in control.
 
-BTW restarting your processes to controll memory is like putting a bandaid on a gunshot wound, try figuring out the reason you're seeing so much memory bloat [derailed benchmarks](https://github.com/schneems/derailed_benchmarks) can help.
+BTW restarting your processes to control memory is like putting a bandaid on a gunshot wound, try figuring out the reason you're seeing so much memory bloat [derailed benchmarks](https://github.com/schneems/derailed_benchmarks) can help.
 
 
 ## Install
@@ -22,21 +39,69 @@ gem 'puma_worker_killer'
 
 Then run `$ bundle install`
 
-<!--
-## Use
+## Turn on Rolling Restarts - Heroku Mode
 
-> If you like `puma_worker_killer` consider using [puma_auto_tune instead](https://github.com/schneems/puma_auto_tune). It handles memory leaks and tunes your workers too!
+A rolling restart will kill each of your workers on a rolling basis. You set the frequency which it conducts the restart. This is a simple way to keep memory down as Ruby web programs generally increase memory usage over time. If you're using Heroku [it is difficult to measure RAM from inside of a container accurately](https://github.com/schneems/get_process_mem/issues/7), so it is recommended to use this feature or use a [log-drain-based worker killer](https://github.com/arches/whacamole). You can enable roling restarts by running:
 
--->
+```ruby
+# config/puma.rb
+
+before_fork do
+  require 'puma_worker_killer'
 
-Somewhere in your main process run this code:
+  PumaWorkerKiller.enable_rolling_restart # Default is every 6 hours
+end
+
+```
+
+or you can pass in the restart frequency:
 
 ```ruby
-# config/initializers/puma_worker_killer.rb
-PumaWorkerKiller.start
+PumaWorkerKiller.enable_rolling_restart(12 * 3600) # 12 hours in seconds
+```
+
+Make sure if you do this to not accidentally call `PumaWorkerKiller.start` as well.
+
+## Enable Worker Killing
+
+If you're not running on a containerized platform (like Heroku or Docker) you can try to detect the amount of memory you're using and only kill Puma workers when you're over that limit. It may allow you to go for longer periods of time without killing a worker however it is more error prone than rolling restarts. To enable measurement based worker killing put this in your `config/puma.rb`:
+
+```ruby
+# config/puma.rb
+
+before_fork do
+  require 'puma_worker_killer'
+
+  PumaWorkerKiller.start
+end
 ```
 
-That's it. Now on a regular basis the size of all Puma and all of it's forked processes will be evaluated and if they're over the RAM threshold will be killed. Don't worry Puma will notice a process is missing a spawn a fresh copy with a much smaller RAM footprint ASAP.
+That's it. Now on a regular basis the size of all Puma and all of it's forked processes will be evaluated and if they're over the RAM threshold will be killed. Don't worry Puma will notice a process is missing and spawn a fresh copy with a much smaller RAM footprint ASAP.
+
+## Troubleshooting
+
+When you boot your program locally you should see debug output:
+
+```
+[77773] Puma starting in cluster mode...
+[77773] * Version 3.1.0 (ruby 2.3.1-p112), codename: El Niño Winter Wonderland
+[77773] * Min threads: 0, max threads: 16
+[77773] * Environment: development
+[77773] * Process workers: 2
+[77773] * Phased restart available
+[77773] * Listening on tcp://0.0.0.0:9292
+[77773] Use Ctrl-C to stop
+[77773] PumaWorkerKiller: Consuming 54.34765625 mb with master and 2 workers.
+```
+
+If you don't see any `PumaWorkerKiller` output, make sure that you are running with multiple workers. PWK only functions if you have workers enabled, you should see something like this when Puma boots:
+
+```
+[77773] * Process workers: 2
+```
+
+If you've configured PWK's frequency try reducing it to a very low value
+
 
 ## Configure
 
@@ -47,21 +112,63 @@ PumaWorkerKiller.config do |config|
   config.ram           = 1024 # mb
   config.frequency     = 5    # seconds
   config.percent_usage = 0.98
-  config.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds
+  config.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds, or 12.hours if using Rails
+  config.reaper_status_logs = true # setting this to false will not log lines like:
+  # PumaWorkerKiller: Consuming 54.34765625 mb with master and 2 workers.
+
+  config.pre_term = -> (worker) { puts "Worker #{worker.inspect} being killed" }
+  config.rolling_pre_term = -> (worker) { puts "Worker #{worker.inspect} being killed by rolling restart" }
 end
 PumaWorkerKiller.start
 ```
 
-## Attention 
-If you start puma as a daemon, to add puma worker killer config into puma config file, rather than into initializers:    
-Sample like this: (in puma.rb file)
+### pre_term
+
+`config.pre_term` will be called just prior to worker termination with the worker that is about to be terminated. This may be useful to use in keeping track of metrics, time of day workers are restarted, etc.
+
+By default Puma Worker Killer will emit a log when a worker is being killed
+
+```
+PumaWorkerKiller: Out of memory. 5 workers consuming total: 500 mb out of max: 450 mb. Sending TERM to pid 23 consuming 53 mb.
+```
+
+or
+
+```
+PumaWorkerKiller: Rolling Restart. 5 workers consuming total: 650mb mb. Sending TERM to pid 34.
+```
+
+However you may want to collect more data, such as sending an event to an error collection service like rollbar or airbrake. The `pre_term` lambda gets called before any worker is killed by PWK for any reason.
+
+### rolling_pre_term
+
+`config.rolling_pre_term` will be called just prior to worker termination by rolling restart when rolling restart is enabled.
+
+It is similar to `config.pre_term`.
+
+Difference:
+
+- `config.pre_term` is triggered only by terminations related with exceeding RAM
+- `config.rolling_pre_term` is triggered only by terminations caused by enabled rolling restart
+
+### on_calculation
+
+`config.on_calculation` will be called every time Puma Worker Killer calculates memory usage (`config.frequency`). This may be useful for monitoring your total puma application memory usage, which can be contrasted with other application monitoring solutions.
+
+This callback lambda is given a single value for the amount of memory used.
+
+## Attention
+
+If you start puma as a daemon, to add puma worker killer config into puma config file, rather than into initializers:
+Sample like this: (in `config/puma.rb` file):
+
 ```ruby
 before_fork do
   PumaWorkerKiller.config do |config|
     config.ram           = 1024 # mb
     config.frequency     = 5    # seconds
     config.percent_usage = 0.98
-    config.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds
+    config.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds, or 12.hours if using Rails
   end
   PumaWorkerKiller.start
 end
@@ -88,32 +195,23 @@ PumaWorkerKiller.frequency = 20 # seconds
 You may want to periodically restart all of your workers rather than simply killing your largest. To do that set:
 
 ```ruby
-PumaWorkerKiller.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds
+PumaWorkerKiller.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds, or 12.hours if using Rails
 ```
 
-By default PumaWorkerKiller will perform a rolling restart of all your worker processes every 12 hours. To disable, set to `false`.
+By default PumaWorkerKiller will perform a rolling restart of all your worker processes every 6 hours. To disable, set to `false`.
 
-## Only turn on Rolling Restarts
-
-If you're running on a platform like [Heroku where it is difficult to measure RAM from inside of a container accurately](https://github.com/schneems/get_process_mem/issues/7), you may want to disable the "worker killer" functionality and only use the rolling restart. You can do that by running:
-
-```ruby
-PumaWorkerKiller.enable_rolling_restart
-```
-
-or you can pass in the restart frequency
+You may want to hide the following log lines: `PumaWorkerKiller: Consuming 54.34765625 mb with master and 2 workers.`. To do that set:
 
 ```ruby
-PumaWorkerKiller.enable_rolling_restart(12 * 3600) # 12 hours in seconds
+PumaWorkerKiller.reaper_status_logs = false
 ```
 
-Make sure if you do this to not accidentally call `PumaWorkerKiller.start` as well.
+Note: It is `true` by default.
 
 ## License
 
 MIT
 
-
 ## Feedback
 
 Open up an issue or ping me on twitter [@schneems](http://twitter.com/schneems).

data/Rakefile

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 
 require 'bundler/gem_tasks'
 
@@ -7,7 +7,7 @@ require 'rake/testtask'
 
 task :default => [:test]
 
-test_task = Rake::TestTask.new(:test) do |t|
+Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'

data/lib/puma_worker_killer.rb

@@ -1,20 +1,28 @@
+# frozen_string_literal: true
+
 require 'get_process_mem'
 
 module PumaWorkerKiller
   extend self
 
-  attr_accessor :ram, :frequency, :percent_usage, :rolling_restart_frequency
+  attr_accessor :ram, :frequency, :percent_usage, :rolling_restart_frequency,
+                :reaper_status_logs, :pre_term, :rolling_pre_term, :on_calculation
+
   self.ram           = 512  # mb
   self.frequency     = 10   # seconds
   self.percent_usage = 0.99 # percent of RAM to use
-  self.rolling_restart_frequency = 6 * 3600
+  self.rolling_restart_frequency = 6 * 3600 # 6 hours in seconds
+  self.reaper_status_logs = true
+  self.pre_term = nil
+  self.rolling_pre_term = nil
+  self.on_calculation = nil
 
   def config
     yield self
   end
 
-  def reaper(ram = self.ram, percent = self.percent_usage)
-    Reaper.new(ram * percent_usage)
+  def reaper(ram = self.ram, percent_usage = self.percent_usage, reaper_status_logs = self.reaper_status_logs, pre_term = self.pre_term, on_calculation = self.on_calculation)
+    Reaper.new(ram * percent_usage, nil, reaper_status_logs, pre_term, on_calculation)
   end
 
   def start(frequency = self.frequency, reaper = self.reaper)
@@ -22,9 +30,9 @@ module PumaWorkerKiller
     enable_rolling_restart(rolling_restart_frequency) if rolling_restart_frequency
   end
 
-  def enable_rolling_restart(frequency = self.rolling_restart_frequency)
-    frequency = frequency + rand(0..10.0) # so all workers don't restart at the exact same time across multiple machines
-    AutoReap.new(frequency, RollingRestart.new).start
+  def enable_rolling_restart(frequency = rolling_restart_frequency)
+    frequency += rand(0..10.0) # so all workers don't restart at the exact same time across multiple machines
+    AutoReap.new(frequency, RollingRestart.new(nil, rolling_pre_term)).start
   end
 end
 

data/lib/puma_worker_killer/auto_reap.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PumaWorkerKiller
   class AutoReap
     def initialize(timeout, reaper = Reaper.new)
@@ -11,11 +13,10 @@ module PumaWorkerKiller
 
       Thread.new do
         while @running
-          @reaper.reap
           sleep @timeout
+          @reaper.reap
         end
       end
     end
-
   end
 end

data/lib/puma_worker_killer/puma_memory.rb

@@ -1,21 +1,28 @@
+# frozen_string_literal: true
+
 module PumaWorkerKiller
   class PumaMemory
     def initialize(master = nil)
       @master  = master || get_master
+      @workers = nil
     end
 
-    def master
-      @master
-    end
+    attr_reader :master
 
     def size
       workers.size
     end
 
+    def term_worker(worker)
+      worker.term
+    end
+
     def term_largest_worker
       largest_worker.term
-    #   Process.wait(largest_worker.pid)
-    # rescue Errno::ECHILD
+    end
+
+    def workers_stopped?
+      !running?
     end
 
     def running?
@@ -23,7 +30,7 @@ module PumaWorkerKiller
     end
 
     def smallest_worker
-      smallest, _ = workers.to_a.first
+      smallest, = workers.to_a.first
       smallest
     end
 
@@ -33,7 +40,7 @@ module PumaWorkerKiller
     end
 
     def largest_worker
-      largest_worker, _ = workers.to_a.last
+      largest_worker, = workers.to_a.last
       largest_worker
     end
 
@@ -45,10 +52,10 @@ module PumaWorkerKiller
     # Will refresh @workers
     def get_total(workers = set_workers)
       master_memory = GetProcessMem.new(Process.pid).mb
-      worker_memory = workers.map {|_, mem| mem }.inject(&:+) || 0
+      worker_memory = workers.values.inject(:+) || 0
       worker_memory + master_memory
     end
-    alias :get_total_memory :get_total
+    alias get_total_memory get_total
 
     def workers
       @workers || set_workers
@@ -64,14 +71,14 @@ module PumaWorkerKiller
     # sorted by memory ascending (smallest first, largest last)
     def set_workers
       workers = {}
-      @master.instance_variable_get("@workers").each do |worker|
+      @master.instance_variable_get('@workers').each do |worker|
         workers[worker] = GetProcessMem.new(worker.pid).mb
       end
       if workers.any?
-        @workers = Hash[ workers.sort_by {|_, mem| mem } ]
+        @workers = Hash[workers.sort_by { |_, mem| mem }]
       else
         {}
       end
     end
   end
-end
+end

data/lib/puma_worker_killer/reaper.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 module PumaWorkerKiller
   class Reaper
-    def initialize(max_ram, master = nil)
+    def initialize(max_ram, master = nil, reaper_status_logs = true, pre_term = nil, on_calculation = nil)
       @cluster = PumaWorkerKiller::PumaMemory.new(master)
       @max_ram = max_ram
+      @reaper_status_logs = reaper_status_logs
+      @pre_term = pre_term
+      @on_calculation = on_calculation
     end
 
     # used for tes
@@ -11,12 +16,27 @@ module PumaWorkerKiller
     end
 
     def reap
-      return false unless @cluster.running?
-      if (total = get_total_memory) > @max_ram
-        @cluster.master.log "PumaWorkerKiller: Out of memory. #{@cluster.workers.count} workers consuming total: #{total} mb out of max: #{@max_ram} mb. Sending TERM to #{@cluster.largest_worker.inspect} consuming #{@cluster.largest_worker_memory} mb."
-        @cluster.term_largest_worker
-      else
-        @cluster.master.log "PumaWorkerKiller: Consuming #{total} mb with master and #{@cluster.workers.count} workers"
+      return false if @cluster.workers_stopped?
+
+      total = get_total_memory
+      @on_calculation&.call(total)
+
+      if total > @max_ram
+        @cluster.master.log "PumaWorkerKiller: Out of memory. #{@cluster.workers.count} workers consuming total: #{total} mb out of max: #{@max_ram} mb. Sending TERM to pid #{@cluster.largest_worker.pid} consuming #{@cluster.largest_worker_memory} mb."
+
+        # Fetch the largest_worker so that both `@pre_term` and `term_worker` are called with the same worker
+        # Avoids a race condition where:
+        #   Worker A consume 100 mb memory
+        #   Worker B consume 99 mb memory
+        #   pre_term gets called with Worker A
+        #   A new request comes in, Worker B takes it, and consumes 101 mb memory
+        #   term_largest_worker (previously here) gets called and terms Worker B (thus not passing the about-to-be-terminated worker to `@pre_term`)
+        largest_worker = @cluster.largest_worker
+        @pre_term&.call(largest_worker)
+        @cluster.term_worker(largest_worker)
+
+      elsif @reaper_status_logs
+        @cluster.master.log "PumaWorkerKiller: Consuming #{total} mb with master and #{@cluster.workers.count} workers."
       end
     end
   end

data/lib/puma_worker_killer/rolling_restart.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module PumaWorkerKiller
   class RollingRestart
-    def initialize(master = nil)
+    def initialize(master = nil, rolling_pre_term = nil)
       @cluster = PumaWorkerKiller::PumaMemory.new(master)
+      @rolling_pre_term = rolling_pre_term
     end
 
     # used for tes
@@ -9,12 +12,17 @@ module PumaWorkerKiller
       @cluster.get_total_memory
     end
 
-    def reap(wait_between_worker_kill = 60) # seconds
+    def reap(seconds_between_worker_kill = 60)
+      # this will implicitly call set_workers
+      total_memory = get_total_memory
       return false unless @cluster.running?
-      @cluster.workers.each do |worker, ram|
-        @cluster.master.log "PumaWorkerKiller: Rolling Restart. #{@cluster.workers.count} workers consuming total: #{ get_total_memory } mb out of max: #{@max_ram} mb. Sending TERM to #{worker.inspect}"
+
+      @cluster.workers.each do |worker, _ram|
+        @cluster.master.log "PumaWorkerKiller: Rolling Restart. #{@cluster.workers.count} workers consuming total: #{total_memory} mb. Sending TERM to pid #{worker.pid}."
+        @rolling_pre_term&.call(worker)
+
         worker.term
-        sleep wait_between_worker_kill
+        sleep seconds_between_worker_kill
       end
     end
   end

data/lib/puma_worker_killer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PumaWorkerKiller
-  VERSION = "0.0.5"
+  VERSION = '0.2.0'
 end

data/puma_worker_killer.gemspec

@@ -1,27 +1,28 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'puma_worker_killer/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "puma_worker_killer"
+  gem.name          = 'puma_worker_killer'
   gem.version       = PumaWorkerKiller::VERSION
-  gem.authors       = ["Richard Schneeman"]
-  gem.email         = ["richard.schneeman+rubygems@gmail.com"]
-  gem.description   = %q{ Kills pumas, the code kind }
-  gem.summary       = %q{ If you have a memory leak in your web code puma_worker_killer can keep it in check. }
-  gem.homepage      = "https://github.com/schneems/puma_worker_killer"
-  gem.license       = "MIT"
+  gem.authors       = ['Richard Schneeman']
+  gem.email         = ['richard.schneeman+rubygems@gmail.com']
+  gem.description   = ' Kills pumas, the code kind '
+  gem.summary       = ' If you have a memory leak in your web code puma_worker_killer can keep it in check. '
+  gem.homepage      = 'https://github.com/schneems/puma_worker_killer'
+  gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_dependency "puma",              ">= 2.7", "< 4"
-  gem.add_dependency "get_process_mem",   "~>  0.2"
-  gem.add_development_dependency "rack", "~> 1.6"
-  gem.add_development_dependency "rake",  "~> 10.1"
-  gem.add_development_dependency "test-unit",  ">= 0"
+  gem.require_paths = ['lib']
 
+  gem.add_dependency 'get_process_mem',   '~>  0.2'
+  gem.add_dependency 'puma',              '>= 2.7', '< 5'
+  gem.add_development_dependency 'rack', '~> 1.6'
+  gem.add_development_dependency 'rake', '~> 10.1'
+  gem.add_development_dependency 'test-unit', '>= 0'
+  gem.add_development_dependency 'wait_for_it', '~> 0.1'
 end

data/test/fixtures/big.ru

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+load File.expand_path('fixture_helper.rb', __dir__)
+
+PumaWorkerKiller.start
+
+@memory = []
+10_000.times.each do
+  @memory << SecureRandom.hex
+end
+
+run HelloWorldApp

data/test/fixtures/config/puma_worker_killer_start.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+load File.expand_path('../fixture_helper.rb', __dir__)
+
+before_fork do
+  require 'puma_worker_killer'
+  PumaWorkerKiller.start
+end

data/test/fixtures/default.ru

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+load File.expand_path('fixture_helper.rb', __dir__)
+
+PumaWorkerKiller.start
+
+run HelloWorldApp

data/test/fixtures/{app.ru → fixture_helper.rb}

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
 require 'rack'
 require 'rack/server'
 
@@ -7,21 +11,17 @@ PumaWorkerKiller.config do |config|
   config.ram       = Integer(ENV['PUMA_RAM'])       if ENV['PUMA_RAM']
   config.frequency = Integer(ENV['PUMA_FREQUENCY']) if ENV['PUMA_FREQUENCY']
 end
-PumaWorkerKiller.start
-
 
 puts "Frequency: #{PumaWorkerKiller.frequency}" if ENV['PUMA_FREQUENCY']
 
 class HelloWorld
-  def response
+  def response(_env)
     [200, {}, ['Hello World']]
   end
 end
 
 class HelloWorldApp
   def self.call(env)
-    HelloWorld.new.response
+    HelloWorld.new.response(env)
   end
 end
-
-run HelloWorldApp

data/test/fixtures/on_calculation.ru

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+load File.expand_path('fixture_helper.rb', __dir__)
+
+PumaWorkerKiller.config do |config|
+  config.on_calculation = ->(usage) { puts("Current memory footprint: #{usage} mb") }
+end
+PumaWorkerKiller.start
+
+run HelloWorldApp

data/test/fixtures/pre_term.ru

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+load File.expand_path('fixture_helper.rb', __dir__)
+
+PumaWorkerKiller.config do |config|
+  config.pre_term = ->(worker) { puts("About to terminate worker: #{worker.inspect}") }
+end
+PumaWorkerKiller.start
+
+run HelloWorldApp

data/test/fixtures/rolling_pre_term.ru

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+load File.expand_path('fixture_helper.rb', __dir__)
+
+PumaWorkerKiller.config do |config|
+  config.rolling_pre_term = ->(worker) { puts("About to terminate (rolling) worker: #{worker.pid}") }
+end
+PumaWorkerKiller.enable_rolling_restart(1) # 1 second
+
+run HelloWorldApp

data/test/fixtures/rolling_restart.ru

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+load File.expand_path('fixture_helper.rb', __dir__)
+
+PumaWorkerKiller.enable_rolling_restart(1) # 1 second
+
+run HelloWorldApp

data/test/puma_worker_killer_test.rb

@@ -1,77 +1,104 @@
+# frozen_string_literal: true
+
 require 'test_helper'
 
 class PumaWorkerKillerTest < Test::Unit::TestCase
-
   def test_starts
-    app_path = fixture_path.join("app.ru")
     port     = 0 # http://stackoverflow.com/questions/200484/how-do-you-find-a-free-tcp-server-port-using-ruby
-    puma_log = Pathname.new "#{ SecureRandom.hex }-puma.log"
-    pid  = Process.spawn("PUMA_FREQUENCY=1 bundle exec puma #{ app_path } -t 1:1 -w 5 --preload --debug -p #{ port } > #{puma_log}")
-    sleep 5
-    assert_match "PumaWorkerKiller:", puma_log.read
-  ensure
-    puma_log.delete
-    Process.kill('TERM', pid) if pid
-  end
+    command  = "bundle exec puma #{fixture_path.join("default.ru")} -t 1:1 -w 2 --preload --debug -p #{port}"
+    options  = { wait_for: 'booted', timeout: 5, env: { 'PUMA_FREQUENCY' => 1 } }
 
-  def test_worker_reaped
-    ram      = 1 #mb
-    cluster = FakeCluster.new
-    reaper   = PumaWorkerKiller::Reaper.new(ram, cluster)
-    worker_count = 10
-    worker_count.times { cluster.add_worker }
+    WaitForIt.new(command, options) do |spawn|
+      assert_contains(spawn, 'PumaWorkerKiller')
+    end
+  end
 
-    assert_equal worker_count, cluster.workers.count
-    refute cluster.workers.detect {|w| w.is_term? }
+  def test_without_preload
+    port     = 0 # http://stackoverflow.com/questions/200484/how-do-you-find-a-free-tcp-server-port-using-ruby
+    command  = "bundle exec puma #{fixture_path.join("default.ru")} -t 1:1 -w 2 --debug -p #{port} -C #{fixture_path.join("config/puma_worker_killer_start.rb")}"
+    options  = { wait_for: 'booted', timeout: 10, env: { 'PUMA_FREQUENCY' => 1 } }
 
-    reaper.reap
-    assert_equal 1, cluster.workers.select {|w| w.is_term? }.count
+    WaitForIt.new(command, options) do |spawn|
+      assert_contains(spawn, 'PumaWorkerKiller')
+    end
+  end
 
-    reaper.reap
-    assert_equal 2, cluster.workers.select {|w| w.is_term? }.count
+  def test_kills_large_app
+    file     = fixture_path.join('big.ru')
+    port     = 0
+    command  = "bundle exec puma #{file} -t 1:1 -w 2 --preload --debug -p #{port}"
+    options  = { wait_for: 'booted', timeout: 5, env: { 'PUMA_FREQUENCY' => 1, 'PUMA_RAM' => 1 } }
 
-    reaper.reap
-    assert_equal 3, cluster.workers.select {|w| w.is_term? }.count
-  ensure
-    cluster.workers.map(&:term)
+    WaitForIt.new(command, options) do |spawn|
+      assert_contains(spawn, 'Out of memory')
+    end
   end
 
-  def test_kills_memory_leak
-    ram     = rand(75..100) #mb
-    cluster = FakeCluster.new
-    reaper  = PumaWorkerKiller::Reaper.new(ram, cluster)
-    while reaper.get_total_memory < (ram * 0.80)
-      cluster.add_worker
-      sleep 0.01
+  def test_pre_term
+    file     = fixture_path.join('pre_term.ru')
+    port     = 0
+    command  = "bundle exec puma #{file} -t 1:1 -w 2 --preload --debug -p #{port}"
+    options  = { wait_for: 'booted', timeout: 5, env: { 'PUMA_FREQUENCY' => 1, 'PUMA_RAM' => 1 } }
+
+    WaitForIt.new(command, options) do |spawn|
+      assert_contains(spawn, 'Out of memory')
+      assert_contains(spawn, 'About to terminate worker:') # defined in pre_term.ru
     end
+  end
 
-    reaper.reap
-    assert_equal 0, cluster.workers.select {|w| w.is_term? }.count
+  def test_on_calculation
+    file     = fixture_path.join('on_calculation.ru')
+    port     = 0
+    command  = "bundle exec puma #{file} -t 1:1 -w 2 --preload --debug -p #{port}"
+    options  = { wait_for: 'booted', timeout: 5, env: { 'PUMA_FREQUENCY' => 1, 'PUMA_RAM' => 1 } }
 
-    until reaper.get_total_memory > ram
-      cluster.add_worker
-      sleep 0.01
+    WaitForIt.new(command, options) do |spawn|
+      assert_contains(spawn, 'Out of memory')
+      assert_contains(spawn, 'Current memory footprint:') # defined in on_calculate.ru
     end
-
-    reaper.reap
-    assert_equal 1, cluster.workers.select {|w| w.is_term? }.count
-  ensure
-    cluster.workers.map(&:term)
   end
 
+  def assert_contains(spawn, string)
+    assert spawn.wait(string), "Expected logs to contain '#{string}' but it did not, contents: #{spawn.log.read}"
+  end
 
   def test_rolling_restart
-    ram     = rand(75..100) #mb
-    cluster = FakeCluster.new
-    cluster.add_worker
+    file     = fixture_path.join('rolling_restart.ru')
+    port     = 0
+    command  = "bundle exec puma #{file} -t 1:1 -w 2 --preload --debug -p #{port}"
+    puts command.inspect
+    options = { wait_for: 'booted', timeout: 15, env: {} }
+
+    WaitForIt.new(command, options) do |spawn|
+      assert_contains(spawn, 'Rolling Restart')
+    end
+  end
 
-    worker = cluster.workers.first
-    reaper = PumaWorkerKiller::RollingRestart.new(cluster)
-    reaper.reap(1)
+  def test_rolling_restart_worker_kill_check
+    file     = fixture_path.join('rolling_restart.ru')
+    port     = 0
+    command  = "bundle exec puma #{file} -t 1:1 -w 1 --preload --debug -p #{port}"
+    puts command.inspect
+    options = { wait_for: 'booted', timeout: 120, env: {} }
+
+    WaitForIt.new(command, options) do |spawn|
+      # at least 2 matches for TERM (so we set a timeout value longer - 120sec)
+      spawn.wait!(/TERM.*TERM/m)
+      term_ids = spawn.log.read.scan(/TERM to pid (\d*)/)
+      assert term_ids.sort == term_ids.uniq.sort
+    end
+  end
+
+  def test_rolling_pre_term
+    file     = fixture_path.join('rolling_pre_term.ru')
+    port     = 0
+    command  = "bundle exec puma #{file} -t 1:1 -w 2 --preload --debug -p #{port}"
+    puts command.inspect
+    options = { wait_for: 'booted', timeout: 15, env: {} }
 
-    assert_equal 1, cluster.workers.select {|w| w.is_term? }.count
-  ensure
-    cluster.workers.map(&:term)
+    WaitForIt.new(command, options) do |spawn|
+      assert_contains(spawn, 'Rolling Restart')
+      assert_contains(spawn, 'About to terminate (rolling) worker:') # defined in rolling_pre_term.ru
+    end
   end
 end
-

data/test/test_helper.rb

@@ -1,71 +1,11 @@
+# frozen_string_literal: true
+
 Bundler.require
 
 require 'puma_worker_killer'
 require 'test/unit'
+require 'wait_for_it'
 
 def fixture_path
-  Pathname.new(File.expand_path("../fixtures", __FILE__))
-end
-
-# Mock object stand in for Puma::Cluster
-class FakeCluster
-  def initialize
-    @workers = []
-  end
-
-  def wakeup!
-  end
-
-  class Worker
-    attr_accessor :pid
-
-    def initialize(pid)
-      @pid = pid
-    end
-
-    def memory_leak
-      while true
-
-      end
-    end
-
-    # not public interface, used for testing
-    def is_term?
-      @first_term_sent
-    end
-
-    def term
-      begin
-        if @first_term_sent && (Time.new - @first_term_sent) > 30
-          @signal = "KILL"
-        else
-          @first_term_sent ||= Time.new
-        end
-
-        Process.kill "TERM", @pid
-        Process.wait(@pid)
-      rescue Errno::ESRCH, Errno::ECHILD
-      end
-    end
-  end
-
-  def log(msg)
-    puts msg
-  end
-
-  def do_work
-    while true
-      sleep 1
-    end
-  end
-
-  # not a public interface, added to make testing easier
-  def workers
-    @workers
-  end
-
-  def add_worker
-    pid = fork { do_work }
-    @workers << Worker.new(pid)
-  end
+  Pathname.new(File.expand_path('fixtures', __dir__))
 end

metadata

@@ -1,49 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: puma_worker_killer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Schneeman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: puma
+  name: get_process_mem
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.7'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.7'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: get_process_mem
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: wait_for_it
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: " Kills pumas, the code kind "
 email:
 - richard.schneeman+rubygems@gmail.com
@@ -93,7 +107,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/check_changelog.yml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -106,14 +123,21 @@ files:
 - lib/puma_worker_killer/rolling_restart.rb
 - lib/puma_worker_killer/version.rb
 - puma_worker_killer.gemspec
-- test/fixtures/app.ru
+- test/fixtures/big.ru
+- test/fixtures/config/puma_worker_killer_start.rb
+- test/fixtures/default.ru
+- test/fixtures/fixture_helper.rb
+- test/fixtures/on_calculation.ru
+- test/fixtures/pre_term.ru
+- test/fixtures/rolling_pre_term.ru
+- test/fixtures/rolling_restart.ru
 - test/puma_worker_killer_test.rb
 - test/test_helper.rb
 homepage: https://github.com/schneems/puma_worker_killer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,13 +152,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: If you have a memory leak in your web code puma_worker_killer can keep it
   in check.
 test_files:
-- test/fixtures/app.ru
+- test/fixtures/big.ru
+- test/fixtures/config/puma_worker_killer_start.rb
+- test/fixtures/default.ru
+- test/fixtures/fixture_helper.rb
+- test/fixtures/on_calculation.ru
+- test/fixtures/pre_term.ru
+- test/fixtures/rolling_pre_term.ru
+- test/fixtures/rolling_restart.ru
 - test/puma_worker_killer_test.rb
 - test/test_helper.rb