newrelic_rpm 3.6.9.171 → 3.7.0.174.beta

data/test/new_relic/agent/browser_monitoring_test.rb

@@ -9,21 +9,16 @@ require 'base64'
 
 class NewRelic::Agent::BrowserMonitoringTest < Test::Unit::TestCase
   include NewRelic::Agent::BrowserMonitoring
-  include NewRelic::Agent::Instrumentation::ControllerInstrumentation
 
   def setup
-    NewRelic::Agent.manual_start
     @config = {
       :beacon                 => 'beacon',
       :browser_key            => 'browserKey',
       :application_id         => '5, 6', # collector can return app multiple ids
       :'rum.enabled'          => true,
-      :episodes_file          => 'this_is_my_file',
-      :'rum.jsonp'            => true,
-      :license_key            => 'a' * 40
+      :license_key            => "\0"  # no-op obfuscation key
     }
     NewRelic::Agent.config.apply_config(@config)
-    @episodes_file = "this_is_my_file"
     NewRelic::Agent.instance.instance_eval do
       @beacon_configuration = NewRelic::Agent::BeaconConfiguration.new
     end
@@ -40,6 +35,22 @@ class NewRelic::Agent::BrowserMonitoringTest < Test::Unit::TestCase
     mocha_teardown
   end
 
+  def test_js_errors_beta_default_gets_default_loader
+    assert_equal "rum", NewRelic::Agent.config[:'browser_monitoring.loader']
+  end
+
+  def test_js_errors_beta_gets_full_loader
+    with_config(:js_errors_beta => true) do
+      assert_equal "full", NewRelic::Agent.config[:'browser_monitoring.loader']
+    end
+  end
+
+  def test_js_errors_beta_off_gets_default_loader
+    with_config(:js_errors_beta => false) do
+      assert_equal "rum", NewRelic::Agent.config[:'browser_monitoring.loader']
+    end
+  end
+
   def test_auto_instrumentation_config_defaults_to_enabled
     assert NewRelic::Agent.config[:'browser_monitoring.auto_instrument']
   end
@@ -68,82 +79,68 @@ class NewRelic::Agent::BrowserMonitoringTest < Test::Unit::TestCase
 
   def test_browser_timing_header_with_no_beacon_configuration
     NewRelic::Agent.instance.stubs(:beacon_configuration).returns( nil)
-    header = browser_timing_header
-    assert_equal "", header
-  end
-
-  def test_browser_timing_header
-    header = browser_timing_header
-    assert_equal "<script type=\"text/javascript\">var NREUMQ=NREUMQ||[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);</script>", header
-  end
-
-  def test_browser_timing_header_with_rum_enabled_not_specified
-    NewRelic::Agent.instance.stubs(:beacon_configuration).returns( NewRelic::Agent::BeaconConfiguration.new)
-    header = browser_timing_header
-    assert_equal "<script type=\"text/javascript\">var NREUMQ=NREUMQ||[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);</script>", header
+    assert_equal "", browser_timing_header
   end
 
   def test_browser_timing_header_with_rum_enabled_false
     with_config(:'rum.enabled' => false) do
-      NewRelic::Agent.instance.stubs(:beacon_configuration).returns( NewRelic::Agent::BeaconConfiguration.new)
-      header = browser_timing_header
-      assert_equal "", header
+      NewRelic::Agent.instance.stubs(:beacon_configuration).returns(NewRelic::Agent::BeaconConfiguration.new)
+      assert_equal "", browser_timing_header
     end
   end
 
   def test_browser_timing_header_disable_all_tracing
-    header = nil
     NewRelic::Agent.disable_all_tracing do
-      header = browser_timing_header
+      assert_equal "", browser_timing_header
     end
-    assert_equal "", header
   end
 
   def test_browser_timing_header_disable_transaction_tracing
-    header = nil
     NewRelic::Agent.disable_transaction_tracing do
-      header = browser_timing_header
+      assert_equal "", browser_timing_header
     end
-    assert_equal "", header
   end
 
-  def test_browser_timing_header_with_loader_without_js_errors_beta
-    with_config(:js_agent_loader => 'loader') do
-      header = browser_timing_header
-      assert_equal("<script type=\"text/javascript\">var NREUMQ=NREUMQ||[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);</script>", header,
-                   "expected old RUM header but saw '#{header}'")
+  def test_browser_timing_header_without_loader
+    with_config(:js_agent_loader => '') do
+      assert_equal "", browser_timing_header
     end
   end
 
-  def test_browser_timing_header_with_js_errors_beta_without_loader
-    with_config(:js_errors_beta => true) do
-      header = browser_timing_header
-      assert_equal("<script type=\"text/javascript\">var NREUMQ=NREUMQ||[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);</script>", header,
-                   "expected old RUM header but saw '#{header}'")
+  def test_browser_timing_header_without_rum_enabled
+    with_config(:js_agent_loader => 'loader', :'rum.enabled' => false) do
+      assert_equal "", browser_timing_header
     end
   end
 
-  def test_browser_timing_header_with_js_errors_beta_and_loader
-    with_config(:js_errors_beta => true, :js_agent_loader => 'loader') do
-      header = browser_timing_header
-      assert_equal("\n<script type=\"text/javascript\">loader</script>", header,
-                   "expected new JS agent loader 'loader' but saw '#{header}'")
+  def test_browser_timing_header_with_loader
+    with_config(:js_agent_loader => 'loader') do
+      assert_has_js_agent_loader(browser_timing_header)
     end
   end
 
+  def assert_has_js_agent_loader(header)
+    assert_equal("\n<script type=\"text/javascript\">loader</script>",
+                 header,
+                 "expected new JS agent loader 'loader' but saw '#{header}'")
+  end
+
+  BEGINNING_OF_FOOTER = '<script type="text/javascript">window.NREUM||(NREUM={});NREUM.info='
+  END_OF_FOOTER = '}</script>'
+
   def test_browser_timing_footer
     with_config(:license_key => 'a' * 13) do
-      NewRelic::Agent::TransactionState.reset
       browser_timing_header
       footer = browser_timing_footer
-      snippet = '<script type="text/javascript">if (typeof NREUMQ !== "undefined") { if (!NREUMQ.f) { NREUMQ.f=function() {
-NREUMQ.push(["load",new Date().getTime()]);
-var e=document.createElement("script");'
-      assert(footer.include?(snippet),
-             "Expected footer to include snippet: #{snippet}, but instead was #{footer}")
+      assert_has_text(BEGINNING_OF_FOOTER, footer)
+      assert_has_text(END_OF_FOOTER, footer)
     end
   end
 
+  def assert_has_text(snippet, footer)
+    assert(footer.include?(snippet), "Expected footer to include snippet: #{snippet}, but instead was #{footer}")
+  end
+
   def test_browser_timing_footer_with_no_browser_key_rum_enabled
     with_config(:browser_key => '') do
       browser_timing_header
@@ -156,36 +153,17 @@ var e=document.createElement("script");'
   def test_browser_timing_footer_with_no_browser_key_rum_disabled
     with_config(:'rum.enabled' => false) do
       browser_timing_header
-      NewRelic::Agent.instance.stubs(:beacon_configuration) \
-        .returns(NewRelic::Agent::BeaconConfiguration.new)
+      NewRelic::Agent.instance.stubs(:beacon_configuration).returns(NewRelic::Agent::BeaconConfiguration.new)
       footer = browser_timing_footer
       assert_equal "", footer
     end
   end
 
-  def setup_beacon_config
-    NewRelic::Agent::TransactionState.reset
-    browser_timing_header
-
-    license_bytes = [];
-    ("a" * 13).each_byte {|byte| license_bytes << byte}
-    config =  NewRelic::Agent::BeaconConfiguration.new
-    config.expects(:license_bytes).returns(license_bytes).at_least_once
-    NewRelic::Agent.instance.stubs(:beacon_configuration).returns(config).at_least_once
-  end
-
   def test_browser_timing_footer_with_rum_enabled_not_specified
-    setup_beacon_config
-
     footer = browser_timing_footer
-    beginning_snippet = '<script type="text/javascript">if (typeof NREUMQ !== "undefined") { if (!NREUMQ.f) { NREUMQ.f=function() {
-NREUMQ.push(["load",new Date().getTime()]);
-var e=document.createElement("script");'
-    ending_snippet = "]);}</script>"
-    assert(footer.include?(beginning_snippet),
-           "expected footer to include beginning snippet: #{beginning_snippet}, but was #{footer}")
-    assert(footer.include?(ending_snippet),
-           "expected footer to include ending snippet: #{ending_snippet}, but was #{footer}")
+    beginning_snippet = BEGINNING_OF_FOOTER
+    assert_has_text(BEGINNING_OF_FOOTER, footer)
+    assert_has_text(END_OF_FOOTER, footer)
   end
 
   def test_browser_timing_footer_with_no_beacon_configuration
@@ -239,10 +217,8 @@ var e=document.createElement("script");'
     end
   end
 
-  def test_browser_timing_footer_with_js_errors_beta_and_loader
-    with_config(:js_errors_beta => true, :js_agent_loader => 'loader') do
-      setup_beacon_config
-
+  def test_browser_timing_footer_with_loader
+    with_config(:js_agent_loader => 'loader') do
       footer = browser_timing_footer
       beginning_snippet = "\n<script type=\"text/javascript\">window.NREUM||(NREUM={});NREUM.info={\""
       ending_snippet = '}</script>'
@@ -275,7 +251,7 @@ var e=document.createElement("script");'
 
   def test_browser_monitoring_transaction_name_when_tt_disabled
     with_config(:'transaction_tracer.enabled' => false) do
-      perform_action_with_newrelic_trace(:name => 'disabled_transactions') do
+      in_transaction('disabled_transactions') do
         self.class.inspect
       end
 
@@ -284,27 +260,159 @@ var e=document.createElement("script");'
     end
   end
 
-  def test_footer_js_string_basic
+  def test_extra_data
+    in_transaction do
+      with_config(ANALYTICS_TXN_IN_PAGE => true) do
+        NewRelic::Agent.add_custom_parameters({:boo => "hoo"})
+        assert_equal({:boo => "hoo"}, extra_data)
+      end
+    end
+  end
+
+  def test_extra_data_outside_transaction
+    NewRelic::Agent.add_custom_parameters({:boo => "hoo"})
+    assert extra_data.empty?
+  end
+
+  def test_format
+    assert_formatted({:a => "1", "b" => 2}, "a=1", "b=#2")
+  end
+
+  def test_format_extra_data_escaping
+    assert_formatted({"semi;colon" => "gets;escaped"}, "semi:colon=gets:escaped")
+    assert_formatted({"equal=key" => "equal=value"}, "equal-key=equal-value")
+    assert_formatted({'"quoted"' => '"marks"'}, %Q['quoted'='marks'])
+  end
+
+  def test_format_extra_data_disallowed_types
+    assert_formatted_empty({"nested" => { "hashes?" => "nope" }})
+    assert_formatted_empty({"lists" => ["are", "they", "allowed?", "nope"]})
+  end
+
+  def assert_formatted(data, *expected)
+    result = format_extra_data(data).split(";")
+    expected.each do |expect|
+      assert_includes(result, expect)
+    end
+  end
+
+  def assert_formatted_empty(data)
+    result = format_extra_data(data)
+    assert_equal("", result)
+  end
+
+  def test_footer_js_data
     freeze_time
     in_transaction do
-      txn = NewRelic::Agent::Transaction.current
-      user_attributes = {:user => "user", :account => "account", :product => "product"}
-      txn.stubs(:user_attributes).returns(user_attributes)
-      txn.stubs(:queue_time).returns(0)
-      txn.stubs(:start_time).returns(Time.now - 10)
-      txn.name = 'most recent transaction'
-
-      NewRelic::Agent::TransactionState.get.reset(nil)
-      NewRelic::Agent::TransactionState.get.request_token = '0123456789ABCDEF'
-      NewRelic::Agent::TransactionState.get.request_guid = 'ABC'
-
-      self.expects(:obfuscate).with(NewRelic::Agent.instance.beacon_configuration, 'most recent transaction').returns('most recent transaction')
-      self.expects(:obfuscate).with(NewRelic::Agent.instance.beacon_configuration, 'user').returns('user')
-      self.expects(:obfuscate).with(NewRelic::Agent.instance.beacon_configuration, 'account').returns('account')
-      self.expects(:obfuscate).with(NewRelic::Agent.instance.beacon_configuration, 'product').returns('product')
-
-      value = footer_js_string(NewRelic::Agent.instance.beacon_configuration)
-      assert_equal(%'<script type="text/javascript">if (typeof NREUMQ !== "undefined") { 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  "this_is_my_file";\ndocument.body.appendChild(e);\nif(NREUMQ.a)NREUMQ.a();\n};\nNREUMQ.a=window.onload;window.onload=NREUMQ.f;\n};\nNREUMQ.push(["nrfj","beacon","browserKey","5, 6","most recent transaction",0,10000,new Date().getTime(),"ABC","0123456789ABCDEF","user","account","product"]);}</script>', value, "should return the javascript given some default values")
+      with_config(ANALYTICS_TXN_IN_PAGE => true) do
+        NewRelic::Agent.set_user_attributes(:user => "user")
+
+        txn = NewRelic::Agent::Transaction.current
+        txn.stubs(:queue_time).returns(0)
+        txn.stubs(:start_time).returns(Time.now - 10)
+        txn.name = 'most recent transaction'
+
+        state = NewRelic::Agent::TransactionState.get
+        state.request_token = '0123456789ABCDEF'
+        state.request_guid = 'ABC'
+
+        data = js_data(NewRelic::Agent.instance.beacon_configuration)
+        expected = {
+          "beacon"          => "beacon",
+          "errorBeacon"     => nil,
+          "licenseKey"      => "browserKey",
+          "applicationID"   => "5, 6",
+          "transactionName" => pack("most recent transaction"),
+          "queueTime"       => 0,
+          "applicationTime" => 10000,
+          "ttGuid"          => "ABC",
+          "agentToken"      => "0123456789ABCDEF",
+          "agent"           => nil,
+          "extra"           => pack("user=user")
+        }
+
+        assert_equal(expected, data)
+
+        js = footer_js_string(NewRelic::Agent.instance.beacon_configuration)
+        expected.each do |key, value|
+          assert_match(/"#{key.to_s}":#{formatted_for_matching(value)}/, js)
+        end
+      end
+    end
+  end
+
+  ANALYTICS_ENABLED = :'analytics_events.enabled'
+  ANALYTICS_TXN_ENABLED = :'analytics_events.transactions.enabled'
+  ANALYTICS_TXN_IN_PAGE = :'capture_attributes.page_view_events'
+
+  def test_js_data_doesnt_pick_up_extras_by_default
+    in_transaction do
+      NewRelic::Agent.add_custom_parameters({:boo => "hoo"})
+      assert_extra_data_is("")
+    end
+  end
+
+  def test_js_data_picks_up_extras_when_configured
+    in_transaction do
+      with_config(ANALYTICS_ENABLED => true,
+                  ANALYTICS_TXN_ENABLED => true,
+                  ANALYTICS_TXN_IN_PAGE => true) do
+        NewRelic::Agent.add_custom_parameters({:boo => "hoo"})
+        assert_extra_data_is("boo=hoo")
+      end
+    end
+  end
+
+  def test_js_data_ignores_extras_if_no_analytics
+    in_transaction do
+      with_config(ANALYTICS_ENABLED => false,
+                  ANALYTICS_TXN_ENABLED => true,
+                  ANALYTICS_TXN_IN_PAGE => true) do
+        NewRelic::Agent.add_custom_parameters({:boo => "hoo"})
+        assert_extra_data_is("")
+      end
+    end
+  end
+
+  def test_js_data_ignores_extras_if_no_transaction_analytics
+    in_transaction do
+      with_config(ANALYTICS_ENABLED => true,
+                  ANALYTICS_TXN_ENABLED => false,
+                  ANALYTICS_TXN_IN_PAGE => true) do
+        NewRelic::Agent.add_custom_parameters({:boo => "hoo"})
+        assert_extra_data_is("")
+      end
+    end
+  end
+
+  def test_js_data_ignores_extras_if_not_allowed_in_page
+    in_transaction do
+      with_config(ANALYTICS_ENABLED => true,
+                  ANALYTICS_TXN_ENABLED => true,
+                  ANALYTICS_TXN_IN_PAGE => false) do
+        NewRelic::Agent.add_custom_parameters({:boo => "hoo"})
+        assert_extra_data_is("")
+      end
+    end
+  end
+
+  def assert_extra_data_is(expected)
+    data = js_data(NewRelic::Agent.instance.beacon_configuration)
+    assert_equal pack(expected), data["extra"]
+  end
+
+  def pack(text)
+    [text].pack("m0").gsub("\n", "")
+  end
+
+  def formatted_for_matching(value)
+    case value
+    when String
+      %Q["#{value}"]
+    when NilClass
+      "null"
+    else
+      value
     end
   end
 

data/test/new_relic/agent/request_sampler_test.rb

@@ -21,6 +21,45 @@ class NewRelic::Agent::RequestSamplerTest < Test::Unit::TestCase
     end
   end
 
+  def test_custom_parameters_in_event_are_normalized_to_string_keys
+    with_sampler_config do
+      generate_request('whatever', :custom_params => {:bing => 2, 1 => 3})
+      txn_event = @sampler.samples.first
+      assert_equal 2, txn_event['bing']
+      assert_equal 3, txn_event['1']
+    end
+  end
+
+
+  def test_includes_custom_parameters_in_event
+    with_sampler_config do
+      generate_request('whatever', :custom_params => {'bing' => 2})
+      txn_event = @sampler.samples.first
+      assert_equal 2, txn_event['bing']
+    end
+  end
+
+  def test_doesnt_include_custom_parameters_in_event_when_configured_not_to
+    with_sampler_config('capture_attributes.transaction_events' => false) do
+      generate_request('whatever', :custom_params => {'bing' => 2})
+      txn_event = @sampler.samples.first
+      assert_equal nil, txn_event['bing']
+    end
+  end
+
+  def test_custom_parameters_in_event_cant_override_reserved_attributes
+    with_sampler_config do
+      generate_request('whatever',
+        :overview_metrics => {'webDuration' => 0.01},
+        :custom_params => {'type' => 'giraffe', 'duration' => 'hippo', 'webDuration' => 'zebra'}
+      )
+      txn_event = @sampler.samples.first
+      assert_equal 'Transaction', txn_event['type']
+      assert_equal 0.1, txn_event['duration']
+      assert_equal 0.01, txn_event['webDuration']
+    end
+  end
+
   def test_samples_on_transaction_finished_event_includes_overview_metrics
     with_sampler_config do
       generate_request('name', :overview_metrics => {:foo => :bar})
@@ -130,7 +169,8 @@ class NewRelic::Agent::RequestSamplerTest < Test::Unit::TestCase
       :type => :controller,
       :start_timestamp => Time.now.to_f,
       :duration => 0.1,
-      :overview_metrics => {}
+      :overview_metrics => {},
+      :custom_params => {}
     }.merge(options)
     @event_listener.notify(:transaction_finished, payload)
   end