sidekiq-unique-jobs 7.0.0.beta9 → 7.0.0.beta10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a24246a99460117c9ebacb054dc8d1860e3a330058f3c4f34d409125136ffc22
-  data.tar.gz: 662a626190317ed24ecc5453a936437824166bf5b08cbb9e96187bb63f1d091b
+  metadata.gz: 80989f0c409c7ac687e7164fbd31255f566b80543887c899e3c5a50301ee8bc7
+  data.tar.gz: 78e4513aa3686ec123d5e63266249a13b4fb05a2087c11ff7c40bd51d951b7a6
 SHA512:
-  metadata.gz: a406b1f3f3f73a39f4c50b44417cbc1b6a83492c5e5c4dea71055cda9eca8c5139e667d2a1d4363e952f07e4e918b96455734cfd6285a753cdf3af026c2ab7eb
-  data.tar.gz: 99742c266e02ef86cfefd96a3c694b986f6d5610fca49877b7fd0f5d14ddcef4abadb6e65ae00b53de1fe71830d74210a9f7ff3237e3aecb141f9c9c5efdcf30
+  metadata.gz: 2ad61ee12ab5c62367fea9dfb0dd8850b4580b7cdb8548d370e79da6f164e1201fc5de4019173bc3cae47519814f7a1712c79a0cb5a9c65edd05bd9827e9bc9b
+  data.tar.gz: 24aa2c29b9f5097538c70132140d34c92b31a464573ab17e951303c8028702461a6f08ca20d375d0e1b5e0a5fd48ef3e4185aef488e467524912f41ff00fdde8

data/README.md

@@ -1,4 +1,4 @@
-# SidekiqUniqueJobs [![Join the chat at https://gitter.im/mhenrixon/sidekiq-unique-jobs](https://badges.gitter.im/mhenrixon/sidekiq-unique-jobs.svg)](https://gitter.im/mhenrixon/sidekiq-unique-jobs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/mhenrixon/sidekiq-unique-jobs.png?branch=master)](https://travis-ci.org/mhenrixon/sidekiq-unique-jobs) [![Code Climate](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs.png)](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs) [![Test Coverage](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs/badges/coverage.svg)](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs/coverage)
+# SidekiqUniqueJobs [![Join the chat at https://gitter.im/mhenrixon/sidekiq-unique-jobs](https://badges.gitter.im/mhenrixon/sidekiq-unique-jobs.svg)](https://gitter.im/mhenrixon/sidekiq-unique-jobs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/mhenrixon/sidekiq-unique-jobs.svg?branch=master)](https://travis-ci.org/mhenrixon/sidekiq-unique-jobs) [![Code Climate](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs.svg)](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs) [![Test Coverage](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs/badges/coverage.svg)](https://codeclimate.com/github/mhenrixon/sidekiq-unique-jobs/coverage)
 
 <!-- MarkdownTOC -->
 
@@ -23,8 +23,8 @@
 - [Worker Configuration](#worker-configuration)
   - [lock_ttl](#lock_ttl-1)
   - [lock_timeout](#lock_timeout-1)
-  - [unique_across_queues](#uniqueacrossqueues)
-  - [unique_across_workers](#uniqueacrossworkers)
+  - [unique_across_queues](#unique_across_queues)
+  - [unique_across_workers](#unique_across_workers)
 - [Locks](#locks)
   - [Until Executing](#until-executing)
   - [Until Executed](#until-executed)
@@ -33,14 +33,14 @@
   - [While Executing](#while-executing)
   - [Custom Locks](#custom-locks)
 - [Conflict Strategy](#conflict-strategy)
-- [lib/strategies/my_custom_strategy.rb](#libstrategiesmycustomstrategyrb)
+- [lib/strategies/my_custom_strategy.rb](#libstrategiesmy_custom_strategyrb)
 - [For rails application](#for-rails-application)
-- [config/initializers/sidekiq_unique_jobs.rb](#configinitializerssidekiquniquejobsrb)
+- [config/initializers/sidekiq_unique_jobs.rb](#configinitializerssidekiq_unique_jobsrb)
 - [For other projects, whenever you prefer](#for-other-projects-whenever-you-prefer)
 - [this goes in your initializer](#this-goes-in-your-initializer)
 - [app/config/routes.rb](#appconfigroutesrb)
 - [app/workers/bad_worker.rb](#appworkersbad_workerrb)
-- [spec/workers/bad_worker_spec.rb](#specworkersbadworkerspecrb)
+- [spec/workers/bad_worker_spec.rb](#specworkersbad_worker_specrb)
 - [OR](#or)
 - [Contributing](#contributing)
 - [Contributors](#contributors)
@@ -504,9 +504,9 @@ Requiring the gem in your gemfile should be sufficient to enable unique jobs.
 
 ### Finer Control over Uniqueness
 
-Sometimes it is desired to have a finer control over which arguments are used in determining uniqueness of the job, and others may be _transient_. For this use-case, you need to define either a `unique_args` method, or a ruby proc.
+Sometimes it is desired to have a finer control over which arguments are used in determining uniqueness of the job, and others may be _transient_. For this use-case, you need to define either a `lock_args` method, or a ruby proc.
 
-*NOTE:* The unique_args method need to return an array of values to use for uniqueness check.
+*NOTE:* The lock_args method need to return an array of values to use for uniqueness check.
 
 *NOTE:* The arguments passed to the proc or the method is always an array. If your method takes a single array as argument the value of args will be `[[...]]`.
 
@@ -516,9 +516,9 @@ The method or the proc can return a modified version of args without the transie
 class UniqueJobWithFilterMethod
   include Sidekiq::Worker
   sidekiq_options lock: :until_and_while_executing,
-                  unique_args: :unique_args # this is default and will be used if such a method is defined
+                  lock_args: :lock_args # this is default and will be used if such a method is defined
 
-  def self.unique_args(args)
+  def self.lock_args(args)
     [ args[0], args[2][:type] ]
   end
 
@@ -529,7 +529,7 @@ end
 class UniqueJobWithFilterProc
   include Sidekiq::Worker
   sidekiq_options lock: :until_executed,
-                  unique_args: ->(args) { [ args.first ] }
+                  lock_args: ->(args) { [ args.first ] }
 
   ...
 
@@ -541,9 +541,9 @@ It is possible to ensure different types of unique args based on context. I can'
 ```ruby
 class UniqueJobWithFilterMethod
   include Sidekiq::Worker
-  sidekiq_options lock: :until_and_while_executing, unique_args: :unique_args
+  sidekiq_options lock: :until_and_while_executing, lock_args: :lock_args
 
-  def self.unique_args(args)
+  def self.lock_args(args)
     if Sidekiq::ProcessSet.new.size > 1
       # sidekiq runtime; uniqueness for the object (first arg)
       args.first

data/lib/sidekiq_unique_jobs.rb

@@ -42,8 +42,10 @@ require "sidekiq_unique_jobs/orphans/observer"
 require "sidekiq_unique_jobs/orphans/manager"
 require "sidekiq_unique_jobs/cli"
 require "sidekiq_unique_jobs/core_ext"
-require "sidekiq_unique_jobs/time_calculator"
-require "sidekiq_unique_jobs/unique_args"
+require "sidekiq_unique_jobs/lock_timeout"
+require "sidekiq_unique_jobs/lock_ttl"
+require "sidekiq_unique_jobs/lock_args"
+require "sidekiq_unique_jobs/lock_digest"
 require "sidekiq_unique_jobs/unlockable"
 require "sidekiq_unique_jobs/key"
 require "sidekiq_unique_jobs/locksmith"

data/lib/sidekiq_unique_jobs/batch_delete.rb

@@ -11,6 +11,8 @@ module SidekiqUniqueJobs
     # @return [Integer] the default batch size
     BATCH_SIZE = 100
 
+    #
+    # @return [Array<String>] Supported key suffixes
     SUFFIXES = %w[
       QUEUED
       PRIMED

data/lib/sidekiq_unique_jobs/cli.rb

@@ -9,12 +9,14 @@ module SidekiqUniqueJobs
   # @author Mikael Henriksson <mikael@zoolutions.se>
   #
   class Cli < Thor
+    # :nodoc:
     def self.banner(command, _namespace = nil, _subcommand = false)
-      "jobs #{@package_name} #{command.usage}"
+      "jobs #{@package_name} #{command.usage}" # rubocop:disable ThreadSafety/InstanceVariableInClassMethod
     end
 
     desc "list PATTERN", "list all unique digests and their expiry time"
     option :count, aliases: :c, type: :numeric, default: 1000, desc: "The max number of digests to return"
+    # :nodoc:
     def list(pattern = "*")
       entries = digests.entries(pattern: pattern, count: options[:count])
       say "Found #{entries.size} digests matching '#{pattern}':"
@@ -24,6 +26,7 @@ module SidekiqUniqueJobs
     desc "del PATTERN", "deletes unique digests from redis by pattern"
     option :dry_run, aliases: :d, type: :boolean, desc: "set to false to perform deletion"
     option :count, aliases: :c, type: :numeric, default: 1000, desc: "The max number of digests to return"
+    # :nodoc:
     def del(pattern)
       max_count = options[:count]
       if options[:dry_run]
@@ -36,6 +39,7 @@ module SidekiqUniqueJobs
     end
 
     desc "console", "drop into a console with easy access to helper methods"
+    # :nodoc:
     def console
       say "Use `list '*', 1000 to display the first 1000 unique digests matching '*'"
       say "Use `del '*', 1000, true (default) to see how many digests would be deleted for the pattern '*'"
@@ -46,10 +50,12 @@ module SidekiqUniqueJobs
     end
 
     no_commands do
+      # :nodoc:
       def digests
         @digests ||= SidekiqUniqueJobs::Digests.new
       end
 
+      # :nodoc:
       def console_class
         require "pry"
         Pry

data/lib/sidekiq_unique_jobs/config.rb

@@ -25,11 +25,15 @@ module SidekiqUniqueJobs
   #
   # @author Mauro Berlanda <mauro.berlanda@gmail.com>
   class Config < ThreadSafeConfig
+    #
+    # @return [Hash<Symbol, SidekiqUniqueJobs::Lock::BaseLock] all available queued locks
     LOCKS_WHILE_ENQUEUED = {
       until_executing: SidekiqUniqueJobs::Lock::UntilExecuting,
       while_enqueued: SidekiqUniqueJobs::Lock::UntilExecuting,
     }.freeze
 
+    #
+    # @return [Hash<Symbol, SidekiqUniqueJobs::Lock::BaseLock] all available fulltime locks
     LOCKS_FROM_PUSH_TO_PROCESSED = {
       until_completed: SidekiqUniqueJobs::Lock::UntilExecuted,
       until_executed: SidekiqUniqueJobs::Lock::UntilExecuted,
@@ -39,10 +43,14 @@ module SidekiqUniqueJobs
       until_successfully_completed: SidekiqUniqueJobs::Lock::UntilExecuted,
     }.freeze
 
+    #
+    # @return [Hash<Symbol, SidekiqUniqueJobs::Lock::BaseLock] all available locks without unlock
     LOCKS_WITHOUT_UNLOCK = {
       until_expired: SidekiqUniqueJobs::Lock::UntilExpired,
     }.freeze
 
+    #
+    # @return [Hash<Symbol, SidekiqUniqueJobs::Lock::BaseLock] all available runtime/client locks
     LOCKS_WHEN_BUSY = {
       around_perform: SidekiqUniqueJobs::Lock::WhileExecuting,
       while_busy: SidekiqUniqueJobs::Lock::WhileExecuting,
@@ -51,6 +59,8 @@ module SidekiqUniqueJobs
       while_executing_reject: SidekiqUniqueJobs::Lock::WhileExecutingReject,
     }.freeze
 
+    #
+    # @return [Hash<Symbol, SidekiqUniqueJobs::Lock::BaseLock] all available default locks
     LOCKS =
       LOCKS_WHEN_BUSY.dup
                      .merge(LOCKS_WHILE_ENQUEUED.dup)
@@ -58,6 +68,8 @@ module SidekiqUniqueJobs
                      .merge(LOCKS_FROM_PUSH_TO_PROCESSED.dup)
                      .freeze
 
+    #
+    # @return [Hash<Symbol, SidekiqUniqueJobs::OnConflict::Strategy] all available default strategies
     STRATEGIES = {
       log: SidekiqUniqueJobs::OnConflict::Log,
       raise: SidekiqUniqueJobs::OnConflict::Raise,
@@ -66,18 +78,44 @@ module SidekiqUniqueJobs
       reschedule: SidekiqUniqueJobs::OnConflict::Reschedule,
     }.freeze
 
+    #
+    # @return ['uniquejobs'] by default we use this prefix
     PREFIX                = "uniquejobs"
+    #
+    # @return [0] by default don't wait for locks
     LOCK_TIMEOUT          = 0
+    #
+    # @return [nil]
     LOCK_TTL              = nil
+    #
+    # @return [true] by default the gem is enabled
     ENABLED               = true
+    #
+    # @return [false] by default we don't debug the lua scripts because it is slow
     DEBUG_LUA             = false
+    #
+    # @return [1_000] use a changelog history of 1_000 entries by default
     MAX_HISTORY           = 1_000
-    REAPER                = :ruby # The type of cleanup to run. Possible values are [:ruby, :lua]
+    #
+    # @return [:ruby] prefer the ruby reaper by default since the lua reaper still has problems
+    REAPER                = :ruby
+    #
+    # @return [1_000] reap 1_000 orphaned locks at a time by default
     REAPER_COUNT          = 1_000
-    REAPER_INTERVAL       = 600 # Every 10 minutes
-    REAPER_TIMEOUT        = 10 # 10 seconds
+    #
+    # @return [600] reap locks every 10 minutes
+    REAPER_INTERVAL       = 600
+    #
+    # @return [10] stop reaper after 10 seconds
+    REAPER_TIMEOUT        = 10
+    #
+    # @return [false] while useful it also adds overhead so disable lock_info by default
     USE_LOCK_INFO         = false
+    #
+    # @return [false] by default we don't raise validation errors for workers
     RAISE_ON_CONFIG_ERROR = false
+    #
+    # @return [0.0.0] default redis version is only to avoid NoMethodError on nil
     REDIS_VERSION         = "0.0.0"
 
     #
@@ -185,6 +223,12 @@ module SidekiqUniqueJobs
       self.strategies = new_strategies
     end
 
+    #
+    # The current version of redis
+    #
+    #
+    # @return [String] a version string eg. `5.0.1`
+    #
     def redis_version
       self.current_redis_version = SidekiqUniqueJobs.fetch_redis_version if current_redis_version == REDIS_VERSION
       current_redis_version

data/lib/sidekiq_unique_jobs/constants.rb

@@ -17,6 +17,8 @@ module SidekiqUniqueJobs
   LIMIT                 ||= "limit"
   LIVE_VERSION          ||= "uniquejobs:live"
   LOCK                  ||= "lock"
+  LOCK_ARGS             ||= "lock_args"
+  LOCK_DIGEST           ||= "lock_digest"
   LOCK_EXPIRATION       ||= "lock_expiration"
   LOCK_INFO             ||= "lock_info"
   LOCK_LIMIT            ||= "lock_limit"

data/lib/sidekiq_unique_jobs/exceptions.rb

@@ -14,7 +14,7 @@ module SidekiqUniqueJobs
   # @author Mikael Henriksson <mikael@zoolutions.se>
   class Conflict < UniqueJobsError
     def initialize(item)
-      super("Item with the key: #{item[UNIQUE_DIGEST]} is already scheduled or processing")
+      super("Item with the key: #{item[LOCK_DIGEST]} is already scheduled or processing")
     end
   end
 
@@ -60,13 +60,18 @@ module SidekiqUniqueJobs
   #
   # @author Mikael Henriksson <mikael@zoolutions.se>
   class InvalidUniqueArguments < UniqueJobsError
-    def initialize(given:, worker_class:, unique_args_method:)
-      uniq_args_meth  = worker_class.method(unique_args_method)
-      num_args        = uniq_args_meth.arity
-      # source_location = uniq_args_meth.source_location
+    def initialize(options)
+      given            = options[:given]
+      worker_class     = options[:worker_class]
+      lock_args_method = options[:lock_args_method]
+      lock_args_meth   = worker_class.method(lock_args_method)
+      num_args         = lock_args_meth.arity
+      source_location  = lock_args_meth.source_location
 
       super(
-        "#{worker_class}#unique_args takes #{num_args} arguments, received #{given.inspect}"
+        "#{worker_class}##{lock_args_method} takes #{num_args} arguments, received #{given.inspect}" \
+        "\n\n" \
+        "   #{source_location.join(':')}"
       )
     end
   end
@@ -77,7 +82,7 @@ module SidekiqUniqueJobs
   # @author Mikael Henriksson <mikael@zoolutions.se>
   #
   class NotUniqueWorker < UniqueJobsError
-    def initialize(options: {})
+    def initialize(options)
       super("#{options[:class]} is not configured for uniqueness. Missing the key `:lock` in #{options.inspect}")
     end
   end

data/lib/sidekiq_unique_jobs/job.rb

@@ -7,23 +7,44 @@ module SidekiqUniqueJobs
   module Job
     extend self
 
-    # Adds timeout, expiration, unique_args, unique_prefix and unique_digest to the sidekiq job hash
-    # @return [void] nothing returned here matters
-    def add_uniqueness(item)
-      add_timeout_and_expiration(item)
-      add_unique_args_and_digest(item)
+    # Adds timeout, expiration, lock_args, lock_prefix and lock_digest to the sidekiq job hash
+    # @return [Hash] the job hash
+    def prepare(item)
+      add_lock_timeout(item)
+      add_lock_ttl(item)
+      add_digest(item)
+    end
+
+    # Adds lock_args, lock_prefix and lock_digest to the sidekiq job hash
+    # @return [Hash] the job hash
+    def add_digest(item)
+      add_lock_prefix(item)
+      add_lock_args(item)
+      add_lock_digest(item)
+
+      item
     end
 
     private
 
-    def add_timeout_and_expiration(item)
-      calculator = SidekiqUniqueJobs::TimeCalculator.new(item)
-      item[LOCK_TIMEOUT] = calculator.lock_timeout
-      item[LOCK_TTL]     = calculator.lock_ttl
+    def add_lock_ttl(item)
+      item[LOCK_TTL] = SidekiqUniqueJobs::LockTTL.calculate(item)
+    end
+
+    def add_lock_timeout(item)
+      item[LOCK_TIMEOUT] = SidekiqUniqueJobs::LockTimeout.calculate(item)
+    end
+
+    def add_lock_args(item)
+      item[LOCK_ARGS] = SidekiqUniqueJobs::LockArgs.call(item)
+    end
+
+    def add_lock_digest(item)
+      item[LOCK_DIGEST] = SidekiqUniqueJobs::LockDigest.call(item)
     end
 
-    def add_unique_args_and_digest(item)
-      SidekiqUniqueJobs::UniqueArgs.digest(item)
+    def add_lock_prefix(item)
+      item[LOCK_PREFIX] = SidekiqUniqueJobs.config.unique_prefix
     end
   end
 end

data/lib/sidekiq_unique_jobs/lock/base_lock.rb

@@ -28,7 +28,7 @@ module SidekiqUniqueJobs
         @callback   = callback
         @redis_pool = redis_pool
         @attempt    = 0
-        add_uniqueness_when_missing # Used to ease testing
+        prepare_item # Used to ease testing
         @lock_config = LockConfig.new(item)
       end
 
@@ -90,12 +90,12 @@ module SidekiqUniqueJobs
 
       private
 
-      def add_uniqueness_when_missing
-        return if item.key?(UNIQUE_DIGEST)
+      def prepare_item
+        return if item.key?(LOCK_DIGEST)
 
         # The below should only be done to ease testing
         # in production this will be done by the middleware
-        SidekiqUniqueJobs::Job.add_uniqueness(item)
+        SidekiqUniqueJobs::Job.prepare(item)
       end
 
       def call_strategy

data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb

@@ -21,7 +21,7 @@ module SidekiqUniqueJobs
             runtime_lock.execute { return yield }
           end
         else
-          log_warn "couldn't unlock digest: #{item[UNIQUE_DIGEST]} #{item[JID]}"
+          log_warn "couldn't unlock digest: #{item[LOCK_DIGEST]} #{item[JID]}"
         end
       end
 

data/lib/sidekiq_unique_jobs/lock/validator.rb

@@ -8,6 +8,12 @@ module SidekiqUniqueJobs
     # @author Mikael Henriksson <mikael@zoolutions.se>
     #
     class Validator
+      DEPRECATED_KEYS = {
+        UNIQUE.to_sym => LOCK.to_sym,
+        UNIQUE_ARGS.to_sym => LOCK_ARGS.to_sym,
+        UNIQUE_PREFIX.to_sym => LOCK_PREFIX.to_sym,
+      }.freeze
+
       #
       # Shorthand for `new(options).validate`
       #
@@ -30,7 +36,9 @@ module SidekiqUniqueJobs
       # @param [Hash] options the sidekiq_options for the worker being validated
       #
       def initialize(options)
+        @options     = options.transform_keys(&:to_sym)
         @lock_config = LockConfig.new(options)
+        handle_deprecations
       end
 
       #
@@ -53,10 +61,24 @@ module SidekiqUniqueJobs
         lock_config
       end
 
+      def handle_deprecations
+        DEPRECATED_KEYS.each do |old, new|
+          next unless @options.key?(old)
+
+          lock_config.errors[old] = "is deprecated, use `#{new}: #{@options[old]}` instead."
+        end
+      end
+
+      #
+      # Validates the client configuration
+      #
       def validate_client
         ClientValidator.validate(lock_config)
       end
 
+      #
+      # Validates the server configuration
+      #
       def validate_server
         ServerValidator.validate(lock_config)
       end