sidekiq 5.0.0

data/lib/sidekiq/web/helpers.rb

@@ -0,0 +1,286 @@
+# frozen_string_literal: true
+require 'uri'
+require 'set'
+require 'yaml'
+require 'cgi'
+
+module Sidekiq
+  # This is not a public API
+  module WebHelpers
+    def strings(lang)
+      @@strings ||= {}
+      @@strings[lang] ||= begin
+        # Allow sidekiq-web extensions to add locale paths
+        # so extensions can be localized
+        settings.locales.each_with_object({}) do |path, global|
+          find_locale_files(lang).each do |file|
+            strs = YAML.load(File.open(file))
+            global.deep_merge!(strs[lang])
+          end
+        end
+      end
+    end
+
+    def clear_caches
+      @@strings = nil
+      @@locale_files = nil
+    end
+
+    def locale_files
+      @@locale_files ||= settings.locales.flat_map do |path|
+        Dir["#{path}/*.yml"]
+      end
+    end
+
+    def find_locale_files(lang)
+      locale_files.select { |file| file =~ /\/#{lang}\.yml$/ }
+    end
+
+    # This is a hook for a Sidekiq Pro feature.  Please don't touch.
+    def filtering(*)
+    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 poll_path
+      if current_path != '' && params['poll']
+        root_path + current_path
+      else
+        ""
+      end
+    end
+
+    def text_direction
+      get_locale['TextDirection'] || 'ltr'
+    end
+
+    def rtl?
+      text_direction == 'rtl'
+    end
+
+    # Given a browser request Accept-Language header like
+    # "fr-FR,fr;q=0.8,en-US;q=0.6,en;q=0.4,ru;q=0.2", this function
+    # will return "fr" since that's the first code with a matching
+    # locale in web/locales
+    def locale
+      @locale ||= begin
+        locale = 'en'.freeze
+        languages = env['HTTP_ACCEPT_LANGUAGE'.freeze] || 'en'.freeze
+        languages.downcase.split(','.freeze).each do |lang|
+          next if lang == '*'.freeze
+          lang = lang.split(';'.freeze)[0]
+          break locale = lang if find_locale_files(lang).any?
+        end
+        locale
+      end
+    end
+
+    # mperham/sidekiq#3243
+    def unfiltered?
+      yield unless env['PATH_INFO'].start_with?("/filter/")
+    end
+
+    def get_locale
+      strings(locale)
+    end
+
+    def t(msg, options={})
+      string = get_locale[msg] || msg
+      if options.empty?
+        string
+      else
+        string % options
+      end
+    end
+
+    def workers
+      @workers ||= Sidekiq::Workers.new
+    end
+
+    def processes
+      @processes ||= Sidekiq::ProcessSet.new
+    end
+
+    def stats
+      @stats ||= Sidekiq::Stats.new
+    end
+
+    def retries_with_score(score)
+      Sidekiq.redis do |conn|
+        conn.zrangebyscore('retry', score, score)
+      end.map { |msg| Sidekiq.load_json(msg) }
+    end
+
+    def redis_connection
+      Sidekiq.redis { |conn| conn.client.id }
+    end
+
+    def namespace
+      @@ns ||= Sidekiq.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
+    end
+
+    def redis_info
+      Sidekiq.redis_info
+    end
+
+    def root_path
+      "#{env['SCRIPT_NAME']}/"
+    end
+
+    def current_path
+      @current_path ||= request.path_info.gsub(/^\//,'')
+    end
+
+    def current_status
+      workers.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 job_params(job, score)
+      "#{score}-#{job['jid']}"
+    end
+
+    def parse_params(params)
+      score, jid = params.split("-")
+      [score.to_f, jid]
+    end
+
+    SAFE_QPARAMS = %w(page poll)
+
+    # Merge options with current params, filter safe params, and stringify to query string
+    def qparams(options)
+      options = options.stringify_keys
+      params.merge(options).map do |key, value|
+        SAFE_QPARAMS.include?(key) ? "#{key}=#{CGI.escape(value.to_s)}" : next
+      end.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)
+      args.map do |arg|
+        h(truncate(to_display(arg), truncate_after_chars))
+      end.join(", ")
+    end
+
+    def csrf_tag
+      "<input type='hidden' name='authenticity_token' value='#{session[:csrf]}'/>"
+    end
+
+    def to_display(arg)
+      begin
+        arg.inspect
+      rescue
+        begin
+          arg.to_s
+        rescue => ex
+          "Cannot display argument: [#{ex.class.name}] #{ex.message}"
+        end
+      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
+    ))
+
+    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 number_with_delimiter(number)
+      begin
+        Float(number)
+      rescue ArgumentError, TypeError
+        return number
+      end
+
+      options = {delimiter: ',', separator: '.'}
+      parts = number.to_s.to_str.split('.')
+      parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{options[:delimiter]}")
+      parts.join(options[:separator])
+    end
+
+    def h(text)
+      ::Rack::Utils.escape_html(text)
+    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.options[:environment] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+
+      "[#{environment.upcase}] " unless environment == "production"
+    end
+
+    def product_version
+      "Sidekiq v#{Sidekiq::VERSION}"
+    end
+
+    def redis_connection_and_namespace
+      @redis_connection_and_namespace ||= begin
+        namespace_suffix = namespace == nil ? '' : "##{namespace}"
+        "#{redis_connection}#{namespace_suffix}"
+      end
+    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/lib/sidekiq/web/router.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+require 'rack'
+
+module Sidekiq
+  module WebRouter
+    GET = 'GET'.freeze
+    DELETE = 'DELETE'.freeze
+    POST = 'POST'.freeze
+    PUT = 'PUT'.freeze
+    PATCH = 'PATCH'.freeze
+    HEAD = 'HEAD'.freeze
+
+    ROUTE_PARAMS = 'rack.route_params'.freeze
+    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+    PATH_INFO = 'PATH_INFO'.freeze
+
+    def get(path, &block)
+      route(GET, path, &block)
+    end
+
+    def post(path, &block)
+      route(POST, path, &block)
+    end
+
+    def put(path, &block)
+      route(PUT, path, &block)
+    end
+
+    def patch(path, &block)
+      route(PATCH, path, &block)
+    end
+
+    def delete(path, &block)
+      route(DELETE, path, &block)
+    end
+
+    def route(method, path, &block)
+      @routes ||= { GET => [], POST => [], PUT => [], PATCH => [], DELETE => [], HEAD => [] }
+
+      @routes[method] << WebRoute.new(method, path, block)
+      @routes[HEAD] << WebRoute.new(method, path, block) if method == GET
+    end
+
+    def match(env)
+      request_method = env[REQUEST_METHOD]
+      path_info = ::Rack::Utils.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 == ""
+
+      @routes[request_method].each do |route|
+        if params = route.match(request_method, path_info)
+          env[ROUTE_PARAMS] = params
+
+          return WebAction.new(env, route.block)
+        end
+      end
+
+      nil
+    end
+  end
+
+  class WebRoute
+    attr_accessor :request_method, :pattern, :block, :name
+
+    NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([^\.:$\/]+)/.freeze
+
+    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
+
+    def match(request_method, path)
+      case matcher
+      when String
+        {} if path == matcher
+      else
+        if path_match = path.match(matcher)
+          Hash[path_match.names.map(&:to_sym).zip(path_match.captures)]
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/worker.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+require 'sidekiq/client'
+require 'sidekiq/core_ext'
+
+module Sidekiq
+
+
+  ##
+  # Include this module in your worker class and you can easily create
+  # asynchronous jobs:
+  #
+  # class HardWorker
+  #   include Sidekiq::Worker
+  #
+  #   def perform(*args)
+  #     # do some work
+  #   end
+  # end
+  #
+  # Then in your Rails app, you can do this:
+  #
+  #   HardWorker.perform_async(1, 2, 3)
+  #
+  # Note that perform_async is a class method, perform is an instance method.
+  module Worker
+    attr_accessor :jid
+
+    def self.included(base)
+      raise ArgumentError, "You cannot include Sidekiq::Worker in an ActiveJob: #{base.name}" if base.ancestors.any? {|c| c.name == 'ActiveJob::Base' }
+
+      base.extend(ClassMethods)
+      base.class_attribute :sidekiq_options_hash
+      base.class_attribute :sidekiq_retry_in_block
+      base.class_attribute :sidekiq_retries_exhausted_block
+    end
+
+    def logger
+      Sidekiq.logger
+    end
+
+    # This helper class encapsulates the set options for `set`, e.g.
+    #
+    #     SomeWorker.set(queue: 'foo').perform_async(....)
+    #
+    class Setter
+      def initialize(opts)
+        @opts = opts
+      end
+
+      def perform_async(*args)
+        @opts['class'.freeze].client_push(@opts.merge!('args'.freeze => args))
+      end
+
+      # +interval+ must be a timestamp, numeric or something that acts
+      #   numeric (like an activesupport time interval).
+      def perform_in(interval, *args)
+        int = interval.to_f
+        now = Time.now.to_f
+        ts = (int < 1_000_000_000 ? now + int : int)
+
+        @opts.merge! 'args'.freeze => args, 'at'.freeze => ts
+        # Optimization to enqueue something now that is scheduled to go out now or in the past
+        @opts.delete('at'.freeze) if ts <= now
+        @opts['class'.freeze].client_push(@opts)
+      end
+      alias_method :perform_at, :perform_in
+    end
+
+    module ClassMethods
+
+      def delay(*args)
+        raise ArgumentError, "Do not call .delay on a Sidekiq::Worker class, call .perform_async"
+      end
+
+      def delay_for(*args)
+        raise ArgumentError, "Do not call .delay_for on a Sidekiq::Worker class, call .perform_in"
+      end
+
+      def delay_until(*args)
+        raise ArgumentError, "Do not call .delay_until on a Sidekiq::Worker class, call .perform_at"
+      end
+
+      def set(options)
+        Setter.new(options.merge!('class'.freeze => self))
+      end
+
+      def perform_async(*args)
+        client_push('class'.freeze => self, 'args'.freeze => args)
+      end
+
+      # +interval+ must be a timestamp, numeric or something that acts
+      #   numeric (like an activesupport time interval).
+      def perform_in(interval, *args)
+        int = interval.to_f
+        now = Time.now.to_f
+        ts = (int < 1_000_000_000 ? now + int : int)
+
+        item = { 'class'.freeze => self, 'args'.freeze => args, 'at'.freeze => ts }
+
+        # Optimization to enqueue something now that is scheduled to go out now or in the past
+        item.delete('at'.freeze) if ts <= now
+
+        client_push(item)
+      end
+      alias_method :perform_at, :perform_in
+
+      ##
+      # Allows customization for this type of Worker.
+      # Legal options:
+      #
+      #   queue - use a named queue for this Worker, default 'default'
+      #   retry - enable the RetryJobs middleware for this Worker, *true* to use the default
+      #      or *Integer* count
+      #   backtrace - whether to save any error backtrace in the retry payload to display in web UI,
+      #      can be true, false or an integer number of lines to save, default *false*
+      #   pool - use the given Redis connection pool to push this type of job to a given shard.
+      #
+      # In practice, any option is allowed.  This is the main mechanism to configure the
+      # options for a specific job.
+      def sidekiq_options(opts={})
+        self.sidekiq_options_hash = get_sidekiq_options.merge(opts.stringify_keys)
+      end
+
+      def sidekiq_retry_in(&block)
+        self.sidekiq_retry_in_block = block
+      end
+
+      def sidekiq_retries_exhausted(&block)
+        self.sidekiq_retries_exhausted_block = block
+      end
+
+      def get_sidekiq_options # :nodoc:
+        self.sidekiq_options_hash ||= Sidekiq.default_worker_options
+      end
+
+      def client_push(item) # :nodoc:
+        pool = Thread.current[:sidekiq_via_pool] || get_sidekiq_options['pool'.freeze] || Sidekiq.redis_pool
+        hash = item.stringify_keys
+        Sidekiq::Client.new(pool).push(hash)
+      end
+
+    end
+  end
+end