rack-mini-profiler 2.0.0 → 2.1.0

data/lib/mini_profiler/storage/abstract_store.rb

@@ -41,6 +41,78 @@ module Rack
         raise NotImplementedError.new("allowed_tokens is not implemented")
       end
 
+      def should_take_snapshot?(period)
+        raise NotImplementedError.new("should_take_snapshot? is not implemented")
+      end
+
+      def push_snapshot(page_struct, config)
+        raise NotImplementedError.new("push_snapshot is not implemented")
+      end
+
+      def fetch_snapshots(batch_size: 200, &blk)
+        raise NotImplementedError.new("fetch_snapshots is not implemented")
+      end
+
+      def snapshot_groups_overview
+        groups = {}
+        fetch_snapshots do |batch|
+          batch.each do |snapshot|
+            group_name = default_snapshot_grouping(snapshot)
+            if !groups[group_name] || groups[group_name] < snapshot.duration_ms
+              groups[group_name] = snapshot.duration_ms
+            end
+          end
+        end
+        groups = groups.to_a
+        groups.sort_by! { |name, score| score }
+        groups.reverse!
+        groups.map! do |name, score|
+          { name: name, worst_score: score }
+        end
+        groups
+      end
+
+      def find_snapshots_group(group_name)
+        data = []
+        fetch_snapshots do |batch|
+          batch.each do |snapshot|
+            snapshot_group_name = default_snapshot_grouping(snapshot)
+            if group_name == snapshot_group_name
+              data << {
+                id: snapshot[:id],
+                duration: snapshot.duration_ms,
+                timestamp: snapshot[:started_at]
+              }
+            end
+          end
+        end
+        data.sort_by! { |s| s[:duration] }
+        data.reverse!
+        data
+      end
+
+      def load_snapshot(id)
+        raise NotImplementedError.new("load_snapshot is not implemented")
+      end
+
+      private
+
+      def default_snapshot_grouping(snapshot)
+        group_name = rails_route_from_path(snapshot[:request_path], snapshot[:request_method])
+        group_name ||= snapshot[:request_path]
+        "#{snapshot[:request_method]} #{group_name}"
+      end
+
+      def rails_route_from_path(path, method)
+        if defined?(Rails) && defined?(ActionController::RoutingError)
+          hash = Rails.application.routes.recognize_path(path, method: method)
+          if hash && hash[:controller] && hash[:action]
+            "#{hash[:controller]}##{hash[:action]}"
+          end
+        end
+      rescue ActionController::RoutingError
+        nil
+      end
     end
   end
 end

data/lib/mini_profiler/storage/memory_store.rb

@@ -52,17 +52,21 @@ module Rack
         @expires_in_seconds = args.fetch(:expires_in) { EXPIRES_IN_SECONDS }
 
         @token1, @token2, @cycle_at = nil
+        @snapshots_cycle = 0
+        @snapshots = []
 
         initialize_locks
         initialize_cleanup_thread(args)
       end
 
       def initialize_locks
-        @token_lock         = Mutex.new
-        @timer_struct_lock  = Mutex.new
-        @user_view_lock     = Mutex.new
-        @timer_struct_cache = {}
-        @user_view_cache    = {}
+        @token_lock           = Mutex.new
+        @timer_struct_lock    = Mutex.new
+        @user_view_lock       = Mutex.new
+        @snapshots_cycle_lock = Mutex.new
+        @snapshots_lock       = Mutex.new
+        @timer_struct_cache   = {}
+        @user_view_cache      = {}
       end
 
       #FIXME: use weak ref, trouble it may be broken in 1.9 so need to use the 'ref' gem
@@ -135,6 +139,51 @@ module Rack
 
         end
       end
+
+      def should_take_snapshot?(period)
+        @snapshots_cycle_lock.synchronize do
+          @snapshots_cycle += 1
+          if @snapshots_cycle % period == 0
+            @snapshots_cycle = 0
+            true
+          else
+            false
+          end
+        end
+      end
+
+      def push_snapshot(page_struct, config)
+        @snapshots_lock.synchronize do
+          @snapshots << page_struct
+          @snapshots.sort_by! { |s| s.duration_ms }
+          @snapshots.reverse!
+          if @snapshots.size > config.snapshots_limit
+            @snapshots.slice!(-1)
+          end
+        end
+      end
+
+      def fetch_snapshots(batch_size: 200, &blk)
+        @snapshots_lock.synchronize do
+          @snapshots.each_slice(batch_size) do |batch|
+            blk.call(batch)
+          end
+        end
+      end
+
+      def load_snapshot(id)
+        @snapshots_lock.synchronize do
+          @snapshots.find { |s| s[:id] == id }
+        end
+      end
+
+      private
+
+      # used in tests only
+      def wipe_snapshots_data
+        @snapshots_cycle = 0
+        @snapshots = []
+      end
     end
   end
 end

data/lib/mini_profiler/storage/redis_store.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'digest'
+
 module Rack
   class MiniProfiler
     class RedisStore < AbstractStore
@@ -33,7 +35,7 @@ module Rack
 
       def set_unviewed(user, id)
         key = user_key(user)
-        if redis.exists(prefixed_id(id))
+        if redis.call([:exists, prefixed_id(id)]) == 1
           expire_at = Process.clock_gettime(Process::CLOCK_MONOTONIC).to_i + redis.ttl(prefixed_id(id))
           redis.zadd(key, expire_at, id)
         end
@@ -44,7 +46,7 @@ module Rack
         key = user_key(user)
         redis.del(key)
         ids.each do |id|
-          if redis.exists(prefixed_id(id))
+          if redis.call([:exists, prefixed_id(id)]) == 1
             expire_at = Process.clock_gettime(Process::CLOCK_MONOTONIC).to_i + redis.ttl(prefixed_id(id))
             redis.zadd(key, expire_at, id)
           end
@@ -108,6 +110,106 @@ unviewed_ids: #{get_unviewed_ids(user)}
         [key1, key2].compact
       end
 
+      COUNTER_LUA = <<~LUA
+        if redis.call("INCR", KEYS[1]) % ARGV[1] == 0 then
+          redis.call("DEL", KEYS[1])
+          return 1
+        else
+          return 0
+        end
+      LUA
+
+      COUNTER_LUA_SHA = Digest::SHA1.hexdigest(COUNTER_LUA)
+
+      def should_take_snapshot?(period)
+        1 == cached_redis_eval(
+          COUNTER_LUA,
+          COUNTER_LUA_SHA,
+          reraise: false,
+          keys: [snapshot_counter_key()],
+          argv: [period]
+        )
+      end
+
+      def push_snapshot(page_struct, config)
+        zset_key = snapshot_zset_key()
+        hash_key = snapshot_hash_key()
+
+        id = page_struct[:id]
+        score = page_struct.duration_ms
+        limit = config.snapshots_limit
+        bytes = Marshal.dump(page_struct)
+
+        lua = <<~LUA
+          local zset_key = KEYS[1]
+          local hash_key = KEYS[2]
+          local id = ARGV[1]
+          local score = tonumber(ARGV[2])
+          local bytes = ARGV[3]
+          local limit = tonumber(ARGV[4])
+          redis.call("ZADD", zset_key, score, id)
+          redis.call("HSET", hash_key, id, bytes)
+          if redis.call("ZCARD", zset_key) > limit then
+            local lowest_snapshot_id = redis.call("ZRANGE", zset_key, 0, 0)[1]
+            redis.call("ZREM", zset_key, lowest_snapshot_id)
+            redis.call("HDEL", hash_key, lowest_snapshot_id)
+          end
+        LUA
+        redis.eval(
+          lua,
+          keys: [zset_key, hash_key],
+          argv: [id, score, bytes, limit]
+        )
+      end
+
+      def fetch_snapshots(batch_size: 200, &blk)
+        zset_key = snapshot_zset_key()
+        hash_key = snapshot_hash_key()
+        iteration = 0
+        corrupt_snapshots = []
+        while true
+          ids = redis.zrange(
+            zset_key,
+            batch_size * iteration,
+            batch_size * iteration + batch_size - 1
+          )
+          break if ids.size == 0
+          batch = redis.mapped_hmget(hash_key, *ids).to_a
+          batch.map! do |id, bytes|
+            begin
+              Marshal.load(bytes)
+            rescue
+              corrupt_snapshots << id
+              nil
+            end
+          end
+          batch.compact!
+          blk.call(batch) if batch.size != 0
+          break if ids.size < batch_size
+          iteration += 1
+        end
+        if corrupt_snapshots.size > 0
+          redis.pipelined do
+            redis.zrem(zset_key, corrupt_snapshots)
+            redis.hdel(hash_key, corrupt_snapshots)
+          end
+        end
+      end
+
+      def load_snapshot(id)
+        hash_key = snapshot_hash_key()
+        bytes = redis.hget(hash_key, id)
+        begin
+          Marshal.load(bytes)
+        rescue
+          redis.pipelined do
+            redis.zrem(snapshot_zset_key(), id)
+            redis.hdel(hash_key, id)
+          end
+          nil
+        end
+      end
+
       private
 
       def user_key(user)
@@ -125,6 +227,38 @@ unviewed_ids: #{get_unviewed_ids(user)}
         end
       end
 
+      def snapshot_counter_key
+        @snapshot_counter_key ||= "#{@prefix}-mini-profiler-snapshots-counter"
+      end
+
+      def snapshot_zset_key
+        @snapshot_zset_key ||= "#{@prefix}-mini-profiler-snapshots-zset"
+      end
+
+      def snapshot_hash_key
+        @snapshot_hash_key ||= "#{@prefix}-mini-profiler-snapshots-hash"
+      end
+
+      def cached_redis_eval(script, script_sha, reraise: true, argv: [], keys: [])
+        begin
+          redis.evalsha(script_sha, argv: argv, keys: keys)
+        rescue ::Redis::CommandError => e
+          if e.message.start_with?('NOSCRIPT')
+            redis.eval(script, argv: argv, keys: keys)
+          else
+            raise e if reraise
+          end
+        end
+      end
+
+      # only used in tests
+      def wipe_snapshots_data
+        redis.pipelined do
+          redis.del(snapshot_counter_key())
+          redis.del(snapshot_zset_key())
+          redis.del(snapshot_hash_key())
+        end
+      end
     end
   end
 end

data/lib/mini_profiler/timer_struct/page.rb

@@ -39,8 +39,11 @@ module Rack
             executed_scalars: 0,
             executed_non_queries: 0,
             custom_timing_names: [],
-            custom_timing_stats: {}
+            custom_timing_stats: {},
+            custom_fields: {}
           )
+          self[:request_method] = env['REQUEST_METHOD']
+          self[:request_path] = env['PATH_INFO']
           name = "#{env['REQUEST_METHOD']} http://#{env['SERVER_NAME']}:#{env['SERVER_PORT']}#{env['SCRIPT_NAME']}#{env['PATH_INFO']}"
           self[:root] = TimerStruct::Request.createRoot(name, self)
         end

data/lib/mini_profiler/version.rb

@@ -2,6 +2,6 @@
 
 module Rack
   class MiniProfiler
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

data/lib/mini_profiler_rails/railtie.rb

@@ -30,6 +30,8 @@ module Rack::MiniProfilerRails
 
     if serves_static_assets?(app)
       c.skip_paths << app.config.assets.prefix
+      wp_assets_path = get_webpacker_assets_path()
+      c.skip_paths << wp_assets_path if wp_assets_path
     end
 
     unless Rails.env.development? || Rails.env.test?
@@ -116,6 +118,17 @@ module Rack::MiniProfilerRails
     @already_initialized = true
   end
 
+  def self.create_engine
+    return if defined?(Rack::MiniProfilerRails::Engine)
+    klass = Class.new(::Rails::Engine) do
+      engine_name 'rack-mini-profiler'
+      config.assets.paths << File.expand_path('../../html', __FILE__)
+      config.assets.precompile << 'rack-mini-profiler.js'
+      config.assets.precompile << 'rack-mini-profiler.css'
+    end
+    Rack::MiniProfilerRails.const_set("Engine", klass)
+  end
+
   def self.subscribe(event, &blk)
     if ActiveSupport::Notifications.respond_to?(:monotonic_subscribe)
       ActiveSupport::Notifications.monotonic_subscribe(event) { |*args| blk.call(*args) }

data/lib/mini_profiler_rails/railtie_methods.rb

@@ -51,5 +51,11 @@ module Rack::MiniProfilerRailsMethods
     child[start] + child[duration] <= node[start] + node[duration]
   end
 
+  def get_webpacker_assets_path
+    if defined?(Webpacker) && Webpacker.config.config_path.exist?
+      Webpacker.config.public_output_path.to_s.gsub(Webpacker.config.public_path.to_s, "")
+    end
+  end
+
   extend self
 end

data/lib/patches/net_patches.rb

@@ -1,13 +1,26 @@
 # frozen_string_literal: true
 
 if (defined?(Net) && defined?(Net::HTTP))
-  module NetHTTPWithMiniProfiler
-    def request(request, *args, &block)
-      Rack::MiniProfiler.step("Net::HTTP #{request.method} #{request.path}") do
-        super
+
+  if defined?(Rack::MINI_PROFILER_PREPEND_NET_HTTP_PATCH)
+    module NetHTTPWithMiniProfiler
+      def request(request, *args, &block)
+        Rack::MiniProfiler.step("Net::HTTP #{request.method} #{request.path}") do
+          super
+        end
+      end
+    end
+    Net::HTTP.prepend(NetHTTPWithMiniProfiler)
+  else
+    Net::HTTP.class_eval do
+      def request_with_mini_profiler(*args, &block)
+        request = args[0]
+        Rack::MiniProfiler.step("Net::HTTP #{request.method} #{request.path}") do
+          request_without_mini_profiler(*args, &block)
+        end
       end
+      alias request_without_mini_profiler request
+      alias request request_with_mini_profiler
     end
   end
-
-  Net::HTTP.prepend(NetHTTPWithMiniProfiler)
 end

data/lib/prepend_net_http_patch.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rack
+  MINI_PROFILER_PREPEND_NET_HTTP_PATCH = true
+end

data/rack-mini-profiler.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
     "CHANGELOG.md"
   ]
   s.add_runtime_dependency 'rack', '>= 1.2.0'
-  s.required_ruby_version = '>= 2.3.0'
+  s.required_ruby_version = '>= 2.4.0'
 
   s.metadata = {
     'source_code_uri' => 'https://github.com/MiniProfiler/rack-mini-profiler',
@@ -30,7 +30,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake', '< 11'
   s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'activerecord', '~> 3.0'
   s.add_development_dependency 'dalli'
   s.add_development_dependency 'rspec', '~> 3.6.0'
   s.add_development_dependency 'redis'
@@ -40,6 +39,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'mini_racer'
   s.add_development_dependency 'nokogiri'
   s.add_development_dependency 'rubocop-discourse'
+  s.add_development_dependency 'listen'
+  s.add_development_dependency 'webpacker', '~> 5.1'
+  s.add_development_dependency 'rails', '~> 5.1'
 
   s.require_paths = ["lib"]
 end