Add a root section to prevent missing timing in some specific cases

Author: alexisbernard

lib/rorvswild/agent.rb

@@ -113,10 +113,12 @@ def measure_job(name, parameters: nil, &block)
 
     def start_execution(execution)
       Thread.current[:rorvswild_execution] ||= execution
+      RorVsWild::Section.start
     end
 
     def stop_execution
       return unless execution = current_execution
+      RorVsWild::Section.stop
       execution.stop
       case execution
       when Execution::Job then queue_job

test/agent_test.rb

@@ -32,7 +32,7 @@ def test_measure_section_with_exception
         end
       end
     end
-    assert_equal(2, current_sections_without_gc.size)
+    assert_equal(2, current_user_sections.size)
   end
 
   def test_measure_job_when_ignored
@@ -45,7 +45,7 @@ def test_measure_job_when_recursive
     agent.measure_job("parent") do
       agent.measure_job("child") { }
     end
-    assert_equal(1, (sections = current_sections_without_gc).size)
+    assert_equal(1, (sections = current_user_sections).size)
     assert_equal("child", sections[0].command)
   end
 
@@ -63,7 +63,7 @@ def test_measure_class_method
     line = Example.method(:foo).source_location[1]
     agent.measure_method(Example.method(:foo))
     agent.measure_job("job") { assert_equal(1, Example.foo) }
-    section = current_sections_without_gc.first
+    section = current_user_sections.first
     assert_equal("code", section.kind)
     assert_equal("/agent_test.rb", section.file)
     assert_equal(line, section.line)
@@ -74,7 +74,7 @@ def test_measure_instance_method
     line = Example.instance_method(:bar).source_location[1]
     agent.measure_method(Example.instance_method(:bar))
     agent.measure_job("job") { assert_equal(2, Example.new.bar) }
-    section = current_sections_without_gc.first
+    section = current_user_sections.first
     assert_equal("code", section.kind)
     assert_equal("/agent_test.rb", section.file)
     assert_equal(line, section.line)

test/helper.rb

@@ -41,8 +41,9 @@ def client.transmit(request)
     agent
   end
 
-  def current_sections_without_gc
-    agent.current_execution.sections.select { |s| s.kind != "gc" }
+  # Returns all section except the GC and the root one which is the last
+  def current_user_sections
+    agent.current_execution.sections[0..-2].select { |s| s.kind != "gc" }
   end
 
   def start_request(path = "/")

test/plugin/action_mailer_test.rb

@@ -13,7 +13,7 @@ def test_callback
       end
     end
 
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_equal(1, sections.size)
     assert_equal("Mailer", sections[0].command)
     assert_equal(line, sections[0].line.to_i)

test/plugin/action_view_test.rb

@@ -18,7 +18,7 @@ def test_render_template_callback
       end
     end
 
-    sections = current_sections_without_gc
+    sections = current_user_sections
     sub_partial, partial, template = sections[0], sections[1], sections[2]
     assert_equal(3, sections.size)
 
@@ -48,7 +48,7 @@ def test_render_collection
       end
     end
 
-    sections = current_sections_without_gc
+    sections = current_user_sections
     collection, template = sections[0], sections[1]
     assert_equal(2, sections.size)
 
@@ -65,14 +65,14 @@ def test_render_empty_collection
     agent.measure_block("test") do
       instrument("render_template.action_view", {identifier: "_collection.html.erb", layout: nil, count: 0}) { }
     end
-    assert_empty(current_sections_without_gc)
+    assert_empty(current_user_sections)
   end
 
   def test_render_withtout_identifier
     agent.measure_block("test") do
       instrument("render_template.action_view", {identifier: nil}) { }
     end
-    assert_empty(current_sections_without_gc)
+    assert_empty(current_user_sections)
   end
 
   private

test/plugin/active_job_test.rb

@@ -28,15 +28,15 @@ def setup
 
   def test_callback
     SampleJob.perform_now
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_equal("RorVsWild::Plugin::ActiveJobTest::SampleJob", agent.current_execution.name)
     assert_equal(1, sections.size)
     assert_equal("RorVsWild::Plugin::ActiveJobTest::SampleJob#perform", sections[0].command)
   end
 
   def test_callback_on_exception
     assert_raises { SampleJob.perform_now("Error") }
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_equal("RorVsWild::Plugin::ActiveJobTest::SampleJob", agent.current_execution.name)
     assert_equal(1, sections.size)
     assert_equal("RorVsWild::Plugin::ActiveJobTest::SampleJob#perform", sections[0].command)

test/plugin/active_record_test.rb

@@ -21,7 +21,7 @@ def test_render_template_callback
       end
     end
 
-    sections = current_sections_without_gc
+    sections = current_user_sections
     sql1, sql2 = sections[0], sections[1]
     assert_equal(2, sections.size)
 
@@ -47,7 +47,7 @@ def test_transaction_begin_insert_into_and_commit
         instrument_sql("COMMIT")
       end
     end
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_equal(1, sections.size)
     assert_equal(9, sections[0].calls)
     assert_equal("BEGIN\nINSERT INTO users\nCOMMIT", sections[0].command)
@@ -69,7 +69,7 @@ def test_async_query
         ActiveSupport::Notifications.publish_event(event)
       end
     end
-    query, root = current_sections_without_gc
+    query, root = current_user_sections
     assert_equal(root.children_ms, query.total_ms)
   end
 

test/plugin/middleware_test.rb

@@ -6,14 +6,14 @@ class RorVsWild::Plugin::MiddlewareTest < Minitest::Test
   def test_callback
     middleware.call("ORIGINAL_FULLPATH" => "/foo/bar")
     assert_equal("/foo/bar", agent.current_execution.path)
-    assert_equal(1, (sections = current_sections_without_gc).size)
+    assert_equal(1, (sections = current_user_sections).size)
     assert_equal("Rails::Engine#call", sections[0].command)
   end
 
   def test_queue_time_section
     middleware.call("HTTP_X_REQUEST_START" => unix_timestamp_seconds.to_s)
 
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_equal(2, sections.size)
     queue_time_section = sections[0]
     assert_equal "queue", queue_time_section.file
@@ -25,23 +25,23 @@ def test_queue_time_section
   def test_queue_time_secs
     middleware.call("HTTP_X_REQUEST_START" => (unix_timestamp_seconds - 0.123).to_s)
 
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_equal(2, sections.size)
     assert_operator(123, :<=, sections[0].total_ms)
   end
 
   def test_queue_time_millis
     middleware.call("HTTP_X_QUEUE_START" => (unix_timestamp_seconds * 1000 - 234).to_s)
 
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_equal(2, sections.size)
     assert_operator(234, :<=, sections[0].total_ms)
   end
 
   def test_queue_time_micros
     middleware.call("HTTP_X_MIDDLEWARE_START" => (unix_timestamp_seconds * 1_000_000 - 345_000).to_s)
 
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_equal(2, sections.size)
     assert_operator(345, :<=, sections[0].total_ms)
   end

test/plugin/mongo_test.rb

@@ -21,7 +21,7 @@ def test_callback
       mongo[:mountains].find(altitude: {"$gt": 4800}).each { |mountain| }
     end
 
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_equal(3, sections.size)
 
     assert_equal(1, sections[0].calls)

test/plugin/net_http_test.rb

@@ -7,7 +7,7 @@ class RorVsWild::Plugin::NetHttpTest < Minitest::Test
 
   def test_callback
     agent.measure_block("test") { Net::HTTP.get("www.ruby-lang.org", "/index.html") }
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_equal(1, sections.size)
     assert_equal(1, sections[0].calls)
     assert_equal("http", sections[0].kind)
@@ -16,7 +16,7 @@ def test_callback
 
   def test_callback_with_https
     agent.measure_block("test") { Net::HTTP.get(URI("https://www.ruby-lang.org/index.html")) }
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_match("GET www.ruby-lang.org", sections[0].command)
     assert_equal("http", sections[0].kind)
   end
@@ -27,7 +27,7 @@ def test_nested_query_because_net_http_request_is_recursive_when_connection_is_n
       http = Net::HTTP.new(uri.host, uri.port)
       http.request(Net::HTTP::Get.new(uri.path))
     end
-    sections = current_sections_without_gc
+    sections = current_user_sections
     assert_equal(1, sections[0].calls)
   end
 end