action_controller-twirp 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22fa76662fce706d3efefc38981bfab8ed7cd01611e1d4de2bc8c7a8ad919e38
-  data.tar.gz: 4479f03e25ef53f640feaaa9fb9e8c2e10e5202606f522da1949abbed88dfa5e
+  metadata.gz: 17541f1f7bae98a4beb49d20368f0bcbb60b5c0284e6763ead869f13bc333784
+  data.tar.gz: 272ddd872c4a7176abcba1b78baf20478e37f93338bc5002ef4537f21e4d8289
 SHA512:
-  metadata.gz: b576978ee686292ac1150e876283101981094ce919e2d0c00bc202d7e5177badad3a9f29655aa3f7a6eed158e1ff02bbce89c8fb4998300cf4ba419f8a51729e
-  data.tar.gz: b28a534f96ace98a8f2daad7bbe2e90f72cbce3533ad5133fadfa49aa0d4ab07006b649e79f0252e43be331868091255af951ae6934103a8659244684602dc4f
+  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,18 +51,11 @@ 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
 
-  rescue_from ActiveRecord::RecordNotFound do |e|
-    twerr = Twirp::Error.not_found('The message',
-                                   reason: e.class.name.demodulize,
-                                   id: params[:id].to_s)
-    render twirp_error: twerr
-  end
-
   USERS = [
     { id: 1, name: 'Anna' },
     { id: 2, name: 'Reina' }
@@ -77,6 +75,88 @@ class UsersController < ApplicationController # :nodoc:
 end
 ```
 
+### Error handling
+
+We must follow protocol when using Twirp. Specifically,
+
+- 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|
+  # Mapping your exception classes and Twirp::Error::ERROR_CODES
+  # String => Symbol
+  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) {}
+
+  # Block to make Twirp::Error metadata. when exception_codes exist
+  # It MUST return Hash value
+  # config.build_metadata = ->(exception) {}
+
+  # Block to run additional process. e.g. logging
+  # config.on_exceptions = ->(exception) {}
+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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/attribute_accessors'
+
+module ActionController
+  module Twirp
+    # Configration for ActionController::Twirp
+    module Config
+      # Mapping your exception classes and Twirp::Error::ERROR_CODES
+      mattr_accessor :exception_codes, default: {}
+
+      # Block to make Twirp::Error message
+      mattr_accessor :build_message, default: ->(exception) {}
+
+      # Block to make Twirp::Error metadata
+      mattr_accessor :build_metadata, default: ->(exception) {}
+
+      # Block to run additional process. e.g. logging
+      mattr_accessor :on_exceptions, default: ->(exception) {}
+
+      def self.setup
+        yield self
+      end
+    end
+  end
+end

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/{twirp_error_renderer.rb → error_renderer.rb}

@@ -3,12 +3,12 @@
 module ActionController
   module Twirp
     # Convert Twirp::Error to #render option
-    class TwirpErrorRenderer
-      # @param content [Twirp::Error] given as a value of :twirp_error key of render method.
+    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?(::Twirp::Error)
-          raise ArgumentError, 'Only Twirp::Error instance can be specified'
+        unless content.is_a?(Exception)
+          raise ArgumentError, 'Instance of Exception class can be specified'
         end
 
         @content = content
@@ -24,16 +24,10 @@ module ActionController
 
       private
 
-      def twirp_error
-        return @twirp_error if defined? @twirp_error
-
-        code = @content.code
+      attr_reader :content, :options
 
-        @twirp_error = if ::Twirp::Error.valid_code?(code)
-                         @content
-                       else
-                         ::Twirp::Error.internal("Invalid code: #{code}", invalid_code: code.to_s)
-                       end
+      def twirp_error
+        @twirp_error ||= Error.new(content).generate
       end
 
       def status

data/lib/action_controller/twirp/railtie.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'action_controller/twirp/twirp_error_renderer'
+require 'action_controller/twirp/error_renderer'
 require 'action_dispatch/twirp/railtie'
 
 module ActionController
@@ -9,7 +9,7 @@ module ActionController
       initializer 'action_controller.twirp' do
         ActiveSupport.on_load(:action_controller) do
           ActionController::Renderers.add :twirp_error do |content, options|
-            renderer = TwirpErrorRenderer.new(content, options)
+            renderer = ErrorRenderer.new(content, options)
             render(**renderer.to_render_option)
           end
         end

data/lib/action_controller/twirp/version.rb

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

data/lib/action_controller/twirp.rb

@@ -2,6 +2,8 @@
 
 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
@@ -12,7 +14,7 @@ module ActionController
     def send_action(*_args)
       twirp_service_class.raise_exceptions = true
 
-      status, header, body = twirp_service_class.new(self)&.call(request.env)
+      status, header, body = twirp_action
 
       response.status = status
       response.header.merge!(header)
@@ -25,5 +27,21 @@ module ActionController
       class_name = request.path.split('/')[-2].underscore.gsub('.', '/').classify
       @twirp_service_class = "#{class_name}Service".constantize
     end
+
+    def twirp_action
+      twirp_service_class.new(self)&.call(request.env)
+    rescue StandardError => e
+      begin
+        Config.on_exceptions.call(e)
+      rescue StandardError => hook_e
+        e = hook_e
+      end
+      twirp_error_response(e)
+    end
+
+    def twirp_error_response(exception)
+      twerr = Error.new(exception).generate
+      twirp_service_class.error_response(twerr)
+    end
   end
 end

data/lib/generators/action_controller/twirp/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ActionController
+  module Twirp
+    module Generators
+      class InstallGenerator < Rails::Generators::Base # :nodoc:
+        source_root File.expand_path('../../templates', __dir__)
+
+        desc 'Creates a ActionController::Twirp initializer'
+        def copy_initializer
+          template 'action_controller_twirp.rb', 'config/initializers/action_controller_twirp.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/templates/action_controller_twirp.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+ActionController::Twirp::Config.setup do |config|
+  # 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,
+  # }
+
+  # Block to make Twirp::Error message when exception_codes exist
+  # config.build_message = ->(exception) {}
+
+  # Block to make Twirp::Error metadata. when exception_codes exist
+  # It MUST return Hash value
+  # config.build_metadata = ->(exception) {}
+
+  # Block to run additional process. e.g. logging
+  # config.on_exceptions = ->(exception) {}
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_controller-twirp
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Kosuke Arisawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2022-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,11 +63,15 @@ files:
 - README.md
 - 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/twirp_error_renderer.rb
 - lib/action_controller/twirp/version.rb
 - lib/action_dispatch/routing/mapper/twirp.rb
 - lib/action_dispatch/twirp/railtie.rb
+- lib/generators/action_controller/twirp/install_generator.rb
+- lib/generators/templates/action_controller_twirp.rb
 - lib/tasks/action_controller/twirp_tasks.rake
 homepage: https://github.com/arisawa/action_controller-twirp
 licenses: