scout_apm 5.3.5 → 5.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 656e36a7b9a11b5870058c46b31e8227c628691f8ab7f7d4de991c3e89b5f13d
-  data.tar.gz: 5f27c0af5b3f864a96ea65944c6655106a86aa96dbf489083b1c3a178322d827
+  metadata.gz: 8eb7dc8091eba4caa3dfb078b44636de67c94abc26646c05c14339e77ba0b58a
+  data.tar.gz: 7e7a596d825cf2c648470f6e867ea2c5cc3eb9112b813b4b4ca4dcf873a2b98c
 SHA512:
-  metadata.gz: b805ac798aa0f430182e31e9d4b3d924d20624a59406d333f8d8d02ead0d30bece36bf0b127b4b9e04a5cf149cc9e67621ab72f2143f7fcd5c03f70790fedf09
-  data.tar.gz: 6883c955de7003baeb2685c369f63532b45e1c25b5859067fdfb2112e31abae6f57e2dc44dd5b06f55d66f3a6b9b778904de864c45905a63cdd9516719d59367
+  metadata.gz: 9964722b976e23fc9a629cdb010079f4781e10764226bb8eeb9d6da4439612d20fe21c9fa13f8e1a7fbe8db268ff15005599d102893ee5ed44388ef686874b44
+  data.tar.gz: 1b9a9a0847c9f688fe34068cd68e0cd9d4bcac0e70eb3a59c507a2671d03aa2ac30bb7a8a1eea9f1df6d9ec5e4a4a713046707fe60702ff06b353df634e5cce2

data/CHANGELOG.markdown

@@ -1,5 +1,16 @@
 # Unreleased
 
+# 5.3.8
+* Avoid inaccurate websocket queue time capturing (#494)
+
+# 5.3.7
+* Fix parser dependency issue
+
+# 5.3.6
+* Fix AutoInstruments when instrumenting hash with shorthand (#486)
+* Fix Connection Handling deprecation in ActiveRecord for Rails 7.1 (#483)
+* Update ActionView partial instrumentation for Rails 7 (#487)
+
 # 5.3.5
 * Fix adding instrumentation of ActiveRecord after configuration has initialized for Rails versions greater than 3. (#465)
 * Fix typo with double use of PercentilePolicy, instead of PercentPolicy, for scoring. (#468)

data/README.markdown

@@ -1,6 +1,6 @@
 # ScoutApm Ruby Agent
 
-[![Build Status](https://travis-ci.org/scoutapp/scout_apm_ruby.svg?branch=master)](https://travis-ci.org/scoutapp/scout_apm_ruby)
+[![Build Status](https://github.com/scoutapp/scout_apm_ruby/actions/workflows/test.yml/badge.svg)](https://github.com/scoutapp/scout_apm_ruby/actions)
 
 A Ruby gem for detailed Rails application performance monitoring 📈. Metrics and transaction traces are
 reported to [Scout](https://scoutapp.com), a hosted application monitoring
@@ -21,6 +21,10 @@ Add the gem to your Gemfile
 
     gem 'scout_apm'
 
+Add [a version of the `parser` gem that supports your version of Ruby](https://github.com/whitequark/parser?tab=readme-ov-file#backwards-compatibility). For example, if you're on Ruby 3.3.0:
+
+    gem 'parser', '~> 3.3.0.0'
+
 Update your Gemfile
 
     bundle install

data/gems/instruments.gemfile

@@ -4,3 +4,5 @@ gem 'httpclient'
 gem 'http'
 gem 'redis'
 gem 'moped'
+gem 'actionpack'
+gem 'actionview'

data/lib/scout_apm/app_server_load.rb

@@ -51,7 +51,7 @@ module ScoutApm
     ensure
       # Sometimes :database_engine and :database_adapter can cause a reference to an AR connection.
       # Make sure we release all AR connections held by this thread.
-      ActiveRecord::Base.clear_active_connections! if Utils::KlassHelper.defined?("ActiveRecord::Base")
+      ActiveRecord::Base.connection_handler.clear_active_connections! if Utils::KlassHelper.defined?("ActiveRecord::Base")
     end
 
     # Calls `.to_s` on the object passed in.

data/lib/scout_apm/auto_instrument/rails.rb

@@ -135,6 +135,27 @@ module ScoutApm
           wrap(node.location.expression, *instrument(node.location.expression.source, file_name, line))
         end
 
+        def on_hash(node)
+          node.children.each do |pair|
+            # Skip `pair` if we're sure it's not using the hash shorthand syntax
+            next if pair.type != :pair
+            key_node, value_node = pair.children
+            next unless key_node.type == :sym && value_node.type == :send
+            key = key_node.children[0]
+            next unless value_node.children.size == 2 && value_node.children[0].nil? && key == value_node.children[1]
+
+            # Extract useful metadata for instrumentation:
+            line = pair.location.line || 'line?'
+            # column = pair.location.column || 'column?' # not used
+            # method_name = key || '*unknown*' # not used
+            file_name = @source_rewriter.source_buffer.name
+
+            instrument_before, instrument_after = instrument(pair.location.expression.source, file_name, line)
+            replace(pair.loc.expression, "#{key}: #{instrument_before}#{key}#{instrument_after}")
+          end
+          super
+        end
+
         # def on_class(node)
         #   class_name = node.children[1]
         #

data/lib/scout_apm/instruments/action_view.rb

@@ -72,9 +72,67 @@ module ScoutApm
 
         logger.info "Instrumenting ActionView::TemplateRenderer"
         ::ActionView::TemplateRenderer.prepend(ActionViewTemplateRendererInstruments)
+
+        if defined?(::ActionView::CollectionRenderer)
+          logger.info "Instrumenting ActionView::CollectionRenderer"
+          ::ActionView::CollectionRenderer.prepend(ActionViewCollectionRendererInstruments)
+        end
+      end
+
+      # In Rails 6.1 collection was moved to CollectionRenderer.
+      module ActionViewCollectionRendererInstruments
+        def render_collection(*args, **kwargs)
+          req = ScoutApm::RequestManager.lookup
+
+          maybe_template = args[3]
+
+          template_name ||= maybe_template.virtual_path rescue nil
+          template_name ||= "Unknown Collection"
+          layer_name = template_name + "/Rendering"
+
+          layer = ScoutApm::Layer.new("View", layer_name)
+          layer.subscopable!
+
+          begin
+            req.start_layer(layer)
+            if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?
+              super(*args, **kwargs)
+            else
+              super(*args)
+            end
+          ensure
+            req.stop_layer
+          end
+        end
       end
 
       module ActionViewPartialRendererInstruments
+        # In Rails 6.1, render_partial was renamed to render_partial_template
+        def render_partial_template(*args, **kwargs)
+          req = ScoutApm::RequestManager.lookup
+
+          # Template was moved to the third argument in Rails 6.1.
+          maybe_template = args[2]
+
+          template_name ||= maybe_template.virtual_path rescue nil
+          template_name ||= "Unknown Partial"
+
+          layer_name = template_name + "/Rendering"
+          layer = ScoutApm::Layer.new("View", layer_name)
+          layer.subscopable!
+
+          begin
+            req.start_layer(layer)
+            if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?
+              super(*args, **kwargs)
+            else
+              super(*args)
+            end
+          ensure
+            req.stop_layer
+          end
+        end
+
         # In Rails 6, the signature changed to pass the view & template args directly, as opposed to through the instance var
         # New signature is: def render_partial(view, template)
         def render_partial(*args, **kwargs)
@@ -83,7 +141,7 @@ module ScoutApm
           maybe_template = args[1]
 
           template_name = @template.virtual_path rescue nil        # Works on Rails 3.2 -> end of Rails 5 series
-          template_name ||= maybe_template.virtual_path rescue nil # Works on Rails 6 -> 6.0.3.5
+          template_name ||= maybe_template.virtual_path rescue nil # Works on Rails 6 -> 6.0.6
           template_name ||= "Unknown Partial"
 
           layer_name = template_name + "/Rendering"
@@ -102,13 +160,14 @@ module ScoutApm
           end
         end
 
+        # This method was moved in Rails 6.1 to CollectionRender. 
         def collection_with_template(*args, **kwargs)
           req = ScoutApm::RequestManager.lookup
 
           maybe_template = args[1]
 
           template_name = @template.virtual_path rescue nil # Works on Rails 3.2 -> end of Rails 5 series
-          template_name ||= maybe_template.virtual_path rescue nil # Works on Rails 6 -> 6.0.3.5
+          template_name ||= maybe_template.virtual_path rescue nil # Works on Rails 6 -> 6.0.6
           template_name ||= "Unknown Collection"
           layer_name = template_name + "/Rendering"
 
@@ -137,7 +196,7 @@ module ScoutApm
           maybe_template = args[1]
 
           template_name = args[0].virtual_path rescue nil # Works on Rails 3.2 -> end of Rails 5 series
-          template_name ||= maybe_template.virtual_path rescue nil # Works on Rails 6 -> 6.1.3
+          template_name ||= maybe_template.virtual_path rescue nil # Works on Rails 6 -> 7.1.3
           template_name ||= "Unknown"
           layer_name = template_name + "/Rendering"
 

data/lib/scout_apm/layer_converters/request_queue_time_converter.rb

@@ -15,6 +15,9 @@ module ScoutApm
 
         return unless headers
 
+        # When an application uses Turbo Streams, we capture very innaccurate queue times.
+        return if request_over_websocket?
+
         raw_start = locate_timestamp
         return unless raw_start
 
@@ -38,6 +41,10 @@ module ScoutApm
 
       private
 
+      def request_over_websocket?
+        headers["Upgrade"] == "websocket"
+      end
+
       # Looks through the possible headers with this data, and extracts the raw
       # value of the header
       # Returns nil if not found

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.3.5"
+  VERSION = "5.3.8"
 end

data/scout_apm.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "parser"
 
   # These are general development dependencies which are used in instrumentation
-  # tests. Specific versions are pulled in using specific gemfiles, e.g. 
+  # tests. Specific versions are pulled in using specific gemfiles, e.g.
   # `gems/rails3.gemfile`.
   s.add_development_dependency "activerecord"
   s.add_development_dependency "sqlite3"

data/test/test_helper.rb

@@ -65,7 +65,13 @@ class FakeEnvironment
   end
 end
 
+def remove_rails_namespace
+  Object.send(:remove_const, "Rails") if defined?(Rails)
+end
+
 def fake_rails(version)
+  remove_rails_namespace if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
+
   Kernel.const_set("Rails", Module.new)
   Kernel.const_set("ActionController", Module.new)
   r = Kernel.const_get("Rails")

data/test/unit/auto_instrument/hash_shorthand_controller-instrumented.rb

@@ -0,0 +1,41 @@
+
+class HashShorthandController < ApplicationController
+  def hash
+    json = {
+      static: "static",
+      shorthand: ::ScoutApm::AutoInstrument("shorthand:",["ROOT/test/unit/auto_instrument/hash_shorthand_controller.rb:6:in `hash'"]){shorthand},
+      longhand: ::ScoutApm::AutoInstrument("longhand: longhand",["ROOT/test/unit/auto_instrument/hash_shorthand_controller.rb:7:in `hash'"]){longhand},
+      longhand_different_key: ::ScoutApm::AutoInstrument("longhand",["ROOT/test/unit/auto_instrument/hash_shorthand_controller.rb:8:in `hash'"]){longhand},
+      hash_rocket: ::ScoutApm::AutoInstrument(":hash_rocket => hash_rocket",["ROOT/test/unit/auto_instrument/hash_shorthand_controller.rb:9:in `hash'"]){hash_rocket},
+      :hash_rocket_different_key => ::ScoutApm::AutoInstrument("hash_rocket",["ROOT/test/unit/auto_instrument/hash_shorthand_controller.rb:10:in `hash'"]){hash_rocket},
+      non_nil_receiver: ::ScoutApm::AutoInstrument("non_nil_receiver.value",["ROOT/test/unit/auto_instrument/hash_shorthand_controller.rb:11:in `hash'"]){non_nil_receiver.value},
+      nested: {
+        shorthand: ::ScoutApm::AutoInstrument("shorthand:",["ROOT/test/unit/auto_instrument/hash_shorthand_controller.rb:13:in `hash'"]){shorthand},
+      },
+      nested_call: ::ScoutApm::AutoInstrument("nested_call(params[\"timestamp\"])",["ROOT/test/unit/auto_instrument/hash_shorthand_controller.rb:15:in `hash'"]){nested_call(params["timestamp"])}
+    }
+    ::ScoutApm::AutoInstrument("render json:",["ROOT/test/unit/auto_instrument/hash_shorthand_controller.rb:17:in `hash'"]){render json:}
+  end
+
+  private
+
+  def nested_call(noop)
+    noop
+  end
+
+  def shorthand
+    "shorthand"
+  end
+
+  def longhand
+    "longhand"
+  end
+
+  def hash_rocket
+    "hash_rocket"
+  end
+
+  def non_nil_receiver
+    ::ScoutApm::AutoInstrument("OpenStruct.new(value: \"value\")",["ROOT/test/unit/auto_instrument/hash_shorthand_controller.rb:39:in `non_nil_receiver'"]){OpenStruct.new(value: "value")}
+  end
+end

data/test/unit/auto_instrument/hash_shorthand_controller.rb

@@ -0,0 +1,41 @@
+
+class HashShorthandController < ApplicationController
+  def hash
+    json = {
+      static: "static",
+      shorthand:,
+      longhand: longhand,
+      longhand_different_key: longhand,
+      :hash_rocket => hash_rocket,
+      :hash_rocket_different_key => hash_rocket,
+      non_nil_receiver: non_nil_receiver.value,
+      nested: {
+        shorthand:,
+      },
+      nested_call: nested_call(params["timestamp"])
+    }
+    render json:
+  end
+
+  private
+
+  def nested_call(noop)
+    noop
+  end
+
+  def shorthand
+    "shorthand"
+  end
+
+  def longhand
+    "longhand"
+  end
+
+  def hash_rocket
+    "hash_rocket"
+  end
+
+  def non_nil_receiver
+    OpenStruct.new(value: "value")
+  end
+end

data/test/unit/auto_instrument_test.rb

@@ -4,7 +4,7 @@ require 'scout_apm/auto_instrument'
 
 class AutoInstrumentTest < Minitest::Test
   ROOT = File.expand_path("../../", __dir__)
-  
+
   def source_path(name)
     File.expand_path("auto_instrument/#{name}.rb", __dir__)
   end
@@ -38,6 +38,12 @@ class AutoInstrumentTest < Minitest::Test
       normalize_backtrace(::ScoutApm::AutoInstrument::Rails.rewrite(source_path("controller")))
   end
 
+  def test_controller_rewrite_hash_shorthand
+    skip if RUBY_VERSION < "3.1"
+    assert_equal instrumented_source("hash_shorthand_controller"),
+      normalize_backtrace(::ScoutApm::AutoInstrument::Rails.rewrite(source_path("hash_shorthand_controller")))
+  end
+
   def test_rescue_from_rewrite
     # update_instrumented_source("rescue_from")
 

data/test/unit/instruments/action_view_test.rb

@@ -0,0 +1,102 @@
+# Most of this was taken from Rails:
+# https://github.com/rails/rails/blob/v7.1.3/actionview/test/actionpack/controller/render_test.rb
+# https://github.com/rails/rails/blob/v7.1.3/actionview/test/abstract_unit.rb
+
+if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
+  require 'test_helper'
+  require 'action_view'
+  require 'action_pack'
+  require 'action_controller'
+
+  FIXTURE_LOAD_PATH = File.expand_path("fixtures", __dir__)
+
+  include ActionView::Context
+  include ActionView::Helpers::TagHelper
+  include ActionView::Helpers::TextHelper
+
+  module ActionController
+
+    class Base
+      self.view_paths = FIXTURE_LOAD_PATH
+
+      def self.test_routes(&block)
+        routes = ActionDispatch::Routing::RouteSet.new
+        routes.draw(&block)
+        include routes.url_helpers
+        routes
+      end
+    end
+
+    class TestCase
+      include ActionDispatch::TestProcess
+
+      def self.with_routes(&block)
+        routes = ActionDispatch::Routing::RouteSet.new
+        routes.draw(&block)
+        include Module.new {
+          define_method(:setup) do
+            super()
+            @routes = routes
+            @controller.singleton_class.include @routes.url_helpers if @controller
+          end
+        }
+        routes
+      end
+    end
+  end
+
+  class TestController < ActionController::Base
+
+    def render_test_view
+      render template: "test_view"
+    end
+  end
+
+  class RenderTest < ActionController::TestCase
+
+    tests TestController
+
+    with_routes do
+      get :render_test_view, to: "test#render_test_view"
+    end
+
+    def setup
+      super
+      @controller.logger      = ActiveSupport::Logger.new(nil)
+      ActionView::Base.logger = ActiveSupport::Logger.new(nil)
+
+      @request.host = "www.scoutapm.com"
+
+      @old_view_paths = ActionController::Base.view_paths
+      ActionController::Base.view_paths = FIXTURE_LOAD_PATH
+    end
+
+    def teardown
+      ActionView::Base.logger = nil
+
+      ActionController::Base.view_paths = @old_view_paths
+    end
+
+    def test_partial_instrumentation
+      recorder = FakeRecorder.new
+      agent_context.recorder = recorder
+
+      instrument = ScoutApm::Instruments::ActionView.new(agent_context)
+      instrument.install(prepend: true)
+
+      get :render_test_view
+      assert_response :success
+
+      root_layer = recorder.requests.first.root_layer
+      children = root_layer.children.to_a
+      assert_equal 2, children.size
+
+      partial_layer = children[0]
+      collection_layer = children[1]
+
+      assert_equal "test_view/Rendering", root_layer.name
+      assert_equal "test/_test_partial/Rendering", partial_layer.name
+      assert_equal "test/_test_partial_collection/Rendering", collection_layer.name
+    end
+  end
+end

data/test/unit/instruments/fixtures/test/_test_partial.html.erb

@@ -0,0 +1,3 @@
+<div>
+  <p><%= message %></p>
+</div>

data/test/unit/instruments/fixtures/test/_test_partial_collection.html.erb

@@ -0,0 +1,3 @@
+<div>
+  <p><%= index %></p>
+</div>

data/test/unit/instruments/fixtures/test_view.html.erb

@@ -0,0 +1,10 @@
+<html>
+  <head>
+    <title>View</title>
+  </head>
+  <body>
+    <h1>View</h1>
+    <%= render partial: "test_partial", locals: { message: 'Partial' } %>
+    <%= render partial: "test_partial_collection", collection: [1, 2, 3], as: :index %>
+  </body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.3.5
+  version: 5.3.8
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -423,6 +423,8 @@ files:
 - test/unit/auto_instrument/controller-instrumented.rb
 - test/unit/auto_instrument/controller.rb
 - test/unit/auto_instrument/hanging_method.rb
+- test/unit/auto_instrument/hash_shorthand_controller-instrumented.rb
+- test/unit/auto_instrument/hash_shorthand_controller.rb
 - test/unit/auto_instrument/rescue_from-instrumented.rb
 - test/unit/auto_instrument/rescue_from.rb
 - test/unit/auto_instrument_test.rb
@@ -442,7 +444,11 @@ files:
 - test/unit/git_revision_test.rb
 - test/unit/histogram_test.rb
 - test/unit/ignored_uris_test.rb
+- test/unit/instruments/action_view_test.rb
 - test/unit/instruments/active_record_test.rb
+- test/unit/instruments/fixtures/test/_test_partial.html.erb
+- test/unit/instruments/fixtures/test/_test_partial_collection.html.erb
+- test/unit/instruments/fixtures/test_view.html.erb
 - test/unit/instruments/http_client_test.rb
 - test/unit/instruments/http_test.rb
 - test/unit/instruments/moped_test.rb
@@ -512,6 +518,8 @@ test_files:
 - test/unit/auto_instrument/controller-instrumented.rb
 - test/unit/auto_instrument/controller.rb
 - test/unit/auto_instrument/hanging_method.rb
+- test/unit/auto_instrument/hash_shorthand_controller-instrumented.rb
+- test/unit/auto_instrument/hash_shorthand_controller.rb
 - test/unit/auto_instrument/rescue_from-instrumented.rb
 - test/unit/auto_instrument/rescue_from.rb
 - test/unit/auto_instrument_test.rb
@@ -531,7 +539,11 @@ test_files:
 - test/unit/git_revision_test.rb
 - test/unit/histogram_test.rb
 - test/unit/ignored_uris_test.rb
+- test/unit/instruments/action_view_test.rb
 - test/unit/instruments/active_record_test.rb
+- test/unit/instruments/fixtures/test/_test_partial.html.erb
+- test/unit/instruments/fixtures/test/_test_partial_collection.html.erb
+- test/unit/instruments/fixtures/test_view.html.erb
 - test/unit/instruments/http_client_test.rb
 - test/unit/instruments/http_test.rb
 - test/unit/instruments/moped_test.rb