async-container 0.27.1 → 0.27.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c475605b174dc9677a89310e85b7ca28269b084469b51c6f7f5226ca39d26340
-  data.tar.gz: ccbdcaa3da1c785abdadefc3ece4ce6552ea6c418a0218229e04ab53c51b2637
+  metadata.gz: 4e0f77eb0f6eb3e7e8f8971af4d653e5ff2c3243ecc12f8dd06b27ae27e09d45
+  data.tar.gz: 869aaa117d285f6f407b482b5fcd5b3bb19edcba215202d2faefe159195eed38
 SHA512:
-  metadata.gz: 1f17a77ff0978894a46b5b18b4ac7e2fc2bf451d13c2c4c4a94c122cc205df90b248007ad2b1d6d4655b89257bb94d745a57aa23ed833702f811afe62dc64261
-  data.tar.gz: 7415b0fb06ccaeea5645f0cc43e098f8ea1f684fc3cc51b1e5dd22dd1b3be68eba864af8f32fe93d960af3e6205a490453c48189730371a19cf0f873cb738155
+  metadata.gz: f1eb59fda7b292a5ca70b15ea0b70af9d6f41551d9a4818f5820dbc9b078f3008d37f646e8cbcdc74428d3c359c9ec9e731b3b0b008a74922f379b700eda32e4
+  data.tar.gz: 301401ff8bcd736d2e41d1816110625ce038ff65b0a675d11e0ec900feb5550c73e6e754af9e5123dd12b692e4980deac1d197cbdad38e3a48213b38dd938171

data/lib/async/container/channel.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2024, by Samuel Williams.
+# Copyright, 2020-2025, by Samuel Williams.
 
 require "json"
 
@@ -10,8 +10,9 @@ module Async
 		# Provides a basic multi-thread/multi-process uni-directional communication channel.
 		class Channel
 			# Initialize the channel using a pipe.
-			def initialize
+			def initialize(timeout: 1.0)
 				@in, @out = ::IO.pipe
+				@in.timeout = timeout
 			end
 			
 			# The input end of the pipe.
@@ -43,12 +44,11 @@ module Async
 			# @returns [Hash]
 			def receive
 				if data = @in.gets
-					begin
-						return JSON.parse(data, symbolize_names: true)
-					rescue
-						return {line: data}
-					end
+					return JSON.parse(data, symbolize_names: true)
 				end
+			rescue => error
+				Console.error(self, "Error during channel receive!", error)
+				return nil
 			end
 		end
 	end

data/lib/async/container/controller.rb

@@ -91,11 +91,11 @@ module Async
 			# Start the container unless it's already running.
 			def start
 				unless @container
-					Console.info(self) {"Controller starting..."}
+					Console.info(self, "Controller starting...")
 					self.restart
 				end
 				
-				Console.info(self) {"Controller started..."}
+				Console.info(self, "Controller started...")
 			end
 			
 			# Stop the container if it's running.
@@ -111,9 +111,9 @@ module Async
 				if @container
 					@notify&.restarting!
 					
-					Console.debug(self) {"Restarting container..."}
+					Console.info(self, "Restarting container...")
 				else
-					Console.debug(self) {"Starting container..."}
+					Console.info(self, "Starting container...")
 				end
 				
 				container = self.create_container
@@ -127,13 +127,14 @@ module Async
 				end
 				
 				# Wait for all child processes to enter the ready state.
-				Console.debug(self, "Waiting for startup...")
+				Console.info(self, "Waiting for startup...")
 				container.wait_until_ready
-				Console.debug(self, "Finished startup.")
+				Console.info(self, "Finished startup.")
 				
 				if container.failed?
 					@notify&.error!("Container failed to start!")
 					
+					Console.info(self, "Stopping failed container...")
 					container.stop(false)
 					
 					raise SetupError, container
@@ -145,7 +146,7 @@ module Async
 				container = nil
 				
 				if old_container
-					Console.debug(self, "Stopping old container...")
+					Console.info(self, "Stopping old container...")
 					old_container&.stop(@graceful_stop)
 				end
 				
@@ -168,11 +169,9 @@ module Async
 				end
 				
 				# Wait for all child processes to enter the ready state.
-				Console.debug(self, "Waiting for startup...")
-				
+				Console.info(self, "Waiting for startup...")
 				@container.wait_until_ready
-				
-				Console.debug(self, "Finished startup.")
+				Console.info(self, "Finished startup.")
 				
 				if @container.failed?
 					@notify.error!("Container failed to reload!")

data/lib/async/container/forked.rb

@@ -136,8 +136,8 @@ module Async
 				
 				# Initialize the process.
 				# @parameter name [String] The name to use for the child process.
-				def initialize(name: nil)
-					super()
+				def initialize(name: nil, **options)
+					super(**options)
 					
 					@name = name
 					@status = nil
@@ -260,7 +260,6 @@ module Async
 				end
 			end
 			
-			
 			# Start a named child process and execute the provided block in it.
 			# @parameter name [String] The name (title) of the child process.
 			# @parameter block [Proc] The block to execute in the child process.

data/lib/async/container/generic.rb

@@ -2,6 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2019-2025, by Samuel Williams.
+# Copyright, 2025, by Marc-André Cournoyer.
 
 require "etc"
 require "async/clock"
@@ -139,12 +140,18 @@ module Async
 			# Stop the children instances.
 			# @parameter timeout [Boolean | Numeric] Whether to stop gracefully, or a specific timeout.
 			def stop(timeout = true)
+				Console.info(self, "Stopping container...", timeout: timeout, caller: caller_locations)
 				@running = false
 				@group.stop(timeout)
 				
 				if @group.running?
-					Console.warn(self) {"Group is still running after stopping it!"}
+					Console.warn(self, "Group is still running after stopping it!")
+				else
+					Console.info(self, "Group has stopped.")
 				end
+			rescue => error
+				Console.error(self, "Error while stopping container!", exception: error)
+				raise
 			ensure
 				@running = true
 			end
@@ -165,7 +172,7 @@ module Async
 				name ||= UNNAMED
 				
 				if mark?(key)
-					Console.debug(self) {"Reusing existing child for #{key}: #{name}"}
+					Console.debug(self, "Reusing existing child.", child: {key: key, name: name})
 					return false
 				end
 				
@@ -173,15 +180,20 @@ module Async
 				
 				fiber do
 					while @running
-						child = self.start(name, &block)
+						Console.debug(self, "Starting child...", child: {key: key, name: name, restart: restart, health_check_timeout: health_check_timeout}, statistics: @statistics)
 						
+						child = self.start(name, &block)
 						state = insert(key, child)
 						
+						Console.debug(self, "Started child.", child: child, spawn: {key: key, restart: restart, health_check_timeout: health_check_timeout}, statistics: @statistics)
+						
 						# If a health check is specified, we will monitor the child process and terminate it if it does not update its state within the specified time.
 						if health_check_timeout
 							age_clock = state[:age] = Clock.start
 						end
 						
+						status = nil
+						
 						begin
 							status = @group.wait_for(child) do |message|
 								case message
@@ -194,15 +206,17 @@ module Async
 									age_clock&.reset!
 								end
 							end
+						rescue => error
+							Console.error(self, "Error during child process management!", exception: error, running: @running)
 						ensure
 							delete(key, child)
 						end
 						
-						if status.success?
-							Console.debug(self) {"#{child} exited with #{status}"}
+						if status&.success?
+							Console.debug(self, "Child exited successfully.", status: status, running: @running)
 						else
 							@statistics.failure!
-							Console.error(self, status: status)
+							Console.error(self, "Child exited with error!", status: status, running: @running)
 						end
 						
 						if restart

data/lib/async/container/group.rb

@@ -100,9 +100,14 @@ module Async
 				end
 			end
 			
+			private def each_running(&block)
+				# We create a copy of the values here, in case the block modifies the running set:
+				@running.values.each(&block)
+			end
+			
 			# Perform a health check on all running processes.
 			def health_check!
-				@running.each_value do |fiber|
+				each_running do |fiber|
 					fiber.resume(:health_check!)
 				end
 			end
@@ -111,7 +116,7 @@ module Async
 			# This resumes the controlling fiber with an instance of {Interrupt}.
 			def interrupt
 				Console.info(self, "Sending interrupt to #{@running.size} running processes...")
-				@running.each_value do |fiber|
+				each_running do |fiber|
 					fiber.resume(Interrupt)
 				end
 			end
@@ -120,7 +125,7 @@ module Async
 			# This resumes the controlling fiber with an instance of {Terminate}.
 			def terminate
 				Console.info(self, "Sending terminate to #{@running.size} running processes...")
-				@running.each_value do |fiber|
+				each_running do |fiber|
 					fiber.resume(Terminate)
 				end
 			end
@@ -129,7 +134,7 @@ module Async
 			# This resumes the controlling fiber with an instance of {Kill}.
 			def kill
 				Console.info(self, "Sending kill to #{@running.size} running processes...")
-				@running.each_value do |fiber|
+				each_running do |fiber|
 					fiber.resume(Kill)
 				end
 			end
@@ -183,7 +188,7 @@ module Async
 					self.wait_for_exit(clock, interrupt_timeout)
 				end
 				
-				if terminate_timeout
+				if terminate_timeout and self.any?
 					clock = Async::Clock.start
 					
 					# If the children are still running, terminate them:
@@ -231,8 +236,8 @@ module Async
 			protected
 			
 			def wait_for_children(duration = nil)
-				# This log is a big noisy and doesn't really provide a lot of useful information.
-				# Console.debug(self, "Waiting for children...", duration: duration, running: @running)
+				# This log is a bit noisy and doesn't really provide a lot of useful information:
+				Console.debug(self, "Waiting for children...", duration: duration, running: @running)
 				
 				unless @running.empty?
 					# Maybe consider using a proper event loop here:

data/lib/async/container/notify/pipe.rb

@@ -63,9 +63,9 @@ module Async
 				# Formats the message using JSON and sends it to the parent controller.
 				# This is suitable for use with {Channel}.
 				def send(**message)
-					data = ::JSON.dump(message)
+					data = ::JSON.dump(message) << "\n"
 					
-					@io.puts(data)
+					@io.write(data)
 					@io.flush
 				end
 				

data/lib/async/container/statistics.rb

@@ -56,6 +56,24 @@ module Async
 				@restarts += other.restarts
 				@failures += other.failures
 			end
+			
+			# Generate a hash representation of the statistics.
+			#
+			# @returns [Hash] The statistics as a hash.
+			def as_json(...)
+				{
+					spawns: @spawns,
+					restarts: @restarts,
+					failures: @failures,
+				}
+			end
+			
+			# Generate a JSON representation of the statistics.
+			#
+			# @returns [String] The statistics as JSON.
+			def to_json(...)
+				as_json.to_json(...)
+			end
 		end
 	end
 end

data/lib/async/container/threaded.rb

@@ -124,8 +124,8 @@ module Async
 				# Initialize the thread.
 				#
 				# @parameter name [String] The name to use for the child thread.
-				def initialize(name: nil)
-					super()
+				def initialize(name: nil, **options)
+					super(**options)
 					
 					@status = nil
 					

data/lib/async/container/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module Container
-		VERSION = "0.27.1"
+		VERSION = "0.27.7"
 	end
 end

data/license.md

@@ -5,6 +5,7 @@ Copyright, 2019, by Yuji Yaginuma.
 Copyright, 2020, by Olle Jonsson.  
 Copyright, 2020, by Juan Antonio Martín Lucas.  
 Copyright, 2022, by Anton Sozontov.  
+Copyright, 2025, by Marc-André Cournoyer.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -26,6 +26,23 @@ Please see the [project documentation](https://socketry.github.io/async-containe
 
 Please see the [project releases](https://socketry.github.io/async-container/releases/index) for all releases.
 
+### v0.27.5
+
+  - Make the child handling more robust in the face of exceptions.
+
+### v0.27.4
+
+  - Fix race condition where `wait_for` could modify `@running` while it was being iterated over (`each_value`) during health checks.
+
+### v0.27.3
+
+  - Add log for starting child, including container statistics.
+  - Don't try to (log) "terminate 0 child processes" if there are none.
+
+### v0.27.2
+
+  - More logging, especially around failure cases.
+
 ### v0.27.1
 
   - Log caller and timeout when waiting on a child instance to exit, if it blocks.
@@ -51,21 +68,6 @@ Please see the [project releases](https://socketry.github.io/async-container/rel
 
   - [Add support for `NOTIFY_LOG` for Kubernetes readiness probes.](https://socketry.github.io/async-container/releases/index#add-support-for-notify_log-for-kubernetes-readiness-probes.)
 
-### v0.21.0
-
-  - Use `SIGKILL`/`Thread#kill` when the health check fails. In some cases, `SIGTERM` may not be sufficient to terminate a process because the signal can be ignored or the process may be in an uninterruptible state.
-
-### v0.20.1
-
-  - Fix compatibility between <code class="language-ruby">Async::Container::Hybrid</code> and the health check.
-  - <code class="language-ruby">Async::Container::Generic\#initialize</code> passes unused arguments through to <code class="language-ruby">Async::Container::Group</code>.
-
-### v0.20.0
-
-  - Improve container signal handling reliability by using `Thread.handle_interrupt` except at known safe points.
-  - Improved logging when child process fails and container startup.
-  - [Add `health_check_timeout` for detecting hung processes.](https://socketry.github.io/async-container/releases/index#add-health_check_timeout-for-detecting-hung-processes.)
-
 ## Contributing
 
 We welcome contributions to this project.

data/releases.md

@@ -1,5 +1,22 @@
 # Releases
 
+## v0.27.5
+
+  - Make the child handling more robust in the face of exceptions.
+
+## v0.27.4
+
+  - Fix race condition where `wait_for` could modify `@running` while it was being iterated over (`each_value`) during health checks.
+
+## v0.27.3
+
+  - Add log for starting child, including container statistics.
+  - Don't try to (log) "terminate 0 child processes" if there are none.
+
+## v0.27.2
+
+  - More logging, especially around failure cases.
+
 ## v0.27.1
 
   - Log caller and timeout when waiting on a child instance to exit, if it blocks.

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-container
 version: !ruby/object:Gem::Version
-  version: 0.27.1
+  version: 0.27.7
 platform: ruby
 authors:
 - Samuel Williams
 - Olle Jonsson
 - Anton Sozontov
 - Juan Antonio Martín Lucas
+- Marc-André Cournoyer
 - Yuji Yaginuma
 bindir: bin
 cert_chain:
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Abstract container-based parallelism using threads and processes where appropriate.
 test_files: []