blue_green_process 0.1.3 → 0.1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89de1bb6ab2d7f30cf4063f1f04411da882e1061550603ee8ca866839a62f9d0
-  data.tar.gz: dc64126db9c11c6e03dfa80be32aed24e0a7142f463efd04915729f335233c68
+  metadata.gz: 864e404c1e622e26d8689695a3791b4cf6c84709127617a5d778b550cb03527c
+  data.tar.gz: 002bba05528b78c7be7184c74bbbf0b94418c12d01d3c93cda5883043b6c376b
 SHA512:
-  metadata.gz: '00874bdfeba757a3e8cc5bba6cebdf8a8bfa63d2ab8ff4779f26a9ce5bd8a5afd9ac933e4833b8a0042ce55cefda62d69f70077396d8f6df9bb64961d2e12f70'
-  data.tar.gz: c5de3504ad7ec738260fcf4969ea9cb1cba38539f582ad122c159f543e05666ac1cc3dc7d8f1111134a5d8ad8ae4392006db8d7c4893f4d1214ae9bcea98361f
+  metadata.gz: 511d89c74a5a24331cb3d4cc3e72aacf92d8eaed3cc2abcfc4e8964949fa2760fb311d3dd265f2ef185a35c53af70042fa2106b0c6297548793a4565fbc2de9b
+  data.tar.gz: ab4c37316936239229d153bc4c54747cb184319bd04438d16c81100c0dfc8346c27273727b57112cc9f8f764b91ca4daa28fea8f00d848f93774d216fcde9cbb

data/.rubocop.yml

@@ -40,3 +40,6 @@ Metrics/ClassLength:
 
 Lint/AmbiguousBlockAssociation:
   Enabled: false
+
+Layout/LineLength:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.1.4.2] - 2022-12-25
+* プロセス終了時にDRb.stop_serviceを呼ぶのをやめました
+
+## [0.1.4.1] - 2022-12-13
+* プロセス終了時にDRb.stop_serviceを呼ぶようにしました
+
+## [0.1.4] - 2022-12-12
+* BlueGreenProcess.terminate_workers_immediately を呼び出すことで、シグナル経由で終了できるようになりました
+
 ## [0.1.3] - 2022-9-5
 * 単一プロセスでの実行を延長するとGC.startを実行しなくなりました
     * 長時間にわたって延長する時は呼び出し側でGC.startを実行してください

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    blue_green_process (0.1.3)
+    blue_green_process (0.1.4.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,6 +2,29 @@
 
 A library that solves GC bottlenecks with multi-process.
 
+```mermaid
+sequenceDiagram
+  autonumber
+  loop
+  Master->>+Blue: be active
+  Blue->>-Master: response
+  Master->>+Blue: work
+  Blue->>-Master: response
+  Master->>+Blue: be inactive
+  Blue->>-Master: response
+  Blue-->>Blue: GC.start
+  Master->>+Green: be active
+  Green->>-Master: response
+  Master->>+Green: work
+  Green->>-Master: response
+  Master->>+Green: be inactive
+  Green->>-Master: response
+  Green->>Green: GC.start
+end
+ 
+```
+
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -31,6 +54,7 @@ end
 sleep(1)
 
 process.shutdown
+# or BlueGreenProcess.terminate_workers_immediately
 Process.waitall
 ```
 
@@ -148,6 +172,3 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## TODO
 * shutdownしないでプロセスを停止したときにSIGINTを受け取りたい
-* runしている間にsignalをもらったらすぐにdieを送りたい
-* inactiveからactiveへの切り替えになる時間を測定したい
-  * GCが長引いてactiveプロセスが処理開始に時間がかかるので

data/lib/blue_green_process/master_process.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "English"
 module BlueGreenProcess
   class ErrorWrapper < StandardError
     attr_accessor :error_class, :message
@@ -24,10 +25,18 @@ module BlueGreenProcess
       @max_work = max_work
     end
 
+    # @return [Array<Integer>]
+    # 削除予定
     def pids
       @processes.map(&:pid)
     end
 
+    # @return [Array<Integer>]
+    def worker_pids
+      @processes.map(&:pid)
+    end
+
+    # @return [BlueGreenProcess::WorkerProcess]
     def fork_process(label:, worker_instance:)
       child_read, parent_write = IO.pipe
       parent_read, child_write = IO.pipe
@@ -39,10 +48,12 @@ module BlueGreenProcess
         parent_write.close
         parent_read.close
         process_status = :inactive
+        handle_signal(pipes: [child_read, child_write])
 
         loop do
-          data = child_read.gets&.strip
-          json = JSON.parse(data)
+          next unless (data = child_read.gets)
+
+          json = JSON.parse(data.strip)
           command = json["c"]
           case command
           when BlueGreenProcess::PROCESS_COMMAND_DIE, nil, ""
@@ -60,9 +71,7 @@ module BlueGreenProcess
                                data: BlueGreenProcess::SharedVariable.data }.to_json)
             ::GC.start unless BlueGreenProcess::SharedVariable.extend_run_on_this_process
           when BlueGreenProcess::PROCESS_COMMAND_WORK
-            if process_status == BlueGreenProcess::PROCESS_STATUS_INACTIVE
-              warn "Should not be able to run in this status"
-            end
+            warn "Should not be able to run in this status" if process_status == BlueGreenProcess::PROCESS_STATUS_INACTIVE
 
             begin
               worker_instance.work(*label)
@@ -76,6 +85,8 @@ module BlueGreenProcess
             puts "unknown. from #{label}(#{$PROCESS_ID})"
             exit 1
           end
+        rescue IOError # NOTE: シグナル経由でpipeが破棄された時にこれが発生する
+          exit 127
         end
 
         exit 0
@@ -87,6 +98,7 @@ module BlueGreenProcess
       BlueGreenProcess::WorkerProcess.new(pid, label, parent_read, parent_write)
     end
 
+    # @return [void]
     def work
       active_process do |process|
         @max_work.times do
@@ -99,6 +111,7 @@ module BlueGreenProcess
       raise eval(e.error_class), e.message
     end
 
+    # @return [void]
     def shutdown
       @processes.each(&:shutdown)
       Process.waitall
@@ -106,6 +119,7 @@ module BlueGreenProcess
 
     private
 
+    # @return [void]
     def active_process
       active_process = nil
       @stage[!@stage_state].be_inactive
@@ -126,5 +140,34 @@ module BlueGreenProcess
 
       true
     end
+
+    # @return [void]
+    # シグナルを受け取ってpipeをcloseする
+    def handle_signal(pipes:)
+      Thread.new do
+        self_read, self_write = IO.pipe
+        %w[INT TERM].each do |sig|
+          trap sig do
+            self_write.puts(sig)
+          end
+        rescue ArgumentError
+          warn("Signal #{sig} not supported")
+        end
+
+        begin
+          while (readable_io = IO.select([self_read]))
+            signal = readable_io.first[0].gets.strip
+            case signal
+            when "TERM"
+              raise Interrupt
+            when "INT"
+              BlueGreenProcess.logger.warn "[BLUE_GREEN_PROCESS][#{$PROCESS_ID}] INTシグナルは無視します"
+            end
+          end
+        rescue Interrupt
+          pipes.each(&:close)
+        end
+      end
+    end
   end
 end

data/lib/blue_green_process/version.rb

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

data/lib/blue_green_process/worker_process.rb

@@ -47,7 +47,9 @@ module BlueGreenProcess
     end
 
     def wait_response
-      response = JSON.parse(read)
+      return unless (text = read)
+
+      response = JSON.parse(text.strip)
       BlueGreenProcess::SharedVariable.instance.restore(response["data"])
       case response["c"]
       when BlueGreenProcess::RESPONSE_OK
@@ -60,11 +62,15 @@ module BlueGreenProcess
     end
 
     def read
-      rpipe.gets.strip
+      rpipe.gets
+    rescue IOError
+      # NOTE: シグナル経由でpipeが破棄された時にこれが発生する
     end
 
     def write(token, args = {})
       wpipe.puts({ c: token }.merge!(args).to_json)
+    rescue Errno::EPIPE
+      # NOTE: シグナル経由でpipeが破棄された時にこれが発生する
     end
 
     def enforce_to_be_active

data/lib/blue_green_process.rb

@@ -13,6 +13,8 @@ require "json"
 require "singleton"
 
 module BlueGreenProcess
+  PID_PATH = "/tmp/pbm_blue_green_process_pids"
+
   PROCESS_STATUS_ACTIVE = :active
   PROCESS_STATUS_INACTIVE = :inactive
 
@@ -25,7 +27,9 @@ module BlueGreenProcess
   RESPONSE_ERROR = "ERR"
 
   def self.new(worker_instance:, max_work:)
-    BlueGreenProcess::MasterProcess.new(worker_instance: worker_instance, max_work: max_work)
+    master_process = BlueGreenProcess::MasterProcess.new(worker_instance: worker_instance, max_work: max_work)
+    File.write(PID_PATH, master_process.worker_pids.join(","))
+    master_process
   end
 
   def self.configure
@@ -50,4 +54,30 @@ module BlueGreenProcess
     @config = Config.new
     @performance = Performance.new
   end
+
+  # @return [void]
+  def self.terminate_workers_immediately
+    BlueGreenProcess.logger.warn "[BLUE_GREEN_PROCESS][#{$PROCESS_ID}] TERMシグナルを送信します"
+
+    worker_pids = nil
+    begin
+      worker_pids = File.read(PID_PATH).split(",").map(&:to_i)
+    rescue Errno::ENOENT
+      warn("#{PID_PATH}にファイルがありませんでした")
+      return
+    end
+
+    worker_pids.each do |worker_pid|
+      Process.kill "TERM", worker_pid
+    rescue Errno::ESRCH => e
+      BlueGreenProcess.logger.warn("[BLUE_GREEN_PROCESS][#{$PROCESS_ID}] workerプロセス(#{worker_pid})の終了に失敗しました。#{e.message}")
+    end
+
+    begin
+      Process.wait
+    rescue Errno::ECHILD => e
+      BlueGreenProcess.logger.warn("[BLUE_GREEN_PROCESS][#{$PROCESS_ID}] Process.wait(#{e.message})に失敗しました")
+    end
+    BlueGreenProcess.logger.warn "[BLUE_GREEN_PROCESS][#{$PROCESS_ID}] TERMシグナルを送信しました"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blue_green_process
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4.2
 platform: ruby
 authors:
 - jiikko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
+date: 2022-12-25 00:00:00.000000000 Z
 dependencies: []
 description: A library that solves GC bottlenecks with multi-process.
 email: