rails_mini_profiler 0.6.0 → 0.7.2

data/app/search/rails_mini_profiler/trace_search.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  class TraceSearch < BaseSearch
+    option(:name) do |scope, value|
+      scope.where(name: value)
+    end
+
+    option(:duration) do |scope, value|
+      scope.where('duration > :duration', duration: value)
+    end
+
+    option(:allocations) do |scope, value|
+      scope.where('allocations > :allocations', allocations: value)
+    end
+
+    option(:payload) do |scope, value|
+      payload_column = DatabaseAdapter.cast_to_text(:payload)
+      scope.where("#{payload_column} LIKE ?", "%#{value}%")
+    end
+
+    option(:backtrace) do |scope, value|
+      backtrace_column = Adapters::DatabaseAdapter.cast_to_text(:backtrace)
+      scope.where("#{backtrace_column} LIKE ?", "%#{value}%")
+    end
+  end
+end

data/app/views/rails_mini_profiler/profiled_requests/shared/header/_header.erb

@@ -12,9 +12,8 @@
                    }) -%>
     <%= link_to(destroy_all_profiled_requests_url,
                 method: :delete,
-                class: 'clear-action',
                 data: { confirm: "This will delete all requests. Are you sure?" }) do %>
-      <%= button_tag('Delete All') %>
+      <%= button_tag('Delete All', class: 'btn-red') %>
     <% end %>
   </div>
 </div>

data/app/views/rails_mini_profiler/profiled_requests/shared/table/_table_head.erb

@@ -23,7 +23,7 @@
                                 placeholder: 'Search Path',
                                 class: 'dropdown-search-field',
                                 data: { 'filters-target': 'filter' } %>
-          <%= form.submit 'Search', class: 'dropdown-search-button', data: { action: 'click->search#submit' } -%>
+          <%= form.submit 'Search', class: 'btn-red', data: { action: 'click->search#submit' } -%>
         <% end %>
       </div>
     </div>
@@ -74,7 +74,7 @@
       </button>
     </div>
   </th>
-  <th style="width: 15%" class="" data-controller="dropdown">
+  <th style="width: 15%;" class="" data-controller="dropdown">
     <button data-action="click->dropdown#toggle click@window->dropdown#hide" data-dropdown-target="button" class="dropdown-toggle none">
       Media Type <%= inline_svg('filter.svg', class: 'table-filter-icon') %> </button>
     <div data-controller="checklist" data-dropdown-target="menu" class="dropdown-container hidden">
@@ -97,7 +97,7 @@
       </button>
     </div>
   </th>
-  <th style="width: 10%" class="text-left" data-controller="dropdown">
+  <th style="width: 10%;" class="text-left" 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">
@@ -107,12 +107,12 @@
           Clear filter
         </button>
       </div>
-      <% %w[>100ms >250ms].each do |duration| %>
+      <% [100_00, 250_00, 500_00].each do |duration| %>
         <%= label_tag nil, class: "dropdown-entry" do %>
-          <%= radio_button_tag 'duration', duration, params.fetch(:duration, []).include?(duration),
+          <%= radio_button_tag 'duration', duration.to_s , params.fetch(:duration, []).include?(duration.to_s),
                                class: "",
                                data: { target: "filters.filter" } %>
-          <%= duration %>
+          <%= "> #{duration / 100}ms" %>
         <% end %>
       <% end %>
       <button class="dropdown-footer" data-action="filters#apply">
@@ -120,6 +120,6 @@
       </button>
     </div>
   </th>
-  <th style="width: 15%" class="text-left">Date</th>
+  <th style="width: 15%;" class="text-left">Date</th>
 </tr>
 </thead>

data/app/views/rails_mini_profiler/profiled_requests/{shared → show}/_trace.html.erb

@@ -7,8 +7,29 @@
         <button class="popover-close">x</button>
       </section>
       <section class="popover-body">
-        <%= trace.payload %>
-        <table class="trace-table">
+        <%= trace.content %>
+
+        <% if trace.backtrace %>
+          <section class="popover-footer">
+            <div
+              class="backtrace"
+              data-controller="clipboard"
+              data-clipboard-filter=".+?(?=:in)"
+              data-clipboard-copied-message="Copied" >
+              <pre data-clipboard-target="source"><%= trace.backtrace %></pre>
+              <button
+                title="Copy to clipboard"
+                type="button"
+                data-action="clipboard#copy"
+                data-clipboard-target="button"
+              >
+                <%= inline_svg('copy.svg') %>
+              </button>
+            </div>
+          </section>
+        <% end %>
+
+        <table class="trace-details-table">
           <thead>
           <tr>
             <th class="text-left"></th>
@@ -30,26 +51,7 @@
         </table>
       </section>
 
-      <% if trace.backtrace %>
-        <section class="popover-footer">
-          <div
-            class="backtrace"
-            data-controller="clipboard"
-            data-clipboard-filter=".+?(?=:in)"
-            data-clipboard-copied-class="copied"
-          >
-            <pre data-clipboard-target="source"><%= trace.backtrace %></pre>
-            <button
-              title="Copy to clipboard"
-              type="button"
-              data-action="clipboard#copy"
-              data-clipboard-target="button"
-            >
-              <%= inline_svg('copy.svg') %>
-          </button>
-          </div>
-        </section>
-      <% end %>
+
     </div>
   </div>
 </li>

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

@@ -0,0 +1,12 @@
+<section class="trace-list">
+  <%= render "rails_mini_profiler/profiled_requests/show/trace_list_header" %>
+  <% if @traces.empty? %>
+    <%= render "rails_mini_profiler/profiled_requests/show/trace_list_placeholder" %>
+  <% else %>
+    <ol>
+      <% @traces.each do |trace| %>
+        <%= render "rails_mini_profiler/profiled_requests/show/trace", trace: trace %>
+      <% end %>
+    </ol>
+  <% end %>
+</section>

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="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/db/migrate/20210621185018_create_rmp.rb

@@ -2,7 +2,7 @@
 
 class CreateRmp < ActiveRecord::Migration[6.0]
   def change
-    create_table :rmp_profiled_requests do |t|
+    create_table :rmp_profiled_requests, charset: 'utf8' do |t|
       t.string :user_id
       t.bigint :start
       t.bigint :finish
@@ -23,7 +23,7 @@ class CreateRmp < ActiveRecord::Migration[6.0]
       t.index :created_at
     end
 
-    create_table :rmp_traces do |t|
+    create_table :rmp_traces, charset: 'utf8' do |t|
       t.belongs_to :rmp_profiled_request, null: false, foreign_key: true
       t.string :name
       t.bigint :start
@@ -36,7 +36,7 @@ class CreateRmp < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
-    create_table :rmp_flamegraphs do |t|
+    create_table :rmp_flamegraphs, charset: 'utf8' do |t|
       t.belongs_to :rmp_profiled_request, null: false, foreign_key: true
       t.binary :data
 

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

@@ -22,6 +22,7 @@ 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
 

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)

data/lib/rails_mini_profiler/configuration/user_interface.rb

@@ -9,6 +9,8 @@ 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
@@ -36,6 +38,8 @@ module RailsMiniProfiler
                   :page_size,
                   :webpacker_enabled
 
+    attr_writer :base_controller
+
     def initialize(**kwargs)
       defaults!
       kwargs.each { |key, value| instance_variable_set("@#{key}", value) }
@@ -45,8 +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

@@ -18,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
@@ -30,6 +32,7 @@ module RailsMiniProfiler
                   :flamegraph_sample_rate,
                   :skip_paths,
                   :storage,
+                  :tracers,
                   :ui,
                   :user_provider
 
@@ -46,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/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/middleware.rb

@@ -5,21 +5,25 @@ module RailsMiniProfiler
     def initialize(app)
       @app = app
       @config = RailsMiniProfiler.configuration
-      Tracing::Subscriptions.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 = RailsMiniProfiler::Tracing::TraceFactory.create(event)
-      traces.append(trace) unless trace.is_a?(RailsMiniProfiler::Tracing::NullTrace)
+      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