async-container 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f6640daaa86e57d05f5c7ec2a0d25d98b355edb0926d45ba1e2414adfdaa46e
-  data.tar.gz: fd25c58be73c64bf64dec42ac24e84b9f5c66fdb26da9780246c877bd38056f5
+  metadata.gz: fd0aec5639eb9f64edc338624657d7e6442948b5e4f403acac9264707a5d2bfe
+  data.tar.gz: 3ef49efb43cb2cf4c4470ce9ed98426d18d41e009e19f11c5f10a718a30b80c2
 SHA512:
-  metadata.gz: e6011d00efba48db1d17fedf7fe9823210c58840611a140710be8ce88a55e39b5421bebf666d97a4741f5c97c1f16758f6bc7598fd4205ffb0b2c975173e496f
-  data.tar.gz: d0c020e874296fc31abdd6638d7113ddb0ff7e718e142c9c8c77b40ad7874e848a78b9e351e45f9439421d1629d58cb20fe086d3966d07345c3cb46fe9a517a3
+  metadata.gz: c4a15262693a7928b00ecf157f57d2333e9760387e7d723ce9679732d21eeb566b855835e593db486e912976e8cdf69ce1a67b4c5a1d9f3c54614de2df39b9d2
+  data.tar.gz: e2d4e51a734a853852cf3aae1119a8a01698b62e6be5791612c6e008f67518cf651b39be3b959d45f4ca42830fa2b7e7f2fb2bfb8be8b82696bfaaa6009d39e1

data/.github/workflows/development.yml

@@ -0,0 +1,36 @@
+name: Development
+
+on: [push]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+          - macos
+        
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+        
+        include:
+          - os: 'ubuntu'
+            ruby: '2.6'
+            env: COVERAGE=PartialSummary,Coveralls
+    
+    runs-on: ${{matrix.os}}-latest
+    
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+    - name: Install dependencies
+      run: |
+        command -v bundler || gem install bundler
+        bundle install
+    - name: Run tests
+      run: ${{matrix.env}} bundle exec rspec

data/.travis.yml

@@ -4,14 +4,14 @@ cache: bundler
 
 matrix:
   include:
-    - rvm: 2.3
     - rvm: 2.4
     - rvm: 2.5
     - rvm: 2.6
-    - rvm: 2.6
-      os: osx
+    # - rvm: 2.6
+    #   os: osx
     - rvm: 2.6
       env: COVERAGE=BriefSummary,Coveralls
+    - rvm: 2.7
     - rvm: truffleruby
     - rvm: jruby-head
       env: JRUBY_OPTS="--debug -X+O"

data/Gemfile

@@ -14,7 +14,4 @@ end
 group :test do
 	gem 'benchmark-ips'
 	gem 'ruby-prof', platforms: :mri
-	
-	gem 'simplecov'
-	gem 'coveralls', require: false
 end

data/README.md

@@ -2,7 +2,7 @@
 
 Provides containers which implement concurrency policy for high-level servers (and potentially clients).
 
-[![Build Status](https://secure.travis-ci.org/socketry/async-container.svg)](http://travis-ci.org/socketry/async-container)
+[![Actions Status](https://github.com/socketry/async-container/workflows/Development/badge.svg)](https://github.com/socketry/async-container/actions?workflow=Development)
 [![Code Climate](https://codeclimate.com/github/socketry/async-container.svg)](https://codeclimate.com/github/socketry/async-container)
 [![Coverage Status](https://coveralls.io/repos/socketry/async-container/badge.svg)](https://coveralls.io/r/socketry/async-container)
 
@@ -24,20 +24,87 @@ Or install it yourself as:
 
 ## Usage
 
+### Container
+
+A container represents a set of child processes (or threads) which are doing work for you.
+
 ```ruby
-container = Async::Container::Threaded.new
+require 'async/container'
+
+Async.logger.debug!
 
-container.run(count: 8)
-	# 8 reactors will be spawned, in separate threads.
-	Server.new.run(...)
+container = Async::Container.new
+
+container.async do |task|
+	task.logger.debug "Sleeping..."
+	task.sleep(1)
+	task.logger.debug "Waking up!"
 end
 
-container = Async::Container::Forked.new
+Async.logger.debug "Waiting for container..."
+container.wait
+Async.logger.debug "Finished."
+```
+
+### Controller
 
-container.run(count: 8) do
-	# 8 reactors will be spawned, in separate forked processes.
-	Server.new.run(...)
+The controller provides the life-cycle management for one or more containers of processes. It provides behaviour like starting, restarting, reloading and stopping. You can see some [example implementations in Falcon](https://github.com/socketry/falcon/blob/master/lib/falcon/controller/). If the process running the controller receives `SIGHUP` it will recreate the container gracefully.
+
+```ruby
+require 'async/container'
+
+Async.logger.debug!
+
+class Controller < Async::Container::Controller
+	def setup(container)
+		container.async do |task|
+			while true
+				Async.logger.debug("Sleeping...")
+				task.sleep(1)
+			end
+		end
+	end
 end
+
+controller = Controller.new
+
+controller.run
+
+# If you send SIGHUP to this process, it will recreate the container.
+```
+
+### Signal Handling
+
+`SIGINT` is the interrupt signal. The terminal sends it to the foreground process when the user presses **ctrl-c**. The default behavior is to terminate the process, but it can be caught or ignored. The intention is to provide a mechanism for an orderly, graceful shutdown.
+
+`SIGQUIT` is the dump core signal. The terminal sends it to the foreground process when the user presses **ctrl-\**. The default behavior is to terminate the process and dump core, but it can be caught or ignored. The intention is to provide a mechanism for the user to abort the process. You can look at `SIGINT` as "user-initiated happy termination" and `SIGQUIT` as "user-initiated unhappy termination."
+
+`SIGTERM` is the termination signal. The default behavior is to terminate the process, but it also can be caught or ignored. The intention is to kill the process, gracefully or not, but to first allow it a chance to cleanup.
+
+`SIGKILL` is the kill signal. The only behavior is to kill the process, immediately. As the process cannot catch the signal, it cannot cleanup, and thus this is a signal of last resort.
+
+`SIGSTOP` is the pause signal. The only behavior is to pause the process; the signal cannot be caught or ignored. The shell uses pausing (and its counterpart, resuming via `SIGCONT`) to implement job control.
+
+### Integration
+
+#### systemd
+
+Install a template file into `/etc/systemd/system/`:
+
+```
+# my-daemon.service
+[Unit]
+Description=My Daemon
+AssertPathExists=/srv/
+
+[Service]
+Type=notify
+WorkingDirectory=/srv/my-daemon
+ExecStart=bundle exec my-daemon
+Nice=5
+
+[Install]
+WantedBy=multi-user.target
 ```
 
 ## Contributing

data/examples/async.rb

@@ -0,0 +1,21 @@
+
+require 'kernel/sync'
+
+class Worker
+	def initialize(&block)
+		
+	end
+end
+
+Sync do
+	count.times do
+		worker = Worker.new(&block)
+		
+		status = worker.wait do |message|
+			
+		end
+		
+		status.success?
+		status.failed?
+	end
+end

data/examples/channel.rb

@@ -0,0 +1,44 @@
+
+require 'json'
+
+class Channel
+	def initialize
+		@in, @out = IO.pipe
+	end
+	
+	def after_fork
+		@out.close
+	end
+	
+	def receive
+		if data = @in.gets
+			return JSON.parse(data, symbolize_names: true)
+		end
+	end
+	
+	def send(**message)
+		data = JSON.dump(message)
+		
+		@out.puts(data)
+	end
+end
+
+status = Channel.new
+
+pid = fork do
+	status.send(ready: false, status: "Initializing...")
+	
+	# exit(-1) # crash
+	
+	status.send(ready: true, status: "Initialization Complete!")
+end
+
+status.after_fork
+
+while message = status.receive
+	pp message
+end
+
+pid, status = Process.waitpid2(pid)
+
+puts "Status: #{status}"

data/examples/channels/client.rb

@@ -0,0 +1,103 @@
+
+require 'msgpack'
+require 'async/io'
+require 'async/io/stream'
+require 'async/container'
+
+# class Bus
+# 	def initialize
+# 
+# 	end
+# 
+# 	def << object
+# 		return :object
+# 	end
+# 
+# 	def [] key
+# 		return
+# end
+# 
+# class Proxy < BasicObject
+# 	def initialize(bus, name)
+# 		@bus = bus
+# 		@name = name
+# 	end
+# 
+# 	def inspect
+# 		"[Proxy #{method_missing(:inspect)}]"
+# 	end
+# 
+# 	def method_missing(*args, &block)
+# 		@bus.invoke(@name, args, &block)
+# 	end
+# 
+# 	def respond_to?(*args)
+# 		@bus.invoke(@name, ["respond_to?", *args])
+# 	end
+# end
+# 
+# class Wrapper < MessagePack::Factory
+# 	def initialize(bus)
+# 		super()
+# 
+# 		self.register_type(0x00, Object,
+# 			packer: @bus.method(:<<),
+# 			unpacker: @bus.method(:[])
+# 		)
+# 
+# 		self.register_type(0x01, Symbol)
+# 		self.register_type(0x02, Exception,
+# 			packer: ->(exception){Marshal.dump(exception)},
+# 			unpacker: ->(data){Marshal.load(data)},
+# 		)
+# 
+# 		self.register_type(0x03, Class,
+# 			packer: ->(klass){Marshal.dump(klass)},
+# 			unpacker: ->(data){Marshal.load(data)},
+# 		)
+# 	end
+# end
+# 
+# class Channel
+# 	def self.pipe
+# 		input, output = Async::IO.pipe
+# 
+# 
+# 	end
+# 
+# 	def initialize(input, output)
+# 		@input = input
+# 		@output = output
+# 	end
+# 
+# 	def read
+# 		@input.read
+# 	end
+# 
+# 	def write
+# 	end
+# end
+
+container = Async::Container.new
+input, output = Async::IO.pipe
+
+container.async do |instance|
+	stream = Async::IO::Stream.new(input)
+	output.close
+	
+	while message = stream.gets
+		puts "Hello World from #{instance}: #{message}"
+	end
+	
+	puts "exiting"
+end
+
+stream = Async::IO::Stream.new(output)
+
+5.times do |i|
+	stream.puts "#{i}"
+end
+
+stream.close
+
+container.wait

data/examples/container.rb

@@ -9,7 +9,7 @@ Async.logger.debug(self, "Starting up...")
 
 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.")
 		

data/examples/isolate.rb

@@ -0,0 +1,35 @@
+
+# We define end of life-cycle in terms of "Interrupt" (SIGINT), "Terminate" (SIGTERM) and "Kill" (SIGKILL, does not invoke user code).
+class Terminate < Interrupt
+end
+
+class Isolate
+	def initialize(&block)
+		
+	end
+end
+
+
+parent = Isolate.new do |parent|
+	preload_user_code
+	server = bind_socket
+	children = 4.times.map do
+		Isolate.new do |worker|
+			app = load_user_application
+			worker.ready!
+			server.accept do |peer|
+				app.handle_request(peer)
+			end
+		end
+	end
+	while status = parent.wait
+		# Status is not just exit status of process but also can be `:ready` or something else.
+	end
+end
+
+# Similar to Process.wait(pid)
+status = parent.wait
+# Life cycle controls
+parent.interrupt!
+parent.terminate!
+parent.kill!

data/examples/minimal.rb

@@ -0,0 +1,93 @@
+
+class Threaded
+	def initialize(&block)
+		@channel = Channel.new
+		@thread = Thread.new(&block)
+		
+		@waiter = Thread.new do
+			begin
+				@thread.join
+			rescue Exception => error
+				finished(error)
+			else
+				finished
+			end
+		end
+	end
+	
+	attr :channel
+	
+	def close
+		self.terminate!
+		self.wait
+	ensure
+		@channel.close
+	end
+	
+	def interrupt!
+		@thread.raise(Interrupt)
+	end
+	
+	def terminate!
+		@thread.raise(Terminate)
+	end
+	
+	def wait
+		if @waiter
+			@waiter.join
+			@waiter = nil
+		end
+		
+		return @status
+	end
+	
+	protected
+	
+	def finished(error = nil)
+		@status = Status.new(error)
+		@channel.out.close
+	end
+end
+
+class Forked
+	def initialize(&block)
+		@channel = Channel.new
+		@status = nil
+		
+		@pid = Process.fork do
+			Signal.trap(:INT) {raise Interrupt}
+			Signal.trap(:INT) {raise Terminate}
+			
+			@channel.in.close
+			
+			yield
+		end
+		
+		@channel.out.close
+	end
+	
+	attr :channel
+	
+	def close
+		self.terminate!
+		self.wait
+	ensure
+		@channel.close
+	end
+	
+	def interrupt!
+		Process.kill(:INT, @pid)
+	end
+	
+	def terminate!
+		Process.kill(:TERM, @pid)
+	end
+	
+	def wait
+		unless @status
+			pid, @status = ::Process.wait(@pid)
+		end
+		
+		return @status
+	end
+end