rack-mini-profiler 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cde7281c7a63d3d3ac5bc7605ba2cf81dedf6b598ff17ed568610a54a50b517f
-  data.tar.gz: 7af763d5136493c71cc4321fe54db79372e5b9aaac4c10d31bc2f27d22f324b7
+  metadata.gz: 7544df4d22f5f615b146fb0d63f18098ffd702ac9dec966d8040187f2e8302b9
+  data.tar.gz: 7c39c41a96205c8c7fbd69765ab5f1e0a3a3a37950055fc58d0f27f4a0591e0f
 SHA512:
-  metadata.gz: abb415f975552a1256753e15ba9d6623aeb55fe4b058c775701f2b7d3a955f62d2a906a93929f1a22545f8558750d48c78f3b7e185f774c224d12e6a256a69a6
-  data.tar.gz: f5ff03170537e5dc17a826909d9b77609bc8d6f2390f42b29be9ff1af538332eaa33c269f7433d87142ba7e05315741b3ea5b4c69fcc76980a56c225338d843c
+  metadata.gz: 6e3f5f9a51fc5395dda4a7e793903f998513499d850aeb291fe036171a78617d11c3d8cd6fef57d1144359aa4992055ad54ba878075896c3d0280c426a84e3be
+  data.tar.gz: c4e353c8442db93f29d11d04e2724e6c3f8dacaaf082210acbbb7d47655ffc3a6b5297079750e305fe9f1cd3e7efb1d806aef0ec68bbc1a8e40a0f958de0ec52

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 3.1.0 - 2023-04-11
+
+- [FEATURE] The query parameter that RMP uses (by default, pp) is now configurable [#553](https://github.com/MiniProfiler/rack-mini-profiler/pull/553)
+- [FEATURE] You can now opt-out of the Net::HTTP patch by using RACK_MINI_PROFILER_PATCH_NET_HTTP="false"
+- [FIX] Error responses now include header values from the app, and stackprof not installed message now has correct content [#547](https://github.com/MiniProfiler/rack-mini-profiler/pull/547)
+- [FIX] RMP pages now have more valid HTML, with title elements [#562](https://github.com/MiniProfiler/rack-mini-profiler/pull/562)
+- [BREAKING CHANGE] Ruby 2.4 and Ruby 2.5 are no longer supported.
+- [FIX] Now works with apps that don't otherwise require erb [#531](https://github.com/MiniProfiler/rack-mini-profiler/pull/531)
+- [DOCS] Added Heroku Redis instructions
+- [DEPRECATION] We are changing the name of the generators to `rack_mini_profiler`, e.g. `rack_mini_profiler:install` [#550](https://github.com/MiniProfiler/rack-mini-profiler/pull/550)
+
 ## 3.0.0 - 2022-02-24
 
 - PERF: Improve snapshots page performance (#518) (introduces breaking changes to the API of `AbstractStore`, `MemoryStore` and `RedisStore`, and removes the `snapshots_limit` config option.)

data/README.md

@@ -1,6 +1,8 @@
 # rack-mini-profiler
 
-Middleware that displays speed badge for every html page. Designed to work both in production and in development.
+Middleware that displays speed badge for every HTML page, along with (optional) flamegraphs and memory profiling. Designed to work both in production and in development.
+
+![Screenshot 2023-04-05 at 3 13 52 PM](https://user-images.githubusercontent.com/845662/229996538-0f2d9c48-23d9-4d53-a1de-8b4c84c87fbd.png)
 
 #### Features
 
@@ -27,7 +29,7 @@ If you feel like taking on any of this start an issue and update us on your prog
 
 ## Installation
 
-Install/add to Gemfile in Ruby 2.4+
+Install/add to Gemfile in Ruby 2.6+
 
 ```ruby
 gem 'rack-mini-profiler'
@@ -101,7 +103,7 @@ be loaded outright, and an attempt to re-initialize it manually will raise an ex
 Then run the generator which will set up rack-mini-profiler in development:
 
 ```bash
-bundle exec rails g rack_profiler:install
+bundle exec rails g rack_mini_profiler:install
 ```
 
 #### Rack Builder
@@ -164,11 +166,19 @@ export RACK_MINI_PROFILER_PATCH="false"
 # initializers/rack_profiler.rb: SqlPatches.patch %w(mongo)
 ```
 
+#### Patching Net::HTTP
+
+Other than databases, `rack-mini-profiler` applies a patch to `Net::HTTP`. You may want to disable this patch:
+
+```bash
+export RACK_MINI_PROFILER_PATCH_NET_HTTP="false"
+```
+
 ### Flamegraphs
 
 To generate [flamegraphs](http://samsaffron.com/archive/2013/03/19/flame-graphs-in-ruby-miniprofiler), add the [**stackprof**](https://rubygems.org/gems/stackprof) gem to your Gemfile.
 
-Then, to view the flamegraph as a direct HTML response from your request, just visit any page in your app with `?pp=flamegraph` appended to the URL. 
+Then, to view the flamegraph as a direct HTML response from your request, just visit any page in your app with `?pp=flamegraph` appended to the URL.
 
 Conversely, if you want your regular response instead (which is specially useful for JSON and/or XHR requests), just append the `?pp=async-flamegraph` parameter to your request/fetch URL; the request will then return as normal, and the flamegraph data will be stored for later *async* viewing, both for this request and for all subsequent requests made by this page (based on the `REFERER` header). For viewing these async flamegraphs, use the 'flamegraph' link that will appear inside the MiniProfiler UI for these requests.
 
@@ -406,39 +416,40 @@ Rack::MiniProfiler.config.start_hidden = true
 ```
 The available configuration options are:
 
-Option|Default|Description
--------|---|--------
-pre_authorize_cb|Rails: dev only<br>Rack: always on|A lambda callback that returns true to make mini_profiler visible on a given request.
-position|`'top-left'`|Display mini_profiler on `'top-right'`, `'top-left'`, `'bottom-right'` or `'bottom-left'`.
-skip_paths|`[]`|An array of paths that skip profiling. Both `String` and `Regexp` are acceptable in the array.
-skip_schema_queries|Rails dev: `true`<br>Othwerwise: `false`|`true` to skip schema queries.
-auto_inject|`true`|`true` to inject the miniprofiler script in the page.
-backtrace_ignores|`[]`|Regexes of lines to be removed from backtraces.
-backtrace_includes|Rails: `[/^\/?(app\|config\|lib\|test)/]`<br>Rack: `[]`|Regexes of lines to keep in backtraces.
-backtrace_remove|rails: `Rails.root`<br>Rack: `nil`|A string or regex to remove part of each line in the backtrace.
-toggle_shortcut|Alt+P|Keyboard shortcut to toggle the mini_profiler's visibility. See [jquery.hotkeys](https://github.com/jeresig/jquery.hotkeys).
-start_hidden|`false`|`false` to make mini_profiler visible on page load.
-backtrace_threshold_ms|`0`|Minimum SQL query elapsed time before a backtrace is recorded.
-flamegraph_sample_rate|`0.5`|How often to capture stack traces for flamegraphs in milliseconds.
-flamegraph_mode|`:wall`|The [StackProf mode](https://github.com/tmm1/stackprof#all-options) to pass to `StackProf.run`.
-base_url_path|`'/mini-profiler-resources/'`|Path for assets; added as a prefix when naming assets and sought when responding to requests.
-cookie_path|`'/'`|Set-Cookie header path for profile cookie
-collapse_results|`true`|If multiple timing results exist in a single page, collapse them till clicked.
-max_traces_to_show|20|Maximum number of mini profiler timing blocks to show on one page
-html_container|`body`|The HTML container (as a jQuery selector) to inject the mini_profiler UI into
-show_total_sql_count|`false`|Displays the total number of SQL executions.
-enable_advanced_debugging_tools|`false`|Enables sensitive debugging tools that can be used via the UI. In production we recommend keeping this disabled as memory and environment debugging tools can expose contents of memory that may contain passwords. Defaults to `true` in development.
-assets_url|`nil`|See the "Register MiniProfiler's assets in the Rails assets pipeline" section above.
-snapshot_every_n_requests|`-1`|Determines how frequently snapshots are taken. See the "Snapshots Sampling" above for more details.
-max_snapshot_groups|`50`|Determines how many snapshot groups Mini Profiler is allowed to keep.
-max_snapshots_per_group|`15`|Determines how many snapshots per group Mini Profiler is allowed to keep.
-snapshot_hidden_custom_fields|`[]`|Each snapshot custom field will have a dedicated column in the UI by default. Use this config to exclude certain custom fields from having their own columns.
-snapshots_transport_destination_url|`nil`|Set this config to a valid URL to enable snapshots transporter which will `POST` snapshots to the given URL. The transporter requires `snapshots_transport_auth_key` config to be set as well.
-snapshots_transport_auth_key|`nil`|`POST` requests made by the snapshots transporter to the destination URL will have a `Mini-Profiler-Transport-Auth` header with the value of this config. Make sure you use a secure and random key for this config.
-snapshots_redact_sql_queries|`true`|When this is true, SQL queries will be redacted from sampling snapshots, but the backtrace and duration of each SQL query will be saved with the snapshot to keep debugging performance issues possible.
-snapshots_transport_gzip_requests|`false`|Make the snapshots transporter gzip the requests it makes to `snapshots_transport_destination_url`.
-content_security_policy_nonce|Rails: Current nonce<br>Rack: nil|Set the content security policy nonce to use when inserting MiniProfiler's script block.
-enable_hotwire_turbo_drive_support| `false` | Enable support for Hotwire TurboDrive page transitions.
+Option                              | Default                                                 | Description
+------------------------------------|---------------------------------------------------------|------------------------
+pre_authorize_cb                    | Rails: dev only<br>Rack: always on                      | A lambda callback that returns true to make mini_profiler visible on a given request.
+position                            | `'top-left'`                                            | Display mini_profiler on `'top-right'`, `'top-left'`, `'bottom-right'` or `'bottom-left'`.
+skip_paths                          | `[]`                                                    | An array of paths that skip profiling. Both `String` and `Regexp` are acceptable in the array.
+skip_schema_queries                 | Rails dev: `true`<br>Othwerwise: `false`                | `true` to skip schema queries.
+auto_inject                         | `true`                                                  | `true` to inject the miniprofiler script in the page.
+backtrace_ignores                   | `[]`                                                    | Regexes of lines to be removed from backtraces.
+backtrace_includes                  | Rails: `[/^\/?(app\|config\|lib\|test)/]`<br>Rack: `[]` | Regexes of lines to keep in backtraces.
+backtrace_remove                    | rails: `Rails.root`<br>Rack: `nil`                      | A string or regex to remove part of each line in the backtrace.
+toggle_shortcut                     | Alt+P                                                   | Keyboard shortcut to toggle the mini_profiler's visibility. See [jquery.hotkeys](https://github.com/jeresig/jquery.hotkeys).
+start_hidden                        | `false`                                                 | `false` to make mini_profiler visible on page load.
+backtrace_threshold_ms              | `0`                                                     | Minimum SQL query elapsed time before a backtrace is recorded.
+flamegraph_sample_rate              | `0.5`                                                   | How often to capture stack traces for flamegraphs in milliseconds.
+flamegraph_mode                     | `:wall`                                                 | The [StackProf mode](https://github.com/tmm1/stackprof#all-options) to pass to `StackProf.run`.
+base_url_path                       | `'/mini-profiler-resources/'`                           | Path for assets; added as a prefix when naming assets and sought when responding to requests.
+cookie_path                         | `'/'`                                                   | Set-Cookie header path for profile cookie
+collapse_results                    | `true`                                                  | If multiple timing results exist in a single page, collapse them till clicked.
+max_traces_to_show                  | 20                                                      | Maximum number of mini profiler timing blocks to show on one page
+html_container                      | `body`                                                  | The HTML container (as a jQuery selector) to inject the mini_profiler UI into
+show_total_sql_count                | `false`                                                 | Displays the total number of SQL executions.
+enable_advanced_debugging_tools     | `false`                                                 | Enables sensitive debugging tools that can be used via the UI. In production we recommend keeping this disabled as memory and environment debugging tools can expose contents of memory that may contain passwords. Defaults to `true` in development.
+assets_url                          | `nil`                                                   | See the "Register MiniProfiler's assets in the Rails assets pipeline" section above.
+snapshot_every_n_requests           | `-1`                                                    | Determines how frequently snapshots are taken. See the "Snapshots Sampling" above for more details.
+max_snapshot_groups                 | `50`                                                    | Determines how many snapshot groups Mini Profiler is allowed to keep.
+max_snapshots_per_group             | `15`                                                    | Determines how many snapshots per group Mini Profiler is allowed to keep.
+snapshot_hidden_custom_fields       | `[]`                                                    | Each snapshot custom field will have a dedicated column in the UI by default. Use this config to exclude certain custom fields from having their own columns.
+snapshots_transport_destination_url | `nil`                                                   | Set this config to a valid URL to enable snapshots transporter which will `POST` snapshots to the given URL. The transporter requires `snapshots_transport_auth_key` config to be set as well.
+snapshots_transport_auth_key        | `nil`                                                   | `POST` requests made by the snapshots transporter to the destination URL will have a `Mini-Profiler-Transport-Auth` header with the value of this config. Make sure you use a secure and random key for this config.
+snapshots_redact_sql_queries        | `true`                                                  | When this is true, SQL queries will be redacted from sampling snapshots, but the backtrace and duration of each SQL query will be saved with the snapshot to keep debugging performance issues possible.
+snapshots_transport_gzip_requests   | `false`                                                 | Make the snapshots transporter gzip the requests it makes to `snapshots_transport_destination_url`.
+content_security_policy_nonce       | Rails: Current nonce<br>Rack: nil                       | Set the content security policy nonce to use when inserting MiniProfiler's script block.
+enable_hotwire_turbo_drive_support  | `false`                                                 | Enable support for Hotwire TurboDrive page transitions.
+profile_parameter                   | `'pp'`                                                  | The query parameter used to interact with this gem.
 
 ### Using MiniProfiler with `Rack::Deflate` middleware
 
@@ -448,41 +459,26 @@ which means it will run after `Rack::Deflate` on response processing. To prevent
 HTML in already compressed response body MiniProfiler will suppress compression by setting
 `identity` encoding in `Accept-Encoding` request header.
 
-## Special query strings
-
-If you include the query string `pp=help` at the end of your request you will see the various options available. You can use these options to extend or contract the amount of diagnostics rack-mini-profiler gathers.
-
-
-## Rails 2.X support
+### Using MiniProfiler with Heroku Redis
 
-To get MiniProfiler working with Rails 2.3.X you need to do the initialization manually as well as monkey patch away an incompatibility between activesupport and json_pure.
-
-Add the following code to your environment.rb (or just in a specific environment such as development.rb) for initialization and configuration of MiniProfiler.
+If you are using Heroku Redis, you may need to add the following to your `config/initializers/mini_profiler.rb`, in order to get Mini Profiler to work:
 
 ```ruby
-# configure and initialize MiniProfiler
-require 'rack-mini-profiler'
-c = ::Rack::MiniProfiler.config
-c.pre_authorize_cb = lambda { |env|
-  Rails.env.development? || Rails.env.production?
-}
-tmp = Rails.root.to_s + "/tmp/miniprofiler"
-FileUtils.mkdir_p(tmp) unless File.exist?(tmp)
-c.storage_options = {:path => tmp}
-c.storage = ::Rack::MiniProfiler::FileStore
-config.middleware.use(::Rack::MiniProfiler)
-::Rack::MiniProfiler.profile_method(ActionController::Base, :process) {|action| "Executing action: #{action}"}
-::Rack::MiniProfiler.profile_method(ActionView::Template, :render) {|x,y| "Rendering: #{path_without_format_and_extension}"}
-
-# monkey patch away an activesupport and json_pure incompatability
-# http://pivotallabs.com/users/alex/blog/articles/1332-monkey-patch-of-the-day-activesupport-vs-json-pure-vs-ruby-1-8
-if JSON.const_defined?(:Pure)
-  class JSON::Pure::Generator::State
-    include ActiveSupport::CoreExtensions::Hash::Except
-  end
+if Rails.env.production?
+  Rack::MiniProfiler.config.storage_options = { 
+    url: ENV["REDIS_URL"],
+    ssl_params: { verify_mode: OpenSSL::SSL::VERIFY_NONE }
+  }
+  Rack::MiniProfiler.config.storage = Rack::MiniProfiler::RedisStore
 end
 ```
 
+The above code snippet is [Heroku's officially suggested workaround](https://help.heroku.com/HC0F8CUS/redis-connection-issues).
+
+## Special query strings
+
+If you include the query string `pp=help` at the end of your request you will see the various options available. You can use these options to extend or contract the amount of diagnostics rack-mini-profiler gathers.
+
 ## Development
 
 If you want to contribute to this project, that's great, thank you! You can run the following rake task:
@@ -501,8 +497,8 @@ Make sure to prepend `bundle exec` before any Rake tasks you run.
 You need Memcached and Redis services running for the specs.
 
 ```
-$ rake build
-$ rake spec
+$ bundle exec rake build
+$ bundle exec rake spec
 ```
 
 ## Licence

data/lib/generators/rack_mini_profiler/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates an initializer for rack-mini-profiler. Use an initializer when manually
+    requiring rack-mini-profiler in your application (using require: false in your Gemfile).
+
+Example:
+    `bin/rails generate rack_mini_profiler:install`
+
+    This generates a an initializer that requires and initializes
+    rack-mini-profiler in development mode.

data/lib/generators/rack_mini_profiler/install_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module RackMiniProfiler
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_initializer_file
+        copy_file "rack_mini_profiler.rb", "config/initializers/rack_mini_profiler.rb"
+      end
+    end
+  end
+end

data/lib/generators/{rack_profiler/templates/rack_profiler.rb → rack_mini_profiler/templates/rack_mini_profiler.rb}

@@ -3,6 +3,6 @@
 if Rails.env.development?
   require "rack-mini-profiler"
 
-  # initialization is skipped so trigger it
+  # The initializer was required late, so initialize it manually.
   Rack::MiniProfilerRails.initialize!(Rails.application)
 end

data/lib/generators/rack_profiler/install_generator.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
+require "generators/rack_mini_profiler/install_generator"
+
 module RackProfiler
   module Generators
-    class InstallGenerator < ::Rails::Generators::Base
-      source_root File.expand_path("templates", __dir__)
+    class InstallGenerator < RackMiniProfiler::Generators::InstallGenerator
+      source_root File.expand_path("../rack_mini_profiler/templates", __dir__)
 
       def create_initializer_file
-        copy_file "rack_profiler.rb", "config/initializers/rack_profiler.rb"
+        warn("bin/rails generate rack_profiler:install is deprecated. Please use rack_mini_profiler:install instead.")
+        super
       end
     end
   end

data/lib/mini_profiler/config.rb

@@ -62,6 +62,8 @@ module Rack
           @snapshots_transport_gzip_requests = false
           @enable_hotwire_turbo_drive_support = false
 
+          @profile_parameter = "pp"
+
           self
         }
       end
@@ -74,7 +76,7 @@ module Rack
         :storage_options, :user_provider, :enable_advanced_debugging_tools,
         :skip_sql_param_names, :suppress_encoding, :max_sql_param_length,
         :content_security_policy_nonce, :enable_hotwire_turbo_drive_support,
-        :flamegraph_mode
+        :flamegraph_mode, :profile_parameter
 
       # ui accessors
       attr_accessor :collapse_results, :max_traces_to_show, :position,

data/lib/mini_profiler/storage/file_store.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 module Rack
   class MiniProfiler
     class FileStore < AbstractStore

data/lib/mini_profiler/storage/memory_store.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 module Rack
   class MiniProfiler
     class MemoryStore < AbstractStore

data/lib/mini_profiler/storage/redis_store.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'digest'
+require 'securerandom'
 
 module Rack
   class MiniProfiler

data/lib/mini_profiler/storage.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'mini_profiler/storage/abstract_store'
+require 'mini_profiler/storage/memcache_store'
+require 'mini_profiler/storage/memory_store'
+require 'mini_profiler/storage/redis_store'
+require 'mini_profiler/storage/file_store'

data/lib/mini_profiler/timer_struct/base.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'json'
+
 module Rack
   class MiniProfiler
     module TimerStruct

data/lib/mini_profiler/timer_struct/sql.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'erb'
+
 module Rack
   class MiniProfiler
 

data/lib/mini_profiler/timer_struct.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'mini_profiler/timer_struct/base'
+require 'mini_profiler/timer_struct/page'
+require 'mini_profiler/timer_struct/sql'
+require 'mini_profiler/timer_struct/custom'
+require 'mini_profiler/timer_struct/client'
+require 'mini_profiler/timer_struct/request'

data/lib/mini_profiler/version.rb

@@ -2,7 +2,7 @@
 
 module Rack
   class MiniProfiler
-    VERSION = '3.0.0'
+    VERSION = '3.1.0'
     SOURCE_CODE_URI = 'https://github.com/MiniProfiler/rack-mini-profiler'
   end
 end

data/lib/{mini_profiler/profiler.rb → mini_profiler.rb}

@@ -1,6 +1,17 @@
 # frozen_string_literal: true
 
 require 'cgi'
+require 'json'
+require 'erb'
+
+require 'mini_profiler/timer_struct'
+require 'mini_profiler/storage'
+require 'mini_profiler/config'
+require 'mini_profiler/profiling_methods'
+require 'mini_profiler/context'
+require 'mini_profiler/client_settings'
+require 'mini_profiler/gc_profiler'
+require 'mini_profiler/snapshots_transporter'
 
 module Rack
   class MiniProfiler
@@ -27,11 +38,11 @@ module Rack
       end
 
       def resources_root
-        @resources_root ||= ::File.expand_path("../../html", __FILE__)
+        @resources_root ||= ::File.expand_path("../html", __FILE__)
       end
 
       def share_template
-        @share_template ||= ERB.new(::File.read(::File.expand_path("../html/share.html", ::File.dirname(__FILE__))))
+        @share_template ||= ERB.new(::File.read(::File.expand_path("html/share.html", ::File.dirname(__FILE__))))
       end
 
       def current
@@ -223,7 +234,7 @@ module Rack
       # Someone (e.g. Rails engine) could change the SCRIPT_NAME so we save it
       env['RACK_MINI_PROFILER_ORIGINAL_SCRIPT_NAME'] = ENV['PASSENGER_BASE_URI'] || env['SCRIPT_NAME']
 
-      skip_it = /pp=skip/.match?(query_string) || (
+      skip_it = /#{@config.profile_parameter}=skip/.match?(query_string) || (
         @config.skip_paths &&
         @config.skip_paths.any? do |p|
           if p.instance_of?(String)
@@ -255,11 +266,11 @@ module Rack
 
       has_disable_cookie = client_settings.disable_profiling?
       # manual session disable / enable
-      if query_string =~ /pp=disable/ || has_disable_cookie
+      if query_string =~ /#{@config.profile_parameter}=disable/ || has_disable_cookie
         skip_it = true
       end
 
-      if query_string =~ /pp=enable/
+      if query_string =~ /#{@config.profile_parameter}=enable/
         skip_it = false
         config.enabled = true
       end
@@ -273,22 +284,24 @@ module Rack
       end
 
       # profile gc
-      if query_string =~ /pp=profile-gc/
+      if query_string =~ /#{@config.profile_parameter}=profile-gc/
         return tool_disabled_message(client_settings) if !advanced_debugging_enabled?
         current.measure = false if current
         return client_settings.handle_cookie(Rack::MiniProfiler::GCProfiler.new.profile_gc(@app, env))
       end
 
       # profile memory
-      if query_string =~ /pp=profile-memory/
+      if query_string =~ /#{@config.profile_parameter}=profile-memory/
         return tool_disabled_message(client_settings) if !advanced_debugging_enabled?
 
         unless defined?(MemoryProfiler) && MemoryProfiler.respond_to?(:report)
           message = "Please install the memory_profiler gem and require it: add gem 'memory_profiler' to your Gemfile"
-          _, _, body = @app.call(env)
+          status, headers, body = @app.call(env)
           body.close if body.respond_to? :close
 
-          return client_settings.handle_cookie(text_result(message))
+          return client_settings.handle_cookie(
+            text_result(message, status: 500, headers: headers)
+          )
         end
 
         query_params = Rack::Utils.parse_nested_query(query_string)
@@ -308,12 +321,12 @@ module Rack
 
       MiniProfiler.create_current(env, @config)
 
-      if query_string =~ /pp=normal-backtrace/
+      if query_string =~ /#{@config.profile_parameter}=normal-backtrace/
         client_settings.backtrace_level = ClientSettings::BACKTRACE_DEFAULT
-      elsif query_string =~ /pp=no-backtrace/
+      elsif query_string =~ /#{@config.profile_parameter}=no-backtrace/
         current.skip_backtrace = true
         client_settings.backtrace_level = ClientSettings::BACKTRACE_NONE
-      elsif query_string =~ /pp=full-backtrace/ || client_settings.backtrace_full?
+      elsif query_string =~ /#{@config.profile_parameter}=full-backtrace/ || client_settings.backtrace_full?
         current.full_backtrace = true
         client_settings.backtrace_level = ClientSettings::BACKTRACE_FULL
       elsif client_settings.backtrace_none?
@@ -322,7 +335,7 @@ module Rack
 
       flamegraph = nil
 
-      trace_exceptions = query_string =~ /pp=trace-exceptions/ && defined? TracePoint
+      trace_exceptions = query_string =~ /#{@config.profile_parameter}=trace-exceptions/ && defined? TracePoint
       status, headers, body, exceptions, trace = nil
 
       if trace_exceptions
@@ -347,12 +360,7 @@ module Rack
         env['HTTP_ACCEPT_ENCODING'] = 'identity' if config.suppress_encoding
 
         if query_string =~ /pp=(async-)?flamegraph/ || env['HTTP_REFERER'] =~ /pp=async-flamegraph/
-          unless defined?(StackProf) && StackProf.respond_to?(:run)
-            headers = { 'Content-Type' => 'text/html' }
-            message = "Please install the stackprof gem and require it: add gem 'stackprof' to your Gemfile"
-            body.close if body.respond_to? :close
-            return client_settings.handle_cookie([500, headers, message])
-          else
+          if defined?(StackProf) && StackProf.respond_to?(:run)
             # do not sully our profile with mini profiler timings
             current.measure = false
             match_data      = query_string.match(/flamegraph_sample_rate=([\d\.]+)/)
@@ -379,12 +387,24 @@ module Rack
             ) do
               status, headers, body = @app.call(env)
             end
+          else
+            message = "Please install the stackprof gem and require it: add gem 'stackprof' to your Gemfile"
+            status, headers, body = @app.call(env)
+            body.close if body.respond_to? :close
+
+            return client_settings.handle_cookie(
+              text_result(message, status: status, headers: headers)
+            )
           end
         elsif path == '/rack-mini-profiler/requests'
           blank_page_html = <<~HTML
+            <!DOCTYPE html>
             <html>
-              <head></head>
-              <body></body>
+              <head>
+                <title>Rack::MiniProfiler Requests</title>
+              </head>
+              <body>
+              </body>
             </html>
           HTML
 
@@ -419,19 +439,19 @@ module Rack
         return client_settings.handle_cookie(dump_exceptions exceptions)
       end
 
-      if query_string =~ /pp=env/
+      if query_string =~ /#{@config.profile_parameter}=env/
         return tool_disabled_message(client_settings) if !advanced_debugging_enabled?
         body.close if body.respond_to? :close
         return client_settings.handle_cookie(dump_env env)
       end
 
-      if query_string =~ /pp=analyze-memory/
+      if query_string =~ /#{@config.profile_parameter}=analyze-memory/
         return tool_disabled_message(client_settings) if !advanced_debugging_enabled?
         body.close if body.respond_to? :close
         return client_settings.handle_cookie(analyze_memory)
       end
 
-      if query_string =~ /pp=help/
+      if query_string =~ /#{@config.profile_parameter}=help/
         body.close if body.respond_to? :close
         return client_settings.handle_cookie(help(client_settings, env))
       end
@@ -440,7 +460,7 @@ module Rack
       page_struct[:user] = user(env)
       page_struct[:root].record_time((Process.clock_gettime(Process::CLOCK_MONOTONIC) - start) * 1000)
 
-      if flamegraph && query_string =~ /pp=flamegraph/
+      if flamegraph && query_string =~ /#{@config.profile_parameter}=flamegraph/
         body.close if body.respond_to? :close
         return client_settings.handle_cookie(self.flamegraph(flamegraph, path))
       elsif flamegraph # async-flamegraph
@@ -538,7 +558,7 @@ module Rack
 
         body << "\nBacktraces\n"
         exceptions.each_with_index do |e, i|
-          body << "##{i + 1}: #{e.class} - \"#{e.message}\"\n  #{e.backtrace.join("\n  ")}\n\n"
+          body << "##{i + 1}: #{e.class} - \"#{e.message.lines.first.chomp}\"\n  #{e.backtrace.join("\n  ")}\n\n"
         end
       end
       text_result(body)
@@ -638,45 +658,51 @@ module Rack
       text_result(body)
     end
 
-    def text_result(body)
-      headers = { 'Content-Type' => 'text/plain; charset=utf-8' }
-      [200, headers, [body]]
+    def text_result(body, status: 200, headers: nil)
+      headers = (headers || {}).merge('Content-Type' => 'text/plain; charset=utf-8')
+      [status, headers, [body]]
     end
 
     def make_link(postfix, env)
-      link = env["PATH_INFO"] + "?" + env["QUERY_STRING"].sub("pp=help", "pp=#{postfix}")
-      "pp=<a href='#{ERB::Util.html_escape(link)}'>#{postfix}</a>"
+      link = env["PATH_INFO"] + "?" + env["QUERY_STRING"].sub("#{@config.profile_parameter}=help", "#{@config.profile_parameter}=#{postfix}")
+      "#{@config.profile_parameter}=<a href='#{ERB::Util.html_escape(link)}'>#{postfix}</a>"
     end
 
     def help(client_settings, env)
       headers = { 'Content-Type' => 'text/html' }
-      body = "<html><body>
-<pre style='line-height: 30px; font-size: 16px;'>
-This is the help menu of the <a href='#{Rack::MiniProfiler::SOURCE_CODE_URI}'>rack-mini-profiler</a> gem, append the following to your query string for more options:
-
-  #{make_link "help", env} : display this screen
-  #{make_link "env", env} : display the rack environment
-  #{make_link "skip", env} : skip mini profiler for this request
-  #{make_link "no-backtrace", env} #{"(*) " if client_settings.backtrace_none?}: don't collect stack traces from all the SQL executed (sticky, use pp=normal-backtrace to enable)
-  #{make_link "normal-backtrace", env} #{"(*) " if client_settings.backtrace_default?}: collect stack traces from all the SQL executed and filter normally
-  #{make_link "full-backtrace", env} #{"(*) " if client_settings.backtrace_full?}: enable full backtraces for SQL executed (use pp=normal-backtrace to disable)
-  #{make_link "disable", env} : disable profiling for this session
-  #{make_link "enable", env} : enable profiling for this session (if previously disabled)
-  #{make_link "profile-gc", env} : perform gc profiling on this request, analyzes ObjectSpace generated by request
-  #{make_link "profile-memory", env} : requires the memory_profiler gem, new location based report
-  #{make_link "flamegraph", env} : a graph representing sampled activity (requires the stackprof gem).
-  #{make_link "async-flamegraph", env} : store flamegraph data for this page and all its AJAX requests. Flamegraph links will be available in the mini-profiler UI (requires the stackprof gem).
-  #{make_link "flamegraph&flamegraph_sample_rate=1", env}: creates a flamegraph with the specified sample rate (in ms). Overrides value set in config
-  #{make_link "flamegraph&flamegraph_mode=cpu", env}: creates a flamegraph with the specified mode (one of cpu, wall, object, or custom). Overrides value set in config
-  #{make_link "flamegraph_embed", env} : a graph representing sampled activity (requires the stackprof gem), embedded resources for use on an intranet.
-  #{make_link "trace-exceptions", env} : will return all the spots where your application raises exceptions
-  #{make_link "analyze-memory", env} : will perform basic memory analysis of heap
-</pre>
-</body>
-</html>
-"
-
-      [200, headers, [body]]
+      html = <<~HTML
+        <!DOCTYPE html>
+        <html>
+          <head>
+            <title>Rack::MiniProfiler Help</title>
+          </head>
+          <body>
+            <pre style='line-height: 30px; font-size: 16px'>
+              This is the help menu of the <a href='#{Rack::MiniProfiler::SOURCE_CODE_URI}'>rack-mini-profiler</a> gem, append the following to your query string for more options:
+
+              #{make_link "help", env} : display this screen
+              #{make_link "env", env} : display the rack environment
+              #{make_link "skip", env} : skip mini profiler for this request
+              #{make_link "no-backtrace", env} #{"(*) " if client_settings.backtrace_none?}: don't collect stack traces from all the SQL executed (sticky, use #{@config.profile_parameter}=normal-backtrace to enable)
+              #{make_link "normal-backtrace", env} #{"(*) " if client_settings.backtrace_default?}: collect stack traces from all the SQL executed and filter normally
+              #{make_link "full-backtrace", env} #{"(*) " if client_settings.backtrace_full?}: enable full backtraces for SQL executed (use #{@config.profile_parameter}=normal-backtrace to disable)
+              #{make_link "disable", env} : disable profiling for this session
+              #{make_link "enable", env} : enable profiling for this session (if previously disabled)
+              #{make_link "profile-gc", env} : perform gc profiling on this request, analyzes ObjectSpace generated by request
+              #{make_link "profile-memory", env} : requires the memory_profiler gem, new location based report
+              #{make_link "flamegraph", env} : a graph representing sampled activity (requires the stackprof gem).
+              #{make_link "async-flamegraph", env} : store flamegraph data for this page and all its AJAX requests. Flamegraph links will be available in the mini-profiler UI (requires the stackprof gem).
+              #{make_link "flamegraph&flamegraph_sample_rate=1", env}: creates a flamegraph with the specified sample rate (in ms). Overrides value set in config
+              #{make_link "flamegraph&flamegraph_mode=cpu", env}: creates a flamegraph with the specified mode (one of cpu, wall, object, or custom). Overrides value set in config
+              #{make_link "flamegraph_embed", env} : a graph representing sampled activity (requires the stackprof gem), embedded resources for use on an intranet.
+              #{make_link "trace-exceptions", env} : will return all the spots where your application raises exceptions
+              #{make_link "analyze-memory", env} : will perform basic memory analysis of heap
+            </pre>
+          </body>
+        </html>
+      HTML
+
+      [200, headers, [html]]
     end
 
     def flamegraph(graph, path)
@@ -685,6 +711,7 @@ This is the help menu of the <a href='#{Rack::MiniProfiler::SOURCE_CODE_URI}'>ra
         <!DOCTYPE html>
         <html>
           <head>
+            <title>Rack::MiniProfiler Flamegraph</title>
             <style>
               body { margin: 0; height: 100vh; }
               #speedscope-iframe { width: 100%; height: 100%; border: none; }
@@ -773,7 +800,7 @@ This is the help menu of the <a href='#{Rack::MiniProfiler::SOURCE_CODE_URI}'>ra
       end
 
       # TODO : cache this snippet
-      script = ::File.read(::File.expand_path('../html/profile_handler.js', ::File.dirname(__FILE__)))
+      script = ::File.read(::File.expand_path('html/profile_handler.js', ::File.dirname(__FILE__)))
       # replace the variables
       settings.each do |k, v|
         regex = Regexp.new("\\{#{k.to_s}\\}")
@@ -828,8 +855,11 @@ This is the help menu of the <a href='#{Rack::MiniProfiler::SOURCE_CODE_URI}'>ra
       response = Rack::Response.new([], status, headers)
 
       response.write <<~HTML
+        <!DOCTYPE html>
         <html>
-          <head></head>
+          <head>
+            <title>Rack::MiniProfiler Snapshots</title>
+          </head>
           <body class="mp-snapshots">
       HTML
       response.write(data_html)

data/lib/patches/net_patches.rb

@@ -1,26 +1,27 @@
 # frozen_string_literal: true
 
-if (defined?(Net) && defined?(Net::HTTP))
-
-  if defined?(Rack::MINI_PROFILER_PREPEND_NET_HTTP_PATCH)
-    module NetHTTPWithMiniProfiler
-      def request(request, *args, &block)
-        Rack::MiniProfiler.step("Net::HTTP #{request.method} #{request.path}") do
-          super
+if ENV['RACK_MINI_PROFILER_PATCH_NET_HTTP'] != 'false'
+  if (defined?(Net) && defined?(Net::HTTP))
+    if defined?(Rack::MINI_PROFILER_PREPEND_NET_HTTP_PATCH)
+      module NetHTTPWithMiniProfiler
+        def request(request, *args, &block)
+          Rack::MiniProfiler.step("Net::HTTP #{request.method} #{request.path}") do
+            super
+          end
         end
       end
-    end
-    Net::HTTP.prepend(NetHTTPWithMiniProfiler)
-  else
-    Net::HTTP.class_eval do
-      def request_with_mini_profiler(*args, &block)
-        request = args[0]
-        Rack::MiniProfiler.step("Net::HTTP #{request.method} #{request.path}") do
-          request_without_mini_profiler(*args, &block)
+      Net::HTTP.prepend(NetHTTPWithMiniProfiler)
+    else
+      Net::HTTP.class_eval do
+        def request_with_mini_profiler(*args, &block)
+          request = args[0]
+          Rack::MiniProfiler.step("Net::HTTP #{request.method} #{request.path}") do
+            request_without_mini_profiler(*args, &block)
+          end
         end
+        alias request_without_mini_profiler request
+        alias request request_with_mini_profiler
       end
-      alias request_without_mini_profiler request
-      alias request request_with_mini_profiler
     end
   end
 end

data/lib/rack-mini-profiler.rb

@@ -1,33 +1,10 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'timeout'
-require 'thread'
-require 'securerandom'
-
 require 'mini_profiler/version'
 require 'mini_profiler/asset_version'
 
-require 'mini_profiler/timer_struct/base'
-require 'mini_profiler/timer_struct/page'
-require 'mini_profiler/timer_struct/sql'
-require 'mini_profiler/timer_struct/custom'
-require 'mini_profiler/timer_struct/client'
-require 'mini_profiler/timer_struct/request'
-
-require 'mini_profiler/storage/abstract_store'
-require 'mini_profiler/storage/memcache_store'
-require 'mini_profiler/storage/memory_store'
-require 'mini_profiler/storage/redis_store'
-require 'mini_profiler/storage/file_store'
+require 'mini_profiler'
 
-require 'mini_profiler/config'
-require 'mini_profiler/profiling_methods'
-require 'mini_profiler/context'
-require 'mini_profiler/client_settings'
-require 'mini_profiler/gc_profiler'
-require 'mini_profiler/snapshots_transporter'
-require 'mini_profiler/profiler'
 require 'patches/sql_patches'
 require 'patches/net_patches'
 

data/rack-mini-profiler.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
     "CHANGELOG.md"
   ]
   s.add_runtime_dependency 'rack', '>= 1.2.0'
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 2.6.0'
 
   s.metadata = {
     'source_code_uri' => Rack::MiniProfiler::SOURCE_CODE_URI,
@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'dalli'
-  s.add_development_dependency 'rspec', '~> 3.6.0'
+  s.add_development_dependency 'rspec', '~> 3.12.0'
   s.add_development_dependency 'redis'
   s.add_development_dependency 'sassc'
   s.add_development_dependency 'stackprof'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-mini-profiler
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Sam Saffron
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -74,14 +74,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -262,9 +262,11 @@ files:
 - CHANGELOG.md
 - README.md
 - lib/enable_rails_patches.rb
+- lib/generators/rack_mini_profiler/USAGE
+- lib/generators/rack_mini_profiler/install_generator.rb
+- lib/generators/rack_mini_profiler/templates/rack_mini_profiler.rb
 - lib/generators/rack_profiler/USAGE
 - lib/generators/rack_profiler/install_generator.rb
-- lib/generators/rack_profiler/templates/rack_profiler.rb
 - lib/html/dot.1.1.2.min.js
 - lib/html/includes.css
 - lib/html/includes.js
@@ -291,19 +293,21 @@ files:
 - lib/html/speedscope/source-map.438fa06b.js
 - lib/html/speedscope/speedscope.44364064.js
 - lib/html/vendor.js
+- lib/mini_profiler.rb
 - lib/mini_profiler/asset_version.rb
 - lib/mini_profiler/client_settings.rb
 - lib/mini_profiler/config.rb
 - lib/mini_profiler/context.rb
 - lib/mini_profiler/gc_profiler.rb
-- lib/mini_profiler/profiler.rb
 - lib/mini_profiler/profiling_methods.rb
 - lib/mini_profiler/snapshots_transporter.rb
+- lib/mini_profiler/storage.rb
 - lib/mini_profiler/storage/abstract_store.rb
 - lib/mini_profiler/storage/file_store.rb
 - lib/mini_profiler/storage/memcache_store.rb
 - lib/mini_profiler/storage/memory_store.rb
 - lib/mini_profiler/storage/redis_store.rb
+- lib/mini_profiler/timer_struct.rb
 - lib/mini_profiler/timer_struct/base.rb
 - lib/mini_profiler/timer_struct/client.rb
 - lib/mini_profiler/timer_struct/custom.rb
@@ -347,14 +351,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Profiles loading speed for rack applications.