sidekiq-unique-jobs 6.0.25 → 7.1.33

metadata

@@ -1,227 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 6.0.25
+  version: 7.1.33
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: concurrent-ruby
+  name: brpoplpush-redis_script
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
+        version: 0.1.1
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
+        version: 0.1.1
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: sidekiq
+  name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: 1.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - "<"
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.20'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  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
-  name: rack-test
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '7.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.20'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.20'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: github-markup
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.18
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.18
-- !ruby/object:Gem::Dependency
-  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.
@@ -238,24 +120,65 @@ files:
 - bin/uniquejobs
 - lib/sidekiq-unique-jobs.rb
 - lib/sidekiq_unique_jobs.rb
+- lib/sidekiq_unique_jobs/batch_delete.rb
+- lib/sidekiq_unique_jobs/changelog.rb
 - lib/sidekiq_unique_jobs/cli.rb
-- lib/sidekiq_unique_jobs/client/middleware.rb
+- lib/sidekiq_unique_jobs/config.rb
 - lib/sidekiq_unique_jobs/connection.rb
 - lib/sidekiq_unique_jobs/constants.rb
 - lib/sidekiq_unique_jobs/core_ext.rb
+- lib/sidekiq_unique_jobs/deprecation.rb
 - lib/sidekiq_unique_jobs/digests.rb
 - lib/sidekiq_unique_jobs/exceptions.rb
+- lib/sidekiq_unique_jobs/expiring_digests.rb
 - lib/sidekiq_unique_jobs/job.rb
+- lib/sidekiq_unique_jobs/json.rb
+- lib/sidekiq_unique_jobs/key.rb
+- lib/sidekiq_unique_jobs/lock.rb
 - lib/sidekiq_unique_jobs/lock/base_lock.rb
+- lib/sidekiq_unique_jobs/lock/client_validator.rb
+- lib/sidekiq_unique_jobs/lock/server_validator.rb
 - lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb
 - lib/sidekiq_unique_jobs/lock/until_executed.rb
 - lib/sidekiq_unique_jobs/lock/until_executing.rb
 - lib/sidekiq_unique_jobs/lock/until_expired.rb
+- lib/sidekiq_unique_jobs/lock/validator.rb
 - lib/sidekiq_unique_jobs/lock/while_executing.rb
 - lib/sidekiq_unique_jobs/lock/while_executing_reject.rb
+- lib/sidekiq_unique_jobs/lock_args.rb
+- lib/sidekiq_unique_jobs/lock_config.rb
+- lib/sidekiq_unique_jobs/lock_digest.rb
+- lib/sidekiq_unique_jobs/lock_info.rb
+- lib/sidekiq_unique_jobs/lock_timeout.rb
+- lib/sidekiq_unique_jobs/lock_ttl.rb
+- lib/sidekiq_unique_jobs/lock_type.rb
 - lib/sidekiq_unique_jobs/locksmith.rb
 - lib/sidekiq_unique_jobs/logging.rb
+- lib/sidekiq_unique_jobs/logging/middleware_context.rb
+- lib/sidekiq_unique_jobs/lua/delete.lua
+- lib/sidekiq_unique_jobs/lua/delete_by_digest.lua
+- lib/sidekiq_unique_jobs/lua/delete_job_by_digest.lua
+- lib/sidekiq_unique_jobs/lua/find_digest_in_queues.lua
+- lib/sidekiq_unique_jobs/lua/lock.lua
+- lib/sidekiq_unique_jobs/lua/lock_until_expired.lua
+- lib/sidekiq_unique_jobs/lua/locked.lua
+- lib/sidekiq_unique_jobs/lua/queue.lua
+- lib/sidekiq_unique_jobs/lua/reap_orphans.lua
+- lib/sidekiq_unique_jobs/lua/shared/_common.lua
+- lib/sidekiq_unique_jobs/lua/shared/_current_time.lua
+- lib/sidekiq_unique_jobs/lua/shared/_delete_from_queue.lua
+- lib/sidekiq_unique_jobs/lua/shared/_delete_from_sorted_set.lua
+- lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_process_set.lua
+- lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_queues.lua
+- lib/sidekiq_unique_jobs/lua/shared/_find_digest_in_sorted_set.lua
+- lib/sidekiq_unique_jobs/lua/shared/_hgetall.lua
+- lib/sidekiq_unique_jobs/lua/shared/_upgrades.lua
+- lib/sidekiq_unique_jobs/lua/unlock.lua
+- lib/sidekiq_unique_jobs/lua/update_version.lua
+- lib/sidekiq_unique_jobs/lua/upgrade.lua
 - lib/sidekiq_unique_jobs/middleware.rb
+- lib/sidekiq_unique_jobs/middleware/client.rb
+- lib/sidekiq_unique_jobs/middleware/server.rb
 - lib/sidekiq_unique_jobs/normalizer.rb
 - lib/sidekiq_unique_jobs/on_conflict.rb
 - lib/sidekiq_unique_jobs/on_conflict/log.rb
@@ -266,43 +189,77 @@ files:
 - lib/sidekiq_unique_jobs/on_conflict/reschedule.rb
 - lib/sidekiq_unique_jobs/on_conflict/strategy.rb
 - lib/sidekiq_unique_jobs/options_with_fallback.rb
-- lib/sidekiq_unique_jobs/scripts.rb
-- lib/sidekiq_unique_jobs/server/middleware.rb
+- lib/sidekiq_unique_jobs/orphans/lua_reaper.rb
+- lib/sidekiq_unique_jobs/orphans/manager.rb
+- lib/sidekiq_unique_jobs/orphans/null_reaper.rb
+- lib/sidekiq_unique_jobs/orphans/observer.rb
+- lib/sidekiq_unique_jobs/orphans/reaper.rb
+- lib/sidekiq_unique_jobs/orphans/reaper_resurrector.rb
+- lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb
+- lib/sidekiq_unique_jobs/redis.rb
+- lib/sidekiq_unique_jobs/redis/entity.rb
+- lib/sidekiq_unique_jobs/redis/hash.rb
+- lib/sidekiq_unique_jobs/redis/list.rb
+- lib/sidekiq_unique_jobs/redis/set.rb
+- lib/sidekiq_unique_jobs/redis/sorted_set.rb
+- lib/sidekiq_unique_jobs/redis/string.rb
+- lib/sidekiq_unique_jobs/reflectable.rb
+- lib/sidekiq_unique_jobs/reflections.rb
+- lib/sidekiq_unique_jobs/rspec/matchers.rb
+- lib/sidekiq_unique_jobs/rspec/matchers/have_valid_sidekiq_options.rb
+- lib/sidekiq_unique_jobs/script.rb
+- lib/sidekiq_unique_jobs/script/caller.rb
+- lib/sidekiq_unique_jobs/server.rb
 - lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb
 - lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb
 - lib/sidekiq_unique_jobs/sidekiq_worker_methods.rb
 - lib/sidekiq_unique_jobs/testing.rb
-- lib/sidekiq_unique_jobs/timeout.rb
-- lib/sidekiq_unique_jobs/timeout/calculator.rb
-- lib/sidekiq_unique_jobs/unique_args.rb
+- lib/sidekiq_unique_jobs/timer_task.rb
+- lib/sidekiq_unique_jobs/timing.rb
 - lib/sidekiq_unique_jobs/unlockable.rb
-- lib/sidekiq_unique_jobs/util.rb
+- lib/sidekiq_unique_jobs/update_version.rb
+- lib/sidekiq_unique_jobs/upgrade_locks.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
-- lib/sidekiq_unique_jobs/web/views/unique_digest.erb
-- lib/sidekiq_unique_jobs/web/views/unique_digests.erb
+- lib/sidekiq_unique_jobs/web/views/changelogs.erb
+- lib/sidekiq_unique_jobs/web/views/lock.erb
+- lib/sidekiq_unique_jobs/web/views/locks.erb
 - lib/tasks/changelog.rake
-- redis/acquire_lock.lua
-- redis/convert_legacy_lock.lua
-- redis/delete.lua
-- redis/delete_by_digest.lua
-- redis/delete_job_by_digest.lua
-- redis/lock.lua
-- redis/release_stale_locks.lua
-- redis/unlock.lua
-homepage: https://mhenrixon.github.io/sidekiq-unique-jobs
+homepage: https://github.com/mhenrixon/sidekiq-unique-jobs
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://mhenrixon.github.io/sidekiq-unique-jobs
-  bug_tracker_uri: https://github.com/mhenrixon/sidekiq-unique-jobs/issues
-  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:
+  rubygems_mfa_required: 'true'
+post_install_message: |
+  IMPORTANT!
+
+  Automatic configuration of the sidekiq middleware is no longer done.
+  Please see: https://github.com/mhenrixon/sidekiq-unique-jobs/blob/master/README.md#add-the-middleware
+
+  This version deprecated the following sidekiq_options
+
+    - sidekiq_options lock_args: :method_name
+
+  It is now configured with:
+
+    - sidekiq_options lock_args_method: :method_name
+
+  This is also true for `Sidekiq.default_worker_options`
+
+  We also deprecated the global configuration options:
+    - default_lock_ttl
+    - default_lock_ttl=
+    - default_lock_timeout
+    - default_lock_timeout=
+
+  The new methods to use are:
+    - lock_ttl
+    - lock_ttl=
+    - lock_timeout
+    - lock_timeout=
 rdoc_options: []
 require_paths:
 - lib
@@ -310,14 +267,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Sidekiq middleware that prevents duplicates jobs

data/lib/sidekiq_unique_jobs/client/middleware.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "sidekiq_unique_jobs/server/middleware"
-
-module SidekiqUniqueJobs
-  module Client
-    # The unique sidekiq middleware for the client push
-    #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
-    class Middleware
-      include SidekiqUniqueJobs::Logging
-      include OptionsWithFallback
-
-      # Calls this client middleware
-      #   Used from Sidekiq.process_single
-      # @param [String] worker_class name of the sidekiq worker class
-      # @param [Hash] item a sidekiq job hash
-      # @param [String] queue name of the queue
-      # @param [Sidekiq::RedisConnection, ConnectionPool] redis_pool the redis connection
-      # @yield when uniqueness is disable or lock successful
-      def call(worker_class, item, queue, redis_pool = nil)
-        @worker_class = worker_class
-        @item         = item
-        @queue        = queue
-        @redis_pool   = redis_pool
-
-        yield if success?
-      end
-
-      private
-
-      # The sidekiq job hash
-      # @return [Hash] the Sidekiq job hash
-      attr_reader :item
-
-      def success?
-        unique_disabled? || locked?
-      end
-
-      def locked?
-        SidekiqUniqueJobs::Job.add_uniqueness(item)
-        SidekiqUniqueJobs.with_context(logging_context(self.class, item)) do
-          locked = lock.lock
-          warn_about_duplicate unless locked
-          locked
-        end
-      end
-
-      def warn_about_duplicate
-        return unless log_duplicate_payload?
-
-        log_warn "payload is not unique #{item}"
-      end
-    end
-  end
-end

data/lib/sidekiq_unique_jobs/scripts.rb

@@ -1,118 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-require "digest/sha1"
-require "concurrent/map"
-
-module SidekiqUniqueJobs
-  # Interface to dealing with .lua files
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  module Scripts
-    LUA_PATHNAME ||= Pathname.new(__FILE__).dirname.join("../../redis").freeze
-    SCRIPT_SHAS ||= Concurrent::Map.new
-
-    include SidekiqUniqueJobs::Connection
-
-    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
-    #
-    # @return value from script
-    #
-    def call(file_name, redis_pool, options = {})
-      execute_script(file_name, redis_pool, options)
-    rescue Redis::CommandError => ex
-      handle_error(ex, file_name) do
-        call(file_name, redis_pool, options)
-      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)
-        conn.evalsha(sha, options)
-      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
-      end
-
-      sha = conn.script(:load, script_source(file_name))
-      SCRIPT_SHAS.put(file_name, sha)
-      sha
-    end
-
-    #
-    # 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
-    #
-    # @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)
-        return yield if block_given?
-      end
-
-      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
-  end
-end

data/lib/sidekiq_unique_jobs/server/middleware.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module SidekiqUniqueJobs
-  module Server
-    # The unique sidekiq middleware for the server processor
-    #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
-    class Middleware
-      include Logging
-      include OptionsWithFallback
-
-      #
-      #
-      # 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 is acquired
-      def call(worker_class, item, queue)
-        @worker_class = worker_class
-        @item         = item
-        @queue        = queue
-        return yield if unique_disabled?
-
-        SidekiqUniqueJobs::Job.add_uniqueness(item)
-        SidekiqUniqueJobs.with_context(logging_context(self.class, item)) do
-          lock.execute do
-            yield
-          end
-        end
-      end
-
-      private
-
-      # The sidekiq job hash
-      # @return [Hash] the Sidekiq job hash
-      attr_reader :item
-    end
-  end
-end