rails_mini_profiler 0.1.0

data/app/views/rails_mini_profiler/profiled_requests/shared/_trace.html.erb

@@ -0,0 +1,40 @@
+<li class="trace <%= trace.type %>">
+  <span class="trace-name " style="width: calc(calc(<%= trace.from_start_percent %>% * .9) + 10%)"><%= trace.label %></span>
+  <div class="trace-bar" style="width: max(calc(<%= trace.duration_percent %>% * .9), 5px)">
+    <div class="popover">
+      <section class="popover-header">
+        <h1 class="popover-description"><%= trace.description %></h1>
+        <button class="popover-close">x</button>
+      </section>
+      <section class="popover-body">
+        <%= trace.payload %>
+        <table class="trace-table">
+          <thead>
+          <tr>
+            <th class="text-left"></th>
+            <th class="text-right">Response Time</th>
+            <th class="text-right">Allocations</th>
+          </tr>
+          </thead>
+          <tbody>
+          <tr>
+            <td>Total</td>
+            <td class="text-right"><%= trace.duration %>ms</td>
+            <td class="text-right"><%= trace.allocations %></td>
+          </tr>
+          <tr>
+            <td>Relative</td>
+            <td class="text-right"><%= trace.duration_percent %>%</td>
+            <td class="text-right"><%= trace.allocations_percent %>%</td>
+          </tr>
+        </table>
+      </section>
+
+      <% if trace.backtrace %>
+        <section class="popover-footer">
+          <pre><%= trace.backtrace %></pre>
+        </section>
+      <% end %>
+    </div>
+  </div>
+</li>

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

@@ -0,0 +1,40 @@
+<section class="request-details">
+  <h1> <%= @profiled_request.request_path %> </h1>
+
+  <ul class="request-details-data">
+    <li class="data-item">
+      <small>Method</small>
+      <span class="pill request-method request-method-<%= @profiled_request.request_method %>"><%= @profiled_request.request_method %></span>
+    </li>
+    <li class="data-item">
+      <small>Status</small>
+      <span class="pill request-status request-status-<%= @profiled_request.response_status %>"><%= @profiled_request.response_status %></span>
+    </li>
+    <li class="data-item">
+      <small>Response Time</small>
+      <span><%= @profiled_request.duration %>ms</span>
+    </li>
+    <li class="data-item">
+      <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>
+
+<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>

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

@@ -0,0 +1,8 @@
+<% flash.each do |type, message| %>
+  <% if type == "alert" %>
+    <div class="flash flash-error"><%= message %></div>
+  <% end %>
+  <% if type == "notice" %>
+    <div class="flash flash-notice"><%= message %></div>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,15 @@
+<header class="header">
+  <nav class="nav">
+    <a class="home" href="<%= profiled_requests_path %>">
+      <%= inline_svg_tag('rails_mini_profiler/logo', class: 'home-logo') %>
+      <h1 class="home-title">Rails Mini Profiler </h1>
+    </a>
+    <ul class="header-links">
+      <li>
+        <a href="https://github.com/hschne/rails-mini-profiler#rails-mini-profiler">
+          Docs
+        </a>
+      </li>
+    </ul>
+  </nav>
+</header>

data/config/routes.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RailsMiniProfiler::Engine.routes.draw do
+  root 'profiled_requests#index'
+  resources :profiled_requests, only: %i[index show destroy] do
+    collection do
+      delete 'destroy_all'
+    end
+  end
+  resources :flamegraphs, only: %i[show]
+end

data/db/migrate/20210621185018_create_rmp.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class CreateRmp < ActiveRecord::Migration[6.0]
+  def change
+    create_table :rmp_profiled_requests do |t|
+      t.string :user_id
+      t.integer :start
+      t.integer :finish
+      t.integer :duration
+      t.integer :allocations
+      t.string :request_path
+      t.string :request_query_string
+      t.string :request_method
+      t.json :request_headers
+      t.text :request_body
+      t.integer :response_status
+      t.text :response_body
+      t.json :response_headers
+      t.string :response_media_type
+
+      t.timestamps
+    end
+
+    create_table :rmp_traces do |t|
+      t.belongs_to :rmp_profiled_request, null: false, foreign_key: true
+      t.string :name
+      t.integer :start
+      t.integer :finish
+      t.integer :duration
+      t.integer :allocations
+      t.json :payload
+      t.json :backtrace
+
+      t.timestamps
+    end
+
+    create_table :rmp_flamegraphs do |t|
+      t.belongs_to :rmp_profiled_request, null: false, foreign_key: true
+      t.binary :data
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/rails_mini_profiler/USAGE

@@ -0,0 +1,2 @@
+description:
+    Enable rails-mini-profiler in development for your application.

data/lib/generators/rails_mini_profiler/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      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')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+RailsMiniProfiler.configure do |config|
+  # Customize when Rails Mini Profiler should run
+  # config.enabled = proc { |env| Rails.env.development? || request.headers[RMP_ENABLED].present? }
+
+  # Disable Flamegraph generation
+  # config.flamegraph_enabled = false
+
+  # Use RailsMiniProfiler::Storage::ActiveRecord to store profiles in your Database
+  config.storage = RailsMiniProfiler::Storage::Memory
+
+  # Uncomment to customize how users are detected
+  # config.user_provider = proc { |env| Rack::Request.new(env).ip }
+end

data/lib/rails_mini_profiler.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'inline_svg'
+
+require 'rails_mini_profiler/version'
+require 'rails_mini_profiler/engine'
+
+require 'rails_mini_profiler/errors'
+
+require 'rails_mini_profiler/user'
+require 'rails_mini_profiler/request_context'
+
+require 'rails_mini_profiler/models/base_model'
+require 'rails_mini_profiler/models/trace'
+
+require 'rails_mini_profiler/logger'
+require 'rails_mini_profiler/configuration'
+require 'rails_mini_profiler/storage'
+require 'rails_mini_profiler/request_wrapper'
+require 'rails_mini_profiler/response_wrapper'
+require 'rails_mini_profiler/guard'
+require 'rails_mini_profiler/flamegraph_guard'
+require 'rails_mini_profiler/redirect'
+require 'rails_mini_profiler/badge'
+require 'rails_mini_profiler/tracers'
+require 'rails_mini_profiler/middleware'
+
+module RailsMiniProfiler
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def storage_configuration
+      configuration.storage.configuration
+    end
+
+    def logger
+      @logger ||= configuration.logger
+    end
+
+    def authorize!(current_user)
+      RailsMiniProfiler::User.current_user = current_user
+    end
+
+    def current_user=(current_user)
+      RailsMiniProfiler::User.current_user = current_user
+    end
+  end
+end

data/lib/rails_mini_profiler/badge.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  class Badge
+    include InlineSvg::ActionView::Helpers
+    include Engine.routes.url_helpers
+
+    def initialize(request_context, configuration: RailsMiniProfiler.configuration)
+      @configuration = configuration
+      @profiled_request = request_context.profiled_request
+      @original_response = request_context.response
+    end
+
+    def render
+      content_type = @original_response.headers['Content-Type']
+      return @original_response unless content_type =~ %r{text/html}
+
+      modified_response = Rack::Response.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)
+
+      ResponseWrapper.new(@original_response.status,
+                          @original_response.headers,
+                          modified_response)
+    end
+
+    private
+
+    def modified_body
+      body = @original_response.response.body
+      index = body.rindex(%r{</body>}i) || body.rindex(%r{</html>}i)
+      if index
+        body.dup.insert(index, badge_content)
+      else
+        body
+      end
+    end
+
+    def badge_content
+      html = IO.read(File.expand_path('../../app/views/rails_mini_profiler/badge.html.erb', __dir__))
+      @position = css_position
+      template = ERB.new(html)
+      template.result(binding)
+    end
+
+    def css_position
+      case RailsMiniProfiler.configuration.badge_position
+      when 'top-right'
+        'top: 5px; right: 5px;'
+      when 'bottom-left'
+        'bottom: 5px; left: 5px;'
+      when 'bottom-right'
+        'bottom: 5px; right: 5px;'
+      else
+        'top: 5px; left: 5px;'
+      end
+    end
+  end
+end

data/lib/rails_mini_profiler/configuration.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  class Configuration
+    attr_reader :logger
+
+    attr_accessor :enabled,
+                  :badge_enabled,
+                  :badge_position,
+                  :flamegraph_enabled,
+                  :flamegraph_sample_rate,
+                  :skip_paths,
+                  :storage,
+                  :user_provider
+
+    def initialize(**kwargs)
+      reset
+      kwargs.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+    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
+      @user_provider = proc { |env| Rack::Request.new(env).ip }
+    end
+
+    def logger=(logger)
+      if logger.nil?
+        @logger.level = Logger::FATAL
+      else
+        @logger = logger
+      end
+    end
+  end
+end

data/lib/rails_mini_profiler/engine.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsMiniProfiler
+
+    initializer 'rails_mini_profiler.add_middleware' do |app|
+      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
+
+    initializer 'rails_mini_profiler_add_static assets' do |app|
+      app.middleware.insert_before(ActionDispatch::Static, ActionDispatch::Static, "#{root}/public")
+    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/flamegraph_guard.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RailsMiniProfiler
+  class FlamegraphGuard
+    def initialize(request_context, configuration: RailsMiniProfiler.configuration)
+      @request_context = request_context
+      @request = request_context.request
+      @configuration = configuration
+    end
+
+    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
+
+      unless flamegraph
+        RailsMiniProfiler.logger.error('Failed to record Flamegraph, possibly due to concurrent requests')
+        return result
+      end
+
+      @request_context.flamegraph = flamegraph.to_json
+      result
+    end
+
+    private
+
+    def enabled?
+      defined?(StackProf) && StackProf.respond_to?(:run) && config_enabled?
+    end
+
+    def config_enabled?
+      params = CGI.parse(@request.query_string).transform_values(&:first).with_indifferent_access
+      return params[:rmp_flamegraph] if params[:rmp_flamegraph]
+
+      RailsMiniProfiler.configuration.flamegraph_enabled
+    end
+  end
+end