rack-mini-profiler 0.1.2 → 0.1.3

data/{CHANGELOG.md → CHANGELOG}

@@ -6,3 +6,12 @@
   * Fixed bug where unviewed missing ids never got cleared
   * Supress all '/assets/' in the rails tie (makes debugging easier)
   * record_sql was mega buggy
+
+9-July-2012 - Sam 
+
+  * Cleaned up mechanism for profiling in production, all you need to do now
+	is call Rack::MiniProfiler.authorize_request to get profiling working in
+	production 
+	* Added option to display full backtraces pp=full-backtrace
+	* Cleaned up railties, got rid of the post authorize callback
+	* Version 0.1.3

data/README.md

@@ -2,7 +2,7 @@
 
 Middleware that displays speed badge for every html page. Designed to work both in production and in development.
 
-## Using mini-profiler in your app
+## Using rack-mini-profiler in your app
 
 Install/add to Gemfile
 
@@ -13,6 +13,20 @@ Using Rails:
 
 All you have to do is include the Gem and you're good to go in development.
 
+rack-mini-profiler is designed with production profiling in mind. To enable that just run `Rack::MiniProfiler.authorize_request` once you know a request is allowed to profile.
+
+For example: 
+
+```ruby
+# A hook in your ApplicationController
+def authorize
+  if current_user.is_admin? 
+    Rack::MiniProfiler.authorize_request
+  end
+end
+````
+
+
 Using Builder:
 
 ```ruby
@@ -56,9 +70,10 @@ In a Rails app, this can be done conveniently in an initializer such as config/i
 ## Available Options
 
 * pre_authorize_cb - A lambda callback you can set to determine whether or not mini_profiler should be visible on a given request. Default in a Rails environment is only on in development mode. If in a Rack app, the default is always on.
-* post_authorize_cb - A lambda that is called after your request executed to ensure you really have access to the results. 
 * position - Can either be 'right' or 'left'. Default is 'left'.
 * skip_schema_queries - Whether or not you want to log the queries about the schema of your tables. Default is 'false', 'true' in rails development.
 
+## Special query strings 
 
+If you include the query string `pp=help` at the end of your request you will see the various option you have. You can use these options to extend or contract the amount of diagnostics rack-mini-profiler gathers. 
 

data/lib/mini_profiler/config.rb

@@ -12,9 +12,9 @@ module Rack
       @attributes
     end
 
-    attr_accessor :auto_inject, :base_url_path, :pre_authorize_cb, :post_authorize_cb, :position,
+    attr_accessor :auto_inject, :base_url_path, :pre_authorize_cb, :position,
         :backtrace_remove, :backtrace_filter, :skip_schema_queries, 
-        :storage, :user_provider, :storage_instance, :storage_options, :skip_paths
+        :storage, :user_provider, :storage_instance, :storage_options, :skip_paths, :authorization_mode
       
       def self.default
         new.instance_eval {
@@ -25,11 +25,11 @@ module Rack
           @pre_authorize_cb = lambda {|env| true} 
                                                   
           # called after rack chain, to ensure we are REALLY allowed to profile
-          @post_authorize_cb = nil
           @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
           self
         }
       end

data/lib/mini_profiler/profiler.rb

@@ -114,15 +114,26 @@ module Rack
       # 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
+    
+    def current
+      MiniProfiler.current
+    end
+
+    def current=(c)
+      MiniProfiler.current=c
+    end
 
+    # discard existing results, don't track this request
     def self.discard_results
       current[:discard] = true if current
     end
- 
+
+    # user has the mini profiler cookie, only used when config.authorization_mode == :whitelist
     def self.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 self.remove_profiling_cookie(headers)
       Rack::Utils.delete_cookie_header!(headers, '__profilin')
     end
@@ -131,14 +142,6 @@ module Rack
       Rack::Utils.set_cookie_header!(headers, '__profilin', 'stylin')
     end
 
-    def current
-      MiniProfiler.current
-    end
-
-    def current=(c)
-      MiniProfiler.current=c
-    end
-
     def config
       @config
     end
@@ -151,21 +154,32 @@ module Rack
       self.current['current_timer'] = current['page_struct']['Root']
     end
 
+    def self.authorize_request
+      Thread.current[:mp_authorized] = true
+    end
 
-		def call(env)
-			status = headers = body = nil
+    def self.deauthorize_request
+      Thread.current[:mp_authorized] = nil
+    end
 
+    def self.request_authorized?
+      Thread.current[:mp_authorized]
+    end
+
+		def call(env)
+      status = headers = body = nil
       path = env['PATH_INFO']
-			# only profile if authorized
-			if  !@config.pre_authorize_cb.call(env) ||
-          (@config.skip_paths && @config.skip_paths.any?{ |p| path[0,p.length] == p}) ||
-          env["QUERY_STRING"] =~ /pp=skip/
 
+      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 = self.class.has_profiling_cookie?(env)
+    
+      if skip_it || (@config.authorization_mode == :whitelist && !has_profiling_cookie)
         status,headers,body = @app.call(env)
-        if @config.post_authorize_cb 
-          if @config.post_authorize_cb.call(env) 
-            self.class.set_profiling_cookie(headers)
-          end
+        if !skip_it && @config.authorization_mode == :whitelist && !has_profiling_cookie && MiniProfiler.request_authorized? 
+          self.class.set_profiling_cookie(headers) 
         end
         return [status,headers,body]
       end
@@ -174,10 +188,14 @@ module Rack
 			return serve_html(env) if env['PATH_INFO'].start_with? @config.base_url_path
 
       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
-      
+
       done_sampling = false
       quit_sampler = false
       backtraces = nil
@@ -212,15 +230,15 @@ module Rack
         end
       end
 
-      skip_it = current['discard']
-      if @config.post_authorize_cb && !@config.post_authorize_cb.call(env)
-        self.class.remove_profiling_cookie(headers)
+      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
+      # 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
@@ -287,7 +305,8 @@ module Rack
   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 calls
+  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)
 "
       #headers['Content-Length'] = body.length
@@ -383,7 +402,7 @@ module Rack
 
 		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'])
+			c['current_timer'].add_sql(query, elapsed_ms, c['page_struct'], c['skip-backtrace'], c['full-backtrace']) if (c && c['current_timer'])
 		end
 
 	end

data/lib/mini_profiler/request_timer_struct.rb

@@ -45,8 +45,8 @@ module Rack
         @children_duration += request_timer['DurationMilliseconds']
       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, skip_backtrace, full_backtrace)
         timer['ParentTimingId'] = self['Id']
         self['SqlTimings'].push(timer)
         self['HasSqlTimings'] = true

data/lib/mini_profiler/sql_timer_struct.rb

@@ -5,7 +5,7 @@ module Rack
 
     # Timing system for a SQL query
     class SqlTimerStruct < TimerStruct
-      def initialize(query, duration_ms, page, skip_backtrace = false)
+      def initialize(query, duration_ms, page, skip_backtrace = false, full_backtrace = false)
 
         stack_trace = nil 
         unless skip_backtrace 
@@ -13,8 +13,8 @@ module Rack
           stack_trace = ""
            # Clean up the stack trace if there are options to do so
           Kernel.caller.each do |ln|
-            ln.gsub!(Rack::MiniProfiler.config.backtrace_remove, '') if Rack::MiniProfiler.config.backtrace_remove
-            if Rack::MiniProfiler.config.backtrace_filter.nil? or ln =~ Rack::MiniProfiler.config.backtrace_filter
+            ln.gsub!(Rack::MiniProfiler.config.backtrace_remove, '') if Rack::MiniProfiler.config.backtrace_remove and !full_backtrace
+            if full_backtrace or Rack::MiniProfiler.config.backtrace_filter.nil? or ln =~ Rack::MiniProfiler.config.backtrace_filter
               stack_trace << ln << "\n" 
             end
           end

data/lib/mini_profiler_rails/railtie.rb

@@ -6,8 +6,7 @@ module MiniProfilerRails
 
       # By default, only show the MiniProfiler in development mode, in production allow profiling if post_authorize_cb is set
       c.pre_authorize_cb = lambda { |env|
-        Rails.env.development? ||  
-        (Rack::MiniProfiler.config.post_authorize_cb && Rack::MiniProfiler.has_profiling_cookie?(env))
+        Rails.env.development? || Rails.env.production?  
       }
 
       if Rails.env.development?
@@ -16,6 +15,10 @@ module MiniProfilerRails
         c.skip_schema_queries = true
       end
 
+      if Rails.env.production? 
+        c.authorization_mode = :whitelist
+      end
+
       # The file store is just so much less flaky
       tmp = Rails.root.to_s + "/tmp/miniprofiler"
       Dir::mkdir(tmp) unless File.exists?(tmp)
@@ -29,7 +32,7 @@ module MiniProfilerRails
       c.skip_schema_queries =  Rails.env != 'production'
 
       # Install the Middleware
-      app.middleware.insert_before 'Rack::Lock', 'Rack::MiniProfiler'
+      app.middleware.insert(0, Rack::MiniProfiler)
 
       # Attach to various Rails methods
       ::Rack::MiniProfiler.profile_method(ActionController::Base, :process) {|action| "Executing action: #{action}"}

data/rack-mini-profiler.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name = "rack-mini-profiler"
-	s.version = "0.1.2"
+	s.version = "0.1.3"
 	s.summary = "Profiles loading speed for rack applications."
 	s.authors = ["Aleks Totic","Sam Saffron", "Robin Ward"]
 	s.date = "2012-04-02"
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
 	].concat( Dir.glob('lib/**/*').reject {|f| File.directory?(f) || f =~ /~$/ } )
 	s.extra_rdoc_files = [
 		"README.md",
-    "CHANGELOG.md"
+    "CHANGELOG"
 	]
 	s.add_runtime_dependency 'rack', '>= 1.1.3' 
   if RUBY_VERSION < "1.9"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-mini-profiler
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -84,7 +84,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
-- CHANGELOG.md
+- CHANGELOG
 files:
 - rack-mini-profiler.gemspec
 - lib/mini_profiler/sql_timer_struct.rb
@@ -115,7 +115,7 @@ files:
 - lib/mini_profiler_rails/railtie.rb
 - lib/patches/sql_patches.rb
 - README.md
-- CHANGELOG.md
+- CHANGELOG
 homepage: http://miniprofiler.com
 licenses: []
 post_install_message: 
@@ -130,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 876564877
+      hash: 809318397
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 876564877
+      hash: 809318397
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24