grpc_kit 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a609dafaf12831fc04a1ffbf84f38b1551a408aeeeeb0fc22ec59eae33ab607
-  data.tar.gz: b2623749a3c1ec772963e081fafb4ca249fd0afba6e682fe61ccec68dd8e1c6a
+  metadata.gz: f9713e72ba462451e689cd4aaa676994c96d591eaae9ddb9c4552f3d741431f7
+  data.tar.gz: 77af2186c14504d79c801ac216b7cb7576ddd8f516c7451f3e571bab3ade41c9
 SHA512:
-  metadata.gz: bbf6bad8922e0058979e7e1962aed08ff7625f24691ae55cd62fc5a9ae6c53a6a68b1938050d17320b972b861e37edf1435e48497d63186863ed8e452c736eaa
-  data.tar.gz: aabd06f81259f04e8ea051466d88b5160cc062422f070a1bb6cb4945db43747ae488cbbe6d2f4af0bd97dfcf159c6705d52ceaaa7a6b916f7fc31b2f1378abf0
+  metadata.gz: 177555f8840c371e7d83cc67f6227a4043fe80fa06c4074b7ae5fcb9273af3f4115f06a4be94e4ea8491f6a5f606832114605d23611f27face8819bac937e2ab
+  data.tar.gz: 8a05c9f24bd762a845ed1a8f9652d108f3a281042c04387545c32954fd8c5bfa8a96e806229c8647dc4be6b3f75f334e0b1123ae7c25da06012ce325e629b7c4

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.5.0 (2021-04-22)
+
+- improve: Configurable max_receive_message_size and max_send_message_size ([#33](https://github.com/cookpad/grpc_kit/pull/33))
+
 ## v0.4.0 (2020-10-23)
 
 - bug: Fix Ruby 2.7 keyword argument separation warnings ([#27](https://github.com/cookpad/grpc_kit/pull/27))

data/lib/grpc_kit/client.rb

@@ -12,7 +12,9 @@ module GrpcKit
     # @param authority [nil, String]
     # @param interceptors [Array<GrpcKit::Grpc::ClientInterceptor>] list of interceptors
     # @param timeout [nil, Integer, String]
-    def initialize(sock, authority: nil, interceptors: [], timeout: nil)
+    # @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(sock, authority: nil, interceptors: [], timeout: nil, max_receive_message_size: nil, max_send_message_size: nil)
       @sock = sock
       @authority =
         if authority
@@ -24,7 +26,12 @@ module GrpcKit
 
       @timeout = timeout && GrpcKit::GrpcTime.new(timeout)
 
-      build_rpcs(interceptors)
+      # Defined at GrpcKit::Grpc::Dsl#.rpc_stub_class
+      build_rpcs(
+        interceptors,
+        max_receive_message_size: max_receive_message_size,
+        max_send_message_size: max_send_message_size,
+      )
     end
 
     # @param rpc [GrpcKit::Rpcs::Client::RequestResponse]

data/lib/grpc_kit/grpc/dsl.rb

@@ -7,6 +7,8 @@ require 'grpc_kit/grpc/stream'
 
 module GrpcKit
   module Grpc
+    # Methods under GrpcKit::Grpc::Dsl is available for classes include GRPC::GenericService.
+    # See also: GrpcKit::Grpc::GenericService
     module Dsl
       # @param value [String]
       attr_accessor :service_name
@@ -73,9 +75,9 @@ module GrpcKit
             super
           end
 
-          define_method(:build_rpcs) do |interceptors|
+          define_method(:build_rpcs) do |interceptors, **options|
             rpc_descs_.each do |method_name, rpc_desc|
-              @rpcs[method_name] = rpc_desc.build_client(interceptors: interceptors)
+              @rpcs[method_name] = rpc_desc.build_client(interceptors: interceptors, **options)
             end
           end
           private :build_rpcs

data/lib/grpc_kit/method_config.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 module GrpcKit
+  MAX_SERVER_RECEIVE_MESSAGE_SIZE = 1024 * 1024 * 4
+  MAX_SERVER_SEND_MESSAGE_SIZE = 1024 * 1024 * 4
+  MAX_CLIENT_RECEIVE_MESSAGE_SIZE = 1024 * 1024 * 4
+  MAX_CLIENT_SEND_MESSAGE_SIZE = 1024 * 1024 * 4
+
   MethodConfig = Struct.new(
     :path,
     :ruby_style_method_name,
@@ -12,11 +17,6 @@ module GrpcKit
     :max_send_message_size,
     :compressor_type,
   ) do
-    MAX_SERVER_RECEIVE_MESSAGE_SIZE = 1024 * 1024 * 4
-    MAX_SERVER_SEND_MESSAGE_SIZE = 1024 * 1024 * 4
-    MAX_CLIENT_RECEIVE_MESSAGE_SIZE = 1024 * 1024 * 4
-    MAX_CLIENT_SEND_MESSAGE_SIZE = 1024 * 1024 * 4
-
     def self.build_for_server(
           path:, ruby_style_method_name:, codec:, service_name:, method_name:, interceptor:,
           max_receive_message_size: MAX_SERVER_RECEIVE_MESSAGE_SIZE, max_send_message_size: MAX_SERVER_SEND_MESSAGE_SIZE, compressor_type: ''

data/lib/grpc_kit/rpc_desc.rb

@@ -38,10 +38,21 @@ module GrpcKit
       @service_name = service_name
     end
 
+    # @return [String]
+    attr_reader :name, :service_name
+
+    # @return [Class, GrpcKit::Grpc::Stream]
+    attr_reader :marshal, :unmarshal
+
+    # @return [Symbol]
+    attr_reader :marshal_method, :unmarshal_method
+
     # @param handler [GrpcKit::Grpc::GenericService]
     # @param interceptors [Array<GrpcKit::Grpc::ServerInterceptor>]
+    # @param max_receive_message_size [Integer, nil]
+    # @param max_send_message_size [Integer, nil]
     # @return [#invoke] Server version of rpc class
-    def build_server(handler, interceptors: [])
+    def build_server(handler, interceptors: [], max_send_message_size: nil, max_receive_message_size: nil)
       inter = interceptors.empty? ? nil : server_interceptor.new(interceptors)
 
       config = GrpcKit::MethodConfig.build_for_server(
@@ -51,13 +62,17 @@ module GrpcKit
         service_name: @service_name,
         method_name: @name,
         interceptor: inter,
+        max_receive_message_size: max_receive_message_size || GrpcKit::MAX_SERVER_RECEIVE_MESSAGE_SIZE,
+        max_send_message_size: max_send_message_size || GrpcKit::MAX_SERVER_SEND_MESSAGE_SIZE,
       )
       server.new(handler, config)
     end
 
     # @param interceptors [Array<GrpcKit::Grpc::ClientInterceptor>]
+    # @param max_receive_message_size [Integer, nil]
+    # @param max_send_message_size [Integer, nil]
     # @return [#invoke] Client version of rpc class
-    def build_client(interceptors: [])
+    def build_client(interceptors: [], max_send_message_size: nil, max_receive_message_size: nil)
       inter = interceptors.empty? ? nil : client_interceptor.new(interceptors)
 
       config = GrpcKit::MethodConfig.build_for_client(
@@ -67,6 +82,8 @@ module GrpcKit
         service_name: @service_name,
         method_name: @name,
         interceptor: inter,
+        max_receive_message_size: max_receive_message_size || GrpcKit::MAX_CLIENT_RECEIVE_MESSAGE_SIZE,
+        max_send_message_size: max_send_message_size || GrpcKit::MAX_CLIENT_SEND_MESSAGE_SIZE,
       )
       client.new(config)
     end

data/lib/grpc_kit/rpcs.rb

@@ -19,6 +19,9 @@ module GrpcKit
     end
 
     class ServerRpc
+      # @return [GrpcKit::MethodConfig]
+      attr_reader :config
+
       # @param handler [GrpcKit::Grpc::GenericService]
       # @param config [GrpcKit::MethodConfig]
       def initialize(handler, config)

data/lib/grpc_kit/server.rb

@@ -10,11 +10,15 @@ module GrpcKit
     # @param shutdown_timeout [Integer] Number of seconds to wait for the server shutdown
     # @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, settings: [])
+    # @param max_receive_message_size [Integer, nil] Specify the maximum size of inbound message in bytes. Default to 4MB.
+    # @param max_send_message_size [Integer, nil] Specify the maximum size of outbound message in bytes. Default to 4MB.
+    def initialize(interceptors: [], shutdown_timeout: 30, min_pool_size: nil, max_pool_size: nil, settings: [], max_receive_message_size: nil, max_send_message_size: nil)
       @interceptors = interceptors
       @shutdown_timeout = shutdown_timeout
       @min_pool_size = min_pool_size || GrpcKit::RpcDispatcher::DEFAULT_MIN
       @max_pool_size = max_pool_size || GrpcKit::RpcDispatcher::DEFAULT_MAX
+      @max_receive_message_size = max_receive_message_size
+      @max_send_message_size = max_send_message_size
       @sessions = []
       @rpc_descs = {}
       @mutex = Mutex.new
@@ -37,8 +41,12 @@ module GrpcKit
           raise "Duplicated method registered #{path}, class: #{klass}"
         end
 
-        s = handler.is_a?(Class) ? handler.new : handler
-        @rpc_descs[path] = rpc_desc.build_server(s, interceptors: @interceptors)
+        @rpc_descs[path] = rpc_desc.build_server(
+          handler.is_a?(Class) ? handler.new : handler,
+          interceptors: @interceptors,
+          max_receive_message_size: @max_receive_message_size,
+          max_send_message_size: @max_send_message_size,
+        )
       end
     end
 

data/lib/grpc_kit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc_kit
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yuta Iwama
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ds9
@@ -147,7 +147,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -253,7 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: A kit for creating gRPC server/client

data/.ruby-version

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