Module: Sidekiq::JobUtil

Included in:
Client, Sidekiq::Job::Setter
Defined in:
lib/sidekiq/job_util.rb

Constant Summary collapse

TRANSIENT_ATTRIBUTES =

These functions encapsulate various job utilities.

%w[

Instance Method Summary collapse

Instance Method Details

#normalize_item(item) ⇒ Object

Raises:

  • (ArgumentError) 


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/sidekiq/job_util.rb', line 41

def normalize_item(item)
  validate(item)

  # merge in the default sidekiq_options for the item's class and/or wrapped element
  # this allows ActiveJobs to control sidekiq_options too.
  defaults = normalized_hash(item["class"])
  defaults = defaults.merge(item["wrapped"].get_sidekiq_options) if item["wrapped"].respond_to?(:get_sidekiq_options)
  item = defaults.merge(item)

  raise(ArgumentError, "Job must include a valid queue name") if item["queue"].nil? || item["queue"] == ""

  # remove job attributes which aren't necessary to persist into Redis
  TRANSIENT_ATTRIBUTES.each { |key| item.delete(key) }

  item["jid"] ||= SecureRandom.hex(12)
  item["class"] = item["class"].to_s
  item["queue"] = item["queue"].to_s
  item["retry_for"] = item["retry_for"].to_i if item["retry_for"]
  item["created_at"] ||= Time.now.to_f
  item
end

#normalized_hash(item_class) ⇒ Object 



63
64
65
66
67
68
69
70
 
# File 'lib/sidekiq/job_util.rb', line 63

def normalized_hash(item_class)
  if item_class.is_a?(Class)
    raise(ArgumentError, "Message must include a Sidekiq::Job class, not class name: #{item_class.ancestors.inspect}") unless item_class.respond_to?(:get_sidekiq_options)
    item_class.get_sidekiq_options
  else
    Sidekiq.default_job_options
  end
end

#validate(item) ⇒ Object

Raises:

  • (ArgumentError) 


10
11
12
13
14
15
16
17
 
# File 'lib/sidekiq/job_util.rb', line 10

def validate(item)
  raise(ArgumentError, "Job must be a Hash with 'class' and 'args' keys: `#{item}`") unless item.is_a?(Hash) && item.key?("class") && item.key?("args")
  raise(ArgumentError, "Job args must be an Array: `#{item}`") unless item["args"].is_a?(Array) || item["args"].is_a?(Enumerator::Lazy)
  raise(ArgumentError, "Job class must be either a Class or String representation of the class name: `#{item}`") unless item["class"].is_a?(Class) || item["class"].is_a?(String)
  raise(ArgumentError, "Job 'at' must be a Numeric timestamp: `#{item}`") if item.key?("at") && !item["at"].is_a?(Numeric)
  raise(ArgumentError, "Job tags must be an Array: `#{item}`") if item["tags"] && !item["tags"].is_a?(Array)
  raise(ArgumentError, "retry_for must be a relative amount of time, e.g. 48.hours `#{item}`") if item["retry_for"] && item["retry_for"] > 1_000_000_000
end

#verify_json(item) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/sidekiq/job_util.rb', line 19

def verify_json(item)
  job_class = item["wrapped"] || item["class"]
  args = item["args"]
  mode = Sidekiq::Config::DEFAULTS[:on_complex_arguments]

  if mode == :raise || mode == :warn
    if (unsafe_item = json_unsafe?(args))
      msg = <<~EOM
        Job arguments to #{job_class} must be native JSON types, but #{unsafe_item.inspect} is a #{unsafe_item.class}.
        See https://github.com/sidekiq/sidekiq/wiki/Best-Practices
        To disable this error, add `Sidekiq.strict_args!(false)` to your initializer.
      EOM

      if mode == :raise
        raise(ArgumentError, msg)
      else
        warn(msg)
      end
    end
  end
end