kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Clarify documentation of Gitlab::SidekiqStatus

Browse source 
The "running" state is ambiguous. Clarify that it covers both enqueued
and actually running jobs.
This commit is contained in:
Nick Thomas 2019-07-03 14:46:13 +01:00
parent 9a4b5f08db
commit 9ef0c8559d
No known key found for this signature in database
GPG key ID: 2A313A47AFADACE9
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/gitlab/sidekiq_status.rb
View file

@ -53,14 +53,14 @@ module Gitlab
self.num_running(job_ids).zero?
end
# Returns true if the given job is running
# Returns true if the given job is running or enqueued.
#
# 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.
# Returns the number of jobs that are running or enqueued.
#
# job_ids - The Sidekiq job IDs to check.
def self.num_running(job_ids)
@ -81,7 +81,7 @@ module Gitlab
# job_ids - The Sidekiq job IDs to check.
#
# Returns an array of true or false indicating job completion.
# true = job is still running
# true = job is still running or enqueued
# false = job completed
def self.job_status(job_ids)
keys = job_ids.map { |jid| key_for(jid) }