action_controller-twirp 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22fa76662fce706d3efefc38981bfab8ed7cd01611e1d4de2bc8c7a8ad919e38
-  data.tar.gz: 4479f03e25ef53f640feaaa9fb9e8c2e10e5202606f522da1949abbed88dfa5e
+  metadata.gz: ba5d8f3dbfc7dc8099def1e420b3a6c79cc2611df1295fad0c9e5f03ed3b1339
+  data.tar.gz: f2597df16242abd93b1ff1878b664db3f9e66cf63904e2030a47e000c32ba160
 SHA512:
-  metadata.gz: b576978ee686292ac1150e876283101981094ce919e2d0c00bc202d7e5177badad3a9f29655aa3f7a6eed158e1ff02bbce89c8fb4998300cf4ba419f8a51729e
-  data.tar.gz: b28a534f96ace98a8f2daad7bbe2e90f72cbce3533ad5133fadfa49aa0d4ab07006b649e79f0252e43be331868091255af951ae6934103a8659244684602dc4f
+  metadata.gz: ec99d0597b6d950cbf5f65c6900ef64ac855871520bb682d7f916a70aa1dcb6892152a190f487ab639098f4ba44757db9387a420ef22e603326ec08468964d3c
+  data.tar.gz: 780bf0fab5393d22940621111dfdf811c78007369c64b9a18cfa1f8e50b0adddf3300e07ef6a592605a936d987c481e73835e115109fccaa2a60e3b8ad6902d4

data/README.md

@@ -51,13 +51,6 @@ Finally, implement rpc method your controller
 class UsersController < ApplicationController # :nodoc:
   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 +70,48 @@ class UsersController < ApplicationController # :nodoc:
 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.
+
+You can install initializer by rails generate command
+```sh
+> bin/rails generate action_controller:twirp:install
+
+> 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,
+  # }
+
+  # 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
+```
+
 ## Contributing
 Contribution directions go here.
 

data/lib/action_controller/twirp/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module/attribute_accessors'
+
+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: {}
+
+      # 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/railtie.rb

@@ -1,19 +1,10 @@
 # frozen_string_literal: true
 
-require 'action_controller/twirp/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 = TwirpErrorRenderer.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.1.1'
+    VERSION = '0.2.0'
   end
 end

data/lib/action_controller/twirp.rb

@@ -2,6 +2,7 @@
 
 require 'action_controller/twirp/version'
 require 'action_controller/twirp/railtie'
+require 'action_controller/twirp/config'
 
 module ActionController
   # Module to execute your implemented methods on Twirp with Rails
@@ -10,9 +11,9 @@ module ActionController
 
     # Override it to call a twirp class from request path
     def send_action(*_args)
-      twirp_service_class.raise_exceptions = true
+      twirp_service_class.raise_exceptions = Config.handle_exceptions
 
-      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 +26,35 @@ 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 = twirp_error(exception)
+      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/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,30 @@
+# 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 = {
+  #   '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.2.0
 platform: ruby
 authors:
 - Kosuke Arisawa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2022-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,11 +63,13 @@ files:
 - README.md
 - Rakefile
 - lib/action_controller/twirp.rb
+- lib/action_controller/twirp/config.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:

data/lib/action_controller/twirp/twirp_error_renderer.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-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.
-      # @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'
-        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
-
-      def twirp_error
-        return @twirp_error if defined? @twirp_error
-
-        code = @content.code
-
-        @twirp_error = if ::Twirp::Error.valid_code?(code)
-                         @content
-                       else
-                         ::Twirp::Error.internal("Invalid code: #{code}", invalid_code: code.to_s)
-                       end
-      end
-
-      def status
-        ::Twirp::ERROR_CODES_TO_HTTP_STATUS[twirp_error.code]
-      end
-
-      def content_type
-        ::Twirp::Encoding::JSON
-      end
-    end
-  end
-end