async-container 0.15.0 → 0.16.0

data/lib/async/container/hybrid.rb

@@ -1,4 +1,4 @@
-# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2017, 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
@@ -22,7 +22,6 @@ require_relative 'forked'
 require_relative 'threaded'
 
 module Async
-	# Manages a reactor within one or more threads.
 	module Container
 		class Hybrid < Forked
 			def run(count: nil, forks: nil, threads: nil, **options, &block)
@@ -33,7 +32,7 @@ module Async
 				
 				forks.times do
 					self.spawn(**options) do
-						container = Threaded.new
+						container = Threaded::Container.new
 						
 						container.run(count: threads, **options, &block)
 						

data/lib/async/container/keyed.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.
+
+module Async
+	module Container
+		class Keyed
+			def initialize(key, value)
+				@key = key
+				@value = value
+				@marked = true
+			end
+			
+			attr :key
+			attr :value
+			
+			def marked?
+				@marked
+			end
+			
+			def mark!
+				@marked = true
+			end
+			
+			def clear!
+				@marked = false
+			end
+			
+			def stop?
+				unless @marked
+					@value.stop
+					return true
+				end
+			end
+		end
+	end
+end

data/lib/async/container/notify.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+#
+# Copyright, 2020, 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 'notify/pipe'
+require_relative 'notify/socket'
+
+module Async
+	module Container
+		module Notify
+			# We cache the client on a per-process basis. Because that's the relevant scope for process readiness protocols.
+			@@client = nil
+			
+			def self.open!
+				# Select the best available client:
+				@@client ||= (
+					Pipe.open! ||
+					Socket.open!
+				)
+			end
+		end
+	end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+#
+# Copyright, 2020, 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.
+
+module Async
+	module Container
+		module Notify
+			class Client
+				def ready!(**message)
+					send(ready: true, **message)
+				end
+				
+				def reloading!(**message)
+					message[:ready] = false
+					message[:reloading] = true
+					message[:status] ||= "Reloading..."
+					
+					send(**message)
+				end
+				
+				def restarting!(**message)
+					message[:ready] = false
+					message[:reloading] = true
+					message[:status] ||= "Restarting..."
+					
+					send(**message)
+				end
+				
+				def stopping!(**message)
+					message[:stopping] = true
+				end
+				
+				def status!(text)
+					send(status: text)
+				end
+				
+				def error!(text, **message)
+					send(status: text, **message)
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+#
+# Copyright, 2020, 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 'client'
+
+require 'json'
+
+module Async
+	module Container
+		module Notify
+			class Pipe < Client
+				NOTIFY_PIPE = 'NOTIFY_PIPE'
+				
+				def self.open!(environment = ENV)
+					if descriptor = environment.delete(NOTIFY_PIPE)
+						self.new(::IO.for_fd(descriptor.to_i))
+					end
+				rescue Errno::EBADF => error
+					Async.logger.error(self) {error}
+					
+					return nil
+				end
+				
+				def initialize(io)
+					@io = io
+				end
+				
+				# Inserts or duplicates the environment given an argument array.
+				# Sets or clears it in a way that is suitable for {::Process.spawn}.
+				def before_spawn(arguments, options)
+					environment = environment_for(arguments)
+					
+					# Use `notify_pipe` option if specified:
+					if notify_pipe = options.delete(:notify_pipe)
+						options[notify_pipe] = @io
+						environment[NOTIFY_PIPE] = notify_pipe.to_s
+					
+					# Use stdout if it's not redirected:
+					elsif !options.key?(:out)
+						options[:out] = @io
+						environment[NOTIFY_PIPE] = "1"
+					
+					# Use fileno 3 if it's available:
+					elsif !options.key?(3)
+						options[3] = @io
+						environment[NOTIFY_PIPE] = "3"
+					
+					# Otherwise, give up!
+					else
+						raise ArgumentError, "Please specify valid file descriptor for notify_pipe!"
+					end
+				end
+				
+				def send(**message)
+					data = ::JSON.dump(message)
+					
+					@io.puts(data)
+					@io.flush
+				end
+				
+				def ready!(**message)
+					send(ready: true, **message)
+				end
+				
+				def reloading!(**message)
+					message[:ready] = false
+					message[:reloading] = true
+					message[:status] ||= "Reloading..."
+					
+					send(**message)
+				end
+				
+				def reloading!(**message)
+					message[:ready] = false
+					message[:reloading] = true
+					message[:status] ||= "Reloading..."
+					
+					send(**message)
+				end
+				
+				private
+				
+				def environment_for(arguments)
+					# Insert or duplicate the environment hash which is the first argument:
+					if arguments.first.is_a?(Hash)
+						environment = arguments[0] = arguments.first.dup
+					else
+						arguments.unshift(environment = Hash.new)
+					end
+					
+					return environment
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+#
+# Copyright, 2020, 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/io'
+require 'async/io/unix_endpoint'
+require 'kernel/sync'
+
+require 'tmpdir'
+require 'securerandom'
+
+module Async
+	module Container
+		module Notify
+			class Server
+				NOTIFY_SOCKET = 'NOTIFY_SOCKET'
+				MAXIMUM_MESSAGE_SIZE = 4096
+				
+				def self.load(message)
+					lines = message.split("\n")
+					
+					lines.pop if lines.last == ""
+					
+					pairs = lines.map do |line|
+						key, value = line.split("=", 2)
+						
+						if value == '0'
+							value = false
+						elsif value == '1'
+							value = true
+						end
+						
+						next [key.downcase.to_sym, value]
+					end
+					
+					return Hash[pairs]
+				end
+				
+				def self.generate_path
+					File.expand_path(
+						"async-container-#{::Process.pid}-#{SecureRandom.hex(8)}.ipc",
+						Dir.tmpdir
+					)
+				end
+				
+				def self.open(path = self.generate_path)
+					self.new(path)
+				end
+				
+				def initialize(path)
+					@path = path
+				end
+				
+				attr :path
+				
+				def bind
+					Context.new(@path)
+				end
+				
+				class Context
+					def initialize(path)
+						@path = path
+						@endpoint = IO::Endpoint.unix(@path, ::Socket::SOCK_DGRAM)
+						
+						Sync do
+							@bound = @endpoint.bind
+						end
+						
+						@state = {}
+					end
+					
+					def close
+						Sync do
+							@bound.close
+						end
+						
+						File.unlink(@path)
+					end
+					
+					def receive
+						while true
+							data, address, flags, *controls = @bound.recvmsg(MAXIMUM_MESSAGE_SIZE)
+							
+							message = Server.load(data)
+							
+							yield message
+						end
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+#
+# Copyright, 2020, 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 'client'
+
+require 'async/io'
+require 'async/io/unix_endpoint'
+require 'kernel/sync'
+
+module Async
+	module Container
+		module Notify
+			class Socket < Client
+				NOTIFY_SOCKET = 'NOTIFY_SOCKET'
+				MAXIMUM_MESSAGE_SIZE = 4096
+				
+				def self.open!(environment = ENV)
+					if path = environment.delete(NOTIFY_SOCKET)
+						self.new(path)
+					end
+				end
+				
+				def initialize(path)
+					@path = path
+					@endpoint = IO::Endpoint.unix(path, ::Socket::SOCK_DGRAM)
+				end
+				
+				def dump(message)
+					buffer = String.new
+					
+					message.each do |key, value|
+						# Conversions required by NOTIFY_SOCKET specifications:
+						if value == true
+							value = 1
+						elsif value == false
+							value = 0
+						end
+						
+						buffer << "#{key.to_s.upcase}=#{value}\n"
+					end
+					
+					return buffer
+				end
+				
+				def send(**message)
+					data = dump(message)
+					
+					if data.bytesize > MAXIMUM_MESSAGE_SIZE
+						raise ArgumentError, "Message length #{message.bytesize} exceeds #{MAXIMUM_MESSAGE_SIZE}: #{message.inspect}"
+					end
+					
+					Sync do
+						@endpoint.connect do |peer|
+							peer.send(data)
+						end
+					end
+				end
+				
+				def error!(text, **message)
+					message[:errno] ||= -1
+					
+					send(status: text, **message)
+				end
+			end
+		end
+	end
+end