serverengine 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1c09d476bdc08a078882ba14ee74f487ab988a397d2228c3e83f611fff94df1
-  data.tar.gz: 33732af3d1c591ec28c67249b1b67b16b142f80048f70c3cf5c769b3e267b76a
+  metadata.gz: 8b802588a6e93b69c2dc9810ab33b9e3195e14d93c5f977961a04cc6d88cacf1
+  data.tar.gz: 9921383ec5ae39cfe982da9ce8c0b432bbc553c2ea5d2090a2d849ec2500c230
 SHA512:
-  metadata.gz: 383aaf8822f01aec3ce2e4a25243da8ca741da9d11f97c601c31cc6985e285743a088cafdd4fd918b58a966960376f65b28645b1fca74d0741e64052bd329ac8
-  data.tar.gz: ca10bd75948760060c8ae433cb2021a7024d6b076d84157012db5ae6809d01c9a8bb2eb2bb1f9f8d84f0881e4cbaf3bebfb25ef959130574e0cf717550ee1867
+  metadata.gz: ea4c0e4b34490665e4287c0f43e4ea1f32c10fe022464a69326505ec21aad2650e53b842c2aaeec2a969d914f73715ee059b2bdbb3d72d14b0bce51192bf217c
+  data.tar.gz: 3e30810b08b8667f2295b41fca60c4683126d8936e32169d0789b8ec02ba3965fc631dbe069c9a8cf057e109ccaa9ad3ad14f4507b2388dcd9ae27463ce39651

data/Changelog

@@ -1,3 +1,7 @@
+2022-12-22 version 2.3.1
+
+* Don't treat as error when worker shuts down with exit status 0
+
 2022-06-13 version 2.3.0
 
 * Add restart_worker_interval option to prevent workers restart immediately
@@ -13,6 +17,7 @@
 2022-01-13 version 2.2.5:
 
 * Fix DLL load error on Ruby 3.1 on Windows
+* Treat as error when worker shuts down unexpectedly
 
 2021-05-24 version 2.2.4:
 

data/lib/serverengine/multi_process_server.rb

@@ -147,7 +147,11 @@ module ServerEngine
           if @stop
             @worker.logger.info "Worker #{@wid} finished with #{ServerEngine.format_join_status(stat)}"
           else
-            @worker.logger.error "Worker #{@wid} finished unexpectedly with #{ServerEngine.format_join_status(stat)}"
+            if stat.is_a?(Process::Status) && stat.success?
+              @worker.logger.info "Worker #{@wid} exited with #{ServerEngine.format_join_status(stat)}"
+            else
+              @worker.logger.error "Worker #{@wid} exited unexpectedly with #{ServerEngine.format_join_status(stat)}"
+            end
           end
           if stat.is_a?(Process::Status) && stat.exited? && @unrecoverable_exit_codes.include?(stat.exitstatus)
             @unrecoverable_exit = true

data/lib/serverengine/version.rb

@@ -1,3 +1,3 @@
 module ServerEngine
-  VERSION = "2.3.0"
+  VERSION = "2.3.1"
 end

data/serverengine.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake-compiler', ['~> 0.9.4']
 
   gem.add_development_dependency "timecop", ["~> 0.9.5"]
+  gem.add_development_dependency "rr", ["~> 3.1"]
 end

data/spec/daemon_spec.rb

@@ -2,6 +2,14 @@
 describe ServerEngine::Daemon do
   include_context 'test server and worker'
 
+  before do
+    @log_path = "tmp/multi-worker-test-#{SecureRandom.hex(10)}.log"
+  end
+
+  after do
+    FileUtils.rm_rf(@log_path)
+  end
+
   it 'run and graceful stop by signal' do
     pending "not supported signal base commands on Windows" if ServerEngine.windows?
 
@@ -111,6 +119,7 @@ describe ServerEngine::Daemon do
       daemonize: false,
       supervisor: false,
       pid_path: "tmp/pid",
+      logger: ServerEngine::DaemonLogger.new(@log_path),
       log_stdout: false,
       log_stderr: false,
       unrecoverable_exit_codes: [3,4,5],
@@ -135,6 +144,7 @@ describe ServerEngine::Daemon do
       supervisor: false,
       worker_type: 'process',
       pid_path: "tmp/pid",
+      logger: ServerEngine::DaemonLogger.new(@log_path),
       log_stdout: false,
       log_stderr: false,
       unrecoverable_exit_codes: [3,4,5],
@@ -158,6 +168,7 @@ describe ServerEngine::Daemon do
       supervisor: true,
       worker_type: 'process',
       pid_path: "tmp/pid",
+      logger: ServerEngine::DaemonLogger.new(@log_path),
       log_stdout: false,
       log_stderr: false,
       unrecoverable_exit_codes: [3,4,5],

data/spec/multi_process_server_spec.rb

@@ -1,13 +1,30 @@
+require 'timeout'
+require 'securerandom'
+
 [ServerEngine::MultiThreadServer, ServerEngine::MultiProcessServer].each do |impl_class|
   # MultiProcessServer uses fork(2) internally, then it doesn't support Windows.
 
   describe impl_class do
     include_context 'test server and worker'
 
+    before do
+      @log_path = "tmp/multi-worker-test-#{SecureRandom.hex(10)}.log"
+      @logger = ServerEngine::DaemonLogger.new(@log_path)
+    end
+
+    after do
+      FileUtils.rm_rf(@log_path)
+    end
+
     it 'scale up' do
       pending "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
 
-      config = {workers: 2, log_stdout: false, log_stderr: false}
+      config = {
+        workers: 2,
+        logger: @logger,
+        log_stdout: false,
+        log_stderr: false,
+      }
 
       s = impl_class.new(TestWorker) { config.dup }
       t = Thread.new { s.main }
@@ -35,7 +52,12 @@
     it 'scale down' do
       pending "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
 
-      config = {workers: 2, log_stdout: false, log_stderr: false}
+      config = {
+        workers: 2,
+        logger: @logger,
+        log_stdout: false,
+        log_stderr: false
+      }
 
       s = impl_class.new(TestWorker) { config.dup }
       t = Thread.new { s.main }
@@ -59,12 +81,32 @@
 
       test_state(:worker_stop).should == 3
     end
+  end
+end
+
+[ServerEngine::MultiProcessServer].each do |impl_class|
+  describe impl_class do
+    include_context 'test server and worker'
+
+    before do
+      @log_path = "tmp/multi-worker-test-#{SecureRandom.hex(10)}.log"
+      @logger = ServerEngine::DaemonLogger.new(@log_path)
+    end
+
+    after do
+      FileUtils.rm_rf(@log_path)
+    end
 
     it 'raises SystemExit when all workers exit with specified code by unrecoverable_exit_codes' do
-      pending "unrecoverable_exit_codes supported only for multi process workers" if impl_class == ServerEngine::MultiThreadServer
       pending "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
 
-      config = {workers: 4, log_stdout: false, log_stderr: false, unrecoverable_exit_codes: [3, 4, 5]}
+      config = {
+        workers: 4,
+        logger: @logger,
+        log_stdout: false,
+        log_stderr: false,
+        unrecoverable_exit_codes: [3, 4, 5]
+      }
 
       s = impl_class.new(TestExitWorker) { config.dup }
       raised_error = nil
@@ -85,10 +127,16 @@
     end
 
     it 'raises SystemExit immediately when a worker exits if stop_immediately_at_unrecoverable_exit specified' do
-      pending "unrecoverable_exit_codes supported only for multi process workers" if impl_class == ServerEngine::MultiThreadServer
       pending "Windows environment does not support fork" if ServerEngine.windows? && impl_class == ServerEngine::MultiProcessServer
 
-      config = {workers: 4, log_stdout: false, log_stderr: false, unrecoverable_exit_codes: [3, 4, 5], stop_immediately_at_unrecoverable_exit: true}
+      config = {
+        workers: 4,
+        logger: @logger,
+        log_stdout: false,
+        log_stderr: false,
+        unrecoverable_exit_codes: [3, 4, 5],
+        stop_immediately_at_unrecoverable_exit: true
+      }
 
       s = impl_class.new(TestExitWorker) { config.dup }
       raised_error = nil
@@ -111,3 +159,101 @@
     end
   end
 end
+
+describe "log level for exited proccess" do
+  include_context 'test server and worker'
+
+  before do
+    @log_path = "tmp/multi-process-log-level-test-#{SecureRandom.hex(10)}.log"
+  end
+
+  after do
+    FileUtils.rm_rf(@log_path)
+  end
+
+  it 'stop' do
+    pending "Windows environment does not support fork" if ServerEngine.windows?
+
+    config = {
+      workers: 1,
+      logger: ServerEngine::DaemonLogger.new(@log_path),
+      log_stdout: false,
+      log_stderr: false,
+    }
+
+    s = ServerEngine::MultiProcessServer.new(TestWorker) { config.dup }
+    t = Thread.new { s.main }
+
+    begin
+      wait_for_fork
+      test_state(:worker_run).should == 1
+    ensure
+      s.stop(true)
+      t.join
+    end
+
+    log_lines = File.read(@log_path).split("\n")
+    expect(log_lines[2]).to match(/^I, \[\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d+ #\d+\]  INFO -- : Worker 0 finished with status 0$/)
+  end
+
+  it 'non zero exit status' do
+    pending "Windows environment does not support fork" if ServerEngine.windows?
+
+    config = {
+      workers: 1,
+      logger: ServerEngine::DaemonLogger.new(@log_path),
+      log_stdout: false,
+      log_stderr: false,
+      unrecoverable_exit_codes: [5],
+    }
+
+    s = ServerEngine::MultiProcessServer.new(TestExitWorker) { config.dup }
+    raised_error = nil
+    Thread.new do
+      begin
+        s.main
+      rescue SystemExit => e
+        raised_error = e
+      end
+    end.join
+
+    test_state(:worker_stop).to_i.should == 0
+    raised_error.status.should == 5
+    log_lines = File.read(@log_path).split("\n")
+    expect(log_lines[1]).to match(/^E, \[\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d+ #\d+\] ERROR -- : Worker 0 exited unexpectedly with status 5$/)
+  end
+
+  module TestNormalExitWorker
+    include TestExitWorker
+    def initialize
+      super
+      @exit_code = 0
+    end
+  end
+
+  it 'zero exit status' do
+    pending "Windows environment does not support fork" if ServerEngine.windows?
+
+    config = {
+      workers: 1,
+      logger: ServerEngine::DaemonLogger.new(@log_path),
+      log_stdout: false,
+      log_stderr: false,
+    }
+
+    s = ServerEngine::MultiProcessServer.new(TestNormalExitWorker) { config.dup }
+    t = Thread.new { s.main }
+
+    begin
+      Timeout.timeout(5) do
+        sleep 1 until File.read(@log_path).include?("INFO -- : Worker 0 exited with status 0")
+      end
+    ensure
+      s.stop(true)
+      t.join
+    end
+
+    log_lines = File.read(@log_path).split("\n")
+    expect(log_lines[1]).to match(/^I, \[\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d+ #\d+\]  INFO -- : Worker 0 exited with status 0$/)
+  end
+end

data/spec/multi_spawn_server_spec.rb

@@ -4,10 +4,25 @@ require 'timecop'
 describe ServerEngine::MultiSpawnServer do
   include_context 'test server and worker'
 
+  before do
+    @log_path = "tmp/multi-worker-test-#{SecureRandom.hex(10)}.log"
+    @logger = ServerEngine::DaemonLogger.new(@log_path)
+  end
+
+  after do
+    FileUtils.rm_rf(@log_path)
+  end
+
   describe 'starts worker processes' do
     context 'with command_sender=pipe' do
       it do
-        config = {workers: 2, command_sender: 'pipe', log_stdout: false, log_stderr: false}
+        config = {
+          workers: 2,
+          command_sender: 'pipe',
+          logger: @logger,
+          log_stdout: false,
+          log_stderr: false
+        }
 
         s = ServerEngine::MultiSpawnServer.new(TestWorker) { config.dup }
         t = Thread.new { s.main }
@@ -32,6 +47,7 @@ describe ServerEngine::MultiSpawnServer do
       {
         workers: workers,
         command_sender: 'pipe',
+        logger: @logger,
         log_stdout: false,
         log_stderr: false,
         start_worker_delay: start_worker_delay,

data/spec/supervisor_spec.rb

@@ -1,8 +1,12 @@
+require 'rr'
 
 describe ServerEngine::Supervisor do
   include_context 'test server and worker'
 
   def start_supervisor(worker = nil, **config)
+    config[:log] ||= @log_path
+    config[:log_stdout] ||= false
+    config[:log_stderr] ||= false
     if ServerEngine.windows?
       config[:windows_daemon_cmdline] = windows_supervisor_cmdline(nil, worker, config)
     end
@@ -13,6 +17,8 @@ describe ServerEngine::Supervisor do
   end
 
   def start_daemon(**config)
+    config[:log_stdout] ||= false
+    config[:log_stderr] ||= false
     if ServerEngine.windows?
       config[:windows_daemon_cmdline] = windows_daemon_cmdline
     end
@@ -22,9 +28,17 @@ describe ServerEngine::Supervisor do
     return daemon, t
   end
 
+  before do
+    @log_path = "tmp/supervisor-test-#{SecureRandom.hex(10)}.log"
+  end
+
+  after do
+    FileUtils.rm_rf(@log_path)
+  end
+
   context 'when :log=IO option is given' do
     it 'can start' do
-      daemon, t = start_daemon(log: STDOUT)
+      daemon, t = start_daemon(log: File.open(@log_path, "wb"))
 
       begin
         wait_for_fork
@@ -40,7 +54,7 @@ describe ServerEngine::Supervisor do
 
   context 'when :logger option is given' do
     it 'uses specified logger instance' do
-      logger = ServerEngine::DaemonLogger.new(STDOUT)
+      logger = ServerEngine::DaemonLogger.new(@log_path)
       daemon, t = start_daemon(logger: logger)
 
       begin
@@ -57,7 +71,7 @@ describe ServerEngine::Supervisor do
 
   context 'when both :logger and :log options are given' do
     it 'start ignoring :log' do
-      logger = ServerEngine::DaemonLogger.new(STDOUT)
+      logger = ServerEngine::DaemonLogger.new(@log_path)
       daemon, t = start_daemon(logger: logger, log: STDERR)
 
       begin
@@ -188,6 +202,8 @@ describe ServerEngine::Supervisor do
       it 'auto restart in limited ratio' do
         pending 'not supported on Windows' if ServerEngine.windows? && sender == 'signal'
 
+        RR.stub(ServerEngine).dump_uncaught_error
+
         sv, t = start_supervisor(RunErrorWorker, server_restart_wait: 1, command_sender: sender)
 
         begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverengine
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-13 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sigdump
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: A framework to implement robust multiprocess servers like Unicorn
 email:
 - frsyuki@gmail.com