rack-mini-profiler 0.9.7 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2417d22f7d7896ced32bc242d3e7f0b43eb73f6f
-  data.tar.gz: 0a5d429ac232a90772dd17de9650fb12f6eb355c
+  metadata.gz: 661dc965f1499d7a00baa35f5699e91e1552ff68
+  data.tar.gz: 7bbccf4b17154aab14f7bd2012afcf2dac0efe25
 SHA512:
-  metadata.gz: 1b33304bb3ccb9e659fc5a274d939cb2e8455a9a5427bd3fa46a98ff8d88d5b238ebfe3a46f6b2cee9730f88a1ebe585bae41ac716f988e5feecc6ac17231d48
-  data.tar.gz: 8799e05e0fcea21ab023aa7e4594cb75e21c7315fa0c25478d275a3df815b37731cb490d3e64756d0bc2d206d00292b9c395a368349715c22cd7dbe328f2093b
+  metadata.gz: 903fe47823489fae4a2b18aff1cddca204130c1e41b2132c5db951007a5c1fe85b7b110f3264b8abc2f22c07d438071b81c93251bc31cbe26db725b868ca0a2a
+  data.tar.gz: 400bb2bf85475461de90d238eb95cbac925710f758f576c7371cb7b25ef0998bf39d637835520b42dd96fbbeb7cd53f36fe531f83e9e9c8c1cf36022795fcb8c

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 0.9.8 - 2015-11-27 (Sam Saffron)
+
+- [FEATURE] disable_env_dump config setting (@mathias)
+- [FEATURE] set X-MiniProfiler-Ids for all 2XX reqs (@tymagu2)
+- [FEATURE] add support for NoBrainer (rethinkdb) profiling (@niv)
+- [FEATURE] add oracle enhanced adapter profiling (@rrooding)
+- [FEATURE] pp=profile-memory can now parse query params (@dgynn)
+
+
 ## 0.9.7 - 2015-08-03 (Sam Saffron)
 
 - [FEATURE] remove confusing pp=profile-gc-time (Nate Berkopec)

data/README.md

@@ -6,7 +6,7 @@ Middleware that displays speed badge for every html page. Designed to work both
 
 #### Features
 
-* database profiling. Currently supports Mysql2, Postgres, and Mongoid3 (with fallback support to ActiveRecord)
+* database profiling. Currently supports Mysql2, Postgres, Oracle (oracle_enhanced ~> 1.5.0) and Mongoid3 (with fallback support to ActiveRecord)
 
 #### Learn more
 
@@ -89,20 +89,21 @@ To generate [flamegraphs](http://samsaffron.com/archive/2013/03/19/flame-graphs-
 * add the [**flamegraph**](https://github.com/SamSaffron/flamegraph) gem to your Gemfile
 * visit a page in your app with `?pp=flamegraph`
 
-Flamegraph generation is supported in MRI 2.0 and 2.1 only.
+Flamegraph generation is supported in MRI 2.0, 2.1, and 2.2 only.
 
 
-## Access control in production
+## Access control in non-development environments
 
 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.
 
 ```ruby
-# A hook in your ApplicationController
-def authorize
-  if current_user.is_admin?
-    Rack::MiniProfiler.authorize_request
+  # inside your ApplicationController
+
+  before_action do
+    if current_user && current_user.is_admin?
+      Rack::MiniProfiler.authorize_request
+    end
   end
-end
 ```
 
 ## Configuration
@@ -189,6 +190,7 @@ The available configuration options are:
 * start_hidden (default false) - Whether or not you want the mini_profiler to be visible when loading a page
 * backtrace_threshold_ms (default zero) - Minimum SQL query elapsed time before a backtrace is recorded. Backtrace recording can take a couple of milliseconds on rubies earlier than 2.0, impacting performance for very small queries.
 * flamegraph_sample_rate (default 0.5ms) - How often fast_stack should get stack trace info to generate flamegraphs
+* disable_env_dump (default false) - When enabled, disables the `?pp=env` which can be useful when you are concerned about not sending ENV vars out over HTTP.
 
 ### Custom middleware ordering (required if using `Rack::Deflate` with Rails)
 

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
 
     # Deprecated options
     attr_accessor :use_existing_jquery
@@ -44,6 +47,7 @@ module Rack
             end
           end
           @enabled = true
+          @disable_env_dump = false
           self
         }
       end

data/lib/mini_profiler/profiler.rb

@@ -203,8 +203,14 @@ module Rack
       end
 
       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 do
+        report = MemoryProfiler.report(options) do
           _,_,body = @app.call(env)
           body.close if body.respond_to? :close
         end
@@ -285,7 +291,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 >= 200 && status < 300 && ((Time.now - start) > 0.1)
           client_settings.discard_cookie!(headers)
         end
         skip_it = true
@@ -299,7 +305,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
@@ -330,7 +336,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
@@ -552,7 +558,7 @@ Append the following to your query string:
   #{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>
@@ -588,7 +594,11 @@ 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["action_controller.instance"]
+        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,

data/lib/mini_profiler/storage/file_store.rb

@@ -26,8 +26,14 @@ module Rack
         end
 
         private
-        def path(key)
-          @path + "/" + @prefix  + "_" + key
+        if RUBY_PLATFORM =~ /mswin(?!ce)|mingw|cygwin|bccwin/
+          def path(key)
+            @path + "/" + @prefix  + "_" + key.gsub(/:/, '_')
+          end
+        else
+          def path(key)
+            @path + "/" + @prefix  + "_" + key
+          end
         end
       end
 

data/lib/mini_profiler/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class MiniProfiler
-    VERSION = '0.9.7'
+    VERSION = '0.9.8'
   end
 end

data/lib/mini_profiler_rails/railtie.rb

@@ -24,8 +24,9 @@ module Rack::MiniProfilerRails
 
     c.skip_paths ||= []
 
+    c.skip_paths << app.config.assets.prefix if serves_static_assets?(app)
+
     if Rails.env.development?
-      c.skip_paths << app.config.assets.prefix if app.respond_to? :assets
       c.skip_schema_queries = true
     end
 
@@ -64,6 +65,16 @@ module Rack::MiniProfilerRails
     @already_initialized = true
   end
 
+  def self.serves_static_assets?(app)
+    return false if !app.respond_to?(:assets)
+    # Rails 4.2 deprecates serve_static_assets in favor of serve_static_files
+    if app.config.respond_to?(:serve_static_files)
+      app.config.serve_static_files
+    else
+      app.config.serve_static_assets
+    end
+  end
+
   class Railtie < ::Rails::Railtie
 
     initializer "rack_mini_profiler.configure_rails_initialization" do |app|

data/lib/patches/db/mongo.rb

@@ -0,0 +1,12 @@
+# Mongo/Mongoid 5 patches
+class Mongo::Server::Connection
+  def dispatch_with_timing(*args, &blk)
+    return dispatch_without_timing(*args, &blk) unless SqlPatches.should_measure?
+
+    result, _record = SqlPatches.record_sql(args[0][0].payload.inspect) do
+      dispatch_without_timing(*args, &blk)
+    end
+    return result
+  end
+  alias_method_chain :dispatch, :timing
+end

data/lib/patches/db/nobrainer.rb

@@ -0,0 +1,29 @@
+class Rack::MiniProfiler::NoBrainerProfiler
+
+  def on_query(env)
+    if SqlPatches.should_measure?
+      not_indexed = env[:criteria] && env[:criteria].where_present? &&
+                        !env[:criteria].where_indexed? &&
+                        !env[:criteria].model.try(:perf_warnings_disabled)
+
+      query = ""
+
+      # per-model/query database overrides
+      query << "[#{env[:options][:db]}] " if env[:options][:db]
+
+      # "read", "write" prefix
+      # query << "(#{NoBrainer::RQL.type_of(env[:query]).to_s}) "
+
+      query << "NOT USING INDEX: " if not_indexed
+      query << env[:query].inspect.gsub(/\n/, '').gsub(/ +/, ' ') + " "
+
+      if env[:exception]
+        query << "exception: #{env[:exception].class} #{env[:exception].message.split("\n").first} "
+      end
+
+      ::Rack::MiniProfiler.record_sql query.strip, env[:duration] * 1000.0
+    end
+  end
+
+  NoBrainer::Profiler.register self.new
+end

data/lib/patches/db/oracle_enhanced.rb

@@ -0,0 +1,70 @@
+class ActiveRecord::Result
+  alias_method :each_without_profiling, :each
+  def each(&blk)
+    return each_without_profiling(&blk) unless @miniprofiler_sql_id
+
+    start        = Time.now
+    result       = each_without_profiling(&blk)
+    elapsed_time = SqlPatches.elapsed_time(start)
+    @miniprofiler_sql_id.report_reader_duration(elapsed_time)
+
+    result
+  end
+end
+
+class ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter
+  SCHEMA_QUERY_TYPES = ["Sequence", "Primary Key", "Primary Key Trigger", nil].freeze
+
+  alias_method :execute_without_profiling, :execute
+  def execute(sql, name = nil)
+    mp_profile_sql(sql, name) { execute_without_profiling(sql, name) }
+  end
+
+  alias_method :exec_query_without_profiling, :exec_query
+  def exec_query(sql, name = 'SQL', binds = [])
+    mp_profile_sql(sql, name) { exec_query_without_profiling(sql, name, binds) }
+  end
+
+  alias_method :exec_insert_without_profiling, :exec_insert
+  def exec_insert(sql, name, binds, pk = nil, sequence_name = nil)
+    mp_profile_sql(sql, name) { exec_insert_without_profiling(sql, name, binds, pk, sequence_name) }
+  end
+
+  alias_method :exec_update_without_profiling, :exec_update
+  def exec_update(sql, name, binds)
+    mp_profile_sql(sql, name) { exec_update_without_profiling(sql, name, binds) }
+  end
+
+  # See oracle-enhanced/lib/active_record/connection_adapters/oracle_enhanced_database_statements.rb:183
+  # where the exec delete method is aliased in the same way. We just have to do it again here to make sure
+  # the new exec_delete alias is linked to our profiling-enabled version.
+  alias :exec_delete :exec_update
+
+  private
+
+  def mp_profile_sql(sql, name, &blk)
+    return yield unless mp_should_measure?(name)
+
+    start        = Time.now
+    result       = yield
+    elapsed_time = SqlPatches.elapsed_time(start)
+    record       = ::Rack::MiniProfiler.record_sql(sql, elapsed_time)
+
+    # Some queries return the row count as a Fixnum and will be frozen, don't save a record
+    # for those.
+    result.instance_variable_set("@miniprofiler_sql_id", record) if (result && !result.frozen?)
+
+    result
+  end
+
+  # Only measure when profiling is enabled
+  # When skip_schema_queries is set to true, it will ignore any query of the types
+  # in the schema_query_types array
+  def mp_should_measure?(name)
+    return false unless SqlPatches.should_measure?
+
+    !(Rack::MiniProfiler.config.skip_schema_queries && SCHEMA_QUERY_TYPES.include?(name))
+  end
+end
+
+SqlPatches.patched = true

data/lib/patches/sql_patches.rb

@@ -14,6 +14,12 @@ class SqlPatches
     false
   end
 
+  def self.correct_version?(required_version, klass)
+    Gem::Dependency.new('', required_version).match?('', klass::VERSION)
+  rescue NameError
+    false
+  end
+
   def self.module_exists?(name)
     eval(name + ".class").to_s.eql?('Module')
   rescue NameError
@@ -37,10 +43,13 @@ class SqlPatches
   end
 end
 
-require 'patches/db/mysql2'         if defined?(Mysql2::Client) && SqlPatches.class_exists?("Mysql2::Client")
-require 'patches/db/pg'             if defined?(PG::Result) && SqlPatches.class_exists?("PG::Result")
-require 'patches/db/moped'          if defined?(Moped::Node) && SqlPatches.class_exists?("Moped::Node")
-require 'patches/db/plucky'         if defined?(Plucky::Query) && SqlPatches.class_exists?("Plucky::Query")
-require 'patches/db/rsolr'          if defined?(RSolr::Connection) && SqlPatches.class_exists?("RSolr::Connection") && RSolr::VERSION[0] != "0"
-require 'patches/db/sequel'         if defined?(Sequel::Database) && !SqlPatches.patched? && SqlPatches.class_exists?("Sequel::Database")
-require 'patches/db/activerecord'   if defined?(ActiveRecord) &&!SqlPatches.patched? && SqlPatches.module_exists?("ActiveRecord")
+require 'patches/db/mysql2'           if defined?(Mysql2::Client) && SqlPatches.class_exists?("Mysql2::Client")
+require 'patches/db/pg'               if defined?(PG::Result) && SqlPatches.class_exists?("PG::Result")
+require 'patches/db/oracle_enhanced'  if defined?(ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter) && SqlPatches.class_exists?("ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter") && SqlPatches.correct_version?('~> 1.5.0', ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter)
+require 'patches/db/mongo'            if defined?(Mongo) &&!SqlPatches.patched? && SqlPatches.module_exists?("Mongo")
+require 'patches/db/moped'            if defined?(Moped::Node) && SqlPatches.class_exists?("Moped::Node")
+require 'patches/db/plucky'           if defined?(Plucky::Query) && SqlPatches.class_exists?("Plucky::Query")
+require 'patches/db/rsolr'            if defined?(RSolr::Connection) && SqlPatches.class_exists?("RSolr::Connection") && RSolr::VERSION[0] != "0"
+require 'patches/db/sequel'           if defined?(Sequel::Database) && !SqlPatches.patched? && SqlPatches.class_exists?("Sequel::Database")
+require 'patches/db/activerecord'     if defined?(ActiveRecord) &&!SqlPatches.patched? && SqlPatches.module_exists?("ActiveRecord")
+require 'patches/db/nobrainer'        if defined?(NoBrainer) && SqlPatches.module_exists?("NoBrainer")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-mini-profiler
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.8
 platform: ruby
 authors:
 - Sam Saffron
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-03 00:00:00.000000000 Z
+date: 2015-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -223,8 +223,11 @@ files:
 - lib/mini_profiler/version.rb
 - lib/mini_profiler_rails/railtie.rb
 - lib/patches/db/activerecord.rb
+- lib/patches/db/mongo.rb
 - lib/patches/db/moped.rb
 - lib/patches/db/mysql2.rb
+- lib/patches/db/nobrainer.rb
+- lib/patches/db/oracle_enhanced.rb
 - lib/patches/db/pg.rb
 - lib/patches/db/plucky.rb
 - lib/patches/db/rsolr.rb
@@ -253,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Profiles loading speed for rack applications.