newrelic_rpm 3.0.0 → 3.0.1

data/CHANGELOG

@@ -1,3 +1,7 @@
+v3.0.1 
+  * Updated Real User Monitoring to reduce javascript size and improve
+    compatibility, fix a few known bugs
+
 v3.0.0
   * Support for Real User Monitoring
   * Back end work on internals to improve reliability

data/lib/new_relic/agent/beacon_configuration.rb

@@ -2,19 +2,23 @@ module NewRelic
   module Agent
     class BeaconConfiguration
       attr_reader :browser_timing_header
+      attr_reader :browser_timing_static_footer
       attr_reader :application_id
       attr_reader :browser_monitoring_key
       attr_reader :beacon
       attr_reader :rum_enabled
       attr_reader :license_bytes
 
+      JS_HEADER = "<script>var NREUMQ=[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);</script>"
+
       def initialize(connect_data)
         @browser_monitoring_key = connect_data['browser_key']
         @application_id = connect_data['application_id']
         @beacon = connect_data['beacon']
         @rum_enabled = connect_data['rum.enabled']
         @rum_enabled = true if @rum_enabled.nil?
-        @browser_timing_header = build_browser_timing_header(connect_data)
+        @browser_timing_header = build_browser_timing_header
+        @browser_timing_static_footer = build_load_file_js(connect_data) 
       end
 
       def license_bytes
@@ -25,22 +29,22 @@ module NewRelic
         @license_bytes
       end
 
-      def load_file_js(connect_data)
+      def build_load_file_js(connect_data)
         return "" unless connect_data.fetch('rum.load_episodes_file', true)
 
         episodes_url = connect_data.fetch('episodes_url', '')
-        "(function(){var d=document;var e=d.createElement(\"script\");e.type=\"text/javascript\";e.async=true;e.src=\"#{episodes_url}\";var s=d.getElementsByTagName(\"script\")[0];s.parentNode.insertBefore(e,s);})()"
+        "(function(){var d=document;var e=d.createElement(\"script\");e.async=true;e.src=\"#{episodes_url}\";var s=d.getElementsByTagName(\"script\")[0];s.parentNode.insertBefore(e,s);})();"
       end
 
-      def basic_javascript(connect_data)
-        "<script>var NREUMQ=[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);#{load_file_js(connect_data)}</script>"
+      def javascript_header
+        JS_HEADER.dup
       end
 
-      def build_browser_timing_header(connect_data)
+      def build_browser_timing_header
         return "" if !@rum_enabled
         return "" if @browser_monitoring_key.nil?
         
-        value = basic_javascript(connect_data)
+        value = javascript_header
         if value.respond_to?(:html_safe)
           value.html_safe
         else

data/lib/new_relic/agent/browser_monitoring.rb

@@ -56,7 +56,7 @@ module NewRelic
 
       def footer_js_string(beacon, license_key, application_id)
         obfuscated_transaction_name = obfuscate(browser_monitoring_transaction_name)
-        html_safe_if_needed("<script type=\"text/javascript\" charset=\"utf-8\">NREUMQ.push([\"nrf2\",\"#{beacon}\",\"#{license_key}\",#{application_id},\"#{obfuscated_transaction_name}\",#{browser_monitoring_queue_time},#{browser_monitoring_app_time}])</script>")
+        html_safe_if_needed("<script>#{NewRelic::Agent.instance.beacon_configuration.browser_timing_static_footer}NREUMQ.push([\"nrf2\",\"#{beacon}\",\"#{license_key}\",#{application_id},\"#{obfuscated_transaction_name}\",#{browser_monitoring_queue_time},#{browser_monitoring_app_time},new Date().getTime()])</script>")
       end
 
       def html_safe_if_needed(string)
@@ -76,7 +76,7 @@ module NewRelic
           index+=1
         }
 
-        [obfuscated].pack("m0").chomp
+        [obfuscated].pack("m0").gsub("\n", '')
       end
     end
   end

data/lib/new_relic/rack/browser_monitoring.rb

@@ -9,6 +9,12 @@ module NewRelic::Rack
 
     # method required by Rack interface
     def call(env)
+      
+      # clear out the thread locals we use in case this is a static request
+      Thread.current[:newrelic_most_recent_transaction] = nil
+      Thread.current[:newrelic_start_time] = Time.now
+      Thread.current[:newrelic_queue_time] = 0
+      
       result = @app.call(env)   # [status, headers, response]
 
       if (NewRelic::Agent.browser_timing_header != "") && should_instrument?(result[0], result[1])
@@ -30,7 +36,7 @@ module NewRelic::Rack
 
     def autoinstrument_source(response, headers)
       source = nil
-      response.each {|fragment| (source) ? (source << f) : (source = fragment)}
+      response.each {|fragment| (source) ? (source << fragment) : (source = fragment)}
 
       body_start = source.index("<body")
       body_close = source.rindex("</body>")

data/lib/new_relic/version.rb

@@ -3,7 +3,7 @@ module NewRelic
   module VERSION #:nodoc:
     MAJOR = 3
     MINOR = 0
-    TINY  = 0
+    TINY  = 1
     BUILD = nil #'0' # Set to nil for a release, 'beta1', 'alpha', etc for prerelease builds
     STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
   end

data/newrelic.yml

@@ -138,8 +138,8 @@ common: &default_settings
   transaction_tracer:
   
     # Transaction tracer is enabled by default. Set this to false to
-    # turn it off. This feature is only available at the Silver and
-    # above product levels.
+    # turn it off. This feature is only available at the Professional
+    # and above product levels.
     enabled: true
     
     # Threshold in seconds for when to collect a transaction
@@ -176,7 +176,7 @@ common: &default_settings
   error_collector:
     
     # Error collector is enabled by default. Set this to false to turn
-    # it off. This feature is only available at the Silver and above
+    # it off. This feature is only available at the Professional and above
     # product levels
     enabled: true
     

data/newrelic_rpm.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{newrelic_rpm}
-  s.version = "3.0.0"
+  s.version = "3.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bill Kayser", "Justin George"]
-  s.date = %q{2011-05-11}
+  s.date = %q{2011-05-20}
   s.description = %q{New Relic RPM is a Ruby performance management system, developed by
 New Relic, Inc (http://www.newrelic.com).  RPM provides you with deep
 information about the performance of your Ruby on Rails or Merb

data/test/new_relic/agent/beacon_configuration_test.rb

@@ -19,7 +19,7 @@ class NewRelic::Agent::BeaconConfigurationTest < Test::Unit::TestCase
     assert_equal 'a browser monitoring key', bc.browser_monitoring_key
     assert_equal 'an application id', bc.application_id
     assert_equal 'a beacon', bc.beacon
-    assert_equal 269, bc.browser_timing_header.size
+    assert_equal 86, bc.browser_timing_header.size
   end
 
   def test_license_bytes_nil
@@ -50,72 +50,55 @@ class NewRelic::Agent::BeaconConfigurationTest < Test::Unit::TestCase
     connect_data = {}
     bc = NewRelic::Agent::BeaconConfiguration.new(connect_data)
     bc.instance_eval { @rum_enabled = false }
-    assert_equal '', bc.build_browser_timing_header(connect_data), "should not return a header when rum enabled is 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
     connect_data = {}
     bc = NewRelic::Agent::BeaconConfiguration.new(connect_data)
     bc.instance_eval { @rum_enabled = true; @browser_monitoring_key = nil }
-    assert_equal '', bc.build_browser_timing_header(connect_data), "should not return a header when browser_monitoring_key is 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_checking_for_episodes_url
-    connect_data = {'episodes_url' => 'an episodes url'}
-    bc = NewRelic::Agent::BeaconConfiguration.new(connect_data)
-    bc.instance_eval { @rum_enabled = true; @browser_monitoring_key = 'a' * 40 }
-    assert(bc.build_browser_timing_header(connect_data).include?('an episodes url'), "should include the episodes url in the javascript")
-  end
-
   def test_build_browser_timing_header_enabled_with_key
     connect_data = {}
     bc = NewRelic::Agent::BeaconConfiguration.new(connect_data)
     bc.instance_eval { @browser_monitoring_key = 'a browser monitoring key' }
-    bc.expects(:load_file_js).with({}).returns('load file js')
-    assert(bc.build_browser_timing_header(connect_data).include?('load file js'), "header should be generated when rum is enabled and browser monitoring key is set")
+    assert(bc.build_browser_timing_header.include?('NREUMQ'), "header should be generated when rum is enabled and browser monitoring key is set")
   end
 
-  def test_basic_javascript
-    connect_data = {}
-    bc = NewRelic::Agent::BeaconConfiguration.new(connect_data)
-    mock_data = mock('connect data')
-    bc.expects(:load_file_js).with(mock_data)
-    # should just pass through the data
-    bc.basic_javascript(mock_data)
-  end
-  
   def test_build_browser_timing_header_should_html_safe_header
     mock_javascript = mock('javascript')
     connect_data = {'browser_key' => 'a' * 40}
     bc = NewRelic::Agent::BeaconConfiguration.new(connect_data)
     assert_equal('a' * 40, bc.instance_variable_get('@browser_monitoring_key'), "should save the key from the config")
-    bc.expects(:basic_javascript).with(connect_data).returns(mock_javascript)
+    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(connect_data)
+    bc.build_browser_timing_header
   end
   
-  def test_load_file_js_load_episodes_file_false
+  def test_build_load_file_js_load_episodes_file_false
     connect_data = {'rum.load_episodes_file' => false}
     bc = NewRelic::Agent::BeaconConfiguration.new(connect_data)
-    assert_equal '', bc.load_file_js(connect_data), "should be empty when load episodes file is false"
+    assert_equal '', bc.build_load_file_js(connect_data), "should be empty when load episodes file is false"
   end
   
-  def test_load_file_js_load_episodes_file_missing
+  def test_build_load_file_js_load_episodes_file_missing
     connect_data = {}
     bc = NewRelic::Agent::BeaconConfiguration.new(connect_data)
-    assert_equal(183, bc.load_file_js(connect_data).size, "should output the javascript when there is no configuration")
+    assert_equal(159, bc.build_load_file_js(connect_data).size, "should output the javascript when there is no configuration")
   end
 
-  def test_load_file_js_load_episodes_file_present
+  def test_build_load_file_js_load_episodes_file_present
     connect_data = {'rum.load_episodes_file' => true}
     bc = NewRelic::Agent::BeaconConfiguration.new(connect_data)
-    assert_equal(183, bc.load_file_js(connect_data).size, "should output the javascript when rum.load_episodes_file is true")
+    assert_equal(159, bc.build_load_file_js(connect_data).size, "should output the javascript when rum.load_episodes_file is true")
   end
   
-  def test_load_file_js_load_episodes_file_with_episodes_url
+  def test_build_load_file_js_load_episodes_file_with_episodes_url
     connect_data = {'episodes_url' => 'an episodes url'}
     bc = NewRelic::Agent::BeaconConfiguration.new(connect_data)
-    assert(bc.load_file_js(connect_data).include?('an episodes url'), "should include the episodes url by default")
+    assert(bc.build_load_file_js(connect_data).include?('an episodes url'), "should include the episodes url by default")
   end
 end

data/test/new_relic/agent/browser_monitoring_test.rb

@@ -30,13 +30,13 @@ class NewRelic::Agent::BrowserMonitoringTest < Test::Unit::TestCase
 
   def test_browser_timing_header
     header = browser_timing_header
-    assert_equal "<script>var NREUMQ=[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);(function(){var d=document;var e=d.createElement(\"script\");e.type=\"text/javascript\";e.async=true;e.src=\"this_is_my_file\";var s=d.getElementsByTagName(\"script\")[0];s.parentNode.insertBefore(e,s);})()</script>", header
+    assert_equal "<script>var NREUMQ=[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);</script>", header
   end
   
   def test_browser_timing_header_with_rum_enabled_not_specified
     NewRelic::Agent.instance.expects(:beacon_configuration).at_least_once.returns( NewRelic::Agent::BeaconConfiguration.new({"browser_key" => "browserKey", "application_id" => "apId", "beacon"=>"beacon", "episodes_url"=>"this_is_my_file"}))
     header = browser_timing_header
-    assert_equal "<script>var NREUMQ=[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);(function(){var d=document;var e=d.createElement(\"script\");e.type=\"text/javascript\";e.async=true;e.src=\"this_is_my_file\";var s=d.getElementsByTagName(\"script\")[0];s.parentNode.insertBefore(e,s);})()</script>", header
+    assert_equal "<script>var NREUMQ=[];NREUMQ.push([\"mark\",\"firstbyte\",new Date().getTime()]);</script>", header
   end
 
   def test_browser_timing_header_with_rum_enabled_false
@@ -68,7 +68,8 @@ class NewRelic::Agent::BrowserMonitoringTest < Test::Unit::TestCase
     Thread.current[:newrelic_start_time] = Time.now
 
     footer = browser_timing_footer
-    assert footer.include?("<script type=\"text/javascript\" charset=\"utf-8\">NREUMQ.push([\"nrf2\",")
+    snippet = "<script>(function(){var d=document;var e=d.createElement(\"script\");e.async=true;e.src=\"this_is_my_file\";var s=d.getElementsByTagName(\"script\")[0];s.parentNode.insertBefore(e,s);})();NREUMQ.push([\"nrf2\","
+    assert footer.include?(snippet), "Expected footer to include snippet: #{snippet}, but instead was #{footer}"
   end
   
   def test_browser_timing_footer_without_calling_header
@@ -100,8 +101,10 @@ class NewRelic::Agent::BrowserMonitoringTest < Test::Unit::TestCase
     config.expects(:license_bytes).returns(license_bytes)
     NewRelic::Agent.instance.expects(:beacon_configuration).returns(config).at_least_once
     footer = browser_timing_footer
-    assert footer.include?("<script type=\"text/javascript\" charset=\"utf-8\">NREUMQ.push([\"nrf2\",")
-    assert footer.include?("])</script>")
+    beginning_snippet = "(function(){var d=document;var e=d.createElement(\"script\");e.async=true;e.src=\"this_is_my_file\";var s=d.getElementsByTagName(\"script\")[0];s.parentNode.insertBefore(e,s);})();NREUMQ.push([\"nrf2\","
+    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}")
   end
 
   def test_browser_timing_footer_with_no_beacon_configuration
@@ -231,7 +234,7 @@ class NewRelic::Agent::BrowserMonitoringTest < Test::Unit::TestCase
     self.expects(:obfuscate).with('most recent transaction').returns('most recent transaction')
     
     value = footer_js_string(beacon, license_key, application_id)
-    assert_equal('<script type="text/javascript" charset="utf-8">NREUMQ.push(["nrf2","","",1,"most recent transaction",0,0])</script>', value, "should return the javascript given some default values")
+    assert_equal('<script>(function(){var d=document;var e=d.createElement("script");e.async=true;e.src="this_is_my_file";var s=d.getElementsByTagName("script")[0];s.parentNode.insertBefore(e,s);})();NREUMQ.push(["nrf2","","",1,"most recent transaction",0,0,new Date().getTime()])</script>', value, "should return the javascript given some default values")
   end
 
   def test_html_safe_if_needed_unsafed
@@ -260,4 +263,12 @@ class NewRelic::Agent::BrowserMonitoringTest < Test::Unit::TestCase
     output = obfuscate(text)
     assert_equal('YCJrZXV2fih5Y25vaCFtZSR2a2ZkZSp/aXV1', output, "should output obfuscated text")
   end
+
+  def test_obfuscate_long_string
+    text = 'a happy piece of small text' * 5
+    key = (1..40).to_a
+    NewRelic::Agent.instance.beacon_configuration.expects(:license_bytes).returns(key)
+    output = obfuscate(text)
+    assert_equal('YCJrZXV2fih5Y25vaCFtZSR2a2ZkZSp/aXV1YyNsZHZ3cSl6YmluZCJsYiV1amllZit4aHl2YiRtZ3d4cCp7ZWhiZyNrYyZ0ZWhmZyx5ZHp3ZSVuZnh5cyt8ZGRhZiRqYCd7ZGtnYC11Z3twZCZvaXl6cix9aGdgYSVpYSh6Z2pgYSF2Znxx', output, "should output obfuscated text")
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: newrelic_rpm
 version: !ruby/object:Gem::Version 
-  hash: 7
-  prerelease: 
+  hash: 5
+  prerelease: false
   segments: 
   - 3
   - 0
-  - 0
-  version: 3.0.0
+  - 1
+  version: 3.0.1
 platform: ruby
 authors: 
 - Bill Kayser
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-11 00:00:00 -07:00
+date: 2011-05-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -369,7 +369,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: New Relic Ruby Performance Monitoring Agent