The gem allows to protect job uniqueness with next strategies:

Inspired by SidekiqUniqueJobs, uses Redlock under the hood, sponsored by Veeqo.

Add the activejob-uniqueness gem to your Gemfile.

gem 'activejob-uniqueness'

And run bundle install command.

ActiveJob::Uniqueness is ready to work without any configuration. It will use REDIS_URL to connect to Redis instance. To override the defaults, create an initializer config/initializers/active_job_uniqueness.rb using the following command:

rails generate active_job:uniqueness:install

Define uniqueness strategy for your job via unique class method:

class MyJob < ActiveJob::Base
  unique :until_executed

  # Custom expiration:
  # unique :until_executed, lock_ttl: 3.hours

  # Do not raise error on non unique jobs enqueuing:
  # unique :until_executed, on_conflict: :log

  # Handle conflict by custom Proc:
  # unique :until_executed, on_conflict: ->(job) { job.logger.info 'Oops' }

  # The :until_and_while_executing strategy supports extra attributes for a runtime lock:
  # unique :until_and_while_executing runtime_lock_ttl: 10.minutes, on_runtime_conflict: :log
end

ActiveJob::Uniqueness allows to manually unlock jobs:

# Remove the lock for particular arguments:
MyJob.unlock!(foo: 'bar')
# or
ActiveJob::Uniqueness.unlock!(job_class_name: 'MyJob', arguments: [{foo: 'bar'}])

# Remove all locks of MyJob
MyJob.unlock!
# or
ActiveJob::Uniqueness.unlock!(job_class_name: 'MyJob')

# Remove all locks
ActiveJob::Uniqueness.unlock!

Most probably you don't want jobs to be locked in tests. Add this line to your test suite (rails_helper.rb):

ActiveJob::Uniqueness.test_mode!

ActiveJob::Uniqueness instruments ActiveSupport::Notifications with next events:

• lock.active_job_uniqueness
• runtime_lock.active_job_uniqueness
• unlock.active_job_uniqueness
• runtime_unlock.active_job_uniqueness
• conflict.active_job_uniqueness
• runtime_conflict.active_job_uniqueness

And then writes to ActiveJob::Base.logger.

Bug reports and pull requests are welcome on GitHub at https://github.com/veeqo/activejob-uniqueness.

The gem is available as open source under the terms of the MIT License.