Class: SidekiqUniqueJobs::Lock::UntilExecuting

Inherits:
BaseLock
  • Object
show all
Defined in:
lib/sidekiq_unique_jobs/lock/until_executing.rb

Overview

Locks jobs until #execute starts

  • Locks on perform_in or perform_async

  • Unlocks before yielding to the worker’s perform method

Author:

Instance Method Summary collapse

Methods inherited from BaseLock

#initialize, #locksmith, validate_options

Methods included from Reflectable

#reflect

Methods included from SidekiqUniqueJobs::Logging

#build_message, included, #log_debug, #log_error, #log_fatal, #log_info, #log_warn, #logger, #logging_context, #with_configured_loggers_context, #with_logging_context

Constructor Details

This class inherits a constructor from SidekiqUniqueJobs::Lock::BaseLock

Instance Method Details

#execute { ... } ⇒ Object

Executes in the Sidekiq server process

Yields:

  • to the worker class perform method



33
34
35
36
37
38
39
40
 
# File 'lib/sidekiq_unique_jobs/lock/until_executing.rb', line 33

def execute
  callback_safely if locksmith.unlock
  yield
rescue StandardError => ex
  reflect(:execution_failed, item, ex)
  locksmith.lock(wait: 1)
  raise
end

#lock(&block) ⇒ String?

Note:

Will call a conflict strategy if lock can’t be achieved.

Locks a sidekiq job

Returns:

  • (String, nil) —

    the locked jid when properly locked, else nil.



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/sidekiq_unique_jobs/lock/until_executing.rb', line 18

def lock(&block)
  unless (token = locksmith.lock)
    reflect(:lock_failed, item)
    call_strategy(origin: :client, &block)

    return
  end

  yield if block

  token
end