grpc_kit 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 669ad89bc39849c66aeea640ba77ac6204e7cb1c2034a77b4bd4b698830c071a
-  data.tar.gz: fa4a14c0c2bf93837826b9477c126031849e95310f18f7633237d9a485688e56
+  metadata.gz: 24da7e7fc87c510f28152d959814121928623f6217da6d46148fa8a83f39446f
+  data.tar.gz: 792c2414ddffaf2e96abf6e8de8239cbf4a9cd1963675e9af9cf3af2434c7bf5
 SHA512:
-  metadata.gz: c20fe45fbc01d727fdde2f70d1ebd53bcd2c89c03e9ef01e676a73344e7618aa7e32eaa07af71b10733cb79986fd1883647ba81a5e71b04779a8ded3c4bd8c4a
-  data.tar.gz: be9fb063cd523f9c6c2a47a58584a930f431378a050af865106126b1784ace126291d226c088884c7bd479423d86076439189856e7831341a1b22d7465443043
+  metadata.gz: 8c7194e0e9043f0f984b226b13dee18ee3ff84168061f2c788a8deeeb8e8096c748c83a26635ef4241deaeb283e315e9ffb39d40a54065922daad0bb59152055
+  data.tar.gz: 0b502f3c1d0606c4bfe514eea8a0d250fbf7a34718d6f5926a9cbc7b0eaae296ba4f1a2f5a33eeebd50e665481927d6711377978d762184e29ec50a666b18b7e

data/lib/grpc_kit/control_queue.rb

@@ -0,0 +1,30 @@
+module GrpcKit
+  class ControlQueue
+    def initialize
+      @event_stream = Queue.new
+    end
+
+    # Be nonblocking
+    def pop
+      if @event_stream.empty?
+        nil
+      else
+        @event_stream.pop(true)
+      end
+    rescue ThreadError => _
+      nil
+    end
+
+    def submit_response(id, headers)
+      @event_stream.push([:submit_response, id, headers])
+    end
+
+    def submit_headers(id, headers)
+      @event_stream.push([:submit_headers, id, headers])
+    end
+
+    def resume_data(id)
+      @event_stream.push([:resume_data, id])
+    end
+  end
+end

data/lib/grpc_kit/server.rb

@@ -7,9 +7,13 @@ module GrpcKit
   class Server
     # @param interceptors [Array<GrpcKit::Grpc::ServerInterceptor>] list of interceptors
     # @param shutdown_timeout [Integer] Number of seconds to wait for the server shutdown
-    def initialize(interceptors: [], shutdown_timeout: 30)
+    # @param min_pool_size [Integer] A mininum thread pool size
+    # @param max_pool_size [Integer] A maximum thread pool size
+    def initialize(interceptors: [], shutdown_timeout: 30, min_pool_size: nil, max_pool_size: nil)
       @interceptors = interceptors
       @shutdown_timeout = shutdown_timeout
+      @min_pool_size = min_pool_size || GrpcKit::ThreadPool::DEFAULT_MIN
+      @max_pool_size = max_pool_size || GrpcKit::ThreadPool::DEFAULT_MAX
       @sessions = []
       @rpc_descs = {}
       @mutex = Mutex.new
@@ -68,16 +72,15 @@ module GrpcKit
         @mutex.synchronize { @sessions.each(&:drain) }
 
         end_time = Time.now + @shutdown_timeout
-        until end_time < Time.now
-          if @sessions.empty?
-            return
+        loop do
+          if end_time < Time.now
+            GrpcKit.logger.error("Graceful shutdown is timeout (#{@shutdown_timeout}sec). Perform shutdown forceibly")
+            shutdown_sessions
+            break
+          elsif @sessions.empty?
+            break
           end
-
-          sleep 1
         end
-
-        GrpcKit.logger.error('Timeout graceful shutdown. perform force shutdown')
-        shutdown_sessions
       end
     end
 
@@ -85,28 +88,35 @@ module GrpcKit
       @mutex.synchronize { @sessions.size }
     end
 
-    # @param path [String] gRPC method path
-    # @param stream [GrpcKit::Streams::ServerStream]
-    # @return [void]
-    def dispatch(path, stream)
+    private
+
+    def dispatch(stream, control_queue)
+      t = GrpcKit::Transport::ServerTransport.new(control_queue, stream)
+      ss = GrpcKit::Stream::ServerStream.new(t)
+      path = stream.headers.path
+
       rpc = @rpc_descs[path]
       unless rpc
         e = GrpcKit::Errors::Unimplemented.new(path)
-        stream.send_status(status: e.code, msg: e.message)
+        ss.send_status(status: e.code, msg: e.message)
         return
       end
 
-      stream.invoke(rpc)
+      ss.invoke(rpc)
     end
 
-    private
+    def thread_pool
+      @thread_pool ||= GrpcKit::ThreadPool.new(min: @min_pool_size, max: @max_pool_size) do |task|
+        dispatch(task[0], task[1])
+      end
+    end
 
     def shutdown_sessions
       @mutex.synchronize { @sessions.each(&:shutdown) }
     end
 
     def establish_session(conn)
-      session = GrpcKit::Session::ServerSession.new(GrpcKit::Session::IO.new(conn), self)
+      session = GrpcKit::Session::ServerSession.new(GrpcKit::Session::IO.new(conn), thread_pool)
       begin
         @mutex.synchronize { @sessions << session }
         yield(session)

data/lib/grpc_kit/session/recv_buffer.rb

@@ -6,32 +6,36 @@ module GrpcKit
       def initialize
         @buffer = +''.b
         @end = false
+        @mutex = Mutex.new
       end
 
       # @param data [String]
       # @return [void]
       def write(data)
-        @buffer << data
+        @mutex.synchronize { @buffer << data }
       end
 
       # @param size [Integer,nil]
       # @param last [Boolean]
       # @return [String,nil]
       def read(size = nil, last: false)
-        return nil if @buffer.empty?
+        buf = @mutex.synchronize do
+          return nil if @buffer.empty?
 
-        end_read if last
-
-        if size.nil? || @buffer.bytesize < size
-          buf = @buffer
-          @buffer = ''.b
-          buf
-        else
-          @buffer.freeze
-          rbuf = @buffer.byteslice(0, size)
-          @buffer = @buffer.byteslice(size, @buffer.bytesize)
-          rbuf
+          if size.nil? || @buffer.bytesize < size
+            buf = @buffer
+            @buffer = ''.b
+            buf
+          else
+            @buffer.freeze
+            rbuf = @buffer.byteslice(0, size)
+            @buffer = @buffer.byteslice(size, @buffer.bytesize)
+            rbuf
+          end
         end
+
+        end_read if last
+        buf
       end
 
       # @return [Boolean]

data/lib/grpc_kit/session/send_buffer.rb

@@ -7,14 +7,15 @@ module GrpcKit
         @buffer = ''.b
         @end_write = false
         @deferred_read = false
+        @mutex = Mutex.new
       end
 
       # @param data [String]
       # @param last [Boolean]
       # @return [void]
       def write(data, last: false)
+        @mutex.synchronize { @buffer << data }
         end_write if last
-        @buffer << data
       end
 
       # @return [Boolean]
@@ -32,11 +33,21 @@ module GrpcKit
         @end_write
       end
 
+      def empty?
+        @mutex.synchronize { @buffer.empty? }
+      end
+
       # @param size [Integer,nil]
       # @return [nil,DS9::ERR_DEFERRED,String]
       def read(size = nil)
-        if @buffer.empty?
+        buf = do_read(size)
+        if buf.nil?
           if end_write?
+            # Call again because #write invokes `@buffer << data` before calling #end_write
+            if (buf = do_read(size))
+              return buf
+            end
+
             @deferred_read = false
             return nil # EOF
           end
@@ -45,15 +56,25 @@ module GrpcKit
           return DS9::ERR_DEFERRED
         end
 
-        if size.nil? || @buffer.bytesize < size
-          buf = @buffer
-          @buffer = ''.b
-          buf
-        else
-          @buffer.freeze
-          rbuf = @buffer.byteslice(0, size)
-          @buffer = @buffer.byteslice(size, @buffer.bytesize)
-          rbuf
+        buf
+      end
+
+      private
+
+      def do_read(size = nil)
+        @mutex.synchronize do
+          if @buffer.empty?
+            nil
+          elsif size.nil? || @buffer.bytesize < size
+            buf = @buffer
+            @buffer = ''.b
+            buf
+          else
+            @buffer.freeze
+            rbuf = @buffer.byteslice(0, size)
+            @buffer = @buffer.byteslice(size, @buffer.bytesize)
+            rbuf
+          end
         end
       end
     end

data/lib/grpc_kit/session/server_session.rb

@@ -2,11 +2,13 @@
 
 require 'ds9'
 require 'forwardable'
+require 'grpc_kit/control_queue'
 require 'grpc_kit/session/stream'
 require 'grpc_kit/session/drain_controller'
 require 'grpc_kit/stream/server_stream'
-require 'grpc_kit/transport/server_transport'
 require 'grpc_kit/session/send_buffer'
+require 'grpc_kit/transport/server_transport'
+require 'grpc_kit/thread_pool'
 
 module GrpcKit
   module Session
@@ -16,16 +18,17 @@ module GrpcKit
       delegate %i[send_event recv_event] => :@io
 
       # @param io [GrpcKit::Session::IO]
-      # @param dispatcher [GrpcKit::Server]
-      def initialize(io, dispatcher)
+      # @param pool [GrpcKit::ThreadPool] Thread pool handling reqeusts
+      def initialize(io, pool)
         super() # initialize DS9::Session
 
         @io = io
         @streams = {}
         @stop = false
-        @dispatcher = dispatcher
         @inflights = []
         @drain_controller = GrpcKit::Session::DrainController.new
+        @control_queue = GrpcKit::ControlQueue.new
+        @pool = pool
       end
 
       # @return [void]
@@ -101,10 +104,20 @@ module GrpcKit
       end
 
       def invoke
-        while (stream = @inflights.pop)
-          t = GrpcKit::Transport::ServerTransport.new(self, stream)
-          th = GrpcKit::Stream::ServerStream.new(t)
-          @dispatcher.dispatch(stream.headers.path, th)
+        while (event = @control_queue.pop)
+          case event[0]
+          when :submit_response
+            # piggybacked previous invokeing #submit_response?
+            if @streams[event[1]].pending_send_data.empty?
+              next
+            end
+
+            submit_response(event[1], event[2])
+          when :submit_headers
+            submit_headers(event[1], event[2])
+          when :resume_data
+            resume_data(event[1])
+          end
         end
       end
 
@@ -138,7 +151,16 @@ module GrpcKit
         end
       end
 
+      # nghttp2_session_callbacks_set_on_data_chunk_recv_callback
+      def on_data_chunk_recv(stream_id, data, _flags)
+        stream = @streams[stream_id]
+        if stream
+          stream.pending_recv_data.write(data)
+        end
+      end
+
       # nghttp2_session_callbacks_set_on_frame_recv_callback
+      # Note: called after ServerSession#on_data_chunk_recv
       def on_frame_recv(frame)
         GrpcKit.logger.debug("on_frame_recv #{frame}") # Too many call
 
@@ -152,7 +174,7 @@ module GrpcKit
 
           unless stream.inflight
             stream.inflight = true
-            @inflights << stream
+            @pool.schedule([stream, @control_queue])
           end
         when DS9::Frames::Headers
           if frame.end_stream?
@@ -233,14 +255,6 @@ module GrpcKit
           end
         end
       end
-
-      # nghttp2_session_callbacks_set_on_data_chunk_recv_callback
-      def on_data_chunk_recv(stream_id, data, _flags)
-        stream = @streams[stream_id]
-        if stream
-          stream.pending_recv_data.write(data)
-        end
-      end
     end
   end
 end

data/lib/grpc_kit/thread_pool/auto_trimmer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module GrpcKit
+  class ThreadPool
+    class AutoTrimmer
+      def initialize(pool, interval: 30)
+        @pool = pool
+        @interval = interval
+        @running = false
+      end
+
+      def start!
+        @running = true
+        @thread = Thread.new do
+          loop do
+            unless @running
+              GrpcKit.logger.debug('Stop AutoTrimer')
+              break
+            end
+            @pool.trim
+            sleep @interval
+          end
+        end
+      end
+
+      def stop
+        @running = false
+        @thread.wakeup
+      end
+    end
+  end
+end

data/lib/grpc_kit/thread_pool.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'grpc_kit/thread_pool/auto_trimmer'
+
+module GrpcKit
+  class ThreadPool
+    DEFAULT_MAX = 20
+    DEFAULT_MIN = 5
+
+    # @param min [Integer] A mininum thread pool size
+    # @param max [Integer] A maximum thread pool size
+    # @param interval [Integer] An interval time of calling #trim
+    def initialize(max: DEFAULT_MAX, min: DEFAULT_MIN, interval: 30, &block)
+      @max_pool_size = max
+      @min_pool_size = min
+      @shutdown = false
+      @tasks = Queue.new
+      unless max == min
+        @auto_trimmer = AutoTrimmer.new(self, interval: interval).tap(&:start!)
+      end
+
+      @spawned = 0
+      @workers = []
+      @mutex = Mutex.new
+      @block = block
+
+      @min_pool_size.times { spawn_thread }
+    end
+
+    # @param task [Object] task to schedule
+    def schedule(task, &block)
+      if task.nil?
+        return
+      end
+
+      if @shutdown
+        raise "scheduling new task isn't allowed during shutdown"
+      end
+
+      @tasks.push(block || task)
+
+      Thread.pass
+      if !@tasks.empty? && @mutex.synchronize { @spawned > @min_pool_size }
+        spawn_thread
+      end
+    end
+
+    def shutdown
+      @shutdown = true
+      @auto_trimmer.stop if @auto_trimmer
+      @waiting.times { @tasks.push(nil) }
+    end
+
+    def trim(force = false)
+      if (force || @tasks.empty?) && @mutex.synchronize { @spawned > @min_pool_size }
+        GrpcKit.logger.debug("Trim worker! Next worker size #{@spawned - 1}")
+        @tasks.push(nil)
+      end
+    end
+
+    private
+
+    def spawn_thread
+      @spawned += 1
+      worker = Thread.new(@spawned) do |i|
+        Thread.current.name = "grpc_kit worker thread #{i}"
+        GrpcKit.logger.debug("#{Thread.current.name} started")
+
+        loop do
+          if @shutdown
+            break
+          end
+
+          task = @tasks.pop
+          if task.nil?
+            break
+          end
+
+          begin
+            @block.call(task)
+          rescue Exception => e # rubocop:disable Lint/RescueException
+            GrpcKit.logger.error("An error occured on top level in worker #{Thread.current.name}: #{e.message} (#{e.class})\n #{Thread.current.backtrace.join("\n")}")
+          end
+        end
+
+        GrpcKit.logger.debug("worker thread #{Thread.current.name} is stopping")
+        @mutex.synchronize do
+          @spawned -= 1
+          @workers.delete(worker)
+        end
+      end
+
+      @workers.push(worker)
+    end
+  end
+end

data/lib/grpc_kit/transport/server_transport.rb

@@ -7,24 +7,23 @@ module GrpcKit
     class ServerTransport
       include GrpcKit::Transport::Packable
 
-      # @param session [GrpcKit::Session::ServerSession]
+      # @param session [GrpcKit::ControlQueue]
       # @param stream [GrpcKit::Session::Stream]
-      def initialize(session, stream)
-        @session = session
+      def initialize(control_queue, stream)
+        @control_queue = control_queue
         @stream = stream
       end
 
       # @param headers [Hash<String, String>]
       # @return [void]
       def start_response(headers)
-        @session.submit_response(@stream.stream_id, headers)
-        send_data
+        @control_queue.submit_response(@stream.stream_id, headers)
       end
 
       # @param headers [Hash<String, String>]
       # @return [void]
       def submit_headers(headers)
-        @session.submit_headers(@stream.stream_id, headers)
+        @control_queue.submit_headers(@stream.stream_id, headers)
       end
 
       # @param buf [String]
@@ -32,7 +31,6 @@ module GrpcKit
       # @return [void]
       def write_data(buf, last: false)
         @stream.write_send_data(pack(buf), last: last)
-        send_data(last: last)
       end
 
       # @param last [Boolean]
@@ -45,7 +43,6 @@ module GrpcKit
       # @return [void]
       def write_trailers(trailer)
         @stream.write_trailers_data(trailer)
-        send_data(last: true)
       end
 
       # @return [void]
@@ -63,29 +60,23 @@ module GrpcKit
       def recv_data(last: false)
         loop do
           data = @stream.read_recv_data(last: last)
-          return data unless data.nil?
+          return data if data
 
           if @stream.close_remote?
-            # it do not receive data which we need, it may receive invalid grpc-status
-            unless @stream.end_read?
-              return nil
-            end
-
-            return nil
+            # Call @stream.read_recv_data after checking @stream.close_remote?
+            # because of the order of nghttp2 callbacks which calls a callback receiving data before a callback receiving END_STREAM flag
+            data = @stream.read_recv_data(last: last)
+            return data
           end
-
-          @session.run_once
         end
       end
 
-      def send_data(last: false)
-        if @stream.pending_send_data.need_resume?
-          @session.resume_data(@stream.stream_id)
+      def send_data
+        unless @stream.pending_send_data.need_resume?
+          return
         end
 
-        unless last
-          @session.run_once
-        end
+        @session.resume_data(@stream.stream_id)
       end
     end
   end

data/lib/grpc_kit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc_kit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Yuta Iwama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ds9
@@ -183,6 +183,7 @@ files:
 - lib/grpc_kit/calls/server_server_streamer.rb
 - lib/grpc_kit/client.rb
 - lib/grpc_kit/codec.rb
+- lib/grpc_kit/control_queue.rb
 - lib/grpc_kit/errors.rb
 - lib/grpc_kit/grpc/core.rb
 - lib/grpc_kit/grpc/dsl.rb
@@ -226,6 +227,8 @@ files:
 - lib/grpc_kit/status_codes.rb
 - lib/grpc_kit/stream/client_stream.rb
 - lib/grpc_kit/stream/server_stream.rb
+- lib/grpc_kit/thread_pool.rb
+- lib/grpc_kit/thread_pool/auto_trimmer.rb
 - lib/grpc_kit/transport/client_transport.rb
 - lib/grpc_kit/transport/packable.rb
 - lib/grpc_kit/transport/server_transport.rb