sidekiq-unique-jobs 6.0.12 → 6.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e400e981096ecad506646c8d3d8a57fdbe09628d344cd74bf3d4ebacaa717034
-  data.tar.gz: 8eb32a66471a6fc9a8ab9bc5f8717dde2a544151bfb65dedb8214072f9fb14a7
+  metadata.gz: 75372204d0ab2439c631cf536b4e9ed87578e7117c4e2e183bff16e5d854172e
+  data.tar.gz: 0cbf2db1b5b271102509e290439a6590dea26c25c7aaa2c7e298a38bf8fe74e3
 SHA512:
-  metadata.gz: 0036cec9334f5d1cf2ac814ed18efaff1adfe3cb372a8b593c686996ccade529faf18258c023313a64373a8d40389707cd5cc3515578f4b2a3062a7e2d9c51f5
-  data.tar.gz: b0513ccbbdb7a72fdaea163c6a943df2b97bdcfcd4dad1637f28adfc8eb3f8107fa0a0ca0613ddd21fb0e91f5a82c1822913d9b7663df43f6b7ff739035b26a6
+  metadata.gz: c0cc1a9a25f7c7cfdab463fa4ce61b75ecec7e96744ddb84f4ebc68de39dd525b4d0359ab9891a96c34bff661cd87bd5853e5f7c7d40a3c983024f54bc6388ac
+  data.tar.gz: 3c0529e64d2bc3e40265339f16a8209b22c25bba4a6d264e341a45a0c057450b59dee0bc4b070f86df1e7174f5c6fec9c1df35cfb5bae3282b08e4aca9be2546

data/.rubocop.yml

@@ -1,4 +1,5 @@
 require:
+  - rubocop-performance
   - rubocop-rspec
 
 inherit_mode:
@@ -64,6 +65,9 @@ Naming/FileName:
   Exclude:
     - lib/sidekiq-unique-jobs.rb
 
+Naming/RescuedExceptionsVariableName:
+  PreferredName: ex
+
 Naming/UncommunicativeMethodParamName:
   AllowedNames:
     - ex

data/.travis.yml

@@ -25,22 +25,21 @@ script:
 
 after_script:
   - if [[ "${COV}" = "true" ]]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi;
-
 rvm:
-  - 2.6.1
+  - 2.6.2
   - 2.4.5
   - 2.3.8
-  - jruby-9.2.5.0
+  - jruby-9.2.7.0
 
 matrix:
   fast_finish: true
   include:
-    - rvm: 2.5.3
+    - rvm: 2.5.5
       gemfile: gemfiles/sidekiq_develop.gemfile
       env: COV=true
-    - rvm: 2.6.0
+    - rvm: 2.6.2
       gemfile: gemfiles/sidekiq_6.0.gemfile
-    - rvm: 2.5.3
+    - rvm: 2.5.5
       gemfile: gemfiles/sidekiq_6.0.gemfile
 
 gemfile:

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [v6.0.12](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.12) (2019-02-28)
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.11...v6.0.12)
+
+**Fixed bugs:**
+
+- we are receiving SidekiqUniqueJobs::ScriptError "Problem compiling convert\_legacy\_lock" after upgrading from 5.0.10 -\> 6.0.11 [\#377](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/377)
+- Fix converting legacy locks [\#378](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/378) ([mhenrixon](https://github.com/mhenrixon))
+
 ## [v6.0.11](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.11) (2019-02-24)
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.10...v6.0.11)
 

data/Gemfile

@@ -19,8 +19,10 @@ platforms :mri_25 do
   gem "guard-rubocop"
   gem "memory_profiler"
   gem "pry"
+  gem "redcarpet", "~> 3.4"
   gem "reek", ">= 5.3"
   gem "rubocop"
+  gem "rubocop-performance"
   gem "rubocop-rspec"
   gem "simplecov-json"
   gem "travis"

data/README.md

@@ -5,6 +5,8 @@
 - [Introduction](#introduction)
 - [Documentation](#documentation)
 - [Requirements](#requirements)
+  - [ActiveJob](#activejob)
+  - [redis-namespace](#redis-namespace)
 - [Installation](#installation)
 - [Support Me](#support-me)
 - [General Information](#general-information)
@@ -56,9 +58,17 @@ Below are links to the latest major versions (4 & 5):
 
 ## Requirements
 
-See [Sidekiq requirements][] for what is required. Starting from 5.0.0 only sidekiq >= 4 is supported and support for MRI <= 2.1 is dropped. ActiveJob is not supported
+See [Sidekiq requirements][] for what is required. Starting from 5.0.0 only sidekiq >= 4 and MRI >= 2.2. ActiveJob is not supported
 
-Version 6 requires Redis >= 3 and pure Sidekiq, no ActiveJob supported anymore. See [About ActiveJob](https://github.com/mhenrixon/sidekiq-unique-jobs/wiki/About-ActiveJob) for why.
+### ActiveJob
+
+Version 6 requires Redis >= 3 and pure Sidekiq, no ActiveJob supported anymore. See [About ActiveJob](https://github.com/mhenrixon/sidekiq-unique-jobs/wiki/About-ActiveJob) for why. It simply is too complex and generates more issues than I can handle given how little timer I have to spend on this project.
+
+### redis-namespace
+
+Will not be officially supported anymore. Since Mike [won't support redis-namespace](https://github.com/mperham/sidekiq/issues/3366#issuecomment-284270120) neither will I.
+
+[Read this](http://www.mikeperham.com/2017/04/10/migrating-from-redis-namespace/) for how to migrate away from namespacing.
 
 ## Installation
 

data/bin/bench

@@ -10,11 +10,27 @@ require "benchmark/ips"
 require "sidekiq-unique-jobs"
 
 ITERATIONS ||= 10_000
+LOCK_TYPES = %w[
+  until_executed
+  until_expired
+  until_and_while_executing
+  until_executing
+  while_executing
+].freeze
 
 Benchmark.ips do |x|
-  x.config(time: 5, warmup: 2)
-  x.report("new_shit") do |_times|
-    SidekiqUniqueJobs::Scripts::AcquireLock.execute(nil, SecureRandom.hex, SecureRandom.hex)
+  x.config(time: 180, warmup: 2)
+  x.report("locksmith lock and unlock") do |_times|
+    item = {
+      "ttl" => rand(10),
+      "jid" => SecureRandom.hex,
+      "unique_digest" => SecureRandom.hex,
+      "lock" => LOCK_TYPES.sample,
+    }
+    locksmith = SidekiqUniqueJobs::Locksmith.new(item)
+    locksmith.lock
+    locksmith.unlock
   end
+
   x.compare!
 end

data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb

@@ -19,7 +19,6 @@ module SidekiqUniqueJobs
         return unless locked?
 
         unlock
-
         runtime_lock.execute { yield }
       end
 

data/lib/sidekiq_unique_jobs/lock/while_executing.rb

@@ -16,6 +16,7 @@ module SidekiqUniqueJobs
       # @param [Hash] item the Sidekiq job hash
       # @param [Proc] callback callback to call after unlock
       # @param [Sidekiq::RedisConnection, ConnectionPool] redis_pool the redis connection
+      #
       def initialize(item, callback, redis_pool = nil)
         super(item, callback, redis_pool)
         append_unique_key_suffix
@@ -34,7 +35,12 @@ module SidekiqUniqueJobs
       def execute
         return strategy.call unless locksmith.lock(item[LOCK_TIMEOUT_KEY])
 
-        with_cleanup { yield }
+        yield
+      rescue Exception # rubocop:disable Lint/RescueException
+        delete!
+        raise
+      else
+        unlock_with_callback
       end
 
       private

data/lib/sidekiq_unique_jobs/lock/while_executing_reject.rb

@@ -11,14 +11,6 @@ module SidekiqUniqueJobs
     #
     # @author Mikael Henriksson <mikael@zoolutions.se>
     class WhileExecutingReject < WhileExecuting
-      # Executes in the Sidekiq server process
-      # @yield to the worker class perform method
-      def execute
-        return strategy.call unless locksmith.lock(item[LOCK_TIMEOUT_KEY])
-
-        with_cleanup { yield }
-      end
-
       # Overridden with a forced {OnConflict::Reject} strategy
       # @return [OnConflict::Reject] a reject strategy
       def strategy

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -23,7 +23,10 @@ module SidekiqUniqueJobs
       @redis_pool    = redis_pool
     end
 
+    #
     # Deletes the lock unless it has a ttl set
+    #
+    #
     def delete
       return if ttl
 
@@ -39,11 +42,14 @@ module SidekiqUniqueJobs
       )
     end
 
+    #
     # Create a lock for the item
+    #
     # @param [Integer] timeout the number of seconds to wait for a lock.
-    #   nil means wait indefinitely
-    # @yield the block to execute if a lock is successful
-    # @return the Sidekiq job_id (jid)
+    #
+    # @return [String] the Sidekiq job_id (jid)
+    #
+    #
     def lock(timeout = nil, &block)
       Scripts.call(:lock, redis_pool,
                    keys: [exists_key, grabbed_key, available_key, UNIQUE_SET, unique_digest],
@@ -56,9 +62,12 @@ module SidekiqUniqueJobs
     end
     alias wait lock
 
+    #
     # Removes the lock keys from Redis if locked by the provided jid/token
+    #
     # @return [false] unless locked?
     # @return [String] Sidekiq job_id (jid) if successful
+    #
     def unlock(token = nil)
       token ||= jid
       return false unless locked?(token)
@@ -66,9 +75,14 @@ module SidekiqUniqueJobs
       unlock!(token)
     end
 
+    #
     # Removes the lock keys from Redis
+    #
+    # @param [String] token the token to unlock (defaults to jid)
+    #
     # @return [false] unless locked?
     # @return [String] Sidekiq job_id (jid) if successful
+    #
     def unlock!(token = nil)
       token ||= jid
 
@@ -80,10 +94,17 @@ module SidekiqUniqueJobs
       )
     end
 
-    # Checks if this instance is considered locked
+    #
     # @param [String] token the unique token to check for a lock.
     #   nil will default to the jid provided in the initializer
     # @return [true, false]
+    #
+    # Checks if this instance is considered locked
+    #
+    # @param [<type>] token <description>
+    #
+    # @return [<type>] <description>
+    #
     def locked?(token = nil)
       token ||= jid
 

data/lib/sidekiq_unique_jobs/scripts.rb

@@ -16,14 +16,20 @@ module SidekiqUniqueJobs
 
     module_function
 
+    #
     # Call a lua script with the provided file_name
+    #
+    # @note this method is recursive if we need to load a lua script
+    #   that wasn't previously loaded.
+    #
     # @param [Symbol] file_name the name of the lua script
     # @param [Sidekiq::RedisConnection, ConnectionPool] redis_pool the redis connection
     # @param [Hash] options arguments to pass to the script file
     # @option options [Array] :keys the array of keys to pass to the script
     # @option options [Array] :argv the array of arguments to pass to the script
-    # @note this method is recursive if we need to load a lua script
-    #   that wasn't previously loaded.
+    #
+    # @return value from script
+    #
     def call(file_name, redis_pool, options = {})
       execute_script(file_name, redis_pool, options)
     rescue Redis::CommandError => ex
@@ -32,12 +38,17 @@ module SidekiqUniqueJobs
       end
     end
 
+    #
     # Execute the script file
+    #
     # @param [Symbol] file_name the name of the lua script
     # @param [Sidekiq::RedisConnection, ConnectionPool] redis_pool the redis connection
     # @param [Hash] options arguments to pass to the script file
     # @option options [Array] :keys the array of keys to pass to the script
     # @option options [Array] :argv the array of arguments to pass to the script
+    #
+    # @return value from script (evalsha)
+    #
     def execute_script(file_name, redis_pool, options = {})
       redis(redis_pool) do |conn|
         sha = script_sha(conn, file_name)
@@ -45,10 +56,15 @@ module SidekiqUniqueJobs
       end
     end
 
+    #
     # Return sha of already loaded lua script or load it and return the sha
+    #
     # @param [Sidekiq::RedisConnection] conn the redis connection
     # @param [Symbol] file_name the name of the lua script
     # @return [String] sha of the script file
+    #
+    # @return [String] the sha of the script
+    #
     def script_sha(conn, file_name)
       if (sha = SCRIPT_SHAS.get(file_name))
         return sha
@@ -59,10 +75,15 @@ module SidekiqUniqueJobs
       sha
     end
 
-    # Return sha of already loaded lua script or load it and return the sha
+    #
+    # Handle errors to allow retrying errors that need retrying
+    #
     # @param [Redis::CommandError] ex exception to handle
     # @param [Symbol] file_name the name of the lua script
-    # @raise [ScriptError] when the error isn't handled
+    #
+    # @return [void]
+    #
+    # @yieldreturn [void] yields back to the caller when NOSCRIPT is raised
     def handle_error(ex, file_name)
       if ex.message == "NOSCRIPT No matching script. Please use EVAL."
         SCRIPT_SHAS.delete(file_name)
@@ -72,16 +93,24 @@ module SidekiqUniqueJobs
       raise ScriptError, file_name: file_name, source_exception: ex
     end
 
+    #
     # Reads the lua file from disk
+    #
     # @param [Symbol] file_name the name of the lua script
+    #
     # @return [String] the content of the lua file
+    #
     def script_source(file_name)
       script_path(file_name).read
     end
 
+    #
     # Construct a Pathname to a lua script
+    #
     # @param [Symbol] file_name the name of the lua script
+    #
     # @return [Pathname] the full path to the gems lua script
+    #
     def script_path(file_name)
       LUA_PATHNAME.join("#{file_name}.lua")
     end

data/lib/sidekiq_unique_jobs/server/middleware.rb

@@ -9,13 +9,19 @@ module SidekiqUniqueJobs
       include Logging
       include OptionsWithFallback
 
-      # Runs the server middleware
-      #   Used from Sidekiq::Processor#process
+      #
+      #
+      # Runs the server middleware (used from Sidekiq::Processor#process)
+      #
       # @param [Sidekiq::Worker] worker_class
       # @param [Hash] item a sidekiq job hash
       # @param [String] queue name of the queue
+      #
+      # @see https://github.com/mperham/sidekiq/wiki/Job-Format
+      # @see https://github.com/mperham/sidekiq/wiki/Middleware
+      #
       # @yield when uniqueness is disabled
-      # @yield when the lock class executes successfully
+      # @yield when the lock is acquired
       def call(worker_class, item, queue)
         @worker_class = worker_class
         @item         = item

data/lib/sidekiq_unique_jobs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqUniqueJobs
-  VERSION = "6.0.12"
+  VERSION = "6.0.13"
 end

data/sidekiq-unique-jobs.gemspec

@@ -55,7 +55,7 @@ Gem::Specification.new do |spec|
   # ===== Documentation =====
   spec.add_development_dependency "github-markup", "~> 3.0"
   spec.add_development_dependency "github_changelog_generator", "~> 1.14"
-  spec.add_development_dependency "redcarpet", "~> 3.4"
+  # spec.add_development_dependency "redcarpet", "~> 3.4"
   spec.add_development_dependency "yard", "~> 0.9.18"
 
   # ===== Release Management =====

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 6.0.12
+  version: 6.0.13
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2019-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -176,20 +176,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -373,7 +359,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs