rails_mini_profiler 0 → 0.1.0

data/app/views/rails_mini_profiler/badge.html.erb

@@ -25,13 +25,13 @@
       transition: opacity 0.3s;
   }
 
-  #logo-variant {
+  #rails-mini-profiler-badge-icon {
     height: 18px;
     width: 18px;
     padding-bottom: 2px;
   }
 </style>
 <a id="rails-mini-profiler-badge" href="<%= profiled_request_path(@profiled_request.id) %>" data-turbolinks="false" title="View performance data">
-  <%= inline_svg('logo_variant.svg') %>
+  <%= inline_svg_tag('rails_mini_profiler/logo_variant', id: "rails-mini-profiler-badge-icon") %>
   <%= (@profiled_request.duration.to_f / 100).round %>ms
 </a>

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

@@ -1,9 +1,59 @@
+<% if @profiled_requests.empty? %>
+  <section class="placeholder">
+    <%= inline_svg_tag('rails_mini_profiler/logo_variant', class: 'placeholder-image') %>
+    <div class="placeholder-text">
+      <h2> There is nothing here yet! </h2>
+      <p>Send some requests to your app for them to show up here</p>
+    </div>
+  </section>
+<% else %>
+  <h1>Profiled Requests</h1>
+  <div class="profiled-requests-actions">
+    <%= form_with id: 'profiled-request-search-form', url: profiled_requests_url, method: :get do |form| %>
+      <%= form.search_field :path, id: 'profiled-request-search', placeholder: 'Search Path...', class: 'search-field' %>
+    <% end %>
+    <%= link_to(destroy_all_profiled_requests_url,
+                method: :delete,
+                class: 'clear-action',
+                data: { confirm: "This will delete all requests. Are you sure?" }) do %>
+      <button>Clear Requests</button>
+    <% end %>
+  </div>
+  <table id="profiled-requests-table" class="table">
+    <thead>
+    <tr>
+      <th class="text-left">Path</th>
+      <th class="text-left">Method</th>
+      <th class="text-left">Status</th>
+      <th class="text-left">Media Type</th>
+      <th class="text-right">Duration</th>
+      <th class="text-left"></th>
+      <th class="text-left"></th>
+    </tr>
+    </thead>
 
-<div
-  data-controller="filters selectable"
-  data-action="search-controller:submit@window->filters#apply">
-  <%= render "rails_mini_profiler/profiled_requests/shared/header/header" %>
-  <%= render "rails_mini_profiler/profiled_requests/shared/table/table" %>
-</div>
-<%== pagy_nav(@pagy) if @pagy.pages > 1 %>
-<br>
+    <tbody>
+    <% @profiled_requests.each do |profiled_request| %>
+      <tr data-link="<%= profiled_request_path(profiled_request.id)%>">
+        <td class="request-path"><%= profiled_request.request_name %></td>
+        <td> <%= profiled_request.request_method %> </td>
+        <td> <%= profiled_request.response_status %> </td>
+        <td> <%= profiled_request.response_media_type %> </td>
+        <td class="text-right"><%= profiled_request.duration %> ms</td>
+        <td class=""><%= profiled_request.created_at %></td>
+        <td class="request-buttons">
+          <%= link_to(profiled_request_path(profiled_request.id), title: 'Show Details') do %>
+            <%= inline_svg_tag('rails_mini_profiler/show.svg', options = {}) %>
+          <% end %>
+          <%= profiled_request.flamegraph_icon %>
+          <%= link_to(profiled_request_path(profiled_request.id), title: 'Delete Request', method: :delete) do %>
+            <%= inline_svg_tag('rails_mini_profiler/delete.svg') %>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+    </tbody>
+  </table>
+
+  <br>
+<% end %>

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

@@ -1,4 +1,4 @@
-<section class="page-header">
+<section class="request-details">
   <h1> <%= @profiled_request.request_path %> </h1>
 
   <ul class="request-details-data">

data/app/views/rails_mini_profiler/shared/_navbar.html.erb

@@ -1,7 +1,7 @@
 <header class="header">
   <nav class="nav">
     <a class="home" href="<%= profiled_requests_path %>">
-      <%= inline_svg('logo.svg', class: 'home-logo') %>
+      <%= inline_svg_tag('rails_mini_profiler/logo', class: 'home-logo') %>
       <h1 class="home-title">Rails Mini Profiler </h1>
     </a>
     <ul class="header-links">

data/db/migrate/20210621185018_create_rmp.rb

@@ -4,10 +4,10 @@ class CreateRmp < ActiveRecord::Migration[6.0]
   def change
     create_table :rmp_profiled_requests do |t|
       t.string :user_id
-      t.bigint :start
-      t.bigint :finish
+      t.integer :start
+      t.integer :finish
       t.integer :duration
-      t.bigint :allocations
+      t.integer :allocations
       t.string :request_path
       t.string :request_query_string
       t.string :request_method
@@ -19,17 +19,15 @@ class CreateRmp < ActiveRecord::Migration[6.0]
       t.string :response_media_type
 
       t.timestamps
-
-      t.index :created_at
     end
 
     create_table :rmp_traces do |t|
       t.belongs_to :rmp_profiled_request, null: false, foreign_key: true
       t.string :name
-      t.bigint :start
-      t.bigint :finish
+      t.integer :start
+      t.integer :finish
       t.integer :duration
-      t.bigint :allocations
+      t.integer :allocations
       t.json :payload
       t.json :backtrace
 

data/lib/generators/rails_mini_profiler/install_generator.rb

@@ -1,39 +1,15 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  # Generators for Rails Mini Profiler
   module Generators
-    # A basic installation generator to help set up users apps
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path('templates', __dir__)
 
-      # Install Rails Mini Profiler to your Rails app
-      #
-      # Updates the routes file to mount the engine, adds an initializer and copies a migration.
       desc 'Install rails-mini-profiler'
-
       def install
         route("mount RailsMiniProfiler::Engine => '/rails_mini_profiler'")
         template 'rails_mini_profiler.rb.erb', 'config/initializers/rails_mini_profiler.rb'
         system('rails rails_mini_profiler:install:migrations')
-        webpacker_install if defined?(Webpacker::Engine)
-      end
-
-      private
-
-      def webpacker_install
-        webpacker_config_file = Rails.root.join('config', 'webpacker.yml')
-        unless File.exist?(webpacker_config_file)
-          say "Webpacker is not installed. Run 'rails webpacker:install' and rerun installation to complete setup"
-          return
-        end
-
-        run 'yarn add @rails-mini-profiler/assets'
-        webpack_config = YAML.load_file(webpacker_config_file)[Rails.env]
-        destination = Rails.root.join(webpack_config['source_path'],
-                                      webpack_config['source_entry_path'],
-                                      'rails-mini-profiler.js')
-        template('rails_mini_profiler.js.erb', destination)
       end
     end
   end

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

@@ -1,29 +1,13 @@
-# Rails Mini Profiler Initializer (<%= RailsMiniProfiler::VERSION %>)
-
-# Customize to your hearts content. If you remove this file, Rails Mini Profiler will use sensible defaults.
-# For more information see https://github.com/hschne/rails-mini-profiler#configuration
 RailsMiniProfiler.configure do |config|
   # Customize when Rails Mini Profiler should run
-  config.enabled = proc { |env| Rails.env.development? || env['HTTP_RMP_ENABLED'].present? }
-
-  # Configure Flamegraph generation
-  config.flamegraph_enabled = true
-  # config.flamegraph_sample_rate = 0.5
-
-  # Configure endpoints to profile
-  config.skip_paths = []
+  # config.enabled = proc { |env| Rails.env.development? || request.headers[RMP_ENABLED].present? }
 
-  # Configure how Rails Mini Profiler stores profiling information
-  # config.storage.database = :rmp_database
-  # config.storage.profiled_requests_table = :rmp_profiled_requests
-  # config.storage.traces_table = :rmp_traces
-  # config.storage.flamegraphs_table = :rmp_flamegraphs
+  # Disable Flamegraph generation
+  # config.flamegraph_enabled = false
 
-  # Configure the Rails Mini Profiler User Interface
-  # config.ui.badge_enabled = true
-  # config.ui.badge_position = 'top-left'
-  # config.ui.page_size = 25
+  # Use RailsMiniProfiler::Storage::ActiveRecord to store profiles in your Database
+  config.storage = RailsMiniProfiler::Storage::Memory
 
-  # Customize how users are detected
-  config.user_provider = proc { |env| Rack::Request.new(env).ip }
+  # Uncomment to customize how users are detected
+  # config.user_provider = proc { |env| Rack::Request.new(env).ip }
 end

data/lib/rails_mini_profiler/badge.rb

@@ -1,33 +1,20 @@
 # frozen_string_literal: true
 
-require_relative '../../app/helpers/rails_mini_profiler/application_helper'
-
 module RailsMiniProfiler
-  # Wraps functionality to render an interactive badge on top of HTML responses
-  #
-  # @api private
   class Badge
     include InlineSvg::ActionView::Helpers
-    include RailsMiniProfiler::ApplicationHelper
     include Engine.routes.url_helpers
 
-    # @param request_context [RequestContext] The current request context
-    # @param configuration [Configuration] The current configuration
     def initialize(request_context, configuration: RailsMiniProfiler.configuration)
       @configuration = configuration
       @profiled_request = request_context.profiled_request
       @original_response = request_context.response
     end
 
-    # Inject the badge into the response
-    #
-    # @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
-
       modified_response = Rack::Response.new([], @original_response.status, @original_response.headers)
       modified_response.write(modified_body)
       modified_response.finish
@@ -42,9 +29,6 @@ module RailsMiniProfiler
 
     private
 
-    # Modify the body of the original response
-    #
-    # @return String The modified body
     def modified_body
       body = @original_response.response.body
       index = body.rindex(%r{</body>}i) || body.rindex(%r{</html>}i)
@@ -55,9 +39,6 @@ module RailsMiniProfiler
       end
     end
 
-    # Render the badge template
-    #
-    # @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__))
       @position = css_position
@@ -65,11 +46,8 @@ module RailsMiniProfiler
       template.result(binding)
     end
 
-    # Transform the configuration position into CSS style positions
-    #
-    # @return String The badge position as CSS style
     def css_position
-      case @configuration.ui.badge_position
+      case RailsMiniProfiler.configuration.badge_position
       when 'top-right'
         'top: 5px; right: 5px;'
       when 'bottom-left'

data/lib/rails_mini_profiler/configuration.rb

@@ -1,36 +1,16 @@
 # 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
-  #
-  # @!attribute [r] logger
-  #   @return [Logger] the current logger
-  # @!attribute enabled
-  #   @return [Boolean] if the profiler is enabled
-  # @!attribute flamegraph_enabled
-  #   @return [Boolean] if Flamegraph recording is enabled
-  # @!attribute flamegraph_sample_rate
-  #   @return [Float] the sample rate in samples per millisecond
-  # @!attribute skip_paths
-  #   @return [Array<String>] a list of regex patterns for paths to skip
-  # @!attribute storage
-  #   @return [Storage] the storage configuration
-  # @!attribute ui
-  #   @return [UserInterface] the ui configuration
-  # @!attribute user_provider
-  #   @return [Proc] a proc to identify a user based on a rack env
   class Configuration
     attr_reader :logger
 
     attr_accessor :enabled,
+                  :badge_enabled,
+                  :badge_position,
                   :flamegraph_enabled,
                   :flamegraph_sample_rate,
                   :skip_paths,
                   :storage,
-                  :ui,
                   :user_provider
 
     def initialize(**kwargs)
@@ -38,22 +18,18 @@ module RailsMiniProfiler
       kwargs.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
-    # Reset the configuration to default values
     def reset
       @enabled = proc { |_env| Rails.env.development? || Rails.env.test? }
+      @badge_enabled = true
+      @badge_position = 'top-left'
       @flamegraph_enabled = true
       @flamegraph_sample_rate = 0.5
       @logger = RailsMiniProfiler::Logger.new(Rails.logger)
       @skip_paths = []
       @storage = Storage.new
-      @ui = UserInterface.new
       @user_provider = proc { |env| Rack::Request.new(env).ip }
     end
 
-    # Set the logger
-    #
-    # @param logger [Logger]
-    #   The logger to be used. If set to nil, the Rails default logger is used and the log level set to fatal
     def logger=(logger)
       if logger.nil?
         @logger.level = Logger::FATAL

data/lib/rails_mini_profiler/engine.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  # The Rails Mini Profiler engine
-  #
-  # Injects a a custom [Middleware] into an existing Rails app to record request profiling information.
   class Engine < ::Rails::Engine
     isolate_namespace RailsMiniProfiler
 
@@ -11,6 +8,10 @@ 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]
+    end
+
     config.generators do |g|
       g.test_framework :rspec
     end
@@ -18,17 +19,5 @@ 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/errors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  RailsMiniProfilerError = Class.new(StandardError)
+
+  # Storage errors
+  StorageError = Class.new(RailsMiniProfilerError)
+end

data/lib/rails_mini_profiler/guard.rb

@@ -1,22 +1,13 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  # Encapsulates guard conditions on whether or not to run certain parts of the profiler.
   class Guard
-    # @param request_context [RequestContext] the current request context
-    # @param configuration [Configuration] the current configuration
     def initialize(request_context, configuration: RailsMiniProfiler.configuration)
       @request_context = request_context
       @request = request_context.request
       @configuration = configuration
     end
 
-    # Whether or not to profile
-    #
-    # Profiling is disabled the profiler has been flat out disabled in the configuration or if the current request path
-    # matches on of the ignored paths.
-    #
-    # @return [Boolean] false if no profiling should be done
     def profile?
       return false unless enabled?
 
@@ -25,28 +16,26 @@ module RailsMiniProfiler
       true
     end
 
+    def store?
+      return false unless @request_context.user
+
+      true
+    end
+
     private
 
-    # Is the path of the current request an ignored one?
-    #
-    # @return [Boolean] true if the path is ignored. Per default, paths going to the engine itself are ignored, as are
-    #   asset requests, and the paths the user has configured.
     def ignored_path?
       return true if /#{Engine.routes.find_script_name({})}/.match?(@request.path)
 
       return true if /assets/.match?(@request.path)
 
       ignored_paths = @configuration.skip_paths
+
       return true if Regexp.union(ignored_paths).match?(@request.path)
 
       false
     end
 
-    # Is the profiler enabled?
-    #
-    # Takes into account the current request env to decide if the profiler is enabled.
-    #
-    # @return [Boolean] false if the profiler is disabled
     def enabled?
       enabled = @configuration.enabled
       return enabled unless enabled.respond_to?(:call)

data/lib/rails_mini_profiler/logger.rb

@@ -1,11 +1,7 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  # Construct a new custom logger to log from within the engine
   module Logger
-    # Extends a logger with additional formatting
-    #
-    # @return [Logger] a customized logger
     def self.new(logger)
       logger = logger.dup
 
@@ -15,7 +11,6 @@ module RailsMiniProfiler
       logger.extend(self)
     end
 
-    # Custom formatter to add a RailsMiniProfiler tag to log messages
     module Formatter
       def call(severity, timestamp, progname, msg)
         super(severity, timestamp, progname, "[RailsMiniProfiler] #{msg}")

data/lib/rails_mini_profiler/middleware.rb

@@ -5,11 +5,11 @@ module RailsMiniProfiler
     def initialize(app)
       @app = app
       @config = RailsMiniProfiler.configuration
-      Tracing::Subscriptions.setup! { |trace| track_trace(trace) }
+      Tracers.setup! { |trace| track_trace(trace) }
     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?
 
@@ -33,8 +33,8 @@ 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 = Tracers.build_trace(event)
+      traces.append(trace)
     end
 
     private

data/lib/rails_mini_profiler/models/base_model.rb

@@ -1,12 +1,7 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  # Thin wrappers around request/response classes
-  #
-  # @api private
   module Models
-    # A pseudo model to be used to wrap profiling information. We can't use regular models, as their connecting
-    # to the database results in problems when profiling.
     class BaseModel
       include ActiveModel::Model
 

data/lib/rails_mini_profiler/models/trace.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  module Models
+    class Trace < BaseModel
+      attr_accessor :id, :name, :start, :finish, :duration, :payload, :backtrace, :allocations, :created_at, :updated_at
+    end
+  end
+end

data/lib/rails_mini_profiler/redirect.rb

@@ -1,25 +1,17 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  # Renders a redirect response if the user should be redirected from the original request
   class Redirect
     include Engine.routes.url_helpers
 
-    # @param request_context [RequestContext] the current request context
     def initialize(request_context)
       @request = request_context.request
       @profiled_request = request_context.profiled_request
     end
 
-    # Renders a redirect to a specific resource under certain conditions
-    #
-    # When the user requests a Flamegraph using a parameter for a specific request, they are being served a redirect.
-    #
-    # @return [Boolean] false if no redirect happens
-    # @return [Array] response with status 302 and the new location to redirect to
     def render
       params = CGI.parse(@request.query_string).transform_values(&:first).with_indifferent_access
-      return redirect_to(flamegraph_path(@profiled_request.id)) if params[:rmp_flamegraph].present?
+      return redirect_to(flamegraph_path(@profiled_request.id)) if params[:rmp_flamegraph]
 
       false
     end

data/lib/rails_mini_profiler/request_context.rb

@@ -1,27 +1,11 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  # A working context for the duration of a request, as it runs through Rails Mini Profiler's middleware
-  #
-  # Contains all information that is being gathered while profiling is active. At the end of the request processing,
-  # the request context is converted into a models which are then stored in the host apps database.
-  #
-  # @!attribute [r] request
-  #   @return [RequestWrapper] the request as sent to the application
-  # @!attribute response
-  #   @return [ResponseWrapper] the response as rendered by the application
-  # @!attribute profiled_request
-  #   @return [ProfiledRequest] the profiling data as gathered during profiling
-  # @!attribute traces
-  #   @return [Array<Models::Trace>] trace wrappers gathered during profiling
-  # @!attribute flamegraph
-  #   @return [Flamegraph] a Flamegraph, if recorded
   class RequestContext
     attr_reader :request
 
     attr_accessor :response, :profiled_request, :traces, :flamegraph
 
-    # @param request [RequestWrapper] the request as sent to the application
     def initialize(request)
       @request = request
       @env = request.env
@@ -29,16 +13,16 @@ module RailsMiniProfiler
       @complete = false
     end
 
-    # If a user is currently authorized
-    #
-    # @return [Boolean] true if the user is authorized
+    def user_id
+      @user_id ||= User.current_user
+    end
+
     def authorized?
       @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.user_id = user_id
       profiled_request.request = @request
       profiled_request.response = @response
       total_time = traces.find { |trace| trace.name == 'rails_mini_profiler.total_time' }
@@ -46,12 +30,9 @@ module RailsMiniProfiler
       @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.flamegraph = RailsMiniProfiler::Flamegraph.new(data: flamegraph) if flamegraph.present?
+        profiled_request.flamegraph = Flamegraph.new(data: flamegraph) if flamegraph.present?
         profiled_request.save
         insert_traces unless traces.empty?
       end
@@ -73,12 +54,7 @@ module RailsMiniProfiler
 
       timestamp = Time.zone.now
       inserts = traces.map do |trace|
-        {
-          rmp_profiled_request_id: profiled_request.id,
-          created_at: timestamp,
-          updated_at: timestamp,
-          **trace.to_h.symbolize_keys # Symbolize keys needed for Ruby 2.6
-        }
+        { rmp_profiled_request_id: profiled_request.id, **trace.to_h, created_at: timestamp, updated_at: timestamp }
       end
       RailsMiniProfiler::Trace.insert_all(inserts)
     end