Class: MultiBackgroundJob::Middleware::UniqueJob

Inherits:
Object
  • Object
show all
Defined in:
lib/multi_background_job/middleware/unique_job.rb,
lib/multi_background_job/middleware/unique_job/faktory.rb,
lib/multi_background_job/middleware/unique_job/sidekiq.rb

Overview

This middleware uses an external redis queue to control duplications. The locking key is composed of worker class and its arguments. Before enqueue new jobs it will check if have a “lock” active. The TTL of lock is 1 week as default. TTL is important to ensure locks won’t last forever.

Defined Under Namespace

Modules: Faktory, Sidekiq

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.bootstrap(service:) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/multi_background_job/middleware/unique_job.rb', line 12

def self.bootstrap(service:)
  services = Dir[File.expand_path('../unique_job/*.rb', __FILE__)].map { |f| File.basename(f, '.rb').to_sym }
  unless services.include?(service)
    msg = "UniqueJob is not supported for the `%<service>p' service. Supported options are: %<services>s."
    raise MultiBackgroundJob::Error, format(msg, service: service.to_sym, services: services.map { |s| "`:#{s}'" }.join(', '))
  end
  if (require("multi_background_job/middleware/unique_job/#{service}"))
    class_name = service.to_s.split('_').collect!{ |w| w.capitalize }.join
    MultiBackgroundJob::Middleware::UniqueJob.const_get(class_name).bootstrap
  end

  MultiBackgroundJob.configure do |config|
    config.unique_job_active = true
    config.middleware.add(UniqueJob)
  end
end

Instance Method Details

#call(worker, service) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/multi_background_job/middleware/unique_job.rb', line 29

def call(worker, service)
  if MultiBackgroundJob.config.unique_job_active? &&
      (uniq_lock = unique_job_lock(worker: worker, service: service))
    return false if uniq_lock.locked? # Don't push job to server

    # Add unique job information to the job payload
    worker.unique_job.lock = uniq_lock
    worker.payload['uniq'] = worker.unique_job.to_hash

    uniq_lock.lock
  end

  yield
end