async-container 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1b28eaf57dab7a59a62f755fcedf993c1e666e11308bbc2bbf1504d6e43d7a5
-  data.tar.gz: 8e80d9fadf1491d7e8b6ff1827c27d72f5d4ba120f6afbccf021c760c63d4f34
+  metadata.gz: 4f6640daaa86e57d05f5c7ec2a0d25d98b355edb0926d45ba1e2414adfdaa46e
+  data.tar.gz: fd25c58be73c64bf64dec42ac24e84b9f5c66fdb26da9780246c877bd38056f5
 SHA512:
-  metadata.gz: 262d775565084f15cab838bdc72ce84581f8f4ee879e3a003a75c163479ac62a172736956c56a9d5524eefb80194d3aa3aed4b6239f6ddbeaea91713d8572f22
-  data.tar.gz: 143eec3c82a23f3b804784850556e5a3b8dd455608a0f3b98ace66583a024a6c5e20819a129ed17121d04bc849bfe42573b5405331f4ef7f360254c0588b4434
+  metadata.gz: e6011d00efba48db1d17fedf7fe9823210c58840611a140710be8ce88a55e39b5421bebf666d97a4741f5c97c1f16758f6bc7598fd4205ffb0b2c975173e496f
+  data.tar.gz: d0c020e874296fc31abdd6638d7113ddb0ff7e718e142c9c8c77b40ad7874e848a78b9e351e45f9439421d1629d58cb20fe086d3966d07345c3cb46fe9a517a3

data/.travis.yml

@@ -17,6 +17,5 @@ matrix:
       env: JRUBY_OPTS="--debug -X+O"
     - rvm: ruby-head
   allow_failures:
-    - rvm: truffleruby
     - rvm: ruby-head
     - rvm: jruby-head

data/async-container.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 	spec.add_runtime_dependency "process-group"
 	
 	spec.add_runtime_dependency "async", "~> 1.0"
-	spec.add_runtime_dependency "async-io", "~> 1.4"
+	spec.add_runtime_dependency "async-io", "~> 1.26"
 	
 	spec.add_development_dependency "async-rspec", "~> 1.1"
 	

data/examples/container.rb

@@ -1,21 +1,32 @@
 #!/usr/bin/env ruby
 
-require 'async/container/forked'
+require '../lib/async/container/controller'
+require '../lib/async/container/forked'
 
-container = Async::Container::Forked.new
+Async.logger.debug!
 
-puts "Controller process: #{Process.pid}"
+Async.logger.debug(self, "Starting up...")
 
-container.run(processes: 8, restart: true) do
-	puts "Starting process: #{Process.pid}"
-	
-	while true
-		sleep 1
+controller = Async::Container::Controller.new do |container|
+	Async.logger.debug(self, "Setting up container...")
+
+	container.run(count: 1, restart: true) do
+		Async.logger.debug(self, "Child process started.")
+		
+		while true
+			sleep 1
+			
+			if rand < 0.1
+				exit(1)
+			end
+		end
+	ensure
+		Async.logger.debug(self, "Child process exiting:", $!)
 	end
-ensure
-	puts "Exiting: #{$!}"
 end
 
-container.wait
-
-puts "Controller procss exiting!"
+begin
+	controller.run
+ensure
+	Async.logger.debug(controller, "Parent process exiting:", $!)
+end

data/examples/threads.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+puts "Process pid: #{Process.pid}"
+
+threads = 10.times.collect do
+	Thread.new do
+		begin
+			sleep
+		rescue Exception
+			puts "Thread: #{$!}"
+		end
+	end
+end
+
+while true
+	begin
+		threads.each(&:join)
+		exit(0)
+	rescue Exception
+		puts "Join: #{$!}"
+	end
+end
+
+puts "Done"

data/lib/async/container.rb

@@ -18,32 +18,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'container/forked'
-require_relative 'container/threaded'
-require_relative 'container/hybrid'
-
-require 'etc'
+require_relative 'container/controller'
 
 module Async
 	# Containers execute one or more "instances" which typically contain a reactor. A container spawns "instances" using threads and/or processes. Because these are resources that must be cleaned up some how (either by `join` or `waitpid`), their creation is deferred until the user invokes `Container#wait`. When executed this way, the container guarantees that all "instances" will be complete once `Container#wait` returns. Containers are constructs for achieving parallelism, and are not designed to be used directly for concurrency. Typically, you'd create one or more container, add some tasks to it, and then wait for it to complete.
 	module Container
-		def self.best_container_class
-			if Process.respond_to?(:fork) and Process.respond_to?(:setpgid)
-				return Forked
-			else
-				return Threaded
-			end
-		end
-		
-		# @return [Integer] the number of hardware processors which can run threads/processes simultaneously.
-		def self.processor_count
-			Etc.nprocessors
-		rescue
-			2
-		end
-		
-		def self.new(*arguments)
-			best_container_class.new(*arguments)
-		end
 	end
 end

data/lib/async/container/best.rb

@@ -0,0 +1,44 @@
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'forked'
+require_relative 'threaded'
+require_relative 'hybrid'
+
+module Async
+	# Containers execute one or more "instances" which typically contain a reactor. A container spawns "instances" using threads and/or processes. Because these are resources that must be cleaned up some how (either by `join` or `waitpid`), their creation is deferred until the user invokes `Container#wait`. When executed this way, the container guarantees that all "instances" will be complete once `Container#wait` returns. Containers are constructs for achieving parallelism, and are not designed to be used directly for concurrency. Typically, you'd create one or more container, add some tasks to it, and then wait for it to complete.
+	module Container
+		def self.fork?
+			Process.respond_to?(:fork) and Process.respond_to?(:setpgid)
+		end
+		
+		def self.best_container_class
+			if fork?
+				return Forked
+			else
+				return Threaded
+			end
+		end
+		
+		def self.new(*arguments)
+			best_container_class.new(*arguments)
+		end
+	end
+end

data/lib/async/container/controller.rb

@@ -18,49 +18,101 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'terminator'
+require_relative 'error'
+require_relative 'best'
 
-require 'async/reactor'
+require_relative 'statistics'
 
 module Async
 	module Container
+		class ContainerFailed < Error
+			def initialize(container)
+				super("Could not create container!")
+				@container = container
+			end
+			
+			attr :container
+		end
+		
+		# Manages the life-cycle of a container.
 		class Controller
-			def initialize
-				@attached = []
+			SIGHUP = Signal.list["HUP"]
+			DEFAULT_TIMEOUT = 2
+			
+			def initialize(startup_duration: DEFAULT_TIMEOUT)
+				@container = nil
+				
+				@startup_duration = startup_duration
+			end
+			
+			attr :container
+			
+			def create_container
+				Container.new
+			end
+			
+			def setup(container)
+			end
+			
+			def start
+				self.restart
+			end
+			
+			def stop(graceful = true)
+				@container&.stop(graceful)
+				@container = nil
 			end
 			
-			def attach(controller = nil, &block)
-				if controller
-					@attached << controller
+			def restart(duration = @startup_duration)
+				hup_action = Signal.trap(:HUP, :IGNORE)
+				container = self.create_container
+				
+				begin
+					self.setup(container)
+				rescue
+					raise ContainerFailed, container
 				end
 				
-				if block_given?
-					@attached << Terminator.new(&block)
+				Async.logger.debug(self, "Waiting for startup...")
+				container.sleep(duration)
+				Async.logger.debug(self, "Finished startup.")
+				
+				if container.failed?
+					container.stop
+					
+					raise ContainerFailed, container
 				end
 				
-				return self
+				@container&.stop
+				@container = container
+			ensure
+				Signal.trap(:HUP, hup_action)
 			end
 			
-			def async(**options, &block)
-				spawn(**options) do |instance|
+			def run
+				Async.logger.debug(self) {"Starting container..."}
+				
+				self.start
+				
+				while true
 					begin
-						Async::Reactor.run(instance, &block)
-					rescue Interrupt
-						# Graceful exit.
+						@container.wait
+					rescue SignalException => exception
+						if exception.signo == SIGHUP
+							Async.logger.info(self) {"Reloading container..."}
+							
+							begin
+								self.restart
+							rescue ContainerFailed => failure
+								Async.logger.error(self) {failure}
+							end
+						else
+							raise
+						end
 					end
 				end
-			end
-			
-			def run(count: Container.processor_count, **options, &block)
-				count.times do
-					async(**options, &block)
-				end
-				
-				return self
-			end
-			
-			def stop(graceful = true)
-				@attached.each(&:stop)
+			ensure
+				self.stop
 			end
 		end
 	end

data/lib/async/container/{terminator.rb → error.rb}

@@ -20,14 +20,7 @@
 
 module Async
 	module Container
-		class Terminator
-			def initialize(&block)
-				@block = block
-			end
-			
-			def stop(graceful = true)
-				@block.call(graceful)
-			end
+		class Error < StandardError
 		end
 	end
 end

data/lib/async/container/forked.rb

@@ -21,13 +21,13 @@
 require 'async/reactor'
 
 require_relative 'group'
-require_relative 'controller'
+require_relative 'generic'
 require_relative 'statistics'
 
 module Async
 	# Manages a reactor within one or more threads.
 	module Container
-		class Forked < Controller
+		class Forked < Generic
 			UNNAMED = "Unnamed"
 			
 			class Instance
@@ -52,11 +52,8 @@ module Async
 				super
 				
 				@group = Group.new
-				@statistics = Statistics.new
 			end
 			
-			attr :statistics
-			
 			def spawn(name: nil, restart: false)
 				Fiber.new do
 					while true
@@ -85,18 +82,16 @@ module Async
 				return self
 			end
 			
-			def wait(forever = false)
+			def sleep(duration)
+				@group.sleep(duration)
+			end
+			
+			def wait
 				@group.wait
-				
-				sleep if forever
-			rescue Interrupt
-				# Graceful exit.
 			end
 			
 			# Gracefully shut down all children processes.
 			def stop(graceful = true)
-				super
-				
 				@group.stop(graceful)
 			end
 		end

data/lib/async/container/generic.rb

@@ -0,0 +1,64 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'async/reactor'
+
+require 'etc'
+
+module Async
+	module Container
+		# @return [Integer] the number of hardware processors which can run threads/processes simultaneously.
+		def self.processor_count
+			Etc.nprocessors
+		rescue
+			2
+		end
+		
+		class Generic
+			def initialize
+				@statistics = Statistics.new
+			end
+			
+			attr :statistics
+			
+			def failed?
+				@statistics.failed?
+			end
+			
+			def async(**options, &block)
+				spawn(**options) do |instance|
+					begin
+						Async::Reactor.run(instance, &block)
+					rescue Interrupt
+						# Graceful exit.
+					end
+				end
+			end
+			
+			def run(count: Container.processor_count, **options, &block)
+				count.times do
+					async(**options, &block)
+				end
+				
+				return self
+			end
+		end
+	end
+end

data/lib/async/container/group.rb

@@ -18,27 +18,27 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'async/reactor'
-
-require_relative 'controller'
-require_relative 'statistics'
-
 module Async
-	# Manages a reactor within one or more threads.
 	module Container
 		class Group
 			def initialize
 				@pgid = nil
 				@running = {}
+				
+				@queue = nil
 			end
 			
 			def spawn(*arguments)
+				self.yield
+				
 				if pid = ::Process.spawn(*arguments)
 					wait_for(pid)
 				end
 			end
 			
 			def fork(&block)
+				self.yield
+				
 				if pid = ::Process.fork(&block)
 					wait_for(pid)
 				end
@@ -48,20 +48,22 @@ module Async
 				@running.any?
 			end
 			
+			def sleep(duration)
+				self.resume
+				self.suspend
+				
+				Kernel::sleep(duration)
+				
+				while self.wait_one(::Process::WNOHANG)
+				end
+			end
+			
 			def wait
+				self.resume
+				
 				while self.any?
 					self.wait_one
 				end
-			rescue Interrupt
-				# If the user interrupts the wait, interrupt the process group and wait for them to finish:
-				self.kill(:INT)
-				
-				# If user presses Ctrl-C again (or something else goes wrong), we will come out and kill(:TERM) in the ensure below:
-				wait_all
-
-				raise
-			ensure
-				self.close
 			end
 			
 			def kill(signal = :INT)
@@ -71,7 +73,7 @@ module Async
 			def stop(graceful = false)
 				if graceful
 					self.kill(:INT)
-					wait_all
+					interrupt_all
 				end
 			ensure
 				self.close
@@ -85,15 +87,34 @@ module Async
 				end
 				
 				# Clean up zombie processes - if user presses Ctrl-C or for some reason something else blows up, exception would propagate back to caller:
-				wait_all
+				interrupt_all
 			end
 			
 			protected
 			
-			def wait_all
+			def yield
+				if @queue
+					@queue << Fiber.current
+					Fiber.yield
+				end
+			end
+			
+			def suspend
+				@queue ||= []
+			end
+			
+			def resume
+				if @queue
+					@queue.each(&:resume)
+					@queue = nil
+				end
+			end
+			
+			def interrupt_all
 				while self.any?
 					self.wait_one do |fiber, status|
 						begin
+							# This causes the waiting fiber to `raise Interrupt`:
 							fiber.resume(nil)
 						rescue Interrupt
 							# Graceful exit.

data/lib/async/container/statistics.rb

@@ -44,6 +44,16 @@ module Async
 			def failure!
 				@failures += 1
 			end
+			
+			def failed?
+				@failures > 0
+			end
+			
+			def << other
+				@spawns += other.spawns
+				@restarts += other.restarts
+				@failures += other.failures
+			end
 		end
 	end
 end

data/lib/async/container/threaded.rb

@@ -21,13 +21,13 @@
 require 'async/reactor'
 require 'thread'
 
-require_relative 'controller'
+require_relative 'generic'
 require_relative 'statistics'
 
 module Async
 	module Container
 		# Manages a reactor within one or more threads.
-		class Threaded < Controller
+		class Threaded < Generic
 			class Instance
 				def initialize(thread)
 					@thread = thread
@@ -59,11 +59,8 @@ module Async
 				
 				@threads = []
 				@running = true
-				@statistics = Statistics.new
 			end
 			
-			attr :statistics
-			
 			def spawn(name: nil, restart: false, &block)
 				@statistics.spawn!
 				
@@ -98,19 +95,18 @@ module Async
 				return self
 			end
 			
-			def wait(forever = false)
+			def sleep(duration)
+				Kernel::sleep(duration)
+			end
+			
+			def wait
 				@threads.each(&:join)
 				@threads.clear
-				
-				sleep if forever
-			rescue Interrupt
-				# Graceful exit.
 			end
 			
 			# Gracefully shut down all reactors.
 			def stop(graceful = true)
 				@running = false
-				super
 				
 				if graceful
 					@threads.each{|thread| thread.raise(Interrupt)}

data/lib/async/container/version.rb

@@ -20,6 +20,6 @@
 
 module Async
 	module Container
-		VERSION = "0.14.1"
+		VERSION = "0.15.0"
 	end
 end

data/spec/async/container/controller_spec.rb

@@ -0,0 +1,53 @@
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require "async/container/controller"
+
+RSpec.describe Async::Container::Controller do
+	describe '#start' do
+		it "can start up a container" do
+			expect(subject).to receive(:setup)
+			
+			subject.start
+			
+			expect(subject.container).to_not be_nil
+			
+			subject.stop
+			
+			expect(subject.container).to be_nil
+		end
+		
+		it "can spawn a reactor" do
+			def subject.setup(container)
+				container.async do |task|
+					task.sleep 1
+				end
+			end
+			
+			subject.start
+			
+			statistics = subject.container.statistics
+			
+			expect(statistics.spawns).to be == 1
+			
+			subject.stop
+		end
+	end
+end

data/spec/async/container/forked_spec.rb

@@ -18,11 +18,12 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require "async/container"
 require "async/container/forked"
 
 require_relative 'shared_examples'
 
-RSpec.describe Async::Container::Forked do
+RSpec.describe Async::Container::Forked, if: Async::Container.fork? do
 	it_behaves_like Async::Container
 	
 	it "can restart child" do

data/spec/async/container/hybrid_spec.rb

@@ -22,7 +22,7 @@ require "async/container/hybrid"
 
 require_relative 'shared_examples'
 
-RSpec.describe Async::Container::Hybrid do
+RSpec.describe Async::Container::Hybrid, if: Async::Container.fork? do
 	it_behaves_like Async::Container
 	
 	it "should be multiprocess" do

data/spec/async/container/shared_examples.rb

@@ -21,18 +21,6 @@
 require 'async/rspec/reactor'
 
 RSpec.shared_examples_for Async::Container do
-	it "can attach terminator" do
-		terminated = false
-		
-		subject.attach do
-			terminated = true
-		end
-		
-		subject.stop
-		
-		expect(terminated).to be_truthy
-	end
-	
 	it "can run concurrently" do
 		input, output = IO.pipe
 		
@@ -58,4 +46,21 @@ RSpec.shared_examples_for Async::Container do
 		
 		subject.wait
 	end
+	
+	describe '#sleep' do
+		it "can sleep for a short time" do
+			subject.spawn do
+				sleep(2)
+				raise "Boom"
+			end
+			
+			subject.sleep(1)
+			
+			expect(subject.statistics.failures).to be_zero
+			
+			subject.wait
+			
+			expect(subject.statistics.failures).to_not be_zero
+		end
+	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-container
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-09 00:00:00.000000000 Z
+date: 2019-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: process-group
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.26'
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -141,15 +141,19 @@ files:
 - Rakefile
 - async-container.gemspec
 - examples/container.rb
+- examples/threads.rb
 - lib/async/container.rb
+- lib/async/container/best.rb
 - lib/async/container/controller.rb
+- lib/async/container/error.rb
 - lib/async/container/forked.rb
+- lib/async/container/generic.rb
 - lib/async/container/group.rb
 - lib/async/container/hybrid.rb
 - lib/async/container/statistics.rb
-- lib/async/container/terminator.rb
 - lib/async/container/threaded.rb
 - lib/async/container/version.rb
+- spec/async/container/controller_spec.rb
 - spec/async/container/forked_spec.rb
 - spec/async/container/hybrid_spec.rb
 - spec/async/container/shared_examples.rb
@@ -176,11 +180,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Async is an asynchronous I/O framework based on nio4r.
 test_files:
+- spec/async/container/controller_spec.rb
 - spec/async/container/forked_spec.rb
 - spec/async/container/hybrid_spec.rb
 - spec/async/container/shared_examples.rb