scout_apm 2.6.6 → 4.0.4

data/lib/scout_apm/tracer.rb

@@ -91,7 +91,7 @@ module ScoutApm
 
       def _instrumented_method_string(instrumented_name, uninstrumented_name, type, name, options={})
         method_str = <<-EOF
-        def #{instrumented_name}(*args, &block)
+        def #{instrumented_name}(*args#{", **kwargs" if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?}, &block)
           name = begin
                    "#{name}"
                  rescue => e
@@ -103,7 +103,7 @@ module ScoutApm
                                name,
                                {:scope => #{options[:scope] || false}}
                              ) do
-            #{uninstrumented_name}(*args, &block)
+            #{uninstrumented_name}(*args#{", **kwargs" if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?}, &block)
           end
         end
         EOF

data/lib/scout_apm/utils/sql_sanitizer.rb

@@ -51,6 +51,7 @@ module ScoutApm
         sql.gsub!(PSQL_PLACEHOLDER, '?')
         sql.gsub!(PSQL_VAR_INTERPOLATION, '')
         sql.gsub!(PSQL_AFTER_WHERE) {|c| c.gsub(PSQL_REMOVE_STRINGS, '?')}
+        sql.gsub!(PSQL_AFTER_SET) {|c| c.gsub(PSQL_REMOVE_STRINGS, '?')}
         sql.gsub!(PSQL_REMOVE_INTEGERS, '?')
         sql.gsub!(PSQL_IN_CLAUSE, 'IN (?)')
         sql.gsub!(MULTIPLE_SPACES, ' ')

data/lib/scout_apm/utils/sql_sanitizer_regex.rb

@@ -5,13 +5,13 @@ module ScoutApm
       MULTIPLE_SPACES    = %r|\s+|.freeze
       MULTIPLE_QUESTIONS = /\?(,\?)+/.freeze
 
-
-      PSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
+      PSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*\z|.freeze
       PSQL_REMOVE_STRINGS = /'(?:[^']|'')*'/.freeze
       PSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze
       PSQL_PLACEHOLDER = /\$\d+/.freeze
       PSQL_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
-      PSQL_AFTER_WHERE = /(?:WHERE\s+).*?(?:SELECT|$)/i.freeze
+      PSQL_AFTER_WHERE = /(?:WHERE\s+).*?(?:SELECT|\z)/im.freeze
+      PSQL_AFTER_SET = /(?:SET\s+).*?(?:WHERE|\z)/im.freeze
 
       MYSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
       MYSQL_REMOVE_INTEGERS = /(?<!LIMIT )\b\d+\b/.freeze

data/lib/scout_apm/utils/sql_sanitizer_regex_1_8_7.rb

@@ -11,6 +11,7 @@ module ScoutApm
       PSQL_PLACEHOLDER = /\$\d+/.freeze
       PSQL_IN_CLAUSE = /IN\s+\(\?[^\)]*\)/.freeze
       PSQL_AFTER_WHERE = /(?:WHERE\s+).*?(?:SELECT|$)/i.freeze
+      PSQL_AFTER_SET = /(?:SET\s+).*?(?:WHERE|$)/i.freeze
 
       MYSQL_VAR_INTERPOLATION = %r|\[\[.*\]\]\s*$|.freeze
       MYSQL_REMOVE_INTEGERS = /\b\d+\b/.freeze

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "2.6.6"
+  VERSION = "4.0.4"
 end

data/scout_apm.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |s|
   s.extensions << 'ext/allocations/extconf.rb'
   s.extensions << 'ext/rusage/extconf.rb'
 
+  s.required_ruby_version = '>= 2.1'
+
   s.add_development_dependency "minitest"
   s.add_development_dependency "mocha"
   s.add_development_dependency "pry"
@@ -36,10 +38,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "activerecord"
   s.add_development_dependency "sqlite3"
 
-  if RUBY_VERSION >= "1.9.3"
-    s.add_development_dependency "rubocop"
-    s.add_development_dependency "guard"
-    s.add_development_dependency "guard-minitest"
-    s.add_development_dependency "m"
-  end
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-minitest"
+  s.add_development_dependency "m"
 end

data/test/unit/agent_context_test.rb

@@ -0,0 +1,29 @@
+require "test_helper"
+
+require "scout_apm/agent_context"
+
+class AgentContextTest < Minitest::Test
+  def test_has_error_service_ignored_exceptions
+    context = ScoutApm::AgentContext.new
+    assert ScoutApm::ErrorService::IgnoredExceptions, context.ignored_exceptions.class
+  end
+
+  def test_has_error_buffer
+    context = ScoutApm::AgentContext.new
+    assert ScoutApm::ErrorService::ErrorBuffer, context.error_buffer.class
+  end
+
+
+  class TestPolicy
+    def call(req); 1; end
+    def stored!(req); end
+  end
+
+  def test_customize_slow_request_policy
+    context = ScoutApm::AgentContext.new
+    assert 4, context.slow_request_policy.policies
+
+    context.slow_request_policy.add(TestPolicy.new)
+    assert 5, context.slow_request_policy.policies
+  end
+end

data/test/unit/environment_test.rb

@@ -44,8 +44,8 @@ class EnvironmentTest < Minitest::Test
   end
 
   def clean_fake_rails
-    Kernel.const_unset("Rails") if defined?(Kernel::Rails)
-    Kernel.const_unset("ActionController") if defined?(Kernel::ActionController)
+    Kernel.send(:remove_const, "Rails") if defined?(Kernel::Rails)
+    Kernel.send(:remove_const, "ActionController") if defined?(Kernel::ActionController)
   end
 
   def fake_sinatra

data/test/unit/error_service/error_buffer_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+class ErrorBufferTest < Minitest::Test
+  class FakeError < StandardError
+  end
+
+  def test_captures_and_stores_exceptions_and_env
+    eb = ScoutApm::ErrorService::ErrorBuffer.new(context)
+    eb.capture(ex, env)
+  end
+
+  #### Helpers
+
+  def context
+    ScoutApm::AgentContext.new
+  end
+
+  def env
+    {}
+  end
+
+  def ex(msg="Whoops")
+    FakeError.new(msg)
+  end
+end

data/test/unit/error_service/ignored_exceptions_test.rb

@@ -0,0 +1,49 @@
+require "test_helper"
+
+class IgnoredExceptionsTest < Minitest::Test
+  class FakeError < StandardError
+  end
+
+  class SubclassFakeError < FakeError
+  end
+
+  def test_ignores_with_string_match
+    ig = ScoutApm::ErrorService::IgnoredExceptions.new(context, ["RuntimeError"])
+    assert ig.ignored?(RuntimeError.new("something went wrong"))
+    assert !ig.ignored?(FakeError.new("something went wrong"))
+  end
+
+  def test_ignores_with_block
+    ig = ScoutApm::ErrorService::IgnoredExceptions.new(context, [])
+    ig.add_callback { |e| e.message == "ignore me" }
+
+    should_ignore = RuntimeError.new("ignore me")
+    should_not_ignore = RuntimeError.new("super legit")
+
+    assert ig.ignored?(should_ignore)
+    assert !ig.ignored?(should_not_ignore)
+  end
+
+  def test_ignores_subclasses
+    ig = ScoutApm::ErrorService::IgnoredExceptions.new(context, ["IgnoredExceptionsTest::FakeError"])
+    assert ig.ignored?(SubclassFakeError.new("Subclass"))
+  end
+
+  # Check that a bad exception in the list doesn't stop the whole thing from working
+  def test_does_not_consider_unknown_errors
+    ig = ScoutApm::ErrorService::IgnoredExceptions.new(context, ["ThisDoesNotExist", "IgnoredExceptionsTest::FakeError"])
+    assert ig.ignored?(FakeError.new("ignore this one"))
+  end
+
+  def test_add_module
+    ig = ScoutApm::ErrorService::IgnoredExceptions.new(context, [])
+    ig.add(IgnoredExceptionsTest::FakeError)
+    assert ig.ignored?(FakeError.new("ignore this one"))
+  end
+
+  #### Helpers
+
+  def context
+    ScoutApm::AgentContext.new
+  end
+end

data/test/unit/serializers/payload_serializer_test.rb

@@ -108,4 +108,40 @@ class PayloadSerializerTest < Minitest::Test
     json = { "foo" => "\bbar\nbaz\r" }
     assert_equal json, JSON.parse(ScoutApm::Serializers::PayloadSerializerToJson.jsonify_hash(json))
   end
+
+  def test_escapes_escaped_quotes
+    # Some escapes haven't ever worked on 1.8.7, and is not the issue I'm
+    # fixing now. Remove this when we drop support for ancient ruby
+    skip if RUBY_VERSION == "1.8.7"
+
+    json = {"foo" => %q|`additional_details` = '{\"amount\":1}'|}
+    result = ScoutApm::Serializers::PayloadSerializerToJson.jsonify_hash(json)
+    assert_equal json, JSON.parse(result)
+  end
+
+  def test_escapes_various_special_characters
+    # Some escapes haven't ever worked on 1.8.7, and is not the issue I'm
+    # fixing now. Remove this when we drop support for ancient ruby
+    skip if RUBY_VERSION == "1.8.7"
+
+    json = {"foo" => [
+      %Q|\fbar|,
+      %Q|\rbar|,
+      %Q|\nbar|,
+      %Q|\tbar|,
+      %Q|"bar|,
+      %Q|'bar|,
+      %Q|{bar|,
+      %Q|}bar|,
+      %Q|\\bar|,
+      if RUBY_VERSION == '1.8.7'
+        ""
+      else
+        %Q|\\\nbar|
+      end,
+    ]}
+
+    result = ScoutApm::Serializers::PayloadSerializerToJson.jsonify_hash(json)
+    assert_equal json, JSON.parse(result)
+  end
 end

data/test/unit/slow_request_policy_test.rb

@@ -1,6 +1,7 @@
 require 'test_helper'
 
 require 'scout_apm/slow_request_policy'
+require 'scout_apm/slow_policy/policy'
 require 'scout_apm/layer'
 
 class FakeRequest
@@ -16,35 +17,62 @@ class FakeRequest
   end
 end
 
+class FixedPolicy < ScoutApm::SlowPolicy::Policy
+  attr_reader :stored
+
+  def initialize(x)
+    @x = x
+  end
+
+  def call(req)
+    @x
+  end
+
+  def stored!(req)
+    @stored = true
+  end
+end
+
 class SlowRequestPolicyTest < Minitest::Test
   def setup
     @context = ScoutApm::AgentContext.new
   end
 
-  def test_stored_records_current_time
+  def test_age_policy_stored_records_current_time
     test_start = Time.now
-    policy = ScoutApm::SlowRequestPolicy.new(@context)
+    policy = ScoutApm::SlowPolicy::AgePolicy.new(@context)
     request = FakeRequest.new("users/index")
 
     policy.stored!(request)
     assert policy.last_seen[request.unique_name] > test_start
   end
 
-  def test_score
+  def test_sums_up_score
     policy = ScoutApm::SlowRequestPolicy.new(@context)
     request = FakeRequest.new("users/index")
 
-    request.set_duration(10) # 10 seconds
-    policy.last_seen[request.unique_name] = Time.now - 120 # 2 minutes since last seen
-    @context.request_histograms.add(request.unique_name, 1)
-    @context.transaction_time_consumed.add(request.unique_name, 1)
+    policy.add(FixedPolicy.new(1))
+    policy.add(FixedPolicy.new(2))
 
-    # Actual value I have in console is 4.01
-    # Score uses Time.now to compare w/ last_seen, and will tick up slowly as
-    # time passes, hence the range below.
-    score = policy.score(request)
+    assert_equal 3, policy.score(request)
+  end
+
+  def test_calls_store_on_policies
+    policy = ScoutApm::SlowRequestPolicy.new(@context)
+    request = FakeRequest.new("users/index")
+
+    policy.add(fp1 = FixedPolicy.new(1))
+    policy.add(fp2 = FixedPolicy.new(2))
+    policy.stored!(request)
+
+    assert_equal true, fp1.stored
+    assert_equal true, fp2.stored
+  end
+
+  def test_checks_new_policy_api
+    policy = ScoutApm::SlowRequestPolicy.new(@context)
 
-    assert score > 3.95
-    assert score < 4.05
+    assert_raises { policy.add(Object.new) }
+    assert_raises { policy.add(->(req){1}) } # only implements call
   end
 end

data/test/unit/sql_sanitizer_test.rb

@@ -139,6 +139,44 @@ module ScoutApm
         assert_equal %q|SELECT `blogs`.* FROM `blogs` WHERE (title = ?)|, ss.to_s
       end
 
+      def test_set_columns
+        sql = %q|UPDATE "mytable" SET "myfield" = 'fieldcontent', "countofthings" = 10 WHERE "user_id" = 10|
+
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :postgres }
+        assert_equal %q|UPDATE "mytable" SET "myfield" = ?, "countofthings" = ? WHERE "user_id" = ?|, ss.to_s
+      end
+
+      def test_postgres_multiline_sql
+        sql = %q|
+        SELECT "html_form_payloads".*
+        FROM "html_form_payloads"
+        INNER JOIN "leads" ON "leads"."payload_id" = "html_form_payloads"."id"
+               AND "leads"."payload_type" = ?
+        WHERE html_form_payloads.id < 10
+          AND "form_type" = 'xyz'
+          AND (params::varchar = '{"name":"Chris","resident":"Yes","e-content":"Secret content"}')
+          AND (leads.url = 'http://example.com')
+        ORDER BY "html_form_payloads"."id" ASC
+        LIMIT ?
+        |
+
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :postgres }
+        assert_equal %q|SELECT "html_form_payloads".* FROM "html_form_payloads" INNER JOIN "leads" ON "leads"."payload_id" = "html_form_payloads"."id" AND "leads"."payload_type" = ? WHERE html_form_payloads.id < ? AND "form_type" = ? AND (params::varchar = ?) AND (leads.url = ?) ORDER BY "html_form_payloads"."id" ASC LIMIT ?|, ss.to_s
+      end
+
+      def test_mysql_multiline
+        sql = %q|
+        SELECT `blogs`.*
+        FROM `blogs`
+        WHERE (title = 'abc')
+        |
+
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :mysql }
+        assert_equal %q|SELECT `blogs`.*
+        FROM `blogs`
+        WHERE (title = ?)|, ss.to_s
+      end
+
       def assert_faster_than(target_seconds)
         t1 = ::Time.now
         yield

data/test/unit/tracer_test.rb

@@ -65,6 +65,31 @@ class TracerTest < Minitest::Test
     assert_recorded(recorder, "Test", "name")
   end
 
+  if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?
+    def test_instrument_method_with_keyword_args
+      initial_value = Warning[:deprecated]
+      Warning[:deprecated] = true
+      recorder = FakeRecorder.new
+      ScoutApm::Agent.instance.context.recorder = recorder
+
+      klass = Class.new { include ScoutApm::Tracer }
+
+      invoked = false
+      klass.send(:define_method, :work) { |run:| invoked = true }
+      klass.instrument_method(:work, :type => "Test", :name => "name")
+
+      args = { run: false }
+      assert_output(nil, '') do
+        klass.new.work(**args)
+      end
+
+      assert invoked, "instrumented code was not invoked"
+      assert_recorded(recorder, "Test", "name")
+    ensure
+      Warning[:deprecated] = initial_value
+    end
+  end
+
   private
 
   def assert_recorded(recorder, type, name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.6.6
+  version: 4.0.4
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-19 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -216,6 +216,7 @@ extensions:
 - ext/rusage/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -250,6 +251,7 @@ files:
 - lib/scout_apm/auto_instrument/parser.rb
 - 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/legacy_sneakers.rb
 - lib/scout_apm/background_job_integrations/que.rb
 - lib/scout_apm/background_job_integrations/resque.rb
@@ -267,6 +269,17 @@ files:
 - lib/scout_apm/debug.rb
 - lib/scout_apm/detailed_trace.rb
 - lib/scout_apm/environment.rb
+- lib/scout_apm/error.rb
+- lib/scout_apm/error_service.rb
+- lib/scout_apm/error_service/error_buffer.rb
+- lib/scout_apm/error_service/error_record.rb
+- lib/scout_apm/error_service/ignored_exceptions.rb
+- lib/scout_apm/error_service/middleware.rb
+- lib/scout_apm/error_service/notifier.rb
+- lib/scout_apm/error_service/payload.rb
+- lib/scout_apm/error_service/periodic_work.rb
+- lib/scout_apm/error_service/railtie.rb
+- lib/scout_apm/error_service/sidekiq.rb
 - lib/scout_apm/extensions/config.rb
 - lib/scout_apm/extensions/transaction_callback_payload.rb
 - lib/scout_apm/fake_store.rb
@@ -281,7 +294,6 @@ files:
 - lib/scout_apm/instant/middleware.rb
 - lib/scout_apm/instant_reporting.rb
 - lib/scout_apm/instrument_manager.rb
-- lib/scout_apm/instruments/.DS_Store
 - lib/scout_apm/instruments/action_controller_rails_2.rb
 - lib/scout_apm/instruments/action_controller_rails_3_rails4.rb
 - lib/scout_apm/instruments/action_view.rb
@@ -305,6 +317,7 @@ files:
 - lib/scout_apm/instruments/resque.rb
 - lib/scout_apm/instruments/samplers.rb
 - lib/scout_apm/instruments/sinatra.rb
+- lib/scout_apm/instruments/typhoeus.rb
 - lib/scout_apm/job_record.rb
 - lib/scout_apm/layaway.rb
 - lib/scout_apm/layaway_file.rb
@@ -359,8 +372,12 @@ files:
 - lib/scout_apm/server_integrations/thin.rb
 - lib/scout_apm/server_integrations/unicorn.rb
 - lib/scout_apm/server_integrations/webrick.rb
-- lib/scout_apm/slow_job_policy.rb
 - lib/scout_apm/slow_job_record.rb
+- lib/scout_apm/slow_policy/age_policy.rb
+- lib/scout_apm/slow_policy/percent_policy.rb
+- lib/scout_apm/slow_policy/percentile_policy.rb
+- lib/scout_apm/slow_policy/policy.rb
+- lib/scout_apm/slow_policy/speed_policy.rb
 - lib/scout_apm/slow_request_policy.rb
 - lib/scout_apm/slow_transaction.rb
 - lib/scout_apm/stack_item.rb
@@ -391,6 +408,7 @@ files:
 - test/data/config_test_1.yml
 - test/test_helper.rb
 - test/tmp/README.md
+- test/unit/agent_context_test.rb
 - test/unit/agent_test.rb
 - test/unit/auto_instrument/assignments-instrumented.rb
 - test/unit/auto_instrument/assignments.rb
@@ -406,6 +424,8 @@ files:
 - test/unit/db_query_metric_set_test.rb
 - test/unit/db_query_metric_stats_test.rb
 - test/unit/environment_test.rb
+- test/unit/error_service/error_buffer_test.rb
+- test/unit/error_service/ignored_exceptions_test.rb
 - test/unit/extensions/periodic_callbacks_test.rb
 - test/unit/extensions/transaction_callbacks_test.rb
 - test/unit/fake_store_test.rb
@@ -429,7 +449,6 @@ files:
 - test/unit/request_histograms_test.rb
 - test/unit/scored_item_set_test.rb
 - test/unit/serializers/payload_serializer_test.rb
-- test/unit/slow_job_policy_test.rb
 - test/unit/slow_request_policy_test.rb
 - test/unit/sql_sanitizer_test.rb
 - test/unit/store_test.rb
@@ -454,68 +473,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
-test_files:
-- test/data/config_test_1.yml
-- test/test_helper.rb
-- test/tmp/README.md
-- test/unit/agent_test.rb
-- test/unit/auto_instrument/assignments-instrumented.rb
-- test/unit/auto_instrument/assignments.rb
-- test/unit/auto_instrument/controller-ast.txt
-- test/unit/auto_instrument/controller-instrumented.rb
-- test/unit/auto_instrument/controller.rb
-- test/unit/auto_instrument/rescue_from-instrumented.rb
-- test/unit/auto_instrument/rescue_from.rb
-- test/unit/auto_instrument_test.rb
-- test/unit/background_job_integrations/sidekiq_test.rb
-- test/unit/config_test.rb
-- test/unit/context_test.rb
-- test/unit/db_query_metric_set_test.rb
-- test/unit/db_query_metric_stats_test.rb
-- test/unit/environment_test.rb
-- test/unit/extensions/periodic_callbacks_test.rb
-- test/unit/extensions/transaction_callbacks_test.rb
-- test/unit/fake_store_test.rb
-- test/unit/git_revision_test.rb
-- test/unit/histogram_test.rb
-- test/unit/ignored_uris_test.rb
-- test/unit/instruments/active_record_test.rb
-- test/unit/instruments/net_http_test.rb
-- test/unit/instruments/percentile_sampler_test.rb
-- test/unit/layaway_test.rb
-- test/unit/layer_children_set_test.rb
-- test/unit/layer_converters/depth_first_walker_test.rb
-- test/unit/layer_converters/metric_converter_test.rb
-- test/unit/layer_converters/stubs.rb
-- test/unit/limited_layer_test.rb
-- test/unit/logger_test.rb
-- test/unit/metric_set_test.rb
-- test/unit/remote/test_message.rb
-- test/unit/remote/test_router.rb
-- test/unit/remote/test_server.rb
-- test/unit/request_histograms_test.rb
-- test/unit/scored_item_set_test.rb
-- test/unit/serializers/payload_serializer_test.rb
-- test/unit/slow_job_policy_test.rb
-- test/unit/slow_request_policy_test.rb
-- test/unit/sql_sanitizer_test.rb
-- test/unit/store_test.rb
-- test/unit/tracer_test.rb
-- test/unit/tracked_request_test.rb
-- test/unit/transaction_test.rb
-- test/unit/transaction_time_consumed_test.rb
-- test/unit/utils/active_record_metric_name_test.rb
-- test/unit/utils/backtrace_parser_test.rb
-- test/unit/utils/numbers_test.rb
-- test/unit/utils/scm.rb
+test_files: []