Module: SidekiqUniqueJobs

Defined in:
lib/sidekiq-unique-jobs.rb,
lib/sidekiq_unique_jobs/cli.rb,
lib/sidekiq_unique_jobs/lock.rb,
lib/sidekiq_unique_jobs/util.rb,
lib/sidekiq_unique_jobs/config.rb,
lib/sidekiq_unique_jobs/scripts.rb,
lib/sidekiq_unique_jobs/testing.rb,
lib/sidekiq_unique_jobs/version.rb,
lib/sidekiq_unique_jobs/constants.rb,
lib/sidekiq_unique_jobs/middleware.rb,
lib/sidekiq_unique_jobs/normalizer.rb,
lib/sidekiq_unique_jobs/unlockable.rb,
lib/sidekiq_unique_jobs/script_mock.rb,
lib/sidekiq_unique_jobs/unique_args.rb,
lib/sidekiq_unique_jobs/client/middleware.rb,
lib/sidekiq_unique_jobs/server/middleware.rb,
lib/sidekiq_unique_jobs/lock/until_timeout.rb,
lib/sidekiq_unique_jobs/timeout_calculator.rb,
lib/sidekiq_unique_jobs/lock/until_executed.rb,
lib/sidekiq_unique_jobs/lock/until_executing.rb,
lib/sidekiq_unique_jobs/lock/while_executing.rb,
lib/sidekiq_unique_jobs/scripts/acquire_lock.rb,
lib/sidekiq_unique_jobs/scripts/release_lock.rb,
lib/sidekiq_unique_jobs/options_with_fallback.rb,
lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb

Defined Under Namespace

Modules: Client, Lock, Middleware, Normalizer, OptionsWithFallback, ScriptMock, Scripts, Server, Unlockable, Util Classes: Cli, Config, QueueLockTimeoutCalculator, RunLockTimeoutCalculator, Testing, TimeoutCalculator, UniqueArgs

Constant Summary collapse

ScriptError = 
Class.new(StandardError)
UniqueKeyMissing = 
Class.new(ArgumentError)
JidMissing = 
Class.new(ArgumentError)
MaxLockTimeMissing = 
Class.new(ArgumentError)
UnexpectedValue = 
Class.new(StandardError)
VERSION = 
'5.0.9'
RunLockFailed = 
Class.new(StandardError)

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.config ⇒ Object 



25
26
27
28
29
30
31
32
33
 
# File 'lib/sidekiq-unique-jobs.rb', line 25

def config
  @config ||= Config.new(
    unique_prefix: 'uniquejobs',
    default_queue_lock_expiration: 30 * 60,
    default_run_lock_expiration: 60,
    default_lock: :while_executing,
    redis_test_mode: :redis, # :mock
  )
end

.configure(options = {}) ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/sidekiq-unique-jobs.rb', line 43

def configure(options = {})
  if block_given?
    yield config
  else
    options.each do |key, val|
      config.send("#{key}=", val)
    end
  end
end

.connection(redis_pool = nil) ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/sidekiq-unique-jobs.rb', line 74

def connection(redis_pool = nil)
  if redis_pool
    redis_pool.with { |conn| yield conn }
  else
    Sidekiq.redis { |conn| yield conn }
  end
end

.default_lock ⇒ Object 



39
40
41
 
# File 'lib/sidekiq-unique-jobs.rb', line 39

def default_lock
  config.default_lock
end

.logger ⇒ Object 



35
36
37
 
# File 'lib/sidekiq-unique-jobs.rb', line 35

def logger
  Sidekiq.logger
end

.mocked? ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/sidekiq-unique-jobs.rb', line 66

def mocked?
  config.redis_test_mode == :mock
end

.namespace ⇒ Object 



53
54
55
 
# File 'lib/sidekiq-unique-jobs.rb', line 53

def namespace
  @namespace ||= connection { |conn| conn.respond_to?(:namespace) ? conn.namespace : nil }
end

.redis_version ⇒ Object 



70
71
72
 
# File 'lib/sidekiq-unique-jobs.rb', line 70

def redis_version
  @redis_version ||= connection { |conn| conn.info('server')['redis_version'] }
end

.synchronize(item, redis_pool) ⇒ Object 



82
83
84
 
# File 'lib/sidekiq-unique-jobs.rb', line 82

def synchronize(item, redis_pool)
  Lock::WhileExecuting.synchronize(item, redis_pool) { yield }
end

.worker_class_constantize(worker_class) ⇒ Object

Attempt to constantize a string worker_class argument, always failing back to the original argument.



59
60
61
62
63
64
 
# File 'lib/sidekiq-unique-jobs.rb', line 59

def worker_class_constantize(worker_class)
  return worker_class unless worker_class.is_a?(String)
  Object.const_get(worker_class)
rescue NameError
  worker_class
end

Instance Method Details

#redis_version ⇒ Object 



70
71
72
 
# File 'lib/sidekiq-unique-jobs.rb', line 70

def redis_version
  @redis_version ||= connection { |conn| conn.info('server')['redis_version'] }
end

#redis_version_real ⇒ Object 



7
8
9
 
# File 'lib/sidekiq_unique_jobs/testing.rb', line 7

def redis_version
  @redis_version ||= connection { |conn| conn.info('server')['redis_version'] }
end