grpc-rest 0.1.21 → 0.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '090bea208182dd067a0a1f0347e9cb4484610dca9a7a4f1c2f7689fa216d40e8'
-  data.tar.gz: 3695746b75dcbba972e88249ad2785551d7e0e4fbd9d8a01140496dfa4f2a002
+  metadata.gz: b4e105820176e2fb387f9ff63ae82a086de8d1b291d372f8e8ba3d38dfc34859
+  data.tar.gz: 1e480bc608d0524821ba06d408681830294ab34c9e36bd330b881f48128f8e33
 SHA512:
-  metadata.gz: 963b26c2d6141a20a3739341bd564005000a7dfdbe42a0bee3becffd04bc1f7d455a692135f21037399e12431c0bba91e73c17b4aa0d4bef6c75944fef4d2782
-  data.tar.gz: eaad993e480c9a9e7d05c55dedd4a7de06712666b3cd5601b6566bcd5da955a5b30e7528562b117b35297862cc4a6ad3930c8aabcc5eb81bbba6417ab3babae5
+  metadata.gz: c8118e6cbb88e44bc3577e66c4639f3e5b87ff18515f1c27d9dd5d458caacac52030f39afbd4a108b2009115b7e28ce9c9c7a810419517f700894538febfe3de
+  data.tar.gz: e591ab5d4d0481048f4e61814d1552d83c782f91191fd4f3f1aa430bacfc257aaac2ff3225152767b5acb7e13f1dcc75c42cb86ae93919d6b3cfc483b7bea53d

data/CHANGELOG

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+# 0.1.24 - 2024-12-09
+- Log error backtraces. 
+
+# 0.1.23 - 2024-11-25
+- Fix: Return a 400 status code when payload is invalid JSON
+
+# 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.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grpc-rest (0.1.21)
+    grpc-rest (0.1.22)
       grpc
       rails (>= 6.0)
 

data/README.md

@@ -154,9 +154,24 @@ service MyService {
 
 ## Gruf Interceptors
 
-grpc-rest supports [gruf](https://github.com/bigcommerce/gruf) Interceptors. As long as you're not using a custom interceptor
+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
 
 * Replace Go implementation with Ruby (+ executable)

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.21'
+  VERSION = '0.1.24'
 end

data/protoc-gen-rails/internal/output.go

@@ -63,7 +63,7 @@ class {{.ControllerName}}Controller < ActionController::Base
   rescue_from GRPC::BadStatus do |e|
 		render json: GrpcRest.error_msg(e), status: GrpcRest.grpc_http_status(e.code)
   end
-  rescue_from Google::Protobuf::TypeError do |e|
+  rescue_from ActionDispatch::Http::Parameters::ParseError, Google::Protobuf::TypeError do |e|
     render json: GrpcRest.error_msg(e), status: :bad_request
   end
   METHOD_PARAM_MAP = {
@@ -102,20 +102,22 @@ func ProcessService(service *descriptorpb.ServiceDescriptorProto, pkg string) (F
 			return FileResult{}, routes, err
 		}
 		restOpts, err := ExtractRestOptions(m)
-		if err != nil { return FileResult{}, routes, err }
+		if err != nil {
+			return FileResult{}, routes, err
+		}
 		httpMethod, path, err := MethodAndPath(opts.Pattern)
 		pathInfo, err := ParsedPath(path)
 		if err != nil {
 			return FileResult{}, routes, err
 		}
 		controllerMethod := method{
-			Name:           strcase.ToSnake(m.GetName()),
-			RequestType:    Classify(m.GetInputType()),
-			Path:           path,
-			RestOptions:    rubyRestOptions(restOpts),
-			HttpMethod:     httpMethod,
-			Body:           opts.Body,
-			PathInfo:       pathInfo,
+			Name:        strcase.ToSnake(m.GetName()),
+			RequestType: Classify(m.GetInputType()),
+			Path:        path,
+			RestOptions: rubyRestOptions(restOpts),
+			HttpMethod:  httpMethod,
+			Body:        opts.Body,
+			PathInfo:    pathInfo,
 		}
 		data.Methods = append(data.Methods, controllerMethod)
 		routes = append(routes, Route{

data/protoc-gen-rails/testdata/base/app/controllers/my_service_controller.rb

@@ -11,9 +11,10 @@ class MyServiceController < ActionController::Base
   rescue_from GRPC::BadStatus do |e|
 		render json: GrpcRest.error_msg(e), status: GrpcRest.grpc_http_status(e.code)
   end
-  rescue_from Google::Protobuf::TypeError do |e|
+  rescue_from ActionDispatch::Http::Parameters::ParseError, Google::Protobuf::TypeError do |e|
     render json: GrpcRest.error_msg(e), status: :bad_request
   end
+
   METHOD_PARAM_MAP = {
 
     "test" => [

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/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.21
+  version: 0.1.24
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -81,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
@@ -101,6 +102,7 @@ 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
@@ -132,6 +134,7 @@ 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