scout_apm 6.2.1 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c667c4b7279ecdc5107a30bb50ac2a42eda6403a257f6bf2a05a6452c1143f18
-  data.tar.gz: d5183ae2f3fb7fbdfabae56616543f99503f59bb65b154e6709ea278f42166d3
+  metadata.gz: fe18e4045997fdf6b731025ee98c13e2702096a0cfd13ac5f0f651d7a7f4a4db
+  data.tar.gz: d9b4593ef2b8d5df4983d7b93cb9eaf5cc3f7e6916d8288ae9814e59dd913007
 SHA512:
-  metadata.gz: bdc045802aa3d9cc37c147f6fd5a866e4bc3a3a49de480711595b3ca5b6dd04c314c2085bd229ccaebc0dca3125a7463f2bf0a53552adbb2caef8b0a09102de2
-  data.tar.gz: 07a522e00f9d86d4d03a57c5e8965a9fd724104881429c8acddf603c0a0ad8829d098f998b3e551a6a0751ab1ba60af0f2c077bab1c3528d988138d2f4c2268e
+  metadata.gz: a5b838d8e12286496038899c7dd006b6c3d6507061bcba1a963fc10664fa96e36c603f71e315430eda9eeaa84dabadb21f91dee9e9aa9baf7009f6e03d8f3d9d
+  data.tar.gz: bee9ed547611139d56eb6f88cf6c1e730dc77dbdf575e89a8b1cd95f86756687174c78b64cf00acd389a74e90198f9750aec334e2dfba195340a0a9753c280bd

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # Pending
 
+# 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/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.0"
 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.0
 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