rack-mini-profiler 0.9.2 → 0.9.3

data/lib/html/list.tmpl

@@ -19,14 +19,14 @@
 <script id="rowTemplate" type="text/x-jquery-tmpl">
   <tr>
     <td>
-      <a href="${MiniProfiler.path}results?id=${Id}">${Name}</a></td>
-    <td class="date">${MiniProfiler.renderDate(Started)}</td>
-    <td class="time">${DurationMillisecondsInSql}</td>
-    <td class="time">${DurationMilliseconds}</td>
-    {{if ClientTimings}}
-    <td class="time">${MiniProfiler.getClientTimingByName(ClientTimings,"Request").Start}</td>
-    <td class="time">${MiniProfiler.getClientTimingByName(ClientTimings,"Response").Start}</td>
-    <td class="time">${MiniProfiler.getClientTimingByName(ClientTimings,"Dom Complete").Start}</td>
+      <a href="${MiniProfiler.path}results?id=${id}">${name}</a></td>
+    <td class="date">${MiniProfiler.renderDate(started)}</td>
+    <td class="time">${duration_milliseconds_in_sql}</td>
+    <td class="time">${duration_milliseconds}</td>
+    {{if client_timings}}
+    <td class="time">${MiniProfiler.getClientTimingByName(client_timings,"Request").start}</td>
+    <td class="time">${MiniProfiler.getClientTimingByName(client_timings,"Response").start}</td>
+    <td class="time">${MiniProfiler.getClientTimingByName(client_timings,"Dom Complete").start}</td>
     {{else}}
     <td colspan="3"></td>
     {{/if}}

data/lib/mini_profiler/asset_version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class MiniProfiler
+    ASSET_VERSION = '9db1f8db18400644bd5c7449e5295620'.freeze
+  end
+end

data/lib/mini_profiler/client_settings.rb

@@ -5,8 +5,8 @@ module Rack
       COOKIE_NAME = "__profilin"
 
       BACKTRACE_DEFAULT = nil
-      BACKTRACE_FULL = 1
-      BACKTRACE_NONE = 2
+      BACKTRACE_FULL    = 1
+      BACKTRACE_NONE    = 2
 
       attr_accessor :disable_profiling
       attr_accessor :backtrace_level
@@ -30,7 +30,7 @@ module Rack
       def write!(headers)
         if @orig_disable_profiling != @disable_profiling || @orig_backtrace_level != @backtrace_level || @cookie.nil?
           settings = {"p" =>  "t" }
-          settings["dp"] = "t" if @disable_profiling
+          settings["dp"] = "t"              if @disable_profiling
           settings["bt"] = @backtrace_level if @backtrace_level
           settings_string = settings.map{|k,v| "#{k}=#{v}"}.join(",")
           Rack::Utils.set_cookie_header!(headers, COOKIE_NAME, :value => settings_string, :path => '/')

data/lib/mini_profiler/config.rb

@@ -13,7 +13,7 @@ module Rack
     end
 
     attr_accessor :authorization_mode, :auto_inject, :backtrace_ignores, :backtrace_includes, :backtrace_remove,
-      :backtrace_threshold_ms, :base_url_path, :enabled, :flamegraph_sample_rate, :logger, :position,
+      :backtrace_threshold_ms, :base_url_path, :disable_caching, :enabled, :flamegraph_sample_rate, :logger, :position,
       :pre_authorize_cb, :skip_paths, :skip_schema_queries, :start_hidden, :storage, :storage_failure,
       :storage_instance, :storage_options, :toggle_shortcut, :user_provider
 
@@ -22,20 +22,20 @@ module Rack
 
       def self.default
         new.instance_eval {
-          @auto_inject = true # automatically inject on every html page
-          @base_url_path = "/mini-profiler-resources/"
-
+          @auto_inject      = true # automatically inject on every html page
+          @base_url_path    = "/mini-profiler-resources/"
+          @disable_caching  = true
           # called prior to rack chain, to ensure we are allowed to profile
           @pre_authorize_cb = lambda {|env| true}
 
           # called after rack chain, to ensure we are REALLY allowed to profile
-          @position = 'left'  # Where it is displayed
-          @skip_schema_queries = false
-          @storage = MiniProfiler::MemoryStore
-          @user_provider = Proc.new{|env| Rack::Request.new(env).ip}
-          @authorization_mode = :allow_all
-          @toggle_shortcut = 'Alt+P'
-          @start_hidden = false
+          @position               = 'left'  # Where it is displayed
+          @skip_schema_queries    = false
+          @storage                = MiniProfiler::MemoryStore
+          @user_provider          = Proc.new{|env| Rack::Request.new(env).ip}
+          @authorization_mode     = :allow_all
+          @toggle_shortcut        = 'Alt+P'
+          @start_hidden           = false
           @backtrace_threshold_ms = 0
           @flamegraph_sample_rate = 0.5
           @storage_failure = Proc.new do |exception|

data/lib/mini_profiler/gc_profiler.rb

@@ -37,7 +37,7 @@ class Rack::MiniProfiler::GCProfiler
     result
   end
 
-  def diff_object_stats(before,after)
+  def diff_object_stats(before, after)
     diff = {}
     after.each do |k,v|
       diff[k] = v - (before[k] || 0)
@@ -49,7 +49,7 @@ class Rack::MiniProfiler::GCProfiler
     diff
   end
 
-  def analyze_strings(ids_before,ids_after)
+  def analyze_strings(ids_before, ids_after)
     result = {}
     ids_after.each do |id,_|
       obj = ObjectSpace._id2ref(id)
@@ -92,13 +92,13 @@ class Rack::MiniProfiler::GCProfiler
     [objects,memory_allocated]
   end
 
-  def profile_gc_time(app,env)
+  def profile_gc_time(app, env)
     body = []
 
     begin
       GC::Profiler.clear
       prev_profiler_state = GC::Profiler.enabled?
-      prev_gc_state = GC.enable
+      prev_gc_state       = GC.enable
       GC::Profiler.enable
       b = app.call(env)[2]
       b.close if b.respond_to? :close
@@ -112,7 +112,7 @@ class Rack::MiniProfiler::GCProfiler
     return [200, {'Content-Type' => 'text/plain'}, body]
   end
 
-  def profile_gc(app,env)
+  def profile_gc(app, env)
 
     # for memsize_of
     require 'objspace'
@@ -124,17 +124,17 @@ class Rack::MiniProfiler::GCProfiler
 
     # clean up before
     GC.start
-    stat = GC.stat
+    stat          = GC.stat
     prev_gc_state = GC.disable
-    stat_before = object_space_stats
-    b = app.call(env)[2]
+    stat_before   = object_space_stats
+    b             = app.call(env)[2]
     b.close if b.respond_to? :close
     stat_after = object_space_stats
     # so we don't blow out on memory
     prev_gc_state ? GC.disable : GC.enable
 
-    diff = diff_object_stats(stat_before[:stats],stat_after[:stats])
-    string_analysis = analyze_strings(stat_before[:ids], stat_after[:ids])
+    diff                          = diff_object_stats(stat_before[:stats],stat_after[:stats])
+    string_analysis               = analyze_strings(stat_before[:ids], stat_after[:ids])
     new_objects, memory_allocated = analyze_growth(stat_before[:ids], stat_after[:ids])
     objects_before, memory_before = analyze_initial_state(stat_before[:ids])
 

data/lib/mini_profiler/profiler.rb

@@ -1,30 +1,5 @@
-require 'json'
-require 'timeout'
-require 'thread'
-
-require 'mini_profiler/version'
-require 'mini_profiler/page_timer_struct'
-require 'mini_profiler/sql_timer_struct'
-require 'mini_profiler/custom_timer_struct'
-require 'mini_profiler/client_timer_struct'
-require 'mini_profiler/request_timer_struct'
-require 'mini_profiler/storage/abstract_store'
-require 'mini_profiler/storage/memcache_store'
-require 'mini_profiler/storage/memory_store'
-require 'mini_profiler/storage/redis_store'
-require 'mini_profiler/storage/file_store'
-require 'mini_profiler/config'
-require 'mini_profiler/profiling_methods'
-require 'mini_profiler/context'
-require 'mini_profiler/client_settings'
-require 'mini_profiler/gc_profiler'
-# TODO
-# require 'mini_profiler/gc_profiler_ruby_head' if Gem::Version.new('2.1.0') <= Gem::Version.new(RUBY_VERSION)
-
 module Rack
-
   class MiniProfiler
-
     class << self
 
       include Rack::MiniProfiler::ProfilingMethods
@@ -43,8 +18,7 @@ module Rack
       end
 
       def share_template
-        return @share_template unless @share_template.nil?
-        @share_template = ::File.read(::File.expand_path("../html/share.html", ::File.dirname(__FILE__)))
+        @share_template ||= ::File.read(::File.expand_path("../html/share.html", ::File.dirname(__FILE__)))
       end
 
       def current
@@ -53,7 +27,7 @@ module Rack
 
       def current=(c)
         # we use TLS cause we need access to this from sql blocks and code blocks that have no access to env
-        Thread.current[:mini_profiler_private]= c
+        Thread.current[:mini_profiler_private] = c
       end
 
       # discard existing results, don't track this request
@@ -63,10 +37,10 @@ module Rack
 
       def create_current(env={}, options={})
         # profiling the request
-        self.current = Context.new
-        self.current.inject_js = config.auto_inject && (!env['HTTP_X_REQUESTED_WITH'].eql? 'XMLHttpRequest')
-        self.current.page_struct = PageTimerStruct.new(env)
-        self.current.current_timer = current.page_struct['Root']
+        self.current               = Context.new
+        self.current.inject_js     = config.auto_inject && (!env['HTTP_X_REQUESTED_WITH'].eql? 'XMLHttpRequest')
+        self.current.page_struct   = TimerStruct::Page.new(env)
+        self.current.current_timer = current.page_struct[:root]
       end
 
       def authorize_request
@@ -89,7 +63,7 @@ module Rack
     def initialize(app, config = nil)
       MiniProfiler.config.merge!(config)
       @config = MiniProfiler.config
-      @app = app
+      @app    = app
       @config.base_url_path << "/" unless @config.base_url_path.end_with? "/"
       unless @config.storage_instance
         @config.storage_instance = @config.storage.new(@config.storage_options)
@@ -102,18 +76,18 @@ module Rack
     end
 
     def serve_results(env)
-      request = Rack::Request.new(env)
-      id = request['id']
+      request     = Rack::Request.new(env)
+      id          = request[:id]
       page_struct = @storage.load(id)
       unless page_struct
         @storage.set_viewed(user(env), id)
-        id = ERB::Util.html_escape(request['id'])
+        id        = ERB::Util.html_escape(request['id'])
         user_info = ERB::Util.html_escape(user(env))
         return [404, {}, ["Request not found: #{id} - user #{user_info}"]]
       end
-      unless page_struct['HasUserViewed']
-        page_struct['ClientTimings'] = ClientTimerStruct.init_from_form_data(env, page_struct)
-        page_struct['HasUserViewed'] = true
+      unless page_struct[:has_user_viewed]
+        page_struct[:client_timings]  = TimerStruct::Client.init_from_form_data(env, page_struct)
+        page_struct[:has_user_viewed] = true
         @storage.save(page_struct)
         @storage.set_viewed(user(env), id)
       end
@@ -127,10 +101,10 @@ module Rack
         # Otherwise give the HTML back
         html = MiniProfiler.share_template.dup
         html.gsub!(/\{path\}/, "#{env['SCRIPT_NAME']}#{@config.base_url_path}")
-        html.gsub!(/\{version\}/, MiniProfiler::VERSION)
+        html.gsub!(/\{version\}/, MiniProfiler::ASSET_VERSION)
         html.gsub!(/\{json\}/, result_json)
         html.gsub!(/\{includes\}/, get_profile_script(env))
-        html.gsub!(/\{name\}/, page_struct['Name'])
+        html.gsub!(/\{name\}/, page_struct[:name])
         html.gsub!(/\{duration\}/, "%.1f" % page_struct.duration_ms)
 
         [200, {'Content-Type' => 'text/html'}, [html]]
@@ -145,7 +119,7 @@ module Rack
 
       full_path = ::File.expand_path("../html/#{file_name}", ::File.dirname(__FILE__))
       return [404, {}, ["Not found"]] unless ::File.exists? full_path
-      f = Rack::File.new nil
+      f      = Rack::File.new nil
       f.path = full_path
 
       begin
@@ -166,7 +140,7 @@ module Rack
     end
 
     def current=(c)
-      MiniProfiler.current=c
+      MiniProfiler.current = c
     end
 
 
@@ -181,7 +155,7 @@ module Rack
 
       status = headers = body = nil
       query_string = env['QUERY_STRING']
-      path = env['PATH_INFO']
+      path         = env['PATH_INFO']
 
       skip_it = (@config.pre_authorize_cb && !@config.pre_authorize_cb.call(env)) ||
                 (@config.skip_paths && @config.skip_paths.any?{ |p| path[0,p.length] == p}) ||
@@ -262,7 +236,7 @@ module Rack
 
       if trace_exceptions
         exceptions = []
-        trace = TracePoint.new(:raise) do |tp|
+        trace      = TracePoint.new(:raise) do |tp|
           exceptions << tp.raised_exception
         end
         trace.enable
@@ -272,8 +246,10 @@ module Rack
 
         # Strip all the caching headers so we don't get 304s back
         #  This solves a very annoying bug where rack mini profiler never shows up
-        env['HTTP_IF_MODIFIED_SINCE'] = ''
-        env['HTTP_IF_NONE_MATCH'] = ''
+        if config.disable_caching
+          env['HTTP_IF_MODIFIED_SINCE'] = ''
+          env['HTTP_IF_NONE_MATCH']     = ''
+        end
 
         if query_string =~ /pp=flamegraph/
           unless defined?(Flamegraph) && Flamegraph.respond_to?(:generate)
@@ -283,7 +259,7 @@ module Rack
           else
             # do not sully our profile with mini profiler timings
             current.measure = false
-            match_data = query_string.match(/flamegraph_sample_rate=([\d\.]+)/)
+            match_data      = query_string.match(/flamegraph_sample_rate=([\d\.]+)/)
 
             mode = query_string =~ /mode=c/ ? :c : :ruby
 
@@ -334,8 +310,8 @@ module Rack
       end
 
       page_struct = current.page_struct
-      page_struct['User'] = user(env)
-      page_struct['Root'].record_time((Time.now - start) * 1000)
+      page_struct[:user] = user(env)
+      page_struct[:root].record_time((Time.now - start) * 1000)
 
       if flamegraph
         body.close if body.respond_to? :close
@@ -345,7 +321,7 @@ module Rack
 
       begin
         # no matter what it is, it should be unviewed, otherwise we will miss POST
-        @storage.set_unviewed(page_struct['User'], page_struct['Id'])
+        @storage.set_unviewed(page_struct[:user], page_struct[:id])
         @storage.save(page_struct)
 
         # inject headers, script
@@ -373,9 +349,12 @@ module Rack
       # Rack::ETag has already inserted some nonesense in the chain
       content_type = headers['Content-Type']
 
-      headers.delete('ETag')
-      headers.delete('Date')
-      headers['Cache-Control'] = 'no-store, must-revalidate, private, max-age=0'
+      if config.disable_caching
+        headers.delete('ETag')
+        headers.delete('Date')
+      end
+
+      headers['Cache-Control'] = "#{"no-store, " if config.disable_caching}must-revalidate, private, max-age=0"
 
       # inject header
       if headers.is_a? Hash
@@ -384,7 +363,7 @@ module Rack
 
       if current.inject_js && content_type =~ /text\/html/
         response = Rack::Response.new([], status, headers)
-        script = self.get_profile_script(env)
+        script   = self.get_profile_script(env)
 
         if String === body
           response.write inject(body,script)
@@ -437,7 +416,7 @@ module Rack
 
     def dump_exceptions(exceptions)
       headers = {'Content-Type' => 'text/plain'}
-      body = "Exceptions (#{exceptions.length} raised during request)\n\n"
+      body    = "Exceptions (#{exceptions.length} raised during request)\n\n"
       exceptions.each do |e|
         body << "#{e.class} #{e.message}\n#{e.backtrace.join("\n")}\n\n\n\n"
       end
@@ -504,7 +483,7 @@ module Rack
 
     def ids(env)
       # cap at 10 ids, otherwise there is a chance you can blow the header
-      ([current.page_struct["Id"]] + (@storage.get_unviewed_ids(user(env)) || [])[0..8]).uniq
+      ([current.page_struct[:id]] + (@storage.get_unviewed_ids(user(env)) || [])[0..8]).uniq
     end
 
     def ids_json(env)
@@ -522,25 +501,26 @@ module Rack
     # * you have disabled auto append behaviour throught :auto_inject => false flag
     # * you do not want script to be automatically appended for the current page. You can also call cancel_auto_inject
     def get_profile_script(env)
+      path     = "#{env['SCRIPT_NAME']}#{@config.base_url_path}"
 
       settings = {
-       :path => "#{env['SCRIPT_NAME']}#{@config.base_url_path}",
-       :version => MiniProfiler::VERSION,
-       :position => @config.position,
-       :showTrivial => false,
-       :showChildren => false,
+       :path            => path,
+       :version         => MiniProfiler::ASSET_VERSION,
+       :position        => @config.position,
+       :showTrivial     => false,
+       :showChildren    => false,
        :maxTracesToShow => 10,
-       :showControls => false,
-       :authorized => true,
-       :toggleShortcut => @config.toggle_shortcut,
-       :startHidden => @config.start_hidden
+       :showControls    => false,
+       :authorized      => true,
+       :toggleShortcut  => @config.toggle_shortcut,
+       :startHidden     => @config.start_hidden
       }
 
       if current && current.page_struct
-        settings[:ids] = ids_comma_separated(env)
-        settings[:currentId] = current.page_struct["Id"]
+        settings[:ids]       = ids_comma_separated(env)
+        settings[:currentId] = current.page_struct[:id]
       else
-        settings[:ids] = []
+        settings[:ids]       = []
         settings[:currentId] = ""
       end
 
@@ -562,6 +542,4 @@ module Rack
     end
 
   end
-
 end
-

data/lib/mini_profiler/profiling_methods.rb

@@ -3,32 +3,30 @@ module Rack
     module ProfilingMethods
 
       def record_sql(query, elapsed_ms)
+        return unless current
         c = current
-        return unless c
         c.current_timer.add_sql(query, elapsed_ms, c.page_struct, c.skip_backtrace, c.full_backtrace) if (c && c.current_timer)
       end
 
       def start_step(name)
-        if current
-          parent_timer = current.current_timer
-          current.current_timer = current_timer = current.current_timer.add_child(name)
-          [current_timer,parent_timer]
-        end
+        return unless current
+        parent_timer          = current.current_timer
+        current.current_timer = current_timer = current.current_timer.add_child(name)
+        [current_timer,parent_timer]
       end
 
       def finish_step(obj)
-        if obj && current
-          current_timer, parent_timer = obj
-          current_timer.record_time
-          current.current_timer = parent_timer
-        end
+        return unless obj && current
+        current_timer, parent_timer = obj
+        current_timer.record_time
+        current.current_timer = parent_timer
       end
 
       # perform a profiling step on given block
       def step(name, opts = nil)
         if current
-          parent_timer = current.current_timer
-          result = nil
+          parent_timer          = current.current_timer
+          result                = nil
           current.current_timer = current_timer = current.current_timer.add_child(name)
           begin
             result = yield if block_given?
@@ -65,9 +63,9 @@ module Rack
 
       def profile_method(klass, method, type = :profile, &blk)
         default_name = type==:counter ? method.to_s  : klass.to_s + " " + method.to_s
-        clean = clean_method_name(method)
+        clean        = clean_method_name(method)
 
-        with_profiling =  ("#{clean}_with_mini_profiler").intern
+        with_profiling    = ("#{clean}_with_mini_profiler").intern
         without_profiling = ("#{clean}_without_mini_profiler").intern
 
         if klass.send :method_defined?, with_profiling
@@ -131,8 +129,8 @@ module Rack
       def counter(type, duration_ms=nil)
         result = nil
         if block_given?
-          start = Time.now
-          result = yield
+          start       = Time.now
+          result      = yield
           duration_ms = (Time.now - start).to_f * 1000
         end
         return result if current.nil? || !request_authorized?