rails_twirp 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff69015b104dada61abed7c68ad1f17c4f2f0d0ead6e05cf445060f69f4064aa
-  data.tar.gz: 00f4b9f8551e568d4887d4072adb3e0ba0e8465e412d9c419f45a19eb1a8725a
+  metadata.gz: 2e2d7bf09840bf1a4d5aef432df4a47d50e653fe618781324d535c382b222cd9
+  data.tar.gz: 7481248258f806ea042f16bd12e09822be2f3d0abcd80c864ab0328572f428ce
 SHA512:
-  metadata.gz: 75262234b40b10f6de6e4b650c7a7ad024c841d324acb44fadef6042f9725c1f1f1f423bb7d55c7ca300fcf54edf18f033a149331667c907f772ba7d1991e7e9
-  data.tar.gz: 50eb75a5f7b293d873f9b2014ec642779e7622da4ae25e6a79352f3ed61e3e93ea13c1b5f53dcdb4e8f34337cbb29b1b7d99753fe19755a3fbb89512091220c4
+  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/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,6 +37,7 @@ module RailsTwirp
     include AbstractController::Callbacks
     include Rescue
     include Instrumentation
+    include ExceptionHandling
 
     attr_internal :request, :env, :response_class, :rpc_name
     def initialize

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/route_set.rb

@@ -29,6 +29,8 @@ module RailsTwirp
 
       def initialize(service_class)
         @service_class = service_class
+        @service_class.raise_exceptions = true
+
         @rpcs = {}
       end
 

data/lib/rails_twirp/version.rb

@@ -1,3 +1,3 @@
 module RailsTwirp
-  VERSION = "0.9.1"
+  VERSION = "0.10.0"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_twirp
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-07 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
@@ -157,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Integrate Twirp into Rails