rack-mini-profiler 0.1.1 → 0.1.8

data/lib/mini_profiler/profiler.rb

@@ -6,72 +6,107 @@ require 'mini_profiler/page_timer_struct'
 require 'mini_profiler/sql_timer_struct'
 require 'mini_profiler/client_timer_struct'
 require 'mini_profiler/request_timer_struct'
-require 'mini_profiler/body_add_proxy'
 require 'mini_profiler/storage/abstract_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'
 
 module Rack
 
 	class MiniProfiler
 
-		VERSION = 'rZlycOOTnzxZvxTmFuOEV0dSmu4P5m5bLrCtwJHVXPA='.freeze
-		@@instance = nil
+		VERSION = '104'.freeze
 
-		def self.instance
-			@@instance
-		end
+    class << self 
+      
+      include Rack::MiniProfiler::ProfilingMethods
 
-		def self.generate_id
-			rand(36**20).to_s(36)
-		end
+      def generate_id
+        rand(36**20).to_s(36)
+      end
 
-    # Defaults for MiniProfiler's configuration
-    def self.configuration_defaults
-      {
-        :auto_inject => true, # automatically inject on every html page
-        :base_url_path => "/mini-profiler-resources/",
-        :authorize_cb => lambda {|env| true}, # callback returns true if this request is authorized to profile
-        :position => 'left',  # Where it is displayed
-        :backtrace_remove => nil,
-        :backtrace_filter => nil,
-        :skip_schema_queries => true,
-        :storage => MiniProfiler::MemoryStore,
-        :user_provider => Proc.new{|env| Rack::Request.new(env).ip }
-      }
-    end
+      def reset_config
+        @config = Config.default
+      end
 
-    def self.reset_configuration
-      @configuration = configuration_defaults
-    end
+      # So we can change the configuration if we want
+      def config
+        @config ||= Config.default
+      end
 
-    # So we can change the configuration if we want
-    def self.configuration
-      @configuration ||= configuration_defaults.dup
-    end
+      def share_template
+        return @share_template unless @share_template.nil?
+        @share_template = ::File.read(::File.expand_path("../html/share.html", ::File.dirname(__FILE__)))
+      end
+      
+      def current
+        Thread.current[:mini_profiler_private]
+      end
+
+      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
+      end
+
+      # discard existing results, don't track this request
+      def discard_results
+        self.current.discard = true if current
+      end
+
+      # user has the mini profiler cookie, only used when config.authorization_mode == :whitelist
+      def has_profiling_cookie?(env)
+        env['HTTP_COOKIE'] && env['HTTP_COOKIE'].include?("__profilin=stylin")
+      end
+
+      # remove the mini profiler cookie, only used when config.authorization_mode == :whitelist
+      def remove_profiling_cookie(headers)
+        Rack::Utils.delete_cookie_header!(headers, '__profilin')
+      end
+
+      def set_profiling_cookie(headers)
+        Rack::Utils.set_cookie_header!(headers, '__profilin', 'stylin')
+      end
 
-    def self.share_template
-      return @share_template unless @share_template.nil?
-      @share_template = ::File.read(::File.expand_path("../html/share.html", ::File.dirname(__FILE__)))
+      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']
+      end
+
+      def authorize_request
+        Thread.current[:mp_authorized] = true
+      end
+
+      def deauthorize_request
+        Thread.current[:mp_authorized] = nil
+      end
+
+      def request_authorized?
+        Thread.current[:mp_authorized]
+      end
     end
 
 		#
 		# options:
 		# :auto_inject - should script be automatically injected on every html page (not xhr)
-		def initialize(app, opts={})
-			@@instance = self
-      MiniProfiler.configuration.merge!(opts)
-      @options = MiniProfiler.configuration 
+		def initialize(app, config = nil)
+      MiniProfiler.config.merge!(config)
+      @config = MiniProfiler.config 
 			@app = app
-			@options[:base_url_path] << "/" unless @options[:base_url_path].end_with? "/"
-      unless @options[:storage_instance]
-        @storage = @options[:storage_instance] = @options[:storage].new(@options[:storage_options])
+			@config.base_url_path << "/" unless @config.base_url_path.end_with? "/"
+      unless @config.storage_instance
+        @config.storage_instance = @config.storage.new(@config.storage_options)
       end
+      @storage = @config.storage_instance 
 		end
     
     def user(env)
-      options[:user_provider].call(env)
+      @config.user_provider.call(env)
     end
 
 		def serve_results(env)
@@ -83,7 +118,7 @@ module Rack
         return [404, {}, ["Request not found: #{request['id']} - user #{user(env)}"]] 
       end
 			unless page_struct['HasUserViewed']
-				page_struct['ClientTimings'].init_from_form_data(env, page_struct)
+        page_struct['ClientTimings'] = ClientTimerStruct.init_from_form_data(env, page_struct)
 				page_struct['HasUserViewed'] = true
         @storage.save(page_struct) 
         @storage.set_viewed(user(env), id) 
@@ -97,7 +132,7 @@ module Rack
 
         # Otherwise give the HTML back
         html = MiniProfiler.share_template.dup  
-        html.gsub!(/\{path\}/, @options[:base_url_path])      
+        html.gsub!(/\{path\}/, @config.base_url_path)      
         html.gsub!(/\{version\}/, MiniProfiler::VERSION)      
         html.gsub!(/\{json\}/, result_json)
         html.gsub!(/\{includes\}/, get_profile_script(env))
@@ -110,25 +145,26 @@ module Rack
 		end
 
 		def serve_html(env)
-			file_name = env['PATH_INFO'][(@options[:base_url_path].length)..1000]
+			file_name = env['PATH_INFO'][(@config.base_url_path.length)..1000]
 			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
-			f.cache_control = "max-age:86400"
-			f.serving env
-		end
 
-    def self.current
-      Thread.current['profiler.mini.private']
-    end
+      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
 
-    def self.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['profiler.mini.private'] = c
-    end
-   
+		end
+
+    
     def current
       MiniProfiler.current
     end
@@ -137,54 +173,73 @@ module Rack
       MiniProfiler.current=c
     end
 
-    def options
-      @options
-    end
 
-    def self.create_current(env={}, options={})
-      # profiling the request
-      self.current = {}
-      self.current['inject_js'] = options[:auto_inject] && (!env['HTTP_X_REQUESTED_WITH'].eql? 'XMLHttpRequest')
-      self.current['page_struct'] = PageTimerStruct.new(env)
-      self.current['current_timer'] = current['page_struct']['Root']
+    def config
+      @config
     end
 
+
 		def call(env)
-			status = headers = body = nil
+      status = headers = body = nil
+      path = env['PATH_INFO']
 
-			# only profile if authorized
-			return @app.call(env) unless @options[:authorize_cb].call(env)
+      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}) ||
+                env["QUERY_STRING"] =~ /pp=skip/ 
+      
+      has_profiling_cookie = MiniProfiler.has_profiling_cookie?(env)
+    
+      if skip_it || (@config.authorization_mode == :whitelist && !has_profiling_cookie)
+        status,headers,body = @app.call(env)
+        if !skip_it && @config.authorization_mode == :whitelist && !has_profiling_cookie && MiniProfiler.request_authorized? 
+          MiniProfiler.set_profiling_cookie(headers) 
+        end
+        return [status,headers,body]
+      end
 
-			# handle all /mini-profiler requests here
-			return serve_html(env) if env['PATH_INFO'].start_with? @options[:base_url_path]
+      # handle all /mini-profiler requests here
+			return serve_html(env) if env['PATH_INFO'].start_with? @config.base_url_path
 
-      MiniProfiler.create_current(env, @options)
-      if env["QUERY_STRING"] =~ /pp=skip-backtrace/
-        current['skip-backtrace'] = true
+      MiniProfiler.create_current(env, @config)
+      MiniProfiler.deauthorize_request if @config.authorization_mode == :whitelist
+      if env["QUERY_STRING"] =~ /pp=no-backtrace/
+        current.skip_backtrace = true
+      elsif env["QUERY_STRING"] =~ /pp=full-backtrace/
+        current.full_backtrace = true
       end
 
-      start = Time.now 
-
       done_sampling = false
       quit_sampler = false
       backtraces = nil
+      missing_stacktrace = false
       if env["QUERY_STRING"] =~ /pp=sample/
         backtraces = []
         t = Thread.current
         Thread.new {
-          i = 10000 # for sanity never grab more than 10k samples 
-          unless done_sampling || i < 0
-            i -= 1
-            backtraces << t.backtrace
-            sleep 0.001
+          begin
+            require 'stacktrace' rescue nil
+            if !t.respond_to? :stacktrace
+              missing_stacktrace = true
+              quit_sampler = true 
+              return
+            end
+            i = 10000 # for sanity never grab more than 10k samples 
+            while i > 0
+              break if done_sampling
+              i -= 1
+              backtraces << t.stacktrace
+              sleep 0.001
+            end
+          ensure
+            quit_sampler = true
           end
-          quit_sampler = true
         }
       end
 
 			status, headers, body = nil
+      start = Time.now 
       begin 
-        status,headers, body = @app.call(env)
+        status,headers,body = @app.call(env)
       ensure
         if backtraces 
           done_sampling = true
@@ -192,9 +247,35 @@ module Rack
         end
       end
 
-      page_struct = current['page_struct']
+      skip_it = current.discard
+      if (config.authorization_mode == :whitelist && !MiniProfiler.request_authorized?)
+        MiniProfiler.remove_profiling_cookie(headers)
+        skip_it = true
+      end
+      
+      return [status,headers,body] if skip_it
+
+      # we must do this here, otherwise current[:discard] is not being properly treated
+      if env["QUERY_STRING"] =~ /pp=env/
+        body.close if body.respond_to? :close
+        return dump_env env
+      end
+
+      if env["QUERY_STRING"] =~ /pp=help/
+        body.close if body.respond_to? :close
+        return help
+      end
+      
+      page_struct = current.page_struct
 			page_struct['Root'].record_time((Time.now - start) * 1000)
 
+      if backtraces
+        body.close if body.respond_to? :close
+        return help(:stacktrace) if missing_stacktrace
+        return analyze(backtraces, page_struct)
+      end
+      
+
       # no matter what it is, it should be unviewed, otherwise we will miss POST
       @storage.set_unviewed(user(env), page_struct['Id']) 
 			@storage.save(page_struct)
@@ -202,32 +283,106 @@ module Rack
       # inject headers, script
 			if status == 200
         
+        # mini profiler is meddling with stuff, we can not cache cause we will get incorrect data
+        # Rack::ETag has already inserted some nonesense in the chain
+        headers.delete('ETag')
+        headers.delete('Date')
+        headers['Cache-Control'] = 'must-revalidate, private, max-age=0'
+
 				# inject header
         if headers.is_a? Hash
           headers['X-MiniProfiler-Ids'] = ids_json(env)
         end
 
 				# inject script
-				if current['inject_js'] \
+				if current.inject_js \
 					&& headers.has_key?('Content-Type') \
 					&& !headers['Content-Type'].match(/text\/html/).nil? then
-					body = MiniProfiler::BodyAddProxy.new(body, self.get_profile_script(env))
+					
+          response = Rack::Response.new([], status, headers)
+          script = self.get_profile_script(env)
+          if String === body
+            response.write inject(body,script)
+          else
+            body.each { |fragment| response.write inject(fragment, script) }
+          end
+          body.close if body.respond_to? :close
+          return response.finish
 				end
 			end
 
-      # mini profiler is meddling with stuff, we can not cache cause we will get incorrect data
-      # Rack::ETag has already inserted some nonesense in the chain
-      headers.delete('ETag')
-      headers.delete('Date')
-      headers['Cache-Control'] = 'must-revalidate, private, max-age=0'
 			[status, headers, body]
     ensure
       # Make sure this always happens
       current = nil
 		end
 
+    def inject(fragment, script)
+      fragment.sub(/<\/body>/i, script + "</body>") 
+    end
+
+    def dump_env(env)
+      headers = {'Content-Type' => 'text/plain'}
+      body = "" 
+      env.each do |k,v|
+        body << "#{k}: #{v}\n"
+      end
+      [200, headers, [body]]
+    end
+
+    def help(category = nil)
+      headers = {'Content-Type' => 'text/plain'}
+      body = "Append the following to your query string:
+
+  pp=help : display this screen
+  pp=env : display the rack environment
+  pp=skip : skip mini profiler for this request
+  pp=no-backtrace : don't collect stack traces from all the SQL executed
+  pp=full-backtrace : enable full backtrace for SQL executed
+  pp=sample : sample stack traces and return a report isolating heavy usage (requires the stacktrace gem)
+"
+      if (category == :stacktrace)
+        body = "pp=stacktrace requires the stacktrace gem - add gem 'stacktrace' to your Gemfile"
+      end
+    
+      [200, headers, [body]]
+    end
+
+    def analyze(traces, page_struct)
+      headers = {'Content-Type' => 'text/plain'}
+      body = "Collected: #{traces.count} stack traces. Duration(ms): #{page_struct.duration_ms}"
+
+      seen = {}
+      fulldump = ""
+      traces.each do |trace| 
+        fulldump << "\n\n"
+        distinct = {}
+        trace.each do |frame|
+          name = "#{frame.klass} #{frame.method}"
+          unless distinct[name]
+            distinct[name] = true
+            seen[name] ||= 0
+            seen[name] += 1
+          end
+          fulldump << name << "\n"
+        end
+      end
+
+      body << "\n\nStack Trace Analysis\n"
+      seen.to_a.sort{|x,y| y[1] <=> x[1]}.each do |name, count|
+        if count > traces.count / 10
+          body << "#{name} x #{count}\n"
+        end
+      end
+      
+      body << "\n\n\nRaw traces \n"
+      body << fulldump
+
+      [200, headers, [body]]
+    end
+
     def ids_json(env)
-      ids = [current['page_struct']["Id"]] + (@storage.get_unviewed_ids(user(env)) || [])
+      ids = [current.page_struct["Id"]] + (@storage.get_unviewed_ids(user(env)) || [])
       ::JSON.generate(ids.uniq)
     end
 
@@ -239,16 +394,16 @@ module Rack
 		# * 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)
 			ids = ids_json(env)
-			path = @options[:base_url_path]
+			path = @config.base_url_path
 			version = MiniProfiler::VERSION
-			position = @options[:position]
+			position = @config.position
 			showTrivial = false
 			showChildren = false
 			maxTracesToShow = 10
 			showControls = false
-			currentId = current['page_struct']["Id"]
+			currentId = current.page_struct["Id"]
 			authorized = true
-      useExistingjQuery = false
+			useExistingjQuery = @config.use_existing_jquery
 			# TODO : cache this snippet 
 			script = IO.read(::File.expand_path('../html/profile_handler.js', ::File.dirname(__FILE__)))
 			# replace the variables
@@ -258,52 +413,13 @@ module Rack
 			end
 			# replace the '{{' and '}}''
 			script.gsub!(/\{\{/, '{').gsub!(/\}\}/, '}')
-			current['inject_js'] = false
+			current.inject_js = false
 			script
 		end
 
 		# cancels automatic injection of profile script for the current page
 		def cancel_auto_inject(env)
-		  current['inject_js'] = false
-		end
-
-		# perform a profiling step on given block
-		def self.step(name)
-      if current
-        old_timer = current['current_timer']
-        new_step = RequestTimerStruct.new(name, current['page_struct'])
-        current['current_timer'] = new_step
-        new_step['Name'] = name
-        start = Time.now
-        result = yield if block_given?
-        new_step.record_time((Time.now - start)*1000)
-        old_timer.add_child(new_step)
-        current['current_timer'] = old_timer
-        result
-      else
-        yield if block_given?
-      end
-		end
-
-    def self.profile_method(klass, method, &blk)
-      default_name = klass.to_s + " " + method.to_s
-      with_profiling = (method.to_s + "_with_mini_profiler").intern
-      without_profiling = (method.to_s + "_without_mini_profiler").intern
-      
-      klass.send :alias_method, without_profiling, method
-      klass.send :define_method, with_profiling do |*args, &orig|
-        name = default_name 
-        name = blk.bind(self).call(*args) if blk
-        ::Rack::MiniProfiler.step name do 
-          self.send without_profiling, *args, &orig
-        end
-      end
-      klass.send :alias_method, method, with_profiling
-    end
-
-		def record_sql(query, elapsed_ms)
-      c = current
-			c['current_timer'].add_sql(query, elapsed_ms, c['page_struct'], c['skip-backtrace']) if (c && c['current_timer'])
+		  current.inject_js = false
 		end
 
 	end

data/lib/mini_profiler/profiling_methods.rb

@@ -0,0 +1,73 @@
+module Rack
+  class MiniProfiler
+    module ProfilingMethods 
+     
+		  def record_sql(query, elapsed_ms)
+        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
+
+      # perform a profiling step on given block
+      def step(name)
+        if current
+          parent_timer = current.current_timer
+          result = nil
+          current.current_timer = current_timer = current.current_timer.add_child(name) 
+          begin 
+            result = yield if block_given?
+          ensure
+            current_timer.record_time
+            current.current_timer = parent_timer
+          end
+          result
+        else
+          yield if block_given?
+        end
+      end
+
+      def unprofile_method(klass, method)
+        with_profiling = (method.to_s + "_with_mini_profiler").intern
+        without_profiling = (method.to_s + "_without_mini_profiler").intern
+        
+        if klass.send :method_defined?, with_profiling
+          klass.send :alias_method, method, without_profiling
+          klass.send :remove_method, with_profiling
+          klass.send :remove_method, without_profiling
+        end
+      end
+
+      def profile_method(klass, method, &blk)
+        default_name = klass.to_s + " " + method.to_s
+        with_profiling = (method.to_s + "_with_mini_profiler").intern
+        without_profiling = (method.to_s + "_without_mini_profiler").intern
+        
+        if klass.send :method_defined?, with_profiling
+          return # dont double profile
+        end
+          
+        klass.send :alias_method, without_profiling, method
+        klass.send :define_method, with_profiling do |*args, &orig|
+          return self.send without_profiling, *args, &orig unless Rack::MiniProfiler.current
+
+          name = default_name 
+          name = blk.bind(self).call(*args) if blk
+          
+          parent_timer = Rack::MiniProfiler.current.current_timer
+          page_struct = Rack::MiniProfiler.current.page_struct
+          result = nil
+
+          Rack::MiniProfiler.current.current_timer = current_timer = parent_timer.add_child(name) 
+          begin 
+            result = self.send without_profiling, *args, &orig
+          ensure
+            current_timer.record_time
+            Rack::MiniProfiler.current.current_timer = parent_timer
+          end 
+          result 
+        end
+        klass.send :alias_method, method, with_profiling
+      end
+    end
+  end
+end

data/lib/mini_profiler/request_timer_struct.rb

@@ -6,14 +6,14 @@ module Rack
     class RequestTimerStruct < TimerStruct
       
       def self.createRoot(name, page)
-        rt = RequestTimerStruct.new(name, page)
+        rt = RequestTimerStruct.new(name, page, nil)
         rt["IsRoot"]= true
         rt
       end
 
-      attr_reader :children_duration
+      attr_accessor :children_duration
 
-      def initialize(name, page)
+      def initialize(name, page, parent)
         super("Id" => MiniProfiler.generate_id,
               "Name" => name,
               "DurationMilliseconds" => 0,
@@ -30,34 +30,65 @@ module Rack
               "SqlTimingsDurationMilliseconds"=> 0,
               "IsTrivial"=> false,
               "IsRoot"=> false,
-              "Depth"=> 0,
+              "Depth"=> parent ? parent.depth + 1 : 0,
               "ExecutedReaders"=> 0,
               "ExecutedScalars"=> 0,
               "ExecutedNonQueries"=> 0)
         @children_duration = 0
+        @start = Time.now
+        @parent = parent
+        @page = page
       end
 
-      def add_child(request_timer)
+      def duration_ms
+        self['DurationMilliseconds']
+      end
+
+      def start_ms
+        self['StartMilliseconds']
+      end
+
+      def start
+        @start
+      end
+
+      def depth
+        self['Depth']
+      end
+
+      def children
+        self['Children']
+      end
+
+      def add_child(name)
+        request_timer =  RequestTimerStruct.new(name, @page, self)
         self['Children'].push(request_timer)
         self['HasChildren'] = true
         request_timer['ParentTimingId'] = self['Id']
         request_timer['Depth'] = self['Depth'] + 1
-        @children_duration += request_timer['DurationMilliseconds']
+        request_timer
       end
 
-      def add_sql(query, elapsed_ms, page, skip_backtrace = false)
-        timer = SqlTimerStruct.new(query, elapsed_ms, page, skip_backtrace)
+      def add_sql(query, elapsed_ms, page, skip_backtrace = false, full_backtrace = false)
+        timer = SqlTimerStruct.new(query, elapsed_ms, page, self , skip_backtrace, full_backtrace)
         timer['ParentTimingId'] = self['Id']
         self['SqlTimings'].push(timer)
         self['HasSqlTimings'] = true
         self['SqlTimingsDurationMilliseconds'] += elapsed_ms
         page['DurationMillisecondsInSql'] += elapsed_ms        
+        timer
       end
 
-      def record_time(milliseconds)
+      def record_time(milliseconds = nil)
+        milliseconds ||= (Time.now - @start) * 1000
         self['DurationMilliseconds'] = milliseconds
         self['IsTrivial'] = true if milliseconds < self["TrivialDurationThresholdMilliseconds"]
         self['DurationWithoutChildrenMilliseconds'] = milliseconds - @children_duration
+        
+        if @parent
+          @parent.children_duration += milliseconds
+        end
+
       end     
     end
   end