scout_apm 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffcf571075c7f443ebe029e8f07c726cc5cb6c12e156d47e2565c576ac671316
-  data.tar.gz: 684f8ed4ba52d2e5819ea319288333a83f8b5481491ae879be2e8031cdd5d6ee
+  metadata.gz: 1cce8f36675013a0c19a8fcc9c989c3cdb9ce200dbd9d80910ba0f1581a69e6b
+  data.tar.gz: adebeda03d35f00f36f0db73e78a205bd90646f6ab005270660cf7d86a4b685f
 SHA512:
-  metadata.gz: a4d90917dc02469213092848211fe779f44ec09e7db4829aaaa737ca15cf1811137dc2a4ae00adaa76cc2be92916b0467f164f79a76fac501c7a4827ba5d6f7d
-  data.tar.gz: 776d064902d998cc69330e470fbc9bfb368ae401d8e8a341310e4dc2a9070a256a2e57370505ee3475761d26145e4efced633963243527e39b95ab584bf48b2a
+  metadata.gz: fc9fc58ab95c94e5d904bc3b04c5d0a37be1cecb965d88cf994a652e46542457d298759f0a8cfce4040def439d77970a04f35d258b2b96546354ef46b93da42e
+  data.tar.gz: f1ab27e4646ccaa8a11220aff213d239b61434f2e511584e560c5234beec9b1746801a53898b49136097c814f726cf31b4d2dafbcaaf928910cd2204f51b5a84

data/.github/workflows/test.yml

@@ -0,0 +1,49 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 2.6
+      - run: bundle exec rubocop
+
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - ruby: 2.1
+            gemfile: gems/rails3.gemfile
+          - ruby: 2.2
+          - ruby: 2.3
+          - ruby: 2.4
+          - ruby: 2.5
+          - ruby: 2.6
+          - ruby: 2.6
+            gemfile: gems/octoshark.gemfile
+          - ruby: 2.6
+            gemfile: gems/rails3.gemfile
+            bundler: 1.17.3
+          - ruby: 2.7
+          - ruby: 3.0
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          bundler: ${{matrix.bundler}}
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle exec rake

data/.rubocop.yml

@@ -4,9 +4,10 @@ AllCops:
   Exclude:
     - 'test/unit/auto_instrument/*'
     - vendor/bundle/**/*
+  SuggestExtensions: false
 
 # 80 is stifling, especially with a few levels of nesting before we even start.
 # So bump it to 100 to keep really long lines from creeping in.
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
   Max: 100

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-dist: trusty
+dist: xenial
 cache: bundler
 
 matrix:
@@ -11,6 +11,8 @@ matrix:
     - rvm: 2.4
     - rvm: 2.5
     - rvm: 2.6
+    - rvm: 2.7
+    - rvm: 3.0
     - rvm: 2.6
       gemfile: gems/octoshark.gemfile
     - rvm: 2.6

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+# 4.0.1
+
+* Add support for Ruby 3.0 (#374)
+* Use Github Actions for CI (#370)
+* Fix edge case in sanitization of Postgres SQL (#368)
+
 # 4.0.0
 
 * Require Ruby >= 2.1 (#270)

data/gems/rails6.gemfile

@@ -1,4 +1,4 @@
 eval_gemfile("../Gemfile")
 
-gem "rails", "~> 6.0.0rc1"
+gem "rails", "~> 6.0"
 gem "sqlite3", "~> 1.4"

data/lib/scout_apm/environment.rb

@@ -182,9 +182,24 @@ module ScoutApm
       @ruby_2 = defined?(RUBY_VERSION) && RUBY_VERSION.match(/^2/)
     end
 
+    def ruby_3?
+      return @ruby_3 if defined?(@ruby_3)
+      @ruby_3 = defined?(RUBY_VERSION) && RUBY_VERSION.match(/^3/)
+    end
+
+    def ruby_minor
+      return @ruby_minor if defined?(@ruby_minor)
+      @ruby_minor = defined?(RUBY_VERSION) && RUBY_VERSION.split(".")[1].to_i
+    end
+
     # Returns true if this Ruby version supports Module#prepend.
     def supports_module_prepend?
-      ruby_2?
+      ruby_2? || ruby_3?
+    end
+
+    # Returns true if this Ruby version supports Module#prepend.
+    def supports_kwarg_delegation?
+      ruby_3? || (ruby_2? && ruby_minor >= 7)
     end
 
     # Returns a string representation of the OS (ex: darwin, linux)

data/lib/scout_apm/instruments/action_view.rb

@@ -77,7 +77,7 @@ module ScoutApm
       module ActionViewPartialRendererInstruments
         # 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)
+        def render_partial(*args, **kwargs)
           req = ScoutApm::RequestManager.lookup
 
           maybe_template = args[1]
@@ -92,13 +92,17 @@ module ScoutApm
 
           begin
             req.start_layer(layer)
-            super(*args)
+            if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?
+              super(*args, **kwargs)
+            else
+              super(*args)
+            end
           ensure
             req.stop_layer
           end
         end
 
-        def collection_with_template(*args)
+        def collection_with_template(*args, **kwargs)
           req = ScoutApm::RequestManager.lookup
 
           template_name = @template.virtual_path rescue "Unknown Collection"
@@ -110,7 +114,11 @@ module ScoutApm
 
           begin
             req.start_layer(layer)
-            super(*args)
+            if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?
+              super(*args, **kwargs)
+            else
+              super(*args)
+            end
           ensure
             req.stop_layer
           end
@@ -118,7 +126,7 @@ module ScoutApm
       end
 
       module ActionViewTemplateRendererInstruments
-        def render_template(*args)
+        def render_template(*args, **kwargs)
           req = ScoutApm::RequestManager.lookup
 
           template_name = args[0].virtual_path rescue "Unknown"
@@ -130,7 +138,11 @@ module ScoutApm
 
           begin
             req.start_layer(layer)
-            super(*args)
+            if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?
+              super(*args, **kwargs)
+            else
+              super(*args)
+            end
           ensure
             req.stop_layer
           end

data/lib/scout_apm/instruments/active_record.rb

@@ -315,7 +315,11 @@ module ScoutApm
         req.start_layer(layer)
         req.ignore_children!
         begin
-          find_by_sql_without_scout_instruments(*args, **kwargs, &block)
+          if ScoutApm::Agent.instance.context.environment.supports_kwarg_delegation?
+            find_by_sql_without_scout_instruments(*args, **kwargs, &block)
+          else
+            find_by_sql_without_scout_instruments(*args, &block)
+          end
         ensure
           req.acknowledge_children!
           req.stop_layer

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?
+      if ScoutApm::Agent.instance.context.environment.ruby_2? || ScoutApm::Agent.instance.context.environment.ruby_3? 
         caller(3...BACKTRACE_CALLER_LIMIT)
       else
         caller[3...BACKTRACE_CALLER_LIMIT]

data/lib/scout_apm/remote/server.rb

@@ -16,8 +16,20 @@ module ScoutApm
         @server = nil
       end
 
-      def start
+      def require_webrick
         require 'webrick'
+        true
+      rescue LoadError
+        @logger.warn(
+          %q|Could not require Webrick. Ruby 3.0 stopped bundling it
+             automatically, but it is required to instrument Resque. Please add
+             Webrick to your Gemfile.|
+        )
+        false
+      end
+
+      def start
+        return false unless require_webrick
 
         @server = WEBrick::HTTPServer.new(
           :BindAddress => bind,

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_SET = /(?:SET\s+).*?(?:WHERE|$)/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/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "4.0.0"
+  VERSION = "4.0.1"
 end

data/scout_apm.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.extensions << 'ext/allocations/extconf.rb'
   s.extensions << 'ext/rusage/extconf.rb'
 
-  s.required_ruby_version = '~> 2.1'
+  s.required_ruby_version = '>= 2.1'
 
   s.add_development_dependency "minitest"
   s.add_development_dependency "mocha"

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

@@ -146,6 +146,37 @@ module ScoutApm
         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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2021-01-18 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"
@@ -468,7 +469,7 @@ require_paths:
 - data
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -477,7 +478,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring