coworker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8acd4eb9e15823c97f2485b46031de4e3ab49bb7b7fa558cbb3c735fad28d200
+  data.tar.gz: 70f71ef2a2c95278aadfa8ba33d6844a0374d21aa327cbcbaf027086d062c3b7
+SHA512:
+  metadata.gz: e5fdc6981d7dd2690d0150cbee71e4f2ca6895219d66dce6c4ead4ec2929a35792402ae9a49370f8fea2db1fb52748a2cda26100dbaffc1fe3e62b4d263918d5
+  data.tar.gz: e788c80ec2090e67a964e55695a914bbe8506e97ad66740cf4ab75219d783042e0ac0b44b28b9529245754b1f17340b827537216ef6326ea5aa1fbfea6c44b25

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2025-05-25
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Sharon Rosner
+
+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.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Sharon Rosner
+
+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.

data/README.md

@@ -0,0 +1,39 @@
+# Coworker
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/coworker`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/coworker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/TODO.md

@@ -0,0 +1,9 @@
+## implementation
+
+- [ ] Continually select leader according to generation, spawn stamp  
+  (earlier is preferable)
+
+# Features
+
+- make worker count a parameter
+- add hooks for supervisor events, e.g. for logging

data/examples/simple.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'coworker', path: '..'
+end
+
+app = ->(w) do
+  loop do
+    puts "#{Time.now} pid: #{Process.pid} generation: #{w.generation}"
+    sleep 5
+  end
+end
+
+supervisor = Coworker::Supervisor.new(&app)
+supervisor.run

data/lib/coworker/supervisor.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+require_relative './worker'
+require 'child_subreaper'
+
+module Coworker
+  CLUSTER_SIZE = 2
+
+  class Supervisor
+    def initialize(**opts, &app)
+      @opts = opts
+      @app = app
+
+      @leader_pid = nil
+      @workers = {}
+      @messages = Queue.new
+      @pipe_r, @pipe_w = IO.pipe
+      # @socket_supervisor, @socket_worker = UNIXSocket.socketpair(:SOCK_SEQPACKET)
+    end
+
+    def run
+      ChildSubreaper.enable
+
+      trap('SIGUSR1') { @messages.push 'respawn' }
+      start_message_parser
+      while true
+        sleep 1
+        check_worker_state
+        spawn_worker if need_spawn?
+        select_leader if !@leader_pid
+      end
+    rescue Interrupt
+      return
+    ensure
+      stop_message_parser
+      kill_all_workers
+    end
+
+    def stop
+      kill_all_workers
+    end
+
+    def check_worker_state
+      process_received_messages
+      reap_unresponsive_workers
+    end
+
+    private
+
+    def start_message_parser
+      @message_parser_thread = Thread.new { recv_msg_loop }
+    end
+
+    def stop_message_parser
+      @message_parser_thread&.kill&.join
+    end
+
+    def recv_msg_loop
+      # @pipe_w.close
+      loop do
+        msg = recv_msg
+        @messages.push msg
+      end
+    end
+
+    def recv_msg
+      @pipe_r.gets(chomp: true)
+    end
+
+    WORKER_PING_TTL = 15
+
+    def process_received_messages
+      while !@messages.empty?
+        msg = @messages.shift
+        parts = msg.split(':')
+        case parts[0]
+        when 'ping'
+          handle_ping(*parts[1..2].map(&:to_i))
+        when 'reap'
+          handle_reap(parts[1].to_i)
+        when 'respawn'
+          handle_respawn
+        end
+      end      
+    end
+
+    def handle_ping(pid, generation)
+      @workers[pid] = { stamp: Time.now.to_i, generation: generation }
+    end
+
+    def handle_reap(pid)
+      reap_process(pid)
+    end
+
+    def handle_respawn
+      respawn
+    end
+
+    def reap_unresponsive_workers
+      deadline = Time.now.to_i - WORKER_PING_TTL
+      unresponsive_pids = @workers.each_with_object([]) { |(k, v), o| o << k if v[:stamp] < deadline }
+      unresponsive_pids.each do |pid|
+        kill_process(pid)
+        @workers.delete(pid)
+        select_leader if @leader_pid == pid
+      end
+    end
+
+    def kill_process(pid, timeout = 10)
+      t0 = Time.now
+      Process.kill('SIGTERM', pid)
+      while Time.now - t0 < timeout
+        wpid, _status = Process.wait2(pid, Process::WNOHANG)
+        return if wpid == pid
+
+        sleep 0.25
+      end
+
+      Process.kill('SIGKILL', pid)
+      Process.wait(pid)
+    rescue Errno::ESRCH, Errno::ECHILD
+      # ignore
+    end
+
+    def reap_process(pid, timeout = 10)
+      t0 = Time.now
+      while Time.now - t0 < timeout
+        wpid, _status = Process.wait2(pid, Process::WNOHANG)
+        return if wpid == pid
+
+        sleep 0.25
+      end
+
+      Process.kill('SIGKILL', pid)
+      Process.wait(pid)    
+    rescue Errno::ESRCH, Errno::ECHILD
+      # ignore
+    end
+
+    def kill_all_workers(timeout = 10)
+      t0 = Time.now
+      pids = @workers.keys
+      pids.each { Process.kill('SIGTERM', it) rescue nil }
+
+      while Time.now - t0 < timeout
+        wpid, _status = Process.wait2(-1, Process::WNOHANG)
+        if wpid
+          pids.delete(wpid)
+          @workers.delete(wpid)
+          return if pids.empty?
+        else
+          sleep 0.25
+        end
+      end
+
+      pids.each do
+        Process.kill('SIGKILL', it) rescue nil
+        Process.wait(it)
+        @workers.delete(it)
+      end
+    rescue Errno::ECHILD
+      # ignore
+    end
+
+    def need_spawn?
+      @workers.size < CLUSTER_SIZE
+    end
+
+    def select_leader
+      @leader_pid = @workers.keys.sort_by { @workers[it][:generation] }.last
+
+      on_leader_pid_changed
+    end
+
+    # returns [void]
+    def spawn_worker
+      return send_signal('SIGUSR1', @leader_pid) if @leader_pid
+        
+      pid = worker_class.new(@pipe_w, &@app).start
+      @workers[pid] = { stamp: Time.now.to_i, generation: 1 } if pid
+      pid
+    end
+
+    def worker_class
+      @opts[:worker_class] ||= Worker
+    end
+
+    def respawn
+      return if !@leader_pid
+
+      pids_to_replace = @workers.keys.select { it != @leader_pid }
+
+      while (pid = pids_to_replace.shift)
+        size_before = @workers.size
+        send_signal('SIGUSR1', @leader_pid)
+        sleep 0.1 while @workers.size > size_before
+        kill_process(pid)
+      end
+
+      select_leader
+    end
+
+    def send_signal(sig, pid)
+      Process.kill(sig, pid)
+    end
+
+    # event hooks (to be ovcerriden)
+    def on_leader_pid_changed(pid); end
+    def on_spawn_next_generation(pid); end
+    def on_reap(pid); end
+  end
+end

data/lib/coworker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Coworker
+  VERSION = "0.1.0"
+end

data/lib/coworker/worker.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Coworker
+  class Worker
+    attr_reader :fd, :generation
+
+    def initialize(conn, generation = 1, &app)
+      @fd = conn.fileno
+      @app = app
+      @generation = generation
+    end
+
+    def next_generation
+      self.class.new(IO.new(@fd), @generation + 1, &@app)
+    end
+
+    # Starts a forked orphaned worker process, 
+    def start
+      r, w = IO.pipe
+      w.sync = true
+
+      # we count on ChildSubreaper to make it so the
+      # grandparent process reaps the workers
+      parent_pid = fork do
+        fork do
+          send_ping
+          w << "#{Process.pid}"
+          w.close
+          run
+        end
+
+        w.close
+        send_msg("reap:#{Process.pid}")
+      end
+      # get grand-child PID
+      w.close
+      Process.wait(parent_pid)
+      r.read(16).to_i
+    end
+
+    private
+
+    def send_msg(msg)
+      if !@conn
+        @conn = IO.new(@fd)
+        @conn.sync = true
+      end
+      # tell supervisor to reap child
+      @conn.write "#{msg}\n"
+    end
+
+    def on_start
+    end
+
+    def on_stop
+    end
+
+    def run
+      on_start
+
+      @spawn_requests = Queue.new
+      trap(:SIGUSR1) { @spawn_requests << true }
+
+      spawn_thread = Thread.new { spawn_loop}
+      pinger_thread = Thread.new { ping_loop }
+      
+      @app.call(self)
+    ensure
+      on_stop
+      spawn_thread.kill.join
+      pinger_thread.kill.join
+      @conn&.close rescue nil
+    end
+
+    def spawn_loop
+      loop do
+        @spawn_requests.shift && next_generation.start
+      end
+    end
+
+    def send_ping
+      @pid ||= Process.pid
+      send_msg("ping:#{@pid}:#{@generation}")
+    end
+
+    def ping_loop
+      loop do
+        sleep 5
+        send_ping
+      end
+    end
+  end
+end

data/lib/coworker.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'coworker/version'
+require_relative 'coworker/supervisor'
+require_relative 'coworker/worker'
+
+module Coworker
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: coworker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sharon Rosner
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: child_subreaper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: for optimizing memory usage
+email:
+- sharon@noteflakes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- examples/simple.rb
+- lib/coworker.rb
+- lib/coworker/supervisor.rb
+- lib/coworker/version.rb
+- lib/coworker/worker.rb
+homepage: https://github.com/noteflakes/coworker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/noteflakes/coworker
+  source_code_uri: https://github.com/noteflakes/coworker
+  changelog_uri: https://github.com/noteflakes/coworker/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: Worker process supervision
+test_files: []