grpcx 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e6bcd16e9fceffd33f50eb1f4329ce55b9c983ff434f8688cbc2cf2432012d0
-  data.tar.gz: 79fb5b99a06087b37e0a8af8c36c13eebaf07b81a797459144b144adcecc3e07
+  metadata.gz: a99773353852adc153af1cda72a8c17e980687c69127bb9a7830d983fd4a052d
+  data.tar.gz: 415a8d6f395db5283f57c9756ed47483560b8b1365ff224090a88f6a5dba02b1
 SHA512:
-  metadata.gz: e19042030a742d1f985dde51ef366402bbd062c3fe4f2d17d987c6dbc40db0cf069ad61f746648291987d0011b38d28f757e3dd8b9b5bdcdff738ba34029b228
-  data.tar.gz: a79ba2d070d331afa74b95f439f0cfa0fa243d2e5c6b11186d3175374f3a435b304082ad67ec2ba34230415dda06add606101b0762ed8823b36b4c4c19448443
+  metadata.gz: 8a92a53f2e0fe302482ca483f4434a35f274045d97ebc77c63e11a425f3c591d31bbcbdec2ed013a0c296fefbaf9ad514ecdc45ad8dbfc9143acde905d767933
+  data.tar.gz: 775e2e820a35bc874ab36090e3328c72954545653d5dec0a02ee3608aa4b836d88742b17b49a0845dc8e5897db6871464e9978b87f704a03819f23c4bd21971b

data/.gitignore

@@ -1,2 +1,3 @@
 .rubocop-*
+.rake_tasks~
 pkg/

data/Gemfile.lock

@@ -1,96 +1,70 @@
 PATH
   remote: .
   specs:
-    grpcx (0.1.1)
+    grpcx (0.2.0)
       activesupport (>= 5.0)
       grpc (>= 1.8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activerecord (5.2.0)
-      activemodel (= 5.2.0)
-      activesupport (= 5.2.0)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
       arel (>= 9.0)
-    activesupport (5.2.0)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
     arel (9.0.0)
     ast (2.4.0)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
-    faraday (0.15.0)
-      multipart-post (>= 1.2, < 3)
-    google-protobuf (3.5.1.2-x86_64-linux)
-    googleapis-common-protos-types (1.0.1)
+    google-protobuf (3.6.1)
+    googleapis-common-protos-types (1.0.2)
       google-protobuf (~> 3.0)
-    googleauth (0.6.2)
-      faraday (~> 0.12)
-      jwt (>= 1.4, < 3.0)
-      logging (~> 2.0)
-      memoist (~> 0.12)
-      multi_json (~> 1.11)
-      os (~> 0.9)
-      signet (~> 0.7)
-    grpc (1.11.0-x86_64-linux)
+    grpc (1.14.2)
       google-protobuf (~> 3.1)
       googleapis-common-protos-types (~> 1.0.0)
-      googleauth (>= 0.5.1, < 0.7)
-    i18n (1.0.1)
+    i18n (1.1.0)
       concurrent-ruby (~> 1.0)
-    jwt (2.1.0)
-    little-plugger (1.1.4)
-    logging (2.2.2)
-      little-plugger (~> 1.1)
-      multi_json (~> 1.10)
-    memoist (0.16.0)
+    jaro_winkler (1.5.1)
     minitest (5.11.3)
-    multi_json (1.13.1)
-    multipart-post (2.0.0)
-    os (0.9.6)
     parallel (1.12.1)
-    parser (2.5.1.0)
+    parser (2.5.1.2)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
-    public_suffix (3.0.2)
+    powerpack (0.1.2)
     rainbow (3.0.0)
     rake (12.3.1)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.55.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.59.0)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5)
+      parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    signet (0.8.1)
-      addressable (~> 2.3)
-      faraday (~> 0.9)
-      jwt (>= 1.5, < 3.0)
-      multi_json (~> 1.10)
+    ruby-progressbar (1.10.0)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unicode-display_width (1.3.2)
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
@@ -104,4 +78,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   1.16.1
+   1.16.4

data/README.md

@@ -9,7 +9,7 @@ Mixin for `GRPC::RpcServer`:
 
 - handles [GRPC health checks](https://github.com/grpc/grpc/blob/master/doc/health-checking.md) requests
 - handles `ActiveRecord` connection (auto-connect + pooling)
-- instruments each request with `ActiveSupport::Notifications` (available as `process_action.grpc`, includes `action: METHOD_NAME` data)
+- instruments each request with `ActiveSupport::Notifications` (available as `process_action.grpc`, includes `service: 'package.name.ServiceName', action: 'underscored_action_name'` data)
 - includes `ActiveSupport::Rescuable` and transforms most common `ActiveRecord::ActiveRecordError`-s into `GRPC::BadStatus` ones
 
 
@@ -51,12 +51,13 @@ end
 ## Using with [Datadog::Notifications](https://github.com/bsm/datadog-notifications)
 
 ```ruby
+# TODO: update this in datadog-notifications gem itself (to handle new service/action payloads)
 module Datadog::Notifications::Plugins
-  class GRPC < Base
+  class MyGRPC < Base
 
     def initialize(opts={})
       super
-      Datadog::Notifications.subscribe 'process_action.grpc' do |reporter, event|
+      Datadog::Notifications.subscribe(Grpcx::Server::Interceptors::Instrumentation::METRIC_NAME) do |reporter, event|
         record(reporter, event)
       end
     end
@@ -64,9 +65,10 @@ module Datadog::Notifications::Plugins
     private
 
     def record(reporter, event)
-      action = event.payload[:action]
-      status = event.payload[:exception] ? 'error' : 'ok'
-      tags = self.tags + ["rpc:#{action}", "status:#{status}"]
+      service = event.payload[:service]
+      action  = event.payload[:action]
+      status  = event.payload[:exception] ? 'error' : 'ok'
+      tags = self.tags + %W[service:#{service} action:#{action} status:#{status}]
 
       reporter.batch do
         reporter.increment 'grpc.request', tags: tags
@@ -78,7 +80,7 @@ module Datadog::Notifications::Plugins
 end
 
 Datadog::Notifications.configure do |c|
-  c.use Datadog::Notifications::Plugins::GRPC
+  c.use Datadog::Notifications::Plugins::MyGRPC
 end if RUNNING_IN_PROD?
 ```
 
@@ -86,11 +88,14 @@ end if RUNNING_IN_PROD?
 ## Using with [Sentry](https://sentry.io/)/[Raven](https://github.com/getsentry/raven-ruby)
 
 ```ruby
-ActiveSupport::Notifications.subscribe('process_action.grpc') do |_name, _start, _finish, _id, payload|
+ActiveSupport::Notifications.subscribe(Grpcx::Server::Interceptors::Instrumentation::METRIC_NAME) do |_name, _start, _finish, _id, payload|
   e = payload[:exception_object]
   next unless e
 
-  Raven.capture_exception(e)
+  Raven.capture_exception(e, extra: {
+    'service' => payload[:service],
+    'action'  => payload[:action],
+  })
 end
 
 Raven.configure do |config|

data/grpcx.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'grpcx'
-  s.version       = '0.1.1'
+  s.version       = '0.2.0'
   s.authors       = ['Black Square Media Ltd']
   s.email         = ['info@blacksquaremedia.com']
   s.summary       = %(gRPC extensions/helpers)

data/lib/grpcx.rb

@@ -1 +1,2 @@
 require 'grpcx/server'
+require 'grpcx/entity'

data/lib/grpcx/entity.rb

@@ -0,0 +1,58 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require 'set'
+
+module Grpcx
+  # Entity releated helpers
+  module Entity
+    def self._convert(field, value, &block)
+      field.label == :repeated ? value.map(&block) : yield(value) if value # rubocop:disable Style/IfUnlessModifierOfIfUnless
+    end
+
+    module_function
+
+    TRUE_VALUES = [true, 1, "1", "t", "T", "true", "TRUE", "on", "ON"].to_set.freeze
+
+    # @param [Class] msgclass messagepack message class
+    # @param [Hash] attrs attributes to assign
+    def build(msgclass, attrs={}) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+      attrs  = ActiveSupport::HashWithIndifferentAccess.new(attrs)
+      fields = {}
+      msgclass.descriptor.each do |field| # rubocop:disable Metrics/BlockLength
+        next unless attrs.key?(field.name)
+
+        source = attrs[field.name]
+        target = nil
+
+        case field.type
+        when :int64, :int32
+          target = Entity._convert(field, source, &:to_i)
+        when :float, :double
+          target = Entity._convert(field, source, &:to_f)
+        when :string
+          target = Entity._convert(field, source, &:to_s)
+        when :bool
+          target = Entity._convert(field, source) do |vv|
+            TRUE_VALUES.include?(vv)
+          end
+        when :enum
+          target = Entity._convert(field, source) do |vv|
+            case vv
+            when Integer
+              vv
+            when String, Symbol
+              field.subtype.lookup_name(vv.to_s.upcase.to_sym)
+            end
+          end
+        when :message
+          target = Entity._convert(field, source) do |vv|
+            build(field.subtype.msgclass, vv)
+          end
+        end
+
+        fields[field.name] = target if target
+      end
+
+      msgclass.new(fields)
+    end
+  end
+end

data/lib/grpcx/server/interceptors/instrumentation.rb

@@ -7,25 +7,27 @@ module Grpcx
         METRIC_NAME = 'process_action.grpc'.freeze
 
         def request_response(opts={}, &block)
-          instrument(action: opts[:method], &block)
+          instrument(opts[:method], &block)
         end
 
         def client_streamer(opts={}, &block)
-          instrument(action: opts[:method], &block)
+          instrument(opts[:method], &block)
         end
 
         def server_streamer(opts={}, &block)
-          instrument(action: opts[:method], &block)
+          instrument(opts[:method], &block)
         end
 
         def bidi_streamer(opts={}, &block)
-          instrument(action: opts[:method], &block)
+          instrument(opts[:method], &block)
         end
 
         private
 
-        def instrument(opts={}, &block)
-          ActiveSupport::Notifications.instrument(METRIC_NAME, opts, &block)
+        def instrument(method, &block)
+          service = method.owner.service_name # method is just a standard ruby Method class, so `owner` is a service impl
+          action = method.name # does not match real proto service name; it's a GRPC::GenericService.underscore-d version
+          ActiveSupport::Notifications.instrument(METRIC_NAME, service: service, action: action, &block)
         end
 
       end

data/spec/lib/entity_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+RSpec.describe Grpcx::Entity do
+
+  it 'should build messages' do
+    msg = described_class.build Grpcx::Spec::Message,
+      name: 'Name',
+      version: 1,
+      types: {
+        num: 8,
+        truth: [1, 0, true, 'true'],
+        decimal: '1.2',
+      }
+
+    expect(msg.to_h).to eq(
+      name: "Name",
+      version: :V1,
+      types: {
+        num: 8,
+        truth: [true, false, true, true],
+        decimal: 1.2,
+      },
+    )
+  end
+
+end

data/spec/spec_helper.rb

@@ -6,8 +6,15 @@ require 'google/protobuf'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "grpcx.spec.Message" do
     optional :name, :string, 1
+    optional :version, :enum, 2, "grpcx.spec.Version"
+    optional :types, :message, 3, "grpcx.spec.Types"
   end
-  add_enum "grpcx.spec.Enum" do
+  add_message "grpcx.spec.Types" do
+    optional :num, :int64, 1
+    repeated :truth, :bool, 2
+    optional :decimal, :double, 3
+  end
+  add_enum "grpcx.spec.Version" do
     value :V0, 0
     value :V1, 1
     value :V2, 2
@@ -18,7 +25,8 @@ end
 
 module Grpcx::Spec
   Message = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpcx.spec.Message").msgclass
-  Enum = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpcx.spec.Enum").enummodule
+  Version = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpcx.spec.Version").enummodule
+  Types = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpcx.spec.Types").msgclass
   GetMessageRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpcx.spec.GetMessageRequest").msgclass
 
   module Service

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpcx
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Black Square Media Ltd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -124,11 +124,13 @@ files:
 - Rakefile
 - grpcx.gemspec
 - lib/grpcx.rb
+- lib/grpcx/entity.rb
 - lib/grpcx/server.rb
 - lib/grpcx/server/interceptors.rb
 - lib/grpcx/server/interceptors/active_record.rb
 - lib/grpcx/server/interceptors/instrumentation.rb
 - lib/grpcx/server/interceptors/rescue.rb
+- spec/lib/entity_spec.rb
 - spec/lib/server_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bsm/grpcx
@@ -151,10 +153,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: gRPC extensions/helpers
 test_files:
+- spec/lib/entity_spec.rb
 - spec/lib/server_spec.rb
 - spec/spec_helper.rb