rack-mini-profiler 0.9.4 → 0.9.9

data/lib/mini_profiler/config.rb

@@ -12,10 +12,13 @@ module Rack
       @attributes
     end
 
-    attr_accessor :authorization_mode, :auto_inject, :backtrace_ignores, :backtrace_includes, :backtrace_remove,
-      :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
+    attr_accessor :authorization_mode, :auto_inject, :backtrace_ignores,
+      :backtrace_includes, :backtrace_remove, :backtrace_threshold_ms,
+      :base_url_path, :disable_caching, :disable_env_dump, :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, :collapse_results
 
     # Deprecated options
     attr_accessor :use_existing_jquery
@@ -44,6 +47,8 @@ module Rack
             end
           end
           @enabled = true
+          @disable_env_dump = false
+          @collapse_results = true
           self
         }
       end

data/lib/mini_profiler/gc_profiler.rb

@@ -6,18 +6,15 @@ class Rack::MiniProfiler::GCProfiler
   end
 
   def object_space_stats
-    stats = {}
-    ids = {}
+    stats = Hash.new(0).compare_by_identity
+    ids = Hash.new.compare_by_identity
 
     @ignore << stats.__id__
     @ignore << ids.__id__
 
-    i=0
     ObjectSpace.each_object { |o|
       begin
-        i = stats[o.class] || 0
-        i += 1
-        stats[o.class] = i
+        stats[o.class] += 1
         ids[o.__id__] = o if Integer === o.__id__
       rescue NoMethodError
         # protect against BasicObject
@@ -38,12 +35,12 @@ class Rack::MiniProfiler::GCProfiler
   end
 
   def diff_object_stats(before, after)
-    diff = {}
+    diff = {}.compare_by_identity
     after.each do |k,v|
-      diff[k] = v - (before[k] || 0)
+      diff[k] = v - before[k]
     end
     before.each do |k,v|
-      diff[k] = 0 - v unless after[k]
+      diff[k] = 0 - v unless after.has_key?(k)
     end
 
     diff
@@ -92,36 +89,11 @@ class Rack::MiniProfiler::GCProfiler
     [objects,memory_allocated]
   end
 
-  def profile_gc_time(app, env)
-    body = []
-
-    begin
-      GC::Profiler.clear
-      prev_profiler_state = GC::Profiler.enabled?
-      prev_gc_state       = GC.enable
-      GC::Profiler.enable
-      b = app.call(env)[2]
-      b.close if b.respond_to? :close
-      body << "GC Profiler ran during this request, if it fired you will see the cost below:\n\n"
-      body << GC::Profiler.result
-    ensure
-      prev_gc_state ? GC.disable : GC.enable
-      GC::Profiler.disable unless prev_profiler_state
-    end
-
-    return [200, {'Content-Type' => 'text/plain'}, body]
-  end
-
   def profile_gc(app, env)
 
     # for memsize_of
     require 'objspace'
 
-    body = [];
-
-    stat_before,stat_after,diff,string_analysis,
-      new_objects, memory_allocated, stat, memory_before, objects_before = nil
-
     # clean up before
     GC.start
     stat          = GC.stat
@@ -138,13 +110,17 @@ class Rack::MiniProfiler::GCProfiler
     new_objects, memory_allocated = analyze_growth(stat_before[:ids], stat_after[:ids])
     objects_before, memory_before = analyze_initial_state(stat_before[:ids])
 
+    body = []
 
     body << "
 Overview
-------------------------------------
-Initial state: object count - #{objects_before} , memory allocated outside heap (bytes) #{memory_before}
+--------
+Initial state: object count: #{objects_before}
+Memory allocated outside heap (bytes): #{memory_before}
 
-GC Stats: #{stat.map{|k,v| "#{k} : #{v}" }.join(", ")}
+GC Stats:
+--------
+#{stat.map{|k,v| "#{k} : #{v}" }.sort!.join("\n")}
 
 New bytes allocated outside of Ruby heaps: #{memory_allocated}
 New objects: #{new_objects}
@@ -152,16 +128,16 @@ New objects: #{new_objects}
 
     body << "
 ObjectSpace delta caused by request:
---------------------------------------------\n"
-    diff.to_a.reject{|k,v| v == 0}.sort{|x,y| y[1] <=> x[1]}.each do |k,v|
-      body << "#{k} : #{v}\n" if v != 0
+-----------------------------------\n"
+    diff.to_a.delete_if{|_k, v| v == 0}.sort_by! { |_k, v| v }.reverse_each do |k,v|
+      body << "#{k} : #{v}\n"
     end
 
     body << "\n
 ObjectSpace stats:
 -----------------\n"
 
-    stat_after[:stats].to_a.sort{|x,y| y[1] <=> x[1]}.each do |k,v|
+    stat_after[:stats].to_a.sort_by!{ |_k, v| v }.reverse_each do |k,v|
       body << "#{k} : #{v}\n"
     end
 
@@ -170,7 +146,7 @@ ObjectSpace stats:
 String stats:
 ------------\n"
 
-    string_analysis.to_a.sort{|x,y| y[1] <=> x[1] }.take(1000).each do |string,count|
+    string_analysis.to_a.sort_by!{ |_k, v| -v }.take(1000).each do |string,count|
       body << "#{count} : #{string}\n"
     end
 

data/lib/mini_profiler/profiler.rb

@@ -17,6 +17,10 @@ module Rack
         @config ||= Config.default
       end
 
+      def resources_root
+        @resources_root ||= ::File.expand_path("../../html", __FILE__)
+      end
+
       def share_template
         @share_template ||= ::File.read(::File.expand_path("../html/share.html", ::File.dirname(__FILE__)))
       end
@@ -37,10 +41,11 @@ 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   = TimerStruct::Page.new(env)
-        self.current.current_timer = current.page_struct[:root]
+        context               = Context.new
+        context.inject_js     = config.auto_inject && (!env['HTTP_X_REQUESTED_WITH'].eql? 'XMLHttpRequest')
+        context.page_struct   = TimerStruct::Page.new(env)
+        context.current_timer = context.page_struct[:root]
+        self.current          = context
       end
 
       def authorize_request
@@ -92,24 +97,26 @@ module Rack
         @storage.set_viewed(user(env), id)
       end
 
-      result_json = page_struct.to_json
       # If we're an XMLHttpRequest, serve up the contents as JSON
       if request.xhr?
+        result_json = page_struct.to_json
         [200, { 'Content-Type' => 'application/json'}, [result_json]]
       else
-
         # Otherwise give the HTML back
-        html = MiniProfiler.share_template.dup
-        html.gsub!(/\{path\}/, "#{env['RACK_MINI_PROFILER_ORIGINAL_SCRIPT_NAME']}#{@config.base_url_path}")
-        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!(/\{duration\}/, "%.1f" % page_struct.duration_ms)
-
+        html = generate_html(page_struct, env)
         [200, {'Content-Type' => 'text/html'}, [html]]
       end
+    end
 
+    def generate_html(page_struct, env, result_json = page_struct.to_json)
+        html = MiniProfiler.share_template.dup
+        html.sub!('{path}', "#{env['RACK_MINI_PROFILER_ORIGINAL_SCRIPT_NAME']}#{@config.base_url_path}")
+        html.sub!('{version}', MiniProfiler::ASSET_VERSION)
+        html.sub!('{json}', result_json)
+        html.sub!('{includes}', get_profile_script(env))
+        html.sub!('{name}', page_struct[:name])
+        html.sub!('{duration}', page_struct.duration_ms.round(1).to_s)
+        html
     end
 
     def serve_html(env)
@@ -117,21 +124,11 @@ module Rack
 
       return serve_results(env) if file_name.eql?('results')
 
-      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.path = full_path
-
-      begin
-        f.cache_control = "max-age:86400"
-        f.serving env
-      rescue
-        # old versions of rack have a different api
-        status, headers, body = f.serving
-        headers.merge! 'Cache-Control' => "max-age:86400"
-        [status, headers, body]
-      end
+      resources_env = env.dup
+      resources_env['PATH_INFO'] = file_name
 
+      rack_file = Rack::File.new(MiniProfiler.resources_root, {'Cache-Control' => 'max-age:86400'})
+      rack_file.call(resources_env)
     end
 
 
@@ -197,22 +194,27 @@ module Rack
         client_settings.disable_profiling = false
       end
 
+      # profile gc
       if query_string =~ /pp=profile-gc/
         current.measure = false if current
-
-        if query_string =~ /pp=profile-gc-time/
-          return Rack::MiniProfiler::GCProfiler.new.profile_gc_time(@app, env)
-        elsif query_string =~ /pp=profile-gc-ruby-head/
-          result = StringIO.new
-          report = MemoryProfiler.report do
-            _,_,body = @app.call(env)
-            body.close if body.respond_to? :close
-          end
-          report.pretty_print(result)
-          return text_result(result.string)
-        else
-          return Rack::MiniProfiler::GCProfiler.new.profile_gc(@app, env)
+        return Rack::MiniProfiler::GCProfiler.new.profile_gc(@app, env)
+      end
+
+      # profile memory
+      if query_string =~ /pp=profile-memory/
+        query_params = Rack::Utils.parse_nested_query(query_string)
+        options = {
+          :ignore_files => query_params['memory_profiler_ignore_files'],
+          :allow_files => query_params['memory_profiler_allow_files'],
+        }
+        options[:top]= Integer(query_params['memory_profiler_top']) if query_params.key?('memory_profiler_top')
+        result = StringIO.new
+        report = MemoryProfiler.report(options) do
+          _,_,body = @app.call(env)
+          body.close if body.respond_to? :close
         end
+        report.pretty_print(result)
+        return text_result(result.string)
       end
 
       MiniProfiler.create_current(env, @config)
@@ -288,7 +290,7 @@ module Rack
       if (config.authorization_mode == :whitelist && !MiniProfiler.request_authorized?)
         # this is non-obvious, don't kill the profiling cookie on errors or short requests
         # this ensures that stuff that never reaches the rails stack does not kill profiling
-        if status == 200 && ((Time.now - start) > 0.1)
+        if status.to_i >= 200 && status.to_i < 300 && ((Time.now - start) > 0.1)
           client_settings.discard_cookie!(headers)
         end
         skip_it = true
@@ -302,7 +304,7 @@ module Rack
         return dump_exceptions exceptions
       end
 
-      if query_string =~ /pp=env/
+      if query_string =~ /pp=env/ && !config.disable_env_dump
         body.close if body.respond_to? :close
         return dump_env env
       end
@@ -333,7 +335,7 @@ module Rack
         @storage.save(page_struct)
 
         # inject headers, script
-        if headers['Content-Type'] && status == 200
+        if status >= 200 && status < 300
           client_settings.write!(headers)
           result = inject_profiler(env,status,headers,body)
           return result if result
@@ -386,39 +388,17 @@ module Rack
     end
 
     def inject(fragment, script)
-      if fragment.match(/<\/body>/i)
-        # explicit </body>
-
-        regex = /<\/body>/i
-        close_tag = '</body>'
-      elsif fragment.match(/<\/html>/i)
-        # implicit </body>
-
-        regex = /<\/html>/i
-        close_tag = '</html>'
-      else
-        # implicit </body> and </html>. Don't do anything.
-
-        return fragment
-      end
-
-      matches = fragment.scan(regex).length
-      index = 1
-      fragment.gsub(regex) do
-        # though malformed there is an edge case where /body exists earlier in the html, work around
-        if index < matches
-          index += 1
-          close_tag
-        else
-
-          # if for whatever crazy reason we dont get a utf string,
-          #   just force the encoding, no utf in the mp scripts anyway
-          if script.respond_to?(:encoding) && script.respond_to?(:force_encoding)
-            (script + close_tag).force_encoding(fragment.encoding)
-          else
-            script + close_tag
-          end
+      # find explicit or implicit body
+      index = fragment.rindex(/<\/body>/i) || fragment.rindex(/<\/html>/i)
+      if index
+        # if for whatever crazy reason we dont get a utf string,
+        #   just force the encoding, no utf in the mp scripts anyway
+        if script.respond_to?(:encoding) && script.respond_to?(:force_encoding)
+          script = script.force_encoding(fragment.encoding)
         end
+        fragment.insert(index, script)
+      else
+        fragment
       end
     end
 
@@ -463,23 +443,50 @@ module Rack
     def analyze_memory
       require 'objspace'
 
+      utf8 = "utf-8"
+
+      GC.start
+
+      trunc = lambda do |str|
+        str = str.length > 200 ? str : str[0..200]
+
+        if str.encoding != Encoding::UTF_8
+          str = str.dup
+          str.force_encoding(utf8)
+
+          unless str.valid_encoding?
+            # work around bust string with a double conversion
+            str.encode!("utf-16","utf-8",:invalid => :replace)
+            str.encode!("utf-8","utf-16")
+          end
+        end
+
+        str
+      end
+
       body = "ObjectSpace stats:\n\n"
 
-      body << ObjectSpace.count_objects
+      counts = ObjectSpace.count_objects
+      total_strings = counts[:T_STRING]
+
+      body << counts
         .sort{|a,b| b[1] <=> a[1]}
         .map{|k,v| "#{k}: #{v}"}
         .join("\n")
 
-      body << "\n\n\n1000 Largest strings:\n\n"
-
       strings = []
-      max_size = 1000
+      string_counts = Hash.new(0)
+      sample_strings = []
 
-      GC.start
-      GC.start
+      max_size = 1000
+      sample_every = total_strings / max_size
 
+      i = 0
       ObjectSpace.each_object(String) do |str|
-        strings << [str[0..200], str.length]
+        i += 1
+        string_counts[str] += 1
+        strings << [trunc.call(str), str.length]
+        sample_strings << [trunc.call(str), str.length] if i % sample_every == 0
         if strings.length > max_size * 2
           trim_strings(strings, max_size)
         end
@@ -487,7 +494,14 @@ module Rack
 
       trim_strings(strings, max_size)
 
-      body << strings.map{|s,len| "#{s}\n(#{len})\n\n"}.join("\n")
+      body << "\n\n\n1000 Largest strings:\n\n"
+      body << strings.map{|s,len| "#{s[0..1000]}\n(len: #{len})\n\n"}.join("\n")
+
+      body << "\n\n\n1000 Sample strings:\n\n"
+      body << sample_strings.map{|s,len| "#{s[0..1000]}\n(len: #{len})\n\n"}.join("\n")
+
+      body << "\n\n\n1000 Most common strings:\n\n"
+      body << string_counts.sort{|a,b| b[1] <=> a[1]}[0..max_size].map{|s,len| "#{trunc.call(s)}\n(x #{len})\n\n"}.join("\n")
 
       text_result(body)
     end
@@ -517,12 +531,11 @@ Append the following to your query string:
   #{make_link "disable", env} : disable profiling for this session
   #{make_link "enable", env} : enable profiling for this session (if previously disabled)
   #{make_link "profile-gc", env} : perform gc profiling on this request, analyzes ObjectSpace generated by request (ruby 1.9.3 only)
-  #{make_link "profile-gc-time", env} : perform built-in gc profiling on this request (ruby 1.9.3 only)
-  #{make_link "profile-gc-ruby-head", env} : requires the memory_profiler gem, new location based report
+  #{make_link "profile-memory", env} : requires the memory_profiler gem, new location based report
   #{make_link "flamegraph", env} : works best on Ruby 2.0, a graph representing sampled activity (requires the flamegraph gem).
   #{make_link "flamegraph&flamegraph_sample_rate=1", env}: creates a flamegraph with the specified sample rate (in ms). Overrides value set in config
   #{make_link "flamegraph_embed", env} : works best on Ruby 2.0, a graph representing sampled activity (requires the flamegraph gem), embedded resources for use on an intranet.
-  #{make_link "trace-exceptions", env} : requires Ruby 2.0, will return all the spots where your application raises execptions
+  #{make_link "trace-exceptions", env} : requires Ruby 2.0, will return all the spots where your application raises exceptions
   #{make_link "analyze-memory", env} : requires Ruby 2.0, will perform basic memory analysis of heap
 </pre>
 </body>
@@ -558,7 +571,17 @@ Append the following to your query string:
     # * 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['RACK_MINI_PROFILER_ORIGINAL_SCRIPT_NAME']}#{@config.base_url_path}"
+      path = if ENV["PASSENGER_BASE_URI"] then
+        # added because the SCRIPT_NAME workaround below then
+        # breaks running under a prefix as permitted by Passenger. 
+        "#{ENV['PASSENGER_BASE_URI']}#{@config.base_url_path}"
+      elsif env["action_controller.instance"]
+        # Rails engines break SCRIPT_NAME; the following appears to discard SCRIPT_NAME
+        # since url_for appears documented to return any String argument unmodified
+        env["action_controller.instance"].url_for("#{@config.base_url_path}")
+      else
+        "#{env['RACK_MINI_PROFILER_ORIGINAL_SCRIPT_NAME']}#{@config.base_url_path}"
+      end
 
       settings = {
        :path            => path,
@@ -570,7 +593,8 @@ Append the following to your query string:
        :showControls    => false,
        :authorized      => true,
        :toggleShortcut  => @config.toggle_shortcut,
-       :startHidden     => @config.start_hidden
+       :startHidden     => @config.start_hidden,
+       :collapseResults => @config.collapse_results
       }
 
       if current && current.page_struct