sidekiq 5.0.0 → 6.0.0

data/lib/sidekiq/web/helpers.rb

@@ -1,35 +1,41 @@
 # frozen_string_literal: true
-require 'uri'
-require 'set'
-require 'yaml'
-require 'cgi'
+
+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
+      @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])
+            global.merge!(strs[lang])
           end
         end
       end
     end
 
     def clear_caches
-      @@strings = nil
-      @@locale_files = nil
+      @strings = nil
+      @locale_files = nil
+      @available_locales = nil
     end
 
     def locale_files
-      @@locale_files ||= settings.locales.flat_map do |path|
+      @locale_files ||= settings.locales.flat_map { |path|
         Dir["#{path}/*.yml"]
-      end
+      }
+    end
+
+    def available_locales
+      @available_locales ||= locale_files.map { |path| File.basename(path, ".yml") }.uniq
     end
 
     def find_locale_files(lang)
@@ -58,7 +64,7 @@ module Sidekiq
     end
 
     def poll_path
-      if current_path != '' && params['poll']
+      if current_path != "" && params["poll"]
         root_path + current_path
       else
         ""
@@ -66,41 +72,57 @@ module Sidekiq
     end
 
     def text_direction
-      get_locale['TextDirection'] || 'ltr'
+      get_locale["TextDirection"] || "ltr"
     end
 
     def rtl?
-      text_direction == 'rtl'
+      text_direction == "rtl"
+    end
+
+    # See https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4
+    def user_preferred_languages
+      languages = env["HTTP_ACCEPT_LANGUAGE"]
+      languages.to_s.downcase.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 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
+    # 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.
+    #
+    # Inspiration taken from https://github.com/iain/http_accept_language/blob/master/lib/http_accept_language/parser.rb
     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
+        matched_locale = user_preferred_languages.map { |preferred|
+          preferred_language = preferred.split("-", 2).first
+
+          lang_group = available_locales.select { |available|
+            preferred_language == available.split("-", 2).first
+          }
+
+          lang_group.find { |lang| lang == preferred } || lang_group.min_by(&:length)
+        }.compact.first
+
+        matched_locale || "en"
       end
     end
 
     # mperham/sidekiq#3243
     def unfiltered?
-      yield unless env['PATH_INFO'].start_with?("/filter/")
+      yield unless env["PATH_INFO"].start_with?("/filter/")
     end
 
     def get_locale
       strings(locale)
     end
 
-    def t(msg, options={})
-      string = get_locale[msg] || msg
+    def t(msg, options = {})
+      string = get_locale[msg] || strings("en")[msg] || msg
       if options.empty?
         string
       else
@@ -121,17 +143,20 @@ module Sidekiq
     end
 
     def retries_with_score(score)
-      Sidekiq.redis do |conn|
-        conn.zrangebyscore('retry', score, score)
-      end.map { |msg| Sidekiq.load_json(msg) }
+      Sidekiq.redis { |conn|
+        conn.zrangebyscore("retry", score, score)
+      }.map { |msg| Sidekiq.load_json(msg) }
     end
 
     def redis_connection
-      Sidekiq.redis { |conn| conn.client.id }
+      Sidekiq.redis do |conn|
+        c = conn.connection
+        "redis://#{c[:location]}/#{c[:db]}"
+      end
     end
 
     def namespace
-      @@ns ||= Sidekiq.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
+      @ns ||= Sidekiq.redis { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
     end
 
     def redis_info
@@ -139,39 +164,43 @@ module Sidekiq
     end
 
     def root_path
-      "#{env['SCRIPT_NAME']}/"
+      "#{env["SCRIPT_NAME"]}/"
     end
 
     def current_path
-      @current_path ||= request.path_info.gsub(/^\//,'')
+      @current_path ||= request.path_info.gsub(/^\//, "")
     end
 
     def current_status
-      workers.size == 0 ? 'idle' : 'active'
+      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>}
+      %(<time class="ltr" dir="ltr" title="#{stamp}" datetime="#{stamp}">#{time}</time>)
     end
 
     def job_params(job, score)
-      "#{score}-#{job['jid']}"
+      "#{score}-#{job["jid"]}"
     end
 
     def parse_params(params)
-      score, jid = params.split("-")
+      score, jid = params.split("-", 2)
       [score.to_f, jid]
     end
 
-    SAFE_QPARAMS = %w(page poll)
+    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|
+      # stringify
+      options.keys.each do |key|
+        options[key.to_s] = options.delete(key)
+      end
+
+      params.merge(options).map { |key, value|
         SAFE_QPARAMS.include?(key) ? "#{key}=#{CGI.escape(value.to_s)}" : next
-      end.compact.join("&")
+      }.compact.join("&")
     end
 
     def truncate(text, truncate_after_chars = 2000)
@@ -179,9 +208,16 @@ module Sidekiq
     end
 
     def display_args(args, truncate_after_chars = 2000)
-      args.map do |arg|
-        h(truncate(to_display(arg), truncate_after_chars))
-      end.join(", ")
+      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
@@ -189,23 +225,21 @@ module Sidekiq
     end
 
     def to_display(arg)
+      arg.inspect
+    rescue
       begin
-        arg.inspect
-      rescue
-        begin
-          arg.to_s
-        rescue => ex
-          "Cannot display argument: [#{ex.class.name}] #{ex.message}"
-        end
+        arg.to_s
+      rescue => ex
+        "Cannot display argument: [#{ex.class.name}] #{ex.message}"
       end
     end
 
-    RETRY_JOB_KEYS = Set.new(%w(
+    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|
@@ -222,8 +256,8 @@ module Sidekiq
         return number
       end
 
-      options = {delimiter: ',', separator: '.'}
-      parts = number.to_s.to_str.split('.')
+      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
@@ -231,8 +265,8 @@ module Sidekiq
     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')
+      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
 
@@ -249,7 +283,7 @@ module Sidekiq
     end
 
     def environment_title_prefix
-      environment = Sidekiq.options[:environment] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+      environment = Sidekiq.options[:environment] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
 
       "[#{environment.upcase}] " unless environment == "production"
     end
@@ -258,27 +292,31 @@ module Sidekiq
       "Sidekiq v#{Sidekiq::VERSION}"
     end
 
+    def server_utc_time
+      Time.now.utc.strftime("%H:%M:%S UTC")
+    end
+
     def redis_connection_and_namespace
       @redis_connection_and_namespace ||= begin
-        namespace_suffix = namespace == nil ? '' : "##{namespace}"
+        namespace_suffix = namespace.nil? ? "" : "##{namespace}"
         "#{redis_connection}#{namespace_suffix}"
       end
     end
 
     def retry_or_delete_or_kill(job, params)
-      if params['retry']
+      if params["retry"]
         job.retry
-      elsif params['delete']
+      elsif params["delete"]
         job.delete
-      elsif params['kill']
+      elsif params["kill"]
         job.kill
       end
     end
 
     def delete_or_add_queue(job, params)
-      if params['delete']
+      if params["delete"]
         job.delete
-      elsif params['add_to_queue']
+      elsif params["add_to_queue"]
         job.add_to_queue
       end
     end

data/lib/sidekiq/web/router.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
-require 'rack'
+
+require "rack"
 
 module Sidekiq
   module WebRouter
-    GET = 'GET'.freeze
-    DELETE = 'DELETE'.freeze
-    POST = 'POST'.freeze
-    PUT = 'PUT'.freeze
-    PATCH = 'PATCH'.freeze
-    HEAD = 'HEAD'.freeze
+    GET = "GET"
+    DELETE = "DELETE"
+    POST = "POST"
+    PUT = "PUT"
+    PATCH = "PATCH"
+    HEAD = "HEAD"
 
-    ROUTE_PARAMS = 'rack.route_params'.freeze
-    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
-    PATH_INFO = 'PATH_INFO'.freeze
+    ROUTE_PARAMS = "rack.route_params"
+    REQUEST_METHOD = "REQUEST_METHOD"
+    PATH_INFO = "PATH_INFO"
 
     def get(path, &block)
       route(GET, path, &block)
@@ -35,7 +36,7 @@ module Sidekiq
     end
 
     def route(method, path, &block)
-      @routes ||= { GET => [], POST => [], PUT => [], PATCH => [], DELETE => [], HEAD => [] }
+      @routes ||= {GET => [], POST => [], PUT => [], PATCH => [], DELETE => [], HEAD => []}
 
       @routes[method] << WebRoute.new(method, path, block)
       @routes[HEAD] << WebRoute.new(method, path, block) if method == GET
@@ -50,7 +51,8 @@ module Sidekiq
       path_info = "/" if path_info == ""
 
       @routes[request_method].each do |route|
-        if params = route.match(request_method, path_info)
+        params = route.match(request_method, path_info)
+        if params
           env[ROUTE_PARAMS] = params
 
           return WebAction.new(env, route.block)
@@ -64,7 +66,7 @@ module Sidekiq
   class WebRoute
     attr_accessor :request_method, :pattern, :block, :name
 
-    NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([^\.:$\/]+)/.freeze
+    NAMED_SEGMENTS_PATTERN = /\/([^\/]*):([^\.:$\/]+)/
 
     def initialize(request_method, pattern, block)
       @request_method = request_method
@@ -77,7 +79,7 @@ module Sidekiq
     end
 
     def compile
-      if pattern.match(NAMED_SEGMENTS_PATTERN)
+      if pattern.match?(NAMED_SEGMENTS_PATTERN)
         p = pattern.gsub(NAMED_SEGMENTS_PATTERN, '/\1(?<\2>[^$/]+)')
 
         Regexp.new("\\A#{p}\\Z")
@@ -91,7 +93,8 @@ module Sidekiq
       when String
         {} if path == matcher
       else
-        if path_match = path.match(matcher)
+        path_match = path.match(matcher)
+        if path_match
           Hash[path_match.names.map(&:to_sym).zip(path_match.captures)]
         end
       end

data/lib/sidekiq/worker.rb

@@ -1,21 +1,19 @@
 # frozen_string_literal: true
-require 'sidekiq/client'
-require 'sidekiq/core_ext'
-
-module Sidekiq
 
+require "sidekiq/client"
 
+module Sidekiq
   ##
   # Include this module in your worker class and you can easily create
   # asynchronous jobs:
   #
-  # class HardWorker
-  #   include Sidekiq::Worker
+  #   class HardWorker
+  #     include Sidekiq::Worker
   #
-  #   def perform(*args)
-  #     # do some work
+  #     def perform(*args)
+  #       # do some work
+  #     end
   #   end
-  # end
   #
   # Then in your Rails app, you can do this:
   #
@@ -23,15 +21,124 @@ module Sidekiq
   #
   # Note that perform_async is a class method, perform is an instance method.
   module Worker
+    ##
+    # The Options module is extracted so we can include it in ActiveJob::Base
+    # and allow native AJs to configure Sidekiq features/internals.
+    module Options
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.sidekiq_class_attribute :sidekiq_options_hash
+        base.sidekiq_class_attribute :sidekiq_retry_in_block
+        base.sidekiq_class_attribute :sidekiq_retries_exhausted_block
+      end
+
+      module ClassMethods
+        ACCESSOR_MUTEX = Mutex.new
+
+        ##
+        # Allows customization for this type of Worker.
+        # Legal options:
+        #
+        #   queue - name of queue to use for this job type, default *default*
+        #   retry - enable retries for this Worker in case of error during execution,
+        #      *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*
+        #
+        # In practice, any option is allowed.  This is the main mechanism to configure the
+        # options for a specific job.
+        def sidekiq_options(opts = {})
+          opts = Hash[opts.map { |k, v| [k.to_s, v] }] # stringify
+          self.sidekiq_options_hash = get_sidekiq_options.merge(Hash[opts.map { |k, v| [k.to_s, v] }])
+        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 sidekiq_class_attribute(*attrs)
+          instance_reader = true
+          instance_writer = true
+
+          attrs.each do |name|
+            synchronized_getter = "__synchronized_#{name}"
+
+            singleton_class.instance_eval do
+              undef_method(name) if method_defined?(name) || private_method_defined?(name)
+            end
+
+            define_singleton_method(synchronized_getter) { nil }
+            singleton_class.class_eval do
+              private(synchronized_getter)
+            end
+
+            define_singleton_method(name) { ACCESSOR_MUTEX.synchronize { send synchronized_getter } }
+
+            ivar = "@#{name}"
+
+            singleton_class.instance_eval do
+              m = "#{name}="
+              undef_method(m) if method_defined?(m) || private_method_defined?(m)
+            end
+            define_singleton_method("#{name}=") do |val|
+              singleton_class.class_eval do
+                ACCESSOR_MUTEX.synchronize do
+                  undef_method(synchronized_getter) if method_defined?(synchronized_getter) || private_method_defined?(synchronized_getter)
+                  define_method(synchronized_getter) { val }
+                end
+              end
+
+              if singleton_class?
+                class_eval do
+                  undef_method(name) if method_defined?(name) || private_method_defined?(name)
+                  define_method(name) do
+                    if instance_variable_defined? ivar
+                      instance_variable_get ivar
+                    else
+                      singleton_class.send name
+                    end
+                  end
+                end
+              end
+              val
+            end
+
+            if instance_reader
+              undef_method(name) if method_defined?(name) || private_method_defined?(name)
+              define_method(name) do
+                if instance_variable_defined?(ivar)
+                  instance_variable_get ivar
+                else
+                  self.class.public_send name
+                end
+              end
+            end
+
+            if instance_writer
+              m = "#{name}="
+              undef_method(m) if method_defined?(m) || private_method_defined?(m)
+              attr_writer name
+            end
+          end
+        end
+      end
+    end
+
     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' }
+      raise ArgumentError, "Sidekiq::Worker cannot be included in an ActiveJob: #{base.name}" if base.ancestors.any? { |c| c.name == "ActiveJob::Base" }
 
+      base.include(Options)
       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
@@ -43,12 +150,18 @@ module Sidekiq
     #     SomeWorker.set(queue: 'foo').perform_async(....)
     #
     class Setter
-      def initialize(opts)
+      def initialize(klass, opts)
+        @klass = klass
         @opts = opts
       end
 
+      def set(options)
+        @opts.merge!(options)
+        self
+      end
+
       def perform_async(*args)
-        @opts['class'.freeze].client_push(@opts.merge!('args'.freeze => args))
+        @klass.client_push(@opts.merge("args" => args, "class" => @klass))
       end
 
       # +interval+ must be a timestamp, numeric or something that acts
@@ -58,16 +171,15 @@ module Sidekiq
         now = Time.now.to_f
         ts = (int < 1_000_000_000 ? now + int : int)
 
-        @opts.merge! 'args'.freeze => args, 'at'.freeze => ts
+        payload = @opts.merge("class" => @klass, "args" => args, "at" => 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)
+        payload.delete("at") if ts <= now
+        @klass.client_push(payload)
       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
@@ -81,11 +193,11 @@ module Sidekiq
       end
 
       def set(options)
-        Setter.new(options.merge!('class'.freeze => self))
+        Setter.new(self, options)
       end
 
       def perform_async(*args)
-        client_push('class'.freeze => self, 'args'.freeze => args)
+        client_push("class" => self, "args" => args)
       end
 
       # +interval+ must be a timestamp, numeric or something that acts
@@ -95,10 +207,10 @@ module Sidekiq
         now = Time.now.to_f
         ts = (int < 1_000_000_000 ? now + int : int)
 
-        item = { 'class'.freeze => self, 'args'.freeze => args, 'at'.freeze => ts }
+        item = {"class" => self, "args" => args, "at" => ts}
 
         # Optimization to enqueue something now that is scheduled to go out now or in the past
-        item.delete('at'.freeze) if ts <= now
+        item.delete("at") if ts <= now
 
         client_push(item)
       end
@@ -117,28 +229,19 @@ module Sidekiq
       #
       # 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
+      def sidekiq_options(opts = {})
+        super
       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
+        pool = Thread.current[:sidekiq_via_pool] || get_sidekiq_options["pool"] || Sidekiq.redis_pool
+        # stringify
+        item.keys.each do |key|
+          item[key.to_s] = item.delete(key)
+        end
 
+        Sidekiq::Client.new(pool).push(item)
+      end
     end
   end
 end