rails_twirp 0.15 → 0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e1b6e06cf246cc4ab4a639ca805033c8f96a24d2a1f468b733001b5f4ca9732
-  data.tar.gz: 4e03e912af4c785bbe9852245ed6e763e6d398c335dd63d4d0c4c3751402b814
+  metadata.gz: 4214210eff742236d7214ff558426f2dc9aed2e929b8e4ccb3c30777f5075bae
+  data.tar.gz: 8de1099ab7e26c27ce4c226325f7f0d535e5fe017e2fa4728e336b5293f767cb
 SHA512:
-  metadata.gz: 6cdc2a1d80937bbb85a513cc4807e9a91c5bd0848d5b959e90d226477231387c0e9250ec30bf7ff8da170c8cf64ca7136bcd47deb3fb23206797749bdbe624b8
-  data.tar.gz: 68c342ad35489011bc921dc4c7529d5ff7a18f47fce4aef9c597cebd2a789bdcec8050b6738cad457bcb54fce0b1c9f262558a964d42b26e1063a34f73f9d250
+  metadata.gz: a148e4b8363ac7eb45423eef57e98fd3d29cb10cca70ed43c178a453a1e0d6f47b17f22f061656195aa645f8afaeeaf0b58f5dcc3e637410ecb5789137d85f3d
+  data.tar.gz: 959f3beeac15882ad998b88733eb1f1a4f54a4d198c5293fabfe9d8c5acd583e84d9e0d32b02ef3b1d4dc9c0909b1eba537db5e62df98ec98651f9eec9ce9c0a

data/.github/workflows/test.yml

@@ -1,18 +1,24 @@
 name: Ruby Test
-on: push
+on: [push]
 
 jobs:
   test:
+    name: Ruby Tests
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.0", "3.1", "3.2", "3.3"]
+
     steps:
-      - name: Checkout code
+      - name: Checkout
         uses: actions/checkout@v3
 
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.3.0
           bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
 
       - name: Run tests
         run: bin/test

data/.standard.yml

@@ -1,3 +1 @@
-ignore:
-  - '**/*':
-    - Lint/RescueException
+ruby_version: 2.7

data/CHANGELOG.md

@@ -1,9 +1,15 @@
-### 0.15.0
+### 0.17
+* Adding support for rails 7.2. Mostly this was fixing the deprecation of `request.show_exceptions?` and support the various
+  values of `Rails.application.config.action_dispatch.show_exceptions`.
 
+### 0.16
+* Ensure `decode_rack_response` always calls `#close` on the Rack body in tests, as some middleware might be applying a BodyProxy
+
+### 0.15
 * Exclude versions of Rails 7 which were incompatible with the pbbuilder ActionView handler, as pbbuilder cannot work there at all
 * Fix decode_rack_response to be compatible with Rack response body wrappers (and conform to the Rack SPEC)
 
-### 0.14.0
+### 0.14
 * Adding frozen_string_literal: true to all files.
 
 ### 0.13.2
@@ -18,14 +24,14 @@
 * Include `ActionController::Caching` with Base controller/helpers
 
 
-### 0.12.0
+### 0.12
 
 * Allow a custom exception handling proc to be assigned using `RailsTwirp.unhandled_exception_handler`
 
-### 0.11.0
+### 0.11
 
 * Update configuration and tests for Rails 7 compatibility
 
-### 0.10.0
+### 0.10
 
 * Handle exceptions more like the Rails controllers do it, do not capture all of them as if they were Twirp exceptions

data/Gemfile

@@ -8,7 +8,6 @@ gemspec
 gem "sqlite3"
 gem "pbbuilder"
 gem "standard"
-gem "pry"
 
 # HACK(bouk): Overwrite Bundler's platform matcher to ignore universal CPU
 # The protobuf and gRPC 'universal' macOS gems break on M1

data/Rakefile

@@ -6,8 +6,27 @@ require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.verbose = false
+  t.libs << "lib"
+
+  # Running specific tests with line numbers, like with rails test, is not supported by default in rake.
+  # By setting the TESTOPS env var we can however specify the name of a single test with underscores instead of spaces.
+  # So run your single test by calling for ex:
+  #
+  # rake test /Users/sebastian/projects/cheddar/rails-twirp/test/ping_controller_test.rb "uncaught errors should bubble up to the test"
+
+  file_name = ARGV[1]
+  test_name = ARGV[2]&.tr(" ", "_")
+
+  ENV["TESTOPTS"] = "--verbose"
+
+  t.test_files = if file_name
+    if test_name
+      ENV["TESTOPTS"] += " --name=test_#{test_name}"
+    end
+    [file_name]
+  else
+    FileList["test/**/*_test.rb"]
+  end
 end
 
 task default: :test

data/lib/rails_twirp/exception_handling.rb

@@ -10,7 +10,7 @@ module RailsTwirp
 
     def process_action(*)
       super
-    rescue Exception => e
+    rescue => e
       # Only the exceptions which are not captured by ActionController-like "rescue_from" end up here.
       # The idea is that any exception which is rescued by the controller is treated as part of the business
       # logic, and thus taking action on it is the responsibility of the controller which uses "rescue_from".
@@ -18,9 +18,19 @@ module RailsTwirp
 
       # We adopt the same error handling logic as Rails' standard middlewares:
       # 1. When we 'show exceptions' we make the exception bubble up—this is useful for testing
-      #    If the exception gets raised here error reporting will happen in the middleware of the APM package
+      #    If the exception gets raised here, error reporting will happen in the middleware of the APM package
       #    higher in the call stack.
-      raise e unless http_request.show_exceptions?
+      #
+
+      # A backtrace cleaner acts like a filter that only shows us the backtrace
+      # with a selection of useful lines compared to all lines the code goes through.
+      backtrace_cleaner = http_request.get_header("action_dispatch.backtrace_cleaner")
+
+      # Contains various exception related methods we can use and takes the backtrace_cleaner into consideration.
+      exception_wrapper = ActionDispatch::ExceptionWrapper.new(backtrace_cleaner, e)
+      # ExceptionWrapper.show? contains the logic that chooses to pass exceptions through or not based on the
+      # `Rails.application.config.action_dispatch.show_exceptions` setting of :none, :rescuable and :all
+      raise e unless exception_wrapper.show?(http_request)
 
       # 2. We report the error to the error tracking service, this needs to be configured.
       RailsTwirp.unhandled_exception_handler&.call(e)

data/lib/rails_twirp/mapper.rb

@@ -59,10 +59,10 @@ module RailsTwirp
       @module = nil
     end
 
-    def service(service_definition, **, &block)
+    def service(service_definition, **kwargs, &block)
       service_route_set = @route_set.services[service_definition]
       service_mapper = ServiceMapper.new(service_route_set, self)
-      scope(**) { service_mapper.instance_exec(&block) }
+      scope(**kwargs) { service_mapper.instance_exec(&block) }
     end
 
     def scope(**options)

data/lib/rails_twirp/rescue.rb

@@ -9,8 +9,8 @@ module RailsTwirp
 
     def process_action(*)
       super
-    rescue Exception => exception
-      rescue_with_handler(exception) || raise
+    rescue => e
+      rescue_with_handler(e) || raise
     end
   end
 end

data/lib/rails_twirp/testing/integration_test.rb

@@ -91,14 +91,17 @@ module RailsTwirp
     end
 
     def decode_rack_response(service, rpc, status, headers, body)
-      body = Array.wrap(body).join # body is each-able
+      body_bytes = StringIO.new("".b)
+      body.each { |b| body_bytes << b }
 
       if status === 200
         output_class = service.rpcs[rpc][:output_class]
-        Twirp::Encoding.decode(body, output_class, headers["Content-Type"])
+        Twirp::Encoding.decode(body_bytes.string, output_class, headers["Content-Type"])
       else
-        Twirp::Client.error_from_response(Response.new(status, body, headers))
+        Twirp::Client.error_from_response(Response.new(status, body_bytes.string, headers))
       end
+    ensure
+      body.close if body.respond_to?(:close) # Comply with Rack API
     end
 
     def set_controller_from_rack_env(env)

data/lib/rails_twirp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsTwirp
-  VERSION = "0.15"
+  VERSION = "0.17"
 end

data/rails_twirp.gemspec

@@ -13,10 +13,9 @@ Gem::Specification.new do |spec|
 
   spec.files = `git ls-files`.split("\n")
 
-  # Rails has shipped an incompatible change in ActiveView, that was reverted in later versions.
-  # @see https://github.com/rails/rails/pull/51023
-  excluded_versions = ["7.1.0", "7.1.1", "7.1.2", "7.1.3"].map { |v| "!= #{v}" }
-  spec.add_runtime_dependency "rails", ">= 6.1.3", *excluded_versions
-  spec.add_runtime_dependency "twirp", ">= 1.9", "< 1.11"
+  spec.add_runtime_dependency "rails", ">= 6.1.3", "!= 7.1"
+  spec.add_runtime_dependency "twirp", ">= 1.9"
+  spec.add_development_dependency "pry"
+
   spec.required_ruby_version = ">= 3"
 end

data/test/dummy/config/environments/test.rb

@@ -28,8 +28,12 @@ Rails.application.configure do
   config.action_controller.perform_caching = false
   config.cache_store = :null_store
 
-  # Raise exceptions instead of rendering exception templates.
-  config.action_dispatch.show_exceptions = false
+  # Set to one of the following (default is :all):
+  #
+  # :all - render error pages for all exceptions
+  # :rescuable - render error pages for exceptions declared by config.action_dispatch.rescue_responses
+  # :none - raise all exceptions
+  config.action_dispatch.show_exceptions = :none
 
   # Disable request forgery protection in test environment.
   config.action_controller.allow_forgery_protection = false

data/test/ping_controller_test.rb

@@ -49,14 +49,16 @@ class PingControllerTest < RailsTwirp::IntegrationTest
   end
 
   test "uncaught errors should bubble up to the test" do
+    Rails.application.env_config["action_dispatch.show_exceptions"] = :none
+
     req = RPC::DummyAPI::PingRequest.new
     assert_raises StandardError, "Uncaught" do
       rpc RPC::DummyAPI::DummyService, "UncaughtError", req
     end
   end
 
-  test "uncaught errors should return an internal error with details if show_exceptions is true" do
-    Rails.application.env_config["action_dispatch.show_exceptions"] = true
+  test "uncaught errors should return an internal error with details if show_exceptions is all" do
+    Rails.application.env_config["action_dispatch.show_exceptions"] = :all
 
     req = RPC::DummyAPI::PingRequest.new
     rpc RPC::DummyAPI::DummyService, "UncaughtError", req
@@ -64,12 +66,10 @@ class PingControllerTest < RailsTwirp::IntegrationTest
     assert_equal :internal, response.code
     assert_equal "Uncaught", response.msg
     assert_equal "StandardError", response.meta["cause"]
-  ensure
-    Rails.application.env_config["action_dispatch.show_exceptions"] = false
   end
 
   test "uncaught errors should be fanned out to the exception handler proc if one is defined" do
-    Rails.application.env_config["action_dispatch.show_exceptions"] = true
+    Rails.application.env_config["action_dispatch.show_exceptions"] = :all
 
     captured_exception = nil
     RailsTwirp.unhandled_exception_handler = ->(e) { captured_exception = e }
@@ -83,11 +83,10 @@ class PingControllerTest < RailsTwirp::IntegrationTest
     assert_kind_of StandardError, captured_exception
   ensure
     RailsTwirp.unhandled_exception_handler = nil
-    Rails.application.env_config["action_dispatch.show_exceptions"] = false
   end
 
   test "uncaught errors should return an internal error without if show_exceptions is true and show_detailed_exceptions is false" do
-    Rails.application.env_config["action_dispatch.show_exceptions"] = true
+    Rails.application.env_config["action_dispatch.show_exceptions"] = :all
     Rails.application.env_config["action_dispatch.show_detailed_exceptions"] = false
 
     req = RPC::DummyAPI::PingRequest.new
@@ -97,7 +96,6 @@ class PingControllerTest < RailsTwirp::IntegrationTest
     assert_equal "Internal error", response.msg
   ensure
     Rails.application.env_config["action_dispatch.show_detailed_exceptions"] = true
-    Rails.application.env_config["action_dispatch.show_exceptions"] = false
   end
 
   test "before error" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_twirp
 version: !ruby/object:Gem::Version
-  version: '0.15'
+  version: '0.17'
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,16 +19,7 @@ dependencies:
         version: 6.1.3
     - - "!="
       - !ruby/object:Gem::Version
-        version: 7.1.0
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 7.1.1
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 7.1.2
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 7.1.3
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,16 +29,7 @@ dependencies:
         version: 6.1.3
     - - "!="
       - !ruby/object:Gem::Version
-        version: 7.1.0
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 7.1.1
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 7.1.2
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 7.1.3
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: twirp
   requirement: !ruby/object:Gem::Requirement
@@ -55,9 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.9'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -65,9 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.9'
-    - - "<"
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 description:
 email:
 - bouke@cheddar.me
@@ -78,7 +68,6 @@ files:
 - ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
-- ".ruby-version"
 - ".standard.yml"
 - CHANGELOG.md
 - Gemfile
@@ -191,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Integrate Twirp into Rails

data/.ruby-version

@@ -1 +0,0 @@
-3.3.0