RubyGems - mini-sharp-hub - Versions diffs - 0.0.1 - Mend

mini-sharp-hub 0.0.1

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 (86) hide show

data/rack-mini-profiler-4.0.1/lib/mini_profiler/actions.rb ADDED Viewed

@@ -0,0 +1,157 @@
+# 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
+        if Gem::Version.new(Rack.release) >= Gem::Version.new("2.1.0")
+          rack_file = Rack::Files.new(resources_root, 'cache-control' => "max-age=#{cache_control_value}")
+        else
+          rack_file = Rack::File.new(resources_root, 'cache-control' => "max-age=#{cache_control_value}")
+        end
+        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/rack-mini-profiler-4.0.1/lib/mini_profiler/asset_version.rb ADDED Viewed

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Rack
+  class MiniProfiler
+    ASSET_VERSION = 'e0bcc9ce0ae3bb5d6b736b6f282f601f'
+  end
+end

data/rack-mini-profiler-4.0.1/lib/mini_profiler/client_settings.rb ADDED Viewed

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+module Rack
+  class MiniProfiler
+    class ClientSettings
+      COOKIE_NAME = "__profilin"
+      BACKTRACE_DEFAULT = nil
+      BACKTRACE_FULL    = 1
+      BACKTRACE_NONE    = 2
+      attr_accessor :disable_profiling
+      attr_accessor :backtrace_level
+      def initialize(env, store, start)
+        @request = ::Rack::Request.new(env)
+        @cookie = @request.cookies[COOKIE_NAME]
+        @store = store
+        @start = start
+        @backtrace_level = nil
+        @orig_disable_profiling = @disable_profiling = nil
+        @allowed_tokens, @orig_auth_tokens = nil
+        if @cookie
+          @cookie.split(",").map { |pair| pair.split("=") }.each do |k, v|
+            @orig_disable_profiling = @disable_profiling = (v == 't') if k == "dp"
+            @backtrace_level = v.to_i if k == "bt"
+            @orig_auth_tokens = v.to_s.split("|") if k == "a"
+          end
+        end
+        if !@backtrace_level.nil? && (@backtrace_level == 0 || @backtrace_level > BACKTRACE_NONE)
+          @backtrace_level = nil
+        end
+        @orig_backtrace_level = @backtrace_level
+      end
+      def handle_cookie(result)
+        status, headers, _body = result
+        if (MiniProfiler.config.authorization_mode == :allow_authorized && !MiniProfiler.request_authorized?)
+          # this is non-obvious, don't kill the profiling cookie on errors or short requests
+          # this ensures that stuff that never reaches the rails stack does not kill profiling
+          if status.to_i >= 200 && status.to_i < 300 && ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - @start) > 0.1)
+            discard_cookie!(headers)
+          end
+        else
+          write!(headers)
+        end
+        result
+      end
+      def write!(headers)
+        tokens_changed = false
+        if MiniProfiler.request_authorized? && MiniProfiler.config.authorization_mode == :allow_authorized
+          @allowed_tokens ||= @store.allowed_tokens
+          tokens_changed = !@orig_auth_tokens || ((@allowed_tokens - @orig_auth_tokens).length > 0)
+        end
+        if  @orig_disable_profiling != @disable_profiling ||
+            @orig_backtrace_level != @backtrace_level ||
+            @cookie.nil? ||
+            tokens_changed
+          settings = { "p" => "t" }
+          settings["dp"] = "t"                  if @disable_profiling
+          settings["bt"] = @backtrace_level     if @backtrace_level
+          settings["a"] = @allowed_tokens.join("|") if @allowed_tokens && MiniProfiler.request_authorized?
+          settings_string = settings.map { |k, v| "#{k}=#{v}" }.join(",")
+          cookie = { value: settings_string, path: MiniProfiler.config.cookie_path, httponly: true }
+          cookie[:secure] = true if @request.ssl?
+          cookie[:same_site] = 'Lax'
+          Rack::Utils.set_cookie_header!(headers, COOKIE_NAME, cookie)
+        end
+      end
+      def discard_cookie!(headers)
+        if @cookie
+          Rack::Utils.delete_cookie_header!(headers, COOKIE_NAME, path: MiniProfiler.config.cookie_path)
+        end
+      end
+      def has_valid_cookie?
+        valid_cookie = !@cookie.nil?
+        if (MiniProfiler.config.authorization_mode == :allow_authorized) && valid_cookie
+          begin
+            @allowed_tokens ||= @store.allowed_tokens
+          rescue => e
+            if MiniProfiler.config.storage_failure != nil
+              MiniProfiler.config.storage_failure.call(e)
+            end
+          end
+          valid_cookie = @allowed_tokens &&
+            (Array === @orig_auth_tokens) &&
+            ((@allowed_tokens & @orig_auth_tokens).length > 0)
+        end
+        valid_cookie
+      end
+      def disable_profiling?
+        @disable_profiling
+      end
+      def backtrace_full?
+        @backtrace_level == BACKTRACE_FULL
+      end
+      def backtrace_default?
+        @backtrace_level == BACKTRACE_DEFAULT
+      end
+      def backtrace_none?
+        @backtrace_level == BACKTRACE_NONE
+      end
+    end
+  end
+end

data/rack-mini-profiler-4.0.1/lib/mini_profiler/config.rb ADDED Viewed

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+module Rack
+  class MiniProfiler
+    class Config
+      def self.attr_accessor(*vars)
+        @attributes ||= []
+        @attributes.concat vars
+        super(*vars)
+      end
+      def self.attributes
+        @attributes
+      end
+      def self.default
+        new.instance_eval {
+          @auto_inject      = true # automatically inject on every html page
+          @base_url_path    = "/mini-profiler-resources/".dup
+          @cookie_path      = "/".dup
+          @disable_caching  = true
+          # called prior to rack chain, to ensure we are allowed to profile
+          @pre_authorize_cb = lambda { |env| true }
+          # called after rack chain, to ensure we are REALLY allowed to profile
+          @skip_schema_queries    = false
+          @storage                = MiniProfiler::MemoryStore
+          @user_provider          = Proc.new { |env| Rack::Request.new(env).ip }
+          @authorization_mode     = :allow_all
+          @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}")
+            end
+          end
+          @enabled = true
+          @max_sql_param_length = 0 # disable sql parameter collection by default
+          @skip_sql_param_names = /password/ # skips parameters with the name password by default
+          @enable_advanced_debugging_tools = false
+          @snapshot_every_n_requests = -1
+          @max_snapshot_groups = 50
+          @max_snapshots_per_group = 15
+          # ui parameters
+          @autorized            = true
+          @collapse_results     = true
+          @max_traces_to_show   = 20
+          @show_children        = false
+          @show_controls        = false
+          @show_trivial         = false
+          @show_total_sql_count = false
+          @start_hidden         = false
+          @toggle_shortcut      = 'alt+p'
+          @html_container       = 'body'
+          @position             = "top-left"
+          @snapshot_hidden_custom_fields = []
+          @snapshots_transport_destination_url = nil
+          @snapshots_transport_auth_key = nil
+          @snapshots_redact_sql_queries = true
+          @snapshots_transport_gzip_requests = false
+          @enable_hotwire_turbo_drive_support = false
+          @profile_parameter = "pp"
+          self
+        }
+      end
+      attr_accessor :authorization_mode, :auto_inject, :backtrace_ignores,
+        :backtrace_includes, :backtrace_remove, :backtrace_threshold_ms,
+        :base_url_path, :cookie_path, :disable_caching, :enabled,
+        :flamegraph_sample_rate, :logger, :pre_authorize_cb, :skip_paths,
+        :skip_schema_queries, :storage, :storage_failure, :storage_instance,
+        :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_ignore_gc, :profile_parameter
+      # ui accessors
+      attr_accessor :collapse_results, :max_traces_to_show, :position,
+        :show_children, :show_controls, :show_trivial, :show_total_sql_count,
+        :start_hidden, :toggle_shortcut, :html_container
+      # snapshot related config
+      attr_accessor :snapshot_every_n_requests, :max_snapshots_per_group,
+        :snapshot_hidden_custom_fields, :snapshots_transport_destination_url,
+        :snapshots_transport_auth_key, :snapshots_redact_sql_queries,
+        :snapshots_transport_gzip_requests, :max_snapshot_groups
+      # Deprecated options
+      attr_accessor :use_existing_jquery
+      attr_reader :assets_url
+      # redefined - since the accessor defines it first
+      undef :authorization_mode=
+      # rubocop:disable Lint/DuplicateMethods
+      def authorization_mode=(mode)
+        # rubocop:enable Lint/DuplicateMethods
+        if mode == :whitelist
+          warn "[DEPRECATION] `:whitelist` authorization mode is deprecated. Please use `:allow_authorized` instead."
+          mode = :allow_authorized
+        end
+        warn <<~DEP unless mode == :allow_authorized || mode == :allow_all
+          [DEPRECATION] unknown authorization mode #{mode}. Expected `:allow_all` or `:allow_authorized`.
+        DEP
+        @authorization_mode = mode
+      end
+      def assets_url=(lmbda)
+        if defined?(Rack::MiniProfilerRails)
+          Rack::MiniProfilerRails.create_engine
+        end
+        @assets_url = lmbda
+      end
+      def vertical_position
+        position.include?('bottom') ? 'bottom' : 'top'
+      end
+      def horizontal_position
+        position.include?('right') ? 'right' : 'left'
+      end
+      def merge!(config)
+        if config
+          if Hash === config
+            config.each { |k, v| instance_variable_set "@#{k}", v }
+          else
+            self.class.attributes.each { |k|
+              v = config.send k
+              instance_variable_set "@#{k}", v if v
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/rack-mini-profiler-4.0.1/lib/mini_profiler/context.rb ADDED Viewed

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+class Rack::MiniProfiler::Context
+  attr_accessor :inject_js, :current_timer, :page_struct, :skip_backtrace,
+                :full_backtrace, :discard, :mpt_init, :measure
+  def initialize(opts = {})
+    opts["measure"] = true unless opts.key? "measure"
+    opts.each do |k, v|
+      self.instance_variable_set('@' + k, v)
+    end
+  end
+end

data/rack-mini-profiler-4.0.1/lib/mini_profiler/gc_profiler.rb ADDED Viewed

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+class Rack::MiniProfiler::GCProfiler
+  def initialize
+    @ignore = []
+    @ignore << @ignore.__id__
+  end
+  def object_space_stats
+    stats = Hash.new(0).compare_by_identity
+    ids = Hash.new.compare_by_identity
+    @ignore << stats.__id__
+    @ignore << ids.__id__
+    ObjectSpace.each_object { |o|
+      begin
+        stats[o.class] += 1
+        ids[o.__id__] = o if Integer === o.__id__
+      rescue NoMethodError
+        # protect against BasicObject
+      end
+    }
+    @ignore.each do |id|
+      if ids.delete(id)
+        klass = ObjectSpace._id2ref(id).class
+        stats[klass] -= 1
+      end
+    end
+    result = { stats: stats, ids: ids }
+    @ignore << result.__id__
+    result
+  end
+  def diff_object_stats(before, after)
+    diff = {}.compare_by_identity
+    after.each do |k, v|
+      diff[k] = v - before[k]
+    end
+    before.each do |k, v|
+      diff[k] = 0 - v unless after.has_key?(k)
+    end
+    diff
+  end
+  def analyze_strings(ids_before, ids_after)
+    result = {}
+    ids_after.each do |id, _|
+      obj = ObjectSpace._id2ref(id)
+      if String === obj && !ids_before.include?(obj.object_id)
+        result[obj] ||= 0
+        result[obj] += 1
+      end
+    end
+    result
+  end
+  def analyze_growth(ids_before, ids_after)
+    new_objects = 0
+    memory_allocated = 0
+    ids_after.each do |id, _|
+      if !ids_before.include?(id) && obj = ObjectSpace._id2ref(id)
+        # this is going to be version specific (may change in 2.1)
+        size = ObjectSpace.memsize_of(obj)
+        memory_allocated += size
+        new_objects += 1
+      end
+    end
+    [new_objects, memory_allocated]
+  end
+  def analyze_initial_state(ids_before)
+    memory_allocated = 0
+    objects = 0
+    ids_before.each do |id, _|
+      if obj = ObjectSpace._id2ref(id)
+        # this is going to be version specific (may change in 2.1)
+        memory_allocated += ObjectSpace.memsize_of(obj)
+        objects += 1
+      end
+    end
+    [objects, memory_allocated]
+  end
+  def profile_gc(app, env)
+    # for memsize_of
+    require 'objspace'
+    # clean up before
+    GC.start
+    stat          = GC.stat
+    prev_gc_state = GC.disable
+    stat_before   = object_space_stats
+    b             = app.call(env)[2]
+    b.close if b.respond_to? :close
+    stat_after = object_space_stats
+    # so we don't blow out on memory
+    prev_gc_state ? GC.disable : GC.enable
+    diff                          = diff_object_stats(stat_before[:stats], stat_after[:stats])
+    string_analysis               = analyze_strings(stat_before[:ids], stat_after[:ids])
+    new_objects, memory_allocated = analyze_growth(stat_before[:ids], stat_after[:ids])
+    objects_before, memory_before = analyze_initial_state(stat_before[:ids])
+    body = []
+    body << "
+Overview
+--------
+Initial state: object count: #{objects_before}
+Memory allocated outside heap (bytes): #{memory_before}
+GC Stats:
+--------
+#{stat.map { |k, v| "#{k} : #{v}" }.sort!.join("\n")}
+New bytes allocated outside of Ruby heaps: #{memory_allocated}
+New objects: #{new_objects}
+"
+    body << "
+ObjectSpace delta caused by request:
+-----------------------------------\n"
+    diff.to_a.delete_if { |_k, v| v == 0 }.sort_by! { |_k, v| v }.reverse_each do |k, v|
+      body << "#{k} : #{v}\n"
+    end
+    body << "\n
+ObjectSpace stats:
+-----------------\n"
+    stat_after[:stats].to_a.sort_by! { |_k, v| v }.reverse_each do |k, v|
+      body << "#{k} : #{v}\n"
+    end
+    body << "\n
+String stats:
+------------\n"
+    string_analysis.to_a.sort_by! { |_k, v| -v }.take(1000).each do |string, count|
+      body << "#{count} : #{string}\n"
+    end
+    [200, { Rack::CONTENT_TYPE => 'text/plain' }, body]
+  ensure
+    prev_gc_state ? GC.disable : GC.enable
+  end
+end