Sha256: 43a25672af60fe25f33f55f5511426cfe86da126b7b43257cd52bb82c5af068c
Contents?: true
Size: 1.96 KB
Versions: 6
Compression:
Stored size: 1.96 KB
Contents
# frozen_string_literal: true
module SidekiqUniqueJobs
class Lock
# Locks jobs while the job is executing in the server process
# - Locks before yielding to the worker's perform method
# - Unlocks after yielding to the worker's perform method
#
# See {#lock} for more information about the client.
# See {#execute} for more information about the server
#
# @author Mikael Henriksson <mikael@mhenrixon.com>
class WhileExecuting < BaseLock
RUN_SUFFIX ||= ":RUN"
include SidekiqUniqueJobs::OptionsWithFallback
include SidekiqUniqueJobs::Logging::Middleware
# @param [Hash] item the Sidekiq job hash
# @param [Proc] callback callback to call after unlock
# @param [Sidekiq::RedisConnection, ConnectionPool] redis_pool the redis connection
#
def initialize(item, callback, redis_pool = nil)
super(item, callback, redis_pool)
append_unique_key_suffix
end
# Simulate that a client lock was achieved.
# These locks should only ever be created in the server process.
# @return [true] always returns true
def lock
job_id = item[JID]
yield job_id if block_given?
job_id
end
# Executes in the Sidekiq server process.
# These jobs are locked in the server process not from the client
# @yield to the worker class perform method
def execute
with_logging_context do
call_strategy(origin: :server) unless locksmith.execute do
yield
callback_safely if locksmith.unlock
ensure
locksmith.unlock
end
end
end
private
# This is safe as the base_lock always creates a new digest
# The append there for needs to be done every time
def append_unique_key_suffix
return if (lock_digest = item[LOCK_DIGEST]).end_with?(RUN_SUFFIX)
item[LOCK_DIGEST] = lock_digest + RUN_SUFFIX
end
end
end
end
Version data entries
6 entries across 6 versions & 1 rubygems