newrelic_rpm 3.10.0.279 → 3.11.0.283

data/test/multiverse/suites/rails/activejob_test.rb

@@ -2,7 +2,6 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
-require 'multiverse_helpers'
 require File.expand_path(File.join(__FILE__, '..', 'app'))
 
 require 'logger'

data/test/multiverse/suites/rails/app.rb

@@ -2,7 +2,6 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
-require 'multiverse_helpers'
 require File.join(File.dirname(__FILE__), 'middlewares')
 
 suite_dir = File.expand_path(File.dirname(__FILE__))

data/test/multiverse/suites/rails/parameter_capture_test.rb

@@ -9,6 +9,10 @@ class ParameterCaptureController < ApplicationController
     render :text => 'hi!'
   end
 
+  def create
+    render :text => 'created'
+  end
+
   def sql
     NewRelic::Agent.agent.sql_sampler.notice_sql(
       'SELECT * FROM table',
@@ -214,5 +218,14 @@ class ParameterCaptureTest < RailsMultiverseTest
       expected = {"secret" => "[FILTERED]", "name" => "name", "raise" => "1"}
       assert_equal expected, last_traced_error_request_params
     end
+
+    def test_file_upload_params_are_replaced_with_placeholder
+      with_config(:capture_params => true) do
+        params = { :file => Rack::Test::UploadedFile.new(__FILE__, 'text/plain') }
+        post '/parameter_capture', params
+        result = last_transaction_trace_request_params
+        assert_equal("#<ActionDispatch::Http::UploadedFile>", result["file"])
+      end
+    end
   end
 end

data/test/multiverse/suites/rails/rails3_app/app_rails3_plus.rb

@@ -78,8 +78,13 @@ if !defined?(MyApp)
         :constraints => lambda do |_|
           raise ActionController::RoutingError.new('this is an uncaught routing error')
         end)
+
     mount SinatraTestApp, :at => '/sinatra_app' if defined?(Sinatra)
+
     post '/filtering_test' => FilteringTestApp.new
+
+    post '/parameter_capture', :to => 'parameter_capture#create'
+
     get '/:controller(/:action(/:id))'
   end
 

data/test/multiverse/suites/rails/transaction_ignoring_test.rb

@@ -3,8 +3,6 @@
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
 require './app'
-require 'multiverse_helpers'
-require File.join(File.dirname(__FILE__), '..', '..', '..', 'agent_helper')
 require 'transaction_ignoring_test_cases'
 
 class TransactionIgnorerController < ApplicationController

data/test/multiverse/suites/resque/instrumentation_test.rb

@@ -8,8 +8,6 @@ require 'resque'
 require 'logger'
 require 'newrelic_rpm'
 require 'fake_collector'
-require 'multiverse_helpers'
-require File.join(File.dirname(__FILE__), "..", "..", "..", "agent_helper")
 
 class ResqueTest < Minitest::Test
   include MultiverseHelpers

data/test/multiverse/suites/resque/resque_marshalling_test.rb

@@ -2,7 +2,6 @@
 # This file is distributed under New Relic's license terms.
 # See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
 
-require 'multiverse_helpers'
 require File.join(File.dirname(__FILE__), '..', '..', '..', 'new_relic', 'marshalling_test_cases')
 
 if NewRelic::LanguageSupport.can_fork?

data/test/multiverse/suites/sequel/sequel_extension_test.rb

@@ -0,0 +1,135 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+require File.join(File.dirname(__FILE__), 'database.rb')
+require File.join(File.dirname(__FILE__), 'sequel_helpers.rb')
+
+if Sequel.const_defined?( :MAJOR ) &&
+      ( Sequel::MAJOR > 3 ||
+        Sequel::MAJOR == 3 && Sequel::MINOR >= 37 )
+
+require 'newrelic_rpm'
+
+class SequelExtensionTest < Minitest::Test
+  include SequelHelpers
+
+  def setup
+    super
+
+    DB.extension :newrelic_instrumentation
+
+    @posts = DB[:posts]
+
+    NewRelic::Agent.disable_all_tracing do
+      post_id = @posts.insert( :title => 'All The Things', :content => 'A nice short story.' )
+      @post = @posts[:id => post_id]
+    end
+  end
+
+  def teardown
+    super
+
+    NewRelic::Agent.shutdown
+  end
+
+  def expected_metrics_for_operation(operation)
+    [
+      ["Datastore/operation/#{product_name}/#{operation}", "dummy"],
+      "Datastore/operation/#{product_name}/#{operation}",
+      "Datastore/#{product_name}/allWeb",
+      "Datastore/allWeb",
+      "Datastore/#{product_name}/all",
+      "Datastore/all"
+    ]
+  end
+
+  def test_all
+    in_web_transaction { @posts.all }
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:select))
+  end
+
+  def test_find
+    in_web_transaction do
+      @posts[:id => 11]
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:select))
+  end
+
+  def test_model_create_method_generates_metrics
+    in_web_transaction do
+      @posts.insert( :title => 'The Thing', :content => 'A wicked short story.' )
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:insert))
+  end
+
+  def test_update
+    in_web_transaction do
+      @posts.where(:id => @post[:id]).update( :title => 'A Lot of the Things' )
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:update))
+  end
+
+  def test_delete
+    in_web_transaction do
+      @posts.where(:id => @post[:id]).delete
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:delete))
+  end
+
+  def test_slow_queries_get_an_explain_plan
+    with_config( :'transaction_tracer.explain_threshold' => -0.01,
+                 :'transaction_tracer.record_sql' => 'raw' ) do
+      segment = last_segment_for do
+        @posts[:id => 11]
+      end
+      assert_match %r{select \* from `posts` where \(?`id` = 11\)?( limit 1)?}i, segment.params[:sql]
+      assert_segment_has_explain_plan( segment )
+    end
+  end
+
+  def test_sql_is_recorded_in_tt_for_non_select
+    with_config(:'transaction_tracer.record_sql' => 'raw') do
+      segment = last_segment_for do
+        @posts.insert(:title => 'title', :content => 'content')
+      end
+      assert_match %r{insert into `posts` \([^\)]*\) values \([^\)]*\)}i, segment.params[:sql]
+    end
+  end
+
+  def test_queries_can_get_explain_plan_with_obfuscated_sql
+    config = {
+      :'transaction_tracer.explain_threshold' => -0.01,
+      :'transaction_tracer.record_sql' => 'obfuscated'
+    }
+    with_config(config) do
+      segment = last_segment_for(:record_sql => :obfuscated) do
+        @posts[:id => 11]
+      end
+      assert_match %r{select \* from `posts` where \(?`id` = \?\)?}i, segment.params[:sql]
+      assert_segment_has_explain_plan( segment )
+    end
+  end
+
+  def test_notices_sql_with_proper_metric_name
+    config = {
+      :'transaction_tracer.explain_threshold' => -0.01,
+      :'transaction_tracer.record_sql' => 'obfuscated'
+    }
+    with_config(config) do
+      in_web_transaction { @posts.all }
+      expected_metric_name = "Datastore/operation/#{product_name}/select"
+      recorded_metric_names = NewRelic::Agent.agent.sql_sampler.sql_traces.values.map(&:database_metric_name)
+      assert_includes recorded_metric_names, expected_metric_name
+    end
+  end
+end
+
+else
+  puts "Skipping tests in #{__FILE__} because unsupported Sequel version"
+end

data/test/multiverse/suites/sequel/sequel_helpers.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+module SequelHelpers
+  def setup
+    super
+
+    DB.extension :newrelic_instrumentation
+
+    NewRelic::Agent.drop_buffered_data
+  end
+
+  def teardown
+    super
+
+    NewRelic::Agent.shutdown
+  end
+	#
+  # Helpers
+  #
+
+  # Pattern to match the column headers of a Sqlite explain plan
+  SQLITE_EXPLAIN_PLAN_COLUMNS_RE =
+    %r{\|addr\s*\|opcode\s*\|p1\s*\|p2\s*\|p3\s*\|p4\s*\|p5\s*\|comment\s*\|}
+
+  # This is particular to sqlite plans currently. To abstract it up, we'd need to
+  # be able to specify a flavor (e.g., :sqlite, :postgres, :mysql, etc.)
+  def assert_segment_has_explain_plan( segment, msg=nil )
+    msg = "Expected #{segment.inspect} to have an explain plan"
+    assert_block( msg ) { segment.params[:explain_plan].join =~ SQLITE_EXPLAIN_PLAN_COLUMNS_RE }
+  end
+
+  def last_segment_for(options={})
+      in_transaction('sandwiches/index') do
+        yield
+      end
+      sample = NewRelic::Agent.instance.transaction_sampler.last_sample
+      sample.prepare_to_send!
+      last_segment(sample)
+  end
+
+  def last_segment(txn_sample)
+    l_segment = nil
+    txn_sample.root_segment.each_segment do |segment|
+      l_segment = segment
+    end
+    l_segment
+  end
+
+  def product_name
+    if defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
+      "JDBC"
+    else
+      "SQLite"
+    end
+  end
+
+  def assert_datastore_metrics_recorded_exclusive(metrics, options = {})
+    assert_metrics_recorded_exclusive(metrics, {:filter => /^Datastores/}.update(options))
+  end
+end

data/test/multiverse/suites/sequel/sequel_plugin_test.rb

@@ -0,0 +1,230 @@
+# encoding: utf-8
+# This file is distributed under New Relic's license terms.
+# See https://github.com/newrelic/rpm/blob/master/LICENSE for complete details.
+
+require File.join(File.dirname(__FILE__), 'database.rb')
+require File.join(File.dirname(__FILE__), 'sequel_helpers.rb')
+
+if Sequel.const_defined?( :MAJOR ) &&
+      ( Sequel::MAJOR > 3 ||
+        Sequel::MAJOR == 3 && Sequel::MINOR >= 37 )
+
+require 'newrelic_rpm'
+
+class SequelPluginTest < Minitest::Test
+  include SequelHelpers
+
+  def expected_metrics_for_operation(operation)
+    [
+      ["Datastore/statement/#{product_name}/Post/#{operation}", "dummy"],
+      "Datastore/statement/#{product_name}/Post/#{operation}",
+      "Datastore/operation/#{product_name}/#{operation}",
+      "Datastore/#{product_name}/allWeb",
+      "Datastore/allWeb",
+      "Datastore/#{product_name}/all",
+      "Datastore/all",
+      "dummy",
+      "Apdex"
+    ]
+  end
+
+  def test_sequel_model_instrumentation_is_loaded
+    assert Post.respond_to?( :trace_execution_scoped )
+  end
+
+  def test_model_enumerator_generates_metrics
+    in_web_transaction { Post.all }
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:all))
+  end
+
+  def test_model_index_operator_generates_metrics
+    in_web_transaction { Post[11] }
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:get))
+  end
+
+  def test_model_create_method_generates_metrics
+    in_web_transaction do
+      Post.create( :title => 'The Thing', :content => 'A wicked short story.' )
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:create))
+  end
+
+  def test_model_update_method_generates_metrics
+    in_web_transaction do
+      post = NewRelic::Agent.disable_all_tracing do
+        Post.create( :title => 'All The Things', :content => 'A story about beans.' )
+      end
+
+      post.update( :title => 'A Lot of the Things' )
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:update))
+  end
+
+  def test_model_update_all_method_generates_metrics
+    in_web_transaction do
+      post = NewRelic::Agent.disable_all_tracing do
+        Post.create( :title => 'All The Things', :content => 'A nicer story than yours.' )
+      end
+
+      post.update_all( :title => 'A Whole Hell of a Lot of the Things' )
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:update_all))
+  end
+
+  def test_model_update_except_method_generates_metrics
+    in_web_transaction do
+      post = NewRelic::Agent.disable_all_tracing do
+        Post.create( :title => 'All The Things', :content => 'A story.' )
+      end
+
+      post.update_except( {:title => 'A Bit More of the Things'} )
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:update_except))
+  end
+
+  def test_model_update_fields_method_generates_metrics
+    in_web_transaction do
+      post = NewRelic::Agent.disable_all_tracing do
+        Post.create( :title => 'All The Things', :content => 'A venal short story.' )
+      end
+
+      post.update_fields( {:title => 'A Plethora of Things'}, [:title] )
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:update_fields))
+  end
+
+  def test_model_update_only_method_generates_metrics
+    in_web_transaction do
+      post = NewRelic::Agent.disable_all_tracing do
+        Post.create( :title => 'All The Things', :content => 'A meandering short story.' )
+      end
+
+      post.update_only( {:title => 'A Lot of the Things'}, :title )
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:update_only))
+  end
+
+  def test_model_save_method_generates_metrics
+    in_web_transaction do
+      post = NewRelic::Agent.disable_all_tracing do
+        Post.new( :title => 'An Endless Lot Full of Things',
+                  :content => 'A lingering long story.' )
+      end
+
+      post.save
+    end
+
+   assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:save))
+  end
+
+  def test_model_delete_method_generates_metrics
+    in_web_transaction do
+      post = NewRelic::Agent.disable_all_tracing do
+        Post.create( :title => 'All The Things', :content => 'A nice short story.' )
+      end
+
+      post.delete
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:delete))
+  end
+
+  def test_model_destroy_method_generates_metrics
+    in_web_transaction do
+      post = NewRelic::Agent.disable_all_tracing do
+        Post.create( :title => 'Most of the Things', :content => 'Another short story.' )
+      end
+
+      post.destroy
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:destroy))
+  end
+
+  def test_model_destroy_uses_the_class_name_for_the_metric
+    in_web_transaction do
+      post = NewRelic::Agent.disable_all_tracing do
+        Post.create( :title => 'Some of the Things', :content => 'A shorter story.' )
+      end
+
+      post.destroy
+    end
+
+    assert_datastore_metrics_recorded_exclusive(expected_metrics_for_operation(:destroy))
+  end
+
+  def test_slow_queries_get_an_explain_plan
+    with_config( :'transaction_tracer.explain_threshold' => -0.01,
+                 :'transaction_tracer.record_sql' => 'raw' ) do
+      segment = last_segment_for do
+        Post[11]
+      end
+      assert_match %r{select \* from `posts` where `id` = 11}i, segment.params[:sql]
+      assert_segment_has_explain_plan( segment )
+    end
+  end
+
+  def test_sql_is_recorded_in_tt_for_non_select
+    with_config(:'transaction_tracer.record_sql' => 'raw') do
+      segment = last_segment_for do
+        Post.create(:title => 'title', :content => 'content')
+      end
+      assert_match %r{insert into `posts` \([^\)]*\) values \([^\)]*\)}i, segment.params[:sql]
+    end
+  end
+
+  def test_no_explain_plans_with_single_threaded_connection
+    connect_opts = DB.opts
+    single_threaded_db = Sequel.connect(connect_opts.merge(:single_threaded => true))
+    create_tables(single_threaded_db)
+    model_class = Class.new(Sequel::Model(single_threaded_db[:posts]))
+
+    with_config(:'transaction_tracer.explain_threshold' => -0.01,
+                :'transaction_tracer.record_sql' => 'raw') do
+      segment = last_segment_for do
+        model_class[11]
+      end
+      assert_match %r{select \* from `posts` where `id` = 11}i, segment.params[:sql]
+      assert_equal([], segment.params[:explain_plan], "Should not capture explain plan with single-threaded connection pool")
+    end
+  end
+
+  def test_queries_can_get_explain_plan_with_obfuscated_sql
+    config = {
+      :'transaction_tracer.explain_threshold' => -0.01,
+      :'transaction_tracer.record_sql' => 'obfuscated'
+    }
+    with_config(config) do
+      segment = last_segment_for(:record_sql => :obfuscated) do
+        Post[11]
+      end
+      assert_match %r{select \* from `posts` where `id` = \?}i, segment.params[:sql]
+      assert_segment_has_explain_plan( segment )
+    end
+  end
+
+  def test_notices_sql_with_proper_metric_name_for_select
+    config = {
+      :'transaction_tracer.explain_threshold' => -0.01,
+      :'transaction_tracer.record_sql' => 'obfuscated'
+    }
+    with_config(config) do
+      in_web_transaction { Post.all }
+      expected_metric_name = "Datastore/operation/#{product_name}/select"
+      recorded_metric_names = NewRelic::Agent.agent.sql_sampler.sql_traces.values.map(&:database_metric_name)
+      assert recorded_metric_names.include? expected_metric_name
+    end
+  end
+end
+
+else
+  puts "Skipping tests in #{__FILE__} because unsupported Sequel version"
+end