jcw 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7621b3db92b4172f29ae46a914d6f5a33611f276dfaa17d1effeff36f16c68b
-  data.tar.gz: c9ac2ea12ee2862fcb762673dd5285e7422b86fe91c38a39f9fa66bd890fa83c
+  metadata.gz: b501043d4201dca7900d5c39c79aa5ca89996188a68c02774011ea6b10baf73f
+  data.tar.gz: 52bfd8000dd934155eddf3722ac6881f06988d7a84f660f71a66226a3218d529
 SHA512:
-  metadata.gz: e6558c6b64a50a283c6e9a97024ee8191fd595bb73b071ae84259ec7a61d51ab4046b6f70e33f335bedf7888f791f170375e2b7f3ab428a373259716c9acfe19
-  data.tar.gz: c5d6da1d532632920fdce571c254737654d0e37c7aca2d89bf8852126ae15882c3f4965461b341ecfcbf04add3a366010b103d5cd83cf2fe1df8b9c71860e15d
+  metadata.gz: f0641456763034ef58aa571f7f017892939512a7b8abfbefe7a73859cdfeb33ddab66a4037e069abf17e9c7563339a6ec876b3a479f75cecbb6477ffd1aabb25
+  data.tar.gz: 7837034ab4915c1363339a58ee4e275fea2b8a3db0b61d1cf7eb209a513670b23ee55fbe417adb412fa0f6090fcb041c97c295a4eeee0eb5e416d4dfe9de022f

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    jcw (0.1.3)
+    jcw (0.2.0)
       activesupport (>= 5.0)
+      gruf (~> 2.10)
       httprb-opentracing (~> 0.4.0)
       jaeger-client (~> 1.1.0)
       rack-tracer (~> 0.9.0)
@@ -43,11 +44,36 @@ GEM
     docile (1.4.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    e2mmap (0.1.0)
     erubi (1.10.0)
     ffi (1.15.3)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
+    google-protobuf (3.18.1)
+    google-protobuf (3.18.1-universal-darwin)
+    google-protobuf (3.18.1-x86_64-linux)
+    googleapis-common-protos-types (1.2.0)
+      google-protobuf (~> 3.14)
+    grpc (1.41.0)
+      google-protobuf (~> 3.17)
+      googleapis-common-protos-types (~> 1.0)
+    grpc (1.41.0-universal-darwin)
+      google-protobuf (~> 3.17)
+      googleapis-common-protos-types (~> 1.0)
+    grpc (1.41.0-x86_64-linux)
+      google-protobuf (~> 3.17)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-tools (1.41.0)
+    gruf (2.10.0)
+      activesupport (> 4)
+      concurrent-ruby (> 1)
+      e2mmap (~> 0.1)
+      grpc (~> 1.10)
+      grpc-tools (~> 1.10)
+      json (>= 2.3)
+      slop (~> 4.6)
+      thwait (~> 0.1)
     http (5.0.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
@@ -65,6 +91,7 @@ GEM
     jaeger-client (1.1.0)
       opentracing (~> 0.3)
       thrift
+    json (2.5.1)
     llhttp-ffi (0.3.1)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
@@ -163,8 +190,11 @@ GEM
     simplecov-html (0.12.3)
     simplecov-lcov (0.8.0)
     simplecov_json_formatter (0.1.3)
+    slop (4.9.1)
     thor (1.1.0)
     thrift (0.15.0)
+    thwait (0.2.0)
+      e2mmap
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)

data/README.md

@@ -80,6 +80,43 @@ end
 ```
 - `config.subscribe_to` - not recommended for UDP sender, because default max packet size is 65,000 bytes.
 
+#### GRPC Integration
+
+Client side
+
+```ruby
+# Add JCW::Interceptors::Gruf::Client Interceptor to Gruf Client Initializer
+options = {}
+client_options = { timeout: 10, interceptors: [JCW::Interceptors::Gruf::Client.new] }
+
+client = Gruf::Client.new(
+  service: Test::Service, options: options, client_options: client_options
+)
+
+request_method = "some_method"
+client.call(request_method)
+```
+
+Server side
+
+```ruby
+# Add Server Interceptor
+Rails.configuration.to_prepare do
+  Gruf.configure do |config|
+    config.interceptors.use(JCW::Interceptors::Gruf::Server)
+  end
+end  
+
+# Configure
+::JCW::Wrapper.configure do |config|
+  config.service_name = "Service Name"
+  config.connection = { protocol: :udp, host: "127.0.0.1", port: 6831 }
+  config.enabled = true
+  config.subscribe_to = [/.*/]
+  config.grpc_ignore_methods = %w[grpc.ignore.method]
+end
+```
+
 ### Contributing
 
  - Fork it ( https://github.com/Cado-Labs/jcw )
@@ -95,7 +132,7 @@ Released under MIT License.
 ## Supporting
 
 <a href="https://github.com/Cado-Labs">
-  <img src="https://github.com/Cado-Labs/cado-labs-logos/blob/main/cado_labs_logo.png" alt="Supported by Cado Labs" />
+  <img src="https://github.com/Cado-Labs/cado-labs-logos/raw/main/cado_labs_logo.png" alt="Supported by Cado Labs">
 </a>
 
 ## Authors

data/jcw.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "gruf", "~> 2.10"
   spec.add_dependency "httprb-opentracing", "~> 0.4.0"
   spec.add_dependency "jaeger-client", "~> 1.1.0"
   spec.add_dependency "rack-tracer", "~> 0.9.0"

data/lib/jcw/config.rb

@@ -7,7 +7,8 @@ module JCW
                 :subscribe_to,
                 :connection,
                 :flush_interval,
-                :tags
+                :tags,
+                :grpc_ignore_methods
 
     def enabled
       @enabled ||= false
@@ -34,5 +35,9 @@ module JCW
     def tags
       @tags ||= {}
     end
+
+    def grpc_ignore_methods
+      @grpc_ignore_methods ||= []
+    end
   end
 end

data/lib/jcw/interceptors/gruf/client.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "gruf"
+
+module JCW
+  module Interceptors
+    module Gruf
+      class Client < ::Gruf::Interceptors::ClientInterceptor
+        def call(request_context:)
+          tracer = OpenTracing.global_tracer
+          metadata = request_context.metadata
+
+          tags = {
+            "component" => "gRPC",
+            "span.kind" => "client",
+            "grpc.method_type" => "request_response",
+            "grpc.headers" => metadata,
+          }
+
+          tracer.start_active_span(request_context.method.to_s, tags: tags) do |current_scope|
+            current_span = current_scope.span
+            current_span.log_kv(
+              event: "request",
+              data: request_context.requests.map { |request| request.try(:to_h) },
+            )
+            hpack_carrier = Hpack.new(metadata)
+            tracer.inject(current_span.context, ::OpenTracing::FORMAT_TEXT_MAP, hpack_carrier)
+
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jcw/interceptors/gruf/hpack.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module JCW
+  module Interceptors
+    module Gruf
+      class Hpack
+        def initialize(wrapped)
+          @wrapped = wrapped
+        end
+
+        def [](key)
+          @wrapped[key.downcase]
+        end
+
+        def []=(key, value)
+          return unless value
+
+          @wrapped[key.downcase] = value
+        end
+
+        def each(&block)
+          @wrapped.each(&block)
+        end
+      end
+    end
+  end
+end

data/lib/jcw/interceptors/gruf/server.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "gruf"
+
+module JCW
+  module Interceptors
+    module Gruf
+      class Server < ::Gruf::Interceptors::ServerInterceptor
+        # rubocop:disable Metrics/MethodLength
+        def call
+          method = request.method_name
+          return yield if Wrapper.config.grpc_ignore_methods.include?(method)
+
+          tracer = OpenTracing.global_tracer
+          on_finish_span = options[:on_finish_span]
+          service_class = request.service
+          method_name = request.method_key
+          name = method_name.to_s.camelize
+          route = "/#{service_class.service_name}/#{name}"
+
+          begin
+            tags = {
+              "component" => "gRPC",
+              "span.kind" => "server",
+              "grpc.method_type" => "request_response",
+            }
+            hpack_carrier = Hpack.new(request.active_call.metadata)
+            parent_span_context = tracer.extract(::OpenTracing::FORMAT_TEXT_MAP, hpack_carrier)
+            current_scope = tracer.start_active_span(
+              route,
+              child_of: parent_span_context,
+              tags: tags,
+            )
+            current_span = current_scope.span
+            current_span.log_kv(event: "request", data: request.message.to_h)
+
+            response = yield
+
+            if response.try(:error_fields)
+              current_span.set_tag("error", true)
+              current_span.log_kv(event: "error", data: response.to_h)
+            end
+          rescue => e
+            if current_span
+              current_span.set_tag("error", true)
+              current_span.log_kv(event: "error", error_object: e)
+            end
+            raise
+          ensure
+            on_finish_span&.call(current_span)
+            current_scope.close if current_span
+          end
+
+          response
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

data/lib/jcw/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JCW
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/jcw/wrapper.rb

@@ -21,5 +21,8 @@ require_relative "init"
 require_relative "subscriber"
 require_relative "http_tracer"
 require_relative "rack_tracer"
+require_relative "interceptors/gruf/client"
+require_relative "interceptors/gruf/server"
+require_relative "interceptors/gruf/hpack"
 require_relative "logger"
 require_relative "logger_extension"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jcw
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander Starovojtov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: gruf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: httprb-opentracing
   requirement: !ruby/object:Gem::Requirement
@@ -244,6 +258,9 @@ files:
 - lib/jcw/config.rb
 - lib/jcw/http_tracer.rb
 - lib/jcw/init.rb
+- lib/jcw/interceptors/gruf/client.rb
+- lib/jcw/interceptors/gruf/hpack.rb
+- lib/jcw/interceptors/gruf/server.rb
 - lib/jcw/logger.rb
 - lib/jcw/logger_extension.rb
 - lib/jcw/rack_tracer.rb