module Gitlab # The SidekiqStatus module and its child classes can be used for checking if a # Sidekiq job has been processed or not. # # To check if a job has been completed, simply pass the job ID to the # `completed?` method: # # job_id = SomeWorker.perform_async(...) # # if Gitlab::SidekiqStatus.completed?(job_id) # ... # end # # For each job ID registered a separate key is stored in Redis, making lookups # much faster than using Sidekiq's built-in job finding/status API. These keys # expire after a certain period of time to prevent storing too many keys in # Redis. module SidekiqStatus STATUS_KEY = 'gitlab-sidekiq-status:%s'.freeze # The default time (in seconds) after which a status key is expired # automatically. The default of 30 minutes should be more than sufficient # for most jobs. DEFAULT_EXPIRATION = 30.minutes.to_i # Starts tracking of the given job. # # jid - The Sidekiq job ID # expire - The expiration time of the Redis key. def self.set(jid, expire = DEFAULT_EXPIRATION) Sidekiq.redis do |redis| redis.set(key_for(jid), 1, ex: expire) end end # Stops the tracking of the given job. # # jid - The Sidekiq job ID to remove. def self.unset(jid) Sidekiq.redis do |redis| redis.del(key_for(jid)) end end # Returns true if all the given job have been completed. # # job_ids - The Sidekiq job IDs to check. # # Returns true or false. def self.all_completed?(job_ids) self.num_running(job_ids).zero? end # Returns true if the given job is running # # job_id - The Sidekiq job ID to check. def self.running?(job_id) num_running([job_id]) > 0 end # Returns the number of jobs that are running. # # job_ids - The Sidekiq job IDs to check. def self.num_running(job_ids) responses = self.job_status(job_ids) responses.select(&:present?).count end # Returns the number of jobs that have completed. # # job_ids - The Sidekiq job IDs to check. def self.num_completed(job_ids) job_ids.size - self.num_running(job_ids) end # Returns the job status for each of the given job IDs. # # job_ids - The Sidekiq job IDs to check. # # Returns an array of true or false indicating job completion. # true = job is still running # false = job completed def self.job_status(job_ids) keys = job_ids.map { |jid| key_for(jid) } Sidekiq.redis do |redis| redis.pipelined do keys.each { |key| redis.exists(key) } end end end # Returns the JIDs that are completed # # job_ids - The Sidekiq job IDs to check. # # Returns an array of completed JIDs def self.completed_jids(job_ids) statuses = job_status(job_ids) completed = [] job_ids.zip(statuses).each do |job_id, status| completed << job_id unless status end completed end def self.key_for(jid) STATUS_KEY % jid end end end