serverengine 2.0.7 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 849803d15dfe8e2b3e551b2849d8eb3d02deeffa271d4fa5f890ac4fb8db9a64
-  data.tar.gz: 703964e48ed203464b7d98eeaee0a161c88c4fc9597c2c1028e4cc3860b52476
+  metadata.gz: b1c09d476bdc08a078882ba14ee74f487ab988a397d2228c3e83f611fff94df1
+  data.tar.gz: 33732af3d1c591ec28c67249b1b67b16b142f80048f70c3cf5c769b3e267b76a
 SHA512:
-  metadata.gz: 7b372a236fbb4861d6a1143c35a17466483d5e43730e6e6ce3a6dbe9c8a85cd560fbf7cb8a73e84edf7f0a56cecf9a1ec0e596cceed552c174d61d83765f2d49
-  data.tar.gz: '092f8d447cab9895701e566fe5185f6043ca483ff2cc905c57ae653f5551b80f6b080b9f0b51fb1fc42b8466eae463a5809e0941a27e770323479cf99e5e1f92'
+  metadata.gz: 383aaf8822f01aec3ce2e4a25243da8ca741da9d11f97c601c31cc6985e285743a088cafdd4fd918b58a966960376f65b28645b1fca74d0741e64052bd329ac8
+  data.tar.gz: ca10bd75948760060c8ae433cb2021a7024d6b076d84157012db5ae6809d01c9a8bb2eb2bb1f9f8d84f0881e4cbaf3bebfb25ef959130574e0cf717550ee1867

data/.github/workflows/linux.yml

@@ -0,0 +1,31 @@
+name: Testing on Ubuntu
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.1', '3.0', '2.7' ]
+        os:
+          - ubuntu-latest
+    name: Unit testing with Ruby ${{ matrix.ruby }} on ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: |
+          gem install bundler rake
+          bundle install --jobs 4 --retry 3
+      - name: Run tests
+        env:
+          CI: true
+        run: bundle exec rake spec

data/.github/workflows/windows.yml

@@ -0,0 +1,42 @@
+name: Testing on Windows
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.1', '2.7' ]
+        os:
+          - windows-latest
+        include:
+          - ruby: '3.0.3'
+            os: windows-latest
+            # On Ruby 3.0, we need to use fiddle 1.0.8 or later to retrieve correct
+            # error code. In addition, we have to specify the path of fiddle by RUBYLIB
+            # because RubyInstaller 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
+            ruby-lib-opt: RUBYLIB=%RUNNER_TOOL_CACHE%/Ruby/3.0.3/x64/lib/ruby/gems/3.0.0/gems/fiddle-1.1.0/lib
+
+    name: Unit testing with Ruby ${{ matrix.ruby }} on ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Add Fiddle 1.1.0
+        if: ${{ matrix.ruby == '3.0.3' }}
+        run: gem install fiddle --version 1.1.0
+      - name: Install dependencies
+        run: ridk exec bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake spec ${{ matrix.ruby-lib-opt }}

data/Changelog

@@ -1,3 +1,48 @@
+2022-06-13 version 2.3.0
+
+* Add restart_worker_interval option to prevent workers restart immediately
+  after kill
+* Reopen log file when rotation done by external tool is detected
+* Fix unexpected behavior of start_worker_delay option
+* Remove windows-pr dependency
+* Fix a potential crash that command_sender_pipe of ProcessManager::Monitor
+  raises error on shutdown
+* Allow to load serverengine/socket_manager without servernegine/utils
+* Fix unstable tests
+
+2022-01-13 version 2.2.5:
+
+* Fix DLL load error on Ruby 3.1 on Windows
+
+2021-05-24 version 2.2.4:
+
+* Ensure to get correct Win32 socket error on Ruby 3.0
+
+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
+
 2018-07-09 version 2.0.7:
 
 * Add disable_sigdump option

data/NOTICE

@@ -1,3 +1,3 @@
 ServerEngine
-https://github.com/frsyuki/serverengine
+https://github.com/treasure-data/serverengine
 Copyright (C) 2012-2013 Sadayuki Furuhashi

data/README.md

@@ -478,10 +478,11 @@ Available methods are different depending on `worker_type`. ServerEngine support
   - **disable_reload** disables USR2 signal (default: false)
   - **server_restart_wait** sets wait time before restarting server after last restarting (default: 1.0) [dynamic reloadable]
   - **server_detach_wait** sets wait time before starting live restart (default: 10.0) [dynamic reloadable]
-- Multithread server and multiprocess server: available only when `worker_type` is thread or process
+- Multithread server and multiprocess server: available only when `worker_type` is "thread" or "process" or "spawn"
   - **workers** sets number of workers (default: 1) [dynamic reloadable]
-  - **start_worker_delay** sets wait time before starting a new worker (default: 0) [dynamic reloadable]
+  - **start_worker_delay** sets the delay between each worker-start when starting/restarting multiple workers at once (default: 0) [dynamic reloadable]
   - **start_worker_delay_rand** randomizes start_worker_delay at this ratio (default: 0.2) [dynamic reloadable]
+  - **restart_worker_interval** sets wait time before restarting a stopped worker (default: 0) [dynamic reloadable]
 - Multiprocess server: available only when `worker_type` is "process"
   - **worker_process_name** changes process name ($0) of workers [dynamic reloadable]
   - **worker_heartbeat_interval** sets interval of heartbeats in seconds (default: 1.0) [dynamic reloadable]

data/Rakefile

@@ -8,19 +8,3 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 task :default => [:spec, :build]
-
-# 1. update Changelog and lib/serverengine/version.rb
-# 2. bundle && bundle exec rake build:all
-# 3. release 3 packages built on pkg/ directory
-namespace :build do
-  desc 'Build gems for all platforms'
-  task :all do
-    Bundler.with_clean_env do
-      %w[ruby x86-mingw32 x64-mingw32].each do |name|
-        ENV['GEM_BUILD_FAKE_PLATFORM'] = name
-        Rake::Task["build"].execute
-      end
-    end
-  end
-end
-

data/lib/serverengine/daemon_logger.rb

@@ -55,6 +55,9 @@ module ServerEngine
         # update path string
         old_file_dev = @file_dev
         @file_dev = LogDevice.new(logdev, shift_age: @rotate_age, shift_size: @rotate_size)
+        # Enable to detect rotation done by external tools.
+        # Otherwise it continues writing logs to old file unexpectedly.
+        @file_dev.extend(RotationAware)
         old_file_dev.close if old_file_dev
         @logdev = @file_dev
       end
@@ -130,6 +133,40 @@ module ServerEngine
       nil
     end
 
+    module RotationAware
+      def self.extended(obj)
+        obj.update_ino
+      end
+
+      def update_ino
+        (@ino_mutex ||= Mutex.new).synchronize do
+          @ino = File.stat(filename).ino rescue nil
+          @last_ino_time = Time.now
+        end
+      end
+
+      def reopen(log = nil)
+        super(log)
+        update_ino
+      end
+
+      def reopen!
+        super
+        update_ino
+      end
+
+      def write(message)
+        reopen_needed = false
+        @ino_mutex.synchronize do
+          if (Time.now - @last_ino_time).abs > 1
+            ino = File.stat(filename).ino rescue nil
+            reopen_needed = true if ino && ino != @ino
+          end
+        end
+        reopen! if reopen_needed
+        super(message)
+      end
+    end
   end
 
 end

data/lib/serverengine/multi_process_server.rb

@@ -105,9 +105,11 @@ module ServerEngine
         @unrecoverable_exit_codes = unrecoverable_exit_codes
         @unrecoverable_exit = false
         @exitstatus = nil
+        @restart_at = nil
       end
 
       attr_reader :exitstatus
+      attr_accessor :restart_at
 
       def send_stop(stop_graceful)
         @stop = true
@@ -120,10 +122,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
@@ -133,7 +144,11 @@ module ServerEngine
         return false unless @pmon
 
         if stat = @pmon.try_join
-          @worker.logger.info "Worker #{@wid} finished#{@stop ? '' : ' unexpectedly'} with #{ServerEngine.format_join_status(stat)}"
+          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)}"
+          end
           if stat.is_a?(Process::Status) && stat.exited? && @unrecoverable_exit_codes.include?(stat.exitstatus)
             @unrecoverable_exit = true
             @exitstatus = stat.exitstatus

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/multi_thread_server.rb

@@ -39,8 +39,11 @@ module ServerEngine
       def initialize(worker, thread)
         @worker = worker
         @thread = thread
+        @restart_at = nil
       end
 
+      attr_accessor :restart_at
+
       def send_stop(stop_graceful)
         Thread.new do
           begin

data/lib/serverengine/multi_worker_server.rb

@@ -55,8 +55,8 @@ module ServerEngine
 
     def run
       while true
-        num_alive = keepalive_workers
-        break if num_alive == 0
+        num_alive_or_restarting = keepalive_workers
+        break if num_alive_or_restarting == 0
         wait_tick
       end
     end
@@ -85,6 +85,7 @@ module ServerEngine
 
       @start_worker_delay = @config[:start_worker_delay] || 0
       @start_worker_delay_rand = @config[:start_worker_delay_rand] || 0.2
+      @restart_worker_interval = @config[:restart_worker_interval] || 0
 
       scale_workers(@config[:workers] || 1)
 
@@ -96,12 +97,12 @@ module ServerEngine
     end
 
     def keepalive_workers
-      num_alive = 0
+      num_alive_or_restarting = 0
 
       @monitors.each_with_index do |m,wid|
         if m && m.alive?
           # alive
-          num_alive += 1
+          num_alive_or_restarting += 1
 
         elsif m && m.respond_to?(:recoverable?) && !m.recoverable?
           # exited, with unrecoverable exit code
@@ -116,8 +117,12 @@ module ServerEngine
         elsif wid < @num_workers
           # scale up or reboot
           unless @stop
-            @monitors[wid] = delayed_start_worker(wid)
-            num_alive += 1
+            if m
+              restart_worker(wid)
+            else
+              start_new_worker(wid)
+            end
+            num_alive_or_restarting += 1
           end
 
         elsif m
@@ -126,7 +131,27 @@ module ServerEngine
         end
       end
 
-      return num_alive
+      return num_alive_or_restarting
+    end
+
+    def start_new_worker(wid)
+      delayed_start_worker(wid)
+    end
+
+    def restart_worker(wid)
+      m = @monitors[wid]
+
+      is_already_restarting = !m.restart_at.nil?
+      if is_already_restarting
+        delayed_start_worker(wid) if m.restart_at <= Time.now()
+        return
+      end
+
+      if @restart_worker_interval > 0
+        m.restart_at = Time.now() + @restart_worker_interval
+      else
+        delayed_start_worker(wid)
+      end
     end
 
     def delayed_start_worker(wid)
@@ -135,15 +160,13 @@ module ServerEngine
           Kernel.rand * @start_worker_delay * @start_worker_delay_rand -
           @start_worker_delay * @start_worker_delay_rand / 2
 
-        now = Time.now.to_f
-
-        wait = delay - (now - @last_start_worker_time)
+        wait = delay - (Time.now.to_f - @last_start_worker_time)
         sleep wait if wait > 0
 
-        @last_start_worker_time = now
+        @last_start_worker_time = Time.now.to_f
       end
 
-      start_worker(wid)
+      @monitors[wid] = start_worker(wid)
     end
   end
 

data/lib/serverengine/process_manager.rb

@@ -16,6 +16,7 @@
 #    limitations under the License.
 #
 require 'fcntl'
+require 'serverengine/socket_manager'
 
 module ServerEngine
 
@@ -70,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,
@@ -179,18 +179,21 @@ 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
         pid = Process.spawn(env, *args, options)
         if @command_sender == "pipe"
           inpipe.close
         end
 
         m = Monitor.new(pid, monitor_options)
+        m.command_sender_pipe = command_sender_pipe
 
         @monitors << m
 
@@ -305,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
@@ -327,6 +332,18 @@ module ServerEngine
         end
       end
 
+      def send_command(command)
+        pid = @pid
+        return false unless pid
+
+        begin
+          @command_sender_pipe.write(command)
+          return true
+        rescue #Errno::EPIPE
+          return false
+        end
+      end
+
       def try_join
         pid = @pid
         return true unless pid
@@ -364,15 +381,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/server.rb

@@ -80,7 +80,7 @@ module ServerEngine
       if @command_pipe
         Thread.new do
           until @command_pipe.closed?
-            case @command_pipe.gets.chomp
+            case @command_pipe.gets&.chomp
             when "GRACEFUL_STOP"
               s.stop(true)
             when "IMMEDIATE_STOP"

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

@@ -18,9 +18,20 @@
 require 'socket'
 require 'ipaddr'
 require 'time'
+require 'securerandom'
+require 'json'
+require 'base64'
+
+require_relative 'utils' # for ServerEngine.windows?
 
 module ServerEngine
   module SocketManager
+    # This token is used for communication between peers. If token is mismatched, messages will be discarded
+    INTERNAL_TOKEN = if ENV.has_key?('SERVERENGINE_SOCKETMANAGER_INTERNAL_TOKEN')
+                       ENV['SERVERENGINE_SOCKETMANAGER_INTERNAL_TOKEN']
+                     else
+                       SecureRandom.hex
+                     end
 
     class Client
       def initialize(path)
@@ -63,7 +74,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
@@ -151,10 +165,45 @@ 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 = Marshal.dump(obj)
+      data = [SocketManager::INTERNAL_TOKEN, Base64.strict_encode64(Marshal.dump(obj))]
+      data = JSON.generate(data)
       peer.write [data.bytesize].pack('N')
       peer.write data
     end
@@ -165,7 +214,10 @@ module ServerEngine
 
       len = res.unpack('N').first
       data = peer.read(len)
-      Marshal.load(data)
+      data = JSON.parse(data)
+      return nil if SocketManager::INTERNAL_TOKEN != data.first
+
+      Marshal.load(Base64.strict_decode64(data.last))
     end
 
     if ServerEngine.windows?