sidekiq-unique-jobs 6.0.13 → 6.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75372204d0ab2439c631cf536b4e9ed87578e7117c4e2e183bff16e5d854172e
-  data.tar.gz: 0cbf2db1b5b271102509e290439a6590dea26c25c7aaa2c7e298a38bf8fe74e3
+  metadata.gz: f068a7aab06c3cfd05f160b1c62075f5ad69d54e6f8868eec7724d402063b8d3
+  data.tar.gz: 816085f3c9e851d0666f1df0ce4b99f520fdfd7217d22bb3b0875859500bfc1e
 SHA512:
-  metadata.gz: c0cc1a9a25f7c7cfdab463fa4ce61b75ecec7e96744ddb84f4ebc68de39dd525b4d0359ab9891a96c34bff661cd87bd5853e5f7c7d40a3c983024f54bc6388ac
-  data.tar.gz: 3c0529e64d2bc3e40265339f16a8209b22c25bba4a6d264e341a45a0c057450b59dee0bc4b070f86df1e7174f5c6fec9c1df35cfb5bae3282b08e4aca9be2546
+  metadata.gz: 28be9aadb717ba765bee3ac940571756da6b6acf08381cb4174a67b5b255715e60c25db310938adaa3879993ead802b693f89886d69aaaa45c2ba83d5bd9ad5c
+  data.tar.gz: 391913c288892d8753d9b3ebb8da9220e4a1cad981297c7a401eb57ce2439b0257a4ee9b0f4b015b2386d3e65bbb86dc6a3e351323e13e2cebc902306f11019d

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.com/mhenrixon/sidekiq-unique-jobs.svg?branch=v6.x)](https://travis-ci.com/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)
 
 <!-- MarkdownTOC -->
 

data/lib/sidekiq_unique_jobs.rb

@@ -4,6 +4,7 @@ require "forwardable"
 require "concurrent/mutable_struct"
 
 require "sidekiq_unique_jobs/version"
+require "sidekiq_unique_jobs/version_check"
 require "sidekiq_unique_jobs/constants"
 require "sidekiq_unique_jobs/logging"
 require "sidekiq_unique_jobs/sidekiq_worker_methods"

data/lib/sidekiq_unique_jobs/cli.rb

@@ -46,9 +46,11 @@ module SidekiqUniqueJobs
 
     no_commands do
       def console_class
+        return IRB if RUBY_PLATFORM == JAVA
+
         require "pry"
         Pry
-      rescue LoadError
+      rescue LoadError, NameError
         require "irb"
         IRB
       end

data/lib/sidekiq_unique_jobs/constants.rb

@@ -9,6 +9,7 @@ module SidekiqUniqueJobs
   ARGS_KEY                  ||= "args"
   AT_KEY                    ||= "at"
   CLASS_KEY                 ||= "class"
+  JAVA                      ||= "java"
   JID_KEY                   ||= "jid"
   LOCK_EXPIRATION_KEY       ||= "lock_expiration"
   LOCK_TIMEOUT_KEY          ||= "lock_timeout"

data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb

@@ -16,15 +16,31 @@ module SidekiqUniqueJobs
       # Executes in the Sidekiq server process
       # @yield to the worker class perform method
       def execute
-        return unless locked?
-
-        unlock
-        runtime_lock.execute { yield }
+        if unlock
+          lock_on_failure do
+            runtime_lock.execute { return yield }
+          end
+        else
+          log_warn "couldn't unlock digest: #{item[UNIQUE_DIGEST_KEY]} #{item[JID_KEY]}"
+        end
+      ensure
+        runtime_lock.delete!
       end
 
       def runtime_lock
         @runtime_lock ||= SidekiqUniqueJobs::Lock::WhileExecuting.new(item, callback, redis_pool)
       end
+
+      private
+
+      def lock_on_failure
+        yield
+        runtime_lock.delete!
+      rescue Exception # rubocop:disable Lint/RescueException
+        log_error("Failed to execute job, restoring lock")
+        lock
+        raise
+      end
     end
   end
 end

data/lib/sidekiq_unique_jobs/locksmith.rb

@@ -4,7 +4,7 @@ module SidekiqUniqueJobs
   # Lock manager class that handles all the various locks
   #
   # @author Mikael Henriksson <mikael@zoolutions.se>
-  # rubocop:disable ClassLength
+  # rubocop:disable Metrics/ClassLength
   class Locksmith
     include SidekiqUniqueJobs::Connection
 
@@ -185,5 +185,5 @@ module SidekiqUniqueJobs
       redis(&:time)
     end
   end
-  # rubocop:enable ClassLength
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/sidekiq_unique_jobs/logging.rb

@@ -16,6 +16,7 @@ module SidekiqUniqueJobs
     #   Used for compatibility with logger
     def log_debug(message_or_exception = nil, &block)
       logger.debug(message_or_exception, &block)
+      nil
     end
 
     # Logs a message at info level
@@ -24,6 +25,7 @@ module SidekiqUniqueJobs
     #   Used for compatibility with logger
     def log_info(message_or_exception = nil, &block)
       logger.info(message_or_exception, &block)
+      nil
     end
 
     # Logs a message at warn level
@@ -32,6 +34,7 @@ module SidekiqUniqueJobs
     #   Used for compatibility with logger
     def log_warn(message_or_exception = nil, &block)
       logger.warn(message_or_exception, &block)
+      nil
     end
 
     # Logs a message at error level
@@ -40,6 +43,7 @@ module SidekiqUniqueJobs
     #   Used for compatibility with logger
     def log_error(message_or_exception = nil, &block)
       logger.error(message_or_exception, &block)
+      nil
     end
 
     # Logs a message at fatal level
@@ -48,6 +52,7 @@ module SidekiqUniqueJobs
     #   Used for compatibility with logger
     def log_fatal(message_or_exception = nil, &block)
       logger.fatal(message_or_exception, &block)
+      nil
     end
 
     def logging_context(middleware_class, job_hash)

data/lib/sidekiq_unique_jobs/middleware.rb

@@ -44,4 +44,4 @@ module SidekiqUniqueJobs
     end
   end
 end
-SidekiqUniqueJobs.send(:extend, SidekiqUniqueJobs::Middleware)
+SidekiqUniqueJobs.extend SidekiqUniqueJobs::Middleware

data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb

@@ -34,11 +34,15 @@ module SidekiqUniqueJobs
   end
 
   # :reek:ManualDispatch
-  def with_context(context, &block)
+  def with_context(context)
     if logger.respond_to?(:with_context)
-      logger.with_context(context, &block)
+      logger.with_context(context) { yield }
+    elsif defined?(Sidekiq::Context)
+      Sidekiq::Context.with(context) { yield }
     elsif defined?(Sidekiq::Logging)
-      Sidekiq::Logging.with_context(context, &block)
+      Sidekiq::Logging.with_context(context) { yield }
+    else
+      yield
     end
   end
 

data/lib/sidekiq_unique_jobs/version.rb

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

data/lib/sidekiq_unique_jobs/version_check.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module SidekiqUniqueJobs
+  #
+  # Handles checking if a version is compliant with given constraint
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
+  class VersionCheck
+    PATTERN = /(?<operator1>[<>=]+)?\s?(?<version1>(\d+.?)+)(\s+&&\s+)?(?<operator2>[<>=]+)?\s?(?<version2>(\d+.?)+)?/m.freeze # rubocop:disable Metrics/LineLength
+
+    #
+    # Checks if a version is consrtaint is satisfied
+    #
+    # @example A satisfied constraint
+    #   VersionCheck.satisfied?("5.0.0", ">= 4.0.0") #=> true
+    #
+    # @example An unsatisfied constraint
+    #   VersionCheck.satisfied?("5.0.0", "<= 4.0.0") #=> false
+    #
+    #
+    # @param [String] version a version string `5.0.0`
+    # @param [String] constraint a version constraint `>= 5.0.0 <= 5.1.1`
+    #
+    # @return [<type>] <description>
+    #
+    def self.satisfied?(version, constraint)
+      new(version, constraint).satisfied?
+    end
+
+    #
+    # @!attribute [r] version
+    #   @return [String] a version string `5.0.0`
+    attr_reader :version
+    #
+    # @!attribute [r] match
+    #   @return [String] a version constraint `>= 5.0.0 <= 5.1.1`
+    attr_reader :match
+
+    #
+    # Initialize a new VersionCheck instance
+    #
+    # @param [String] version a version string `5.0.0`
+    # @param [String] constraint a version constraint `>= 5.0.0 <= 5.1.1`
+    #
+    def initialize(version, constraint)
+      @version   = Gem::Version.new(version)
+      @match     = PATTERN.match(constraint.to_s)
+
+      raise ArgumentError, "A version (eg. 5.0) is required to compare against" unless @version
+      raise ArgumentError, "At least one operator and version is required (eg. >= 5.1)" unless constraint
+    end
+
+    #
+    # Checks if all constraints were met
+    #
+    #
+    # @return [true,false]
+    #
+    def satisfied?
+      constraints.all? do |expected, operator|
+        compare(expected, operator)
+      end
+    end
+
+    private
+
+    def compare(expected, operator)
+      Gem::Version.new(version).send(operator, Gem::Version.new(expected))
+    end
+
+    def constraints
+      result = { version_one => operator_one }
+      result[version_two] = operator_two if version_two
+
+      result
+    end
+
+    def version_one
+      match[:version1]
+    end
+
+    def operator_one
+      match[:operator1]
+    end
+
+    def version_two
+      match[:version2]
+    end
+
+    def operator_two
+      match[:operator2]
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/web.rb

@@ -26,25 +26,25 @@ module SidekiqUniqueJobs
         @current_cursor = params[:cursor]
         @prev_cursor    = params[:prev_cursor]
         @total_size, @next_cursor, @unique_digests =
-          Digests.page(pattern: @filter, cursor: @current_cursor, page_size: @count)
+          SidekiqUniqueJobs::Digests.page(pattern: @filter, cursor: @current_cursor, page_size: @count)
 
         erb(unique_template(:unique_digests))
       end
 
       app.get "/unique_digests/delete_all" do
-        Digests.del(pattern: "*", count: Digests.count)
+        SidekiqUniqueJobs::Digests.del(pattern: "*", count: SidekiqUniqueJobs::Digests.count)
         redirect_to :unique_digests
       end
 
       app.get "/unique_digests/:digest" do
         @digest = params[:digest]
-        @unique_keys = Util.keys("#{@digest}*", 1000)
+        @unique_keys = SidekiqUniqueJobs::Util.keys("#{@digest}*", 1000)
 
         erb(unique_template(:unique_digest))
       end
 
       app.get "/unique_digests/:digest/delete" do
-        Digests.del(digest: params[:digest])
+        SidekiqUniqueJobs::Digests.del(digest: params[:digest])
         redirect_to :unique_digests
       end
     end

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -36,10 +36,10 @@ module SidekiqUniqueJobs
 
       def safe_relative_time(time)
         time = if time.is_a?(Numeric)
-                 Time.at(time)
-               else
-                 Time.parse(time)
-               end
+          Time.at(time)
+        else
+          Time.parse(time)
+        end
 
         relative_time(time)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 6.0.13
+  version: 6.0.16
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-14 00:00:00.000000000 Z
+date: 2020-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -68,14 +68,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -84,14 +84,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -126,14 +132,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -194,89 +206,30 @@ dependencies:
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 description: |
   Prevents simultaneous Sidekiq jobs with the same unique arguments to run.
   Highly configurable to suite your specific needs.
 email:
-- mikael@zoolutions.se
+- mikael@mhenrixon.com
 executables:
 - uniquejobs
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".editorconfig"
-- ".fasterer.yml"
-- ".github/ISSUE_TEMPLATE/bug_report.md"
-- ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".gitignore"
-- ".mdlrc"
-- ".reek.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".simplecov"
-- ".travis.yml"
-- ".yardopts"
-- Appraisals
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Guardfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- _config.yml
-- assets/unique_digests_1.png
-- assets/unique_digests_2.png
-- bin/bench
 - bin/uniquejobs
-- examples/another_unique_job.rb
-- examples/custom_queue_job.rb
-- examples/custom_queue_job_with_filter_method.rb
-- examples/custom_queue_job_with_filter_proc.rb
-- examples/expiring_job.rb
-- examples/inline_worker.rb
-- examples/just_a_worker.rb
-- examples/long_running_job.rb
-- examples/main_job.rb
-- examples/my_job.rb
-- examples/my_unique_job.rb
-- examples/my_unique_job_with_filter_method.rb
-- examples/my_unique_job_with_filter_proc.rb
-- examples/notify_worker.rb
-- examples/plain_class.rb
-- examples/simple_worker.rb
-- examples/spawn_simple_worker.rb
-- examples/test_class.rb
-- examples/unique_across_workers_job.rb
-- examples/unique_job_on_conflict_raise.rb
-- examples/unique_job_on_conflict_reject.rb
-- examples/unique_job_on_conflict_reschedule.rb
-- examples/unique_job_with_conditional_parameter.rb
-- examples/unique_job_with_filter_method.rb
-- examples/unique_job_with_nil_unique_args.rb
-- examples/unique_job_with_no_unique_args_method.rb
-- examples/unique_job_withthout_unique_args_parameter.rb
-- examples/unique_on_all_queues_job.rb
-- examples/until_and_while_executing_job.rb
-- examples/until_executed_2_job.rb
-- examples/until_executed_job.rb
-- examples/until_executing_job.rb
-- examples/until_expired_job.rb
-- examples/until_global_expired_job.rb
-- examples/while_executing_job.rb
-- examples/while_executing_reject_job.rb
-- examples/without_argument_job.rb
 - lib/sidekiq-unique-jobs.rb
 - lib/sidekiq_unique_jobs.rb
 - lib/sidekiq_unique_jobs/cli.rb
@@ -319,6 +272,7 @@ files:
 - lib/sidekiq_unique_jobs/unlockable.rb
 - lib/sidekiq_unique_jobs/util.rb
 - lib/sidekiq_unique_jobs/version.rb
+- lib/sidekiq_unique_jobs/version_check.rb
 - lib/sidekiq_unique_jobs/web.rb
 - lib/sidekiq_unique_jobs/web/helpers.rb
 - lib/sidekiq_unique_jobs/web/views/_paging.erb
@@ -333,8 +287,6 @@ files:
 - redis/lock.lua
 - redis/release_stale_locks.lua
 - redis/unlock.lua
-- sidekiq-unique-jobs.gemspec
-- update_docs.sh
 homepage: https://mhenrixon.github.io/sidekiq-unique-jobs
 licenses:
 - MIT
@@ -344,7 +296,13 @@ metadata:
   documentation_uri: https://mhenrixon.github.io/sidekiq-unique-jobs
   source_code_uri: https://github.com/mhenrixon/sidekiq-unique-jobs
   changelog_uri: https://github.com/mhenrixon/sidekiq-unique-jobs/CHANGELOG.md
-post_install_message: 
+post_install_message: |
+  Please either install v6.0.19 or change your `unique: :lock_type` to `lock: :lock_type`
+  This version will not unlock otherwise.
+
+  See: https://github.com/mhenrixon/sidekiq-unique-jobs/issues/471
+  And: https://github.com/mhenrixon/sidekiq-unique-jobs/pull/435
+  And: https://github.com/mhenrixon/sidekiq-unique-jobs/issues/471
 rdoc_options: []
 require_paths:
 - lib
@@ -359,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs