63 lines
1.4 KiB
Ruby
63 lines
1.4 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
#
|
|
# Concern that helps with getting an exclusive lease for running a block
|
|
# of code.
|
|
#
|
|
# `#try_obtain_lease` takes a block which will be run if it was able to
|
|
# obtain the lease. Implement `#lease_timeout` to configure the timeout
|
|
# for the exclusive lease.
|
|
#
|
|
# Optionally override `#lease_key` to set the
|
|
# lease key, it defaults to the class name with underscores.
|
|
#
|
|
# Optionally override `#lease_release?` to prevent the job to
|
|
# be re-executed more often than LEASE_TIMEOUT.
|
|
#
|
|
module ExclusiveLeaseGuard
|
|
extend ActiveSupport::Concern
|
|
|
|
def try_obtain_lease
|
|
lease = exclusive_lease.try_obtain
|
|
|
|
unless lease
|
|
log_error("Cannot obtain an exclusive lease for #{self.class.name}. There must be another instance already in execution.")
|
|
return
|
|
end
|
|
|
|
begin
|
|
yield lease
|
|
ensure
|
|
release_lease(lease) if lease_release?
|
|
end
|
|
end
|
|
|
|
def exclusive_lease
|
|
@lease ||= Gitlab::ExclusiveLease.new(lease_key, timeout: lease_timeout)
|
|
end
|
|
|
|
def lease_key
|
|
@lease_key ||= self.class.name.underscore
|
|
end
|
|
|
|
def lease_timeout
|
|
raise NotImplementedError,
|
|
"#{self.class.name} does not implement #{__method__}"
|
|
end
|
|
|
|
def lease_release?
|
|
true
|
|
end
|
|
|
|
def release_lease(uuid)
|
|
Gitlab::ExclusiveLease.cancel(lease_key, uuid)
|
|
end
|
|
|
|
def renew_lease!
|
|
exclusive_lease.renew
|
|
end
|
|
|
|
def log_error(message, extra_args = {})
|
|
Gitlab::AppLogger.error(message)
|
|
end
|
|
end
|