twirp_rails 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1fe8510dbe0b5f3334dd440ea3f6b5685a81ce8cca14f349e5151fd9da75dd7
-  data.tar.gz: ab737943d90ec1e0a691d9b08c7c9803690de1e907c19bfbda7ba3b63274439d
+  metadata.gz: 974aa187c0fa4e596194362b3aafc3b34e12baacd05b502a1a09bb808cf3ab0c
+  data.tar.gz: 9f121868824a0cda89c27a8e77d163640ae3b2b23f714c7122353abe2d39bd65
 SHA512:
-  metadata.gz: 32f77264c8398dc7249c89a979655a6cd37e812669b2e1fd24778afcd2ec6ea11cd33636ddb711df4c2954f8c500371552cc3ca800e9f750c1bd6b9dcc1d4a8a
-  data.tar.gz: 04a932ed0cb583d0505741bb1be9c0c8f0c4a5d7e9dc86d8d4229bbe2dccbc00fad311f8b9cb5cca774b01a07981ea7116dba68bcf52aa9509c5a545885cbebd
+  metadata.gz: 8898c1ae5bae4e1f024a69a5a29ac71a1130d8198fc376f18a6647f49228b2bbfb9d9b998f16e967a5036c8543e6e373374822e440685b0d6bb14033ecc359b1
+  data.tar.gz: 6515db4669525602ad53d090af51239ede7a7e2980981704751d210d6c8541e0405c1e8428dc0a13d9267e0140de95db4f93989c09b002185cb060e622627ac7

data/CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.4.4 - 2020-05-05
+
+### Added
+
+- ability to translate twirp errors to exceptions and vise versa.
+
+## 0.4.3 - 2020-04-14
+
+### Fixed
+
+- autorequire all ruby files from `lib/twirp_clients` folder.
+
+## 0.4.2 - 2020-04-01
+
+### Added
+
+- `to_twirp` extension use model method unless attribute found 
+
 ## 0.4.1 - 2020-03-30
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twirp_rails (0.4.3)
+    twirp_rails (0.4.4)
       railties (~> 6.0)
       twirp (~> 1)
 

data/README.md

@@ -9,6 +9,7 @@ TwirpRails helps to use [twirp-ruby gem](https://github.com/twitchtv/twirp-ruby)
  * `mount_twirp` route helper to mount handlers
  * `rpc` helper to dry your handlers specs
  * ability to log twirp calls by Rails logger
+ * DSL to translate handler exceptions to twirp errors and client twirp errors to ruby exceptions 
 
 ## Installation
 
@@ -151,6 +152,53 @@ generated by
 $ rails g twirp:init
 ```
 
+## Exception handling
+
+Translate handler exceptions to twirp errors and client twirp errors to ruby exceptions.
+
+This feature allow to use ruby style exception handling flow in ruby code.
+
+Create class to describe translate error rules
+```ruby
+  class ErrorTranslator < TwirpRails::ErrorHandling::Base
+    # rules to translate exception raised by handler to twirp
+    translate_exception ArgumentError, with: :invalid_argument
+    translate_exception ActiveRecord::NotFound do |exception, handler|
+      Twirp::Error.not_found
+    end
+    
+    # rules to translate twirp errors returned from client to exception
+    translate_error :invalid_argument, with: ArgumentError
+    translate_error :not_found do |error, client|
+      ActiveRecord::NotFound.new(error.msg)
+    end
+  end
+``` 
+
+And configure TwirpRails to use it:
+```ruby
+# config/initializers/twirp_ruby.rb
+# ...
+  config.twirp_exception_translator_class = 'ErrorTranslator' 
+# ... 
+```
+
+Services mounted by ```mount_twirp``` translates raised exception to twirp errors by this rules.
+
+To raise errors by clients, you should create client by `TwirpRails.client`
+
+```ruby
+client = TwirpRails.client(PeopleClient, 'http://localhost:3000/twirp')
+
+client.get_name(uid: 'not found').error 
+# Twirp::Error code:not_found msg:"Couldn't find User with 'uid'='not found'"
+client.get_name(uid: 'not found').data.name # NoMethodError: undefined method `name' for nil:NilClass
+
+# use bang method to raise translated error and didn't check each twirp call result error
+client.get_name!(uid: 'not found').data.name # ActiveRecord::NotFound: undefined method `name' for nil:NilClass
+``` 
+
+
 ## API acronym
 
 Gem adds inflector acronym `API` to correct using services with suffix `API`. 

data/lib/twirp_rails.rb

@@ -5,6 +5,7 @@ require 'twirp_rails/engine'
 require 'twirp_rails/generators/generators'
 require 'twirp_rails/active_record_extension'
 require 'twirp_rails/log_subscriber'
+require 'twirp_rails/error_handling/error_handling'
 
 module TwirpRails
   class Error < StandardError; end
@@ -61,6 +62,8 @@ module TwirpRails
     config_param :purge_old_twirp_code, true
 
     config_param :add_api_acronym, true
+
+    config_param :twirp_exception_translator_class, nil
   end
 
   def self.configuration
@@ -119,4 +122,10 @@ module TwirpRails
 
     Time.zone.at seconds
   end
+
+  def self.client(klass, url)
+    client = klass.new(url)
+
+    TwirpRails::ErrorHandling.wrap_client(client)
+  end
 end

data/lib/twirp_rails/error_handling/base.rb

@@ -0,0 +1,114 @@
+require 'twirp'
+
+module TwirpRails
+  module ErrorHandling
+    class Base
+      ExceptionHandler = Struct.new(:exception, :proc) do
+        def match?(exception)
+          exception.is_a?(self.exception)
+        end
+
+        def handle(exception, handler)
+          proc.call(exception, handler)
+        end
+
+        def process(exception, handler)
+          match?(exception) ? handle(exception, handler) : nil
+        end
+      end
+
+      ErrorHandler = Struct.new(:code, :proc) do
+        def match?(error)
+          error.code == self.code
+        end
+
+        def handle(error, client)
+          proc.call(error, client)
+        end
+
+        def process(error, client)
+          match?(error) ? handle(error, client) : nil
+        end
+      end
+
+      class << self
+        # translate_exception InvalidArgument, :invalid_argument
+        #
+        # translate_exception StandardError { |exception, service| Twirp::Error.internal_with exception }
+        def translate_exception(*exceptions, with: nil, &block)
+          raise 'unexpected with and block' if block_given? && with
+          raise 'with or block must be defined' unless block_given? || with
+
+
+          proc = if with
+                   raise "invalid twirp code #{with}" unless ::Twirp::ERROR_CODES.include?(with)
+
+                   proc do |exception, _service|
+                     ::Twirp::Error.new(with, exception.message).tap { |t| t.cause = exception }
+                   end
+                 else
+                   proc { |exception, service| block.call(exception, service) }
+                 end
+
+          exceptions.each do |exception|
+            exception_handlers << ExceptionHandler.new(exception, proc)
+          end
+        end
+
+        # translate_error :invalid_argument, InvalidArgument
+        #
+        # translate_error :internal_error { |error, client| StandardError.new(error.msg) }
+        def translate_error(*codes, with: nil, &block)
+          raise 'unexpected with and block' if block_given? && with.nil?
+          raise 'with or block must be defined' unless block_given? || !with.nil?
+          raise "invalid twirp code(s) #{codes - ::Twirp::ERROR_CODES}" if (codes - ::Twirp::ERROR_CODES).any?
+
+          proc = if with
+                   raise 'with should be a exception class' unless with.is_a?(Class)
+
+                   proc { |error, _client| with.new error.msg }
+                 else
+                   proc { |error, client| block.call(error, client) }
+                 end
+
+          codes.each do |code|
+            error_handlers << ErrorHandler.new(code, proc)
+          end
+        end
+
+        def exception_handlers
+          @exception_handlers ||= []
+        end
+
+        def error_handlers
+          @error_handlers ||= []
+        end
+
+        def exception_to_twirp(exception, handler)
+          result = nil
+
+          exception_handlers.take_while do |exception_handler|
+            result = exception_handler.process(exception, handler)
+
+            result.nil?
+          end
+
+          result || ::Twirp::Error.internal_with(exception)
+        end
+
+        def twirp_to_exception(error, client)
+          result = nil
+
+          error_handlers.take_while do |handler|
+            result = handler.process(error, client)
+
+            result.nil?
+          end
+
+          result || StandardError.new(error.msg)
+        end
+      end
+    end
+  end
+end
+

data/lib/twirp_rails/error_handling/error_handling.rb

@@ -0,0 +1,2 @@
+require 'twirp_rails/error_handling/base'
+require 'twirp_rails/error_handling/error_handling_factory'

data/lib/twirp_rails/error_handling/error_handling_factory.rb

@@ -0,0 +1,82 @@
+module TwirpRails
+  class ErrorHandlingFactory
+    class HandlerProxy
+      attr_reader :handler, :translator_class
+
+      def initialize(handler, translator_class)
+        @handler = handler
+        @translator_class = translator_class
+      end
+
+      # rubocop:disable Style/MethodMissingSuper
+      def method_missing(method, *args)
+        handler.public_send method, *args
+      rescue => e
+        translator_class.exception_to_twirp(e, handler)
+      end
+      # rubocop:enable Style/MethodMissingSuper
+
+      def respond_to_missing?(method)
+        handler.respond_to?(method)
+      end
+    end
+
+    class ClientProxy
+      attr_reader :client, :translator_class
+
+      def initialize(client, translator_class)
+        @client = client
+        @translator_class = translator_class
+      end
+
+      def raise_on_error(twirp_result)
+        if twirp_result.error
+          exception = translator_class.twirp_to_exception(twirp_result.error)
+          raise exception
+        else
+          twirp_result
+        end
+      end
+
+      # rubocop:disable Style/MethodMissingSuper
+      def method_missing(method, *args)
+        if method =~ /!$/
+          # when we call a bang version of client method - raise exception translated from error
+          method = method[0..-2]
+          raise_on_error client.public_send(method, args)
+        else
+          client.public_send method, args
+        end
+      end
+      # rubocop:enable Style/MethodMissingSuper
+
+      def respond_to_missing?(method)
+        handler.respond_to?(method)
+      end
+    end
+
+    class << self
+      attr_reader :translator_class
+
+      def wrap_handler(handler)
+        enable_handling? ? HandlerProxy.new(handler, translator_class) : handler
+      end
+
+      def wrap_client(client)
+        enable_handling? ? ClientProxy.new(client, translator_class) : client
+      end
+
+      def enable_handling?
+        if @enable_handling.nil?
+          if (@translator_class = TwirpRails.configuration.twirp_exception_translator_class)
+            @translator_class = @translator_class.constantize unless @translator_class.is_a?(Class)
+            @enable_handling = true
+          else
+            @enable_handling = false
+          end
+        end
+        @enable_handling
+      end
+    end
+  end
+end

data/lib/twirp_rails/generators/twirp/init/templates/twirp_rails.rb

@@ -25,4 +25,18 @@ TwirpRails.configure do |config|
   #
   # Add API acronym to inflector
   # config.add_api_acronym = true
+  #
+  # Translate exceptions to Twirp::Error on services and
+  # Twirp::Error to exceptions. To use service translation you
+  # should mount service via mount_twirp. To use client translation
+  # create client via TwirpRails.client(ClientClass, url) and
+  # call bang methods. E.g. client.hello! throws exception if returns error.
+  #
+  # class SampleTranslator < TwirpRails::ErrorHandling::Base
+  #   translate_exception Mongoid::Errors::DocumentNotFound, with: :not_found
+  #   translate_error :not_found, with: Mongoid::Errors::DocumentNotFound
+  # end
+  # config.twirp_exception_translator_class = 'SampleTranslator'
+  # default:
+  # config.twirp_exception_translator_class = nil
 end

data/lib/twirp_rails/routes.rb

@@ -25,7 +25,7 @@ module TwirpRails
             raise 'twirp service name required'
           end
 
-          service = service_class.new(handler.new)
+          service = service_class.new(ErrorHandlingFactory.wrap_handler(handler.new))
           Helper.run_create_hooks service
 
           if scope

data/lib/twirp_rails/rspec/helper.rb

@@ -65,7 +65,7 @@ module TwirpRails
       end
 
       included do
-        let(:handler) { described_class.new }
+        let(:handler) { TwirpRails::ErrorHandlingFactory.wrap_handler(described_class.new) }
         let(:service) { service_class.new(handler) }
       end
     end

data/lib/twirp_rails/version.rb

@@ -1,3 +1,3 @@
 module TwirpRails
-  VERSION = '0.4.3'.freeze
+  VERSION = '0.4.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twirp_rails
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Alexandr Zimin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-14 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twirp
@@ -142,6 +142,9 @@ files:
 - lib/twirp_rails.rb
 - lib/twirp_rails/active_record_extension.rb
 - lib/twirp_rails/engine.rb
+- lib/twirp_rails/error_handling/base.rb
+- lib/twirp_rails/error_handling/error_handling.rb
+- lib/twirp_rails/error_handling/error_handling_factory.rb
 - lib/twirp_rails/generators/generators.rb
 - lib/twirp_rails/generators/twirp/USAGE
 - lib/twirp_rails/generators/twirp/clients/USAGE