action_controller-twirp 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba5d8f3dbfc7dc8099def1e420b3a6c79cc2611df1295fad0c9e5f03ed3b1339
-  data.tar.gz: f2597df16242abd93b1ff1878b664db3f9e66cf63904e2030a47e000c32ba160
+  metadata.gz: 17541f1f7bae98a4beb49d20368f0bcbb60b5c0284e6763ead869f13bc333784
+  data.tar.gz: 272ddd872c4a7176abcba1b78baf20478e37f93338bc5002ef4537f21e4d8289
 SHA512:
-  metadata.gz: ec99d0597b6d950cbf5f65c6900ef64ac855871520bb682d7f916a70aa1dcb6892152a190f487ab639098f4ba44757db9387a420ef22e603326ec08468964d3c
-  data.tar.gz: 780bf0fab5393d22940621111dfdf811c78007369c64b9a18cfa1f8e50b0adddf3300e07ef6a592605a936d987c481e73835e115109fccaa2a60e3b8ad6902d4
+  metadata.gz: 8b8ea6ac39900c875734119e47552d0425bb18e49e8ca878d30901e38ff5293cf2f59729220bef4184670dc80086d951cf055cfbdfdaa0d5f42d562139acde74
+  data.tar.gz: 3314d20c05db3d93fd07d75b840baec2b60f3d5a581e3e11e76df1da87d15e520a015cd4dbd426a6c3b5e3eba5f89da5c5ddffbd6a6ce4e6787c3cde740822ea

data/README.md

@@ -29,7 +29,12 @@ It provides routing method `twirp` that maps twirp service class and Rails contr
 
 First, you should generate twirp service class. see: [example in twirp-ruby](https://github.com/twitchtv/twirp-ruby/wiki#usage-example)
 
-Next, add twirp action in config/routes.rb
+Next, install initializer.
+```sh
+bin/rails g action_controller:twirp:install
+```
+
+Next, add twirp action in config/routes.rb.
 ```ruby
 Rails.application.routes.draw do
   scope :twirp do
@@ -38,7 +43,7 @@ Rails.application.routes.draw do
 end
 ```
 
-Result of `bin/rails routes`
+Result of `bin/rails routes`.
 ```sh
 > bin/rails routes
  Prefix  Verb  URI Pattern                                    Controller#Action
@@ -46,9 +51,9 @@ Result of `bin/rails routes`
          POST  /twirp/example.v1.UserApi/GetUser(.:format)    users#get_user
 ```
 
-Finally, implement rpc method your controller
+Finally, implement rpc method your controller.
 ```ruby
-class UsersController < ApplicationController # :nodoc:
+class UsersController < ApplicationController
   include ActionController::Twirp
 
   USERS = [
@@ -72,33 +77,47 @@ end
 
 ### Error handling
 
-twirp-ruby eventually provides us with a rack app, which handles the exception and returns a response when an exception occurs.
-Provide settings for exception handling, as the status code or body may be unexpected when an error occurs.
+We must follow protocol when using Twirp. Specifically,
 
-You can install initializer by rails generate command
-```sh
-> bin/rails generate action_controller:twirp:install
+- It accepts request parameters specified in proto file, and must return response body.
+- If an exception occurs, a response body of Twirp::Error's JSON must be returned.
+
+This section describes when an exception occurs.
+
+The following blocks are in the order of method calls when requested to the Rails app. (It's quite simplified)
+```
+ :
+ActionController::Metal#dispatch
+  AbstractController::Base#process
+     :
+    ActionController::Rescue#process_action
+    ActionController::Callbacks#process_action
+     :
+    (Some module's #process_action is called)
+     :
+    AbstractController::Base#process_action
+      AbstractController::Base#send_action
+```
+
+The gem is only override `#send_action`. It follows twirp protocal in this one.
+
+For example, if an exception occurs in the callback, Rails app will return a response, so we must be implemented so that the twirp protocol can be followed.
+
+This is easy to do, see below.
 
+First, modify `exception_codes` config.
+```sh
 > cat config/initializers/action_controller_twirp.rb
 # frozen_string_literal: true
 
 ActionController::Twirp::Config.setup do |config|
-  # Handle exceptions
-  #   true: handling by ActionController::Twirp
-  #   false: handling by Twirp::Service (default)
-  # config.handle_exceptions = false
-
-  # ---
-  # The following configurations ignore when handle_exceptions is false
-  # ---
-
   # Mapping your exception classes and Twirp::Error::ERROR_CODES
   # String => Symbol
-  # config.exception_codes = {
-  #   'ActiveRecord::RecordInvalid' => :invalid_argument,
-  #   'ActiveRecord::RecordNotFound' => :not_found,
-  #   'My::Exception' => :aborted,
-  # }
+  config.exception_codes = {
+    'ActiveRecord::RecordInvalid' => :invalid_argument,
+    'ActiveRecord::RecordNotFound' => :not_found,
+    'MyApp::Unauthenticated' => :unauthenticated,
+  }
 
   # Block to make Twirp::Error message when exception_codes exist
   # config.build_message = ->(exception) {}
@@ -112,6 +131,32 @@ ActionController::Twirp::Config.setup do |config|
 end
 ```
 
+Next, write a `rescue_from` block as usual and use the `:twirp_error` key on `#render`
+```ruby
+class UsersController < ApplicationController
+  include ActionController::Twirp
+
+  before_action :authenticate!
+
+  rescue_from MyApp::Unauthenticated do |e|
+    render twirp_error: e
+  end
+
+  :
+  :
+
+  private
+
+  def authenticate!
+    return if your_logic
+
+    raise MyApp::Unauthenticated
+  end
+end
+```
+
+See [dummy app controller](test/dummy/app/controllers/users_controller.rb) and [integration test](test/integration/users_test.rb) for details.
+
 ## Contributing
 Contribution directions go here.
 

data/lib/action_controller/twirp/config.rb

@@ -6,15 +6,6 @@ module ActionController
   module Twirp
     # Configration for ActionController::Twirp
     module Config
-      # Handle exceptions
-      #   true: handling by ActionController::Twirp
-      #   false: handling by Twirp::Service
-      mattr_accessor :handle_exceptions, default: false
-
-      # ---
-      # The following configurations ignore when handle_exceptions is false
-      # ---
-
       # Mapping your exception classes and Twirp::Error::ERROR_CODES
       mattr_accessor :exception_codes, default: {}
 

data/lib/action_controller/twirp/error.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'action_controller/twirp/config'
+
+module ActionController
+  module Twirp
+    # Class to generate Twirp::Error from an exception class and Config
+    class Error
+      # @param content [Exception] given as a value of :twirp_error key of render method.
+      def initialize(exception)
+        unless exception.is_a?(Exception)
+          raise ArgumentError, 'Instance of Exception class can be specified'
+        end
+
+        @exception = exception
+      end
+
+      def generate
+        if Config.exception_codes.key?(exception_name)
+          code = Config.exception_codes[exception_name]
+          message = Config.build_message.call(exception)
+          metadata = Config.build_metadata.call(exception)
+
+          ::Twirp::Error.public_send(code, message, metadata)
+        else
+          ::Twirp::Error.internal_with(exception)
+        end
+      rescue StandardError => e
+        ::Twirp::Error.internal_with(e)
+      end
+
+      private
+
+      attr_reader :exception
+
+      def exception_name
+        exception.class.to_s
+      end
+    end
+  end
+end

data/lib/action_controller/twirp/error_renderer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ActionController
+  module Twirp
+    # Convert Twirp::Error to #render option
+    class ErrorRenderer
+      # @param content [Exception] given as a value of :twirp_error key of render method.
+      # @param options [Hash] options of render method.
+      def initialize(content, options)
+        unless content.is_a?(Exception)
+          raise ArgumentError, 'Instance of Exception class can be specified'
+        end
+
+        @content = content
+        @options = options.dup
+      end
+
+      def to_render_option
+        {
+          json: twirp_error.to_h,
+          **@options.merge(status: status, content_type: content_type)
+        }
+      end
+
+      private
+
+      attr_reader :content, :options
+
+      def twirp_error
+        @twirp_error ||= Error.new(content).generate
+      end
+
+      def status
+        ::Twirp::ERROR_CODES_TO_HTTP_STATUS[twirp_error.code]
+      end
+
+      def content_type
+        ::Twirp::Encoding::JSON
+      end
+    end
+  end
+end

data/lib/action_controller/twirp/railtie.rb

@@ -1,10 +1,19 @@
 # frozen_string_literal: true
 
+require 'action_controller/twirp/error_renderer'
 require 'action_dispatch/twirp/railtie'
 
 module ActionController
   module Twirp
     class Railtie < ::Rails::Railtie # :nodoc:
+      initializer 'action_controller.twirp' do
+        ActiveSupport.on_load(:action_controller) do
+          ActionController::Renderers.add :twirp_error do |content, options|
+            renderer = ErrorRenderer.new(content, options)
+            render(**renderer.to_render_option)
+          end
+        end
+      end
     end
   end
 end

data/lib/action_controller/twirp/version.rb

@@ -2,6 +2,6 @@
 
 module ActionController
   module Twirp
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/action_controller/twirp.rb

@@ -3,6 +3,7 @@
 require 'action_controller/twirp/version'
 require 'action_controller/twirp/railtie'
 require 'action_controller/twirp/config'
+require 'action_controller/twirp/error'
 
 module ActionController
   # Module to execute your implemented methods on Twirp with Rails
@@ -11,7 +12,7 @@ module ActionController
 
     # Override it to call a twirp class from request path
     def send_action(*_args)
-      twirp_service_class.raise_exceptions = Config.handle_exceptions
+      twirp_service_class.raise_exceptions = true
 
       status, header, body = twirp_action
 
@@ -39,22 +40,8 @@ module ActionController
     end
 
     def twirp_error_response(exception)
-      twerr = twirp_error(exception)
+      twerr = Error.new(exception).generate
       twirp_service_class.error_response(twerr)
     end
-
-    def twirp_error(exception)
-      if Config.exception_codes.key?(exception.class.to_s)
-        code = Config.exception_codes[exception.class.to_s]
-        message = Config.build_message.call(exception)
-        metadata = Config.build_metadata.call(exception)
-
-        ::Twirp::Error.public_send(code, message, metadata)
-      else
-        ::Twirp::Error.internal_with(exception)
-      end
-    rescue StandardError => e
-      ::Twirp::Error.internal_with(e)
-    end
   end
 end

data/lib/generators/templates/action_controller_twirp.rb

@@ -1,15 +1,6 @@
 # frozen_string_literal: true
 
 ActionController::Twirp::Config.setup do |config|
-  # Handle exceptions
-  #   true: handling by ActionTwirpRails
-  #   false: handling by Twirp::Service (default)
-  # config.handle_exceptions = false
-
-  # ---
-  # The following configurations ignore when handle_exceptions is false
-  # ---
-
   # Mapping your exception classes and Twirp::Error::ERROR_CODES
   # String => Symbol
   # config.exception_codes = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_controller-twirp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kosuke Arisawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-29 00:00:00.000000000 Z
+date: 2022-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -64,6 +64,8 @@ files:
 - Rakefile
 - lib/action_controller/twirp.rb
 - lib/action_controller/twirp/config.rb
+- lib/action_controller/twirp/error.rb
+- lib/action_controller/twirp/error_renderer.rb
 - lib/action_controller/twirp/railtie.rb
 - lib/action_controller/twirp/version.rb
 - lib/action_dispatch/routing/mapper/twirp.rb