rails_twirp 0.5.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8df8457b09993d7d5c986130e724948df049c201b6797f33a7b66458bde98918
-  data.tar.gz: 0a2100cbefd37754f9dbd6cf666def1c29d0936322f72837d7e60653b5510b79
+  metadata.gz: '054689e120dd41594071de17cd6e8967886699ec4f75bd08aceae475a2e12e03'
+  data.tar.gz: 56b1471b8103f249c9c2d53fe78b2aa31a978c67f3a1b658e15923534a4a3b63
 SHA512:
-  metadata.gz: 1b50c23cd6fa8852686ca96066c0a65a532f06ec0225b5ed04ac860218760d187e868d0b3d499855527ed23d355dacf8bf33eb1aaf2fd1b590b29aa12c8e836a
-  data.tar.gz: 461fe47bbafdd0bcf304f48b4938f307fd380d7bbce7049a703c60f7bc781b0f58b1cf06b7410c4a168e39441b1a9bd49b5091a0dbfc3472870c002bef6f51e1
+  metadata.gz: b3630e5152913b1bca04ca94ab0d15bdce29f6853a4cafb226c4e5f678042e8a1bbcd6e931b20432d816556ef5f087512e4ad09327e5bbfa3af72e97bcce9a5f
+  data.tar.gz: bace8057362c6085ba5edea873087b5b4459f6c0dc48e5abeea589380abcd64386dfedfcd41cc2a841f69721b3d852a8516aaf06522df843d8b09e902879842e

data/Gemfile

@@ -4,5 +4,6 @@ source "https://rubygems.org"
 gemspec
 
 gem "sqlite3"
-gem "pbbuilder", "~> 0.3.0"
+gem "pbbuilder", "~> 0.10.0"
 gem "standard"
+gem "pry"

data/lib/rails_twirp/base.rb

@@ -10,6 +10,8 @@ require "abstract_controller/callbacks"
 require "action_controller/metal/helpers"
 require "rails_twirp/rescue"
 require "rails_twirp/url_for"
+require "rails_twirp/implicit_render"
+require "rails_twirp/instrumentation"
 
 module RailsTwirp
   class Base < AbstractController::Base
@@ -24,15 +26,16 @@ module RailsTwirp
     include UrlFor
     include AbstractController::AssetPaths
     include AbstractController::Caching
-    include AbstractController::Logger
 
     include ActionView::Rendering
     include RenderPb
     include Errors
+    include ImplicitRender
 
     # These need to be last so errors can be handled as early as possible.
     include AbstractController::Callbacks
     include Rescue
+    include Instrumentation
 
     attr_internal :request, :env, :response_class
     def initialize
@@ -55,8 +58,6 @@ module RailsTwirp
 
       process(action)
 
-      # Implicit render
-      self.response_body = render unless response_body
       response_body
     end
 

data/lib/rails_twirp/implicit_render.rb

@@ -0,0 +1,11 @@
+require "action_controller/metal/basic_implicit_render"
+
+module RailsTwirp
+  module ImplicitRender
+    include ActionController::BasicImplicitRender
+
+    def default_render
+      render
+    end
+  end
+end

data/lib/rails_twirp/instrumentation.rb

@@ -0,0 +1,32 @@
+module RailsTwirp
+  module Instrumentation
+    extend ActiveSupport::Concern
+
+    include AbstractController::Logger
+
+    def process_action(*)
+      raw_payload = {
+        controller: self.class.name,
+        action: action_name,
+        request: request,
+        http_request: http_request,
+        headers: http_request.headers,
+        path: http_request.fullpath
+      }
+
+      ActiveSupport::Notifications.instrument("start_processing.rails_twirp", raw_payload)
+
+      ActiveSupport::Notifications.instrument("process_action.rails_twirp", raw_payload) do |payload|
+        result = super
+        if response_body.is_a?(Twirp::Error)
+          payload[:code] = response_body.code
+          payload[:msg] = response_body.msg
+        else
+          payload[:code] = :success
+        end
+        payload[:response] = response_body
+        result
+      end
+    end
+  end
+end

data/lib/rails_twirp/log_subscriber.rb

@@ -0,0 +1,64 @@
+require "active_support/log_subscriber"
+
+module RailsTwirp
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    def start_processing(event)
+      return unless logger.info?
+
+      payload = event.payload
+
+      info "Processing by #{payload[:controller]}##{payload[:action]}"
+    end
+
+    def process_action(event)
+      payload = event.payload
+      exception_raised(payload[:http_request], payload[:exception_object]) if payload[:exception_object]
+
+      info do
+        code = payload.fetch(:code, :internal)
+
+        message = +"Completed #{code} in #{event.duration.round}ms (Allocations: #{event.allocations})"
+        message << "\n\n" if defined?(Rails.env) && Rails.env.development?
+
+        message
+      end
+    end
+
+    private
+
+    def exception_raised(request, exception)
+      backtrace_cleaner = request.get_header("action_dispatch.backtrace_cleaner")
+      wrapper = ActionDispatch::ExceptionWrapper.new(backtrace_cleaner, exception)
+
+      log_error(wrapper)
+    end
+
+    def log_error(wrapper)
+      exception = wrapper.exception
+      trace = wrapper.exception_trace
+
+      message = []
+      message << "  "
+      message << "#{exception.class} (#{exception.message}):"
+      message.concat(exception.annotated_source_code) if exception.respond_to?(:annotated_source_code)
+      message << "  "
+      message.concat(trace)
+
+      log_array(message)
+    end
+
+    def log_array(array)
+      lines = Array(array)
+
+      return if lines.empty?
+
+      if logger.formatter&.respond_to?(:tags_text)
+        fatal { lines.join("\n#{logger.formatter.tags_text}") }
+      else
+        fatal { lines.join("\n") }
+      end
+    end
+  end
+end
+
+RailsTwirp::LogSubscriber.attach_to :rails_twirp

data/lib/rails_twirp/route_set.rb

@@ -50,13 +50,13 @@ module RailsTwirp
           method_name = rpc_info[:ruby_method]
 
           # Stolen from Rails in ActionDispatch::Request#controller_class_for
-          controller_name = mapping.controller.underscore
-          const_name = controller_name.camelize << "Controller"
           action_name = mapping.action
           response_class = rpc_info[:output_class]
 
           handler.define_method(method_name) do |req, env|
-            controller_class = ::ActiveSupport::Dependencies.constantize(const_name)
+            controller_name = mapping.controller.underscore
+            const_name = controller_name.camelize << "Controller"
+            controller_class = const_name.constantize
             controller_class.dispatch(action_name, req, response_class, env)
           end
         end

data/lib/rails_twirp/testing/integration_test.rb

@@ -1,6 +1,13 @@
+require "twirp/encoding"
+
 module RailsTwirp
   class IntegrationTest < ActiveSupport::TestCase
+    DEFAULT_HOST = "www.example.com"
+    Response = Struct.new(:status, :body, :headers)
+
     attr_reader :response, :request, :controller
+    attr_writer :mount_path
+    alias_method :mount_path!, :mount_path=
 
     def initialize(name)
       super
@@ -8,9 +15,27 @@ module RailsTwirp
       @before_rpc = []
     end
 
+    def host
+      @host || DEFAULT_HOST
+    end
+    attr_writer :host
+    alias_method :host!, :host=
+
+    def https?
+      @https
+    end
+
+    def https!(value = true)
+      @https = value
+    end
+
     def reset!
       @request = nil
       @response = nil
+      @host = nil
+      @host = nil
+      @https = false
+      @mount_path = "/twirp"
     end
 
     def before_rpc(&block)
@@ -19,32 +44,63 @@ module RailsTwirp
 
     def rpc(service, rpc, request, headers: nil)
       @request = request
-      service = app.twirp.routes.services[service].to_service
-
-      rack_env = {
-        "HTTP_HOST" => "localhost"
-      }
-      http_request = ActionDispatch::Request.new(rack_env)
-      http_request.headers.merge! headers if headers.present?
-      env = {rack_env: rack_env}
 
+      env = build_rack_env(service, rpc, request, headers)
       @before_rpc.each do |hook|
         hook.call(env)
       end
 
-      response = begin
-        service.call_rpc rpc, request, env
-      rescue => e
-        Twirp::Error.internal_with(e)
-      end
+      status, headers, body = app.call(env)
+      @response = decode_rack_response(service, rpc, status, headers, body)
+      set_controller_from_rack_env(env)
 
-      @response = response
-      @controller = http_request.controller_instance
-      response
+      @response
     end
 
     def app
       RailsTwirp.test_app
     end
+
+    private
+
+    def build_rack_env(service, rpc, request, headers)
+      env = {
+        "CONTENT_TYPE" => request_content_type,
+        "HTTPS" => https? ? "on" : "off",
+        "HTTP_HOST" => host,
+        "PATH_INFO" => "#{@mount_path}/#{service.service_full_name}/#{rpc}",
+        "REQUEST_METHOD" => "POST",
+        "SERVER_NAME" => host,
+        "SERVER_PORT" => https? ? "443" : "80",
+        "rack.url_scheme" => https? ? "https" : "http"
+      }
+      if headers.present?
+        http_request = ActionDispatch::Request.new(env)
+        http_request.headers.merge! headers
+      end
+
+      input_class = service.rpcs[rpc][:input_class]
+      env["rack.input"] = StringIO.new(Twirp::Encoding.encode(request, input_class, request_content_type))
+      env
+    end
+
+    def request_content_type
+      Twirp::Encoding::PROTO
+    end
+
+    def decode_rack_response(service, rpc, status, headers, body)
+      body = body.join # body is an Enumerable
+
+      if status === 200
+        output_class = service.rpcs[rpc][:output_class]
+        Twirp::Encoding.decode(body, output_class, headers["Content-Type"])
+      else
+        Twirp::Client.error_from_response(Response.new(status, body, headers))
+      end
+    end
+
+    def set_controller_from_rack_env(env)
+      @controller = ActionDispatch::Request.new(env).controller_class
+    end
   end
 end

data/lib/rails_twirp/version.rb

@@ -1,3 +1,3 @@
 module RailsTwirp
-  VERSION = "0.5.0"
+  VERSION = "0.7.2"
 end

data/lib/rails_twirp.rb

@@ -4,6 +4,7 @@ require "rails_twirp/application"
 require "rails_twirp/base"
 require "rails_twirp/route_set"
 require "rails_twirp/testing/integration_test"
+require "rails_twirp/log_subscriber"
 
 module RailsTwirp
   mattr_accessor :test_app

data/rails_twirp.gemspec

@@ -12,6 +12,6 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files`.split("\n")
   spec.test_files = `git ls-files -- test/*`.split("\n")
 
-  spec.add_dependency "rails", "~> 6.1.3"
+  spec.add_dependency "rails", ">= 6.1.3"
   spec.add_dependency "twirp", "~> 1.7.2"
 end

data/test/dummy/config/twirp/routes.rb

@@ -1,4 +1,4 @@
-require "api_twirp"
+require_relative "../../proto/api_twirp"
 
 Rails.application.twirp.routes.draw do
   service RPC::DummyAPI::DummyService do

data/test/ping_controller_test.rb

@@ -11,7 +11,16 @@ class PingControllerTest < RailsTwirp::IntegrationTest
     req = RPC::DummyAPI::PingRequest.new(name: "Bouke")
     rpc RPC::DummyAPI::DummyService, "PingRender", req
     refute_instance_of Twirp::Error, response
-    assert_equal "http://localhost/twirp BoukeBouke", response.double_name
+    assert_equal "http://www.example.com/twirp BoukeBouke", response.double_name
+  end
+
+  test "you can ping render with host and https" do
+    host! "localhost"
+    https!
+    req = RPC::DummyAPI::PingRequest.new(name: "Bouke")
+    rpc RPC::DummyAPI::DummyService, "PingRender", req
+    refute_instance_of Twirp::Error, response
+    assert_equal "https://localhost/twirp BoukeBouke", response.double_name
   end
 
   test "you can ping template" do

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: rails_twirp
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.3
 - !ruby/object:Gem::Dependency
@@ -59,6 +59,9 @@ files:
 - lib/rails_twirp/base.rb
 - lib/rails_twirp/engine.rb
 - lib/rails_twirp/errors.rb
+- lib/rails_twirp/implicit_render.rb
+- lib/rails_twirp/instrumentation.rb
+- lib/rails_twirp/log_subscriber.rb
 - lib/rails_twirp/mapper.rb
 - lib/rails_twirp/render_pb.rb
 - lib/rails_twirp/rescue.rb
@@ -151,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Integrate Twirp into Rails