rack-mini-profiler 0.10.6 → 2.3.0

data/lib/mini_profiler/asset_version.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module Rack
   class MiniProfiler
-    ASSET_VERSION = '812af6927f7534f73488ece21dc89b62'.freeze
+    ASSET_VERSION = '10da952c710f6abd9f1bd50fe50ed714'
   end
-end
+end

data/lib/mini_profiler/client_settings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rack
   class MiniProfiler
     class ClientSettings
@@ -11,18 +13,19 @@ module Rack
       attr_accessor :disable_profiling
       attr_accessor :backtrace_level
 
-
       def initialize(env, store, start)
-        request = ::Rack::Request.new(env)
-        @cookie = request.cookies[COOKIE_NAME]
+        @request = ::Rack::Request.new(env)
+        @cookie = @request.cookies[COOKIE_NAME]
         @store = store
         @start = start
+        @backtrace_level = nil
+        @orig_disable_profiling = @disable_profiling = nil
 
         @allowed_tokens, @orig_auth_tokens = nil
 
         if @cookie
-          @cookie.split(",").map{|pair| pair.split("=")}.each do |k,v|
-            @orig_disable_profiling = @disable_profiling = (v=='t') if k == "dp"
+          @cookie.split(",").map { |pair| pair.split("=") }.each do |k, v|
+            @orig_disable_profiling = @disable_profiling = (v == 't') if k == "dp"
             @backtrace_level = v.to_i if k == "bt"
             @orig_auth_tokens = v.to_s.split("|") if k == "a"
           end
@@ -37,12 +40,12 @@ module Rack
       end
 
       def handle_cookie(result)
-        status,headers,_body = result
+        status, headers, _body = result
 
         if (MiniProfiler.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.to_i >= 200 && status.to_i < 300 && ((Time.now - @start) > 0.1)
+          if status.to_i >= 200 && status.to_i < 300 && ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - @start) > 0.1)
             discard_cookie!(headers)
           end
         else
@@ -66,36 +69,44 @@ module Rack
             @cookie.nil? ||
             tokens_changed
 
-          settings = {"p" =>  "t" }
+          settings = { "p" => "t" }
           settings["dp"] = "t"                  if @disable_profiling
           settings["bt"] = @backtrace_level     if @backtrace_level
           settings["a"] = @allowed_tokens.join("|") if @allowed_tokens && MiniProfiler.request_authorized?
-
-          settings_string = settings.map{|k,v| "#{k}=#{v}"}.join(",")
-          Rack::Utils.set_cookie_header!(headers, COOKIE_NAME, :value => settings_string, :path => '/')
+          settings_string = settings.map { |k, v| "#{k}=#{v}" }.join(",")
+          cookie = { value: settings_string, path: '/', httponly: true }
+          cookie[:secure] = true if @request.ssl?
+          cookie[:same_site] = 'Lax'
+          Rack::Utils.set_cookie_header!(headers, COOKIE_NAME, cookie)
         end
       end
 
       def discard_cookie!(headers)
         if @cookie
-          Rack::Utils.delete_cookie_header!(headers, COOKIE_NAME, :path => '/')
+          Rack::Utils.delete_cookie_header!(headers, COOKIE_NAME, path: '/')
         end
       end
 
       def has_valid_cookie?
         valid_cookie = !@cookie.nil?
 
-        if (MiniProfiler.config.authorization_mode == :whitelist)
-          @allowed_tokens ||= @store.allowed_tokens
+        if (MiniProfiler.config.authorization_mode == :whitelist) && valid_cookie
+          begin
+            @allowed_tokens ||= @store.allowed_tokens
+          rescue => e
+            if MiniProfiler.config.storage_failure != nil
+              MiniProfiler.config.storage_failure.call(e)
+            end
+          end
 
-          valid_cookie = (Array === @orig_auth_tokens) &&
+          valid_cookie = @allowed_tokens &&
+            (Array === @orig_auth_tokens) &&
             ((@allowed_tokens & @orig_auth_tokens).length > 0)
         end
 
         valid_cookie
       end
 
-
       def disable_profiling?
         @disable_profiling
       end

data/lib/mini_profiler/config.rb

@@ -1,45 +1,30 @@
+# frozen_string_literal: true
+
 module Rack
   class MiniProfiler
     class Config
+      def self.attr_accessor(*vars)
+        @attributes ||= []
+        @attributes.concat vars
+        super(*vars)
+      end
 
-    def self.attr_accessor(*vars)
-      @attributes ||= []
-      @attributes.concat vars
-      super(*vars)
-    end
-
-    def self.attributes
-      @attributes
-    end
-
-    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, :pre_authorize_cb, :skip_paths,
-      :skip_schema_queries, :storage, :storage_failure, :storage_instance,
-      :storage_options, :user_provider
-    attr_accessor :skip_sql_param_names, :suppress_encoding, :max_sql_param_length
-
-    # ui accessors
-    attr_accessor :collapse_results, :max_traces_to_show, :position, :vertical_position, :horizontal_position,
-      :show_children, :show_controls, :show_trivial, :start_hidden,
-      :toggle_shortcut, :html_container
-
-    # Deprecated options
-    attr_accessor :use_existing_jquery
+      def self.attributes
+        @attributes
+      end
 
       def self.default
         new.instance_eval {
           @auto_inject      = true # automatically inject on every html page
-          @base_url_path    = "/mini-profiler-resources/"
+          @base_url_path    = "/mini-profiler-resources/".dup
           @disable_caching  = true
           # called prior to rack chain, to ensure we are allowed to profile
-          @pre_authorize_cb = lambda {|env| true}
+          @pre_authorize_cb = lambda { |env| true }
 
           # called after rack chain, to ensure we are REALLY allowed to profile
           @skip_schema_queries    = false
           @storage                = MiniProfiler::MemoryStore
-          @user_provider          = Proc.new{|env| Rack::Request.new(env).ip}
+          @user_provider          = Proc.new { |env| Rack::Request.new(env).ip }
           @authorization_mode     = :allow_all
           @backtrace_threshold_ms = 0
           @flamegraph_sample_rate = 0.5
@@ -49,44 +34,86 @@ module Rack
             end
           end
           @enabled = true
-          @disable_env_dump = false
           @max_sql_param_length = 0 # disable sql parameter collection by default
           @skip_sql_param_names = /password/ # skips parameters with the name password by default
+          @enable_advanced_debugging_tools = false
+          @snapshot_every_n_requests = -1
+          @snapshots_limit = 1000
 
           # ui parameters
-          @autorized          = true
-          @collapse_results   = true
-          @max_traces_to_show = 20
-          @show_children      = false
-          @show_controls      = false
-          @show_trivial       = false
-          @start_hidden       = false
-          @toggle_shortcut    = 'Alt+P'
-          @html_container     = 'body'
+          @autorized            = true
+          @collapse_results     = true
+          @max_traces_to_show   = 20
+          @show_children        = false
+          @show_controls        = false
+          @show_trivial         = false
+          @show_total_sql_count = false
+          @start_hidden         = false
+          @toggle_shortcut      = 'alt+p'
+          @html_container       = 'body'
+          @position             = "top-left"
+          @snapshot_hidden_custom_fields = []
+          @snapshots_transport_destination_url = nil
+          @snapshots_transport_auth_key = nil
+          @snapshots_redact_sql_queries = true
+          @snapshots_transport_gzip_requests = false
 
           self
         }
       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, :pre_authorize_cb, :skip_paths,
+        :skip_schema_queries, :storage, :storage_failure, :storage_instance,
+        :storage_options, :user_provider, :enable_advanced_debugging_tools,
+        :skip_sql_param_names, :suppress_encoding, :max_sql_param_length
+
+      # ui accessors
+      attr_accessor :collapse_results, :max_traces_to_show, :position,
+        :show_children, :show_controls, :show_trivial, :show_total_sql_count,
+        :start_hidden, :toggle_shortcut, :html_container
+
+      # snapshot related config
+      attr_accessor :snapshot_every_n_requests, :snapshots_limit,
+        :snapshot_hidden_custom_fields, :snapshots_transport_destination_url,
+        :snapshots_transport_auth_key, :snapshots_redact_sql_queries,
+        :snapshots_transport_gzip_requests
+
+      # Deprecated options
+      attr_accessor :use_existing_jquery
+
+      attr_reader :assets_url
+
+      def assets_url=(lmbda)
+        if defined?(Rack::MiniProfilerRails)
+          Rack::MiniProfilerRails.create_engine
+        end
+        @assets_url = lmbda
+      end
+
+      def vertical_position
+        position.include?('bottom') ? 'bottom' : 'top'
+      end
+
+      def horizontal_position
+        position.include?('right') ? 'right' : 'left'
+      end
+
       def merge!(config)
         if config
           if Hash === config
-            config.each{|k,v| instance_variable_set "@#{k}",v}
+            config.each { |k, v| instance_variable_set "@#{k}", v }
           else
-            self.class.attributes.each{ |k|
+            self.class.attributes.each { |k|
               v = config.send k
               instance_variable_set "@#{k}", v if v
             }
           end
         end
-        set_positions!
       end
 
-      def set_positions!
-        position = (self.position && self.position.match("-")) ? self.position.split("-") : ["top", "left"]
-        self.vertical_position = position.first
-        self.horizontal_position = position.last
-      end
     end
   end
 end

data/lib/mini_profiler/context.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 class Rack::MiniProfiler::Context
-  attr_accessor :inject_js,:current_timer,:page_struct,:skip_backtrace,
-                :full_backtrace,:discard, :mpt_init, :measure
+  attr_accessor :inject_js, :current_timer, :page_struct, :skip_backtrace,
+                :full_backtrace, :discard, :mpt_init, :measure
 
   def initialize(opts = {})
     opts["measure"] = true unless opts.key? "measure"
-    opts.each do |k,v|
+    opts.each do |k, v|
       self.instance_variable_set('@' + k, v)
     end
   end

data/lib/mini_profiler/gc_profiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Rack::MiniProfiler::GCProfiler
 
   def initialize
@@ -28,7 +30,7 @@ class Rack::MiniProfiler::GCProfiler
       end
     end
 
-    result = {:stats => stats, :ids => ids}
+    result = { stats: stats, ids: ids }
     @ignore << result.__id__
 
     result
@@ -36,10 +38,10 @@ class Rack::MiniProfiler::GCProfiler
 
   def diff_object_stats(before, after)
     diff = {}.compare_by_identity
-    after.each do |k,v|
+    after.each do |k, v|
       diff[k] = v - before[k]
     end
-    before.each do |k,v|
+    before.each do |k, v|
       diff[k] = 0 - v unless after.has_key?(k)
     end
 
@@ -48,7 +50,7 @@ class Rack::MiniProfiler::GCProfiler
 
   def analyze_strings(ids_before, ids_after)
     result = {}
-    ids_after.each do |id,_|
+    ids_after.each do |id, _|
       obj = ObjectSpace._id2ref(id)
       if String === obj && !ids_before.include?(obj.object_id)
         result[obj] ||= 0
@@ -62,8 +64,8 @@ class Rack::MiniProfiler::GCProfiler
     new_objects = 0
     memory_allocated = 0
 
-    ids_after.each do |id,_|
-      if !ids_before.include?(id) && obj=ObjectSpace._id2ref(id)
+    ids_after.each do |id, _|
+      if !ids_before.include?(id) && obj = ObjectSpace._id2ref(id)
         # this is going to be version specific (may change in 2.1)
         size = ObjectSpace.memsize_of(obj)
         memory_allocated += size
@@ -78,15 +80,15 @@ class Rack::MiniProfiler::GCProfiler
     memory_allocated = 0
     objects = 0
 
-    ids_before.each do |id,_|
-      if obj=ObjectSpace._id2ref(id)
+    ids_before.each do |id, _|
+      if obj = ObjectSpace._id2ref(id)
         # this is going to be version specific (may change in 2.1)
         memory_allocated += ObjectSpace.memsize_of(obj)
         objects += 1
       end
     end
 
-    [objects,memory_allocated]
+    [objects, memory_allocated]
   end
 
   def profile_gc(app, env)
@@ -105,7 +107,7 @@ class Rack::MiniProfiler::GCProfiler
     # 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])
+    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])
@@ -120,7 +122,7 @@ Memory allocated outside heap (bytes): #{memory_before}
 
 GC Stats:
 --------
-#{stat.map{|k,v| "#{k} : #{v}" }.sort!.join("\n")}
+#{stat.map { |k, v| "#{k} : #{v}" }.sort!.join("\n")}
 
 New bytes allocated outside of Ruby heaps: #{memory_allocated}
 New objects: #{new_objects}
@@ -129,7 +131,7 @@ New objects: #{new_objects}
     body << "
 ObjectSpace delta caused by request:
 -----------------------------------\n"
-    diff.to_a.delete_if{|_k, v| v == 0}.sort_by! { |_k, v| v }.reverse_each do |k,v|
+    diff.to_a.delete_if { |_k, v| v == 0 }.sort_by! { |_k, v| v }.reverse_each do |k, v|
       body << "#{k} : #{v}\n"
     end
 
@@ -137,20 +139,19 @@ ObjectSpace delta caused by request:
 ObjectSpace stats:
 -----------------\n"
 
-    stat_after[:stats].to_a.sort_by!{ |_k, v| v }.reverse_each do |k,v|
+    stat_after[:stats].to_a.sort_by! { |_k, v| v }.reverse_each do |k, v|
       body << "#{k} : #{v}\n"
     end
 
-
     body << "\n
 String stats:
 ------------\n"
 
-    string_analysis.to_a.sort_by!{ |_k, v| -v }.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
 
-    return [200, {'Content-Type' => 'text/plain'}, body]
+    [200, { 'Content-Type' => 'text/plain' }, body]
   ensure
     prev_gc_state ? GC.disable : GC.enable
   end