Merge pull request #125 from ywenc/init-html-view

Option to display file output in html view

Author: jhawthorn

lib/vernier/output/file_listing.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "filename_filter"
+require "cgi/util"
 
 module Vernier
   module Output
@@ -41,8 +42,6 @@ def samples_by_file
           h[k] = SamplesByLocation.new
         end
 
-        total = weights.sum
-
         samples.zip(weights).each do |stack_idx, weight|
           # self time
           top_frame_index = stack_table.stack_frame_idx(stack_idx)
@@ -75,7 +74,7 @@ def samples_by_file
         end
       end
 
-      def output
+      def output(template: nil)
         output = +""
 
         relevant_files = samples_by_file.select do |k, v|
@@ -84,13 +83,18 @@ def output
           next if k.start_with?("<")
           v.values.map(&:total).sum > total * 0.01
         end
-        relevant_files.keys.sort.each do |filename|
+
+        if template == "html"
+          html_output(output, relevant_files)
+        else
+          relevant_files.keys.sort.each do |filename|
+            output << "="*80 << "\n"
+            output << filename << "\n"
+            output << "-"*80 << "\n"
+            format_file(output, filename, samples_by_file, total: total)
+          end
           output << "="*80 << "\n"
-          output << filename << "\n"
-          output << "-"*80 << "\n"
-          format_file(output, filename, samples_by_file, total: total)
         end
-        output << "="*80 << "\n"
       end
 
       def total
@@ -114,6 +118,35 @@ def format_file(output, filename, all_samples, total:)
           end
         end
       end
+
+      def html_output(output, relevant_files)
+        output << "<pre>"
+        output << "  SELF     FILE\n"
+        relevant_files.sort_by {|k, v| -v.values.map(&:self).sum }.each do |filename, file_contents|
+          tmpl = "<details style=\"display:inline-block;vertical-align:top;\"><summary>%s</summary>"
+          output << sprintf("% 5.1f%%   #{tmpl}\n", file_contents.values.map(&:self).sum * 100 / total.to_f, filename)
+          format_file_html(output, filename, relevant_files)
+          output << "</details>\n"
+        end
+        output << "</pre>"
+      end
+
+      def format_file_html(output, filename, relevant_files)
+        samples = relevant_files[filename]
+
+        # file_name, lines, file_wall, file_cpu, file_idle, file_sort
+        output << sprintf(" TOTAL |  SELF  | LINE SOURCE\n")
+        File.readlines(filename).each_with_index do |line, i|
+          lineno = i + 1
+          calls = samples[lineno]
+
+          if calls && calls.total > 0
+            output << sprintf("%5.1f%% | %5.1f%% | % 4i  %s", 100 * calls.total / total.to_f, 100 * calls.self / total.to_f, lineno, CGI::escapeHTML(line))
+          else
+            output << sprintf("       |        | % 4i  %s", lineno, CGI::escapeHTML(line))
+          end
+        end
+      end
     end
   end
 end

test/output/test_file_listing.rb

@@ -3,38 +3,58 @@
 require "test_helper"
 
 class TestOutputFileListing < Minitest::Test
-  def test_complex_profile
-    result = Vernier.trace do
-      # Proper Ruby sleep
-      sleep 0.01
+  describe "with a live profile" do
+    before do
+      @result = Vernier.trace do
+        # Proper Ruby sleep
+        sleep 0.01
 
-      # Sleep inside rb_thread_call_without_gvl
-      GVLTest.sleep_without_gvl(0.01)
+        # Sleep inside rb_thread_call_without_gvl
+        GVLTest.sleep_without_gvl(0.01)
 
-      # Sleep with GVL held
-      GVLTest.sleep_holding_gvl(0.01)
+        # Sleep with GVL held
+        GVLTest.sleep_holding_gvl(0.01)
 
-      # Ruby busy sleep
-      target = Process.clock_gettime(Process::CLOCK_MONOTONIC) + 0.01
-      while Process.clock_gettime(Process::CLOCK_MONOTONIC) < target
+        # Ruby busy sleep
+        target = Process.clock_gettime(Process::CLOCK_MONOTONIC) + 0.01
+        while Process.clock_gettime(Process::CLOCK_MONOTONIC) < target
+        end
       end
     end
 
-    output = Vernier::Output::FileListing.new(result).output
-    assert_match(/\d+\.\d% \| *\d+\.\d% \| *\d+ +sleep 0\.01/, output)
-    assert_match(/\d+\.\d% \| *\d+\.\d% \| *\d+ +GVLTest\.sleep_without_gvl/, output)
-    assert_match(/\d+\.\d% \| *\d+\.\d% \| *\d+ +GVLTest\.sleep_holding_gvl/, output)
-    assert_match(/\d+\.\d% \| *\d+\.\d% \| *\d+ +while Process\.clock_gettime/, output)
+    def test_complex_profile
+      output = Vernier::Output::FileListing.new(@result).output
+      assert_match(/\d+\.\d% \| *\d+\.\d% \| *\d+ +sleep 0\.01/, output)
+      assert_match(/\d+\.\d% \| *\d+\.\d% \| *\d+ +GVLTest\.sleep_without_gvl/, output)
+      assert_match(/\d+\.\d% \| *\d+\.\d% \| *\d+ +GVLTest\.sleep_holding_gvl/, output)
+      assert_match(/\d+\.\d% \| *\d+\.\d% \| *\d+ +while Process\.clock_gettime/, output)
+    end
+
+    def test_html_output
+      output = Vernier::Output::FileListing.new(@result).output(template: "html")
+      assert_match(/<details style=\"display:inline-block;vertical-align:top;\"><summary>.+#{Regexp.escape(File.basename(__FILE__))}<\/summary>/, output)
+    end
   end
 
-  def test_parsed_profile
-    profile = Vernier::ParsedProfile.read_file(fixture_path("gvl_sleep.vernier.json"))
-    output = Vernier::Output::FileListing.new(profile).output
-    assert_includes output, <<TEXT
+  describe "with a parsed profile" do
+    before do
+      @profile = Vernier::ParsedProfile.read_file(fixture_path("gvl_sleep.vernier.json"))
+    end
+    
+    def test_parsed_profile
+      output = Vernier::Output::FileListing.new(@profile).output
+      assert_includes output, <<TEXT
  24.8% |   0.0% |   44  run(:cfunc_sleep_gvl)
  24.7% |   0.0% |   45  run(:cfunc_sleep_idle)
  24.6% |   0.0% |   46  run(:ruby_sleep_gvl)
  24.7% |   0.0% |   47  run(:sleep_idle)
 TEXT
+    end
+
+    def test_html_output
+      output = Vernier::Output::FileListing.new(@profile).output(template: "html")
+      assert_includes output,
+        " 24.5%   <details style=\"display:inline-block;vertical-align:top;\"><summary>examples/gvl_sleep.rb</summary>\n"
+    end
   end
 end