rails_mini_profiler 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68745f57dfbd4c05a60722a699c377ec8b5eb6f101edc3259bec8134f3b8078e
-  data.tar.gz: c28c669797fb80f92590a9b7574878c59bc0050c415b939d14936c2caf7127d1
+  metadata.gz: 0024a0bf06919b656615d69145f2f68cbd18cca28a1ff1358aa0a06ab0bf2955
+  data.tar.gz: 9d3eb7af567564dc6458125cde850d8dd5db1117e50b4bf298bc07024f2cc533
 SHA512:
-  metadata.gz: 8c2a6559821ce43c54dd30f1f8c396734b2f8d2559b81802553a31197f7a1cdafbd7ee25756f59ea51e3b6aa4685a6184a9b8972bdc3b761e7ac4b6261724ee2
-  data.tar.gz: 34af332d02f3e9a7de68e74a3f900b8c58c57bed9f7fcb37b4c7125e9086c57d446885d8778755d92bddcbb10cd8b5e3393c066877ca9844cffec9e712a82506
+  metadata.gz: 7c24ccb1d9c71acc7fa565f51d3832844e78969438080d5f849ca79734b9cbe77be0de055067f077ed07ec6f5a5d85d6e0a9ab8906adb361b126ac07bd4aa9ab
+  data.tar.gz: 9a440fb88d0066f1caf5d89115c1e3479dfa44bf01fe0b617f79ddc87a6ddba80365ca02a39d9154b101fc479dd3255d01ba34a6f0939ab68274a4a9390a3f68

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,17 +91,20 @@ 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                                                                                     |
 | ------------------------ | ---------------------------- | ----------------------------------------------------------------------------------------------- |
@@ -136,7 +139,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
@@ -166,8 +169,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
@@ -221,6 +222,36 @@ rails rails_mini_profiler:install:migrations
 rails db:migrate
 ```
 
+### Support for API-Only Apps
+
+Rails Mini Profiler supports API-only apps, but you have to make some small adjustments to use it. At the top of `application.rb` add [Sprockets](https://github.com/rails/sprockets-rails):
+
+```
+require "sprockets/railtie"
+```
+
+Then, modify `application.rb`:
+
+```
+module ApiOnly
+  class Application < Rails::Application
+    
+    config.api_only = true # Either set this to false
+    config.middleware.use ActionDispatch::Flash # Or add this
+  end
+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/fonts/rails_mini_profiler/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/app/assets/javascripts/rails_mini_profiler.js

@@ -12,6 +12,8 @@
 //
 //= require rails-ujs
 //= require_tree .
+//= require popper
+//= require tippy
 
 function setupRequestSearch() {
   const profiledRequestNameSearch = document.getElementById('profiled-request-search')

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

@@ -14,6 +14,27 @@
  *= require_self
  */
 
+@font-face {
+  font-family: 'Open Sans';
+  font-weight: 400;
+  font-style: normal;
+  src: url('OpenSans-Regular.ttf') format("truetype");
+}
+
+@font-face {
+   font-family: 'Open Sans';
+   font-weight: 600;
+  font-style: normal;
+   src: url('OpenSans-SemiBold.ttf') format("truetype");
+}
+
+@font-face {
+  font-family: 'Open Sans';
+  font-weight: 700;
+  font-style: normal;
+  src: url('OpenSans-Bold.ttf') format("truetype");
+}
+
 html {
   width: 100%;
   height: 100%;
@@ -49,7 +70,8 @@ html {
   --border-color: var(--grey-200);
   --text-color: var(--grey-900);
 
-  font-family: 'Open Sans', sans-serif;
+  font-family: 'Open Sans', monospace;
+
 }
 
 body {

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

@@ -71,7 +71,7 @@
 
 .sequel-trace-binds {
   margin: 0 0 1em 0;
-  padding: .5em 0;
+  padding: .5em 1em;
   font-size: 12px;
   overflow: auto;
   max-height: 100px;

data/app/controllers/rails_mini_profiler/application_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RailsMiniProfiler
-  class ApplicationController < ::ApplicationController
+  class ApplicationController < ActionController::Base
     rescue_from ActiveRecord::RecordNotFound, with: :not_found
 
     before_action :check_current_user

data/app/models/rails_mini_profiler/application_record.rb

@@ -3,7 +3,7 @@
 module RailsMiniProfiler
   class ApplicationRecord < ActiveRecord::Base
     if RailsMiniProfiler.storage_configuration.database.present?
-      establish_connection(RailsMiniProfiler.storage_configuration.database.present?)
+      establish_connection(RailsMiniProfiler.storage_configuration.database)
     end
 
     self.abstract_class = true

data/app/views/layouts/rails_mini_profiler/application.html.erb

@@ -7,10 +7,6 @@
 
   <%= javascript_include_tag "rails_mini_profiler" %>
   <%= stylesheet_link_tag "rails_mini_profiler/application", media: "all" %>
-  <link rel="preconnect" href="https://fonts.gstatic.com">
-  <script src="https://unpkg.com/@popperjs/core@2"></script>
-  <script src="https://unpkg.com/tippy.js@6"></script>
-  <link href="https://fonts.googleapis.com/css2?family=Open+Sans:ital,wght@0,300;0,400;0,600;0,700;0,800;1,300;1,400;1,600;1,700;1,800&display=swap" rel="stylesheet">
 </head>
 <body>
 

data/lib/generators/rails_mini_profiler/install_generator.rb

@@ -1,10 +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'")

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

@@ -1,13 +1,24 @@
 RailsMiniProfiler.configure do |config|
   # Customize when Rails Mini Profiler should run
-  # config.enabled = proc { |env| Rails.env.development? || request.headers[RMP_ENABLED].present? }
+  config.enabled = proc { |env| Rails.env.development? || env['HTTP_RMP_ENABLED'].present? }
 
-  # Disable Flamegraph generation
-  # config.flamegraph_enabled = false
+  # Configure how hedgehog badge is rendered
+  config.badge_enabled = true
+  # config.badge_position = 'top-left'
 
-  # Use RailsMiniProfiler::Storage::ActiveRecord to store profiles in your Database
-  config.storage = RailsMiniProfiler::Storage
+  # Configure Flamegraph generation
+  config.flamegraph_enabled = true
+  # config.flamegraph_sample_rate = 0.5
 
-  # Uncomment to customize how users are detected
-  # config.user_provider = proc { |env| Rack::Request.new(env).ip }
+  # Configure endpoints to profile
+  config.skip_paths = []
+
+  # 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
+
+  # Customize how users are detected
+  config.user_provider = proc { |env| Rack::Request.new(env).ip }
 end