rack-mini-profiler 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93c2989b331d19e51611a97941ea8259812285211b00ad25bb56e55a7fe17b37
-  data.tar.gz: '07594d8609bad0a73f86cf56cfe1bf1aaeb8e279edeba50e2a5c4a3bf86be0fb'
+  metadata.gz: 1603a0c0246f9b132f81e74331425a1217156d62f71f20a06ecd3edca91aef51
+  data.tar.gz: a341e35cf639c11cc61c9ef5fd1ecd25e89ff12da299d3a6bfe8cb479c5dd7d8
 SHA512:
-  metadata.gz: f651aeb06ef7bab9e853aacc4ed3ab22b8470b3b8723b7d7f727092c6e7e35db75003cdb8bbeba2ef94637c9ff85ea5bf269cbefa748f46aaeb72208d900b387
-  data.tar.gz: ffe60bc20d0132e5e5c34e55debb739da0f3a62fce0d9a391f515fe9ba52f9c6c8f2cd3f327e433a8f2a9222bb60b1bbede8f1f28a9b9f39cb442b4097b982e1
+  metadata.gz: 4244e2738847e0e34b33cebda96f45d79ad82201ce969310bf45f1ad7431561af0d41610c2e8c60a0c64d428032a1e4bea6cc5b02aa71b5462a918474228844a
+  data.tar.gz: b1c0d88134e780bbbb91f711366400585d51d98107d1f35af85ca7c38498f0e23de019f2eb05259e833d8deabf485dc70f1dd581c28e132aba68bfa785967774

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # CHANGELOG
 
+## 2.1.0 - 2020-09-17
+
+- [FEATURE] Allow assets to be precompiled with Sprockets
+- [FEATURE] Snapshots sampling (see README in repo)
+- [FEATURE] Allow `skip_paths` config to contain regular expressions
+
+## 2.0.4 - 2020-08-04
+
+- [FIX] webpacker may exist with no config, allow for that
+
+## 2.0.3 - 2020-07-29
+
+- [FIX] support for deprecation free Redis 4.2
+- [FEATURE] skip /packs when serving static assets
+- [FEATURE] allow Net::HTTP patch to be applied with either prerpend or alias
+
+## 2.0.2 - 2020-05-25
+
+- [FIX] client timings were not showing up when you clicked show trivial
+
+## 2.0.1 - 2020-03-17
+
+- [REVERT] Prepend Net::HTTP patch instead of class_eval and aliasing (#429) (technique clashes with New Relic and Skylight agents)
+
 ## 2.0.0 - 2020-03-11
 
 - [FEATURE] Prepend Net::HTTP patch instead of class_eval and aliasing (#429)

data/README.md

@@ -29,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.3+
+Install/add to Gemfile in Ruby 2.4+
 
 ```ruby
 gem 'rack-mini-profiler'
@@ -65,6 +65,22 @@ If you don't want to manually require Mini Profiler:
 gem 'rack-mini-profiler', require: ['enable_rails_patches', 'rack-mini-profiler']
 ```
 
+#### `Net::HTTP` stack level too deep errors
+
+If you start seeing `SystemStackError: stack level too deep` errors from `Net::HTTP` after installing Mini Profiler, this means there is another patch for `Net::HTTP#request` that conflicts with Mini Profiler's patch in your application. To fix this, change `rack-mini-profiler` gem line in your `Gemfile` to the following:
+
+```ruby
+gem 'rack-mini-profiler', require: ['prepend_net_http_patch', 'rack-mini-profiler']
+```
+
+If you currently have `require: false`, remove the `'rack-mini-profiler'` string from the `require` array above so the gem line becomes like this:
+
+```ruby
+gem 'rack-mini-profiler', require: ['prepend_net_http_patch']
+```
+
+This conflict happens when a ruby method is patched twice, once using module prepend, and once using method aliasing. See this [ruby issue](https://bugs.ruby-lang.org/issues/11120) for details. The fix is to apply all patches the same way. Mini Profiler by default will apply its patch using method aliasing, but you can change that to module prepend by adding `require: ['prepend_net_http_patch']` to the gem line as shown above.
+
 #### Rails and manual initialization
 
 In case you need to make sure rack_mini_profiler is initialized after all other gems, or you want to execute some code before rack_mini_profiler required:
@@ -170,6 +186,18 @@ There are two additional `pp` options that can be used to analyze memory which d
 * Use `?pp=profile-gc` to report on Garbage Collection statistics
 * Use `?pp=analyze-memory` to report on ObjectSpace statistics
 
+### Snapshots Sampling
+
+In a complex web application, it's possible for a request to trigger rare conditions that result in poor performance. Mini Profiler ships with a feature to help detect those rare conditions and fix them. It works by enabling invisible profiling on one request every N requests, and saving the performance metrics that are collected during the request (a.k.a snapshot of the request) so that they can be viewed later. To turn this feature on, set the `snapshot_every_n_requests` config to a value larger than 0. The larger the value is, the less frequently requests are profiled.
+
+Mini Profiler will exclude requests that are made to skippd paths (see `skip_paths` config below) from being sampled. Additionally, if profiling is enabled for a request that later finishes with a non-2xx status code, Mini Profiler will discard the snapshot and not save it (this behavior may change in the future).
+
+After enabling snapshots sampling, you can see the snapshots that have been collected at `/mini-profiler-resources/snapshots` (or if you changed the `base_url_path` config, substitute `mini-profiler-resources` with your value of the config). You'll see on that page a table where each row represents a group of snapshots with the duration of the worst snapshot in that group. The worst snapshot in a group is defined as the snapshot whose request took longer than all of the snapshots in the same group. Snapshots grouped by HTTP method and path of the request, and if your application is a Rails app, Mini Profiler will try to convert the path to `controller#action` and group by that instead of request path. Clicking on a group will display the snapshots of that group sorted from worst to best. From there, you can click on a snapshot's ID to see the snapshot with all the performance metrics that were collected.
+
+Access to the snapshots page is restricted to only those who can see the speed badge on their own requests, see the section below this one about access control.
+
+Mini Profiler will keep a maximum of 1000 snapshots by default, and you can change that via the `snapshots_limit` config. When snapshots reach the configured limit, Mini Profiler will save a new snapshot only if it's worse than at least one of the existing snapshots and delete the best one (i.e. the snapshot whose request took the least time compared to other snapshots).
+
 ## Access control in non-development environments
 
 rack-mini-profiler is designed with production profiling in mind. To enable that run `Rack::MiniProfiler.authorize_request` once you know a request is allowed to profile.
@@ -313,6 +341,15 @@ _Note:_ The GUID (`data-version` and the `?v=` parameter on the `src`) will chan
 #### Using MiniProfiler's built in route for apps without HTML responses
 MiniProfiler also ships with a `/rack-mini-profiler/requests` route that displays the speed badge on a blank HTML page. This can be useful when profiling an application that does not render HTML.
 
+#### Register MiniProfiler's assets in the Rails assets pipeline
+MiniProfiler can be configured so it registers its assets in the assets pipeline. To do that, you'll need to provide a lambda (or proc) to the `assets_url` config (see the below section). The callback will receive 3 arguments which are: `name` represents asset name (currently it's either `rack-mini-profiling.js` or `rack-mini-profiling.css`), `assets_version` is a 32 characters long hash of MiniProfiler's assets, and `env` which is the `env` object of the request. MiniProfiler expects the `assets_url` callback to return a URL from which the asset can be loaded (the return value will be used as a `href`/`src` attribute in the DOM). If the `assets_url` callback is not set (the default) or it returns a non-truthy value, MiniProfiler will fallback to loading assets from its own middleware (`/mini-profiler-resources/*`). The following callback should work for most applications:
+
+```ruby
+Rack::MiniProfiler.config.assets_url = ->(name, version, env) {
+  ActionController::Base.helpers.asset_path(name)
+}
+```
+
 ### Configuration Options
 
 You can set configuration options using the configuration accessor on `Rack::MiniProfiler`.
@@ -328,8 +365,8 @@ 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|`[]`|Paths that skip profiling.
-skip_schema_queries|Rails dev: `'true'`<br>Othwerwise: `'false'`|`'true'` to log schema queries.
+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.
@@ -344,33 +381,17 @@ max_traces_to_show|20|Maximum number of mini profiler timing blocks to show on o
 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.
+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.
+snapshots_limit|`1000`|Determines how many snapshots Mini Profiler is allowed to keep.
 
-### Custom middleware ordering (required if using `Rack::Deflate` with Rails)
-
-If you are using `Rack::Deflate` with rails and rack-mini-profiler in its default configuration,
-`Rack::MiniProfiler` will be injected (as always) at position 0 in the middleware stack. This
-will result in it attempting to inject html into the already-compressed response body. To fix this,
-the middleware ordering must be overriden.
-
-To do this, first add `, require: false` to the gemfile entry for rack-mini-profiler.
-This will prevent the railtie from running. Then, customize the initialization
-in the initializer like so:
-
-```ruby
-require 'rack-mini-profiler'
-
-Rack::MiniProfilerRails.initialize!(Rails.application)
-
-Rails.application.middleware.delete(Rack::MiniProfiler)
-Rails.application.middleware.insert_after(Rack::Deflater, Rack::MiniProfiler)
-```
-
-Deleting the middleware and then reinserting it is a bit inelegant, but
-a sufficient and costless solution. It is possible that rack-mini-profiler might
-support this scenario more directly if it is found that
-there is significant need for this confriguration or that
-the above recipe causes problems.
+### Using MiniProfiler with `Rack::Deflate` middleware
 
+If you are using `Rack::Deflate` with Rails and `rack-mini-profiler` in its default configuration,
+`Rack::MiniProfiler` will be injected (as always) at position 0 in the middleware stack,
+which means it will run after `Rack::Deflate` on response processing. To prevent attempting to inject
+HTML in already compressed response body MiniProfiler will suppress compression by setting 
+`identity` encoding in `Accept-Encoding` request header.
 
 ## Special query strings
 
@@ -407,6 +428,16 @@ if JSON.const_defined?(:Pure)
 end
 ```
 
+## Development
+
+If you want to contribute to this project, that's great, thank you! You can run the following rake task:
+
+```
+$ bundle exec rake client_dev
+```
+
+which will start a local Sinatra server at `http://localhost:9292` where you'll be able to preview your changes. Refreshing the page should be enough to see any changes you make to files in the `lib/html` directory.
+
 ## Running the Specs
 
 ```

data/lib/enable_rails_patches.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
 module Rack
-  class MiniProfiler
-    ENABLE_RAILS_PATCHES = true
-  end
+  MINI_PROFILER_ENABLE_RAILS_PATCHES = true
 end

data/lib/html/includes.css

@@ -1,9 +1,20 @@
 @charset "UTF-8";
+.mp-snapshots,
 .profiler-result,
 .profiler-queries {
   color: #555;
   line-height: 1;
   font-size: 12px; }
+  .mp-snapshots pre,
+  .mp-snapshots code,
+  .mp-snapshots label,
+  .mp-snapshots table,
+  .mp-snapshots tbody,
+  .mp-snapshots thead,
+  .mp-snapshots tfoot,
+  .mp-snapshots tr,
+  .mp-snapshots th,
+  .mp-snapshots td,
   .profiler-result pre,
   .profiler-result code,
   .profiler-result label,
@@ -33,27 +44,40 @@
     background-color: transparent;
     overflow: visible;
     max-height: none; }
+  .mp-snapshots table,
   .profiler-result table,
   .profiler-queries table {
     border-collapse: collapse;
     border-spacing: 0; }
+  .mp-snapshots a,
+  .mp-snapshots a:hover,
   .profiler-result a,
   .profiler-result a:hover,
   .profiler-queries a,
   .profiler-queries a:hover {
     cursor: pointer;
     color: #0077cc; }
+  .mp-snapshots a,
   .profiler-result a,
   .profiler-queries a {
     text-decoration: none; }
+    .mp-snapshots a:hover,
     .profiler-result a:hover,
     .profiler-queries a:hover {
       text-decoration: underline; }
+  .mp-snapshots .custom-fields-title,
+  .profiler-result .custom-fields-title,
+  .profiler-queries .custom-fields-title {
+    color: #555;
+    font: Helvetica, Arial, sans-serif;
+    font-size: 14px; }
 
 .profiler-result {
   font-family: Helvetica, Arial, sans-serif; }
   .profiler-result .profiler-toggle-duration-with-children {
     float: right; }
+  .profiler-result .profiler-snapshots-page-link {
+    float: left; }
   .profiler-result table.profiler-client-timings {
     margin-top: 10px; }
   .profiler-result .profiler-label {
@@ -207,8 +231,7 @@
     top: 0px; }
     .profiler-results.profiler-top.profiler-left {
       left: 0px; }
-      .profiler-results.profiler-top.profiler-left.profiler-no-controls .profiler-totals,
-      .profiler-results.profiler-top.profiler-left.profiler-no-controls .profiler-result:last-child .profiler-button,
+      .profiler-results.profiler-top.profiler-left.profiler-no-controls .profiler-totals, .profiler-results.profiler-top.profiler-left.profiler-no-controls .profiler-result:last-child .profiler-button,
       .profiler-results.profiler-top.profiler-left .profiler-controls {
         -webkit-border-bottom-right-radius: 10px;
         -moz-border-radius-bottomright: 10px;
@@ -218,8 +241,7 @@
         border-right: 1px solid #888; }
     .profiler-results.profiler-top.profiler-right {
       right: 0px; }
-      .profiler-results.profiler-top.profiler-right.profiler-no-controls .profiler-totals,
-      .profiler-results.profiler-top.profiler-right.profiler-no-controls .profiler-result:last-child .profiler-button,
+      .profiler-results.profiler-top.profiler-right.profiler-no-controls .profiler-totals, .profiler-results.profiler-top.profiler-right.profiler-no-controls .profiler-result:last-child .profiler-button,
       .profiler-results.profiler-top.profiler-right .profiler-controls {
         -webkit-border-bottom-left-radius: 10px;
         -moz-border-radius-bottomleft: 10px;
@@ -231,8 +253,7 @@
     bottom: 0px; }
     .profiler-results.profiler-bottom.profiler-left {
       left: 0px; }
-      .profiler-results.profiler-bottom.profiler-left.profiler-no-controls .profiler-totals,
-      .profiler-results.profiler-bottom.profiler-left.profiler-no-controls .profiler-result:first-child .profiler-button,
+      .profiler-results.profiler-bottom.profiler-left.profiler-no-controls .profiler-totals, .profiler-results.profiler-bottom.profiler-left.profiler-no-controls .profiler-result:first-child .profiler-button,
       .profiler-results.profiler-bottom.profiler-left .profiler-controls {
         -webkit-border-top-right-radius: 10px;
         -moz-border-radius-topright: 10px;
@@ -242,8 +263,7 @@
         border-right: 1px solid #888; }
     .profiler-results.profiler-bottom.profiler-right {
       right: 0px; }
-      .profiler-results.profiler-bottom.profiler-right.profiler-no-controls .profiler-totals,
-      .profiler-results.profiler-bottom.profiler-right.profiler-no-controls .profiler-result:first-child .profiler-button,
+      .profiler-results.profiler-bottom.profiler-right.profiler-no-controls .profiler-totals, .profiler-results.profiler-bottom.profiler-right.profiler-no-controls .profiler-result:first-child .profiler-button,
       .profiler-results.profiler-bottom.profiler-right .profiler-controls {
         -webkit-border-bottom-top-radius: 10px;
         -moz-border-radius-topleft: 10px;
@@ -349,7 +369,6 @@
   @media print {
     .profiler-results {
       display: none; } }
-
 .profiler-queries-bg {
   z-index: 2147483642;
   display: none;
@@ -407,3 +426,15 @@
     background: #ffffbb; }
   100% {
     background: #fff; } }
+
+.mp-snapshots {
+  font-family: Helvetica, Arial, sans-serif;
+  font-size: 16px; }
+  .mp-snapshots .snapshots-table thead {
+    background: #6a737c;
+    color: #ffffff; }
+  .mp-snapshots .snapshots-table th, .mp-snapshots .snapshots-table td {
+    padding: 5px;
+    box-sizing: border-box; }
+  .mp-snapshots .snapshots-table th {
+    border-right: 1px solid #ffffff; }

data/lib/html/includes.js

@@ -108,18 +108,8 @@ var MiniProfiler = (function() {
           // ie is buggy strip out functions
           var copy = {
             navigation: {},
-            timing: {}
+            timing: clientPerformance.timing.toJSON()
           };
-          var timing = extend({}, clientPerformance.timing);
-
-          for (p in timing) {
-            if (
-              timing.hasOwnProperty(p) &&
-              !(typeof timing[p] === "function")
-            ) {
-              copy.timing[p] = timing[p];
-            }
-          }
 
           if (clientPerformance.navigation) {
             copy.navigation.redirectCount =
@@ -147,10 +137,13 @@ var MiniProfiler = (function() {
         (function() {
           var request = new XMLHttpRequest();
           var url = options.path + "results";
-          var params = "id="
-            .concat(id, "&clientPerformance=")
-            .concat(clientPerformance, "&clientProbes=")
-            .concat(clientProbes, "&popup=1");
+          var params = {
+            id: id,
+            clientPerformance: clientPerformance,
+            clientProbes: clientProbes,
+            popup: 1
+          };
+          var queryParam = toQueryString(params);
           request.open("POST", url, true);
 
           request.onload = function() {
@@ -172,24 +165,45 @@ var MiniProfiler = (function() {
             "Content-Type",
             "application/x-www-form-urlencoded"
           );
-          request.send(params);
+          request.send(queryParam);
         })();
       }
     }
   };
 
-  var extend = function extend(out) {
-    out = out || {};
-
-    for (var i = 1; i < _arguments.length; i++) {
-      if (!_arguments[i]) continue;
-
-      for (var key in _arguments[i]) {
-        if (_arguments[i].hasOwnProperty(key)) out[key] = _arguments[i][key];
+  var toQueryString = function toQueryString(data, parentKey) {
+    var result = [];
+    for (var key in data) {
+      var val = data[key];
+      var newKey = !parentKey ? key : parentKey + "[" + key + "]";
+      if (
+        typeof val === "object" &&
+        !Array.isArray(val) &&
+        val !== null &&
+        val !== undefined
+      ) {
+        result[result.length] = toQueryString(val, newKey);
+      } else {
+        if (Array.isArray(val)) {
+          val.forEach(function(v) {
+            result[result.length] =
+              encodeURIComponent(newKey + "[]") + "=" + encodeURIComponent(v);
+          });
+        } else if (val === null || val === undefined) {
+          result[result.length] = encodeURIComponent(newKey) + "=";
+        } else {
+          result[result.length] =
+            encodeURIComponent(newKey) +
+            "=" +
+            encodeURIComponent(val.toString());
+        }
       }
     }
-
-    return out;
+    return result
+      .filter(function(element) {
+        return element && element.length > 0;
+      })
+      .join("&");
   };
 
   var renderTemplate = function renderTemplate(json) {
@@ -659,6 +673,19 @@ var MiniProfiler = (function() {
     });
   };
 
+  var initSnapshots = function initSnapshots(dataElement) {
+    var data = JSON.parse(dataElement.textContent);
+    var temp = document.createElement("DIV");
+    if (data.page === "overview") {
+      temp.innerHTML = MiniProfiler.templates.snapshotsGroupsList(data);
+    } else if (data.group_name) {
+      temp.innerHTML = MiniProfiler.templates.snapshotsList(data);
+    }
+    Array.from(temp.children).forEach(function (child) {
+      document.body.appendChild(child);
+    });
+  };
+
   var initControls = function initControls(container) {
     if (options.showControls) {
       var _controls = document.createElement("div");
@@ -938,7 +965,7 @@ var MiniProfiler = (function() {
       var script = document.getElementById("mini-profiler");
       if (!script || !script.getAttribute) return;
 
-      options = (function() {
+      this.options = options = (function() {
         var version = script.getAttribute("data-version");
         var path = script.getAttribute("data-path");
         var currentId = script.getAttribute("data-current-id");
@@ -966,6 +993,7 @@ var MiniProfiler = (function() {
           script.getAttribute("data-start-hidden") === "true" ||
           sessionStorage["rack-mini-profiler-start-hidden"] === "true";
         var htmlContainer = script.getAttribute("data-html-container");
+        var cssUrl = script.getAttribute("data-css-url");
         return {
           ids: ids,
           path: path,
@@ -982,11 +1010,18 @@ var MiniProfiler = (function() {
           toggleShortcut: toggleShortcut,
           startHidden: startHidden,
           collapseResults: collapseResults,
-          htmlContainer: htmlContainer
+          htmlContainer: htmlContainer,
+          cssUrl: cssUrl
         };
       })();
 
       var doInit = function doInit() {
+        var snapshotsElement = document.getElementById("snapshots-data");
+        if (snapshotsElement != null) {
+          initSnapshots(snapshotsElement);
+          return;
+        }
+
         // when rendering a shared, full page, this div will exist
         container = document.querySelectorAll(".profiler-result-full");
 
@@ -1042,7 +1077,7 @@ var MiniProfiler = (function() {
 
       var init = function init() {
         if (options.authorized) {
-          var url = options.path + "includes.css?v=" + options.version;
+          var url = options.cssUrl;
 
           if (document.createStyleSheet) {
             document.createStyleSheet(url);
@@ -1380,8 +1415,34 @@ var MiniProfiler = (function() {
     },
     showTotalSqlCount: function showTotalSqlCount() {
       return options.showTotalSqlCount;
+    },
+    timestampToRelative: function timestampToRelative(timestamp) {
+      var now = Math.round((new Date()).getTime() / 1000);
+      timestamp = Math.round(timestamp / 1000);
+      var diff = now - timestamp;
+      if (diff < 60) {
+        return "< 1 minute";
+      }
+      var buildDisplayTime = function buildDisplayTime(num, unit) {
+        var res = num + " " + unit;
+        if (num !== 1) {
+          res += "s";
+        }
+        return res;
+      }
+      diff = Math.round(diff / 60);
+      if (diff <= 60) {
+        return buildDisplayTime(diff, "minute");
+      }
+      diff = Math.round(diff / 60);
+      if (diff <= 24) {
+        return buildDisplayTime(diff, "hour");
+      }
+      diff = Math.round(diff / 24);
+      return buildDisplayTime(diff, "day");
     }
   };
 })();
 
+window.MiniProfiler = MiniProfiler;
 MiniProfiler.init();