rails_twirp 0.9.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1ac2840887dd15ea43114d7b0d25901c05e3288fa10d6cdcd8d00d4dabc8e74
-  data.tar.gz: 59ff25b65ad6bd62f1ebc537bc11017da58b6ce6e1f4a74cae9e1c7f35454508
+  metadata.gz: '09e97be65f570cd7a2cecaaf0ef83d2ead287fd1fc8c556b833ae45395ee1c2b'
+  data.tar.gz: 1b30d280c8c724747b0b71ef7996ad23fd0a8e189818156602f284677ac9c637
 SHA512:
-  metadata.gz: fd193ba67f59a313b463a2745418329d33585505164124810abdbd556ce808717064e6dde4c249cd50865951a9e1155f085adc0b556860eb1a83d5714206833a
-  data.tar.gz: 2795b73a1cf25688ff7abea8db81af893b23374297dbd9128e6d9b642ee3bce4d4026d83d660aa3158367fd0e357987e2d71717e8b4dabe5e2b86720fbd4b74a
+  metadata.gz: 858ea0680c3efd03f2f1fdc766f6097b6e0a7b19ff39974412207139cd28a432d4c620a7a4f9243b63b9f70eff1919cb5a92d0c3dc6b5cd73ba99eb1349ac870
+  data.tar.gz: ba6311d0b7cb64755380eff9d1168d24458d5804f36acf21c7fceab2a8b0db305722353d8c5f493bf1692225f973342e3194f825d995df286802da6958631e3a

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "github-actions"
+    # Checks for workflow files stored in the default location of `.github/workflows`
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.ruby-version

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

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### 0.12.0
+
+* Allow a custom exception handling proc to be assigned using `RailsTwirp.unhandled_exception_handler`
+
+### 0.11.0
+
+* Update configuration and tests for Rails 7 compatibility
+
+### 0.10.0
+
+* Handle exceptions more like the Rails controllers do it, do not capture all of them as if they were Twirp exceptions

data/Gemfile

@@ -4,6 +4,15 @@ source "https://rubygems.org"
 gemspec
 
 gem "sqlite3"
-gem "pbbuilder", "~> 0.10.0"
+gem "pbbuilder", "~> 0.12.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

@@ -1,8 +1,56 @@
 # RailsTwirp
-Short description and motivation.
+
+Allows for effortless integration of [Twirp](https://github.com/twitchtv/twirp) endpoints into your Rails application. RailsTwirp permits you to define your Twirp endpoints using the familiar vocabulary of Rails routes, controllers, actions and views.
+
+Using an extra routes file you map your Twirp RPCs to controllers, and define your views using [pbbuilder.](https://github.com/cheddar-me/pbbuilder) Even though you are now serving Twirp RPC endpoints instead of HTML or JSON, all the skills and tools you have for working your usual Rails infrastructure apply. `TwirpRails` provides a customised controller superclass called `RailsTwirp::Base` which includes all the relevant ActionController components which still make sense when using Protobufs.
 
 ## Usage
-How to use my plugin.
+
+Add the gem to your project (see "Installation" below). Then add a file called `config/twirp/routes.rb` to your application, and map your RPCs inside of that file. We will map a `GreetWorld` RPC call as an example:
+
+```ruby
+Rails.application.twirp.routes.draw do
+  service HelloService, module: :api do
+    rpc "GreetWorld", to: "greetings#greet"
+  end
+end
+```
+
+The `module` defines the module which will contain your `TwirpRails` controller. The `HelloService` module is your Protobuf mapping generated using Twirp, it inherits from `Twirp::Service` and could look like this:
+
+```ruby
+class HelloService < Twirp::Service
+  package 'api'
+  service 'App'
+  rpc :GreetWorld, GreetWorldRequest, GreetWorldResponse, :ruby_method => :greet_world
+end
+```
+
+The `GreetWorldRequest` in this case is the autogenerated protobuf request class, the `GreetWorldResponse` is the response class.
+
+Then you define your controller, which looks like a standard Rails controller - just with a different base class:
+
+```ruby
+class API::GreetingsController  < RailsTwirp::Base
+  def greet
+    render pb: API::GreetResponse.new
+  end
+end
+```
+
+Note that the controller is routed using the same naming conventions as Rails. Inside of a `TwirpRails` controller you can do most of the things you are used to from Rails controllers, such as renders and implicit renders - which have to be `pbbuilder` views. If our `GreetWorldResponse` has a `greeting` field, it can be filled inside the `pbbuilder` view like so:
+
+```ruby
+pb.greeting "Hello stranger"
+```
+
+Inside the controllers you have access to the call parameters of your RPC call using `request`:
+
+```ruby
+def greet
+  request.name #=> # Returns the value of the "name" field from the request Protobuf
+end
+```
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -37,7 +85,14 @@ end
 ```
 
 ## Contributing
-Contribution directions go here.
+
+* Check out the latest `main` to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for your change. This is important so we don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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,36 @@
+require "twirp/error"
+
+module RailsTwirp
+  module ExceptionHandling
+    extend ActiveSupport::Concern
+
+    include AbstractController::Logger
+
+    def process_action(*)
+      super
+    rescue Exception => e
+      # Only the exceptions which are not captured by ActionController-like "rescue_from" end up here.
+      # The idea is that any exception which is rescued by the controller is treated as part of the business
+      # logic, and thus taking action on it is the responsibility of the controller which uses "rescue_from".
+      # If an exception ends up here it means it wasn't captured by the handlers defined in the controller.
+
+      # 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
+      #    If the exception gets raised here error reporting will happen in the middleware of the APM package
+      #    higher in the call stack.
+      raise e unless http_request.show_exceptions?
+
+      # 2. We report the error to the error tracking service, this needs to be configured.
+      RailsTwirp.unhandled_exception_handler&.call(e)
+
+      # 3. 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
+
+      # 4. 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/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.9.0"
+  VERSION = "0.12.0"
 end

data/lib/rails_twirp.rb

@@ -8,6 +8,7 @@ require "rails_twirp/log_subscriber"
 
 module RailsTwirp
   mattr_accessor :test_app
+  mattr_accessor :unhandled_exception_handler
 end
 
 require "rails_twirp/engine" if defined?(Rails)

data/rails_twirp.gemspec

@@ -13,6 +13,6 @@ Gem::Specification.new do |spec|
   spec.test_files = `git ls-files -- test/*`.split("\n")
 
   spec.add_dependency "rails", ">= 6.1.3"
-  spec.add_dependency "twirp", "~> 1.7.2"
+  spec.add_dependency "twirp", ">= 1.7.2", "~> 1.9.0"
   spec.required_ruby_version = ">= 3"
 end

data/test/ping_controller_test.rb

@@ -46,12 +46,56 @@ 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 be fanned out to the exception handler proc if one is defined" do
+    Rails.application.env_config["action_dispatch.show_exceptions"] = true
+
+    captured_exception = nil
+    RailsTwirp.unhandled_exception_handler = ->(e) { captured_exception = e }
+
     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"]
+    assert_kind_of StandardError, captured_exception
+  ensure
+    RailsTwirp.unhandled_exception_handler = nil
+    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 +105,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.9.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,16 +28,22 @@ dependencies:
   name: twirp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.0
 description:
 email:
 - bouke@cheddar.me
@@ -45,9 +51,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".ruby-version"
 - ".standard.yml"
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -59,6 +68,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
@@ -108,7 +118,6 @@ files:
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/assets.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/content_security_policy.rb
 - test/dummy/config/initializers/cookies_serializer.rb
@@ -157,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Integrate Twirp into Rails
@@ -200,7 +209,6 @@ test_files:
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/assets.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/content_security_policy.rb
 - test/dummy/config/initializers/cookies_serializer.rb

data/test/dummy/config/initializers/assets.rb

@@ -1,12 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Version of your assets, change this if you want to expire all your assets.
-Rails.application.config.assets.version = "1.0"
-
-# Add additional assets to the asset load path.
-# Rails.application.config.assets.paths << Emoji.images_path
-
-# Precompile additional assets.
-# application.js, application.css, and all non-JS/CSS in the app/assets
-# folder are already added.
-# Rails.application.config.assets.precompile += %w( admin.js admin.css )