runaway 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee88a2e47d1bf2847893a4b258d236efcfff3fae
-  data.tar.gz: f3edef5cc5fae9363f1d56978c0465b56faa0a24
+  metadata.gz: 8140c09b38d805e869821a9e25fcc4807de4931f
+  data.tar.gz: 44fe561135e1fb3b8abb21094f20fc2435ecdea4
 SHA512:
-  metadata.gz: 0489708f0657aeb6e7b91c7f23e2007974d22577afe01b9c04b2dca6d12a9fcdbdf68cdbb965b75970351333eab45ec6a1599f3d34a3727abda9f8daa47ab248
-  data.tar.gz: 34eeca38ad28dfb7b205a40b9517f3b3123683a9fdd466031b848bd1780f9b67e1b477c3a1d10104b412b36ee80df21c33e1ab2dfcf5af799e0b0f86963d3ede
+  metadata.gz: d46f84a99dd4e7e84ccab8779c67e67264bd6bb4e35ce56d3418d0115d0e9617001faabe1224b5ed26455c7d3e14777fb8982b487c95e64579b780ccedc82180
+  data.tar.gz: 8dd7da8f9d6f8fc92c886d68d4b2c6be7bb8f785140ef82f215d47751465100baaa009a69d2542d1529b2a14af2de258d55ed2bf5b738dccc51f917ddff6e0e6

data/README.md

@@ -1,18 +1,9 @@
 # runaway
 
-Spin off work into child processes and terminate it on time
+Spin off work into child processes and terminate it on time. If you need the process to be done
+within a certain time period (and if it takes longer it probably is hanging):
 
-To simply ensure the process keeps responding (the Ruby runtime still can do context-switching
-and can respond to Unix signals):
-
-    Runaway.spin do
-      ActiveRAMGobbler.load_many_things(num_things: 10_000_000)
-    end
-
-If you need the process to be done within a certain time period (and if it takes longer
-it probably is hanging):
-
-    Runaway.spin(must_quite_within: 15) do # ensures termination within 15 seconds
+    Runaway.spin(must_quit_within: 15) do # ensures termination within 15 seconds
       `/bin/proprietary_render_server/bin/render --put-server-on-fire=yes`
     end
 

data/lib/runaway.rb

@@ -1,14 +1,10 @@
-require 'securerandom'
-
 module Runaway
-  VERSION = '1.0.1'
+  VERSION = '2.0.0'
   
   UncleanExit = Class.new(StandardError)
   Child = Class.new(StandardError)
-  HeartbeatTimeout = Class.new(Child)
   RuntimeExceeded = Class.new(Child)
   
-  DEFAULT_HEARTBEAT_INTERVAL = 2
   TERM = 'TERM'.freeze
   KILL = 'KILL'.freeze
   USR2 = 'USR2'.freeze
@@ -18,20 +14,12 @@ module Runaway
   # Acts as a substitute for a Logger
   module NullLogger; def self.warn(*); end; end
   
-  def self.spin(must_quit_within: INF, heartbeat_interval: DEFAULT_HEARTBEAT_INTERVAL, 
-    logger: NullLogger, &block_to_run_in_child)
-    cookie = SecureRandom.hex(1)
-    r, w = IO.pipe
+  def self.spin(must_quit_within: INF, logger: NullLogger, &block_to_run_in_child)
     child_pid = fork do
-      r.close_read
       # Remove anything that was there from the parent
-      [USR2, TERM, KILL].each { |reset_sig| trap(reset_sig, DEFAULT) }
-      
-      # When the parent asks us for a heartbeat, send the cookie back
-      trap(USR2) { w.write(cookie); w.flush }
+      [TERM, KILL].each { |reset_sig| trap(reset_sig, DEFAULT) }
       block_to_run_in_child.call
     end
-    w.close_write
     
     started_at = Time.now
     
@@ -49,10 +37,9 @@ module Runaway
       (Process.kill(sig, child_pid) rescue Errno::ESRCH) if !has_quit
     }
     
-    last_heartbeat_sent = started_at
     begin
       loop do
-        sleep 0.5
+        sleep 1
         
         break if has_quit
         
@@ -62,22 +49,6 @@ module Runaway
           raise RuntimeExceeded.new('%d did not terminate after %d secs (limited to %d secs)' % [
             child_pid, running_for, must_quit_within])
         end
-        
-        # Then check if it is time to poke it with a heartbeat
-        at = Time.now
-        next if (at - last_heartbeat_sent) < heartbeat_interval
-        last_heartbeat_sent = at
-        
-        # Then send it the USR2 as a "ping", and expect a "pong" in
-        # the form of a pipe write. If the pipe is still not readable
-        # after a certain time, we assume the process has hung.
-        Process.kill(USR2, child_pid)
-        select_timeout = (heartbeat_interval * 2)
-        ready_read = IO.select([r], [], [], select_timeout)
-        if ready_read.nil?
-          raise HeartbeatTimeout.new('%d did not reply to heartbeat after %d secs' % [child_pid, select_timeout])
-        end
-        r.read(cookie.bytesize)
       end
     rescue Runaway => terminating_error
       logger.error "Terminating %d - %s: %s" % [child_pid, terminating_error.class, terminating_error.message]
@@ -97,7 +68,5 @@ module Runaway
     raise unclean_exit_error if unclean_exit_error
     
     :done
-  ensure
-    r.close_read
   end
 end

data/runaway.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: runaway 1.0.1 ruby lib
+# stub: runaway 2.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "runaway"
-  s.version = "1.0.1"
+  s.version = "2.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2016-03-01"
+  s.date = "2016-04-07"
   s.description = "Spin off blocks in child processes and make sure they terminate on time"
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [

data/spec/runaway_spec.rb

@@ -5,7 +5,7 @@ describe "Runaway" do
   
   it 'supports all the options' do
     require 'logger'
-    Runaway.spin(must_quit_within: 2, heartbeat_interval: 0.3, logger: Logger.new($stdout)) {} # just do nothing
+    Runaway.spin(must_quit_within: 2, logger: Logger.new($stdout)) {} # just do nothing
   end
   
   context 'with a process that quits cleanly' do
@@ -42,28 +42,4 @@ describe "Runaway" do
       }
     end
   end
-  
-  context 'when a process terminates before the first heartbeat has to be dispatched' do
-    it 'just returns :done' do
-      t = Time.now
-      return_token = Runaway.spin(heartbeat_interval: 5) { sleep 0.1 }
-      expect(return_token).to eq(:done)
-      delta = Time.now - t
-      expect(delta).to be < 2
-    end
-  end
-  
-  context 'when a process stops responding to heartbeats' do
-    it 'kills it quickly and raises an error' do
-      t = Time.now
-      expect {
-        # Delete, then override the USR2 trap so that heartbeats do not get handled at all
-        Runaway.spin(heartbeat_interval: 0.8) { trap('USR2', 'DEFAULT'); trap('USR2') {}; sleep 45 }
-      }.to raise_error {|err|
-        expect(err).to be_kind_of(Runaway::HeartbeatTimeout)
-        expect(err.message).to match(/\d+ did not reply to heartbeat after \d+ secs/)
-        expect(Time.now - t).to be < 5 # should really ahve killed it fast
-      }
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runaway
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-01 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec