twirp_rails 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99287bad34a0f5b439f258dfbb0adb7bd62828f1c5f6a34078da76fde019379a
-  data.tar.gz: f6966d4a6bf9c5dfc808382e0c2392f3a9fa559ba6a195a95d67872e223c35d8
+  metadata.gz: ed5981c2bd96acaa3ea71757071e805a939edc81796009d70d0ce8308ad7ee29
+  data.tar.gz: 49e69faa936f5efb286b2e35de4b7558ac6811d4f487b06af2bfdb71c929749f
 SHA512:
-  metadata.gz: 032fd8c2fb3e9e9c127b35cfd62ac551ec93d30095c6881e4d76ac91ecd6ed26be5bd0d71a381a91d12183c62333303037b6e8539beca626c3e7a3ac6d7c727a
-  data.tar.gz: d4d5d2a7e4bdf475b1a98587c3280a76108b89b0124a2cf75c72bc50f3c46f036dc0f8c8639f82fc4fb0857d5bc278ac9e41a672ee384f2b5609e3767adfefbd
+  metadata.gz: 9d3110ce249d65dcab59868b555b9bfa01eef0b430e8e5bd00ae8084dc92415868d14b7f717cde451a8e1c99796eda82f7f0baeffc9725d5d3ba26e2bd04ecb9
+  data.tar.gz: 83e8e6a07c327d539d9b6b8a97a6f68a2699171b666320ca679fb2cdf72d92cd56fcafc6f93d27f40b4258cfb22bf7ba040f80bee82a5c525750af7a8e2cb935

data/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.3.0 - 2020-02-28
+
+### Added
+- Ability to detailed log twirp calls. Add `TwirpRails.log_twirp_calls!` to the initializer. 
+
+### Breaking changes
+- Services not been instrumented via `ActiveSupport::Notifications` unless `TwirpRails.log_twirp_calls!` used.
+
 ## 0.2.0 - 2020-02-21
 
 ### Breaking changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twirp_rails (0.2.1)
+    twirp_rails (0.3.0)
       railties (~> 6.0)
       twirp (~> 1)
 

data/README.md

@@ -1,7 +1,12 @@
 # TwirpRails
 
-TwirpRails helps to use [twirp-ruby gem](https://github.com/twitchtv/twirp-ruby) with rails and to
-automate code generation from ```.proto``` files.
+TwirpRails helps to use [twirp-ruby gem](https://github.com/twitchtv/twirp-ruby) with rails.
+
+ * twirp code generation from ```.proto``` file
+ * handler, rspec and swagger code generation from ```.proto``` file
+ * `mount_twirp` route helper to mount handlers
+ * `rpc` helper to dry your handlers specs
+ * ability to log twirp calls by Rails logger
 
 ## Installation
 
@@ -71,8 +76,8 @@ rails s
 
 And check it from rails console.
 ```ruby
-PeopleClient.new('http://localhost:3000').get_name(GetNameRequest.new uid: '1').data.name
-=> "Name of 1"
+PeopleClient.new('http://localhost:3000/twirp').get_name(uid: 'starship').data.name
+=> "Name of starship"
 ```
 
 ### Test your service with rspec
@@ -81,8 +86,8 @@ If you use RSpec, twirp generator creates handler spec file with all service met
 
 ```ruby
 describe TeamsHandler do
-
   context '#get' do
+    let(:team) { create(:team) } 
     rpc { [:get, id: team.id] }
 
     it { should match(team: team.to_twirp) }
@@ -101,6 +106,34 @@ end
 
 or run ```rails g twirp:rspec``` to do it automatically.
 
+## Log twirp calls
+
+By default, Rails logs only start of POST request. To get a more detailed log of twirp calls, add this code to the initializer.
+
+```ruby
+# config/initializers/twirp_rails.rb
+TwirpRails.log_twirp_calls!
+```
+
+You can customize log output by pass a block argument
+
+```ruby
+# config/initializers/twirp_rails.rb
+TwirpRails.log_twirp_calls! do |event|
+  twirp_call_info = {
+    duration: event.duration,
+    method: event.payload[:env][:rpc_method],
+    params: event.payload[:env][:input].to_h
+  }
+
+  if (exception = event.payload[:env][:exception])
+    twirp_call_info[:exception] = exception
+  end
+
+  Rails.logger.info "method=%{method} duration=%{duration}" % twirp_call_info
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/twirp_rails/engine.rb

@@ -15,10 +15,6 @@ module TwirpRails
         TwirpRails::RavenAdapter.install
       end
 
-      initializer 'twirp_rails.logging' do
-        TwirpRails::LoggingAdapter.install
-      end
-
       initializer 'twirp_rails.require_generated_files' do
         TwirpRails::Twirp.auto_require_twirp_files
       end

data/lib/twirp_rails/generators/twirp/twirp_generator.rb

@@ -6,7 +6,8 @@ class TwirpGenerator < Rails::Generators::NamedBase
   class_option :skip_swagger, type: :boolean, default: false
   class_option :swagger_out, type: :string, default: 'public/swagger'
 
-  GO_BIN_PATH = ENV.fetch('GOPATH') { File.expand_path('~/go/bin') }
+  GOPATH = ENV.fetch('GOPATH') { File.expand_path('~/go') }
+  GO_BIN_PATH = File.join(GOPATH, 'bin')
   TWIRP_PLUGIN_PATH = ENV.fetch('TWIRP_PLUGIN_PATH') { File.join(GO_BIN_PATH, 'protoc-gen-twirp_ruby') }
   SWAGGER_PLUGIN_PATH = ENV.fetch('SWAGGER_PLUGIN_PATH') { File.join(GO_BIN_PATH, 'protoc-gen-twirp_swagger') }
   PROTOC_PATH = `which protoc`.chomp
@@ -105,22 +106,6 @@ class TwirpGenerator < Rails::Generators::NamedBase
     end
   end
 
-  def inject_rspec_helper
-    in_root do
-      return unless File.exist?('spec/rails_helper.rb')
-
-      require_sentinel = %r{require 'rspec/rails'\s*\n}m
-      include_sentinel = /RSpec\.configure do |config|\s*\n/m
-
-      inject_into_file 'spec/rails_helper.rb',
-                       "require 'twirp/rails/rspec/helper'",
-                       after: require_sentinel, verbose: true, force: false
-      inject_into_file 'spec/rails_helper.rb',
-                       '  config.include TwirpRails::RSpec::Helper, type: :rpc, file_path: %r{spec/rpc}',
-                       after: include_sentinel, verbose: true, force: false
-    end
-  end
-
   private
 
   def proto_type_to_ruby(result_type)

data/lib/twirp_rails/log_subscriber.rb

@@ -0,0 +1,27 @@
+module TwirpRails
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    cattr_accessor :log_writer
+
+    def instrumenter(event)
+      if LogSubscriber.log_writer
+        LogSubscriber.log_writer.call(event)
+      else
+        default_log_writer(event)
+      end
+    end
+
+    def default_log_writer(event)
+      twirp_call_info = {
+        duration: event.duration,
+        method: event.payload[:env][:rpc_method],
+        params: event.payload[:env][:input].to_h
+      }
+
+      if (exception = event.payload[:env][:exception])
+        twirp_call_info[:exception] = exception
+      end
+
+      Rails.logger.info twirp_call_info
+    end
+  end
+end

data/lib/twirp_rails/version.rb

@@ -1,3 +1,3 @@
 module TwirpRails
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.3.0'.freeze
 end

data/lib/twirp_rails.rb

@@ -5,7 +5,15 @@ require 'twirp_rails/engine'
 require 'twirp_rails/generators/twirp/twirp_generator'
 require 'twirp_rails/generators/twirp/twirp_rspec_generator'
 require 'twirp_rails/active_record_extension'
+require 'twirp_rails/log_subscriber'
 
 module TwirpRails
   class Error < StandardError; end
+
+  def self.log_twirp_calls!(&log_writer)
+    TwirpRails::LoggingAdapter.install
+
+    TwirpRails::LogSubscriber.log_writer = log_writer if block_given?
+    TwirpRails::LogSubscriber.attach_to(:twirp)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twirp_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexandr Zimin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twirp
@@ -145,6 +145,7 @@ files:
 - lib/twirp_rails/generators/twirp/USAGE
 - lib/twirp_rails/generators/twirp/twirp_generator.rb
 - lib/twirp_rails/generators/twirp/twirp_rspec_generator.rb
+- lib/twirp_rails/log_subscriber.rb
 - lib/twirp_rails/logging_adapter.rb
 - lib/twirp_rails/raven_adapter.rb
 - lib/twirp_rails/routes.rb