rails_mini_profiler 0.4.0 → 0.7.1

data/app/views/rails_mini_profiler/profiled_requests/show/_trace_list_header.erb

@@ -0,0 +1,87 @@
+<div class="trace-list-header" data-controller="filters">
+  <div class="trace-list-filters">
+    <%= form_with url: profiled_request_url(@profiled_request.id), method: :get do |form| %>
+      <%= form.search_field :payload,
+                            value: params[:payload],
+                            placeholder: 'Search Traces...',
+                            class: 'search-field',
+                            data: { 'filters-target': 'filter' } %>
+    <% end %>
+    <div data-controller="dropdown">
+      <button data-action="click->dropdown#toggle click@window->dropdown#hide" data-dropdown-target="button" class="dropdown-toggle none" >
+        Type <%= inline_svg('filter.svg', class: 'table-filter-icon') %> </button>
+      <div data-controller="checklist" data-dropdown-target="menu" class="dropdown-container hidden">
+        <div class="dropdown-header">
+          Select Type...
+          <button class="clear-filters" data-action="checklist#checkNone">
+            Clear filter
+          </button>
+        </div>
+        <% trace_names = %w[process_action.action_controller sql.active_record instantiation.active_record render_template.action_view render_partial.action_view] %>
+        <% trace_names.each do |name| %>
+          <%= label_tag nil, class: "dropdown-entry" do %>
+            <%= check_box_tag 'name[]', name, params.fetch(:name, []).include?(name),
+                              class: "",
+                              data: { 'filters-target': "filter" } %>
+            <%= trace_display_name(name) %>
+          <% end %>
+        <% end %>
+        <button class="dropdown-footer" data-action="filters#apply">
+          Apply
+        </button>
+      </div>
+    </div>
+
+    <div data-controller="dropdown">
+      <button data-action="click->dropdown#toggle click@window->dropdown#hide" data-dropdown-target="button" class="dropdown-toggle none">
+        Duration <%= inline_svg('filter.svg', class: 'table-filter-icon') %> </button>
+      <div data-controller="checklist" data-dropdown-target="menu" class="dropdown-container hidden">
+        <div class="dropdown-header">
+          Select Duration...
+          <button class="clear-filters" data-action="checklist#checkNone filters#apply">
+            Clear filter
+          </button>
+        </div>
+        <% [100_00, 250_00, 500_00].each do |duration| %>
+          <%= label_tag nil, class: "dropdown-entry" do %>
+            <%= radio_button_tag 'duration', duration.to_s, params.fetch(:duration, []).include?(duration.to_s),
+                                 class: "",
+                                 data: { target: "filters.filter" } %>
+            <%= "> #{formatted_duration(duration)}ms" %>
+          <% end %>
+        <% end %>
+        <button class="dropdown-footer" data-action="filters#apply">
+          Apply
+        </button>
+      </div>
+    </div>
+
+    <div data-controller="dropdown">
+      <button data-action="click->dropdown#toggle click@window->dropdown#hide" data-dropdown-target="button" class="dropdown-toggle none">
+        Allocations <%= inline_svg('filter.svg', class: 'table-filter-icon') %> </button>
+      <div data-controller="checklist" data-dropdown-target="menu" class="dropdown-container hidden">
+        <div class="dropdown-header">
+          Select Allocation...
+          <button class="clear-filters" data-action="filters#apply">
+            Clear filter
+          </button>
+        </div>
+        <!-- https://twitter.com/nateberkopec/status/1442648442149367809-->
+        <% [10_000, 100_000, 1_000_000, 10_000_000].each do |allocations| %>
+          <%= label_tag nil, class: "dropdown-entry" do %>
+            <%= radio_button_tag 'allocations', allocations.to_s, params.fetch(:allocations, []).include?(allocations.to_s),
+                                 class: "",
+                                 data: { target: "filters.filter" } %>
+            <%= "> #{formatted_allocations(allocations)}" %>
+          <% end %>
+        <% end %>
+        <button class="dropdown-footer" data-action="filters#apply">
+          Apply
+        </button>
+      </div>
+    </div>
+  </div>
+  <%= link_to(profiled_request_url(@profiled_request.id)) do %>
+    <%= button_tag('Clear All', class: 'btn-red') %>
+  <% end %>
+</div>

data/app/views/rails_mini_profiler/profiled_requests/show/_trace_list_placeholder.erb

@@ -0,0 +1,12 @@
+<tr class="no-row">
+  <td colspan="100%">
+    <div class="placeholder">
+      <%= inline_svg('logo_variant.svg', class: 'placeholder-image') %>
+      <div class="placeholder-text">
+        <h2>No Traces found!</h2>
+        <p>Modify filters or reload this page</p>
+      </div>
+      <%= link_to('Clear Filters', profiled_request_url(@profiled_request.id), class: 'placeholder-link') %>
+    </div>
+  </td>
+</tr>

data/app/views/rails_mini_profiler/profiled_requests/show.html.erb

@@ -1,6 +1,8 @@
-<section class="request-details">
+<section class="page-header">
   <h1> <%= @profiled_request.request_path %> </h1>
+</section>
 
+<div class="profiled-request-details">
   <ul class="request-details-data">
     <li class="data-item">
       <small>Method</small>
@@ -18,23 +20,8 @@
       <small>Allocations</small>
       <span><%= @profiled_request.allocations %></span>
     </li>
-
   </ul>
-
-</section>
-
-<section class="request-details-actions">
-  <%= form_with id: 'trace-form', url: profiled_request_url(@profiled_request.id), method: :get do |form| %>
-    <%= form.search_field :search, id: 'trace-search', placeholder: 'Search Traces...', class: 'search-field' %>
-  <% end %>
   <%= @profiled_request.flamegraph_button %>
-</section>
+</div>
 
-<section>
-  <h2>Traces</h2>
-  <ol class="trace-list">
-    <% @traces.each do |trace| %>
-      <%= render "rails_mini_profiler/profiled_requests/shared/trace", trace: trace %>
-    <% end %>
-  </ol>
-</section>
+<%= render "rails_mini_profiler/profiled_requests/show/trace_list" %>

data/app/views/rails_mini_profiler/shared/_head.erb

@@ -3,7 +3,7 @@
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
 
-  <% if defined?(Webpacker::Engine) %>
+  <% if defined?(Webpacker::Engine) && RailsMiniProfiler.configuration.ui.webpacker_enabled  %>
     <%= javascript_pack_tag "rails-mini-profiler" %>
     <%= stylesheet_pack_tag 'rails-mini-profiler' %>
   <% else %>

data/lib/generators/rails_mini_profiler/templates/rails_mini_profiler.rb.erb

@@ -22,7 +22,9 @@ RailsMiniProfiler.configure do |config|
   # Configure the Rails Mini Profiler User Interface
   # config.ui.badge_enabled = true
   # config.ui.badge_position = 'top-left'
+  # config.ui.base_controller = ApplicationController
   # config.ui.page_size = 25
+  # config.ui.webpacker_enabled = true
 
   # Customize how users are detected
   config.user_provider = proc { |env| Rack::Request.new(env).ip }

data/lib/rails_mini_profiler/badge.rb

@@ -23,30 +23,39 @@ module RailsMiniProfiler
     #
     # @return [ResponseWrapper] The modified response
     def render
-      content_type = @original_response.headers['Content-Type']
-      return @original_response unless content_type =~ %r{text/html}
-
-      return @original_response unless @configuration.ui.badge_enabled
+      return @original_response unless render_badge?
 
-      modified_response = Rack::Response.new([], @original_response.status, @original_response.headers)
+      modified_response = ResponseWrapper.new([], @original_response.status, @original_response.headers)
       modified_response.write(modified_body)
       modified_response.finish
 
-      response = @original_response.response
-      response.close if response.respond_to?(:close)
+      @original_response.close if @original_response.respond_to?(:close)
 
-      ResponseWrapper.new(@original_response.status,
-                          @original_response.headers,
-                          modified_response)
+      modified_response
     end
 
     private
 
+    def render_badge?
+      content_type = @original_response.headers['Content-Type']
+      unless content_type =~ %r{text/html}
+        RailsMiniProfiler.logger.debug("badge not rendered, response has content type #{content_type}")
+        return false
+      end
+
+      unless @configuration.ui.badge_enabled
+        RailsMiniProfiler.logger.debug('badge not rendered, disabled in configuration')
+        return false
+      end
+
+      true
+    end
+
     # Modify the body of the original response
     #
     # @return String The modified body
     def modified_body
-      body = @original_response.response.body
+      body = @original_response.body
       index = body.rindex(%r{</body>}i) || body.rindex(%r{</html>}i)
       if index
         body.dup.insert(index, badge_content)
@@ -59,7 +68,7 @@ module RailsMiniProfiler
     #
     # @return String The badge HTML content to be injected
     def badge_content
-      html = IO.read(File.expand_path('../../app/views/rails_mini_profiler/badge.html.erb', __dir__))
+      html = File.read(File.expand_path('../../app/views/rails_mini_profiler/badge.html.erb', __dir__))
       @position = css_position
       template = ERB.new(html)
       template.result(binding)

data/lib/rails_mini_profiler/configuration/user_interface.rb

@@ -9,8 +9,12 @@ module RailsMiniProfiler
   # @!attribute badge_position
   #   @see Badge
   #   @return [String] the position of the interactive HTML badge
+  # @!attribute base_controller
+  #   @return [class] the controller the UI controllers should inherit from
   # @!attribute page_size
   #   @return [Integer] how many items to render per page in list views
+  # @!attribute webpacker_enabled
+  #   @return [Boolean] if webpacker assets should be used. Disable to fall back to the asset pipeline
   class UserInterface
     class << self
       # Construct a new UI configuration instance
@@ -31,7 +35,10 @@ module RailsMiniProfiler
 
     attr_accessor :badge_enabled,
                   :badge_position,
-                  :page_size
+                  :page_size,
+                  :webpacker_enabled
+
+    attr_writer :base_controller
 
     def initialize(**kwargs)
       defaults!
@@ -42,7 +49,30 @@ module RailsMiniProfiler
     def defaults!
       @badge_enabled = true
       @badge_position = 'top-left'
+      # We must not set base controller during when the app loads, aka during autoload time, as we are loading
+      # constants. Rather, we only load the base controller constants when any engine controllers are first initialized
+      # and call #base_controller
+      @base_controller = nil
       @page_size = 25
+      @webpacker_enabled = true
+    end
+
+    def base_controller
+      @base_controller ||= default_base_controller
+    end
+
+    def default_base_controller
+      app_controller_exists = class_exists?('::ApplicationController')
+      return ::ApplicationController if app_controller_exists && ::ApplicationController < ActionController::Base
+
+      ActionController::Base
+    end
+
+    def class_exists?(class_name)
+      klass = Module.const_get(class_name)
+      klass.is_a?(Class)
+    rescue NameError
+      false
     end
   end
 end

data/lib/rails_mini_profiler/configuration.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'rails_mini_profiler/configuration/storage'
+require 'rails_mini_profiler/configuration/user_interface'
+
 module RailsMiniProfiler
   # The main Rails Mini Profiler configuration object
   #
@@ -15,6 +18,8 @@ module RailsMiniProfiler
   #   @return [Array<String>] a list of regex patterns for paths to skip
   # @!attribute storage
   #   @return [Storage] the storage configuration
+  # @!attribute tracers
+  #   @return [Array<Symbol>] the list of enabled tracers
   # @!attribute ui
   #   @return [UserInterface] the ui configuration
   # @!attribute user_provider
@@ -27,6 +32,7 @@ module RailsMiniProfiler
                   :flamegraph_sample_rate,
                   :skip_paths,
                   :storage,
+                  :tracers,
                   :ui,
                   :user_provider
 
@@ -43,6 +49,7 @@ module RailsMiniProfiler
       @logger = RailsMiniProfiler::Logger.new(Rails.logger)
       @skip_paths = []
       @storage = Storage.new
+      @tracers = %i[controller instantiation sequel view rmp]
       @ui = UserInterface.new
       @user_provider = proc { |env| Rack::Request.new(env).ip }
     end

data/lib/rails_mini_profiler/engine.rb

@@ -11,14 +11,6 @@ module RailsMiniProfiler
       app.middleware.use(RailsMiniProfiler::Middleware)
     end
 
-    initializer 'rails_mini_profiler.assets.precompile', group: :all do |app|
-      app.config.assets.precompile += %w[
-        rails_mini_profiler.js
-        rails_mini_profiler/application.css
-        vendor/assets/images
-      ]
-    end
-
     config.generators do |g|
       g.test_framework :rspec
     end
@@ -26,5 +18,17 @@ module RailsMiniProfiler
     initializer 'rails_mini_profiler_add_static assets' do |app|
       app.middleware.insert_before(ActionDispatch::Static, ActionDispatch::Static, "#{root}/public")
     end
+
+    # If sprockets is not being used then there is no need to hook into asset compilation. Calling config.assets
+    # without Sprockets installed breaks compilation.
+    if defined?(Sprockets::Rails)
+      initializer 'rails_mini_profiler.assets.precompile', group: :all do |app|
+        app.config.assets.precompile += %w[
+          rails_mini_profiler.js
+          rails_mini_profiler/application.css
+          vendor/assets/images
+        ]
+      end
+    end
   end
 end

data/lib/rails_mini_profiler/flamegraph_guard.rb

@@ -11,17 +11,12 @@ module RailsMiniProfiler
     def record(&block)
       return block.call unless enabled?
 
-      sample_rate = @configuration.flamegraph_sample_rate
       if StackProf.running?
         RailsMiniProfiler.logger.error('Stackprof is already running, cannot record Flamegraph')
         return block.call
       end
 
-      result = nil
-      flamegraph = StackProf.run(mode: :wall, raw: true, aggregate: false, interval: (sample_rate * 1000).to_i) do
-        result = block.call
-      end
-
+      flamegraph, result = record_flamegraph(block)
       unless flamegraph
         RailsMiniProfiler.logger.error('Failed to record Flamegraph, possibly due to concurrent requests')
         return result
@@ -33,6 +28,15 @@ module RailsMiniProfiler
 
     private
 
+    def record_flamegraph(block)
+      sample_rate = @configuration.flamegraph_sample_rate
+      result = nil
+      flamegraph = StackProf.run(mode: :wall, raw: true, aggregate: false, interval: (sample_rate * 1000).to_i) do
+        result = block.call
+      end
+      [flamegraph, result]
+    end
+
     def enabled?
       defined?(StackProf) && StackProf.respond_to?(:run) && config_enabled?
     end

data/lib/rails_mini_profiler/guard.rb

@@ -34,7 +34,9 @@ module RailsMiniProfiler
     def ignored_path?
       return true if /#{Engine.routes.find_script_name({})}/.match?(@request.path)
 
-      return true if /assets/.match?(@request.path)
+      return true if asset_path?
+
+      return true if actioncable_request?
 
       ignored_paths = @configuration.skip_paths
       return true if Regexp.union(ignored_paths).match?(@request.path)
@@ -42,6 +44,22 @@ module RailsMiniProfiler
       false
     end
 
+    # Is the current request an asset request, e.g. to webpacker packs or assets?
+    #
+    # @return [Boolean] if the request path matches packs or assets
+    def asset_path?
+      %r{^/packs}.match?(@request.path) || %r{^/assets}.match?(@request.path)
+    end
+
+    # Is the current request an actioncable ping
+    #
+    # @return [Boolean] if the request path matches the mount path of actioncable
+    def actioncable_request?
+      return false unless defined?(ActionCable)
+
+      /#{ActionCable.server.config.mount_path}/.match?(@request.path)
+    end
+
     # Is the profiler enabled?
     #
     # Takes into account the current request env to decide if the profiler is enabled.

data/lib/rails_mini_profiler/middleware.rb

@@ -5,21 +5,25 @@ module RailsMiniProfiler
     def initialize(app)
       @app = app
       @config = RailsMiniProfiler.configuration
-      Tracers.setup! { |trace| track_trace(trace) }
+      @registry = Tracers::Registry.setup!(@config)
+      Tracers::Subscriptions.setup!(@registry.tracers.keys) { |trace| track_trace(trace) }
+      @trace_factory = Tracers::TraceFactory.new(@registry)
     end
 
     def call(env)
-      request = RequestWrapper.new(env: env)
+      request = RequestWrapper.new(env)
       request_context = RequestContext.new(request)
       return @app.call(env) unless Guard.new(request_context).profile?
 
-      request_context.profiled_request = ProfiledRequest.new
       result = with_tracing(request_context) { profile(request_context) }
       return result unless request_context.authorized?
 
-      request_context.response = ResponseWrapper.new(*result)
+      status, headers, body = result
+      request_context.response = ResponseWrapper.new(body, status, headers)
       complete!(request_context)
-      request_context.saved? ? render_response(request_context) : result
+      request_context.saved? ? render_response(request_context).to_a : result
+    ensure
+      User.current_user = nil
     end
 
     def traces
@@ -33,14 +37,13 @@ module RailsMiniProfiler
     def track_trace(event)
       return if traces.nil?
 
-      trace = Tracers.build_trace(event)
-      traces.append(trace)
+      trace = @trace_factory.create(event)
+      traces.append(trace) unless trace.is_a?(RailsMiniProfiler::Tracers::NullTrace)
     end
 
     private
 
     def complete!(request_context)
-      request_context.complete_profiling!
       request_context.save_results!
       true
     rescue ActiveRecord::ActiveRecordError => e
@@ -52,8 +55,7 @@ module RailsMiniProfiler
       redirect = Redirect.new(request_context).render
       return redirect if redirect
 
-      modified_response = Badge.new(request_context).render
-      [modified_response.status, modified_response.headers, modified_response.response]
+      Badge.new(request_context).render
     end
 
     def profile(request_context)

data/lib/rails_mini_profiler/request_context.rb

@@ -10,7 +10,7 @@ module RailsMiniProfiler
   #   @return [RequestWrapper] the request as sent to the application
   # @!attribute response
   #   @return [ResponseWrapper] the response as rendered by the application
-  # @!attribute profiled_request
+  #   # @!attribute profiled_request
   #   @return [ProfiledRequest] the profiling data as gathered during profiling
   # @!attribute traces
   #   @return [Array<Models::Trace>] trace wrappers gathered during profiling
@@ -19,8 +19,10 @@ module RailsMiniProfiler
   class RequestContext
     attr_reader :request
 
-    attr_accessor :response, :profiled_request, :traces, :flamegraph
+    attr_accessor :response, :traces, :flamegraph, :profiled_request
 
+    # Create a new request context
+    #
     # @param request [RequestWrapper] the request as sent to the application
     def initialize(request)
       @request = request
@@ -36,39 +38,41 @@ module RailsMiniProfiler
       @authorized ||= User.get(@env).present?
     end
 
-    # Completes profiling, setting all data and preparing for saving it.
-    def complete_profiling!
-      profiled_request.user_id = User.current_user
-      profiled_request.request = @request
-      profiled_request.response = @response
-      total_time = traces.find { |trace| trace.name == 'rails_mini_profiler.total_time' }
-      profiled_request.total_time = total_time
-      @complete = true
-    end
-
     # Save profiling data in the database.
     #
     # This will store the profiled request, as well as any attached traces and Flamgraph.
     def save_results!
       ActiveRecord::Base.transaction do
+        profiled_request = build_profiled_request
         profiled_request.flamegraph = RailsMiniProfiler::Flamegraph.new(data: flamegraph) if flamegraph.present?
         profiled_request.save
-        insert_traces unless traces.empty?
+        insert_traces(profiled_request) unless traces.empty?
+        @profiled_request = profiled_request
       end
       @saved = true
     end
 
-    def complete?
-      @complete
-    end
-
+    # Check if profiling results have been saved
+    #
+    # @return [Boolean] true if profiling results have been saved
     def saved?
       @saved
     end
 
     private
 
-    def insert_traces
+    def build_profiled_request
+      new_profiled_request = ProfiledRequest.new
+      new_profiled_request.user_id = User.current_user
+      new_profiled_request.request = @request
+      new_profiled_request.response = @response
+      total_time = traces.find { |trace| trace.name == 'rails_mini_profiler.total_time' }
+      new_profiled_request.total_time = total_time
+      new_profiled_request
+    end
+
+    # We insert multiple at once for performance reasons.
+    def insert_traces(profiled_request)
       return if traces.empty?
 
       timestamp = Time.zone.now

data/lib/rails_mini_profiler/request_wrapper.rb

@@ -1,69 +1,26 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  # A convenience wrapper around [Rack::Env]
-  #
-  # @!attribute body
-  #   @return [String] the request body
-  # @!attribute method
-  #   @return [String] the request method
-  # @!attribute path
-  #   @return [String] the request path
-  # @!attribute query_string
-  #   @return [String] the request query string
-  # @!attribute env
-  #   @return [Rack::Env] the original env
+  # A convenience wrapper extending {Rack::Request}
   #
   # @api private
-  class RequestWrapper
-    attr_reader :body,
-                :method,
-                :path,
-                :query_string,
-                :env
+  class RequestWrapper < Rack::Request
+    # Convenience method to read the request body as String
+    #
+    # @return [String] the request body
+    def body
+      return '' unless super
 
-    def initialize(*_args, **attributes)
-      @attributes = attributes
-      setup
+      body = super.read
+      super.rewind
+      body
     end
 
     # The request headers
     #
-    # @return [Hash] the headers
+    # @return [Hash] the request headers
     def headers
-      @attributes[:headers] || @env.select { |k, _v| k.start_with? 'HTTP_' } || {}
-    end
-
-    private
-
-    def setup
-      @env = @attributes[:env] || {}
-      @method = setup_method
-      @query_string = setup_query_string
-      @path = setup_path
-      @body = setup_body
-    end
-
-    def setup_method
-      @attributes[:method] || @env['REQUEST_METHOD'] || 'GET'
-    end
-
-    def setup_query_string
-      @attributes[:query_string] || @env['QUERY_STRING'] || ''
-    end
-
-    def setup_path
-      @attributes[:path] || @env['PATH_INFO'] || '/'
-    end
-
-    def setup_body
-      return @attributes[:body] if @attributes[:body]
-
-      return '' unless @env['rack.input']
-
-      body = @env['rack.input'].read
-      @env['rack.input'].rewind
-      body
+      env.select { |k, _v| k.start_with? 'HTTP_' } || {}
     end
   end
 end

data/lib/rails_mini_profiler/response_wrapper.rb

@@ -1,24 +1,28 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  class ResponseWrapper
-    attr_reader :response, :rack_response
-
-    delegate :status, :headers, to: :rack_response
-
-    def initialize(status, headers, response)
-      @rack_response = Rack::Response.new(response, status, headers)
-      @response = response
-    end
-
+  # A convenience wrapper extending {Rack::Response}
+  #
+  # @api private
+  class ResponseWrapper < Rack::Response
+    # Return the response body as String
+    #
+    # Depending on preceding middleware, response bodies may be Strings, Arrays or literally anything else. This method
+    # converts whatever it is to a string so we can store it later.
+    #
+    # @return [String] of the response body
     def body
-      return '' unless json? || xml?
-
-      response&.body || ''
-    end
-
-    def media_type
-      @media_type ||= @rack_response.media_type
+      body = super
+      case body
+      when String
+        body
+      when Array
+        body.join
+      when ActionDispatch::Response::RackBody
+        body.body
+      else
+        ''
+      end
     end
 
     def json?