serverengine 2.2.1 → 2.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 934c5957de987807cb9a28cf740ee002cfa1c64d54c82b21acb16c464bfd8da0
-  data.tar.gz: aef6141bd22834eb0f9fb837d374ec69b5681cb31bddc0fa1afda5cd82c3ec38
+  metadata.gz: 2175217415cd5751a1bd4a8d60c5abdb64e80429e722c41e8c1e97ec02b1e22a
+  data.tar.gz: 63a7af53a0dc906bb962394f902d1486f7958950c9b3b9bf41206e56789d83ad
 SHA512:
-  metadata.gz: eb93190b271548e433d9dcc9ce2d7b4f8358a4bd96079b24c1417bc43e86567840733265df4931d79beacd1ba31dbe23bd1e29c1d205982e036dc29861d68c2a
-  data.tar.gz: '09f3589a04c3bbea01c619216066e7bbb9ac2e4414cd8345713315aa416cbe2600d537bec860034423bb4566881c5febc4efb33bfd28a376953c078aeee524fb'
+  metadata.gz: 85880cc1ec9b83e03b2cbe80756253e156e46954117ae0a008388bfccf3d412b96a54911f9f002b6387ec2dfa9ef35dd3a40bff1dff22f7b5ca180f667d88611
+  data.tar.gz: 624a1e6397faa39af9b871ef91571b432263d6b2b595fc4bdfaa9244a6153b25a67fe80c38c6f814c94db27b0dddcc1e4e19ae08515c8e48c2ee6208478775d0

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', '2.6' ]
+        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', '2.6' ]
+        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,19 @@
+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

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/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
@@ -133,7 +142,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/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/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/version.rb

@@ -1,3 +1,3 @@
 module ServerEngine
-  VERSION = "2.2.1"
+  VERSION = "2.2.5"
 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
 
@@ -88,18 +102,11 @@ module ServerEngine
     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/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/server_worker_context.rb

@@ -254,7 +254,7 @@ shared_context 'test server and worker' do
   before { reset_test_state }
 
   def wait_for_fork
-    sleep 0.8
+    sleep 1.5
   end
 
   def wait_for_stop

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

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,18 @@
+require 'windows/error' if ServerEngine.windows?
+
+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
+      expect(WinSock.last_error).to be Windows::Error::WSAENOTSOCK
+    end
+  end
+end if ServerEngine.windows?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverengine
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.5
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-24 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sigdump
@@ -87,16 +87,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/linux.yml"
+- ".github/workflows/windows.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Changelog
 - Gemfile
 - LICENSE
 - NOTICE
 - README.md
 - Rakefile
-- appveyor.yml
 - examples/server.rb
 - examples/spawn_worker_script.rb
 - lib/serverengine.rb
@@ -134,6 +134,7 @@ files:
 - spec/socket_manager_spec.rb
 - spec/spec_helper.rb
 - spec/supervisor_spec.rb
+- spec/winsock_spec.rb
 homepage: https://github.com/fluent/serverengine
 licenses:
 - Apache 2.0
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: ServerEngine - multiprocess server framework
@@ -168,3 +169,4 @@ test_files:
 - spec/socket_manager_spec.rb
 - spec/spec_helper.rb
 - spec/supervisor_spec.rb
+- spec/winsock_spec.rb

data/.travis.yml

@@ -1,22 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.1.10
-  - 2.2.9
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - ruby-head
-
-branches:
-  only:
-    - master
-
-script: bundle exec rake spec
-
-before_install:
- - gem update bundler
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head

data/appveyor.yml

@@ -1,24 +0,0 @@
----
-install:
-  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
-  - ruby --version
-  - gem --version
-  - bundle install
-build: off
-test_script:
-  - bundle exec rake -rdevkit
-
-environment:
-  matrix:
-    - ruby_version: "23-x64"
-      devkit: C:\Ruby23-x64\DevKit
-    - ruby_version: "23"
-      devkit: C:\Ruby23\DevKit
-    - ruby_version: "22-x64"
-      devkit: C:\Ruby23-x64\DevKit
-    - ruby_version: "22"
-      devkit: C:\Ruby23\DevKit
-    - ruby_version: "21-x64"
-      devkit: C:\Ruby23-x64\DevKit
-    - ruby_version: "21"
-      devkit: C:\Ruby23\DevKit