exceptional_fork 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c0f186b58e704eeda7fe96b5fe617927fe9e64e
-  data.tar.gz: b44013381bb2431a0d984ac5e9e937385cb65985
+  metadata.gz: 6ab22c22f6a3441848a352c6dc0ae33b899e9d9c
+  data.tar.gz: 83c5ce7dd6da50a819974df9ced0dbd57a8127e4
 SHA512:
-  metadata.gz: 1169303635307088336f99794328231245f870013ecf7eb138fe9dd1fb32f197c85e8df1ad1107c1831120a222cfbd8d38cbbd156c3ed4d48c4fdff34c7046e3
-  data.tar.gz: 15431a14f4ba784cafdb27940709eb03e4280c86c5d06ce01c83e61dae823f7d97a2390114a7b80fe11dd1b31f71a524c477a198e22d12cbe35e248d61f13d48
+  metadata.gz: 8e26f513d002378e533be2cba1e0221fc0d174782351f0b9e7e23921f09f6d183962d9d7aff4a08376f358e6179094d87de14c7cf89ffdec23d2146c967d8892
+  data.tar.gz: d8ae3caa7edc189dd4103729c466bfd704bedb4052355294c2b5acf1c8e3ef3b36599e7f0a94f4c25400834ffceb48b6d8fe7c1d9ef667e691a1801198a497be

data/Gemfile

@@ -1,12 +1,7 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.14"
+  gem "rspec", "~> 3.2"
   gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.0"
   gem "jeweler", "~> 2.0.1"

data/exceptional_fork.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: exceptional_fork 1.1.0 ruby lib
+# stub: exceptional_fork 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "exceptional_fork"
-  s.version = "1.1.0"
+  s.version = "1.2.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 = "2015-12-15"
+  s.date = "2016-09-21"
   s.description = " Uses pipes to re-raise exceptions. Something better than an exit code has to exist. "
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
@@ -32,27 +32,27 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/julik/exceptional_fork"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.5.1"
   s.summary = "Raise exceptions from the forked child process in the parent"
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.2"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_dependency(%q<rspec>, ["~> 3.2"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_dependency(%q<simplecov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, ["~> 2.14"])
+    s.add_dependency(%q<rspec>, ["~> 3.2"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 2.0.1"])

data/lib/exceptional_fork.rb

@@ -1,7 +1,9 @@
 module ExceptionalFork
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
   QUIT = "The child process %d has quit or was killed abruptly. No error information could be retrieved".freeze
   ProcessHung = Class.new(StandardError)
+  DEFAULT_TIMEOUT = 10
+  DEFAULT_ERROR_STATUS = 99
   
   # Fork with a block and wait until the forked child exits.
   # Any exceptions raised within the block will be re-raised from this
@@ -18,7 +20,14 @@ module ExceptionalFork
   #
   # It is not guaranteed that all the exception metadata will be reinstated due to
   # marshaling/unmarshaling mechanics, but it helps debugging nevertheless.
-  def fork_and_wait
+  #
+  # By default, the child process will be expected to complete within DEFAULT_TIMEOUT seconds
+  # (scientifically chosen by an Arbitraryometer-Of-Random-Assumptions). If you need to adjust
+  # the timeout, pass a different number as the timeout argument. The timeout is going to be
+  # excercised using wait2() with the WNOHANG option, so no threads are going to be used and
+  # the wait is not going to be blocking. ExceptionFork is going to do a `Thread.pass` to let
+  # other threads do work while it waits on the process to complete.
+  def fork_and_wait(kill_after_timeout = DEFAULT_TIMEOUT)
     # Redirect the exceptions in the child to the pipe. When we get a non-zero
     # exit code we can read from that pipe to obtain the exception.
     reader, writer = IO.pipe
@@ -26,16 +35,16 @@ module ExceptionalFork
     # Run the block in a forked child
     pid = fork_with_error_output(writer) { yield }
   
-    # Wait for the forked process to exit
-    Process.wait(pid)
+    # Wait for the forked process to exit, in a non-blocking fashion
+    exit_code = wait_and_capture(pid, kill_after_timeout)
   
     writer.close rescue IOError # Close the writer so that we can read from the reader
     child_error = reader.read # Read the error output
     reader.close rescue IOError # Do not leak pipes since the process might be long-lived
   
-    if $?.exitstatus != 0 # If the process exited uncleanly capture the error
-      # If the child gets kill -9d then no exception gets written, and no information
-      # gets recovered.
+    if exit_code.nonzero? # If the process exited uncleanly capture the error
+      # If the child gets KILLed then no exception gets written,
+      # and no information gets recovered.
       raise ProcessHung.new(QUIT % pid) if (child_error.nil? || child_error.empty?)
       
       unmarshaled_error, backtrace_in_child = Marshal.load(child_error)
@@ -66,6 +75,7 @@ module ExceptionalFork
         errors_pipe.puts(Marshal.dump(error_payload))
         errors_pipe.flush
       ensure
+        errors_pipe.close rescue nil
         Process.exit! success # Exit maintaining the status code
       end
     end
@@ -74,5 +84,41 @@ module ExceptionalFork
     pid
   end
   
+  # Wait for a process to quit in a non-blocking fashion, using a
+  # preset timeout, and collect (or synthesize) it's exit code value afterwards
+  def wait_and_capture(pid, timeout)
+    started_waiting_at = Time.now
+    status = nil
+    signals = [:TERM, :KILL]
+    loop do
+      # Use wait2 to recover the status without the global variable (we might
+      # be threaded), use WNOHANG so that we do not have to block while waiting
+      # for the process to complete. If we block (without WNOHANG), MRI will still
+      # be able to do other work _but_ we might be waiting indefinitely. If we use
+      # a non-blocking option we can supply a timeout and force-quit the process
+      # without using the Timeout module (and conversely having an overhead of 1
+      # watcher thread per child spawned) 
+      if wait_res = Process.wait2(pid, Process::WNOHANG)
+        _, status = wait_res
+        return status.exitstatus || DEFAULT_ERROR_STATUS
+      else
+        # If the process is still busy and didn't quit,
+        # we have to undertake Measures. Send progressively
+        # harsher signals to the child
+        Process.kill(signals.shift, pid) if (Time.now - started_waiting_at) > timeout
+        if signals.empty? # If we exhausted our force-quit powers, do a blocking wait. KILL _will_ work.
+          _, status = Process.wait2(pid)
+          return status.exitstatus || DEFAULT_ERROR_STATUS # For killed processes this will be nil
+        end
+      end
+      Thread.pass
+    end
+  rescue Errno::ECHILD, Errno::ESRCH, Errno::EPERM => e# The child already quit
+    # Assume the process finished correctly. If there was an error, we will discover
+    # that from a zero-size output file. There may of course be a thing where the
+    # file gets written incompletely and the child crashes but hey - computers!
+    return 0
+  end
+  
   extend self
 end

data/spec/exceptional_fork_spec.rb

@@ -17,6 +17,20 @@ describe "ExceptionalFork" do
     end
   end
   
+  it 'raises a simple exception upfront' do
+    expect(Process).to receive(:fork).and_call_original
+    expect {
+      ExceptionalFork.fork_and_wait { raise "Explosion! "}
+    }.to raise_error(/Explosion/)
+  end
+  
+  it "kills a process that takes too long to terminate" do
+    expect(Process).to receive(:fork).and_call_original
+    expect {
+      ExceptionalFork.fork_and_wait(1) { sleep 5; raise "Should never ever get here" }
+    }.to raise_error(ExceptionalFork::ProcessHung)
+  end
+  
   it "raises a ProcessHung if no exception information can be recovered" do
     expect(Process).to receive(:fork).and_call_original
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exceptional_fork
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2016-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Raise exceptions from the forked child process in the parent