serverengine 2.0.7 → 2.3.0

data/lib/serverengine/socket_manager_unix.rb

@@ -50,19 +50,30 @@ module ServerEngine
       private
 
       def listen_tcp_new(bind_ip, port)
-        sock = TCPServer.new(bind_ip.to_s, port)
-        sock.listen(Socket::SOMAXCONN)  # TODO make backlog configurable if necessary
-        return sock
+        if ENV['SERVERENGINE_USE_SOCKET_REUSEPORT'] == '1'
+          # Based on Addrinfo#listen
+          tsock = Socket.new(bind_ip.ipv6? ? ::Socket::AF_INET6 : ::Socket::AF_INET, ::Socket::SOCK_STREAM, 0)
+          tsock.ipv6only! if bind_ip.ipv6?
+          tsock.setsockopt(:SOCKET, :REUSEPORT, true)
+          tsock.setsockopt(:SOCKET, :REUSEADDR, true)
+          tsock.bind(Addrinfo.tcp(bind_ip.to_s, port))
+          tsock.listen(::Socket::SOMAXCONN)
+          tsock.autoclose = false
+          TCPServer.for_fd(tsock.fileno)
+        else
+          # TCPServer.new doesn't set IPV6_V6ONLY flag, so use Addrinfo class instead.
+          # TODO: make backlog configurable if necessary
+          tsock = Addrinfo.tcp(bind_ip.to_s, port).listen(::Socket::SOMAXCONN)
+          tsock.autoclose = false
+          TCPServer.for_fd(tsock.fileno)
+        end
       end
 
       def listen_udp_new(bind_ip, port)
-        if bind_ip.ipv6?
-          sock = UDPSocket.new(Socket::AF_INET6)
-        else
-          sock = UDPSocket.new(Socket::AF_INET)
-        end
-        sock.bind(bind_ip.to_s, port)
-        return sock
+        # UDPSocket.new doesn't set IPV6_V6ONLY flag, so use Addrinfo class instead.
+        usock = Addrinfo.udp(bind_ip.to_s, port).bind
+        usock.autoclose = false
+        UDPSocket.for_fd(usock.fileno)
       end
 
       def start_server(path)
@@ -70,7 +81,12 @@ module ServerEngine
         # when client changed working directory
         path = File.expand_path(path)
 
-        @server = UNIXServer.new(path)
+        begin
+          old_umask = File.umask(0077) # Protect unix socket from other users
+          @server = UNIXServer.new(path)
+        ensure
+          File.umask(old_umask)
+        end
 
         @thread = Thread.new do
           begin
@@ -96,7 +112,14 @@ module ServerEngine
       end
 
       def send_socket(peer, pid, method, bind, port)
-        sock = send(method, bind, port)  # calls listen_tcp or listen_udp
+        sock = case method
+               when :listen_tcp
+                 listen_tcp(bind, port)
+               when :listen_udp
+                 listen_udp(bind, port)
+               else
+                 raise ArgumentError, "Unknown method: #{method.inspect}"
+               end
 
         SocketManager.send_peer(peer, nil)
 

data/lib/serverengine/version.rb

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

data/lib/serverengine/winsock.rb

@@ -21,6 +21,7 @@ module ServerEngine
     require 'fiddle/import'
     require 'fiddle/types'
     require 'socket'
+    require 'rbconfig'
 
     extend Fiddle::Importer
 
@@ -78,6 +79,19 @@ module ServerEngine
       end
     end
 
+    def self.last_error
+      # On Ruby 3.0 calling WSAGetLastError here can't retrieve correct error
+      # code because Ruby's internal code resets it.
+      # See also:
+      # * https://github.com/ruby/fiddle/issues/72
+      # * https://bugs.ruby-lang.org/issues/17813
+      if Fiddle.respond_to?(:win32_last_socket_error)
+        Fiddle.win32_last_socket_error || 0
+      else
+        self.WSAGetLastError
+      end
+    end
+
     INVALID_SOCKET = -1
   end
 
@@ -85,21 +99,13 @@ module ServerEngine
     extend Fiddle::Importer
 
     dlload "kernel32"
-    extern "int GetModuleFileNameA(int, char *, int)"
     extern "int CloseHandle(int)"
 
-    ruby_bin_path_buf = Fiddle::Pointer.malloc(1000)
-    GetModuleFileNameA(0, ruby_bin_path_buf, ruby_bin_path_buf.size)
-
-    ruby_bin_path = ruby_bin_path_buf.to_s.gsub(/\\/, '/')
-    ruby_dll_paths = File.dirname(ruby_bin_path) + '/*msvcr*ruby*.dll'
-    ruby_dll_path = Dir.glob(ruby_dll_paths).first
-    dlload ruby_dll_path
-
+    dlload RbConfig::CONFIG['LIBRUBY_SO']
     extern "int rb_w32_map_errno(int)"
 
     def self.raise_last_error(name)
-      errno = rb_w32_map_errno(WinSock.WSAGetLastError)
+      errno = rb_w32_map_errno(WinSock.last_error)
       raise SystemCallError.new(name, errno)
     end
 

data/lib/serverengine.rb

@@ -35,12 +35,27 @@ module ServerEngine
 
   def self.ruby_bin_path
     if ServerEngine.windows?
-      require 'windows/library'
-      ruby_path = "\0" * 256
-      Windows::Library::GetModuleFileName.call(0, ruby_path, 256)
-      return ruby_path.rstrip.gsub(/\\/, '/')
+      ServerEngine::Win32.ruby_bin_path
     else
-      return File.join(RbConfig::CONFIG["bindir"], RbConfig::CONFIG["RUBY_INSTALL_NAME"]) + RbConfig::CONFIG["EXEEXT"]
+      File.join(RbConfig::CONFIG["bindir"], RbConfig::CONFIG["RUBY_INSTALL_NAME"]) + RbConfig::CONFIG["EXEEXT"]
+    end
+  end
+
+  if ServerEngine.windows?
+    module Win32
+      require 'fiddle/import'
+
+      extend Fiddle::Importer
+
+      dlload "kernel32"
+      extern "int GetModuleFileNameW(int, void *, int)"
+
+      def self.ruby_bin_path
+        ruby_bin_path_buf = Fiddle::Pointer.malloc(1024)
+        len = GetModuleFileNameW(0, ruby_bin_path_buf, ruby_bin_path_buf.size / 2)
+        path_bytes = ruby_bin_path_buf[0, len * 2]
+        path_bytes.encode('UTF-8', 'UTF-16LE').gsub(/\\/, '/')
+      end
     end
   end
 end

data/serverengine.gemspec

@@ -27,11 +27,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake-compiler-dock', ['~> 0.5.0']
   gem.add_development_dependency 'rake-compiler', ['~> 0.9.4']
 
-  # build gem for a certain platform. see also Rakefile
-  fake_platform = ENV['GEM_BUILD_FAKE_PLATFORM'].to_s
-  gem.platform = fake_platform unless fake_platform.empty?
-  if /mswin|mingw/ =~ fake_platform || (/mswin|mingw/ =~ RUBY_PLATFORM && fake_platform.empty?)
-    # windows dependencies
-    gem.add_runtime_dependency("windows-pr", ["~> 1.2.5"])
-  end
+  gem.add_development_dependency "timecop", ["~> 0.9.5"]
 end

data/spec/blocking_flag_spec.rb

@@ -20,10 +20,16 @@ describe ServerEngine::BlockingFlag do
   it 'wait_for_set timeout' do
     start = Time.now
 
-    subject.wait_for_set(0.01)
+    subject.wait_for_set(0.1)
     elapsed = Time.now - start
 
-    elapsed.should >= 0.01
+    if ServerEngine.windows? && ENV['CI'] == 'True'
+      # timer seems low accuracy on Windows CI container, often a bit shorter
+      # than expected
+      elapsed.should >= 0.1 * 0.95
+    else
+      elapsed.should >= 0.1
+    end
   end
 
   it 'wait_for_reset timeout' do
@@ -31,10 +37,16 @@ describe ServerEngine::BlockingFlag do
 
     start = Time.now
 
-    subject.wait_for_reset(0.01)
+    subject.wait_for_reset(0.1)
     elapsed = Time.now - start
 
-    elapsed.should >= 0.01
+    if ServerEngine.windows? && ENV['CI'] == 'True'
+      # timer seems low accuracy on Windows CI container, often a bit shorter
+      # than expected
+      elapsed.should >= 0.1 * 0.95
+    else
+      elapsed.should >= 0.1
+    end
   end
 
   it 'wait' do

data/spec/daemon_logger_spec.rb

@@ -1,4 +1,5 @@
 require 'stringio'
+require 'timecop'
 
 describe ServerEngine::DaemonLogger do
   before { FileUtils.rm_rf("tmp") }
@@ -172,4 +173,28 @@ describe ServerEngine::DaemonLogger do
     $stderr = STDERR
     stderr.should_not =~ /(log shifting failed|log writing failed|log rotation inter-process lock failed)/
   end
+
+  it 'reopen log when path is renamed' do
+    pending "rename isn't supported on windows" if ServerEngine.windows?
+
+    log = DaemonLogger.new("tmp/rotate.log", { level: 'info', log_rotate_age: 0  })
+
+    log.info '11111'
+    File.read("tmp/rotate.log").should include('11111')
+    File.rename("tmp/rotate.log", "tmp/rotate.log.1")
+
+    Timecop.travel(Time.now + 1)
+
+    log.info '22222'
+    contents = File.read("tmp/rotate.log.1")
+    contents.should include('11111')
+    contents.should include('22222')
+
+    FileUtils.touch("tmp/rotate.log")
+    Timecop.travel(Time.now + 1)
+
+    log.info '33333'
+    File.read("tmp/rotate.log").should include('33333')
+    File.read("tmp/rotate.log.1").should_not include('33333')
+  end
 end

data/spec/multi_spawn_server_spec.rb

@@ -1,25 +1,208 @@
 require 'timeout'
+require 'timecop'
 
 describe ServerEngine::MultiSpawnServer do
   include_context 'test server and worker'
 
-  context 'with command_sender=pipe' do
-    it 'starts worker processes' do
-      config = {workers: 2, command_sender: 'pipe', log_stdout: false, log_stderr: false}
+  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}
 
-      s = ServerEngine::MultiSpawnServer.new(TestWorker) { config.dup }
-      t = Thread.new { s.main }
+        s = ServerEngine::MultiSpawnServer.new(TestWorker) { config.dup }
+        t = Thread.new { s.main }
 
-      begin
-        wait_for_fork
+        begin
+          wait_for_fork
 
-        Timeout.timeout(5) do
-          sleep(0.5) until test_state(:worker_run) == 2
+          Timeout.timeout(5) do
+            sleep(0.5) until test_state(:worker_run) == 2
+          end
+          test_state(:worker_run).should == 2
+        ensure
+          s.stop(true)
+          t.join
+        end
+      end
+    end
+  end
+
+  describe 'keepalive_workers' do
+    let(:config) {
+      {
+        workers: workers,
+        command_sender: 'pipe',
+        log_stdout: false,
+        log_stderr: false,
+        start_worker_delay: start_worker_delay,
+        start_worker_delay_rand: 0,
+        restart_worker_interval: restart_worker_interval,
+      }
+    }
+    let(:workers) { 3 }
+    let(:server) { ServerEngine::MultiSpawnServer.new(TestWorker) { config.dup } }
+    let(:monitors) { server.instance_variable_get(:@monitors) }
+
+    context 'default' do
+      let(:start_worker_delay) { 0 }
+      let(:restart_worker_interval) { 0 }
+
+      it do
+        t = Thread.new { server.main }
+
+        begin
+          wait_for_fork
+
+          Timeout.timeout(5) do
+            sleep(0.5) until monitors.count { |m| m && m.alive? } == workers
+          end
+
+          monitors.each do |m|
+            m.send_stop(true)
+          end
+
+          # To prevent the judge before stopping once
+          wait_for_stop
+
+          -> {
+            Timeout.timeout(5) do
+              sleep(0.5) until monitors.count { |m| m.alive? } == workers
+            end
+          }.should_not raise_error, "Not all workers restarted correctly."
+        ensure
+          server.stop(true)
+          t.join
+        end
+      end
+    end
+
+    context 'with only restart_worker_interval' do
+      let(:start_worker_delay) { 0 }
+      let(:restart_worker_interval) { 10 }
+
+      it do
+        t = Thread.new { server.main }
+
+        begin
+          wait_for_fork
+
+          # Wait for initial starting
+          Timeout.timeout(5) do
+            sleep(0.5) until monitors.count { |m| m && m.alive? } == workers
+          end
+
+          monitors.each do |m|
+            m.send_stop(true)
+          end
+
+          # Wait for all workers to stop and to be set restarting time
+          Timeout.timeout(5) do
+            sleep(0.5) until monitors.count { |m| m.alive? || m.restart_at.nil? } == 0
+          end
+
+          Timecop.freeze
+
+          mergin_time = 3
+
+          Timecop.freeze(Time.now + restart_worker_interval - mergin_time)
+          sleep(1.5)
+          monitors.count { |m| m.alive? }.should == 0
+
+          Timecop.freeze(Time.now + 2 * mergin_time)
+          -> {
+            Timeout.timeout(5) do
+              sleep(0.5) until monitors.count { |m| m.alive? } == workers
+            end
+          }.should_not raise_error, "Not all workers restarted correctly."
+        ensure
+          server.stop(true)
+          t.join
+        end
+      end
+    end
+
+    context 'with only start_worker_delay' do
+      let(:start_worker_delay) { 3 }
+      let(:restart_worker_interval) { 0 }
+
+      it do
+        t = Thread.new { server.main }
+
+        begin
+          wait_for_fork
+
+          # Initial starts are delayed too, so set longer timeout.
+          # (`start_worker_delay` uses `sleep` inside, so Timecop can't skip this wait.)
+          Timeout.timeout(start_worker_delay * workers) do
+            sleep(0.5) until monitors.count { |m| m && m.alive? } == workers
+          end
+
+          # Skip time to avoid getting a delay for the initial starts.
+          Timecop.travel(Time.now + start_worker_delay)
+
+          monitors.each do |m|
+            m.send_stop(true)
+          end
+
+          sleep(3)
+
+          # The first worker should restart immediately.
+          monitors.count { |m| m.alive? }.should satisfy { |c| 0 < c && c < workers }
+
+          # `start_worker_delay` uses `sleep` inside, so Timecop can't skip this wait.
+          sleep(start_worker_delay * workers)
+          monitors.count { |m| m.alive? }.should == workers
+        ensure
+          server.stop(true)
+          t.join
+        end
+      end
+    end
+
+    context 'with both options' do
+      let(:start_worker_delay) { 3 }
+      let(:restart_worker_interval) { 10 }
+
+      it do
+        t = Thread.new { server.main }
+
+        begin
+          wait_for_fork
+
+          # Initial starts are delayed too, so set longer timeout.
+          # (`start_worker_delay` uses `sleep` inside, so Timecop can't skip this wait.)
+          Timeout.timeout(start_worker_delay * workers) do
+            sleep(0.5) until monitors.count { |m| m && m.alive? } == workers
+          end
+
+          monitors.each do |m|
+            m.send_stop(true)
+          end
+
+          # Wait for all workers to stop and to be set restarting time
+          Timeout.timeout(5) do
+            sleep(0.5) until monitors.count { |m| m.alive? || m.restart_at.nil? } == 0
+          end
+
+          Timecop.freeze
+
+          mergin_time = 3
+
+          Timecop.freeze(Time.now + restart_worker_interval - mergin_time)
+          sleep(1.5)
+          monitors.count { |m| m.alive? }.should == 0
+
+          Timecop.travel(Time.now + 2 * mergin_time)
+          sleep(1.5)
+          monitors.count { |m| m.alive? }.should satisfy { |c| 0 < c && c < workers }
+
+          # `start_worker_delay` uses `sleep` inside, so Timecop can't skip this wait.
+          sleep(start_worker_delay * workers)
+          monitors.count { |m| m.alive? }.should == workers
+        ensure
+          server.stop(true)
+          t.join
         end
-        test_state(:worker_run).should == 2
-      ensure
-        s.stop(true)
-        t.join
       end
     end
   end

data/spec/server_worker_context.rb

@@ -1,6 +1,7 @@
 
 require 'thread'
 require 'yaml'
+require 'timecop'
 
 def reset_test_state
   FileUtils.mkdir_p 'tmp'
@@ -165,8 +166,9 @@ module TestWorker
 
   def run
     incr_test_state :worker_run
-    5.times do
-      # repeats 5 times because signal handlers
+    # This means this worker will automatically finish after 50 seconds.
+    10.times do
+      # repeats multiple times because signal handlers
       # interrupts wait
       @stop_flag.wait(5.0)
     end
@@ -252,16 +254,25 @@ end
 
 shared_context 'test server and worker' do
   before { reset_test_state }
+  after { Timecop.return }
+
+  unless self.const_defined?(:WAIT_RATIO)
+    if ServerEngine.windows?
+      WAIT_RATIO = 2
+    else
+      WAIT_RATIO = 1
+    end
+  end
 
   def wait_for_fork
-    sleep 0.8
+    sleep 1.5 * WAIT_RATIO
   end
 
   def wait_for_stop
-    sleep 0.8
+    sleep 0.8 * WAIT_RATIO
   end
 
   def wait_for_restart
-    sleep 1.5
+    sleep 1.5 * WAIT_RATIO
   end
 end

data/spec/socket_manager_spec.rb

@@ -19,7 +19,21 @@ describe ServerEngine::SocketManager do
     File.unlink(server_path) if server_path.is_a?(String) && File.exist?(server_path)
   end
 
-  if !ServerEngine.windows?
+  if ServerEngine.windows?
+    context 'Server.generate_path' do
+      it 'returns socket path as port number' do
+        path = SocketManager::Server.generate_path
+        expect(path).to be_between(49152, 65535)
+      end
+
+      it 'can be changed via environment variable' do
+        ENV['SERVERENGINE_SOCKETMANAGER_PORT'] = '54321'
+        path = SocketManager::Server.generate_path
+        expect(path).to be 54321
+        ENV.delete('SERVERENGINE_SOCKETMANAGER_PORT')
+      end
+    end
+  else
     context 'Server.generate_path' do
       it 'returns socket path under /tmp' do
         path = SocketManager::Server.generate_path
@@ -155,7 +169,27 @@ describe ServerEngine::SocketManager do
         test_state(:is_udp_socket).should == 1
         test_state(:udp_data_sent).should == 1
       end
-    end if (TCPServer.open("::1",0) rescue nil)
+    end if (TCPServer.open("::1", 0) rescue nil)
+
+    unless ServerEngine.windows?
+      context 'using ipv4/ipv6' do
+        it 'can bind ipv4/ipv6 together' do
+          server = SocketManager::Server.open(server_path)
+          client = ServerEngine::SocketManager::Client.new(server_path)
+
+          tcp_v4 = client.listen_tcp('0.0.0.0', test_port)
+          udp_v4 = client.listen_udp('0.0.0.0', test_port)
+          tcp_v6 = client.listen_tcp('::', test_port)
+          udp_v6 = client.listen_udp('::', test_port)
+
+          tcp_v4.close
+          udp_v4.close
+          tcp_v6.close
+          udp_v6.close
+          server.close
+        end
+      end if (TCPServer.open("::", 0) rescue nil)
+    end
   end
 
   if ServerEngine.windows?

data/spec/spec_helper.rb

@@ -1,4 +1,9 @@
 require 'bundler'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end
 
 begin
   Bundler.setup(:default, :test)

data/spec/supervisor_spec.rb

@@ -191,13 +191,19 @@ describe ServerEngine::Supervisor do
         sv, t = start_supervisor(RunErrorWorker, server_restart_wait: 1, command_sender: sender)
 
         begin
-          sleep 2.2
+          sleep 2.5
         ensure
           sv.stop(true)
           t.join
         end
 
-        test_state(:worker_run).should == 3
+        if ServerEngine.windows?
+          # Because launching a process on Windows is high cost,
+          # it doesn't often reach to 3.
+          test_state(:worker_run).should <= 3
+        else
+          test_state(:worker_run).should == 3
+        end
       end
     end
   end

data/spec/winsock_spec.rb

@@ -0,0 +1,17 @@
+describe ServerEngine::WinSock do
+  # On Ruby 3.0, you need to use fiddle 1.0.8 or later to retrieve a correct
+  # error code. In addition, you need to specify the path of fiddle by RUBYLIB
+  # or `ruby -I` when you use RubyInstaller because it loads Ruby's bundled
+  # fiddle before initializing gem.
+  # See also:
+  # * https://github.com/ruby/fiddle/issues/72
+  # * https://bugs.ruby-lang.org/issues/17813
+  # * https://github.com/oneclick/rubyinstaller2/blob/8225034c22152d8195bc0aabc42a956c79d6c712/lib/ruby_installer/build/dll_directory.rb
+  context 'last_error' do
+    it 'bind error' do
+      expect(WinSock.bind(0, nil, 0)).to be -1
+      WSAENOTSOCK = 10038
+      expect(WinSock.last_error).to be WSAENOTSOCK
+    end
+  end
+end if ServerEngine.windows?