scout_apm 6.3.0 → 6.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe18e4045997fdf6b731025ee98c13e2702096a0cfd13ac5f0f651d7a7f4a4db
-  data.tar.gz: d9b4593ef2b8d5df4983d7b93cb9eaf5cc3f7e6916d8288ae9814e59dd913007
+  metadata.gz: 97692f03252aa5c2af4a4f87092742319b9088dace2f3dbcb4c48af766dfb848
+  data.tar.gz: 30bc39d151abec5d26723b2de0626319cf80685548a0f68da48074e283c72515
 SHA512:
-  metadata.gz: a5b838d8e12286496038899c7dd006b6c3d6507061bcba1a963fc10664fa96e36c603f71e315430eda9eeaa84dabadb21f91dee9e9aa9baf7009f6e03d8f3d9d
-  data.tar.gz: bee9ed547611139d56eb6f88cf6c1e730dc77dbdf575e89a8b1cd95f86756687174c78b64cf00acd389a74e90198f9750aec334e2dfba195340a0a9753c280bd
+  metadata.gz: 0c6a06a5e08a3a753a7110568f44d9c9c6b0163aeeabf3be281a2de9df6a2357f14515de7419c9dedd79e8f7e8266dca67cbf58b3dbac2e6efb54f283ba4d433
+  data.tar.gz: 13bacea25583bf396a3e4d0edee2e957a756296a3c4fcf6083a5a42b5e0bb2e57c90a9751dd6b04f7d86f0315d8c30222ba4d3d0c9c679aa2d73eb1eb38b2eb3

data/.gitignore

@@ -19,3 +19,4 @@ lib/*.bundle
 lib/*.so
 log/scout_apm.log
 gems/*.lock
+gems/vendor/

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # Pending
 
+# 6.3.1
+
+- Capture route names for Grape 4 (#635)
+
 # 6.3.0
 
 - Fix span leak on `ActionController::Live` streaming requests (#631)

data/gems/instruments-ruby4.gemfile

@@ -10,4 +10,5 @@ gem 'moped'
 gem 'actionpack'
 gem 'actionview'
 gem 'httpx'
+gem 'webmock'
 gem 'grape'

data/gems/instruments.gemfile

@@ -7,4 +7,9 @@ gem 'moped'
 gem 'actionpack'
 gem 'actionview'
 gem 'httpx'
+gem 'webmock'
 gem 'grape'
+# json 3.0 (released 2026-09) dropped the `quirks_mode` keyword that Grape 3's
+# ActiveSupport JSON formatter still passes, so any Grape 3 JSON request raises
+# ArgumentError. Pin to the 2.x line until this matrix moves off Grape 3.
+gem 'json', '< 3'

data/gems/typhoeus.gemfile

@@ -1,3 +1,4 @@
 eval_gemfile("../Gemfile")
 
 gem 'typhoeus'
+gem 'webmock'

data/lib/scout_apm/instruments/grape.rb

@@ -51,6 +51,36 @@ module ScoutApm
       end
     end
 
+    module GrapeEndpointNaming
+      # Grape >= 4 moved endpoint route metadata off the public `options`
+      # Hash and onto `Endpoint#config` (a Grape::Endpoint::Options Data
+      # object). Support both so the instrument works across Grape 3 and 4.
+      def self.name_for(endpoint)
+        # `config` is a protected reader on Grape::Endpoint, so a public
+        # respond_to? misses it: check with `true` and read via `send`.
+        if endpoint.respond_to?(:config, true) && endpoint.send(:config).respond_to?(:http_methods)
+          config = endpoint.send(:config)
+          method = config.http_methods && config.http_methods.first
+          api = config.api || (endpoint.respond_to?(:api) ? endpoint.api : nil)
+          path = config.path && config.path.first
+        else
+          method = endpoint.options[:method] && endpoint.options[:method].first
+          api = endpoint.options[:for]
+          path = endpoint.options[:path] && endpoint.options[:path].first
+        end
+
+        ["Grape",
+         method,
+         api.to_s,
+         endpoint.namespace.sub(%r{\A/}, ''), # removing leading slashes
+         path,
+        ].compact.map { |n| n.to_s }.join("/")
+      rescue => e
+        ScoutApm::Agent.instance.context.logger.info("Error getting Grape Endpoint Name. Error: #{e.message}. Options: #{endpoint.options.inspect}")
+        "Grape/Unknown"
+      end
+    end
+
     module GrapeEndpointInstruments
       def run_with_scout_instruments(*args)
         request = ::Grape::Request.new(env || args.first)
@@ -64,17 +94,7 @@ module ScoutApm
 
         req.set_headers(request.headers)
 
-        begin
-          name = ["Grape",
-                  self.options[:method].first,
-                  self.options[:for].to_s,
-                  self.namespace.sub(%r{\A/}, ''), # removing leading slashes
-                  self.options[:path].first,
-          ].compact.map{ |n| n.to_s }.join("/")
-        rescue => e
-          ScoutApm::Agent.instance.context.logger.info("Error getting Grape Endpoint Name. Error: #{e.message}. Options: #{self.options.inspect}")
-          name = "Grape/Unknown"
-        end
+        name = GrapeEndpointNaming.name_for(self)
 
         req.start_layer( ScoutApm::Layer.new("Controller", name) )
         begin
@@ -101,17 +121,7 @@ module ScoutApm
 
         req.set_headers(request.headers)
 
-        begin
-          name = ["Grape",
-                  self.options[:method].first,
-                  self.options[:for].to_s,
-                  self.namespace.sub(%r{\A/}, ''), # removing leading slashes
-                  self.options[:path].first,
-          ].compact.map{ |n| n.to_s }.join("/")
-        rescue => e
-          ScoutApm::Agent.instance.context.logger.info("Error getting Grape Endpoint Name. Error: #{e.message}. Options: #{self.options.inspect}")
-          name = "Grape/Unknown"
-        end
+        name = GrapeEndpointNaming.name_for(self)
 
         req.start_layer( ScoutApm::Layer.new("Controller", name) )
         begin

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "6.3.0"
+  VERSION = "6.3.1"
 end

data/test/unit/instruments/grape_test.rb

@@ -53,6 +53,31 @@ if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
       assert_includes body_content, 'hello'
     end
 
+    # Grape >= 4 moved endpoint route metadata (method/path/api) off the
+    # public `options` Hash and onto the protected `Endpoint#config` object.
+    # Reading the old `options[...]` keys under Grape 4 silently returns nil,
+    # so every request gets named "Grape/Unknown" instead of the real
+    # endpoint name.
+    def test_endpoint_name_reflects_the_route
+      captured_names = []
+      original_new = ScoutApm::Layer.method(:new)
+      ScoutApm::Layer.define_singleton_method(:new) do |type, name, *rest|
+        captured_names << name if type == "Controller"
+        original_new.call(type, name, *rest)
+      end
+
+      begin
+        status, _headers, _body = HelloAPI.call(Rack::MockRequest.env_for('/hello'))
+      ensure
+        ScoutApm::Layer.define_singleton_method(:new, original_new)
+      end
+
+      assert_equal 200, status
+      refute_empty captured_names
+      refute_equal "Grape/Unknown", captured_names.first
+      assert_equal "Grape/GET/#{HelloAPI}//hello", captured_names.first
+    end
+
     # Either instrumentation method is valid: alias_method is the default,
     # prepend is used when configured (`use_prepend`/`prepend_instruments`)
     # or when the instrument falls back to it for safety.

data/test/unit/instruments/httpx_test.rb

@@ -4,17 +4,34 @@ if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
   require 'scout_apm/instruments/httpx'
 
   require 'httpx'
+  require 'webmock'
 
   class HTTPXTest < Minitest::Test
+    include WebMock::API
+
     def setup
+      super # clears Thread.current[:scout_request] so a stale request from a
+            # prior test can't swallow this test's layers
+      WebMock.enable!
+      WebMock.disable_net_connect!
+
       @context = ScoutApm::AgentContext.new
       @recorder = FakeRecorder.new
       ScoutApm::Agent.instance.context.recorder = @recorder
       ScoutApm::Instruments::HTTPX.new(@context).install(prepend: false)
     end
 
+    def teardown
+      WebMock.reset!
+      WebMock.allow_net_connect!
+      WebMock.disable!
+      super
+    end
 
     def test_httpx
+      stub_request(:get, /news\.ycombinator\.com/).to_return(status: 200, body: "")
+      stub_request(:get, /google\.com/).to_return(status: 200, body: "")
+
       responses = HTTPX.get(
         "https://news.ycombinator.com/news",
         "https://news.ycombinator.com/news?p=2",
@@ -27,11 +44,18 @@ if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
     end
 
     def test_httpx_post_request
+      stub_request(:post, /httpbin\.org\/post/).to_return(status: 200, body: "")
+
       HTTPX.post("https://httpbin.org/post", json: { test: "data" })
       assert_recorded(@recorder, "HTTP", "POST", "httpbin.org/post")
     end
 
     def test_instruments_httpx_error_handling
+      # An error response still flows through Session#request, so the layer is
+      # started and stopped, and the request is recorded exactly once.
+      stub_request(:get, /thisshouldnotexistatall12345\.com/)
+        .to_return(status: 500, body: "")
+
       begin
         HTTPX.get("https://thisshouldnotexistatall12345.com")
       rescue
@@ -41,6 +65,10 @@ if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
     end
 
     def test_httpx_request_retry
+      # A timed-out request is still dispatched through Session#request, so the
+      # layer is recorded even though the response errors.
+      stub_request(:get, /httpbin\.org\/delay/).to_timeout
+
       begin
         HTTPX.with(timeout: { connect_timeout: 0.25, request_timeout: 0.25 })
              .get("https://httpbin.org/delay/5")
@@ -50,14 +78,17 @@ if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
     end
 
     def test_multiple_plugins
+      stub_request(:get, /news\.ycombinator\.com/).to_return(status: 200, body: "")
+      stub_request(:get, "http://httpbin.org/redirect/2")
+        .to_return(status: 302, headers: { "Location" => "http://httpbin.org/redirect/1" })
+      stub_request(:get, "http://httpbin.org/redirect/1")
+        .to_return(status: 302, headers: { "Location" => "http://httpbin.org/get" })
+      stub_request(:get, "http://httpbin.org/get").to_return(status: 200, body: "")
+
       session = HTTPX.plugin(:persistent).plugin(:follow_redirects)
 
       session.get("https://news.ycombinator.com/news")
-      begin
-        session.get("http://httpbin.org/redirect/2")
-      rescue
-        skip "httpbin.org not available"
-      end
+      session.get("http://httpbin.org/redirect/2")
 
       assert_equal 2, @recorder.requests.length, "Expected 2 requests to be recorded"
     end

data/test/unit/instruments/typhoeus_test.rb

@@ -4,15 +4,31 @@ if (ENV["SCOUT_TEST_FEATURES"] || "").include?("typhoeus")
   require 'scout_apm/instruments/typhoeus'
 
   require 'typhoeus'
+  require 'webmock'
 
   class TyphoeusTest < Minitest::Test
+    include WebMock::API
+
     def setup
+      super # clears Thread.current[:scout_request] so a stale request from a
+            # prior test can't swallow this test's layers
+      WebMock.enable!
+      WebMock.disable_net_connect!
+      stub_request(:any, /example\.com/).to_return(status: 200, body: "")
+
       @context = ScoutApm::AgentContext.new
       @recorder = FakeRecorder.new
       ScoutApm::Agent.instance.context.recorder = @recorder
       ScoutApm::Instruments::Typhoeus.new(@context).install(prepend: false)
     end
 
+    def teardown
+      WebMock.reset!
+      WebMock.allow_net_connect!
+      WebMock.disable!
+      super
+    end
+
     def test_instruments_typhoeus_hydra
       hydra = Typhoeus::Hydra.new
       2.times.map{ hydra.queue(Typhoeus::Request.new("example.com", followlocation: true)) }
@@ -39,4 +55,4 @@ if (ENV["SCOUT_TEST_FEATURES"] || "").include?("typhoeus")
       assert_equal desc, req.root_layer.desc if !desc.nil?
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.3.1
 platform: ruby
 authors:
 - Derek Haynes
@@ -523,7 +523,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Ruby application performance monitoring
 test_files: []