grpcx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce77106489146dc1a2c5dbaf39411f2061d86355b857de1100cc952a8d1b9522
+  data.tar.gz: 30cdaa7d8aaa269106010a61e91a4c2916c928218fa47624ee6c06a0f4bccd48
+SHA512:
+  metadata.gz: 10727d31b94270648bab756d5da572ffcf244f17bf4540ee4830d110635bf26e7c0900de0d11002a5bd840a3796fbda18a417bd5f38353f44fdcdac7b39af03a
+  data.tar.gz: 1378bb8ecf7d4528e0400bb109fc80e1e98baa0567a131c510ed40b1f3dd37752337d21ad41f7982cf23fb3a7eb9d71fea3c18fd12de5ac5eb4e3d05c9b4a3f6

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1 @@
+.rubocop-*

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_from:
+  - https://storage.googleapis.com/bsm-misc/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics/AbcSize:
+  Enabled: false
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    grpcx (0.1.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)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      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.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)
+      google-protobuf (~> 3.1)
+      googleapis-common-protos-types (~> 1.0.0)
+      googleauth (>= 0.5.1, < 0.7)
+    i18n (1.0.1)
+      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)
+    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)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    public_suffix (3.0.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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      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)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bundler
+  grpcx!
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,103 @@
+# grpcx
+
+Ruby gRPC extensions/helpers
+
+
+# Grpcx::Server
+
+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)
+- includes `ActiveSupport::Rescuable` and transforms most common `ActiveRecord::ActiveRecordError`-s into `GRPC::BadStatus` ones
+
+
+Example:
+
+```ruby
+require 'grpcx/server' # or just 'grpcx'
+
+class MyServer < GRPC::RpcServer
+  include Grpcx::Server
+
+  # optional custom error handling:
+  rescue_from 'MyError' do |e|
+    raise Grpc::BadStatus.new(e.to_s, my_extra: e.my_extra)
+  end
+end
+
+# proceed as with usual GRPC::RpcServer:
+server = MyServer.new(...)
+server.handle(MyService.new)
+server.add_http2_port '127.0.0.1:8080', :this_port_is_insecure
+server.run_till_terminated
+```
+
+Recommended to be used with [Grpclb::Server](https://github.com/bsm/grpclb/tree/master/ruby):
+
+```ruby
+require 'grpclb/server'
+require 'grpcx/server'
+
+class MyServer < Grpclb::Server
+  include Grpcx::Server
+end
+
+...
+```
+
+
+## Using with [Datadog::Notifications](https://github.com/bsm/datadog-notifications)
+
+```ruby
+module Datadog::Notifications::Plugins
+  class GRPC < Base
+
+    def initialize(opts={})
+      super
+      Datadog::Notifications.subscribe 'process_action.grpc' do |reporter, event|
+        record(reporter, event)
+      end
+    end
+
+    private
+
+    def record(reporter, event)
+      action = event.payload[:action]
+      status = event.payload[:exception] ? 'error' : 'ok'
+      tags = self.tags + ["rpc:#{action}", "status:#{status}"]
+
+      reporter.batch do
+        reporter.increment 'grpc.request', tags: tags
+        reporter.timing 'grpc.request.time', event.duration, tags: tags
+      end
+    end
+
+  end
+end
+
+Datadog::Notifications.configure do |c|
+  c.use Datadog::Notifications::Plugins::GRPC
+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|
+  e = payload[:exception_object]
+  next unless e
+
+  Raven.capture_exception(e)
+end
+
+Raven.configure do |config|
+  config.should_capture = proc {|e|
+    !e.is_a?(GRPC::BadStatus) # skip GRPC::BadStatus, but report everything else
+  }
+end
+```
+
+Similar approach can be used for logging.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/grpcx.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name          = 'grpcx'
+  s.version       = '0.1.0'
+  s.authors       = ['Black Square Media Ltd']
+  s.email         = ['info@blacksquaremedia.com']
+  s.summary       = %(gRPC extensions/helpers)
+  s.description   = %()
+  s.homepage      = 'https://bitbucket.org/bsm/grpcx'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^spec/}) }
+  s.test_files    = `git ls-files -z -- spec/*`.split("\x0")
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.2'
+
+  s.add_dependency 'activesupport', '>= 5.0'
+  s.add_dependency 'grpc', '>= 1.8.0'
+
+  s.add_development_dependency 'activerecord'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
+end

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

@@ -0,0 +1,37 @@
+module Grpcx
+  module Server
+    module Interceptors
+      # Manages ActiveRecord::Base connection,
+      # making sure that connection is established before each request
+      # and re-pooling connections when request is processed.
+      class ActiveRecord < GRPC::ServerInterceptor
+
+        def request_response(*, &block)
+          wrap(&block)
+        end
+
+        def client_streamer(*, &block)
+          wrap(&block)
+        end
+
+        def server_streamer(*, &block)
+          wrap(&block)
+        end
+
+        def bidi_streamer(*, &block)
+          wrap(&block)
+        end
+
+        private
+
+        def wrap
+          ::ActiveRecord::Base.establish_connection unless ::ActiveRecord::Base.connection.active?
+          yield
+        ensure
+          ::ActiveRecord::Base.clear_active_connections!
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'active_support/notifications'
+
+module Grpcx
+  module Server
+    module Interceptors
+      class Instrumentation < GRPC::ServerInterceptor
+        METRIC_NAME = 'process_action.grpc'.freeze
+
+        def request_response(method: nil, &block)
+          instrument(action: method, &block)
+        end
+
+        def client_streamer(method: nil, &block)
+          instrument(action: method, &block)
+        end
+
+        def server_streamer(method: nil, &block)
+          instrument(action: method, &block)
+        end
+
+        def bidi_streamer(method: nil, &block)
+          instrument(action: method, &block)
+        end
+
+        private
+
+        def instrument(opts={}, &block)
+          ActiveSupport::Notifications.instrument(METRIC_NAME, opts, &block)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Grpcx
+  module Server
+    module Interceptors
+      class Rescue < GRPC::ServerInterceptor
+        def initialize(rescuable, opts={})
+          @rescuable = rescuable
+          super(opts)
+        end
+
+        def request_response(*)
+          yield
+        rescue StandardError => err
+          @rescuable.rescue_with_handler(err) || raise
+        end
+
+        def client_streamer(*)
+          yield
+        rescue StandardError => err
+          @rescuable.rescue_with_handler(err) || raise
+        end
+
+        def server_streamer(*)
+          yield
+        rescue StandardError => err
+          @rescuable.rescue_with_handler(err) || raise
+        end
+
+        def bidi_streamer(*)
+          yield
+        rescue StandardError => err
+          @rescuable.rescue_with_handler(err) || raise
+        end
+
+      end
+    end
+  end
+end

data/lib/grpcx/server/interceptors.rb

@@ -0,0 +1,3 @@
+require 'grpcx/server/interceptors/rescue'
+require 'grpcx/server/interceptors/instrumentation'
+require 'grpcx/server/interceptors/active_record'

data/lib/grpcx/server.rb

@@ -0,0 +1,56 @@
+require 'grpc'
+require 'grpc/health/checker'
+require 'active_support/concern'
+require 'active_support/rescuable'
+require 'grpcx/server/interceptors'
+
+module Grpcx
+  module Server
+    extend ActiveSupport::Concern
+    include ActiveSupport::Rescuable
+
+    ServingStatus = ::Grpc::Health::Checker::HealthCheckResponse::ServingStatus
+
+    included do
+      attr_reader :interceptors
+
+      rescue_from 'ActiveRecord::RecordInvalid' do |e|
+        raise GRPC::InvalidArgument.new('record invalid', errors: e.record.errors.to_h)
+      end
+      rescue_from 'ActiveRecord::RecordNotFound' do |e|
+        raise GRPC::NotFound.new('record not found', id: e.id, model: e.model.to_s)
+      end
+    end
+
+    def initialize(opts={})
+      opts[:pool_size] ||= ENV['GRPC_SERVER_THREADS'].to_i if ENV['GRPC_SERVER_THREADS']
+      opts[:max_waiting_requests] ||= ENV['GRPC_SERVER_QUEUE'].to_i if ENV['GRPC_SERVER_QUEUE']
+
+      # interceptors are fired in FIFO order.
+      opts[:interceptors] ||= []
+      opts[:interceptors].prepend Grpcx::Server::Interceptors::Rescue.new(self)
+      opts[:interceptors].prepend Grpcx::Server::Interceptors::Instrumentation.new
+      opts[:interceptors].prepend Grpcx::Server::Interceptors::ActiveRecord.new if defined?(::ActiveRecord)
+
+      super(opts).tap do
+        handle(health)
+      end
+    end
+
+    def handle(service)
+      service_name = nil
+      if service.is_a?(Class) && service < GRPC::GenericService
+        service_name = service.service_name
+      elsif service.is_a?(GRPC::GenericService)
+        service_name = service.class.service_name
+      end
+
+      health.add_status(service_name, ServingStatus::SERVING) if service_name
+      super
+    end
+
+    def health
+      @health ||= ::Grpc::Health::Checker.new
+    end
+  end
+end

data/lib/grpcx.rb

@@ -0,0 +1 @@
+require 'grpcx/server'

data/spec/lib/server_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+RSpec.describe Grpcx::Server do
+
+  subject do
+    s = Grpcx::Spec::Server.new
+    s.handle Grpcx::Spec::Service::V1
+    s
+  end
+
+  it 'should have a health-check' do
+    expect(subject.health).to be_a(Grpc::Health::Checker)
+    expect(subject.health.instance_variable_get(:@statuses)).to eq(
+      'grpcx.spec.service.V1' => 1,
+      'grpc.health.v1.Health' => 1,
+    )
+  end
+
+  it 'should have interceptors' do
+    expect(subject.interceptors).to be_a(GRPC::InterceptorRegistry)
+
+    registered = subject.interceptors.instance_variable_get(:@interceptors)
+    expect(registered.size).to eq(3)
+  end
+
+  it 'should have rescue handlers' do
+    expect(subject.rescue_handlers.size).to eq(3)
+    expect(subject.rescue_handlers.map(&:first)).to match_array %w[
+      ActiveRecord::RecordInvalid
+      ActiveRecord::RecordNotFound
+      ArgumentError
+    ]
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require 'rspec'
+require 'grpcx'
+require 'active_record'
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "grpcx.spec.Message" do
+    optional :name, :string, 1
+  end
+  add_enum "grpcx.spec.Enum" do
+    value :V0, 0
+    value :V1, 1
+    value :V2, 2
+  end
+  add_message "grpcx.spec.GetMessageRequest" do
+  end
+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
+  GetMessageRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpcx.spec.GetMessageRequest").msgclass
+
+  module Service
+    class V1
+      include GRPC::GenericService
+
+      self.marshal_class_method = :encode
+      self.unmarshal_class_method = :decode
+      self.service_name = 'grpcx.spec.service.V1'
+
+      rpc :GetMessage, GetMessageRequest, Message
+    end
+
+    Stub = V1.rpc_stub_class
+  end
+
+  class Server < GRPC::RpcServer
+    include Grpcx::Server
+
+    rescue_from 'ArgumentError' do |e|
+      raise GRPC::InvalidArgument.new(errors: e.to_s)
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: grpcx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Black Square Media Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- info@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- grpcx.gemspec
+- lib/grpcx.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/server_spec.rb
+- spec/spec_helper.rb
+homepage: https://bitbucket.org/bsm/grpcx
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: gRPC extensions/helpers
+test_files:
+- spec/lib/server_spec.rb
+- spec/spec_helper.rb