stackprof-webnav 0.1.0 → 1.0.0

data/lib/stackprof-webnav/server.rb

@@ -1,85 +1,128 @@
 require 'sinatra'
 require 'haml'
 require "stackprof"
-require 'net/http'
 require_relative 'presenter'
+require_relative 'dump'
+require 'pry'
+require "sinatra/reloader" if development?
+require 'ruby-graphviz'
 
 module StackProf
   module Webnav
     class Server < Sinatra::Application
       class << self
-        attr_accessor :cmd_options, :report_dump_path, :report_dump_uri, :report_dump_listing
-
-        def presenter regenerate=false
-          return @presenter unless regenerate || @presenter.nil?
-          process_options
-          if self.report_dump_path || self.report_dump_uri
-            report_contents = if report_dump_path.nil?
-                                Net::HTTP.get(URI.parse(report_dump_uri))
-                              else
-                                File.open(report_dump_path).read
-                              end
-            report = StackProf::Report.new(Marshal.load(report_contents))
-          end
-          @presenter = Presenter.new(report)
-        end
+        attr_accessor :cmd_options
+      end
+
+      configure :development do
+        register Sinatra::Reloader
+      end
 
-        private
-        def process_options
-          if cmd_options[:filepath]
-            self.report_dump_path = cmd_options[:filepath]
-          elsif cmd_options[:uri]
-            self.report_dump_uri = cmd_options[:uri]
-          elsif cmd_options[:bucket]
-            self.report_dump_listing = cmd_options[:bucket]
+      configure :production do
+        set :show_exceptions, false
+      end
+
+      error do
+        @error = env['sinatra.error']
+        haml :error
+      end
+
+      before do
+        unless request.path_info == '/'
+          if params[:dump] != current_dump.path
+            current_dump.path = params[:dump]
           end
         end
-
       end
 
       helpers do
-        def presenter
-          Server.presenter
+        def current_dump
+          Thread.current[:cache] = {}
+          Thread.current[params[:dump]] ||= Dump.new(params[:dump])
         end
 
-        def method_url name
-          "/method?name=#{URI.escape(name)}"
+        def current_report
+          StackProf::Report.new(
+            Marshal.load(current_dump.content)
+          )
         end
 
-        def file_url path
-          "/file?path=#{URI.escape(path)}"
+        def presenter
+          Presenter.new(current_report)
         end
 
-        def overview_url path
-          "/overview?path=#{URI.escape(path)}"
+        def ensure_file_generated(path, &block)
+          return if File.exist?(path)
+          File.open(path, 'wb', &block)
+        end
+
+        def url_for(path, options={})
+          query = URI.encode_www_form({dump: params[:dump]}.merge(options))
+          path + "?" + query
         end
       end
 
       get '/' do
-        presenter
-        if Server.report_dump_listing
-          redirect '/listing'
-        else
-          redirect '/overview'
+        if Server.cmd_options[:filepath]
+          query = URI.encode_www_form(dump: Server.cmd_options[:filepath])
+          next redirect to("/overview?#{query}")
         end
+
+        @directory = File.expand_path(Server.cmd_options[:directory] || '.')
+        @files = Dir.entries(@directory).sort.map do |file|
+          path = File.expand_path(file, @directory)
+
+          OpenStruct.new(
+            name: file,
+            path: path,
+            modified: File.mtime(path)
+          )
+        end.select do |file|
+          File.file?(file.path)
+        end
+
+        haml :index
       end
 
       get '/overview' do
-        if params[:path]
-          Server.report_dump_uri = params[:path]
-          Server.presenter(true)
-        end
-        @file = Server.report_dump_path || Server.report_dump_uri
         @action = "overview"
-        @frames = presenter.overview_frames
-        haml :overview
+
+        begin
+          @frames = presenter.overview_frames
+          haml :overview
+        rescue => error
+          haml :invalid_dump
+        end
       end
 
-      get '/listing' do
-        @file = Server.report_dump_listing
-        @action = "listing"
-        @dumps = presenter.listing_dumps
-        haml :listing
+      get '/flames.json' do
+        ensure_file_generated(current_dump.flame_graph_path) do |file|
+          current_report.print_flamegraph(file, true, true)
+        end
+
+        send_file(current_dump.flame_graph_path, type: 'text/javascript')
+      end
+
+      get '/graph.png' do
+        ensure_file_generated(current_dump.graph_path) do |file|
+          current_report.print_graphviz({}, file)
+        end
+
+        ensure_file_generated(current_dump.graph_image_path) do |file|
+          GraphViz
+            .parse(current_dump.graph_path)
+            .output(png: current_dump.graph_image_path)
+        end
+
+        send_file(current_dump.graph_image_path, type: 'image/png')
+      end
+
+      get '/graph' do
+        haml :graph
+      end
+
+      get '/flamegraph' do
+        haml :flamegraph
       end
 
       get '/method' do
@@ -90,8 +133,14 @@ module StackProf
 
       get '/file' do
         path = params[:path]
-        @path = path
-        @data = presenter.file_overview(path)
+
+        if File.exist?(path)
+          @path = path
+          @data = presenter.file_overview(path)
+        else
+          @data = nil
+        end
+
         haml :file
       end
     end

data/lib/stackprof-webnav/version.rb

@@ -1,5 +1,5 @@
 module StackProf
   module Webnav
-    VERSION = '0.1.0'
+    VERSION = '1.0.0'
   end
 end

data/lib/stackprof-webnav/views/error.haml

@@ -0,0 +1,8 @@
+%h1 Oops, something went wrong
+
+%h2
+  = @error.class
+  \-
+  = @error.message
+
+%h3 Are you looking at a valid stackprof dump?

data/lib/stackprof-webnav/views/file.haml

@@ -5,7 +5,10 @@
 %br
 %br
 
-.code_linenums
-  - @data[:lineinfo].each do |l|
-    %span= l
-!= @data[:code]
+- if @data
+  .code_linenums
+    - @data[:lineinfo].each do |l|
+      %span= l
+  != @data[:code]
+- else
+  %h3 Unable to load file, was the dump captured on another machine?

data/lib/stackprof-webnav/views/flamegraph.haml

@@ -0,0 +1,77 @@
+%a{:href => url_for("/overview")}
+  %button Back to overview
+
+%br
+%br
+
+:css
+  body {
+    margin: 0;
+    padding: 0;
+    font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    font-size: 10pt;
+  }
+  .overview-container {
+    position: relative;
+  }
+  .overview {
+    cursor: col-resize;
+  }
+  .overview-viewport-overlay {
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 1;
+    height: 1;
+    background-color: rgba(0, 0, 0, 0.25);
+    transform-origin: top left;
+    cursor: -moz-grab;
+    cursor: -webkit-grab;
+    cursor: grab;
+  }
+  .moving {
+    cursor: -moz-grabbing;
+    cursor: -webkit-grabbing;
+    cursor: grabbing;
+  }
+  .info {
+    display: block;
+    height: 40px;
+    margin: 3px 6px;
+    margin-right: 206px;
+    padding: 3px 6px;
+    line-height: 18px;
+  }
+  .legend {
+    display: block;
+    float: right;
+    width: 195px;
+    max-height: 100%;
+    overflow-y: scroll;
+  }
+  .legend > div {
+    padding: 6px;
+    clear: right;
+  }
+  .legend > div span {
+    opacity: 0.75;
+    display: block;
+    text-align: right;
+  }
+  .legend > div .name {
+    max-width: 70%;
+    word-wrap: break-word;
+  }
+%script{:src => "flamegraph.js"}
+.legend
+.overview-container
+  %canvas.overview
+  .overview-viewport-overlay
+.info
+  %div{:style => "float: right; text-align: right"}
+    .samples
+    .exclusive
+  .frame
+  .file
+%canvas.flamegraph
+%script{:src => "/flames.json?dump=#{params[:dump]}"}

data/lib/stackprof-webnav/views/graph.haml

@@ -0,0 +1,4 @@
+%a{:href => url_for("/overview")}
+  %button Back to overview
+
+%img{src: url_for("/graph.png")}

data/lib/stackprof-webnav/views/index.haml

@@ -0,0 +1,18 @@
+%h3 StackProf Navigator
+%hr
+
+%p
+  Listing dumps in
+  %b= @directory
+
+%table.centered
+  %thead
+    %th Filename
+    %th Modified
+
+  %tbody
+    - @files.each do |file|
+      %tr
+        %td
+          %a{href: url_for("/overview", dump: file.path)}= file.name
+        %td= file.modified

data/lib/stackprof-webnav/views/invalid_dump.haml

@@ -0,0 +1,4 @@
+%h3 StackProf Navigator - #{@action}
+%hr
+
+%h4 Unable to open the specified file as a dump

data/lib/stackprof-webnav/views/layout.haml

@@ -7,6 +7,4 @@
     %link(rel="stylesheet" href="/css/application.css")
 
   %body
-    .row
-      .large-12.columns
-        = yield
+    = yield

data/lib/stackprof-webnav/views/method.haml

@@ -1,12 +1,15 @@
 %h3 StackProf Navigator - #{@action} (#{@frames.count} frames)
 %hr
 
-%a{:href => '/'} ← Back to overview
-%br
+%p
+  %a{:href => url_for("/overview")} ← Back to overview
 
 - @frames.each do |frame|
-  %h4
-    %a{:href => file_url(frame[:location])}= frame[:location]
+  %a{:href => url_for("/file", path: frame[:location])}
+    %button.btn
+      Browse
+      = frame[:location]
+
   - if frame[:callers].any?
     %table
       %thead
@@ -21,7 +24,7 @@
             %td= caller[:weight]
             %td= caller[:pct]
             %td
-              %a{:href => method_url(caller[:method])}
+              %a{:href => url_for("/method", name: caller[:method])}
                 = caller[:method]
 
   - if frame[:callees].any?
@@ -38,7 +41,7 @@
             %td= caller[:weight]
             %td= caller[:pct]
             %td
-              %a{:href => method_url(caller[:method])}
+              %a{:href => url_for("/method", name: caller[:method])}
                 = caller[:method]
 
   %h4 Code

data/lib/stackprof-webnav/views/overview.haml

@@ -3,7 +3,21 @@
 
 %p
   Viewing dump
-  %b= @file
+  %b= current_dump.path
+
+%a{href: "/"}
+  %button.btn Browse directory
+
+
+%a{href: url_for("/graph")}
+  %button.btn View call graph
+
+- if current_report.data[:raw]
+  %a{href: url_for("/flamegraph")}
+    %button View flamegraph
+- else
+  %a{href: "https://github.com/tmm1/stackprof#all-options"}
+    %button.secondary Flamegraph is not available
 
 %table.centered
   %thead
@@ -21,5 +35,5 @@
         %td= frame[:samples]
         %td= frame[:samples_pct]
         %td
-          %a{:href => method_url(frame[:method])}
-            = frame[:method]
+          %a{:href => url_for("/method", name: frame[:method])}
+            = frame[:method]

data/spec/helpers.rb

@@ -0,0 +1,17 @@
+require 'rack/test'
+
+module Helpers
+  def build_app(options={})
+    StackProf::Webnav::Server.cmd_options = options
+    Rack::Test::Session.new(Rack::MockSession.new(StackProf::Webnav::Server))
+  end
+
+  def fixture_path(name)
+    File.join(File.dirname(__FILE__), "fixtures", name)
+  end
+
+  def build_presenter(path)
+    report = StackProf::Report.new(Marshal.load(File.read(path)))
+    StackProf::Webnav::Presenter.new(report)
+  end
+end

data/spec/integration_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper"
+
+RSpec.describe "integration tests" do
+  let(:app) { build_app }
+  let(:presenter) { build_presenter(fixture_path("test.dump")) }
+  let(:response) { app.last_response }
+
+  after(:each) do
+    Dir.glob("spec/fixtures/*.flames.json").each {|file| File.delete(file) }
+    Dir.glob("spec/fixtures/*.digraph.dot").each {|file| File.delete(file) }
+    Dir.glob("spec/fixtures/*.graph.png").each {|file| File.delete(file) }
+  end
+
+  describe "index" do
+    it "lists the files in a folder" do
+      app = build_app(directory: "spec/fixtures")
+      app.get "/"
+      expect(app.last_response.body).to include("test.dump")
+    end
+
+    it "redirects to overview if path is specified" do
+      app = build_app(filepath: fixture_path("test.dump"))
+      app.get "/"
+      app.follow_redirect!
+      expect(app.last_response.body).to include("Dummy")
+    end
+  end
+
+  describe "overview" do
+    it "works with a valid dump" do
+      app.get "/overview", dump: fixture_path("test.dump")
+
+      frame = presenter.overview_frames.first
+      expect(response.body).to include(frame[:method])
+    end
+
+    it "communicates that flamegraph is not available for dump" do
+      app.get "/overview", dump: fixture_path("test.dump")
+    end
+
+    it "does not crash if selected file is not a dump" do
+      app.get "/overview", dump: "Rakefile"
+      expect(response.body).to include("Unable to open")
+    end
+  end
+
+  it "is able to generate flames.json file" do
+    app.get "/flames.json", dump: fixture_path("test-raw.dump")
+    expect(response.body).to include("flamegraph")
+  end
+
+  it "is able to render graph" do
+    app.get "/graph.png", dump: fixture_path("test.dump")
+    expect(response.get_header("Content-Type")).to eq("image/png")
+    expect(response.body.size).to_not eq(0)
+  end
+
+  it "method page renders information about a method" do
+    frame = presenter.overview_frames.first
+    app.get "/method", dump: fixture_path("test.dump"), name: frame[:method]
+    expect(response.body).to include("Callers")
+  end
+
+  it "does not crash on a file page" do
+    frame = presenter.overview_frames.first
+    method_info = presenter.method_info frame[:method]
+
+    expect {
+      app.get "/file",
+        dump: fixture_path("test.dump"),
+        path: method_info.first[:location]
+    }.to_not raise_error
+  end
+end