rails_mini_profiler 0.1.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5967d57f7e1091612b43ac198023ec78af212efd45039cdfd70e9c1cfc030422
-  data.tar.gz: 5c3e03fd7ef6f6317c95618b3c01d6b0113c09749971e95bebb68bb3ad22bf1a
+  metadata.gz: 33db210bbcb4b8ee82f80aa2f88023a478ec4852e9bbcc60cf9f70baf2a0145f
+  data.tar.gz: aed097f8f0e418feea8ce2670f173271bea7dd1f8803e542c2f50b82b953932d
 SHA512:
-  metadata.gz: 3e8ab13ca5a216ce467d853bfe65cbed989286b290c40d930eeb913594630779e57584dc8526bb93985b84478ceac48a2867d1c80182a501e9c2e5f312bc98b5
-  data.tar.gz: cff4e83fefaabb3c1d7db55e03d2a4353b3a3ded37f17a96dcf189c549df98c403c182579822602023c70aee6495d9366a9f0351a275e53aea4af2fcce573dfd
+  metadata.gz: a6cc1c0d0e05949bb360d4e5d04091bcfb16419a80ca31361d617a1a34571d28dfc33f31820075646143b9a359b12aa66c9ec67bb859bbdc25feaca062b5adb8
+  data.tar.gz: c6673b79dc6b8aacd205b5b368c1e044fb8b0e595fbb41371cf6f2c667fe31875cea9376ea551cb0e39a6c13c57cd654f41342b09bc4f41a1084a03092804fe9

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 hschne
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -8,7 +8,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/rails_mini_profiler.svg)](https://badge.fury.io/rb/rails_mini_profiler)
 [![Main](https://github.com/hschne/rails-mini-profiler/actions/workflows/main.yml/badge.svg)](https://github.com/hschne/rails-mini-profiler/actions/workflows/main.yml)
-[![Main](https://img.shields.io/github/license/hschne/rails-mini-profiler)](https://img.shields.io/github/license/hschne/rails-mini-profiler)
+[![License](https://img.shields.io/github/license/hschne/rails-mini-profiler)](https://img.shields.io/github/license/hschne/rails-mini-profiler)
 
 [![Maintainability](https://api.codeclimate.com/v1/badges/1fcc2f4d01ab5bf7a260/maintainability)](https://codeclimate.com/github/hschne/rails-mini-profiler/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/1fcc2f4d01ab5bf7a260/test_coverage)](https://codeclimate.com/github/hschne/rails-mini-profiler/test_coverage)
@@ -91,34 +91,36 @@ By clicking on individual traces you can find out detailed information.
 
 ### Flamegraphs
 
-Rails Mini Profiler per default records Flamegraphs for every profiled request for convenience. Note that Flamegraphs recording
-incur a significant performance penalty, and can take up a lot of space.
+Rails Mini Profiler automatically records Flamegraphs for profiled requests. To enable this feature, add [Stackprof](https://github.com/tmm1/stackprof)
+to your Gemfile: 
 
-To change the default behavior see [Configuration](#Configuration).
+```ruby
+gem 'stackprof'
+```
+
+For convenience, Flamegraphs are recorded for every request. This may incur a significant performance penalty. To change the default behavior see [Configuration](#Configuration).
 
-Flamegraphs are rendered using [Speedscope](https://github.com/jlfwong/speedscope). If Flamegraphs are not rendering
-you may have to amend your content security policy. See [Troubleshooting](#Troubleshooting)
+Flamegraphs are rendered using [Speedscope](https://github.com/jlfwong/speedscope). See [Troubleshooting](#Troubleshooting) if Flamegraphs are not rendering correctly.
 
 ## Configuration
 
-You can set the following configuration options in Rails Mini Profiler:
+Rails Mini Profiler provides a wide array of configuration options. You can find details below. For an example configuration check `initializers/rails_mini_profiler.rb` (or [the template file](https://github.com/hschne/rails-mini-profiler/blob/main/lib/generators/rails_mini_profiler/templates/rails_mini_profiler.rb.erb)).
 
-| Option                   | Default                      | Description                                                                                     |
-| ------------------------ | ---------------------------- | ----------------------------------------------------------------------------------------------- |
+| Name                     | Default                      | Description                                                                                     |
+|--------------------------|------------------------------|-------------------------------------------------------------------------------------------------|
 | `enabled`                | `true` (dev)/ `false` (prod) | Whether or not RMP is enabled                                                                   |
-| `badge_enabled`          | `true`                       | Should the hedgehog 🦔 badge be injected into pages?                                            |
-| `badge_position`         | `'top-left'`                 | Where to display the badge. Options are `'top-left', 'top-right', 'bottom-left, 'bottom-right'` |
 | `flamegraph_enabled`     | `true`                       | Should flamegraphs be recorded automatically?                                                   |
 | `flamegraph_sample_rate` | `0.5`                        | The flamegraph sample rate. How many snapshots per millisecond are created.                     |
 | `skip_paths`             | `[]`                         | An array of request paths that should not be profiled. Regex allowed.                           |
-| `storage`                | `Storage`                    | Storage configuration. See [Storage](#Storage)                                                  |
+| `storage`                | `Storage.new`                | Storage configuration. See [Storage](#Storage).                                                 |
+| `ui`                     | `UserInterface.new`          | UI configuration. See [UI](#UI).                                                                |
 | `user_provider`          | `Rack::Request.new(env).ip`  | How to identify users. See [Users](#Users)                                                      |
 
 ### Request Configuration
 
 You may override the configuration by sending request parameters. The following parameters are available:
 
-| Option           | Description                                                                                 |
+| Name           | Description                                                                                 |
 | ---------------- | ------------------------------------------------------------------------------------------- |
 | `rmp_flamegraph` | Overrides `flamegraph_enabled` If set to `true` will redirect to the flamegraph immediatly. |
 
@@ -127,7 +129,7 @@ You may override the configuration by sending request parameters. The following
 Rails Mini Profiler stores profiling information in your database per default. You can configure various details of how
 traces and requests are stored.
 
-| Configuration             | Default                 | Description                                                                                               |
+| Name                      | Default                 | Description                                                                                               |
 | ------------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------- |
 | `database`                | `nil`                   | Set a custom database to be used for storing profiler information. Uses `connect_to` for profiler records |
 | `profiled_requests_table` | `rmp_profiled_requests` | The table to be used to store profiled requests.                                                          |
@@ -136,7 +138,7 @@ traces and requests are stored.
 
 Rails Mini Profiler does not offer an automatic way to clean up old profiling information. It is recommended you add a sweeper job to clean up old profiled requests periodically (e.g. using [clockwork](https://github.com/adamwiggins/clockwork). For example, with ActiveJob:
 
-```
+```ruby
 # Clockwork
 every(1.month, 'purge rails mini profiler' do
     ProfiledRequestCleanupJob.perform_later
@@ -152,6 +154,16 @@ class ProfiledRequestCleanupJob < ApplicationJob
 end
 ```
 
+### UI
+
+Rails Mini Profiler allows you to configure various UI features. 
+
+| Name             | Default      | Description                                                                                     |
+|------------------|--------------|-------------------------------------------------------------------------------------------------|
+| `badge_enabled`  | `true`       | Should the hedgehog 🦔 badge be injected into pages?                                             |
+| `badge_position` | `'top-left'` | Where to display the badge. Options are `'top-left', 'top-right', 'bottom-left, 'bottom-right'` |
+| `page_size`      | `25`         | The page size for lists shown in the UI.                                                        |
+
 ### Users
 
 Profiling information is segregated by user ID. That means users cannot see each other's profiled requests.
@@ -166,8 +178,6 @@ You may also explicitly set the user from the application itself:
 
 ```ruby
 class ApplicationController < ActionController::Base
-  ...
-
   before_action do
     RailsMiniProfiler::User.authorize(current_user.id)
   end
@@ -214,7 +224,13 @@ As such, compared to `rack-mini-profiler`, it does not support non-Rails apps (e
 
 Rails Mini Profiler is in early development. As such, breaking changes may still be introduced on a regular basis. While Rails Mini Profiler is in pre-release we do not offer upgrade migrations.
 
-If an upgrade to Rails Mini Profiler breaks your application, we recommend that you drop the offending tables and re-run migrations for the latest version: 
+If an upgrade to Rails Mini Profiler breaks your application, we recommend that you clean house and start over. Re-run the initializer and overwrite existing files: 
+
+```bash
+rails rails_mini_profiler:install
+```
+
+If only the DB schema is out of date, drop the offending tables and re-run migrations for the latest version: 
 
 ```
 rails rails_mini_profiler:install:migrations
@@ -243,6 +259,14 @@ end
 
 **Note: Sprockets and flash are currently required for some of Rails Mini Profiler's UI features. These modifications may no longer be needed in the future.
 
+### No Flamegraphs are being recored?
+
+Make sure you have added [StackProf](https://github.com/tmm1/stackprof) to your Gemfile.
+
+```ruby
+gem 'stackprof'
+```
+
 ### Flamegraphs are not rendering?
 
 Flamegraphs are loaded into [Speedscope](https://github.com/jlfwong/speedscope) using an Iframe and URI Encoded blobs (see [source](https://github.com/hschne/rails-mini-profiler/blob/main/app/views/rails_mini_profiler/flamegraphs/show.html.erb))

data/app/assets/javascripts/rails_mini_profiler.js

@@ -12,79 +12,4 @@
 //
 //= require rails-ujs
 //= require_tree .
-
-function setupRequestSearch() {
-  const profiledRequestNameSearch = document.getElementById('profiled-request-search')
-  if (profiledRequestNameSearch) {
-    profiledRequestNameSearch.addEventListener('keyup', function (event) {
-      if (event.key === 'Enter') {
-        event.preventDefault()
-        document.getElementById('profiled-request-search-form').submit()
-      }
-    })
-  }
-}
-
-function setupTraceSearch() {
-  const traceNameSearch = document.getElementById('trace-search')
-  if (traceNameSearch) {
-    traceNameSearch.addEventListener('keyup', function (event) {
-      if (event.key === 'Enter') {
-        event.preventDefault()
-        document.getElementById('trace-form').submit()
-      }
-    })
-  }
-}
-
-function setupRequestTable() {
-  const profiledRequestTable = document.getElementById('profiled-requests-table');
-  if (profiledRequestTable) {
-    const rows = profiledRequestTable.getElementsByTagName('tr')
-    for (let i = 0; i < rows.length; i++) {
-      const currentRow = profiledRequestTable.rows[i]
-      const link = currentRow.dataset.link
-      const createClickHandler = function (currentRow) {
-        return function () {
-          window.location.href = link
-        }
-      }
-      currentRow.onclick = createClickHandler(currentRow)
-    }
-  }
-}
-
-function setupTraceBars () {
-  const traceBars = document.querySelectorAll('.trace-bar')
-  traceBars.forEach((bar) => {
-    const popover = bar.children[0]
-    tippy(bar, {
-      trigger: 'click',
-      content: popover,
-      theme: 'rmp',
-      maxWidth: '700px',
-      placement: 'bottom',
-      interactive: true,
-      onShow (instance) {
-        instance.popper.querySelector('.popover-close').addEventListener('click', () => {
-          instance.hide()
-        })
-      },
-      onHide (instance) {
-        instance.popper.querySelector('.popover-close').removeEventListener('click', () => {
-          instance.hide()
-        })
-      },
-    })
-  })
-}
-
-
-// Trace Bar Popovers
-document.addEventListener('DOMContentLoaded', () => {
-  setupRequestTable();
-  setupRequestSearch();
-  setupTraceBars();
-  setupTraceSearch();
-}, false)
-
+//= require rails-mini-profiler

data/app/assets/stylesheets/rails_mini_profiler/application.css

@@ -12,153 +12,5 @@
  *
  *= require_tree .
  *= require_self
+ *= require rails-mini-profiler
  */
-
-html {
-  width: 100%;
-  height: 100%;
-  margin: 0;
-  padding: 0;
-
-  --grey-50: #F9FAFB;
-  --grey-100: #F3F4F6;
-  --grey-200: #E5E7EB;
-  --grey-400: #9CA3AF;
-  --grey-500: #6B7280;
-  --grey-700: #374151;
-  --grey-900: #111827;
-
-  --red-400: #F87171;
-  --red-500: #EF4444;
-  --red-600: #DC2626;
-
-  --yellow-400: #FBBF24;
-  --yellow-500: #F59E0B;
-
-  --green-300: #6EE7B7;
-  --green-400: #34D399;
-  --green-500: #10B981;
-
-  --blue-400: #60A5FA;
-  --blue-500: #3B82F6;
-
-  --main-width: 1056px;
-
-  --primary: var(--red-600);
-
-  --border-color: var(--grey-200);
-  --text-color: var(--grey-900);
-
-  font-family: 'Open Sans', sans-serif;
-}
-
-body {
-  width: 100%;
-  height: 100%;
-  margin: 0;
-  padding: 0;
-
-  color: var(--text-color)
-}
-
-h1 {
-  padding: 2rem 0 1rem;
-}
-
-button {
-  border: none;
-  border-radius: .25rem;
-  padding: 0.5em .5em;
-  text-align: center;
-  text-decoration: none;
-  display: inline-block;
-  font-size: 1rem;
-  cursor: pointer;
-}
-
-button:hover {
-  box-shadow: 0 .25rem .25rem 0 var(--grey-50);
-}
-
-/* --------------------------------------- */
-
-.text-left {
-  text-align: left;
-}
-
-.text-right {
-  text-align: right;
-}
-
-/* --------------------------------------- */
-
-.pill {
-  margin: .2rem 0;
-  padding: .1rem .4rem;
-  border-radius: 5px;
-
-  font-size: .9rem;
-  font-weight: 600;
-  letter-spacing: .1rem;
-
-  background: var(--grey-200);
-}
-
-/* --------------------------------------- */
-
-.popover {
-  display: flex;
-  flex-direction: column;
-  width: 600px;
-  padding: 1em;
-  color: black;
-}
-
-.popover-header {
-  display: flex;
-  padding-bottom: 1em;
-  flex-direction: row;
-  justify-content: space-between;
-  align-items: center;
-}
-
-.popover-description {
-  margin: 0;
-  padding: 0;
-}
-
-.popover-close {
-  background: transparent;
-  padding: 0;
-  font-weight: 700;
-  font-size: 20px;
-  color: var(--grey-400);
-}
-
-.popover-body {
-  padding: 1em 0;
-}
-
-.popover-footer {
-  border-top: 1px solid var(--grey-50);
-}
-
-.tippy-box[data-theme~='rmp'] {
-  background: white;
-  box-shadow: 8px 0 30px 4px rgba(0, 0, 0, .2), 8px 4px 10px 0 rgba(0, 0, 0, .05);
-  border-radius: 3px;
-
-  transition: all cubic-bezier(.19,1,.22,1) .2s;
-}
-.tippy-box[data-theme~='rmp'][data-placement^='top'] > .tippy-arrow::before {
-  border-top-color: white;
-}
-.tippy-box[data-theme~='rmp'][data-placement^='bottom'] > .tippy-arrow::before {
-  border-bottom-color: white;
-}
-.tippy-box[data-theme~='rmp'][data-placement^='left'] > .tippy-arrow::before {
-  border-left-color: white;
-}
-.tippy-box[data-theme~='rmp'][data-placement^='right'] > .tippy-arrow::before {
-  border-right-color: white;
-}

data/app/controllers/rails_mini_profiler/application_controller.rb

@@ -2,7 +2,9 @@
 
 module RailsMiniProfiler
   class ApplicationController < ActionController::Base
-    rescue_from ActiveRecord::RecordNotFound, with: :not_found
+    include Pagy::Backend
+
+    rescue_from ActiveRecord::RecordNotFound, with: ->(error) { handle(error, 404) }
 
     before_action :check_current_user
 
@@ -17,8 +19,11 @@ module RailsMiniProfiler
 
     private
 
-    def not_found(error)
-      redirect_back(fallback_location: profiled_requests_path, alert: error.to_s)
+    def handle(error, status = 500)
+      respond_to do |format|
+        format.html { redirect_back(fallback_location: profiled_requests_path, alert: error.to_s) }
+        format.json { render status: status, json: { message: error.to_s } }
+      end
     end
 
     def check_current_user

data/app/controllers/rails_mini_profiler/profiled_requests_controller.rb

@@ -11,12 +11,13 @@ module RailsMiniProfiler
                              .includes(:flamegraph)
                              .where(user_id: user_id).order(id: :desc)
       @profiled_requests = @profiled_requests.where('request_path LIKE ?', "%#{params[:path]}%") if params[:path]
+      @pagy, @profiled_requests = pagy(@profiled_requests, items: configuration.ui.page_size)
       @profiled_requests = @profiled_requests.map { |request| present(request) }
     end
 
     def show
       @traces = @profiled_request.traces
-      @traces = @traces.where('payload LIKE ?', "%#{params[:search]}%") if params[:search]
+      @traces = @traces.where("#{payload_column} LIKE ?", "%#{params[:search]}%") if params[:search]
       @traces = @traces
                   .order(:start)
                   .map { |trace| present(trace, profiled_request: @profiled_request) }
@@ -51,5 +52,14 @@ module RailsMiniProfiler
     def configuration
       @configuration ||= RailsMiniProfiler.configuration
     end
+
+    def payload_column
+      if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+        # Cast json field to text to have access to the LIKE operator
+        'payload::text'
+      else
+        'payload'
+      end
+    end
   end
 end