newrelic_rpm 3.6.9.171 → 3.7.0.174.beta

data/lib/new_relic/agent/transaction.rb

@@ -215,7 +215,8 @@ module NewRelic
           :type             => @type,
           :start_timestamp  => start_time.to_f,
           :duration         => end_time.to_f - start_time.to_f,
-          :overview_metrics => overview_metrics
+          :overview_metrics => overview_metrics,
+          :custom_params    => custom_parameters
         }
         agent.events.notify(:transaction_finished, payload)
       end
@@ -295,12 +296,9 @@ module NewRelic
         (current && current.custom_parameters) ? current.custom_parameters : {}
       end
 
-      def self.set_user_attributes(attributes)
-        current.set_user_attributes(attributes) if current
-      end
-
-      def self.user_attributes
-        (current) ? current.user_attributes : {}
+      class << self
+        alias_method :user_attributes, :custom_parameters
+        alias_method :set_user_attributes, :add_custom_parameters
       end
 
       APDEX_METRIC_SPEC = NewRelic::MetricSpec.new('Apdex').freeze
@@ -357,20 +355,15 @@ module NewRelic
         @custom_parameters ||= {}
       end
 
-      def user_attributes
-        @user_atrributes ||= {}
-      end
-
-      def queue_time
-        @apdex_start ? @start_time - @apdex_start : 0
-      end
-
       def add_custom_parameters(p)
         custom_parameters.merge!(p)
       end
 
-      def set_user_attributes(attributes)
-        user_attributes.merge!(attributes)
+      alias_method :user_attributes, :custom_parameters
+      alias_method :set_user_attributes, :add_custom_parameters
+
+      def queue_time
+        @apdex_start ? @start_time - @apdex_start : 0
       end
 
       # Returns truthy if the current in-progress transaction is considered a

data/lib/new_relic/coerce.rb

@@ -42,6 +42,32 @@ module NewRelic
       ""
     end
 
+    # Convert a hash into a format acceptable to be included with Transaction
+    # event data.
+    #
+    # We accept a hash and will return a new hash where all of the keys
+    # have been converted to strings.  As values we only allow Strings,
+    # Floats, Integers. Symbols are also allowed but are converted to strings.
+    # Any values of other type (e.g. Hash, Array, any other class) are
+    # discarded. Their keys are also removed from the results hash.
+    def event_params(value, context=nil)
+      unless value.is_a? Hash
+        raise ArgumentError, "Expected Hash but got #{value.class}"
+      end
+      value.inject({}) do |memo, (key, val)|
+        case val
+        when String, Float, Integer
+          memo[key.to_s] = val
+        when Symbol
+          memo[key.to_s] = val.to_s
+        end
+      memo
+      end
+    rescue => error
+      log_failure(value.class, 'valid event params', context, error)
+      {}
+    end
+
     def log_failure(value, type, context, error)
       msg = "Unable to convert '#{value}' to #{type}"
       msg += " in context '#{context}'" if context

data/lib/new_relic/rack/browser_monitoring.rb

@@ -49,52 +49,28 @@ module NewRelic::Rack
     X_UA_COMPATIBLE_RE = /<\s*meta[^>]+http-equiv=['"]x-ua-compatible['"][^>]*>/im.freeze
 
     def autoinstrument_source(response, headers)
-      source = nil
-      response.each {|fragment| source ? (source << fragment.to_s) : (source = fragment.to_s)}
+      source = gather_source(response)
+      close_old_response(response)
       return nil unless source
 
-
       # Only scan the first 50k (roughly) then give up.
       beginning_of_source = source[0..50_000]
-      # Don't scan for body close unless we find body start
-      if (body_start = beginning_of_source.index("<body")) && (body_close = source.rindex("</body>"))
-
-        footer = NewRelic::Agent.browser_timing_footer
-        header = NewRelic::Agent.browser_timing_header
-
-        match = X_UA_COMPATIBLE_RE.match(beginning_of_source)
-        x_ua_compatible_position = match.end(0) if match
-
-        head_pos = if x_ua_compatible_position
-          # put after X-UA-Compatible meta tag if found
-          ::NewRelic::Agent.logger.debug "Detected X-UA-Compatible meta tag. Attempting to insert RUM header after meta tag."
-          x_ua_compatible_position
-        elsif head_open = beginning_of_source.index("<head")
-          ::NewRelic::Agent.logger.debug "Attempting to insert RUM header at beginning of head."
-          # put at the beginning of the header
-          beginning_of_source.index(">", head_open) + 1
-        else
-          ::NewRelic::Agent.logger.debug "Failed to detect head tag. Attempting to insert RUM header at above body tag."
-          # otherwise put the header right above body start
-          body_start
-        end
 
-        # check that head_pos is less than body close.  If it's not something
-        # is really weird and we should punt.
-        if head_pos && (head_pos < body_close)
-          # rebuild the source
-          source = source[0...head_pos] <<
-            header <<
-            source[head_pos...body_close] <<
-            footer <<
-            source[body_close..-1]
+      if body_start = find_body_start(beginning_of_source)
+        insertion_index = find_x_ua_compatible_position(beginning_of_source) ||
+                          find_end_of_head_open(beginning_of_source) ||
+                          body_start
+
+        if insertion_index
+          source = source[0...insertion_index] <<
+            NewRelic::Agent.browser_timing_footer <<   # sic, footer is now considered "config". Rename soon?
+            NewRelic::Agent.browser_timing_header <<
+            source[insertion_index..-1]
         else
-          if head_pos
-            ::NewRelic::Agent.logger.debug "Skipping RUM instrumentation. Failed to detect head tags."
-          else
-            ::NewRelic::Agent.logger.debug "Skipping RUM instrumentation. Detected head is after detected body close."
-          end
+          NewRelic::Agent.logger.debug "Skipping RUM instrumentation. Could not properly determine location to inject script."
         end
+      else
+        NewRelic::Agent.logger.debug "Skipping RUM instrumentation. Unable to find <body> tag in document."
       end
 
       if headers['Content-Length']
@@ -104,6 +80,34 @@ module NewRelic::Rack
       source
     end
 
+    def gather_source(response)
+      source = nil
+      response.each {|fragment| source ? (source << fragment.to_s) : (source = fragment.to_s)}
+      source
+    end
+
+    # Per "The Response > The Body" section of Rack spec, we should close
+    # if our response is able. http://rack.rubyforge.org/doc/SPEC.html
+    def close_old_response(response)
+      if response.respond_to?(:close)
+        response.close
+      end
+    end
+
+    def find_body_start(beginning_of_source)
+      beginning_of_source.index("<body")
+    end
+
+    def find_x_ua_compatible_position(beginning_of_source)
+      match = X_UA_COMPATIBLE_RE.match(beginning_of_source)
+      match.end(0) if match
+    end
+
+    def find_end_of_head_open(beginning_of_source)
+      head_open = beginning_of_source.index("<head")
+      beginning_of_source.index(">", head_open) + 1 if head_open
+    end
+
     # String does not respond to 'bytesize' in 1.8.6. Fortunately String#length
     # returns bytes rather than characters in 1.8.6 so we can use that instead.
     def calculate_content_length(source)

data/lib/new_relic/version.rb

@@ -11,8 +11,8 @@ module NewRelic
     end
 
     MAJOR = 3
-    MINOR = 6
-    TINY  = 9
+    MINOR = 7
+    TINY  = 0
 
     begin
       require File.join(File.dirname(__FILE__), 'build')

data/lib/tasks/install.rake

@@ -38,6 +38,7 @@ namespace :newrelic do
       puts "<thead>"
       puts "  <th>Setting</th>"
       puts "  <th style='width: 15%'>Type</th>"
+      puts "  <th>Default</th>"
       puts "  <th>Description</th>"
       puts "</thead>"
 

data/test/agent_helper.rb

@@ -326,7 +326,7 @@ end
 
 def wait_for_backtrace_service_poll(opts={})
   defaults = {
-    :timeout => 5.0,
+    :timeout => 10.0,
     :service => NewRelic::Agent.agent.agent_command_router.backtrace_service,
     :iterations => 1
   }
@@ -335,7 +335,7 @@ def wait_for_backtrace_service_poll(opts={})
   until opts[:service].worker_loop.iterations > opts[:iterations]
     sleep(0.01)
     if Time.now > deadline
-      raise "Timed out waiting #{timeout} s for backtrace service poll"
+      raise "Timed out waiting #{opts[:timeout]} s for backtrace service poll"
     end
   end
 end

data/test/environments/rails40/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 gem 'rake'
 
-gem 'rails', '~>4.0.0'
+gem 'rails', '~>4.0.1'
 
 gem "mocha", '~>0.13.0', :require => false
 gem 'rack'

data/test/multiverse/lib/multiverse/suite.rb

@@ -207,7 +207,17 @@ module Multiverse
       options << "-v" if verbose?
       options << "--seed=#{seed}" unless seed == ""
       options << "--name=/#{names.map {|n| n + ".*"}.join("|")}/" unless names == []
-      exit(::MiniTest::Unit.new.run(options))
+
+      original_options = options.dup
+      test_run = ::MiniTest::Unit.new.run(options)
+
+      if test_run
+        exit(test_run)
+      else
+        puts "No tests found with those options."
+        puts "options: #{original_options}"
+        exit(1)
+      end
     end
 
     def configure_before_bundling

data/test/multiverse/suites/agent_only/rum_instrumentation_test.rb

@@ -14,8 +14,13 @@ class RumAutoTest < MiniTest::Unit::TestCase
   include Rack::Test::Methods
   include MultiverseHelpers
 
+  JS_AGENT_LOADER = "JS_AGENT_LOADER"
+
+  LOADER_REGEX = "\n<script.*>JS_AGENT_LOADER</script>"
+  CONFIG_REGEX = "\n<script.*>.*NREUM.info=.*</script>"
+
   setup_and_teardown_agent(:browser_key => 'browserKey', :application_id => 'appId',
-                            :beacon => 'beacon', :episodes_file => 'this_is_my_file')
+                            :beacon => 'beacon', :js_agent_loader => JS_AGENT_LOADER)
 
   def after_setup
     @inner_app = TestingApp.new
@@ -25,36 +30,31 @@ class RumAutoTest < MiniTest::Unit::TestCase
   def test_autoinstrumentation_is_active
     @inner_app.response = "<html><head><title>W00t!</title></head><body><p>Hello World</p></body></html>"
     get '/'
-    assert(last_response.body =~ %r|<script|, "response body should include RUM auto instrumentation js:\n #{last_response.body}")
-    assert(last_response.body =~ %r|NREUMQ|, "response body should include RUM auto instrumentation js:\n #{last_response.body}")
+    assert_response_includes("<script", JS_AGENT_LOADER, "NREUM")
   end
 
   def test_autoinstrumentation_with_basic_page_puts_header_at_beginning_of_head
     @inner_app.response = "<html><head><title>foo</title></head><body><p>Hello World</p></body></html>"
-    NewRelic::Agent.logger.debug("================================")
     get '/'
-    NewRelic::Agent.logger.debug("================================")
-    assert(last_response.body.include?('<html><head><script type="text/javascript">var NREUMQ=NREUMQ||[];NREUMQ.push(["mark","firstbyte",new Date().getTime()]);</script><title>foo</title></head><body>'))
+    assert_response_includes(%Q[<html><head>#{CONFIG_REGEX}#{LOADER_REGEX}<title>foo</title></head>])
   end
 
   def test_autoinstrumentation_with_body_only_puts_header_before_body
     @inner_app.response = "<html><body><p>Hello World</p></body></html>"
     get '/'
-    assert(last_response.body.include?('<html><script type="text/javascript">var NREUMQ=NREUMQ||[];NREUMQ.push(["mark","firstbyte",new Date().getTime()]);</script><body>'))
+    assert_response_includes %Q[<html>#{CONFIG_REGEX}#{LOADER_REGEX}<body>]
   end
 
   def test_autoinstrumentation_with_X_UA_Compatible_puts_header_after_meta_tag
-    @inner_app.response = '<html><head><meta http-equiv="X-UA-Compatible" content="IE=8;FF=3;OtherUA=4" /></head><body><p>Hello World</p></body></html>'
+    @inner_app.response = '<html><head><meta http-equiv="X-UA-Compatible"/></head><body><p>Hello World</p></body></html>'
     get '/'
-    assert(last_response.body.include?(
-      '<html><head><meta http-equiv="X-UA-Compatible" content="IE=8;FF=3;OtherUA=4" /><script type="text/javascript">var NREUMQ=NREUMQ||[];NREUMQ.push(["mark","firstbyte",new Date().getTime()]);</script></head><body>'
-    ))
+    assert_response_includes(%Q[<html><head><meta http-equiv="X-UA-Compatible"/>#{CONFIG_REGEX}#{LOADER_REGEX}</head><body>])
   end
 
   def test_autoinstrumentation_doesnt_run_for_crazy_shit_like_this
     @inner_app.response = '<html><head <body </body>'
     get '/'
-    assert_equal('<html><head <body </body>', last_response.body)
+    assert_response_includes('<html><head <body </body>')
   end
 
   def test_content_length_is_correctly_set_if_present
@@ -73,4 +73,11 @@ class RumAutoTest < MiniTest::Unit::TestCase
     get '/'
     assert_equal(last_response.body, body)
   end
+
+  def assert_response_includes(*texts)
+    texts.each do |text|
+      assert_match(Regexp.new(text), last_response.body,
+                   "Response missing #{text} for JS Agent instrumentation:\n #{last_response.body}")
+    end
+  end
 end

data/test/multiverse/suites/rails/Envfile

@@ -1,10 +1,6 @@
-suite_condition("Rails 3+ do not support 1.8.6") do
-  RUBY_VERSION != '1.8.6'
-end
-
 if RUBY_VERSION >= '1.9.3'
   gemfile <<-RB
-    gem 'rails', '~>4.0.0'
+    gem 'rails', '~>4.0.1'
     gem 'haml', '4.0.2'   # Getting load issues with haml 4.0.3
   RB
 end

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

@@ -22,7 +22,7 @@ class QueueTimeTest < ActionDispatch::IntegrationTest
 
   include MultiverseHelpers
 
-  setup_and_teardown_agent(:beacon => "beacon", :browser_key => "key")
+  setup_and_teardown_agent(:beacon => "beacon", :browser_key => "key", :js_agent_loader => "loader")
 
   def test_should_track_queue_time_metric
     get_queued
@@ -43,7 +43,8 @@ class QueueTimeTest < ActionDispatch::IntegrationTest
   end
 
   def extract_queue_time_from_response
-    @response.body =~ /key\","",\".*\",(\d+.*),\d+,new Date/
+    @response.body =~ /\"queueTime\":(\d+.*)/
+    refute_nil $1, "Should have found queue time in #{@response.body.inspect}"
     $1.to_i
   end
 end

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

@@ -16,6 +16,11 @@ class RequestStatsController < ApplicationController
     sleep 0.01
     render :text => 'some stuff'
   end
+
+  def stats_action_with_custom_params
+    ::NewRelic::Agent.add_custom_parameters('color' => 'blue', 1 => :bar, 'bad' => {})
+    render :text => 'some stuff'
+  end
 end
 
 class RequestStatsTest < ActionController::TestCase
@@ -62,6 +67,30 @@ class RequestStatsTest < ActionController::TestCase
     end
   end
 
+  def test_custom_params_should_be_reported_with_events_and_coerced_to_safe_types
+    with_config( :'analytics_events.enabled' => true ) do
+      20.times { get :stats_action_with_custom_params }
+
+      NewRelic::Agent.agent.send(:harvest_and_send_analytic_event_data)
+
+      post = $collector.calls_for('analytic_event_data').first
+
+      refute_nil( post )
+      assert_kind_of Array, post.body
+      assert_kind_of Array, post.body.first
+
+      sample = post.body.first.first
+      assert_kind_of Hash, sample
+
+      assert_equal 'Controller/request_stats/stats_action_with_custom_params', sample['name']
+      assert_encoding 'utf-8', sample['name']
+      assert_equal 'Transaction', sample['type']
+      assert_equal 'blue', sample['color']
+      assert_equal 'bar', sample['1']
+      assert_false sample.has_key?('bad')
+    end
+  end
+
   def test_request_samples_should_be_preserved_upon_failure
     with_config(:'analytics_events.enabled' => true) do
       5.times { get :stats_action }

data/test/multiverse/suites/sidekiq/Envfile

@@ -3,7 +3,16 @@ suite_condition("SideKiq requires MRI 1.9.3 or JRuby 1.6 in 1.9 mode") do
 end
 
 gemfile <<-RB
+  # Latest version
   gem 'json'
-  gem 'sidekiq'
+  gem 'sidekiq', '~> 2.16.1'
+  gem 'rack'
+RB
+
+gemfile <<-RB
+  # Almost oldest supported version
+  # Having rbx issues on 2.8.0, 2.9.0 seems fine.
+  gem 'json'
+  gem 'sidekiq', '~> 2.9.0'
   gem 'rack'
 RB

data/test/multiverse/suites/sinatra/Envfile

@@ -1,18 +1,14 @@
-suite_condition("Sinatra not compatible with 1.8.6") do
-  RUBY_VERSION != '1.8.6'
-end
-
 gemfile <<-RB
-  gem 'sinatra', '~> 1.4.0'
+  gem 'sinatra', '~> 1.4.4'
   gem 'rack-test', :require => 'rack/test'
 RB
 
 gemfile <<-RB
-  gem 'sinatra', '~> 1.3.0'
+  gem 'sinatra', '~> 1.3.6'
   gem 'rack-test', :require => 'rack/test'
 RB
 
 gemfile <<-RB
-  gem 'sinatra', '~> 1.2.0'
+  gem 'sinatra', '~> 1.2.9'
   gem 'rack-test', :require => 'rack/test'
 RB

data/test/new_relic/agent/beacon_configuration_test.rb

@@ -4,13 +4,13 @@
 
 require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper'))
 require "new_relic/agent/beacon_configuration"
+
 class NewRelic::Agent::BeaconConfigurationTest < Test::Unit::TestCase
   def test_initialize_basic
     with_config(:application_id => 'an application id',
                 :beacon => 'beacon', :'rum.enabled' => true) do
       bc = NewRelic::Agent::BeaconConfiguration.new
       assert_equal true, bc.enabled?
-      assert_equal '', bc.browser_timing_header
     end
   end
 
@@ -19,93 +19,26 @@ class NewRelic::Agent::BeaconConfigurationTest < Test::Unit::TestCase
                 :beacon => 'beacon', :'rum.enabled' => true) do
       bc = NewRelic::Agent::BeaconConfiguration.new
       assert bc.enabled?
-      s = "<script type=\"text/javascript\">var NREUMQ=NREUMQ||[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);</script>"
-      assert_equal(s, bc.browser_timing_header)
     end
   end
 
-  def test_license_bytes_nil
-    with_config(:license_key => 'a' * 40) do
-      bc = NewRelic::Agent::BeaconConfiguration.new
-      assert_equal([97] * 40, bc.license_bytes, 'should return the bytes of the license key')
-    end
-  end
-
-  def test_license_bytes_existing_bytes
-    bc = NewRelic::Agent::BeaconConfiguration.new
-    bc.instance_eval { @license_bytes = [97] * 40 }
-    NewRelic::Agent.config.expects(:[]).with('license_key').never
-    assert_equal([97] * 40, bc.license_bytes, "should return the cached value if it exists")
-  end
+  ARRAY_OF_A = [97] * 40
 
-  def test_license_bytes_should_set_instance_cache
+  def test_license_bytes
     with_config(:license_key => 'a' * 40) do
       bc = NewRelic::Agent::BeaconConfiguration.new
-      bc.instance_eval { @license_bytes = nil }
-      bc.license_bytes
-      assert_equal([97] * 40, bc.instance_variable_get('@license_bytes'), "should cache the license bytes for later")
-    end
-  end
-
-  def test_build_browser_timing_header_disabled
-    bc = NewRelic::Agent::BeaconConfiguration.new
-    bc.instance_eval { @rum_enabled = false }
-    assert_equal '', bc.build_browser_timing_header, "should not return a header when rum enabled is false"
-  end
-
-  def test_build_browser_timing_header_enabled_but_no_key
-    bc = NewRelic::Agent::BeaconConfiguration.new
-    bc.instance_eval { @rum_enabled = true; @browser_monitoring_key = nil }
-    assert_equal '', bc.build_browser_timing_header, "should not return a header when browser_monitoring_key is nil"
-  end
-
-  def test_build_browser_timing_header_enabled_with_key
-    with_config(:browser_key => 'a browser monitoring key', :beacon => 'beacon') do
-      bc = NewRelic::Agent::BeaconConfiguration.new
-      assert(bc.build_browser_timing_header.include?('NREUMQ'),
-             "header should be generated when rum is enabled and browser monitoring key is set")
+      assert_equal(ARRAY_OF_A, bc.license_bytes)
     end
   end
 
-  def test_build_browser_timing_header_should_html_safe_header
-    with_config(:browser_key => 'a' * 40, :beacon => 'beacon') do
-      mock_javascript = mock('javascript')
-      bc = NewRelic::Agent::BeaconConfiguration.new
-      bc.expects(:javascript_header).returns(mock_javascript)
-      mock_javascript.expects(:respond_to?).with(:html_safe).returns(true)
-      mock_javascript.expects(:html_safe)
-      bc.build_browser_timing_header
-    end
-  end
-
-  def test_build_load_file_js_load_episodes_file_false
-    with_config(:'rum.load_episodes_file' => false) do
+  def test_license_bytes_are_memoized
+    with_config(:license_key => 'a' * 40) do
       bc = NewRelic::Agent::BeaconConfiguration.new
-      s = "if (!NREUMQ.f) { NREUMQ.f=function() {\nNREUMQ.push([\"load\",new Date().getTime()]);\nif(NREUMQ.a)NREUMQ.a();\n};\nNREUMQ.a=window.onload;window.onload=NREUMQ.f;\n};\n"
-      assert_equal(s, bc.build_load_file_js)
-    end
-  end
+      assert_equal(ARRAY_OF_A, bc.license_bytes)
 
-  def test_build_load_file_js_load_episodes_file_missing
-    with_config(:'rum.load_episodes_file' => '') do
-      bc = NewRelic::Agent::BeaconConfiguration.new
-      s = "if (!NREUMQ.f) { NREUMQ.f=function() {\nNREUMQ.push([\"load\",new Date().getTime()]);\nif(NREUMQ.a)NREUMQ.a();\n};\nNREUMQ.a=window.onload;window.onload=NREUMQ.f;\n};\n"
-      assert_equal(s, bc.build_load_file_js)
+      NewRelic::Agent.config.apply_config(:license_key => 'b' * 40)
+      assert_equal(ARRAY_OF_A, bc.license_bytes)
     end
   end
 
-  def test_build_load_file_js_load_episodes_file_present
-    bc = NewRelic::Agent::BeaconConfiguration.new
-#     s = "if (!NREUMQ.f) { NREUMQ.f=function() {\nNREUMQ.push([\"load\",new Date().getTime()]);\nvar e=document.createElement(\"script\");\ne.type=\"text/javascript\";e.async=true;e.src=\"\";\ndocument.body.appendChild(e);\nif(NREUMQ.a)NREUMQ.a();\n};\nNREUMQ.a=window.onload;window.onload=NREUMQ.f;\n};\n"
-    s = "if (!NREUMQ.f) { NREUMQ.f=function() {\nNREUMQ.push([\"load\",new Date().getTime()]);\nvar e=document.createElement(\"script\");\ne.type=\"text/javascript\";\ne.src=((\"http:\"===document.location.protocol)?\"http:\":\"https:\") + \"//\" +\n  \"\";\ndocument.body.appendChild(e);\nif(NREUMQ.a)NREUMQ.a();\n};\nNREUMQ.a=window.onload;window.onload=NREUMQ.f;\n};\n"
-    assert_equal(s, bc.build_load_file_js)
-  end
-
-  def test_build_load_file_js_load_episodes_file_with_episodes_file
-    with_config(:episodes_file => 'an episodes url') do
-      bc = NewRelic::Agent::BeaconConfiguration.new
-      assert(bc.build_load_file_js.include?('an episodes url'),
-             "should include the episodes url by default")
-    end
-  end
 end