gruf 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65e740037fb8efc21bd1560364abb3c9de7ae69d8e443363b8965ab617344e99
-  data.tar.gz: 2acbd3d7618774210218dac40e033c8d279152793aa9336f7025eb9a2a6c7e30
+  metadata.gz: 161c1f1aeb32e9b80985795573d6c8474719043ced9971e7aa8f711daf46c633
+  data.tar.gz: 1d320dd2a0973e0889244e4f8fdb949e1b4ef574a1a61af0cbd479881243480d
 SHA512:
-  metadata.gz: 1b7130c6564fa22da55c76c28f602f1f56f90033a1df736539bc3c930e9edc3cb2ea5100644fa9ee2d918d6120cc7d6a683f0a81709431a06b7fc870f98eadd6
-  data.tar.gz: 8247fba2ac2be6f566d9c95bb76c321cc6920e289f082fb0f513c5a3bcfe033b7c5a01c762f1472f20b2c8c401d48187382b89f4cb4faf104c4a8dcf2cedd27d
+  metadata.gz: fae96509a53b6e5ed611f1931e3718f2d377b445824de5947d3dd93062a7b07933553c20218297bf66fe83e323192d12fb085acc9adf26963f34377e28f97177
+  data.tar.gz: d7ab37d15a0d48db8240a028965310f0988e0a3f57c8ccd7701ba129a0dd08d3378de05d9536b5aeb6eb096515fd4dd9491d93632a322c6c4de43bf2d8eec7fd

data/CHANGELOG.md

@@ -2,6 +2,10 @@ Changelog for the gruf gem. This includes internal history before the gem was ma
 
 ### Pending release
 
+### 2.5.2
+
+- Log ok/validation responses at DEBUG levels to prevent log stampeding in high-volume environments
+
 ### 2.5.1
 
 - Ensure `timeout` is an int when passed as a client option to a gRPC client

data/README.md

@@ -447,72 +447,8 @@ very large values (such as binary or json data).
 
 ## Testing with RSpec
 
-### Controllers
-
-In order to test your controller, you first need to mock a GRPC ActiveCall. You can create the following file under `/spec/support/` path of your project:
-
-```ruby
-require 'grpc'
-
-module Rpc
-  module Test
-    class Call
-      attr_reader :metadata
-
-      def initialize(md = nil)
-        @metadata = md || { 'authorization' => "Basic #{Base64.encode64('grpc:magic')}" }
-      end
-
-      def output_metadata
-        @output_metadata ||= {}
-      end
-    end
-  end
-end
-```
-
-Imagine you have the following controller to test:
-
-```ruby
-class ThingController < ::Gruf::Controllers::Base
-  bind ::Rpc::ThingService::Service
-
-  def get_thing
-    thing = Rpc::Thing.new(id: request.message.id, name: 'Foo')
-    Rpc::GetThingResponse.new(thing: thing)
-  end
-end
-```
-
-You can stub it in the specs this way:
-
-```ruby
-describe ThingController do
-  let(:rpc_service) { ::Rpc::ThingService::Service }
-  let(:rpc_desc) { Rpc::ThingService::Service.rpc_descs.values.first }
-  let(:message) { Rpc::GetThingRequest.new(id: 1) }
-  let(:controller) do
-    described_class.new(
-      method_key: :get_thing,
-      service: rpc_service,
-      active_call: Rpc::Test::Call.new,
-      message: message,
-      rpc_desc: rpc_desc
-    )
-  end
-
-  describe '.call' do
-    context 'with :get_thing as an argument' do
-      let(:result) { controller.call(:get_thing) }
-
-      it 'returns an instance of Rpc::GetThingResponse' do
-        expect(result).to be_instance_of(Rpc::GetThingResponse)
-        expect(result.id).to eq request.id
-      end
-    end
-  end
-end
-```
+There is a gem specifically for easy testing with RSpec: [gruf-rspec](https://github.com/bigcommerce/gruf-rspec). Take
+a look at its README for more information.
 
 ## Plugins
 

data/lib/gruf/interceptors/instrumentation/request_logging/interceptor.rb

@@ -38,20 +38,22 @@ module Gruf
         class Interceptor < ::Gruf::Interceptors::ServerInterceptor
 
           # Default mappings of codes to log levels...
-          LOG_LEVEL_MAP = { 'GRPC::Ok' => :info,
-                            'GRPC::InvalidArgument' => :info,
-                            'GRPC::NotFound' => :info,
-                            'GRPC::AlreadyExists' => :info,
-                            'GRPC::OutOfRange' => :info,
-                            'GRPC::Unauthenticated' => :warn,
-                            'GRPC::PermissionDenied' => :warn,
-                            'GRPC::Unknown' => :error,
-                            'GRPC::Internal' => :error,
-                            'GRPC::DataLoss' => :error,
-                            'GRPC::FailedPrecondition' => :error,
-                            'GRPC::Unavailable' => :error,
-                            'GRPC::DeadlineExceeded' => :error,
-                            'GRPC::Cancelled' => :error }.freeze
+          LOG_LEVEL_MAP = {
+            'GRPC::Ok' => :debug,
+            'GRPC::InvalidArgument' => :debug,
+            'GRPC::NotFound' => :debug,
+            'GRPC::AlreadyExists' => :debug,
+            'GRPC::OutOfRange' => :debug,
+            'GRPC::Unauthenticated' => :warn,
+            'GRPC::PermissionDenied' => :warn,
+            'GRPC::Unknown' => :error,
+            'GRPC::Internal' => :error,
+            'GRPC::DataLoss' => :error,
+            'GRPC::FailedPrecondition' => :error,
+            'GRPC::Unavailable' => :error,
+            'GRPC::DeadlineExceeded' => :error,
+            'GRPC::Cancelled' => :error
+          }.freeze
 
           ###
           # Log the request, sending it to the appropriate formatter
@@ -70,7 +72,7 @@ module Gruf
 
             # A result is either successful, or, some level of feedback handled in the else block...
             if result.successful?
-              type = :info
+              type = log_level_map['GRPC::Ok'] || :debug
               status_name = 'GRPC::Ok'
             else
               type = log_level_map[result.message_class_name] || :error
@@ -97,7 +99,7 @@ module Gruf
             payload[:time] = Time.now.to_s
             payload[:host] = Socket.gethostname
 
-            ::Gruf.logger.send(type, formatter.format(payload))
+            logger.send(type, formatter.format(payload))
 
             raise result.message unless result.successful?
             result.message
@@ -105,6 +107,13 @@ module Gruf
 
           private
 
+          ##
+          # @return [::Gruf::Logger]
+          #
+          def logger
+            @logger ||= options.fetch(:logger, ::Gruf.logger)
+          end
+
           ##
           # Return an appropriate log message dependent on the status
           #

data/lib/gruf/version.rb

@@ -14,5 +14,5 @@
 # OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #
 module Gruf
-  VERSION = '2.5.1'.freeze
+  VERSION = '2.5.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gruf
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - Shaun McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2019-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,8 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: gRPC Ruby Framework