ultra-fast-tool 0.0.1

data/sidekiq-8.1.6/lib/sidekiq/web/config.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Sidekiq
+  class Web
+    ##
+    # Configure the Sidekiq::Web instance in this process:
+    #
+    #   require "sidekiq/web"
+    #   Sidekiq::Web.configure do |config|
+    #     config.register(MyExtension, name: "myext", tab: "TabName", index: "tabpage/")
+    #   end
+    #
+    # This should go in your `config/routes.rb` or similar. It
+    # does not belong in your initializer since Web should not be
+    # loaded in some processes (like an actual Sidekiq process).
+    # See `examples/webui-ext` for a sample web extension.
+    class Config
+      extend Forwardable
+
+      OPTIONS = {
+        # By default we support direct uploads to p.f.c since the UI is a JS SPA
+        # and very difficult for us to vendor or provide ourselves. If you are worried
+        # about data security and wish to self-host, you can change these URLs.
+        profile_view_url: "https://profiler.firefox.com/public/%s",
+        profile_store_url: "https://api.profiler.firefox.com/compressed-store"
+      }
+
+      ##
+      # Allows users to add custom rows to all of the Job
+      # tables, e.g. Retries, Dead, Scheduled, with custom
+      # links to other systems, see _job_info.erb and test
+      # in web_test.rb
+      #
+      #   Sidekiq::Web.configure do |cfg|
+      #     cfg.custom_job_info_rows << JobLogLink.new
+      #   end
+      #
+      #   class JobLogLink
+      #     def add_pair(job)
+      #       yield "External Logs", "<a href='https://example.com/logs/#{job.jid}'>Logs for #{job.jid}</a>"
+      #     end
+      #   end
+      attr_accessor :custom_job_info_rows
+
+      attr_reader :tabs
+      attr_reader :locales
+      attr_reader :views
+      attr_reader :middlewares
+
+      # Adds the "Back to App" link in the header
+      attr_accessor :app_url
+      attr_accessor :assets_path
+
+      def initialize
+        @options = OPTIONS.dup
+        @locales = LOCALES
+        @views = VIEWS
+        @assets_path = ASSETS
+        @tabs = DEFAULT_TABS.dup
+        @middlewares = []
+        @custom_job_info_rows = []
+      end
+
+      def_delegators :@options, :[], :[]=, :fetch, :key?, :has_key?, :merge!, :dig
+
+      def use(*args, &block)
+        middlewares << [args, block]
+      end
+
+      # Register a class as a Sidekiq Web UI extension. The class should
+      # provide one or more tabs which map to an index route. Options:
+      #
+      # @param extclass [Class] Class which contains the HTTP actions, required
+      # @param name [String] the name of the extension, used to namespace assets
+      # @param tab [String | Array] labels(s) of the UI tabs
+      # @param index [String | Array] index route(s) for each tab
+      # @param root_dir [String] directory location to find assets, locales and views, typically `web/` within the gemfile
+      # @param asset_paths [Array] one or more directories under {root}/assets/{name} to be publicly served, e.g. ["js", "css", "img"]
+      # @param cache_for [Integer] amount of time to cache assets, default one day
+      #
+      # Web extensions will have a root `web/` directory with `locales/`, `assets/`
+      # and `views/` subdirectories.
+      def register_extension(extclass, name:, tab:, index:, root_dir: nil, cache_for: 86400, asset_paths: nil)
+        tab = Array(tab)
+        index = Array(index)
+        tab.zip(index).each do |tab, index|
+          tabs[tab] = index
+        end
+        if root_dir
+          locdir = File.join(root_dir, "locales")
+          locales << locdir if File.directory?(locdir)
+
+          if asset_paths && name
+            # if you have {root}/assets/{name}/js/scripts.js
+            # and {root}/assets/{name}/css/styles.css
+            # you would pass in:
+            #   asset_paths: ["js", "css"]
+            # See script_tag and style_tag in web/helpers.rb
+            assdir = File.join(root_dir, "assets")
+            assurls = Array(asset_paths).map { |x| "/#{name}/#{x}" }
+            assetprops = {
+              urls: assurls,
+              root: assdir,
+              cascade: true
+            }
+            assetprops[:header_rules] = [[:all, {"cache-control" => "private, max-age=#{cache_for.to_i}"}]] if cache_for
+            middlewares << [[Rack::Static, assetprops], nil]
+          end
+        end
+
+        yield self if block_given?
+        extclass.registered(Web::Application)
+      end
+      alias_method :register, :register_extension
+    end
+  end
+end

data/sidekiq-8.1.6/lib/sidekiq/web/helpers.rb

@@ -0,0 +1,474 @@
+# frozen_string_literal: true
+
+require "uri"
+require "cgi/escape"
+
+module Sidekiq
+  # These methods are available to pages within the Web UI and UI extensions.
+  # They are not public APIs for applications to use.
+  module WebHelpers
+    def store_name
+      hash = redis_info
+      return "Dragonfly" if hash.has_key?("dragonfly_version")
+      return "Valkey" if hash.has_key?("valkey_version")
+      "Redis"
+    end
+
+    def store_version
+      hash = redis_info
+      return hash["dragonfly_version"] if hash.has_key?("dragonfly_version")
+      return hash["valkey_version"] if hash.has_key?("valkey_version")
+      hash["redis_version"]
+    end
+
+    def style_tag(location, **kwargs)
+      global = location.match?(/:\/\//)
+      location = root_path + location if !global && !location.start_with?(root_path)
+      attrs = {
+        type: "text/css",
+        media: "screen",
+        rel: "stylesheet",
+        nonce: csp_nonce,
+        href: location
+      }
+      add_to_head do
+        html_tag(:link, attrs.merge(kwargs))
+      end
+    end
+
+    def script_tag(location, **kwargs)
+      global = location.match?(/:\/\//)
+      location = root_path + location if !global && !location.start_with?(root_path)
+      attrs = {
+        type: "text/javascript",
+        nonce: csp_nonce,
+        src: location
+      }
+      html_tag(:script, attrs.merge(kwargs)) {}
+    end
+
+    # NB: keys and values are not escaped; do not allow user input
+    # in the attributes
+    private def html_tag(tagname, attrs)
+      s = "<#{tagname}"
+      attrs.each_pair do |k, v|
+        next unless v
+        s << " #{k}=\"#{v}\""
+      end
+      if block_given?
+        s << ">"
+        yield s
+        s << "</#{tagname}>"
+      else
+        s << " />"
+      end
+      s
+    end
+
+    def strings(lang)
+      @@strings ||= {}
+
+      # Allow sidekiq-web extensions to add locale paths
+      # so extensions can be localized
+      @@strings[lang] ||= config.locales.each_with_object({}) do |path, global|
+        find_locale_files(lang).each do |file|
+          strs = parse_yaml(file)
+          global.merge!(strs[lang])
+        end
+      end
+    end
+
+    def parse_yaml(path)
+      locale = nil
+      map = {}
+      IO.readlines(path, chomp: true).each do |line|
+        case line
+        when /\A\s*\#.*/
+          # line comment
+        when !locale && /\A([a-zA-Z\-_]+):/
+          locale = $1
+          map[locale] = {}
+        when /\A\s+(\w+):\s+(.+)\z/
+          # A few values have double quotes to include special characters in YAML.
+          # Strip them off manually as our greedy match will include them.
+          key = $1
+          s = $2
+          s = s[1..] if s[0] == "\""
+          s = s[0..-2] if s[-1] == "\""
+          map[locale][key] = s
+        else
+          raise ArgumentError, "unable to parse #{path}: #{line}"
+        end
+      end
+      map
+    end
+
+    def to_json(x)
+      Sidekiq.dump_json(x)
+    end
+
+    def singularize(str, count)
+      if count == 1 && str.respond_to?(:singularize) # rails
+        str.singularize
+      else
+        str
+      end
+    end
+
+    def clear_caches
+      @@strings = nil
+      @@locale_files = nil
+      @@available_locales = nil
+    end
+
+    def locale_files
+      @@locale_files ||= config.locales.flat_map { |path|
+        Dir["#{path}/*.yml"]
+      }
+    end
+
+    def available_locales
+      @@available_locales ||= Set.new(locale_files.map { |path| File.basename(path, ".yml") })
+    end
+
+    def find_locale_files(lang)
+      locale_files.select { |file| file =~ /\/#{lang}\.yml$/ }
+    end
+
+    def language_name(locale)
+      strings(locale).fetch("LanguageName", locale)
+    end
+
+    def search(jobset, substr)
+      resultset = jobset.scan(substr).to_a
+      @current_page = 1
+      @count = @total_size = resultset.size
+      resultset
+    end
+
+    def filtering(which, placeholder_key: "AnyJobContent", label_key: "Filter")
+      erb(:filtering, locals: {which:, placeholder_key:, label_key:})
+    end
+
+    def filter_link(str, within = "retries")
+      hstr = h(str)
+      if within.nil?
+        hstr
+      else
+        "<a href='#{root_path}#{within}?substr=#{hstr}'>#{hstr}</a>"
+      end
+    end
+
+    def display_tags(job, within = "retries")
+      job.tags.map { |tag|
+        "<span class='label label-info jobtag jobtag-#{h(tag)}'>#{filter_link(tag, within)}</span>"
+      }.join(" ")
+    end
+
+    # This view helper provide ability display you html code in
+    # to head of page. Example:
+    #
+    #   <% add_to_head do %>
+    #     <link rel="stylesheet" .../>
+    #     <meta .../>
+    #   <% end %>
+    #
+    def add_to_head
+      @head_html ||= []
+      @head_html << yield.dup if block_given?
+    end
+
+    def display_custom_head
+      @head_html.join if defined?(@head_html)
+    end
+
+    def text_direction
+      get_locale["TextDirection"] || "ltr"
+    end
+
+    def rtl?
+      text_direction == "rtl"
+    end
+
+    # See https://www.rfc-editor.org/rfc/rfc9110.html#section-12.5.4
+    # Returns an array of language tags ordered by their quality value
+    #
+    # Inspiration taken from https://github.com/iain/http_accept_language/blob/master/lib/http_accept_language/parser.rb
+    def user_preferred_languages
+      languages = env["HTTP_ACCEPT_LANGUAGE"]
+      languages.to_s.gsub(/\s+/, "").split(",").map { |language|
+        locale, quality = language.split(";q=", 2)
+        locale = nil if locale == "*" # Ignore wildcards
+        quality = quality ? quality.to_f : 1.0
+        [locale, quality]
+      }.sort { |(_, left), (_, right)|
+        right <=> left
+      }.map(&:first).compact
+    end
+
+    # Given an Accept-Language header like "fr-FR,fr;q=0.8,en-US;q=0.6,en;q=0.4,ru;q=0.2"
+    # this method will try to best match the available locales to the user's preferred languages.
+    def locale
+      # session[:locale] is set via the locale selector from the footer
+      @locale ||= if (l = session&.fetch(:locale, nil)) && available_locales.include?(l)
+        l
+      else
+        matched_locale = nil
+        # Attempt to find a case-insensitive exact match first
+        user_preferred_languages.each do |preferred|
+          # We only care about the language and primary subtag
+          # "en-GB-oxendict" becomes "en-GB"
+          language_tag = preferred.split("-")[0..1].join("-")
+          matched_locale = available_locales.find { |available_locale| available_locale.casecmp?(language_tag) }
+          break if matched_locale
+        end
+
+        return matched_locale if matched_locale
+
+        # Find the first base language match
+        # "en-US,es-MX;q=0.9" matches "en"
+        user_preferred_languages.each do |preferred|
+          base_language = preferred.split("-", 2).first
+          matched_locale = available_locales.find { |available_locale| available_locale.casecmp?(base_language) }
+          break if matched_locale
+        end
+
+        matched_locale || "en"
+      end
+    end
+
+    # sidekiq/sidekiq#3243
+    def unfiltered?
+      s = url_params("substr")
+      yield unless s && s.size > 0
+    end
+
+    def get_locale
+      strings(locale)
+    end
+
+    def t(msg, options = {})
+      string = get_locale[msg] || strings("en")[msg] || msg
+      if options.empty?
+        string
+      else
+        string % options
+      end
+    end
+
+    def sort_direction_label
+      (url_params("direction") == "asc") ? "&uarr;" : "&darr;"
+    end
+
+    def workset
+      @work ||= Sidekiq::WorkSet.new
+    end
+
+    def processes
+      @processes ||= Sidekiq::ProcessSet.new
+    end
+
+    # Sorts processes by hostname following the natural sort order
+    def sorted_processes
+      @sorted_processes ||= begin
+        return processes unless processes.all? { |p| p["hostname"] }
+
+        processes.to_a.sort_by do |process|
+          # Kudos to `shurikk` on StackOverflow
+          # https://stackoverflow.com/a/15170063/575547
+          process["hostname"].split(/(\d+)/).map { |a| /\d+/.match?(a) ? a.to_i : a }
+        end
+      end
+    end
+
+    def stats
+      @stats ||= Sidekiq::Stats.new
+    end
+
+    def redis_url
+      Sidekiq.redis do |conn|
+        conn.config.server_url
+      end
+    end
+
+    def redis_info
+      @info ||= Sidekiq.default_configuration.redis_info
+    end
+
+    def root_path
+      "#{env["SCRIPT_NAME"]}/"
+    end
+
+    def current_path
+      @current_path ||= request.path_info.gsub(/^\//, "")
+    end
+
+    def current_status
+      (workset.size == 0) ? "idle" : "active"
+    end
+
+    def relative_time(time)
+      stamp = time.getutc.iso8601
+      %(<time class="ltr" dir="ltr" title="#{stamp}" datetime="#{stamp}">#{time}</time>)
+    end
+
+    def queue_names_by_capsule(pro)
+      cap = pro.capsules
+      if cap
+        cap.map { |k, v| v["weights"].keys.join(", ") }.join("; ")
+      else
+        # DEPRECATED Backwards compatibility with older processes.
+        # 'capsules' element added in v8.0.9
+        pro.queues.join(", ")
+      end
+    end
+
+    def job_params(job, score)
+      "#{score}-#{job["jid"]}"
+    end
+
+    def parse_key(key)
+      score, jid = key.split("-", 2)
+      [score.to_f, jid]
+    end
+
+    SAFE_QPARAMS = %w[page direction only]
+
+    # Merge options with current params, filter safe params, and stringify to query string
+    def qparams(options)
+      stringified_options = options.transform_keys(&:to_s)
+
+      to_query_string(request.params.merge(stringified_options))
+    end
+
+    def to_query_string(hash)
+      hash.map { |key, value|
+        SAFE_QPARAMS.include?(key) ? "#{key}=#{CGI.escape(value.to_s)}" : next
+      }.compact.join("&")
+    end
+
+    def truncate(text, truncate_after_chars = 2000)
+      (truncate_after_chars && text.size > truncate_after_chars) ? "#{text[0..truncate_after_chars]}..." : text
+    end
+
+    def display_args(args, truncate_after_chars = 2000)
+      return "Invalid job payload, args is nil" if args.nil?
+      return "Invalid job payload, args must be an Array, not #{args.class.name}" unless args.is_a?(Array)
+
+      begin
+        args.map { |arg|
+          h(truncate(to_display(arg), truncate_after_chars))
+        }.join(", ")
+      rescue
+        "Illegal job arguments: #{h args.inspect}"
+      end
+    end
+
+    def csrf_tag
+      ""
+    end
+
+    def csp_nonce
+      env[:csp_nonce]
+    end
+
+    def to_display(arg)
+      arg.inspect
+    rescue
+      begin
+        arg.to_s
+      rescue => ex
+        "Cannot display argument: [#{ex.class.name}] #{ex.message}"
+      end
+    end
+
+    RETRY_JOB_KEYS = Set.new(%w[
+      queue class args retry_count retried_at failed_at
+      jid error_message error_class backtrace
+      error_backtrace enqueued_at retry wrapped
+      created_at tags display_class
+    ])
+
+    def retry_extra_items(retry_job)
+      @retry_extra_items ||= {}.tap do |extra|
+        retry_job.item.each do |key, value|
+          extra[key] = value unless RETRY_JOB_KEYS.include?(key)
+        end
+      end
+    end
+
+    def format_memory(rss_kb)
+      return "0" if rss_kb.nil? || rss_kb == 0
+
+      if rss_kb < 100_000
+        "#{number_with_delimiter(rss_kb)} KB"
+      elsif rss_kb < 10_000_000
+        "#{number_with_delimiter((rss_kb / 1024.0).to_i)} MB"
+      else
+        "#{number_with_delimiter(rss_kb / (1024.0 * 1024.0), precision: 1)} GB"
+      end
+    end
+
+    def number_with_delimiter(number, options = {})
+      precision = options[:precision] || 0
+      %(<span data-nwp="#{precision}">#{number.round(precision)}</span>)
+    end
+
+    def h(text)
+      ::CGI.escapeHTML(text.to_s)
+    rescue ArgumentError => e
+      raise unless e.message.eql?("invalid byte sequence in UTF-8")
+      text.encode!("UTF-16", "UTF-8", invalid: :replace, replace: "").encode!("UTF-8", "UTF-16")
+      retry
+    end
+
+    # Any paginated list that performs an action needs to redirect
+    # back to the proper page after performing that action.
+    def redirect_with_query(url)
+      r = request.referer
+      if r && r =~ /\?/
+        ref = URI(r)
+        redirect("#{url}?#{ref.query}")
+      else
+        redirect url
+      end
+    end
+
+    def environment_title_prefix
+      environment = Sidekiq.default_configuration[:environment] || ENV["APP_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+
+      "[#{environment.upcase}] " unless environment == "production"
+    end
+
+    def product_version
+      "Sidekiq v#{Sidekiq::VERSION}"
+    end
+
+    def server_utc_time
+      Time.now.utc.strftime("%H:%M:%S UTC")
+    end
+
+    def pollable?
+      # there's no point to refreshing the metrics pages every N seconds
+      !(current_path == "" || current_path.index("metrics"))
+    end
+
+    def retry_or_delete_or_kill(job, params)
+      if params["retry"]
+        job.retry
+      elsif params["delete"]
+        job.delete
+      elsif params["kill"]
+        job.kill
+      end
+    end
+
+    def delete_or_add_queue(job, params)
+      if params["delete"]
+        job.delete
+      elsif params["add_to_queue"]
+        job.add_to_queue
+      end
+    end
+  end
+end

data/sidekiq-8.1.6/lib/sidekiq/web/router.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Sidekiq
+  class Web
+    # Provides an API to declare endpoints, along with a match
+    # API to dynamically route a request to an endpoint.
+    module Router
+      def head(path, &) = route(:head, path, &)
+
+      def get(path, &) = route(:get, path, &)
+
+      def post(path, &) = route(:post, path, &)
+
+      def put(path, &) = route(:put, path, &)
+
+      def patch(path, &) = route(:patch, path, &)
+
+      def delete(path, &) = route(:delete, path, &)
+
+      def route(*methods, path, &block)
+        methods.each do |method|
+          raise ArgumentError, "Invalid method #{method}. Must be one of #{@routes.keys.join(",")}" unless route_cache.has_key?(method)
+          route_cache[method] << Route.new(method, path, block)
+        end
+      end
+
+      def match(env)
+        request_method = env["REQUEST_METHOD"].downcase.to_sym
+        path_info = ::URI::RFC2396_PARSER.unescape env["PATH_INFO"]
+
+        # There are servers which send an empty string when requesting the root.
+        # These servers should be ashamed of themselves.
+        path_info = "/" if path_info == ""
+
+        route_cache[request_method].each do |route|
+          params = route.match(request_method, path_info)
+          if params
+            env["rack.route_params"] = params
+            return Action.new(env, route.block)
+          end
+        end
+
+        nil
+      end
+
+      def route_cache
+        @@routes ||= {get: [], post: [], put: [], patch: [], delete: [], head: []}
+      end
+    end
+
+    class Route
+      attr_accessor :request_method, :pattern, :block, :name
+
+      NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([^.:$\/]+)/
+
+      def initialize(request_method, pattern, block)
+        @request_method = request_method
+        @pattern = pattern
+        @block = block
+      end
+
+      def matcher
+        @matcher ||= compile
+      end
+
+      def compile
+        if pattern.match?(NAMED_SEGMENTS_PATTERN)
+          p = pattern.gsub(NAMED_SEGMENTS_PATTERN, '/\1(?<\2>[^$/]+)')
+
+          Regexp.new("\\A#{p}\\Z")
+        else
+          pattern
+        end
+      end
+
+      EMPTY = {}.freeze
+
+      def match(request_method, path)
+        case matcher
+        when String
+          EMPTY if path == matcher
+        else
+          path_match = path.match(matcher)
+          path_match&.named_captures&.transform_keys(&:to_sym)
+        end
+      end
+    end
+  end
+end