rails_mini_profiler 0.1.2 → 0.3.0

data/lib/rails_mini_profiler/badge.rb

@@ -1,16 +1,27 @@
 # 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}
@@ -29,6 +40,9 @@ 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)
@@ -39,6 +53,9 @@ 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
@@ -46,8 +63,11 @@ 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 RailsMiniProfiler.configuration.badge_position
+      case @configuration.badge_position
       when 'top-right'
         'top: 5px; right: 5px;'
       when 'bottom-left'

data/lib/rails_mini_profiler/configuration.rb

@@ -1,6 +1,25 @@
 # frozen_string_literal: true
 
 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 badge_position
+  #   @see Badge
+  #   @return [String] the position of the interactive HTML badge.
+  # @!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 user_provider
+  #   @return [Proc] a proc to identify a user based on a rack env
   class Configuration
     attr_reader :logger
 
@@ -18,6 +37,7 @@ 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
@@ -30,6 +50,10 @@ module RailsMiniProfiler
       @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,6 +1,9 @@
 # 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
 
@@ -9,7 +12,11 @@ module RailsMiniProfiler
     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]
+      app.config.assets.precompile += %w[
+        rails_mini_profiler.js
+        rails_mini_profiler/application.css
+        vendor/assets/images
+      ]
     end
 
     config.generators do |g|

data/lib/rails_mini_profiler/guard.rb

@@ -1,13 +1,22 @@
 # 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?
 
@@ -16,26 +25,28 @@ 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,7 +1,11 @@
 # 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
 
@@ -11,6 +15,7 @@ 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/models/base_model.rb

@@ -1,7 +1,12 @@
 # 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

@@ -2,6 +2,34 @@
 
 module RailsMiniProfiler
   module Models
+    # A simplified representation of a trace.
+    #
+    # Is transformed into [RailsMiniProfiler::Trace] when recording has finished.
+    #
+    # @see https://guides.rubyonrails.org/active_support_instrumentation.html
+    #
+    # @!attribute id
+    #   @return [Integer] the trace ID
+    # @!attribute name
+    #   @return [Integer] the trace type.
+    # @!attribute start
+    #   @return [Integer] the trace start as microsecond timestamp
+    # @!attribute finish
+    #   @return [Integer] the trace finish as microsecond timestamp
+    # @!attribute duration
+    #   @return [Integer] the trace duration
+    # @!attribute payload
+    #   @return [Hash] a subset of trace data
+    # @!attribute backtrace
+    #   @return [String] the line where this trace was recorded
+    # @!attribute allocations
+    #   @return [Integer] the number of alloactions
+    # @!attribute created_at
+    #   @return [DateTime] the creation date
+    # @!attribute updated_at
+    #   @return [DateTime] the last updated date
+    #
+    # @api private
     class Trace < BaseModel
       attr_accessor :id, :name, :start, :finish, :duration, :payload, :backtrace, :allocations, :created_at, :updated_at
     end

data/lib/rails_mini_profiler/redirect.rb

@@ -1,14 +1,22 @@
 # 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]

data/lib/rails_mini_profiler/request_context.rb

@@ -1,11 +1,27 @@
 # 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
@@ -13,16 +29,16 @@ module RailsMiniProfiler
       @complete = false
     end
 
-    def user_id
-      @user_id ||= User.current_user
-    end
-
+    # If a user is currently authorized
+    #
+    # @return [Boolean] true if the user is authorized
     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_id
+      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' }
@@ -30,6 +46,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?

data/lib/rails_mini_profiler/storage.rb

@@ -1,14 +1,31 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
+  # Configure how profiling data is stored within your Rails app.
+  #
+  # @!attribute database
+  #   @return [Symbol] which database to connect to
+  # @!attribute profiled_requests_table
+  #   @return [Symbol] where to store profiled requests
+  # @!attribute traces_table
+  #   @return [Symbol] where to store traces
+  # @!attribute flamegraphs_table
+  #   @return [Symbol] where to store flamegraphs
   class Storage
     class << self
+      # Construct a new configuration instance
+      #
+      # @return [Storage] a new storage configuration
       def configuration
         @configuration ||= new
       end
 
+      # Configure how profiling data is stored
+      #
+      # @yieldreturn [Storage] a new storage configuration object
       def configure
         yield(configuration)
+        configuration
       end
     end
 
@@ -19,6 +36,7 @@ module RailsMiniProfiler
       kwargs.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
+    # Reset the configuration to default values
     def defaults!
       @database = nil
       @profiled_requests_table = 'rmp_profiled_requests'

data/lib/rails_mini_profiler/tracers.rb

@@ -60,7 +60,7 @@ module RailsMiniProfiler
         typecasted_binds = payload[:type_casted_binds]
         # Sometimes, typecasted binds are a proc. Not sure why. In those instances, we extract the typecasted
         # values from the proc by executing call.
-        typecasted_binds = typecasted_binds.respond_to?(:call) ? typecasted_binds.call : typecasted_binds
+        typecasted_binds = typecasted_binds.call if typecasted_binds.respond_to?(:call)
         payload[:binds] = transform_binds(payload[:binds], typecasted_binds)
         payload.delete(:type_casted_binds)
         payload.reject { |_k, v| v.blank? }

data/lib/rails_mini_profiler/version.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  VERSION = '0.1.2'
+  # This needs to be double quoted for release-please
+  #
+  # See https://github.com/googleapis/release-please/issues/1018
+  VERSION = "0.3.0" # rubocop:disable Style/StringLiterals
 end

data/vendor/assets/images/bookmark.svg

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="24px" height="24px" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>Iconly/Bulk/Bookmark</title>
+    <g id="Iconly/Bulk/Bookmark" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Bookmark" transform="translate(4.000000, 2.000000)" fill="#000000" fill-rule="nonzero">
+            <path d="M7.99117971,16.6215262 L1.49944873,19.8641008 C1.00920819,20.1302192 0.397682727,19.9525481 0.123484013,19.4643313 C0.043404087,19.3108374 0.00105752372,19.1402321 -5.24025268e-14,18.9668404 L-5.24025268e-14,11.7088036 C-5.24025268e-14,12.4283887 0.405733186,12.872577 1.47298787,13.3700679 L7.99117971,16.6215262 Z" id="Bookmark-2" opacity="0.400000006"></path>
+            <path d="M11.0694598,0 C13.7772878,0 15.9735391,1.06605192 16,3.79336809 L16,3.79336809 L16,18.9668404 C15.998918,19.1374024 15.9565307,19.3051222 15.876516,19.4554476 C15.7479482,19.7006536 15.5259405,19.8826876 15.2614691,19.959752 C14.9969977,20.0368164 14.7127851,20.0022901 14.4740904,19.8641008 L14.4740904,19.8641008 L7.99117971,16.6215262 L1.47298787,13.3700679 C0.405733186,12.872577 8.17124146e-14,12.4283887 8.17124146e-14,11.7088036 L8.17124146e-14,11.7088036 L8.17124146e-14,3.79336809 C8.17124146e-14,1.06605192 2.19625138,0 4.8952591,0 L4.8952591,0 Z M11.7486218,6.04096089 L4.22491731,6.04096089 C3.79137074,6.04096089 3.4399118,6.39494927 3.4399118,6.83161607 C3.4399118,7.26828286 3.79137074,7.62227124 4.22491731,7.62227124 L4.22491731,7.62227124 L11.7486218,7.62227124 C12.1821684,7.62227124 12.5336273,7.26828286 12.5336273,6.83161607 C12.5336273,6.39494927 12.1821684,6.04096089 11.7486218,6.04096089 L11.7486218,6.04096089 Z"></path>
+        </g>
+    </g>
+</svg>

data/vendor/assets/images/chart.svg

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="24px" height="24px" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <title>Iconly/Bulk/Chart</title>
+    <g id="Iconly/Bulk/Chart" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Chart" transform="translate(2.000000, 2.000000)" fill="currentColor" fill-rule="nonzero">
+            <path d="M14.6755556,0 L5.33333333,0 C1.92888889,0 0,1.92888889 0,5.33333333 L0,14.6666667 C0,18.0711111 1.92888889,20 5.33333333,20 L14.6755556,20 C18.08,20 20,18.0711111 20,14.6666667 L20,5.33333333 C20,1.92888889 18.08,0 14.6755556,0" id="Fill-1" opacity="0.400000006"></path>
+            <path d="M5.36871111,7.36897778 C4.91537778,7.36897778 4.54204444,7.74231111 4.54204444,8.20453333 L4.54204444,15.0756444 C4.54204444,15.5289778 4.91537778,15.9023111 5.36871111,15.9023111 C5.83093333,15.9023111 6.20426667,15.5289778 6.20426667,15.0756444 L6.20426667,8.20453333 C6.20426667,7.74231111 5.83093333,7.36897778 5.36871111,7.36897778" id="Fill-4"></path>
+            <path d="M10.0353778,4.08897778 C9.58204444,4.08897778 9.20871111,4.46231111 9.20871111,4.92453333 L9.20871111,15.0756444 C9.20871111,15.5289778 9.58204444,15.9023111 10.0353778,15.9023111 C10.4976,15.9023111 10.8709333,15.5289778 10.8709333,15.0756444 L10.8709333,4.92453333 C10.8709333,4.46231111 10.4976,4.08897778 10.0353778,4.08897778" id="Fill-6"></path>
+            <path d="M14.6399111,10.9956444 C14.1776889,10.9956444 13.8043556,11.3689778 13.8043556,11.8312 L13.8043556,15.0756444 C13.8043556,15.5289778 14.1776889,15.9023111 14.6310222,15.9023111 C15.0932444,15.9023111 15.4665778,15.5289778 15.4665778,15.0756444 L15.4665778,11.8312 C15.4665778,11.3689778 15.0932444,10.9956444 14.6399111,10.9956444" id="Fill-8"></path>
+        </g>
+    </g>
+</svg>

data/vendor/assets/images/delete.svg

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="24px" height="24px" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <g id="Iconly/Bulk/Delete" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Delete" transform="translate(3.000000, 2.000000)" fill="currentColor" fill-rule="nonzero">
+            <path d="M16.6432894,7.4884379 C16.6432894,7.55643552 16.1103307,14.2971996 15.8059218,17.1341003 C15.6153015,18.8750394 14.492976,19.9310024 12.8094878,19.9610014 C11.5159931,19.9900003 10.2497298,20 9.00389021,20 C7.68121893,20 6.38772423,19.9900003 5.13215907,19.9610014 C3.50507888,19.9220027 2.38178085,18.8450404 2.2008861,17.1341003 C1.88772423,14.2871999 1.36449103,7.55643552 1.35476551,7.4884379 C1.34503998,7.28344508 1.41117355,7.0884519 1.54538578,6.93045743 C1.67765291,6.78446254 1.86827318,6.69646562 2.06861898,6.69646562 L15.9391614,6.69646562 C16.1385347,6.69646562 16.3194294,6.78446254 16.4623946,6.93045743 C16.5956343,7.0884519 16.6627404,7.28344508 16.6432894,7.4884379" id="Fill-1" opacity="0.400000006"></path>
+            <path d="M18,3.97686081 C18,3.56587519 17.67614,3.24388646 17.2871191,3.24388646 L14.371407,3.24388646 C13.77815,3.24388646 13.2626972,2.82190123 13.1304301,2.22692206 L12.9670413,1.49794757 C12.7384915,0.616978406 11.9497515,-1.50990331e-14 11.0647288,-1.50990331e-14 L6.93624379,-1.50990331e-14 C6.04149557,-1.50990331e-14 5.26053598,0.616978406 5.0232332,1.54594589 L4.87054247,2.22792202 C4.73730279,2.82190123 4.22185001,3.24388646 3.62956559,3.24388646 L0.713853469,3.24388646 C0.323859952,3.24388646 0,3.56587519 0,3.97686081 L0,4.35684751 C0,4.75783348 0.323859952,5.08982186 0.713853469,5.08982186 L17.2871191,5.08982186 C17.67614,5.08982186 18,4.75783348 18,4.35684751 L18,3.97686081 Z" id="Fill-4"></path>
+        </g>
+    </g>
+</svg>

data/vendor/assets/images/graph.svg

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="24px" height="24px" viewBox="0 0 24 24" version="1.1" xmlns="http://www.w3.org/2000/svg">
+  <g id="Iconly/Bulk/Graph" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+    <g id="Graph" transform="translate(2.000000, 2.000000)" fill="currentColor" fill-rule="nonzero">
+      <path d="M8.152754,3.55552761 C8.20368413,3.65919399 8.237323,3.77020981 8.2523868,3.88433813 L8.53082191,8.02425688 L8.53082191,8.02425688 L8.66903307,10.1050779 C8.67046167,10.3190591 8.7040335,10.5316649 8.76866587,10.7360386 C8.9355965,11.1325559 9.33716333,11.3845716 9.77405142,11.3669994 L16.4313342,10.9315476 C16.7196104,10.9267943 16.9980001,11.0346143 17.2052401,11.2312807 C17.3779401,11.3951693 17.4894372,11.6095651 17.524563,11.8401601 L17.5363525,11.9801866 C17.260866,15.7948982 14.4591587,18.9766559 10.6523561,19.797994 C6.84555351,20.6193322 2.94186389,18.8842999 1.06070995,15.534895 C0.518387516,14.5618191 0.179650312,13.4922526 0.0643819183,12.388978 C0.0162285779,12.0623771 -0.00497451535,11.7324952 0.000979225624,11.4025464 C-0.00496594783,7.31273376 2.90747021,3.77695779 6.98433295,2.92456686 C7.47500829,2.84816493 7.95602805,3.10792111 8.152754,3.55552761 Z"
+            id="Path"></path>
+      <path d="M10.8700123,0.000819186003 C15.42989,0.11682655 19.2623146,3.39578782 20,7.81229094 L19.9929553,7.84487576 L19.9929553,7.84487576 L19.9728274,7.89227188 L19.9756317,8.0223616 C19.9651826,8.19471218 19.8986437,8.36053991 19.7839681,8.49448471 C19.6645145,8.63401054 19.5013145,8.72903004 19.3215929,8.76590816 L19.2119951,8.78094898 L11.5312118,9.27860816 C11.2757261,9.30380455 11.0213466,9.22142251 10.8313499,9.05195453 C10.6730193,8.91073121 10.5717997,8.72009233 10.543203,8.5146766 L10.0276622,0.845062436 C10.0186901,0.819128783 10.0186901,0.791015148 10.0276622,0.765081496 C10.0347061,0.553672114 10.127765,0.353839855 10.2860482,0.210229821 C10.4443315,0.0666197874 10.6546487,-0.00880036929 10.8700123,0.000819186003 Z"
+            id="Path" opacity="0.400000006"></path>
+    </g>
+  </g>
+</svg>