scout_apm 6.0.2 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af813ad30f40b8cee3cb1e50c8b6ca311c8347d0431d18c6e5ce0939cda174e5
-  data.tar.gz: d9baccb3c23a1c45571503349ddbc4dc4de4f0e48fbf10ee7fd40ce7f7b76b2f
+  metadata.gz: 38fd4f02052ac68bd1db87d3cc08cd9ce9a5d1cfbe81abac7bfc36cc7a6836b5
+  data.tar.gz: 9dd1c1d71c90128ff3d8a8062661668cca4be572ca89ef61d5ec82eede9e0dc6
 SHA512:
-  metadata.gz: 1d08de0c4f24ca6d8385a381705134baff6c5b65463f4775d78eae4c03bdc91195acfb24edf666743cf2e3064b20780251f345b6b4e02ac658e7841633986f51
-  data.tar.gz: ef12b4f094e373c5769e79c55a047b1b90db1a236fdcce4a23aacd657b5703127b662549cc56e92f72172e4e5732c99a8f769376df0a231411dbcf3f7e71d253
+  metadata.gz: 8dc047b9af7a065890b91b7635ebcfa12d4604c0344c9e83d98d61b945cdd1d5e39a75edd9283fe0a7a0fcde41f58e8a498327a25a4da0745d90704c5f6a9b94
+  data.tar.gz: f204b3e5848a056776f68a54b6a1971a69418477a57200ce6660bc5675778f77f41178533d99321d280ddc8b351548061d0dfc35445da450e8184daef3c05c3e

data/.github/workflows/test.yml

@@ -55,6 +55,14 @@ jobs:
             gemfile: gems/sqlite3-v2.gemfile
           - ruby: 3.4
             gemfile: gems/sqlite3-v2.gemfile
+          - ruby: 4.0
+            gemfile: gems/sqlite3-v2.gemfile
+          - ruby: 4.0
+            prepend: true
+            gemfile: gems/sqlite3-v2.gemfile
+          - ruby: 4.0
+            gemfile: gems/instruments-ruby4.gemfile
+            test_features: "instruments"
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
       SCOUT_TEST_FEATURES: ${{ matrix.test_features }}

data/CHANGELOG.markdown

@@ -1,5 +1,12 @@
+# Pending
+
+# 6.1.0
+- Ruby 4 support
+- Update gem metadata
+- Add `backtrace_additional_directories` config option to allow additional directories to be included in the backtrace parser
+
 # 6.0.2
-- Fix `endpoint_sample_rate` and `job_sample_rate` to support float values 
+- Fix `endpoint_sample_rate` and `job_sample_rate` to support float values
 
 # 6.0.1
 - Fix capturing of job params for non ActiveJob
@@ -17,7 +24,7 @@ sampled at exactly 1%, you must now set `0.01` instead of `1`.**
 - Add HTTPX instrumentation (#588)
 - Add ability to automatically capture Sidekiq job args as context
   - `job_params_capture` - Set to true to enable job argument capturing
-  - `job_params_filter`  - A list of arguments to filter (automatically includes Rails filtered_parameters) 
+  - `job_params_filter`  - A list of arguments to filter (automatically includes Rails filtered_parameters)
 - Fix user error context being incorrectly flattened (#581)
 - Handle Delayed Job PerformableMethod jobs for error tracking (#584)
 - Require 'httpclient' library on instrumentation install (#586)

data/gems/instruments-ruby4.gemfile

@@ -0,0 +1,12 @@
+eval_gemfile("../Gemfile")
+
+gem 'minitest-mock'
+gem 'ostruct'
+gem "sqlite3", ">= 2.1"
+gem 'httpclient'
+gem 'http'
+gem 'redis'
+gem 'moped'
+gem 'actionpack'
+gem 'actionview'
+gem 'httpx'

data/gems/sqlite3-v2.gemfile

@@ -2,3 +2,4 @@ eval_gemfile("../Gemfile")
 
 gem "sqlite3", ">= 2.1"
 gem 'minitest-mock'
+gem 'ostruct'

data/lib/scout_apm/config.rb

@@ -120,6 +120,7 @@ module ScoutApm
         'use_prepend',
         'alias_method_instruments',
         'prepend_instruments',
+        'backtrace_additional_directories',
 
         # Error Service Related Configuration
         'errors_enabled',
@@ -267,6 +268,7 @@ module ScoutApm
       'errors_ignored_exceptions' => JsonCoercion.new,
       'errors_filtered_params' => JsonCoercion.new,
       'errors_env_capture' => JsonCoercion.new,
+      'backtrace_additional_directories' => JsonCoercion.new,
     }
 
 
@@ -404,6 +406,7 @@ module ScoutApm
         'errors_filtered_params'               => %w(password s3-key),
         'errors_env_capture'                   => %w(),
         'errors_host'                          => 'https://errors.scoutapm.com',
+        'backtrace_additional_directories'     => [],
       }.freeze
 
       def value(key)

data/lib/scout_apm/environment.rb

@@ -190,6 +190,16 @@ module ScoutApm
       @ruby_3 = defined?(RUBY_VERSION) && RUBY_VERSION.match(/^3/)
     end
 
+    def ruby_4?
+      return @ruby_4 if defined?(@ruby_4)
+      @ruby_4 = defined?(RUBY_VERSION) && RUBY_VERSION.match(/^4/)
+    end
+
+    def ruby_2_or_above?
+      ruby_2? || ruby_3? || ruby_4?
+    end
+
+
     def ruby_minor
       return @ruby_minor if defined?(@ruby_minor)
       @ruby_minor = defined?(RUBY_VERSION) && RUBY_VERSION.split(".")[1].to_i
@@ -197,12 +207,12 @@ module ScoutApm
 
     # Returns true if this Ruby version supports Module#prepend.
     def supports_module_prepend?
-      ruby_2? || ruby_3?
+      ruby_2_or_above?
     end
 
     # Returns true if this Ruby version makes positional and keyword arguments incompatible
     def supports_kwarg_delegation?
-      ruby_3? || (ruby_2? && ruby_minor >= 7)
+      ruby_4? || ruby_3? || (ruby_2? && ruby_minor >= 7)
     end
 
     # Returns a string representation of the OS (ex: darwin, linux)

data/lib/scout_apm/layer.rb

@@ -116,7 +116,7 @@ module ScoutApm
     # In Ruby 2.0+, we can pass the range directly to the caller to reduce the memory footprint.
     def caller_array
       # omits the first several callers which are in the ScoutAPM stack.
-      if ScoutApm::Agent.instance.context.environment.ruby_2? || ScoutApm::Agent.instance.context.environment.ruby_3? 
+      if ScoutApm::Agent.instance.context.environment.ruby_2_or_above?
         caller(3...BACKTRACE_CALLER_LIMIT)
       else
         caller[3...BACKTRACE_CALLER_LIMIT]

data/lib/scout_apm/utils/backtrace_parser.rb

@@ -11,16 +11,20 @@ module ScoutApm
 
       attr_reader :call_stack
 
-      # call_stack - an +Array+ of calls, typically generated via the +caller+ method. 
-      # Example single line: 
+      # call_stack - an +Array+ of calls, typically generated via the +caller+ method.
+      # Example single line:
       # "/Users/dlite/.rvm/rubies/ruby-2.4.5/lib/ruby/2.4.0/irb/workspace.rb:87:in `eval'"
-      def initialize(call_stack, root=ScoutApm::Agent.instance.context.environment.root)
+      # additional_dirs - an +Array+ of additional directory names to include beyond lib/, app/, and config/
+      def initialize(call_stack, root=ScoutApm::Agent.instance.context.environment.root, additional_dirs=ScoutApm::Agent.instance.context.config.value('backtrace_additional_directories'))
         @call_stack = call_stack
         # We can't use a constant as it'd be too early to fetch environment info
         #
         # This regex looks for files under the app root, inside lib/, app/, and
-        # config/ dirs, and captures the path under root.
-        @@app_dir_regex = %r[#{root}/((?:lib/|app/|config/).*)]
+        # config/ dirs (plus any additional configured directories), and captures the path under root.
+        base_dirs = %w[lib app config]
+        all_dirs = base_dirs + Array(additional_dirs)
+        dir_pattern = all_dirs.map { |d| Regexp.escape(d) + "/" }.join("|")
+        @@app_dir_regex = %r[#{root}/((?:#{dir_pattern}).*)]
       end
 
       def call

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "6.0.2"
+  VERSION = "6.1.0"
 end

data/scout_apm.gemspec

@@ -12,6 +12,12 @@ Gem::Specification.new do |s|
   s.description = "Monitors Ruby apps and reports detailed metrics on performance to Scout."
   s.license     = "MIT"
 
+  s.metadata = {
+    "changelog_uri" => "https://github.com/scoutapp/scout_apm_ruby/blob/master/CHANGELOG.markdown",
+    "homepage_uri" => "https://www.scoutapm.com",
+    "source_code_uri" => "https://github.com/scoutapp/scout_apm_ruby",
+  }
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -21,6 +27,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.1'
 
+
   s.add_development_dependency "minitest"
   s.add_development_dependency "mocha"
   s.add_development_dependency "pry"
@@ -34,10 +41,11 @@ Gem::Specification.new do |s|
   # tests. Specific versions are pulled in using specific gemfiles, e.g.
   # `gems/rails3.gemfile`.
   s.add_development_dependency "activerecord"
-  s.add_development_dependency "sqlite3",  "~> 1.4"
+  s.add_development_dependency "sqlite3"
 
   s.add_development_dependency "rubocop"
   s.add_development_dependency "guard"
   s.add_development_dependency "guard-minitest"
   s.add_development_dependency "m"
+
 end

data/test/test_helper.rb

@@ -81,7 +81,10 @@ end
 def fake_rails(version)
   remove_rails_namespace if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
 
-  Kernel.const_set("Rails", Module.new)
+  Kernel.const_set("Rails", Module.new {
+    # ActionView 8.1+ StructuredEventSubscriber calls Rails.try(:root)
+    def self.root; nil; end
+  })
   Kernel.const_set("ActionController", Module.new)
   r = Kernel.const_get("Rails")
   r.const_set("VERSION", Module.new)

data/test/unit/instruments/action_view_test.rb

@@ -4,9 +4,22 @@
 
 if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
   require 'test_helper'
-  require 'action_view'
+
+  # Rails 8.1+ ActionView::StructuredEventSubscriber calls Rails.try(:root)
+  # https://github.com/rails/rails/blob/3ad79fcede4f9b620f03b9fd76507d9fb3c07e95/actionview/lib/action_view/structured_event_subscriber.rb#L67
+  # which raises NameError if Rails is not defined. Define a minimal stub.
+  # Maybe this can get fixed at some point.
+  unless defined?(Rails)
+    module Rails
+      def self.root
+        nil
+      end
+    end
+  end
+
   require 'action_pack'
   require 'action_controller'
+  require 'action_view'
 
   FIXTURE_LOAD_PATH = File.expand_path("fixtures", __dir__)
 
@@ -62,6 +75,9 @@ if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
 
     def setup
       super
+      # Ensure Rails exists - other tests may have called clean_fake_rails
+      fake_rails(8)
+
       @controller.logger      = ActiveSupport::Logger.new(nil)
       ActionView::Base.logger = ActiveSupport::Logger.new(nil)
 
@@ -75,6 +91,7 @@ if (ENV["SCOUT_TEST_FEATURES"] || "").include?("instruments")
       ActionView::Base.logger = nil
 
       ActionController::Base.view_paths = @old_view_paths
+      clean_fake_rails
     end
 
     def test_partial_instrumentation

data/test/unit/utils/backtrace_parser_test.rb

@@ -68,4 +68,116 @@ class BacktraceParserTest < Minitest::Test
     assert_equal false, (result[0] =~ %r|app/controllers/users_controller.rb|).nil?
     assert_equal false, (result[1] =~ %r|config/initializers/inject_something.rb|).nil?
   end
+
+  ################################################################################
+  # Additional directories tests
+
+  def test_with_empty_additional_directories
+    raw_backtrace = [
+      "#{root}/app/controllers/users_controller.rb",
+      "#{root}/engines/my_engine/app/models/thing.rb",
+    ]
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root, []).call
+
+    assert_equal 1, result.length
+    assert_equal false, (result[0] =~ %r|app/controllers/users_controller.rb|).nil?
+  end
+
+  def test_with_single_additional_directory
+    raw_backtrace = [
+      "#{root}/engines/my_engine/app/models/thing.rb",
+      "#{root}/app/controllers/users_controller.rb",
+    ]
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root, ['engines']).call
+
+    assert_equal 2, result.length
+    assert_equal false, (result[0] =~ %r|engines/my_engine/app/models/thing.rb|).nil?
+    assert_equal false, (result[1] =~ %r|app/controllers/users_controller.rb|).nil?
+  end
+
+  def test_with_multiple_additional_directories
+    raw_backtrace = [
+      "#{root}/foo/something.rb",
+      "#{root}/bar/something_else.rb",
+      "#{root}/app/controllers/users_controller.rb",
+    ]
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root, ['foo', 'bar']).call
+
+    assert_equal 3, result.length
+    assert_equal false, (result[0] =~ %r|foo/something.rb|).nil?
+    assert_equal false, (result[1] =~ %r|bar/something_else.rb|).nil?
+    assert_equal false, (result[2] =~ %r|app/controllers/users_controller.rb|).nil?
+  end
+
+  def test_default_directories_still_work_with_additional_dirs
+    raw_backtrace = [
+      "#{root}/lib/utilities.rb",
+      "#{root}/app/models/user.rb",
+      "#{root}/config/initializers/setup.rb",
+      "#{root}/engines/core/lib/core.rb",
+    ]
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root, ['engines']).call
+
+    assert_equal 4, result.length
+    assert_equal false, (result[0] =~ %r|lib/utilities.rb|).nil?
+    assert_equal false, (result[1] =~ %r|app/models/user.rb|).nil?
+    assert_equal false, (result[2] =~ %r|config/initializers/setup.rb|).nil?
+    assert_equal false, (result[3] =~ %r|engines/core/lib/core.rb|).nil?
+  end
+
+  def test_additional_directory_with_special_regex_characters
+    raw_backtrace = [
+      "#{root}/my.engine/lib/something.rb",
+      "#{root}/app/controllers/users_controller.rb",
+    ]
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root, ['my.engine']).call
+
+    assert_equal 2, result.length
+    assert_equal false, (result[0] =~ %r|my\.engine/lib/something.rb|).nil?
+    assert_equal false, (result[1] =~ %r|app/controllers/users_controller.rb|).nil?
+  end
+
+  def test_additional_directory_does_not_match_similar_names
+    # Ensure "my.engine" doesn't match "myXengine" (the dot should be escaped)
+    raw_backtrace = [
+      "#{root}/myXengine/lib/something.rb",
+      "#{root}/app/controllers/users_controller.rb",
+    ]
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root, ['my.engine']).call
+
+    assert_equal 1, result.length
+    assert_equal false, (result[0] =~ %r|app/controllers/users_controller.rb|).nil?
+  end
+
+  def test_backtrace_entirely_within_single_additional_directory
+    # Backtrace originates entirely from an additional directory with no default dirs
+    raw_backtrace = [
+      "#{root}/engines/core/lib/core/base.rb",
+      "#{root}/engines/core/app/models/engine_model.rb",
+      "#{root}/engines/auth/lib/auth/strategy.rb",
+      "#{root}/vendor/bundle/gems/some_gem.rb",
+    ]
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root, ['engines']).call
+
+    assert_equal 3, result.length
+    assert_equal false, (result[0] =~ %r|engines/core/lib/core/base.rb|).nil?
+    assert_equal false, (result[1] =~ %r|engines/core/app/models/engine_model.rb|).nil?
+    assert_equal false, (result[2] =~ %r|engines/auth/lib/auth/strategy.rb|).nil?
+  end
+
+  def test_backtrace_entirely_within_multiple_additional_directories
+    # Backtrace spans multiple additional directories with no default dirs
+    raw_backtrace = [
+      "#{root}/engines/billing/lib/invoice.rb",
+      "#{root}/components/shared/helpers.rb",
+      "#{root}/plugins/analytics/tracker.rb",
+      "#{root}/vendor/bundle/gems/external.rb",
+    ]
+    result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root, ['engines', 'components', 'plugins']).call
+
+    assert_equal 3, result.length
+    assert_equal false, (result[0] =~ %r|engines/billing/lib/invoice.rb|).nil?
+    assert_equal false, (result[1] =~ %r|components/shared/helpers.rb|).nil?
+    assert_equal false, (result[2] =~ %r|plugins/analytics/tracker.rb|).nil?
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.1.0
 platform: ruby
 authors:
 - Derek Haynes
@@ -140,16 +140,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -232,6 +232,7 @@ files:
 - ext/rusage/extconf.rb
 - ext/rusage/rusage.c
 - gems/README.md
+- gems/instruments-ruby4.gemfile
 - gems/instruments.gemfile
 - gems/octoshark.gemfile
 - gems/rails3.gemfile
@@ -500,7 +501,10 @@ files:
 homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/scoutapp/scout_apm_ruby/blob/master/CHANGELOG.markdown
+  homepage_uri: https://www.scoutapm.com
+  source_code_uri: https://github.com/scoutapp/scout_apm_ruby
 rdoc_options: []
 require_paths:
 - lib
@@ -516,7 +520,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Ruby application performance monitoring
 test_files: []