blue_green_process 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a12551178595d00eeb37b62eb34f7b06f577d2c8a345f4c91a18ec7fecb36f8b
+  data.tar.gz: 5f1b1fb9d5f967fbdd55f1a11840c090a92fb9429ce44b16b27da50e815c160a
+SHA512:
+  metadata.gz: 438555f06ca40cea7826b851d2750d8ed7e9a068afc6446d12c8666ebfd3c13d4cc40d70d2b497a7248485e3b7653943211fc41fb9713f61a84007089a841dd2
+  data.tar.gz: 16f58cfe3be851db0f9ea3086a3801fcd1229eebe2ed00b7338db8f200f0cb95eb6ef3843c9692a113e94e5a1706f084a8f39672cdc89561fb6eaeed2705d962

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  NewCops: disable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in blue_green_process.gemspec
+gemspec
+
+gem "pry"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    blue_green_process (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    json (2.6.2)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.32.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  blue_green_process!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 jiikko
+
+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,68 @@
+# BlueGreenProcess
+
+A library that solves GC bottlenecks with multi-process.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add blue_green_process
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install blue_green_process
+
+## Usage
+
+```ruby
+BlueGreenProcess.configure do |config|
+  config.after_fork = ->{ puts 'forked!'  }
+end
+
+process = BlueGreenProcess.new(
+  worker_instance: BlueGreenProcess::BaseWorker.new,
+  max_work: 14,
+)
+
+40.times do
+  process.work
+end
+
+sleep(1)
+
+process.shutdown
+loop do
+  result = Process.waitall
+  if result.empty?
+    break
+  else
+    sleep(0.01)
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/blue_green_process.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## NOTE
+* 前回の処理が終わっていないのにqueuingしない
+* workerの処理内容は固定
+
+## TODO
+* プロセスを入れ替えるときに変数を受け渡しをする
+* queueしてからのdequeueするまでの時間を測定したい
+    * webサーバでよくあるqueued timeみたいな扱い
+    * これが伸びると致命的なのでチューニングできるようにしたいため
+* inactiveからactiveへの切り替えになる時間を測定したい
+  * GCが長引いてactiveプロセスが処理開始に時間がかかるので

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/blue_green_process.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/blue_green_process/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "blue_green_process"
+  spec.version = BlueGreenProcess::VERSION
+  spec.authors = ["jiikko"]
+  spec.email = ["n905i.1214@gmail.com"]
+
+  spec.summary = "A library that solves GC bottlenecks with multi-process."
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/splaplapla/blue_green_process"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/splaplapla/blue_green_process"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/blue_green_process/base_worker.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module BlueGreenProcess
+  class BaseWorker
+    def work(*); end
+  end
+end

data/lib/blue_green_process/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module BlueGreenProcess
+  class Config
+    def after_fork=(block)
+      @after_fork_block = block
+    end
+
+    def after_fork
+      @after_fork_block || -> {}
+    end
+
+    def reset
+      @after_fork_block = nil
+    end
+  end
+end

data/lib/blue_green_process/master_process.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module BlueGreenProcess
+  class MasterProcess
+    def initialize(worker_instance:, max_work:)
+      blue = fork_process(label: :blue, worker_instance: worker_instance)
+      green = fork_process(label: :green, worker_instance: worker_instance)
+
+      @stage_state = true
+      @stage = {
+        true => blue.be_active,
+        false => green.be_inactive
+      }
+      @processes = @stage.values
+      @max_work = max_work
+    end
+
+    def fork_process(label:, worker_instance:)
+      child_read, parent_write = IO.pipe
+      parent_read, child_write = IO.pipe
+
+      pid = fork do
+        BlueGreenProcess.config.after_fork.call
+
+        parent_write.close
+        parent_read.close
+        process_status = :inactive
+
+        loop do
+          data = child_read.gets&.strip
+          case data
+          when BlueGreenProcess::PROCESS_COMMAND_DIE, nil, ""
+            BlueGreenProcess.debug_log "#{label}'ll die(#{$PROCESS_ID})"
+            exit 0
+          when BlueGreenProcess::PROCESS_COMMAND_BE_ACTIVE
+            process_status = BlueGreenProcess::PROCESS_STATUS_ACTIVE
+            BlueGreenProcess.debug_log "#{label}'ll be active(#{$PROCESS_ID})"
+            child_write.puts BlueGreenProcess::PROCESS_RESPONSE
+            ::GC.disable
+          when BlueGreenProcess::PROCESS_COMMAND_BE_INACTIVE
+            process_status = BlueGreenProcess::PROCESS_STATUS_INACTIVE
+            BlueGreenProcess.debug_log "#{label}'ll be inactive(#{$PROCESS_ID})"
+            child_write.puts BlueGreenProcess::PROCESS_RESPONSE
+            ::GC.enable
+            ::GC.start
+          when BlueGreenProcess::PROCESS_COMMAND_WORK
+            if process_status == BlueGreenProcess::PROCESS_STATUS_INACTIVE
+              warn "Should not be able to run in this status"
+            end
+
+            BlueGreenProcess.debug_log "#{label}'ll work(#{$PROCESS_ID})"
+            worker_instance.work(*label)
+            child_write.puts BlueGreenProcess::PROCESS_RESPONSE
+          else
+            child_write.puts "NG"
+            puts "unknown. from #{label}(#{$PROCESS_ID})"
+            exit 1
+          end
+        end
+
+        exit 0
+      end
+
+      child_write.close
+      child_read.close
+
+      BlueGreenProcess::WorkerProcess.new(pid, label, parent_read, parent_write)
+    end
+
+    def work
+      active_process do |process|
+        @max_work.times do
+          process.work
+        end
+      end
+
+      true
+    end
+
+    def shutdown
+      @processes.each do |process|
+        process.wpipe.puts(BlueGreenProcess::PROCESS_COMMAND_DIE)
+      end
+    end
+
+    private
+
+    def active_process
+      active_process = @stage[@stage_state].be_active
+      @stage[!@stage_state].be_inactive
+      yield(active_process)
+      @stage_state = !@stage_state
+    end
+  end
+end

data/lib/blue_green_process/version.rb

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

data/lib/blue_green_process/worker_process.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module BlueGreenProcess
+  class WorkerProcess
+    attr_accessor :pid, :label, :rpipe, :wpipe, :status
+
+    def initialize(pid, label, rpipe, wpipe)
+      self.pid = pid
+      self.label = label
+      self.rpipe = rpipe
+      self.wpipe = wpipe
+      self.status = BlueGreenProcess::PROCESS_STATUS_INACTIVE
+    end
+
+    def be_active
+      return self if status == BlueGreenProcess::PROCESS_STATUS_ACTIVE
+
+      write_and_await_until_read(BlueGreenProcess::PROCESS_COMMAND_BE_ACTIVE)
+      self.status = BlueGreenProcess::PROCESS_STATUS_ACTIVE
+      self
+    end
+
+    def be_inactive
+      return self if status == BlueGreenProcess::PROCESS_STATUS_INACTIVE
+
+      write_and_await_until_read(BlueGreenProcess::PROCESS_COMMAND_BE_INACTIVE)
+      self.status = BlueGreenProcess::PROCESS_STATUS_INACTIVE
+      self
+    end
+
+    def work
+      enforce_to_be_active
+
+      write_and_await_until_read(BlueGreenProcess::PROCESS_COMMAND_WORK)
+    end
+
+    private
+
+    def write_and_await_until_read(command)
+      write(command)
+      wait_response
+    end
+
+    def wait_response
+      response = read
+      raise "invalid response." unless response == BlueGreenProcess::PROCESS_RESPONSE
+    end
+
+    def read
+      rpipe.gets.strip
+    end
+
+    def write(token)
+      wpipe.puts token
+    end
+
+    def enforce_to_be_active
+      raise "activeじゃないのにrunできないです" if status != BlueGreenProcess::PROCESS_STATUS_ACTIVE
+    end
+  end
+end

data/lib/blue_green_process.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "English"
+require_relative "blue_green_process/version"
+require "blue_green_process/master_process"
+require "blue_green_process/worker_process"
+require "blue_green_process/base_worker"
+require "blue_green_process/config"
+
+module BlueGreenProcess
+  PROCESS_STATUS_ACTIVE = :active
+  PROCESS_STATUS_INACTIVE = :inactive
+
+  PROCESS_COMMAND_DIE = "die"
+  PROCESS_COMMAND_BE_ACTIVE = "be_active"
+  PROCESS_COMMAND_BE_INACTIVE = "work"
+  PROCESS_COMMAND_WORK = "be_inactive"
+
+  PROCESS_RESPONSE = "ACK"
+
+  def self.new(worker_instance:, max_work:)
+    BlueGreenProcess::MasterProcess.new(worker_instance: worker_instance, max_work: max_work)
+  end
+
+  def self.debug_log(message)
+    return unless ENV["VERBOSE"]
+
+    puts message
+  end
+
+  def self.configure
+    @config = Config.new
+    yield(@config)
+    true
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+end

data/sig/blue_green_process.rbs

@@ -0,0 +1,4 @@
+module BlueGreenProcess
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: blue_green_process
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jiikko
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-08-01 00:00:00.000000000 Z
+dependencies: []
+description: A library that solves GC bottlenecks with multi-process.
+email:
+- n905i.1214@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- blue_green_process.gemspec
+- lib/blue_green_process.rb
+- lib/blue_green_process/base_worker.rb
+- lib/blue_green_process/config.rb
+- lib/blue_green_process/master_process.rb
+- lib/blue_green_process/version.rb
+- lib/blue_green_process/worker_process.rb
+- sig/blue_green_process.rbs
+homepage: https://github.com/splaplapla/blue_green_process
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/splaplapla/blue_green_process
+  source_code_uri: https://github.com/splaplapla/blue_green_process
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.19
+signing_key:
+specification_version: 4
+summary: A library that solves GC bottlenecks with multi-process.
+test_files: []