griffin 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61289d32bbb5830ad446ea08b51604a4f4cf0340f59ec596dcc92c32cf29f7ac
-  data.tar.gz: dc61c80a41aa8c79294d88c9b2042b3e7babb728c108be7fe7a581e6c6324559
+  metadata.gz: aa72d1f7851dc5a90fb99214c57e9bbba2fd6da6e84225a2ea6955d9ad89f872
+  data.tar.gz: 2794b9f846099b958fb5b937fcf8de2168a858bad149a89316664f9c3b921d75
 SHA512:
-  metadata.gz: c0629cb8f5fe58daa29b9c44d0e27cf37f29885e26bbc8fefb4a9aac624be4efed3436e98053fd554bcff1576fa0c9c4e26c313baf1e059ededae9ab0237b601
-  data.tar.gz: ea6576f3ab391cc2f632872375926c26e1f374006ee1d7b9f38be37bbe8af053ebdc208f933db309e95a262e1fa14272efcbf17b45941d07be0998fb16cc6f18
+  metadata.gz: 731a0d9ab4fba6a3989ef0af62bb4a36f1bd34f48bb0790ff4f5d0c954ee8fa5e0492f4d4f65121ff7378d90fea313333feb262ed4575d4a5c355fb03ae35f28
+  data.tar.gz: 0bded1160bf1b33b16a11e6dea2c95c8abc3311695c4947031dfddb918a5d0292cca809e8797a5b06e1b25e4a8d6e0f88c9467543549539378a079b552c83eff

data/README.md

@@ -2,9 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/griffin.svg)](https://badge.fury.io/rb/griffin)
 
-
-__UNDER DEVELOPMENT__
-
 Griffin is [gRPC](https://grpc.io/) server which supports multi process by using [serverengine](https://github.com/treasure-data/serverengine).
 Griffin also supports building gRPC client.
 
@@ -46,13 +43,17 @@ Griffin::Server.configure do |c|
 
   c.services GreeterServer.new
 
-  c.worker 2 # A number of worker process
+  c.workers 2 # A number of worker process
 end
 
 Griffin::Server.run
 
 ```
 
+## Interceptors
+
+* [cookpad/griffin-interceptors](https://github.com/cookpad/griffin-interceptors) colloection of interceptors
+
 ## Development
 
 ```
@@ -61,7 +62,7 @@ bundle install
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ganmacs/griffin.
+Bug reports and pull requests are welcome on GitHub at https://github.com/cookpad/griffin.
 
 ## License
 

data/griffin.gemspec

@@ -28,6 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
 
-  spec.add_dependency 'grpc_kit', '>= 0.3.0'
+  spec.add_dependency 'grpc_kit', '>= 0.5.0'
   spec.add_dependency 'serverengine', '~> 2.0.7'
 end

data/lib/griffin/engine/server.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require 'griffin/listener'
-
 module Griffin
   module Engine
     module Server
-      attr_reader :core, :listener
+      attr_reader :core, :socket_manager_path
 
       def initialize
         @core = Griffin::Server.new(
@@ -14,8 +12,13 @@ module Griffin
           max_pool_size: config[:max_pool_size],
           min_connection_size: config[:min_connection_size],
           max_connection_size: config[:max_connection_size],
+          max_receive_message_size: config[:max_receive_message_size],
+          max_send_message_size: config[:max_send_message_size],
           interceptors: config[:interceptors],
+          settings: config[:http2_settings],
         )
+        @socket_manager_path = ServerEngine::SocketManager::Server.generate_path
+        @socket_manager_server = ServerEngine::SocketManager::Server.open(@socket_manager_path)
       end
 
       def before_run
@@ -26,6 +29,7 @@ module Griffin
 
       def stop(stop_graceful)
         super # needed
+        @socket_manager_server.close
       end
 
       # def after_start; end

data/lib/griffin/engine/single.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'griffin/server'
-require 'griffin/listener'
 
 module Griffin
   module Engine
@@ -12,6 +11,8 @@ module Griffin
           max_pool_size: config[:max_pool_size],
           min_connection_size: config[:min_connection_size],
           max_connection_size: config[:max_connection_size],
+          max_receive_message_size: config[:max_receive_message_size],
+          max_send_message_size: config[:max_send_message_size],
           interceptors: config[:interceptors],
         )
         new(serv, config)
@@ -20,7 +21,8 @@ module Griffin
       def initialize(server, config)
         @server = server
         @config = config
-        @listener = Griffin::Listener.new(@config[:bind], @config[:port])
+        @sock = TCPServer.new(@config[:bind], @config[:port])
+        @sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
       end
 
       def run
@@ -31,7 +33,8 @@ module Griffin
         install_handler
 
         @server.before_run
-        @server.run(@listener.listen)
+        @sock.listen(Socket::SOMAXCONN)
+        @server.run(@sock)
       end
 
       def install_handler

data/lib/griffin/engine/worker.rb

@@ -1,27 +1,54 @@
 # frozen_string_literal: true
 
-require 'griffin/listener'
-
 module Griffin
   module Engine
     module Worker
+      def initialize
+        @socket_manager = ServerEngine::SocketManager::Client.new(server.socket_manager_path)
+      end
+
       def before_fork
-        @listener = Griffin::Listener.new(config[:bind], config[:port])
         server.core.before_run(worker_id)
       end
 
       def run
-        server.core.run(@listener.listen)
+        @lsock = @socket_manager.listen_tcp(config[:bind], config[:port])
+        @lsock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+        server.core.run(@lsock)
       ensure
-        @listener.close
+        @lsock.close if @lsock
       end
 
-      def stop
-        server.core.shutdown
+      def stop(signal = nil)
+        kind = case signal
+               when ServerEngine::Signals::GRACEFUL_STOP then Griffin::Server::GRACEFUL_SHUTDOWN
+               when ServerEngine::Signals::IMMEDIATE_STOP then Griffin::Server::FORCE_SHUTDOWN
+               when ServerEngine::Signals::GRACEFUL_RESTART then Griffin::Server::GRACEFUL_RESTART
+               else Griffin::Server::GRACEFUL_SHUTDOWN
+               end
+        server.core.shutdown(kind)
       end
 
-      # def after_fork; end
-      # def reload; end
+      # Overwrite to identify the kind of signal in #stop
+      # https://github.com/treasure-data/serverengine/blob/a005f3535affaa5b15d1e66486d9349443398dd2/lib/serverengine/worker.rb#L61-L78
+      def install_signal_handlers
+        w = self
+        ServerEngine::SignalThread.new do |st|
+          st.trap(ServerEngine::Signals::GRACEFUL_STOP) { |s| w.stop(s) }
+          st.trap(ServerEngine::Signals::IMMEDIATE_STOP, 'SIG_DFL')
+
+          st.trap(ServerEngine::Signals::GRACEFUL_RESTART) { |s| w.stop(s) }
+          st.trap(ServerEngine::Signals::IMMEDIATE_RESTART, 'SIG_DFL')
+
+          st.trap(ServerEngine::Signals::RELOAD) {
+            w.logger.reopen!
+            w.reload
+          }
+          st.trap(ServerEngine::Signals::DETACH) { |s| w.stop(s) }
+
+          st.trap(ServerEngine::Signals::DUMP) { w.dump }
+        end
+      end
     end
   end
 end

data/lib/griffin/server.rb

@@ -12,6 +12,7 @@ module Griffin
 
     GRACEFUL_SHUTDOWN = '0'
     FORCIBLE_SHUTDOWN = '1'
+    GRACEFUL_RESTART = '2'
 
     class << self
       # @param bind [String]
@@ -40,10 +41,20 @@ module Griffin
     # @param min_connection_size [Integer] Maximun connection of TCP
     # @param max_connection_size [Integer] Minimum connection of TCP
     # @param interceptors [Array<GrpcKit::GRPC::ServerInterceptor>] list of interceptors
-    def initialize(min_pool_size:, max_pool_size:, min_connection_size:, max_connection_size:, interceptors: [], **opts)
+    # @param settings [Array<DS9::Settings,Integer>] list of HTTP2-Settings headers
+    # @param max_receive_message_size [Integer, nil] Specify the default maximum size of inbound message in bytes. Default to 4MB.
+    # @param max_send_message_size [Integer, nil] Specify the default maximum size of outbound message in bytes. Default to 4MB.
+    def initialize(min_pool_size:, max_pool_size:, min_connection_size:, max_connection_size:, interceptors: [], settings: [], max_receive_message_size: nil, max_send_message_size: nil, **opts)
       @min_connection_size = min_connection_size
       @max_connection_size = max_connection_size
-      @server = GrpcKit::Server.new(interceptors: interceptors, min_pool_size: min_pool_size, max_pool_size: max_pool_size)
+      @server = GrpcKit::Server.new(
+        interceptors: interceptors,
+        min_pool_size: min_pool_size,
+        max_pool_size: max_pool_size,
+        max_receive_message_size: max_receive_message_size,
+        max_send_message_size: max_send_message_size,
+        settings: settings
+      )
       @opts = opts
       @status = :run
       @worker_id = 0
@@ -95,9 +106,15 @@ module Griffin
             break if handle_command
           end
 
+          # @thread_pool.schedule could block and accepted socket would be timeout.
+          # So call Thread.pass other workers having resources to handle a request would accept.
+          unless @thread_pool.resouce_available?
+            break
+          end
+
           begin
             conn = sock.accept_nonblock
-            @thread_pool.schedule(conn[0])
+            @thread_pool.schedule(conn)
           rescue IO::WaitReadable, Errno::EINTR => e
             Griffin.logger.debug("Error raised #{e}")
             # nothing
@@ -125,6 +142,13 @@ module Griffin
         @status = :stop
         @server.graceful_shutdown
         true
+      when GRACEFUL_RESTART
+        Griffin.logger.info("Restart sever(id=#{@worker_id}) gracefully...")
+
+        @status = :restart
+        # timeout is false since we don't know when all connections are closed by clients.
+        @server.graceful_shutdown(timeout: false)
+        true
       end
     end
   end

data/lib/griffin/server_config_builder.rb

@@ -8,7 +8,7 @@ module Griffin
     SERVERENGIEN_FIXED_CONFIGS = %i[daemonize worker_type worker_process_name].freeze
 
     # The default size of thread pool TCP Connection
-    DEFAULT_POOL_SIZE = 30
+    DEFAULT_POOL_SIZE = 20
     DEFAULT_CONNECTION_SIZE = 3
 
     GRIFFIN_CONFIGS = [
@@ -16,6 +16,9 @@ module Griffin
       :min_pool_size,
       :max_connection_size,
       :min_connection_size,
+      :max_receive_message_size,
+      :max_send_message_size,
+      :http2_settings,
     ].freeze
 
     GRPC_CONFIGS = %i[services interceptors].freeze
@@ -40,6 +43,7 @@ module Griffin
       min_connection_size: DEFAULT_CONNECTION_SIZE,
       interceptors: [],
       services: [],
+      http2_settings: [],
     }.freeze
 
     def initialize
@@ -67,6 +71,11 @@ module Griffin
       @opts[:min_connection_size] = Integer(min)
       @opts[:max_connection_size] = Integer(max)
     end
+
+    def http2_settings(settings)
+      @opts[:http2_settings] = settings
+    end
+
     def interceptors(*value)
       @opts[:interceptors].concat(value).flatten!
     end
@@ -75,6 +84,15 @@ module Griffin
       @opts[:services].concat(value).flatten!
     end
 
+    def max_receive_message_size(value)
+      @opts[:max_receive_message_size] = Integer(value)
+    end
+
+    def max_send_message_size(value)
+      @opts[:max_send_message_size] = Integer(value)
+    end
+
+
     def build
       c = ServerConfig.new
       @opts.each do |name, value|

data/lib/griffin/thread_pool.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'grpc_kit/thread_pool/auto_trimmer'
+require 'grpc_kit/rpc_dispatcher/auto_trimmer'
 
 module Griffin
   class ThreadPool
@@ -21,7 +21,7 @@ module Griffin
       @waiting = 0
 
       @min_pool_size.times { spawn_thread }
-      @auto_trimmer = GrpcKit::ThreadPool::AutoTrimmer.new(self, interval: interval + rand(10)).tap(&:start!)
+      @auto_trimmer = GrpcKit::RpcDispatcher::AutoTrimmer.new(self, interval: interval + rand(10)).tap(&:start!)
     end
 
     def schedule(task, &block)
@@ -41,6 +41,10 @@ module Griffin
       end
     end
 
+    def resouce_available?
+      (@waiting != 0) || (@spawned != @max_pool_size)
+    end
+
     def shutdown
       @shutdown = true
       @max_pool_size.times { @tasks.push(nil) }

data/lib/griffin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Griffin
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: griffin
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yuta Iwama
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-01-28 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: serverengine
   requirement: !ruby/object:Gem::Requirement
@@ -118,8 +118,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -146,7 +144,6 @@ files:
 - lib/griffin/engine/server.rb
 - lib/griffin/engine/single.rb
 - lib/griffin/engine/worker.rb
-- lib/griffin/listener.rb
 - lib/griffin/logger.rb
 - lib/griffin/server.rb
 - lib/griffin/server_config_builder.rb
@@ -159,7 +156,7 @@ homepage: https://github.com/ganmacs/griffin
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -175,9 +172,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: gRPC server and client for Ruby
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.5

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.4
-before_install: gem install bundler -v 1.16.1

data/lib/griffin/listener.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require 'socket'
-
-module Griffin
-  class Listener
-    DEFAULT_BACKLOG_SIZE = 1024
-
-    # @params host [String]
-    # @params port [Integer]
-    # @params backlog [Integer]
-    def initialize(host, port, backlog: DEFAULT_BACKLOG_SIZE)
-      @host = host
-      @port = port
-      @backlog = backlog
-    end
-
-    def listen(tcp_opt: true)
-      @sock = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
-      if tcp_opt
-        @sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
-      end
-
-      @sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEPORT, true)
-
-      @sock.bind(Addrinfo.tcp(@host, @port))
-      @sock.listen(@backlog)
-      Griffin.logger.info("Start listening #{@host}:#{@port}")
-      @sock
-    end
-
-    def close
-      @sock.close
-    end
-  end
-end