twirp-on-rails 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f09ec24234c61ab85dc6ab6e03768c16e4fa7110fe5e5771240ca94633996eb
-  data.tar.gz: 569db17177ad607e4de0a9f94cf380857c48e408f5e7937ed951bd549d5a0431
+  metadata.gz: c7200f05274651a90db8bd46ff410667dce35b41bb49da9a084f7a5c35fd6e1b
+  data.tar.gz: d7a993fea396f5449315431cb545f49f0b417ee31aa82b7626d451a65a224985
 SHA512:
-  metadata.gz: 542712540c037f4be6ac5f322f45f72a44f55705eb813f941769317afcb17ce1853089524cdf725c61bad411fc73a8ae8be7428a8b3846df6ae9604581d5f90e
-  data.tar.gz: be401e0761378d95a08bc4d493582450cf5e979e288f578d63c25dd00a69bcc7033b16f77fb31bf0100c2dc1c5a7007fe1c69a8140410b0b4ee5f2238ecfd499
+  metadata.gz: 4cb878f46022e40efe060ee312954d2bc6432ecd7fffbac2949173e2f13531f4992665fd2e218d7d6b5308740df5e6acd1ed46b7310ed03a1429f435e94c27a0
+  data.tar.gz: 6a803bf6af2df2a8594cfcbc0b8844fc02651d1fc78d6241a25bd80ed9885b8cb3c0f63fba11bb1351000caf62f53400fc46f4478cb7713af6963f6c2e3912e0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [1.3.0] - 2025-01-20
+
+- Add some logging.
+
+## [1.2.0] - 2024-10-04
+
+- Support rescue_from in handlers.
+
 ## [1.1.0] - 2024-09-12
 
 - Respect package namespace when looking for handlers.

data/Gemfile

@@ -9,7 +9,11 @@ gem "rake"
 
 gem "debug"
 gem "rspec-rails"
-gem "sqlite3", "~> 1.4"
 gem "standard", ">= 1.35.1"
 gem "standard-performance"
 gem "standard-rails"
+
+# These standard library gems need to be here for with certain Rails 7/Ruby 3.4 combinations. Delete eventually.
+gem "mutex_m"
+gem "bigdecimal"
+gem "drb"

data/README.md

@@ -111,6 +111,22 @@ TODO: Give more examples of handlers
 
 Use `before_action`, `around_action`, and other callbacks you're used to, as we build on [AbstractController::Callbacks](https://api.rubyonrails.org/classes/AbstractController/Callbacks.html).
 
+### rescue_from
+
+Use `rescue_from` just like you would in a controller: 
+
+```ruby
+class HaberdasherServiceHandler < Twirp::Rails::Handler
+  rescue_from "ArgumentError" do |error|
+    Twirp::Error.invalid_argument(error.message)
+  end
+
+  rescue_from "Pundit::NotAuthorizedError", :not_authorized
+
+  ...
+end
+```
+
 ### DRY Service Hooks
 
 Apply [Service Hooks](https://github.com/twitchtv/twirp-ruby/wiki/Service-Hooks) one time across multiple services.
@@ -135,6 +151,22 @@ As an Engine, we avoid all the standard Rails middleware. That's nice for simpli
 Rails.application.config.twirp.middleware = [Rack::Deflater]
 ```
 
+### Logging
+
+Our built-in logging outputs the result of each request. 
+
+You could replace our logger if you want different output: 
+
+```ruby
+Rails.application.config.twirp.logger = Rack::CommonLogger
+```
+
+Additionally, you can log the full Twirp response object to help with debugging: 
+
+```ruby
+Rails.application.config.twirp.verbose_logging = true
+```
+
 ## Bonus Features
 
 Outside the [Twirp spec](https://twitchtv.github.io/twirp/docs/spec_v7.html), we have some (optional) extra magic. They might be useful to you, but you can easily ignore them too.
@@ -154,6 +186,8 @@ Rails.application.config.twirp.middleware = [
 ]
 ```
 
+Note: The Handler will still be run, but you won't need to send back the response. Make sure your RPC is idempotent! Future versions hope to make it easier to short-circuit expensive parts of the handler. 
+
 ## TODO
 
 * More docs!

data/lib/twirp/rails/configuration.rb

@@ -9,6 +9,15 @@ module Twirp
       # Where to mount twirp routes. Defaults to /twirp
       attr_accessor :endpoint
 
+      # Logger to use for Twirp requests. Defaults to Rails.logger
+      attr_accessor :logger
+
+      # Whether to log full Twirp responses. Can be useful for debugging, but can expose sensitive data.
+      # Defauts to false
+      # Example:
+      #   Twirp Response: <Twirp::Example::Haberdasher::Hat: inches: 24, color: "Tan", name: "Pork Pie">
+      attr_accessor :verbose_logging
+
       # An array of directories to search for *_twirp.rb files
       # Defaults to ["lib"]
       attr_accessor :load_paths
@@ -25,6 +34,8 @@ module Twirp
         @auto_mount = false
         @endpoint = "/twirp"
         @load_paths = ["lib"]
+        @logger = Logger
+        @verbose_logging = false
         @middleware = []
         @service_hooks = {}
       end

data/lib/twirp/rails/engine.rb

@@ -26,26 +26,45 @@ module Twirp
           app.config.twirp.send(key)
         end
 
+        # Set up logging
+        app.config.middleware.use app.config.twirp.logger, ::Rails.logger
         app.config.twirp.middleware.each do |middleware|
           app.config.middleware.use middleware
         end
+
+        # Load all Twirp files
+        app.config.twirp.load_paths.each do |directory|
+          ::Rails.root.glob("#{directory}/**/*_twirp.rb").sort.each { |file| require file }
+        end
       end
     end
 
     class << self
       def services
         if @services.nil?
-          ::Rails.application.config.twirp.load_paths.each do |directory|
-            ::Rails.root.glob("#{directory}/**/*_twirp.rb").sort.each { |file| require file }
-          end
-
           @services = Twirp::Service.subclasses.map(&:new)
 
           # Install hooks that may be defined in the config
           @services.each do |service|
+            # Add user-defined hooks
             ::Rails.application.config.twirp.service_hooks.each do |hook_name, hook|
               service.send(hook_name, &hook)
             end
+
+            # Add our own logging hooks
+            service.on_success do |env|
+              if ::Rails.application.config.twirp.verbose_logging
+                ::Rails.logger.debug { "Twirp Response: #{env[:output].inspect}" }
+              end
+            end
+
+            service.on_error do |error, _env|
+              ::Rails.logger.debug { "Twirp Response: #{error.inspect}" }
+            end
+
+            service.exception_raised do |exception, _env|
+              ::Rails.logger.error { "Twirp Exception (#{exception.class}: #{exception.message})\n#{exception.backtrace.join("\n")}" }
+            end
           end
         end
 
@@ -54,11 +73,3 @@ module Twirp
     end
   end
 end
-
-class Twirp::Service
-  # Override inspect to show all available RPCs
-  # This is used when displaying routes.
-  def inspect
-    self.class.rpcs.map { |rpc| "#{self.class.name.demodulize.underscore}_handler##{rpc[1][:ruby_method]}" }.join("\n")
-  end
-end

data/lib/twirp/rails/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Twirp
+  module Rails
+    class Error < StandardError
+    end
+  end
+end

data/lib/twirp/rails/handler.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "rescuable" # Ruby 2.7 fails without this. Remove eventually.
+
 module Twirp
   module Rails
     class Handler
       include Twirp::Rails::Callbacks
+      include ActiveSupport::Rescuable
+      using Twirp::Rails::Rescuable
 
       attr_reader :request, :env
       attr_reader :action_name
@@ -34,7 +38,11 @@ module Twirp
         ActiveSupport::Notifications.instrument("handler_run_callbacks.twirp_rails", handler: self.class.name, action: action_name, env: @env, request: @request) do
           run_callbacks(:process_action) do
             ActiveSupport::Notifications.instrument("handler_run.twirp_rails", handler: self.class.name, action: action_name, env: @env, request: @request) do |payload|
-              payload[:response] = send_action(name)
+              payload[:response] = begin
+                send_action(name)
+              rescue => exception
+                rescue_with_handler_and_return(exception) || raise
+              end
             end
           end
         end

data/lib/twirp/rails/logger.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Rack::CommonLogger is nice but we can do better.
+# Rails doesn't use it, but we need to log Twirp requests.
+# Here's an example from Rack::CommonLogger:
+#   127.0.0.1 - - [12/Jan/2025:17:09:49 -0500] "POST /twirp/twirp.example.haberdasher.Haberdasher/MakeHat HTTP/1.0" 200 - 439.0060
+#
+# Rails gives us this:
+#   Started POST "/twirp/twirp.example.haberdasher.Haberdasher/MakeHat" for 127.0.0.1 at 2025-01-12 22:48:00 -0500
+# but we also want to know the result of the Twirp call.
+# Here's what this Logger adds:
+#   Twirp 200 in 2ms as application/protobuf
+#
+
+module Twirp
+  module Rails
+    class Logger < ::Rack::CommonLogger
+      private
+
+      def log(env, status, response_headers, began_at)
+        content_type = response_headers["content-type"].presence
+        content_encoding = response_headers["content-encoding"].presence
+        @logger.info { "Twirp #{status} in #{duration_in_ms(began_at)}ms#{" as #{content_type}" if content_type}#{" with content-encoding: #{content_encoding}" if content_encoding}" }
+      end
+
+      def duration_in_ms(time)
+        ((::Rack::Utils.clock_time - time) * 1000).to_i
+      end
+    end
+  end
+end

data/lib/twirp/rails/rescuable.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Twirp
+  module Rails
+    module Rescuable
+      refine ::ActiveSupport::Rescuable::ClassMethods do
+        # A slightly altered version of ActiveSupport::Rescuable#rescue_with_handler
+        # that returns the result rather than the handled exception
+        def rescue_with_handler_and_return(exception, object: self, visited_exceptions: [])
+          visited_exceptions << exception
+
+          if (handler = handler_for_rescue(exception, object: object))
+            handler.call exception
+          elsif exception
+            if visited_exceptions.include?(exception.cause)
+              nil
+            else
+              rescue_with_handler(exception.cause, object: object, visited_exceptions: visited_exceptions)
+            end
+          end
+        end
+      end
+
+      refine ::ActiveSupport::Rescuable do
+        def rescue_with_handler_and_return(exception)
+          self.class.rescue_with_handler_and_return exception, object: self
+        end
+      end
+    end
+  end
+end

data/lib/twirp/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Twirp
   module Rails
-    VERSION = "1.1.0"
+    VERSION = "1.3.0"
   end
 end

data/lib/twirp/rails.rb

@@ -1,30 +1,30 @@
 # frozen_string_literal: true
 
-require_relative "rails/version"
+require "twirp"
+require "active_support/notifications"
 
-module Twirp
-  module Rails
-    class Error < StandardError; end
-    # Your code goes here...
-  end
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem_extension(Twirp)
+loader.ignore("#{__dir__}/on/rails.rb")
+loader.setup
+
+module Twirp::Rails
 end
 
-require "twirp"
-require "active_support/notifications"
-require_relative "rails/callbacks"
-require_relative "rails/configuration"
-require_relative "rails/dispatcher"
-require_relative "rails/engine"
-require_relative "rails/handler"
+loader.eager_load
+
+Twirp::Service.class_eval do
+  # Override initialize to make handler argument optional.
+  # When left nil, we will use our dispatcher.
+  alias_method :original_initialize, :initialize
+  def initialize(handler = nil)
+    handler ||= Twirp::Rails::Dispatcher.new(self.class)
+    original_initialize(handler)
+  end
 
-module Twirp
-  class Service
-    # Override initialize to make handler argument optional.
-    # When left nil, we will use our dispatcher.
-    alias_method :original_initialize, :initialize
-    def initialize(handler = nil)
-      handler ||= Twirp::Rails::Dispatcher.new(self.class)
-      original_initialize(handler)
-    end
+  # Override inspect to show all available RPCs
+  # This is used when displaying routes.
+  def inspect
+    self.class.rpcs.map { |rpc| "#{self.class.name.demodulize.underscore}_handler##{rpc[1][:ruby_method]}" }.join("\n")
   end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twirp-on-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Daniel Morrison
 - Darron Schall
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -61,8 +60,11 @@ files:
 - lib/twirp/rails/configuration.rb
 - lib/twirp/rails/dispatcher.rb
 - lib/twirp/rails/engine.rb
+- lib/twirp/rails/error.rb
 - lib/twirp/rails/handler.rb
+- lib/twirp/rails/logger.rb
 - lib/twirp/rails/rack/conditional_post.rb
+- lib/twirp/rails/rescuable.rb
 - lib/twirp/rails/version.rb
 - sig/twirp/rails.rbs
 - twirp-rails.gemspec
@@ -73,7 +75,6 @@ metadata:
   homepage_uri: https://github.com/collectiveidea/twirp-rails
   source_code_uri: https://github.com/collectiveidea/twirp-rails
   changelog_uri: https://github.com/collectiveidea/twirp-rails/blob/main/CHANGELOG.md
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -88,8 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Use Twirp RPC with Rails
 test_files: []