RubyGems - rack-mini-profiler - Versions diffs - 3.1.0 → 3.3.0 - Mend

rack-mini-profiler 3.1.0 → 3.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (26) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +25 -1
data/README.md +2 -1
data/lib/html/includes.js +5 -7
data/lib/html/includes.tmpl +1 -1
data/lib/html/speedscope/{import.cf0fa83f.js → import.8ae8aa3d.js} +26 -18
data/lib/html/speedscope/index.html +1 -1
data/lib/html/speedscope/release.txt +3 -3
data/lib/html/speedscope/{speedscope.44364064.js → speedscope.f27db165.js} +99 -106
data/lib/html/vendor.js +1 -1
data/lib/mini_profiler/actions.rb +152 -0
data/lib/mini_profiler/asset_version.rb +1 -1
data/lib/mini_profiler/config.rb +2 -1
data/lib/mini_profiler/profiling_methods.rb +4 -0
data/lib/mini_profiler/storage/memcache_store.rb +9 -0
data/lib/mini_profiler/storage/memory_store.rb +2 -2
data/lib/mini_profiler/timer_struct/request.rb +6 -0
data/lib/mini_profiler/timer_struct/sql.rb +3 -1
data/lib/mini_profiler/version.rb +1 -1
data/lib/mini_profiler/views.rb +193 -0
data/lib/mini_profiler.rb +65 -349
data/lib/mini_profiler_rails/railtie.rb +12 -1
data/lib/mini_profiler_rails/railtie_methods.rb +1 -1
data/lib/patches/sql_patches.rb +2 -2
data/rack-mini-profiler.gemspec +1 -1
metadata +8 -6

data/lib/html/vendor.js CHANGED Viewed

@@ -11,7 +11,7 @@ var out=' <div class="profiler-result"> <div class="profiler-button ';if(it.has_
 }
 MiniProfiler.templates["linksTemplate"] = function anonymous(it
 ) {
-var out=' <a href="'+( MiniProfiler.shareUrl(it.page.id) )+'" class="profiler-share-profiler-results" target="_blank">share</a> <a href="'+( MiniProfiler.moreUrl(it.timing.name) )+'" class="profiler-more-actions">more</a> ';if(it.page.has_flamegraph){out+=' <a href="'+( MiniProfiler.flamegraphUrl(it.page.id) )+'" class="profiler-show-flamegraph" target="_blank">flamegraph</a> ';}out+=' ';if(it.custom_link){out+=' <a href="'+( it.custom_link )+'" class="profiler-custom-link" target="_blank">'+( it.custom_link_name )+'</a> ';}out+=' ';if(it.page.has_trivial_timings){out+=' <a class="profiler-toggle-trivial" data-show-on-load="'+( it.page.has_all_trivial_timings )+'" title="toggles any rows with &lt; '+( it.page.trivial_duration_threshold_milliseconds )+' ms"> show trivial </a> ';}return out;
+var out=' <a href="'+( MiniProfiler.shareUrl(it.page.id) )+'" class="profiler-share-profiler-results" target="_blank">share</a> <a href="'+( MiniProfiler.moreUrl(it.page.name) )+'" class="profiler-more-actions">more</a> ';if(it.page.has_flamegraph){out+=' <a href="'+( MiniProfiler.flamegraphUrl(it.page.id) )+'" class="profiler-show-flamegraph" target="_blank">flamegraph</a> ';}out+=' ';if(it.custom_link){out+=' <a href="'+( it.custom_link )+'" class="profiler-custom-link" target="_blank">'+( it.custom_link_name )+'</a> ';}out+=' ';if(it.page.has_trivial_timings){out+=' <a class="profiler-toggle-trivial" data-show-on-load="'+( it.page.has_all_trivial_timings )+'" title="toggles any rows with &lt; '+( it.page.trivial_duration_threshold_milliseconds )+' ms"> show trivial </a> ';}return out;
 }
 MiniProfiler.templates["timingTemplate"] = function anonymous(it
 ) {

data/lib/mini_profiler/actions.rb ADDED Viewed

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+module Rack
+  class MiniProfiler
+    module Actions
+      def serve_snapshot(env)
+        MiniProfiler.authorize_request
+        status = 200
+        headers = { 'Content-Type' => 'text/html' }
+        qp = Rack::Utils.parse_nested_query(env['QUERY_STRING'])
+        if group_name = qp["group_name"]
+          list = @storage.snapshots_group(group_name)
+          list.each do |snapshot|
+            snapshot[:url] = url_for_snapshot(snapshot[:id], group_name)
+          end
+          data = {
+            group_name: group_name,
+            list: list
+          }
+        else
+          list = @storage.snapshots_overview
+          list.each do |group|
+            group[:url] = url_for_snapshots_group(group[:name])
+          end
+          data = {
+            page: "overview",
+            list: list
+          }
+        end
+        data_html = <<~HTML
+          <div style="display: none;" id="snapshots-data">
+          #{data.to_json}
+          </div>
+        HTML
+        response = Rack::Response.new([], status, headers)
+        response.write <<~HTML
+          <!DOCTYPE html>
+          <html>
+            <head>
+              <title>Rack::MiniProfiler Snapshots</title>
+            </head>
+            <body class="mp-snapshots">
+        HTML
+        response.write(data_html)
+        script = self.get_profile_script(env)
+        response.write(script)
+        response.write <<~HTML
+            </body>
+          </html>
+        HTML
+        response.finish
+      end
+      def serve_file(env, file_name:)
+        resources_env = env.dup
+        resources_env['PATH_INFO'] = file_name
+        rack_file = Rack::File.new(resources_root, 'Cache-Control' => "max-age=#{cache_control_value}")
+        rack_file.call(resources_env)
+      end
+      def serve_results(env)
+        request     = Rack::Request.new(env)
+        id          = request.params['id']
+        group_name  = request.params['group']
+        is_snapshot = group_name && group_name.size > 0
+        if is_snapshot
+          page_struct = @storage.load_snapshot(id, group_name)
+        else
+          page_struct = @storage.load(id)
+        end
+        if !page_struct && is_snapshot
+          id = ERB::Util.html_escape(id)
+          return [404, {}, ["Snapshot with id '#{id}' not found"]]
+        elsif !page_struct
+          @storage.set_viewed(user(env), id)
+          id        = ERB::Util.html_escape(id)
+          user_info = ERB::Util.html_escape(user(env))
+          return [404, {}, ["Request not found: #{id} - user #{user_info}"]]
+        end
+        if !page_struct[:has_user_viewed] && !is_snapshot
+          page_struct[:client_timings]  = TimerStruct::Client.init_from_form_data(env, page_struct)
+          page_struct[:has_user_viewed] = true
+          @storage.save(page_struct)
+          @storage.set_viewed(user(env), id)
+        end
+        # If we're an XMLHttpRequest, serve up the contents as JSON
+        if request.xhr?
+          result_json = page_struct.to_json
+          [200, { 'Content-Type' => 'application/json' }, [result_json]]
+        else
+          # Otherwise give the HTML back
+          html = generate_html(page_struct, env)
+          [200, { 'Content-Type' => 'text/html' }, [html]]
+        end
+      end
+      def serve_flamegraph(env)
+        request     = Rack::Request.new(env)
+        id          = request.params['id']
+        page_struct = @storage.load(id)
+        if !page_struct
+          id        = ERB::Util.html_escape(id)
+          user_info = ERB::Util.html_escape(user(env))
+          return [404, {}, ["Request not found: #{id} - user #{user_info}"]]
+        end
+        if !page_struct[:flamegraph]
+          return [404, {}, ["No flamegraph available for #{ERB::Util.html_escape(id)}"]]
+        end
+        self.flamegraph(page_struct[:flamegraph], page_struct[:request_path], env)
+      end
+      def serve_profile_gc(env, client_settings)
+        return tool_disabled_message(client_settings) if !advanced_debugging_enabled?
+        client_settings.handle_cookie(Rack::MiniProfiler::GCProfiler.new.profile_gc(@app, env))
+      end
+      def serve_profile_memory(env, client_settings)
+        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"
+          status, headers, body = @app.call(env)
+          body.close if body.respond_to? :close
+          return client_settings.handle_cookie(
+            text_result(message, status: 500, headers: headers)
+          )
+        end
+        query_params = Rack::Utils.parse_nested_query(env['QUERY_STRING'])
+        options = {
+          ignore_files: query_params['memory_profiler_ignore_files'],
+          allow_files: query_params['memory_profiler_allow_files'],
+        }
+        options[:top] = Integer(query_params['memory_profiler_top']) if query_params.key?('memory_profiler_top')
+        result = StringIO.new
+        report = MemoryProfiler.report(options) do
+          _, _, body = @app.call(env)
+          body.close if body.respond_to? :close
+        end
+        report.pretty_print(result)
+        client_settings.handle_cookie(text_result(result.string))
+      end
+    end
+  end
+end

data/lib/mini_profiler/asset_version.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Rack
   class MiniProfiler
-    ASSET_VERSION = '35a79b300ab5afa978cb59af0b05e059'
+    ASSET_VERSION = 'c336b1303a50b21f5222bc23262ca7bf'
   end
 end

data/lib/mini_profiler/config.rb CHANGED Viewed

@@ -30,6 +30,7 @@ module Rack
           @backtrace_threshold_ms = 0
           @flamegraph_sample_rate = 0.5
           @flamegraph_mode = :wall
+          @flamegraph_ignore_gc = false
           @storage_failure = Proc.new do |exception|
             if @logger
               @logger.warn("MiniProfiler storage failure: #{exception.message}")
@@ -76,7 +77,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, :profile_parameter
+        :flamegraph_mode, :flamegraph_ignore_gc, :profile_parameter
       # ui accessors
       attr_accessor :collapse_results, :max_traces_to_show, :position,

data/lib/mini_profiler/profiling_methods.rb CHANGED Viewed

@@ -17,6 +17,10 @@ module Rack
         )
       end
+      def report_reader_duration(elapsed_ms, row_count = nil, class_name = nil)
+        current&.current_timer&.report_reader_duration(elapsed_ms, row_count, class_name)
+      end
       def start_step(name)
         return unless current
         parent_timer          = current.current_timer

data/lib/mini_profiler/storage/memcache_store.rb CHANGED Viewed

@@ -18,6 +18,15 @@ module Rack
         @expires_in_seconds = args[:expires_in] || EXPIRES_IN_SECONDS
       end
+      def alive?
+        begin
+          @client.alive!
+          true
+        rescue Dalli::RingError
+          false
+        end
+      end
       def save(page_struct)
         @client.set("#{@prefix}#{page_struct[:id]}", Marshal::dump(page_struct), @expires_in_seconds)
       end

data/lib/mini_profiler/storage/memory_store.rb CHANGED Viewed

@@ -10,11 +10,11 @@ module Rack
       class CacheCleanupThread < Thread
         def initialize(interval, cycle, store)
-          super
           @store       = store
           @interval    = interval
           @cycle       = cycle
           @cycle_count = 1
+          super
         end
         def should_cleanup?
@@ -78,7 +78,7 @@ module Rack
         cleanup_cycle    = args.fetch(:cleanup_cycle)    { CLEANUP_CYCLE }
         t = CacheCleanupThread.new(cleanup_interval, cleanup_cycle, self) do
           until Thread.current[:should_exit] do
-            t.sleepy_run
+            Thread.current.sleepy_run
           end
         end
         at_exit { t[:should_exit] = true }

data/lib/mini_profiler/timer_struct/request.rb CHANGED Viewed

@@ -125,6 +125,12 @@ module Rack
           end
         end
+        # please call SqlTiming#report_reader_duration instead
+        def report_reader_duration(elapsed_ms, row_count = nil, class_name = nil)
+          last_time = self[:sql_timings]&.last
+          last_time&.report_reader_duration(elapsed_ms, row_count, class_name)
+        end
         def add_custom(type, elapsed_ms, page)
           TimerStruct::Custom.new(type, elapsed_ms, page, self).tap do |timer|
             timer[:parent_timing_id] = self[:id]

data/lib/mini_profiler/timer_struct/sql.rb CHANGED Viewed

@@ -51,12 +51,14 @@ module Rack
           )
         end
-        def report_reader_duration(elapsed_ms)
+        def report_reader_duration(elapsed_ms, row_count = nil, class_name = nil)
           return if @reported
           @reported = true
           self[:duration_milliseconds]                += elapsed_ms
           @parent[:sql_timings_duration_milliseconds] += elapsed_ms
           @page[:duration_milliseconds_in_sql]        += elapsed_ms
+          self[:row_count] = self[:row_count].to_i + row_count if row_count
+          self[:class_name] = class_name if class_name
         end
         def trim_binds(binds)

data/lib/mini_profiler/version.rb CHANGED Viewed

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

data/lib/mini_profiler/views.rb ADDED Viewed

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+module Rack
+  class MiniProfiler
+    module Views
+      def resources_root
+        @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__))))
+      end
+      def generate_html(page_struct, env, result_json = page_struct.to_json)
+        # double-assigning to suppress "assigned but unused variable" warnings
+        path = path = "#{env['RACK_MINI_PROFILER_ORIGINAL_SCRIPT_NAME']}#{@config.base_url_path}"
+        version = version = MiniProfiler::ASSET_VERSION
+        json = json = result_json
+        includes = includes = get_profile_script(env)
+        name = name = page_struct[:name]
+        duration = duration = page_struct.duration_ms.round(1).to_s
+        share_template.result(binding)
+      end
+      # get_profile_script returns script to be injected inside current html page
+      # By default, profile_script is appended to the end of all html requests automatically.
+      # Calling get_profile_script cancels automatic append for the current page
+      # Use it when:
+      # * you have disabled auto append behaviour throught :auto_inject => false flag
+      # * you do not want script to be automatically appended for the current page. You can also call cancel_auto_inject
+      def get_profile_script(env)
+        path = public_base_path(env)
+        version = MiniProfiler::ASSET_VERSION
+        if @config.assets_url
+          url = @config.assets_url.call('rack-mini-profiler.js', version, env)
+          css_url = @config.assets_url.call('rack-mini-profiler.css', version, env)
+        end
+        url = "#{path}includes.js?v=#{version}" if !url
+        css_url = "#{path}includes.css?v=#{version}" if !css_url
+        content_security_policy_nonce = @config.content_security_policy_nonce ||
+                                        env["action_dispatch.content_security_policy_nonce"] ||
+                                        env["secure_headers_content_security_policy_nonce"]
+        settings = {
+         path: path,
+         url: url,
+         cssUrl: css_url,
+         version: version,
+         verticalPosition: @config.vertical_position,
+         horizontalPosition: @config.horizontal_position,
+         showTrivial: @config.show_trivial,
+         showChildren: @config.show_children,
+         maxTracesToShow: @config.max_traces_to_show,
+         showControls: @config.show_controls,
+         showTotalSqlCount: @config.show_total_sql_count,
+         authorized: true,
+         toggleShortcut: @config.toggle_shortcut,
+         startHidden: @config.start_hidden,
+         collapseResults: @config.collapse_results,
+         htmlContainer: @config.html_container,
+         hiddenCustomFields: @config.snapshot_hidden_custom_fields.join(','),
+         cspNonce: content_security_policy_nonce,
+         hotwireTurboDriveSupport: @config.enable_hotwire_turbo_drive_support,
+        }
+        if current && current.page_struct
+          settings[:ids]       = ids_comma_separated(env)
+          settings[:currentId] = current.page_struct[:id]
+        else
+          settings[:ids]       = []
+          settings[:currentId] = ""
+        end
+        # TODO : cache this snippet
+        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}\\}")
+          script.gsub!(regex, v.to_s)
+        end
+        current.inject_js = false if current
+        script
+      end
+      BLANK_PAGE = <<~HTML
+        <!DOCTYPE html>
+        <html>
+          <head>
+            <title>Rack::MiniProfiler Requests</title>
+          </head>
+          <body>
+          </body>
+        </html>
+      HTML
+      def blank_page_html
+        BLANK_PAGE
+      end
+      def make_link(postfix, env)
+        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 flamegraph(graph, path, env)
+        headers = { 'Content-Type' => 'text/html' }
+        iframe_src = "#{public_base_path(env)}speedscope/index.html"
+        html = <<~HTML
+          <!DOCTYPE html>
+          <html>
+            <head>
+              <title>Rack::MiniProfiler Flamegraph</title>
+              <style>
+                body { margin: 0; height: 100vh; }
+                #speedscope-iframe { width: 100%; height: 100%; border: none; }
+              </style>
+            </head>
+            <body>
+              <script type="text/javascript">
+                var graph = #{JSON.generate(graph)};
+                var json = JSON.stringify(graph);
+                var blob = new Blob([json], { type: 'text/plain' });
+                var objUrl = encodeURIComponent(URL.createObjectURL(blob));
+                var iframe = document.createElement('IFRAME');
+                iframe.setAttribute('id', 'speedscope-iframe');
+                document.body.appendChild(iframe);
+                var iframeUrl = '#{iframe_src}#profileURL=' + objUrl + '&title=' + 'Flamegraph for #{CGI.escape(path)}';
+                iframe.setAttribute('src', iframeUrl);
+              </script>
+            </body>
+          </html>
+        HTML
+        [200, headers, [html]]
+      end
+      def help(client_settings, env)
+        headers = { 'Content-Type' => 'text/html' }
+        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&flamegraph_ignore_gc=true", env}: ignore garbage collection frames in flamegraphs. 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
+                All features can also be accessed by adding the X-Rack-Mini-Profiler header to the request, with any of the values above (e.g. 'X-Rack-Mini-Profiler: flamegraph')
+              </pre>
+            </body>
+          </html>
+        HTML
+        [200, headers, [html]]
+      end
+      def url_for_snapshots_group(group_name)
+        qs = Rack::Utils.build_query({ group_name: group_name })
+        "/#{@config.base_url_path.gsub('/', '')}/snapshots?#{qs}"
+      end
+      def url_for_snapshot(id, group_name)
+        qs = Rack::Utils.build_query({ id: id, group: group_name })
+        "/#{@config.base_url_path.gsub('/', '')}/results?#{qs}"
+      end
+      def public_base_path(env)
+        "#{env['RACK_MINI_PROFILER_ORIGINAL_SCRIPT_NAME']}#{@config.base_url_path}"
+      end
+    end
+  end
+end