scout_apm 5.3.3 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1e83c44e949efe75ec1ee2c429b0596816c2b9f8e7c5416e7f3dd7243ef69c4
-  data.tar.gz: 9b8a870504f4b32729ddb85f999cf7af30f6aac4215d356caefda6db2349dfb8
+  metadata.gz: 6e125a347fd3bbfa0b52f6dde597daf1dc95d97ba95cb6c44553bc36fae71b82
+  data.tar.gz: 9f0c708e386be527f255582195a791938c1663b418999816b79f25e4f7caaf6f
 SHA512:
-  metadata.gz: ac045625ade6b059933ce82b1eaa014be50ce2eea7db34fb1e8a1f94145810c814bb95ba4cb8b70858547a3aaddebc812c8b3986e753f2f2304a7ae477a70974
-  data.tar.gz: 19c81bacc7df78bbae4b6c9a03007a4ce84ce6c2de230e0e0e6b937e7b8ef4885788f70b36bebcd9cc192ae3aba3b0a7899830cf5ce20182fb95d19a4d2d1843
+  metadata.gz: d7e079bde40861cf673834ec606f8a09fc84bd4416eddccd22abd29d5cd64dbf071347d832549f840dd3b07026c8a3d4e6788f458587128482a1b44682479ec4
+  data.tar.gz: e20c7d5fadbfe008f1febb62e3e31e5aa23cc4410f02634329493b10159603fb467e4ae66d504709f247ff457b0bf5d386f62baa0835010e7e5a0954160f7b97

data/.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release Gem
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+# Directly from https://github.com/rubygems/release-gem/tree/v1
+# Predicated on Tag Ruleset preventing arbitrary tag creation and
+# requiring checks to pass for commit before tag creation
+jobs:
+  push:
+    name: Push gem to RubyGems.org
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
+
+    steps:
+      # Set up
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@v1

data/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
@@ -23,7 +23,9 @@ jobs:
             gemfile: gems/rails3.gemfile
           - ruby: 2.2
           - ruby: 2.3
+            gemfile: gems/sqlite3-1.3.gemfile
           - ruby: 2.4
+            gemfile: gems/sqlite3-1.3.gemfile
           - ruby: 2.5
           - ruby: 2.6
           - ruby: 2.6
@@ -31,35 +33,34 @@ jobs:
             test_features: "typhoeus"
           - ruby: 2.6
             gemfile: gems/octoshark.gemfile
-          - ruby: 2.6
-            gemfile: gems/rails3.gemfile
-            bundler: 1.17.3
           - ruby: 2.7
           - ruby: 2.7
             prepend: true
-          - ruby: 3.0
-          - ruby: 3.0
+          - ruby: "3.0"
+          - ruby: "3.0"
             prepend: true
-          - ruby: 3.0
+          - ruby: "3.0"
             gemfile: gems/instruments.gemfile
             test_features: "instruments"
-          - ruby: 3.0
+          - ruby: "3.0"
             gemfile: gems/instruments.gemfile
             prepend: true
             test_features: "instruments"
-          - ruby: 3.0
+          - ruby: "3.0"
             gemfile: gems/sidekiq.gemfile
             test_features: "sidekiq_install"
-
+          - ruby: 3.1
+          - ruby: 3.2
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
       SCOUT_TEST_FEATURES: ${{ matrix.test_features }}
       SCOUT_USE_PREPEND: ${{ matrix.prepend }}
 
-    runs-on: ubuntu-latest
+    # https://github.com/ruby/setup-ruby/issues/496
+    runs-on: ${{ matrix.ruby == '2.2' && 'ubuntu-20.04' || 'ubuntu-latest' }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true

data/CHANGELOG.markdown

@@ -1,5 +1,29 @@
 # Unreleased
 
+# 5.4.0
+* Add support for GoodJob (#506)
+* Add support for Solid Queue (#508)
+
+# 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)
+* Fix span annotations/desc for external service requests with the use of prepend. (#471)
+* Fix ActiveSupport methods and replace them with non ActiveSupport methods. (#474)
+
+# 5.3.4
+Unused.
+
 # 5.3.3
 
 * Fix double firing of Puma `on_worker_boot` when preloading. (#463)

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/gems/sqlite3-1.3.gemfile

@@ -0,0 +1,3 @@
+eval_gemfile("../Gemfile")
+
+gem "sqlite3", "~> 1.3.5"

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/background_job_integrations/good_job.rb

@@ -0,0 +1,49 @@
+module ScoutApm
+  module BackgroundJobIntegrations
+    class GoodJob
+      UNKNOWN_QUEUE_PLACEHOLDER = 'default'.freeze
+      attr_reader :logger
+
+      def name
+        :good_job
+      end
+
+      def present?
+        defined?(::GoodJob::VERSION)
+      end
+
+      def forking?
+        false
+      end
+
+      def install
+        ActiveSupport.on_load(:active_job) do
+          include ScoutApm::Tracer
+
+          around_perform do |job, block|
+            # I have a sneaking suspicion there is a better way to handle Agent starting
+            # Maybe hook into GoodJob lifecycle events?
+            req = ScoutApm::RequestManager.lookup
+            latency = Time.now - (job.scheduled_at || job.enqueued_at) rescue 0
+            req.annotate_request(queue_latency: latency)
+
+            begin
+              req.start_layer ScoutApm::Layer.new("Queue", job.queue_name.presence || UNKNOWN_QUEUE_PLACEHOLDER)
+              started_queue = true # Following Convention
+              req.start_layer ScoutApm::Layer.new("Job", job.class.name)
+              started_job = true # Following Convention
+
+              block.call
+            rescue
+              req.error!
+              raise
+            ensure
+              req.stop_layer if started_job
+              req.stop_layer if started_queue
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/background_job_integrations/solid_queue.rb

@@ -0,0 +1,47 @@
+module ScoutApm
+  module BackgroundJobIntegrations
+    class SolidQueue
+      UNKNOWN_QUEUE_PLACEHOLDER = 'default'.freeze
+      attr_reader :logger
+
+      def name
+        :solid_queue
+      end
+
+      def present?
+        defined?(::SolidQueue::VERSION)
+      end
+
+      def forking?
+        false
+      end
+
+      def install
+        ActiveSupport.on_load(:active_job) do
+          include ScoutApm::Tracer
+
+          around_perform do |job, block|
+            req = ScoutApm::RequestManager.lookup
+            latency = Time.now - (job.scheduled_at || job.enqueued_at) rescue 0
+            req.annotate_request(queue_latency: latency)
+
+            begin
+              req.start_layer ScoutApm::Layer.new("Queue", job.queue_name.presence || UNKNOWN_QUEUE_PLACEHOLDER)
+              started_queue = true # Following Convention
+              req.start_layer ScoutApm::Layer.new("Job", job.class.name)
+              started_job = true # Following Convention
+
+              block.call
+            rescue
+              req.error!
+              raise
+            ensure
+              req.stop_layer if started_job
+              req.stop_layer if started_queue
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/environment.rb

@@ -31,6 +31,8 @@ module ScoutApm
       ScoutApm::BackgroundJobIntegrations::DelayedJob.new,
       ScoutApm::BackgroundJobIntegrations::Que.new,
       ScoutApm::BackgroundJobIntegrations::Faktory.new,
+      ScoutApm::BackgroundJobIntegrations::GoodJob.new,
+      ScoutApm::BackgroundJobIntegrations::SolidQueue.new,
     ]
 
     FRAMEWORK_INTEGRATIONS = [

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/instruments/active_record.rb

@@ -66,7 +66,7 @@ module ScoutApm
         defined?(::Rails) &&
           defined?(::Rails::VERSION) &&
           defined?(::Rails::VERSION::MAJOR) &&
-          ::Rails::VERSION::MAJOR.to_i == 3 &&
+          ::Rails::VERSION::MAJOR.to_i >= 3 &&
           ::Rails.respond_to?(:configuration)
       end
 

data/lib/scout_apm/instruments/net_http.rb

@@ -60,7 +60,7 @@ module ScoutApm
 
     module NetHttpInstrumentationPrepend
       def request(request, *args, &block)
-        self.class.instrument("HTTP", "request", :ignore_children => true, :desc => request_scout_description(args.first)) do
+        self.class.instrument("HTTP", "request", :ignore_children => true, :desc => request_scout_description(request)) do
           super(request, *args, &block)
         end
       end

data/lib/scout_apm/layer_converters/external_service_converter.rb

@@ -53,7 +53,7 @@ module ScoutApm
       rescue
         # Do nothing
       ensure
-        domain = DEFAULT_DOMAIN if domain.to_s.blank?
+        domain = DEFAULT_DOMAIN if (domain.nil? || domain.empty?)
         domain
       end
 

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

@@ -14,7 +14,7 @@ module ScoutApm
 
     def add_default_policies
       add(SlowPolicy::SpeedPolicy.new(context))
-      add(SlowPolicy::PercentilePolicy.new(context))
+      add(SlowPolicy::PercentPolicy.new(context))
       add(SlowPolicy::AgePolicy.new(context))
       add(SlowPolicy::PercentilePolicy.new(context))
     end

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.3.3"
+  VERSION = "5.4.0"
 end

data/lib/scout_apm.rb

@@ -67,6 +67,8 @@ require 'scout_apm/background_job_integrations/shoryuken'
 require 'scout_apm/background_job_integrations/sneakers'
 require 'scout_apm/background_job_integrations/que'
 require 'scout_apm/background_job_integrations/legacy_sneakers'
+require 'scout_apm/background_job_integrations/good_job'
+require 'scout_apm/background_job_integrations/solid_queue'
 
 require 'scout_apm/framework_integrations/rails_2'
 require 'scout_apm/framework_integrations/rails_3_or_4'

data/scout_apm.gemspec

@@ -31,10 +31,10 @@ 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"
+  s.add_development_dependency "sqlite3",  "~> 1.4"
 
   s.add_development_dependency "rubocop"
   s.add_development_dependency "guard"

data/test/test_helper.rb

@@ -65,6 +65,38 @@ 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")
+  r.const_set("VERSION", Module.new)
+  v = r.const_get("VERSION")
+  v.const_set("MAJOR", version)
+
+  assert_equal version, Rails::VERSION::MAJOR
+end
+
+def clean_fake_rails
+  Kernel.send(:remove_const, "Rails") if defined?(Kernel::Rails)
+  Kernel.send(:remove_const, "ActionController") if defined?(Kernel::ActionController)
+end
+
+def fake_sinatra
+  Kernel.const_set("Sinatra", Module.new)
+  s = Kernel.const_get("Sinatra")
+  s.const_set("Base", Module.new)
+end
+
+def clean_fake_sinatra
+  Kernel.const_unset("Sinatra") if defined?(Kernel::Sinatra)
+end
+
 # Helpers available to all tests
 class Minitest::Test
   def setup

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

@@ -29,32 +29,4 @@ class EnvironmentTest < Minitest::Test
   def test_framework_ruby
     assert_equal :ruby, ScoutApm::Environment.send(:new).framework
   end
-
-  ############################################################
-
-  def fake_rails(version)
-    Kernel.const_set("Rails", Module.new)
-    Kernel.const_set("ActionController", Module.new)
-    r = Kernel.const_get("Rails")
-    r.const_set("VERSION", Module.new)
-    v = r.const_get("VERSION")
-    v.const_set("MAJOR", version)
-
-    assert_equal version, Rails::VERSION::MAJOR
-  end
-
-  def clean_fake_rails
-    Kernel.send(:remove_const, "Rails") if defined?(Kernel::Rails)
-    Kernel.send(:remove_const, "ActionController") if defined?(Kernel::ActionController)
-  end
-
-  def fake_sinatra
-    Kernel.const_set("Sinatra", Module.new)
-    s = Kernel.const_get("Sinatra")
-    s.const_set("Base", Module.new)
-  end
-
-  def clean_fake_sinatra
-    Kernel.const_unset("Sinatra") if defined?(Kernel::Sinatra)
-  end
 end

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

@@ -24,6 +24,36 @@ class ActiveRecordTest < Minitest::Test
   class User < ActiveRecord::Base
   end
 
+  class DumbRailsConfig
+    def self.after_initialize; end
+  end
+
+  def test_old_rails_initialization
+    recorder = FakeRecorder.new
+    agent_context.recorder = recorder
+    old_rails_version = (1..2).to_a.sample
+    fake_rails(old_rails_version)
+
+    ::Rails.expects(:configuration).never
+
+    instrument = ScoutApm::Instruments::ActiveRecord.new(agent_context)
+    instrument.install(prepend: false)
+    clean_fake_rails
+  end
+
+  def test_modern_rails_initialization
+    recorder = FakeRecorder.new
+    agent_context.recorder = recorder
+    modern_rails_version = (3..7).to_a.sample
+    fake_rails(modern_rails_version)
+
+    ::Rails.expects(:configuration).returns(DumbRailsConfig).once
+
+    instrument = ScoutApm::Instruments::ActiveRecord.new(agent_context)
+    instrument.install(prepend: false)
+    clean_fake_rails
+  end
+
   def test_instrumentation
     recorder = FakeRecorder.new
     agent_context.recorder = recorder

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.3
+  version: 5.4.0
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -141,16 +141,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +216,7 @@ extensions:
 - ext/rusage/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -239,6 +240,7 @@ files:
 - gems/rails5.gemfile
 - gems/rails6.gemfile
 - gems/sidekiq.gemfile
+- gems/sqlite3-1.3.gemfile
 - gems/typhoeus.gemfile
 - lib/scout_apm.rb
 - lib/scout_apm/agent.rb
@@ -254,12 +256,14 @@ files:
 - lib/scout_apm/auto_instrument/rails.rb
 - lib/scout_apm/background_job_integrations/delayed_job.rb
 - lib/scout_apm/background_job_integrations/faktory.rb
+- lib/scout_apm/background_job_integrations/good_job.rb
 - lib/scout_apm/background_job_integrations/legacy_sneakers.rb
 - lib/scout_apm/background_job_integrations/que.rb
 - lib/scout_apm/background_job_integrations/resque.rb
 - lib/scout_apm/background_job_integrations/shoryuken.rb
 - lib/scout_apm/background_job_integrations/sidekiq.rb
 - lib/scout_apm/background_job_integrations/sneakers.rb
+- lib/scout_apm/background_job_integrations/solid_queue.rb
 - lib/scout_apm/background_recorder.rb
 - lib/scout_apm/background_worker.rb
 - lib/scout_apm/bucket_name_splitter.rb
@@ -423,6 +427,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 +448,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
@@ -495,7 +505,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring