scout_apm 6.2.1 → 6.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c667c4b7279ecdc5107a30bb50ac2a42eda6403a257f6bf2a05a6452c1143f18
-  data.tar.gz: d5183ae2f3fb7fbdfabae56616543f99503f59bb65b154e6709ea278f42166d3
+  metadata.gz: 97692f03252aa5c2af4a4f87092742319b9088dace2f3dbcb4c48af766dfb848
+  data.tar.gz: 30bc39d151abec5d26723b2de0626319cf80685548a0f68da48074e283c72515
 SHA512:
-  metadata.gz: bdc045802aa3d9cc37c147f6fd5a866e4bc3a3a49de480711595b3ca5b6dd04c314c2085bd229ccaebc0dca3125a7463f2bf0a53552adbb2caef8b0a09102de2
-  data.tar.gz: 07a522e00f9d86d4d03a57c5e8965a9fd724104881429c8acddf603c0a0ad8829d098f998b3e551a6a0751ab1ba60af0f2c077bab1c3528d988138d2f4c2268e
+  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,13 @@
 # Pending
 
+# 6.3.1
+
+- Capture route names for Grape 4 (#635)
+
+# 6.3.0
+
+- Fix span leak on `ActionController::Live` streaming requests (#631)
+
 # 6.2.1
 
 - Fix `SystemStackError` with `grape >= 3.3.0` by falling back to `prepend` instrumentation when Grape owns `Endpoint#run` itself (#624)

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/request_manager.rb

@@ -7,11 +7,23 @@ module ScoutApm
       find || create
     end
 
-    # Get the current Thread local, and detecting, and not returning a stale request
+    # Get the current Thread local, detecting and not returning a stale request,
+    # nor a request that belongs to a different thread.
     def self.find
       req = Thread.current[:scout_request]
+      return nil unless req
 
-      if req && (req.stopping? || req.recorded?)
+      # ActionController::Live runs the controller action in a child thread and
+      # copies the parent thread's raw Thread.current locals (including
+      # :scout_request) into it. Without this check the parent (Rack) thread and
+      # the child (streaming) thread would share and concurrently mutate a single
+      # TrackedRequest -- racing on @layers/@stopping -- which corrupts the layer
+      # stack, drops the transaction, and leaks layers across requests. If the
+      # resident request was created on a different thread, treat it as absent so
+      # lookup creates a fresh one owned by this thread.
+      return nil if req.creating_thread_id != Thread.current.object_id
+
+      if req.stopping? || req.recorded?
         nil
       else
         req

data/lib/scout_apm/tracked_request.rb

@@ -74,9 +74,20 @@ module ScoutApm
       @recorder = agent_context.recorder
       @real_request = false
       @transaction_id = ScoutApm::Utils::TransactionId.new.to_s
+      # The thread this request was created on. ActionController::Live copies the
+      # raw Thread.current locals (including :scout_request) into its streaming
+      # child thread, which would otherwise cause two threads to share and race
+      # on one TrackedRequest. RequestManager uses this to detect an inherited
+      # request and give the child its own instead. See RequestManager.find.
+      @creating_thread_id = Thread.current.object_id
       ignore_request! if @recorder.nil?
     end
 
+    # The object_id of the Thread that created this request. Used to detect a
+    # TrackedRequest that was inherited by a different thread (e.g. an
+    # ActionController::Live streaming thread) rather than created for it.
+    attr_reader :creating_thread_id
+
     def layer_count
       @layers.size
     end
@@ -368,14 +379,21 @@ module ScoutApm
       end
     end
 
-    # This request is a job transaction iff it has a 'Job' layer
-    # Use this only during recording
+    # True iff this request has a 'Job' layer. Only reliable during recording --
+    # see #web? for why.
     def job?
       layer_finder.job != nil
     end
 
-    # This request is a web transaction iff it has a 'Controller' layer
-    # Use this only during recording
+    # True iff this request has a 'Controller' layer.
+    #
+    # Only reliable during recording; returns false mid-request even for a real
+    # web request. #layer_finder walks root_layer's child *tree*, but layers are
+    # attached to that tree only in #stop_layer (via add_child), not in
+    # #start_layer. Controller/Job are top-level spans, so they stop last --
+    # meaning web?/job? only resolve as the request unwinds into recording.
+    # (Negative results aren't memoized, so an early false doesn't poison a
+    # later check.)
     def web?
       layer_finder.controller != nil
     end

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "6.2.1"
+  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

data/test/unit/request_manager_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+
+# Tests for RequestManager's thread-local handling, in particular that a
+# TrackedRequest created on one thread is NOT shared with another thread.
+#
+# ActionController::Live runs the controller action in a child thread and copies
+# the parent (Rack) thread's raw Thread.current locals -- including
+# :scout_request -- into it. Without protection both threads would share and
+# concurrently mutate a single TrackedRequest, racing on @layers/@stopping,
+# which drops the transaction and leaks layers. RequestManager must give the
+# inheriting thread its own request instead.
+class RequestManagerTest < Minitest::Test
+  def teardown
+    # Never let a test leak the thread-local into sibling tests.
+    Thread.current[:scout_request] = nil
+  end
+
+  def test_lookup_reuses_the_request_on_the_same_thread
+    first  = ScoutApm::RequestManager.lookup
+    second = ScoutApm::RequestManager.lookup
+
+    assert_same first, second,
+      "lookup should return the same TrackedRequest on repeated calls within one thread"
+  end
+
+  def test_lookup_in_a_child_thread_that_inherited_the_local_gets_its_own_request
+    parent_request = ScoutApm::RequestManager.lookup
+    inherited = Thread.current[:scout_request]
+
+    child_request = nil
+    child_local_before = nil
+
+    t = Thread.new do
+      # Simulate ActionController::Live copying the parent's raw thread local
+      # into the streaming child thread.
+      Thread.current[:scout_request] = inherited
+      child_local_before = Thread.current[:scout_request]
+
+      child_request = ScoutApm::RequestManager.lookup
+    end
+    t.join
+
+    # The child observed the inherited (parent's) request as its raw local...
+    assert_same parent_request, child_local_before
+
+    # ...but lookup must NOT hand it the parent's request to mutate.
+    refute_nil child_request
+    refute_same parent_request, child_request,
+      "a thread that inherited another thread's :scout_request must get its own TrackedRequest"
+
+    # And the parent's request must be left untouched (still the parent's).
+    assert_same parent_request, Thread.current[:scout_request]
+  end
+
+  def test_find_treats_a_foreign_thread_request_as_absent
+    # A request that reports it was created on a different thread should not be
+    # returned by find (so lookup falls through to create).
+    foreign = ScoutApm::TrackedRequest.new(ScoutApm::Agent.instance.context, ScoutApm::FakeStore.new)
+    foreign.stubs(:creating_thread_id).returns(Thread.current.object_id + 1)
+    Thread.current[:scout_request] = foreign
+
+    assert_nil ScoutApm::RequestManager.find,
+      "find should treat a request created on another thread as absent"
+  end
+
+  def test_find_returns_a_same_thread_request
+    own = ScoutApm::RequestManager.lookup
+    assert_same own, ScoutApm::RequestManager.find
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 6.2.1
+  version: 6.3.1
 platform: ruby
 authors:
 - Derek Haynes
@@ -486,6 +486,7 @@ files:
 - test/unit/remote/route_test.rb
 - test/unit/remote/server_test.rb
 - test/unit/request_histograms_test.rb
+- test/unit/request_manager_test.rb
 - test/unit/sampling_test.rb
 - test/unit/scored_item_set_test.rb
 - test/unit/serializers/payload_serializer_test.rb
@@ -522,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: []