serverengine 2.1.0 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0fc6a5674589bf35670db4884c9d5b24ebc7c3ad
-  data.tar.gz: 2d90ee7be95869d687149d954d230462da3571c9
+SHA256:
+  metadata.gz: c37776b7f6420e895262df160ce7156bf00b6c3adaccd8af016e2d35c2d49f28
+  data.tar.gz: 7109cb65899f1afd047c3a6ddce8dee6b51dcbf69d1c7bc0ef80937214a90850
 SHA512:
-  metadata.gz: fa77bfaee529a011584d2ca8791a65e99193b4e5d21ce1ccdb326aea1fdea6016d32e6ec481ebe1f2bc395cdec8fccfe592578327dffdec73a90a60308f29082
-  data.tar.gz: e3414b8d50c72c6c4a4eb82fafdfb4d2e9b3192c3390405b91b22db0b2929eba216a0544f1f377d80deafcd8fbae37bb01c7ea1d1c9f77e0597b92b54f196df2
+  metadata.gz: f92e476daba00bad71a9de2bb924187926bcc071266b510cba15741f584a3d14333d28533c9530d48f8b9820bd1fb9522bd1bfa5f3c1c858f238f44042a803cd
+  data.tar.gz: 0bd8378d0840b3ca89bae30999317925f9e3155d9c37fb3a9d5482c95f1be0350fa60b82c8d0706d5cdea40573f5bdf2801d4717f55b22da32469177895c15b5

data/.travis.yml

@@ -1,11 +1,10 @@
 language: ruby
 
 rvm:
-  - 2.1.10
-  - 2.2.9
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7
   - ruby-head
 
 branches:

data/Changelog

@@ -1,3 +1,24 @@
+2021-02-17 version 2.2.3:
+
+* Change SocketManager's port assignment strategy on Windows
+
+2020-11-02 version 2.2.2:
+
+* Fix incomplete Windows support in spawn based multi worker
+
+2020-01-24 version 2.2.1:
+
+* Fix IPv6 dual-stack mode issue for UDP
+* experimental: Add SERVERENGINE_USE_SOCKET_REUSEPORT envvar to enable SO_REUSEPORT
+
+2019-11-16 version 2.2.0:
+
+* Fix IPv6 dual-stack mode issue for TCP
+
+2019-04-22 version 2.1.1:
+
+* Fix bug to ignore SIGDUMP_SIGNAL
+
 2018-11-14 version 2.1.0:
 
 * Improve socket manager security

data/lib/serverengine/multi_process_server.rb

@@ -120,10 +120,19 @@ module ServerEngine
       end
 
       def send_reload
-        @pmon.send_signal(@reload_signal) if @pmon
+        return nil unless @pmon
+        if @pmon.command_sender_pipe
+          send_command("RELOAD\n")
+        else
+          @pmon.send_signal(@reload_signal)
+        end
         nil
       end
 
+      def send_command(command)
+        @pmon.send_command(command) if @pmon
+      end
+
       def join
         @pmon.join if @pmon
         nil

data/lib/serverengine/multi_spawn_server.rb

@@ -46,13 +46,6 @@ module ServerEngine
       @pm.command_sender = @command_sender
     end
 
-    def stop(stop_graceful)
-      if @command_sender == "pipe"
-        @pm.command_sender_pipe.write(stop_graceful ? "GRACEFUL_STOP\n" : "IMMEDIATE_STOP\n")
-      end
-      super
-    end
-
     def run
       super
     ensure

data/lib/serverengine/process_manager.rb

@@ -71,7 +71,6 @@ module ServerEngine
     attr_reader :enable_heartbeat, :auto_heartbeat
 
     attr_accessor :command_sender
-    attr_reader :command_sender_pipe
 
     CONFIG_PARAMS = {
       heartbeat_interval: 1,
@@ -180,10 +179,11 @@ module ServerEngine
           end
         end
 
+        command_sender_pipe = nil
         if @command_sender == "pipe"
-          inpipe, @command_sender_pipe = IO.pipe
-          @command_sender_pipe.sync = true
-          @command_sender_pipe.binmode
+          inpipe, command_sender_pipe = IO.pipe
+          command_sender_pipe.sync = true
+          command_sender_pipe.binmode
           options[:in] = inpipe
         end
         env['SERVERENGINE_SOCKETMANAGER_INTERNAL_TOKEN'] = SocketManager::INTERNAL_TOKEN
@@ -193,6 +193,7 @@ module ServerEngine
         end
 
         m = Monitor.new(pid, monitor_options)
+        m.command_sender_pipe = command_sender_pipe
 
         @monitors << m
 
@@ -307,9 +308,11 @@ module ServerEngine
         @graceful_kill_start_time = nil
         @immediate_kill_start_time = nil
         @kill_count = 0
+
+        @command_sender_pipe = nil
       end
 
-      attr_accessor :last_heartbeat_time
+      attr_accessor :last_heartbeat_time, :command_sender_pipe
       attr_reader :pid
 
       def heartbeat_delay
@@ -329,6 +332,10 @@ module ServerEngine
         end
       end
 
+      def send_command(command)
+        @command_sender_pipe.write(command) if @command_sender_pipe
+      end
+
       def try_join
         pid = @pid
         return true unless pid
@@ -366,15 +373,25 @@ module ServerEngine
       end
 
       def start_graceful_stop!
-        now = Time.now
-        @next_kill_time ||= now
-        @graceful_kill_start_time ||= now
+        if ServerEngine.windows?
+          # heartbeat isn't supported on Windows
+          send_command("GRACEFUL_STOP\n")
+        else
+          now = Time.now
+          @next_kill_time ||= now
+          @graceful_kill_start_time ||= now
+        end
       end
 
       def start_immediate_stop!
-        now = Time.now
-        @next_kill_time ||= now
-        @immediate_kill_start_time ||= now
+        if ServerEngine.windows?
+          # heartbeat isn't supported on Windows
+          system("taskkill /f /pid #{@pid}")
+        else
+          now = Time.now
+          @next_kill_time ||= now
+          @immediate_kill_start_time ||= now
+        end
       end
 
       def tick(now=Time.now)

data/lib/serverengine/signal_thread.rb

@@ -67,7 +67,7 @@ module ServerEngine
 
     def signal_handler_main(sig)
       # here always creates new thread to avoid
-      # complicated race conditin in signal handlers
+      # complicated race condition in signal handlers
       Thread.new do
         begin
           enqueue(sig)

data/lib/serverengine/signals.rb

@@ -26,6 +26,6 @@ module ServerEngine
     IMMEDIATE_RESTART = :HUP
     RELOAD = :USR2
     DETACH = :INT
-    DUMP = :CONT
+    DUMP = ENV.has_key?('SIGDUMP_SIGNAL') ? ENV['SIGDUMP_SIGNAL'].to_sym : :CONT
   end
 end

data/lib/serverengine/socket_manager.rb

@@ -72,7 +72,10 @@ module ServerEngine
     class Server
       def self.generate_path
         if ServerEngine.windows?
-          for port in 10000..65535
+          port = ENV['SERVERENGINE_SOCKETMANAGER_PORT']
+          return port.to_i if port
+
+          for port in get_dynamic_port_range
             if `netstat -na | findstr "#{port}"`.length == 0
               return port
             end
@@ -160,6 +163,40 @@ module ServerEngine
       ensure
         peer.close
       end
+
+      if ServerEngine.windows?
+        def self.valid_dynamic_port_range(start_port, end_port)
+          return false if start_port < 1025 or start_port > 65535
+          return false if end_port < 1025 or end_port > 65535
+          return false if start_port > end_port
+          true
+        end
+
+        def self.get_dynamic_port_range
+          numbers = []
+          # Example output of netsh (actual output is localized):
+          #
+          # Protocol tcp Dynamic Port Range
+          # ---------------------------------
+          # Start Port      : 49152
+          # Number of Ports : 16384
+          #
+          str = `netsh int ipv4 show dynamicport tcp`.force_encoding("ASCII-8BIT")
+          str.each_line { |line| numbers << $1.to_i if line.match(/.*: (\d+)/) }
+
+          start_port, n_ports = numbers[0], numbers[1]
+          end_port = start_port + n_ports - 1
+
+          if valid_dynamic_port_range(start_port, end_port)
+            return start_port..end_port
+          else
+            # The default dynamic port range is 49152 - 65535 as of Windows Vista
+            # and Windows Server 2008.
+            # https://docs.microsoft.com/en-us/troubleshoot/windows-server/networking/default-dynamic-port-range-tcpip-chang
+            return 49152..65535
+          end
+        end
+      end
     end
 
     def self.send_peer(peer, obj)

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)

data/lib/serverengine/version.rb

@@ -1,3 +1,3 @@
 module ServerEngine
-  VERSION = "2.1.0"
+  VERSION = "2.2.3"
 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?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverengine
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.3
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sigdump
@@ -153,8 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: ServerEngine - multiprocess server framework