grpc-rest 0.1.20 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b19a325cd920ec6632682c8f91b54e06a09444cece910dbc176e898f8e504cb
-  data.tar.gz: 3fa53b62032088e7e57cae354326188cb93c22312d7dc463111b4d5a6992b68c
+  metadata.gz: 47964383a0aa5a5835edd72fae78e2febe1364fdd13f598a588dc3702f5f882b
+  data.tar.gz: 14255db74de1d544d8964f3bb3b2e5515f6a25d50ab54bd0e00e6eb550ec9309
 SHA512:
-  metadata.gz: 235e5ea946e9e6b10be20485775d0f55f46b0ab1ecb7612f75e98c75be7ff0ca75b438e1649d3abc298196501615425675968cf0605f8968e3771cd8cde897e6
-  data.tar.gz: 10d3caaa87389dca93982af06ce8143e615d0b6b2133f9485c4d51ec6e18b043faaa836960fcc141954e0fac07b644eba50b256062a22f5fed8c5b5a4f04da4a
+  metadata.gz: 8d85e2f3169ec0dedff6f49e193ac1208caeee918c54b99ab3ee18f05973defad99edb8587fab5fe89cdbfb89d44278eda50f329e00e1bb304722ef10ef7c693
+  data.tar.gz: 7ab65c78dc7aadac67a325705d28a3b79873ce24562fa02f1e4f71500536612d49c58806259ed8340b65bd53b3f2f64bf9946b597751d4ff67ae29b086856d63

data/CHANGELOG

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 0.1.22 - 2024-10-31
+- Fix: calling `fail!` in gruf Interceptors was failing with an unrelated exception.
+
+# 0.1.21 - 2024-09-12
+- Feature: Support gruf Interceptors.
+
 # 0.1.20 - 2024-09-10
 - Fix: Repeated float values weren't being treated as arrays and were crashing.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grpc-rest (0.1.19)
+    grpc-rest (0.1.21)
       grpc
       rails (>= 6.0)
 
@@ -91,8 +91,18 @@ GEM
     grpc (1.62.0-x86_64-linux)
       google-protobuf (~> 3.25)
       googleapis-common-protos-types (~> 1.0)
+    grpc-tools (1.64.0)
+    gruf (2.20.0)
+      activesupport (> 4)
+      concurrent-ruby (> 1)
+      grpc (~> 1.10)
+      grpc-tools (~> 1.10)
+      json (>= 2.3)
+      slop (>= 4.6)
+      zeitwerk (>= 2)
     i18n (1.14.4)
       concurrent-ruby (~> 1.0)
+    json (2.7.2)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -169,6 +179,7 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.1)
+    slop (4.10.1)
     thor (1.3.1)
     timeout (0.4.1)
     tzinfo (2.0.6)
@@ -184,6 +195,7 @@ PLATFORMS
 
 DEPENDENCIES
   grpc-rest!
+  gruf
   rspec-rails
 
 BUNDLED WITH

data/README.md

@@ -152,6 +152,25 @@ service MyService {
 }
 ```
 
+## Gruf Interceptors
+
+grpc-rest supports [gruf](https://github.com/bigcommerce/gruf) Interceptors through a custom `GrpcRest::BaseInterceptor` class. As long as you're not using a custom interceptor
+registry, your interceptors will be called normally around the controller.
+
+```ruby
+require 'grpc_rest/base_interceptor'
+
+module Interceptors
+  # Interceptor for catching errors from controllers
+  class ErrorInterceptor < GrpcRest::BaseInterceptor
+    
+    def call
+      # Your code here
+    end
+    
+  end
+end
+```
 
 ## To Do
 

data/grpc-rest.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency('rails', '>= 6.0')
 
   spec.add_development_dependency('rspec-rails')
+  spec.add_development_dependency('gruf')
 end

data/lib/base_interceptor.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'gruf'
+
+module GrpcRest
+  # Fixes an issue with the fail! method since the active call is not instantiated yet.
+  # Overloads https://github.com/bigcommerce/gruf/blob/main/lib/gruf/errors/helpers.rb#L34
+  class BaseInterceptor < ::Gruf::Interceptors::ServerInterceptor
+    def fail!(error_code, _app_code, message = 'unknown error', metadata = {})
+      raise grpc_error(error_code, message.to_s, metadata)
+    end
+
+    private
+
+    # Ported from https://github.com/flipp-oss/grpc-rest/blob/main/lib/grpc_rest.rb#L142
+    def grpc_error(error_code, message, metadata)
+      case error_code
+      when :ok
+        GRPC::Ok.new(message, metadata)
+      when 499
+        GRPC::Cancelled.new(message, metadata)
+      when :bad_request, :invalid_argument
+        GRPC::InvalidArgument.new(message, metadata)
+      when :gateway_timeout
+        GRPC::DeadlineExceeded.new(message, metadata)
+      when :not_found
+        GRPC::NotFound.new(message, metadata)
+      when :conflict
+        GRPC::AlreadyExists.new(message, metadata)
+      when :forbidden
+        GRPC::PermissionDenied.new(message, metadata)
+      when :unauthorized
+        GRPC::Unauthenticated.new(message, metadata)
+      when :too_many_requests
+        GRPC::ResourceExhausted.new(message, metadata)
+      when :not_implemented
+        GRPC::Unimplemented.new(message, metadata)
+      when :service_unavailable
+        GRPC::Unavailable.new(message, metadata)
+      else
+        GRPC::Internal.new(message, metadata)
+      end
+    end
+  end
+end

data/lib/grpc_rest/version.rb

@@ -1,3 +1,3 @@
 module GrpcRest
-  VERSION = '0.1.20'
+  VERSION = '0.1.22'
 end

data/lib/grpc_rest.rb

@@ -203,7 +203,18 @@ module GrpcRest
         active_call: nil,
         message: request
       )
-      handler.send(method.to_sym)
+      Gruf::Interceptors::Context.new(gruf_interceptors(request)).intercept! do
+        handler.send(method.to_sym)
+      end
+    end
+
+    # @param request [Google::Protobuf::AbstractMessage]
+    # @return [Array<Gruf::Interceptors::Base>]
+    def gruf_interceptors(request)
+      error = Gruf::Error.new
+      interceptors = Gruf.interceptors.prepare(request, error)
+      interceptors.delete_if { |k| k.class.name.split('::').first == 'Gruf' }
+      interceptors
     end
 
     def send_grpc_request(service, method, request)

data/spec/base_interceptor_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative './spec_helper'
+require 'src/proto/grpc/testing/test_services_pb'
+
+RSpec.describe GrpcRest::BaseInterceptor, type: :class do
+  let(:rpc_service) { Grpc::Testing::TestService::Service.new }
+  let(:rpc_desc) { Grpc::Testing::TestService::Service.rpc_descs.values.first}
+  let(:message) { Grpc::Testing::SimpleRequest.new }
+
+  describe '#fail!' do
+    let(:error_message) { 'some message' }
+    let(:error_code) { :invalid_argument }
+
+    it 'intercepts and raises the error' do
+      request = Gruf::Controllers::Request.new(
+        method_key: :UnaryCall,
+        service: rpc_service,
+        rpc_desc: rpc_desc,
+        active_call: nil,
+        message: message)
+      interceptor = GrpcRest::BaseInterceptor.new(request, Gruf::Error.new)
+
+      expect{ interceptor.fail!(error_code, error_code, error_message) }.to raise_error(GRPC::InvalidArgument) do |error|
+        expect(error.message).to match(error_message)
+        expect(error.code).to eq(GRPC::Core::StatusCodes::INVALID_ARGUMENT)
+      end
+    end
+  end
+end

data/spec/gruf_spec.rb

@@ -0,0 +1,51 @@
+require_relative './spec_helper'
+require_relative './test_service_services_pb'
+require 'gruf'
+
+class GrufServerImpl < Gruf::Controllers::Base
+
+  bind ::Testdata::MyService::Service
+
+  def test
+    Testdata::TestResponse.new(some_int: 1, full_response: request.message.to_json)
+  end
+
+  def test_2
+    Testdata::TestResponse.new(some_int: 2, full_response: request.message.to_json)
+  end
+
+  def test_3
+    Testdata::TestResponse.new(some_int: 3, full_response: request.message.to_json)
+  end
+
+  def test_4
+    Testdata::TestResponse.new(some_int: 4, full_response: request.message.to_json)
+  end
+
+  cattr_accessor :intercepted
+end
+
+class TestInterceptor < ::Gruf::Interceptors::ServerInterceptor
+  def call
+    GrufServerImpl.intercepted = true
+    yield
+  end
+end
+
+Gruf::Server.new.add_interceptor(TestInterceptor, option_foo: 'value 123')
+
+RSpec.describe MyServiceController, type: :request do
+  describe 'using get' do
+    it 'should be successful and call interceptors' do
+      GrufServerImpl.intercepted = false
+      get "/test/blah/xyz?test_id=abc"
+      expect(response).to be_successful
+      expect(response.parsed_body).to eq({
+                                           'someInt' => 1,
+                                           'fullResponse' => %({"testId":"abc","foobar":"xyz"}),
+                                           "ignoredKey" => ''
+                                         })
+      expect(GrufServerImpl.intercepted).to eq(true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -17,6 +17,7 @@ loader.inflector.inflect('protoc-gen-openapiv2' => 'ProtocGenOpenapiv2')
 loader.ignore("#{Rails.root}/spec/test_service_pb.rb")
 loader.setup
 require "#{Rails.root}/spec/test_service_pb.rb"
+require "#{Rails.root}/lib/base_interceptor.rb"
 
 $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grpc-rest
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.22
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gruf
+  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:
 - daniel.orner@flipp.com
@@ -67,6 +81,7 @@ files:
 - Gemfile.lock
 - README.md
 - grpc-rest.gemspec
+- lib/base_interceptor.rb
 - lib/grpc_rest.rb
 - lib/grpc_rest/version.rb
 - protoc-gen-rails/.goreleaser.yml
@@ -87,7 +102,9 @@ files:
 - protoc-gen-rails/testdata/no_service/.keep
 - protoc-gen-rails/testdata/test.proto
 - protoc-gen-rails/testdata/test_service.proto
+- spec/base_interceptor_spec.rb
 - spec/grpc_rest_spec.rb
+- spec/gruf_spec.rb
 - spec/protoc-gen-openapiv2/options/annotations_pb.rb
 - spec/protoc-gen-openapiv2/options/openapiv2_pb.rb
 - spec/spec_helper.rb
@@ -117,7 +134,9 @@ signing_key:
 specification_version: 4
 summary: Generate Rails controllers and routes from gRPC definitions.
 test_files:
+- spec/base_interceptor_spec.rb
 - spec/grpc_rest_spec.rb
+- spec/gruf_spec.rb
 - spec/protoc-gen-openapiv2/options/annotations_pb.rb
 - spec/protoc-gen-openapiv2/options/openapiv2_pb.rb
 - spec/spec_helper.rb