rails_twirp 0.7.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '054689e120dd41594071de17cd6e8967886699ec4f75bd08aceae475a2e12e03'
-  data.tar.gz: 56b1471b8103f249c9c2d53fe78b2aa31a978c67f3a1b658e15923534a4a3b63
+  metadata.gz: 2e2d7bf09840bf1a4d5aef432df4a47d50e653fe618781324d535c382b222cd9
+  data.tar.gz: 7481248258f806ea042f16bd12e09822be2f3d0abcd80c864ab0328572f428ce
 SHA512:
-  metadata.gz: b3630e5152913b1bca04ca94ab0d15bdce29f6853a4cafb226c4e5f678042e8a1bbcd6e931b20432d816556ef5f087512e4ad09327e5bbfa3af72e97bcce9a5f
-  data.tar.gz: bace8057362c6085ba5edea873087b5b4459f6c0dc48e5abeea589380abcd64386dfedfcd41cc2a841f69721b3d852a8516aaf06522df843d8b09e902879842e
+  metadata.gz: ed132bcafa1a4801ad6196bb26c76e11dbee3ec64a672363eaf46583189fdc58a6fcc515d5bc4525c5125f6ce06b11a00ac914dbfcc4252c93abedc89a58f4f1
+  data.tar.gz: 2469cfc961274f0cac6938951723e425f182becba4b95349c70c981e93f197551068b5124cf3afe687d1f537a3355787b3621275506650c02f5ac1c1c914530e

data/.ruby-version

@@ -0,0 +1 @@
+3.0.3

data/Gemfile

@@ -7,3 +7,12 @@ gem "sqlite3"
 gem "pbbuilder", "~> 0.10.0"
 gem "standard"
 gem "pry"
+
+# HACK(bouk): Overwrite Bundler's platform matcher to ignore universal CPU
+# The protobuf and gRPC 'universal' macOS gems break on M1
+module Bundler::MatchPlatform
+  def match_platform(p)
+    return false if ::Gem::Platform === platform && platform.cpu == "universal"
+    Bundler::MatchPlatform.platforms_match?(platform, p)
+  end
+end

data/README.md

@@ -21,6 +21,21 @@ Or install it yourself as:
 $ gem install rails_twirp
 ```
 
+## Installing correct protobuf version for M1 Mac Chips
+
+If you run into an issue with protobuf universal-darwin version, please paste this in your Gemfile as recommended by @bouke :
+
+```ruby
+# HACK(bouk): Overwrite Bundler's platform matcher to ignore universal CPU
+# The protobuf and gRPC 'universal' macOS gems break on M1
+module Bundler::MatchPlatform
+  def match_platform(p)
+    return false if ::Gem::Platform === platform && platform.cpu == "universal"
+    Bundler::MatchPlatform.platforms_match?(platform, p)
+  end
+end
+```
+
 ## Contributing
 Contribution directions go here.
 

data/lib/rails_twirp/base.rb

@@ -12,6 +12,7 @@ require "rails_twirp/rescue"
 require "rails_twirp/url_for"
 require "rails_twirp/implicit_render"
 require "rails_twirp/instrumentation"
+require "rails_twirp/exception_handling"
 
 module RailsTwirp
   class Base < AbstractController::Base
@@ -36,8 +37,9 @@ module RailsTwirp
     include AbstractController::Callbacks
     include Rescue
     include Instrumentation
+    include ExceptionHandling
 
-    attr_internal :request, :env, :response_class
+    attr_internal :request, :env, :response_class, :rpc_name
     def initialize
       @_request = nil
       @_env = nil
@@ -49,10 +51,11 @@ module RailsTwirp
       @_http_request ||= ActionDispatch::Request.new(env[:rack_env])
     end
 
-    def dispatch(action, request, response_class, env = {})
+    def dispatch(action, request, response_class, rpc_name, env = {})
       self.request = request
       self.env = env
       self.response_class = response_class
+      self.rpc_name = rpc_name
 
       http_request.controller_instance = self
 
@@ -61,8 +64,8 @@ module RailsTwirp
       response_body
     end
 
-    def self.dispatch(action, request, response_class, env = {})
-      new.dispatch(action, request, response_class, env)
+    def self.dispatch(action, request, response_class, rpc_name, env = {})
+      new.dispatch(action, request, response_class, rpc_name, env)
     end
 
     # Used by the template renderer to figure out which template to use

data/lib/rails_twirp/exception_handling.rb

@@ -0,0 +1,26 @@
+require "twirp/error"
+
+module RailsTwirp
+  module ExceptionHandling
+    extend ActiveSupport::Concern
+
+    include AbstractController::Logger
+
+    def process_action(*)
+      super
+    rescue Exception => e
+      # We adopt the same error handling logic as Rails' standard middlewares:
+      # 1. When we 'show exceptions' we make the exception bubble up—this is useful for testing
+      raise e unless http_request.show_exceptions?
+
+      # 2. When we want to show detailed exceptions we include the exception message in the error
+      if http_request.get_header("action_dispatch.show_detailed_exceptions")
+        self.response_body = Twirp::Error.internal_with(e)
+        return
+      end
+
+      # 3. Otherwise we just return a vague internal error message
+      self.response_body = Twirp::Error.internal("Internal error")
+    end
+  end
+end

data/lib/rails_twirp/log_subscriber.rb

@@ -17,7 +17,9 @@ module RailsTwirp
       info do
         code = payload.fetch(:code, :internal)
 
-        message = +"Completed #{code} in #{event.duration.round}ms (Allocations: #{event.allocations})"
+        message = +"Completed #{code}"
+        message << ": #{payload[:msg]}" if payload[:msg]
+        message << " in #{event.duration.round}ms (Allocations: #{event.allocations})"
         message << "\n\n" if defined?(Rails.env) && Rails.env.development?
 
         message

data/lib/rails_twirp/route_set.rb

@@ -29,6 +29,8 @@ module RailsTwirp
 
       def initialize(service_class)
         @service_class = service_class
+        @service_class.raise_exceptions = true
+
         @rpcs = {}
       end
 
@@ -57,7 +59,7 @@ module RailsTwirp
             controller_name = mapping.controller.underscore
             const_name = controller_name.camelize << "Controller"
             controller_class = const_name.constantize
-            controller_class.dispatch(action_name, req, response_class, env)
+            controller_class.dispatch(action_name, req, response_class, name, env)
           end
         end
 

data/lib/rails_twirp/testing/integration_test.rb

@@ -100,7 +100,7 @@ module RailsTwirp
     end
 
     def set_controller_from_rack_env(env)
-      @controller = ActionDispatch::Request.new(env).controller_class
+      @controller = ActionDispatch::Request.new(env).controller_instance
     end
   end
 end

data/lib/rails_twirp/version.rb

@@ -1,3 +1,3 @@
 module RailsTwirp
-  VERSION = "0.7.2"
+  VERSION = "0.10.0"
 end

data/rails_twirp.gemspec

@@ -14,4 +14,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rails", ">= 6.1.3"
   spec.add_dependency "twirp", "~> 1.7.2"
+  spec.required_ruby_version = ">= 3"
 end

data/test/dummy/app/controllers/dummy_controller.rb

@@ -0,0 +1,5 @@
+class DummyController < RailsTwirp::Base
+  def rpc_name_check
+    @rpc_name = rpc_name
+  end
+end

data/test/dummy/app/views/dummy/rpc_name_check.pb.pbbuilder

@@ -0,0 +1 @@
+pb.rpc_name @rpc_name

data/test/dummy/config/twirp/routes.rb

@@ -9,6 +9,7 @@ Rails.application.twirp.routes.draw do
     rpc "RaiseError", to: "pings#raise_error"
     rpc "UncaughtError", to: "pings#uncaught_raise"
     rpc "BeforeError", to: "pings#before_error"
+    rpc "RpcNameCheck", to: "dummy#rpc_name_check"
   end
 
   scope module: :testmod do

data/test/dummy/proto/api.proto

@@ -13,6 +13,7 @@ service Dummy {
   rpc UncaughtError(PingRequest) returns (PingResponse);
   rpc BeforeError(PingRequest) returns (PingResponse);
   rpc Nested(PingRequest) returns (PingResponse);
+  rpc RpcNameCheck(RpcNameCheckRequest) returns (RpcNameCheckResponse);
 }
 
 message PingRequest {
@@ -22,3 +23,8 @@ message PingRequest {
 message PingResponse {
   string double_name = 2;
 }
+
+message RpcNameCheckRequest{}
+message RpcNameCheckResponse{
+  string rpc_name = 1;
+}

data/test/dummy/proto/api_pb.rb

@@ -11,6 +11,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "dummy.api.PingResponse" do
       optional :double_name, :string, 2
     end
+    add_message "dummy.api.RpcNameCheckRequest" do
+    end
+    add_message "dummy.api.RpcNameCheckResponse" do
+      optional :rpc_name, :string, 1
+    end
   end
 end
 
@@ -18,5 +23,7 @@ module RPC
   module DummyAPI
     PingRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dummy.api.PingRequest").msgclass
     PingResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dummy.api.PingResponse").msgclass
+    RpcNameCheckRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dummy.api.RpcNameCheckRequest").msgclass
+    RpcNameCheckResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("dummy.api.RpcNameCheckResponse").msgclass
   end
 end

data/test/dummy/proto/api_twirp.rb

@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.6.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.8.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'api_pb.rb'
 
@@ -15,6 +15,7 @@ module RPC
       rpc :UncaughtError, PingRequest, PingResponse, :ruby_method => :uncaught_error
       rpc :BeforeError, PingRequest, PingResponse, :ruby_method => :before_error
       rpc :Nested, PingRequest, PingResponse, :ruby_method => :nested
+      rpc :RpcNameCheck, RpcNameCheckRequest, RpcNameCheckResponse, :ruby_method => :rpc_name_check
     end
 
     class DummyClient < Twirp::Client

data/test/dummy_test.rb

@@ -0,0 +1,10 @@
+require "test_helper"
+
+class DummyControllerTest < RailsTwirp::IntegrationTest
+  test "controller gets rpc name" do
+    req = RPC::DummyAPI::RpcNameCheckRequest.new
+    rpc RPC::DummyAPI::DummyService, "RpcNameCheck", req
+    assert_instance_of RPC::DummyAPI::RpcNameCheckResponse, response
+    assert_equal "RpcNameCheck", response.rpc_name
+  end
+end

data/test/ping_controller_test.rb

@@ -46,12 +46,38 @@ class PingControllerTest < RailsTwirp::IntegrationTest
     assert_equal :not_found, response.code
   end
 
-  test "uncaught error" do
+  test "uncaught errors should bubble up to the test" do
+    req = RPC::DummyAPI::PingRequest.new
+    assert_raises StandardError, "Uncaught" do
+      rpc RPC::DummyAPI::DummyService, "UncaughtError", req
+    end
+  end
+
+  test "uncaught errors should return an internal error with details if show_exceptions is true" do
+    Rails.application.env_config["action_dispatch.show_exceptions"] = true
+
     req = RPC::DummyAPI::PingRequest.new
     rpc RPC::DummyAPI::DummyService, "UncaughtError", req
     assert_instance_of Twirp::Error, response
+    assert_equal :internal, response.code
     assert_equal "Uncaught", response.msg
+    assert_equal "StandardError", response.meta["cause"]
+  ensure
+    Rails.application.env_config["action_dispatch.show_exceptions"] = false
+  end
+
+  test "uncaught errors should return an internal error without if show_exceptions is true and show_detailed_exceptions is false" do
+    Rails.application.env_config["action_dispatch.show_exceptions"] = true
+    Rails.application.env_config["action_dispatch.show_detailed_exceptions"] = false
+
+    req = RPC::DummyAPI::PingRequest.new
+    rpc RPC::DummyAPI::DummyService, "UncaughtError", req
+    assert_instance_of Twirp::Error, response
     assert_equal :internal, response.code
+    assert_equal "Internal error", response.msg
+  ensure
+    Rails.application.env_config["action_dispatch.show_detailed_exceptions"] = true
+    Rails.application.env_config["action_dispatch.show_exceptions"] = false
   end
 
   test "before error" do
@@ -61,4 +87,10 @@ class PingControllerTest < RailsTwirp::IntegrationTest
     assert_equal "yOuR ReQuEsT Is mAlFoRmEd", response.msg
     assert_equal :malformed, response.code
   end
+
+  test "controller is set to the controller that handled the request" do
+    req = RPC::DummyAPI::PingRequest.new(name: "Bouke")
+    rpc RPC::DummyAPI::DummyService, "Ping", req
+    assert_instance_of PingsController, controller
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_twirp
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-01 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -47,6 +47,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".ruby-version"
 - ".standard.yml"
 - Gemfile
 - MIT-LICENSE
@@ -59,6 +60,7 @@ files:
 - lib/rails_twirp/base.rb
 - lib/rails_twirp/engine.rb
 - lib/rails_twirp/errors.rb
+- lib/rails_twirp/exception_handling.rb
 - lib/rails_twirp/implicit_render.rb
 - lib/rails_twirp/instrumentation.rb
 - lib/rails_twirp/log_subscriber.rb
@@ -79,6 +81,7 @@ files:
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/application_twirp_controller.rb
 - test/dummy/app/controllers/concerns/.keep
+- test/dummy/app/controllers/dummy_controller.rb
 - test/dummy/app/controllers/pings_controller.rb
 - test/dummy/app/controllers/testmod/nested/other_controller.rb
 - test/dummy/app/helpers/application_helper.rb
@@ -88,6 +91,7 @@ files:
 - test/dummy/app/mailers/application_mailer.rb
 - test/dummy/app/models/application_record.rb
 - test/dummy/app/models/concerns/.keep
+- test/dummy/app/views/dummy/rpc_name_check.pb.pbbuilder
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/layouts/mailer.html.erb
 - test/dummy/app/views/layouts/mailer.text.erb
@@ -131,6 +135,7 @@ files:
 - test/dummy/public/apple-touch-icon-precomposed.png
 - test/dummy/public/apple-touch-icon.png
 - test/dummy/public/favicon.ico
+- test/dummy_test.rb
 - test/other_controller_test.rb
 - test/ping_controller_test.rb
 - test/rails_twirp_test.rb
@@ -147,14 +152,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Integrate Twirp into Rails
@@ -168,6 +173,7 @@ test_files:
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/controllers/application_twirp_controller.rb
 - test/dummy/app/controllers/concerns/.keep
+- test/dummy/app/controllers/dummy_controller.rb
 - test/dummy/app/controllers/pings_controller.rb
 - test/dummy/app/controllers/testmod/nested/other_controller.rb
 - test/dummy/app/helpers/application_helper.rb
@@ -177,6 +183,7 @@ test_files:
 - test/dummy/app/mailers/application_mailer.rb
 - test/dummy/app/models/application_record.rb
 - test/dummy/app/models/concerns/.keep
+- test/dummy/app/views/dummy/rpc_name_check.pb.pbbuilder
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/layouts/mailer.html.erb
 - test/dummy/app/views/layouts/mailer.text.erb
@@ -220,6 +227,7 @@ test_files:
 - test/dummy/public/apple-touch-icon-precomposed.png
 - test/dummy/public/apple-touch-icon.png
 - test/dummy/public/favicon.ico
+- test/dummy_test.rb
 - test/other_controller_test.rb
 - test/ping_controller_test.rb
 - test/rails_twirp_test.rb