activejob-uniqueness 0.2.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be824ecac1e864d000509ee27bb2a19a41bf1c0dbbb92fe49517a5a7fe1c86ff
-  data.tar.gz: a0d50fcdea9e48a952f6574604f3286b4de994b780299b99434c04f8ca0d16b1
+  metadata.gz: cd76f286ed7e6482860247e9b98b754dc1b73a381fcd2579d73e469da95d0200
+  data.tar.gz: 866f0949c68745c168217cbc70b10c65799f70aa372902dbd145781726217acd
 SHA512:
-  metadata.gz: e890759b54e003eea294906ed47055f71065ad8763538d1ada3c4985ebbed3492f4ce8ee91f6d732222e1b206d1caff023d8d73f019072642c0bd8873da870cf
-  data.tar.gz: 878c1af167966d9093ffacf90e919e78d8a5de57a92ae68f7475f4717b4e777af95ab413c27d77d86000fa328b6167d7d2e841c3ff9eee7379cc6e573d3b91ff
+  metadata.gz: 5cb9299a82cc40a9fca3df73c771cf553ead9393b11eca505afea5e55fe3023722db67d509528d0886db66e64569ba1caea04622ebde3ca365df1d768f04d2f4
+  data.tar.gz: 205d78f3c41721bce16c16d991204423fe5429b23c1d6fad48eb1a4ac7f775057f7e15192e8d1c32c97fc0c2c4af60a1584d6a666c253df71e1acce9ba02e5fa

data/CHANGELOG.md

@@ -3,14 +3,59 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [Unreleased](https://github.com/veeqo/activejob-uniqueness/compare/v0.2.4...HEAD)
+## [Unreleased](https://github.com/veeqo/activejob-uniqueness/compare/v0.4.0...HEAD)
 
 
+## [0.4.0](https://github.com/veeqo/activejob-uniqueness/compare/v0.3.2...v0.4.0) - 2024-12-07
+
+### Added
+
+- [#86](https://github.com/veeqo/activejob-uniqueness/pull/86) Add Rails 8.0 rc1 support by[@sharshenov](https://github.com/sharshenov)
+- [#78](https://github.com/veeqo/activejob-uniqueness/pull/78) Add on_redis_connection_error config to adjust to new redlock behaviour by[@nduitz](https://github.com/nduitz)
+
+### Changed
+- [#82](https://github.com/veeqo/activejob-uniqueness/pull/82) Optimize bulk unlocking [@sharshenov](https://github.com/sharshenov)
+
+## [0.3.2](https://github.com/veeqo/activejob-uniqueness/compare/v0.3.1...v0.3.2) - 2024-08-16
+
+### Added
+- [#80](https://github.com/veeqo/activejob-uniqueness/pull/80) Add rails 7.2 support by [@viralpraxis](https://github.com/viralpraxis)
+
+### Changed
+- [#74](https://github.com/veeqo/activejob-uniqueness/pull/74) Fix log subscriber by [@shahidkhaliq](https://github.com/shahidkhaliq)
+
+## [0.3.1](https://github.com/veeqo/activejob-uniqueness/compare/v0.3.0...v0.3.1) - 2023-10-30
+
+### Fixed
+
+- [#67](https://github.com/veeqo/activejob-uniqueness/pull/67) Random redis errors on delete_lock by [@laurafeier](https://github.com/laurafeier)
+
+## [0.3.0](https://github.com/veeqo/activejob-uniqueness/compare/v0.2.5...v0.3.0) - 2023-10-20
+
+### Added
+- [#66](https://github.com/veeqo/activejob-uniqueness/pull/66) Activejob 7.1 support by [@laurafeier](https://github.com/laurafeier)
+
+### Changed
+- [#57](https://github.com/veeqo/activejob-uniqueness/pull/57) Upgrade to Redlock 2 & use redis-client by [@bmulholland](https://github.com/bmulholland)
+
+### Removed
+- Support fo Redlock v1 is removed. Switching to `RedisClient` is [a breaking change of Redlock v2](https://github.com/leandromoreira/redlock-rb/blob/main/CHANGELOG.md#200---2023-02-09).
+
+## [0.2.5](https://github.com/veeqo/activejob-uniqueness/compare/v0.2.4...v0.2.5) - 2023-02-01
+
+### Added
+- [#45](https://github.com/veeqo/activejob-uniqueness/pull/45) Add Dependabot for GitHub Actions by [@petergoldstein](https://github.com/petergoldstein)
+- [#51](https://github.com/veeqo/activejob-uniqueness/pull/51) Add support for Sidekiq 7 by [@dwightwatson](https://github.com/dwightwatson)
+- [#52](https://github.com/veeqo/activejob-uniqueness/pull/52) Add Ruby 3.2.0 to the CI matrix by [@petergoldstein](https://github.com/petergoldstein)
+
+### Changed
+- [#46](https://github.com/veeqo/activejob-uniqueness/pull/46) Fix a method name typo in CHANGELOG by [@y-yagi](https://github.com/y-yagi)
+
 ## [0.2.4](https://github.com/veeqo/activejob-uniqueness/compare/v0.2.3...v0.2.4) - 2022-06-22
 
 ### Added
 - [#43](https://github.com/veeqo/activejob-uniqueness/pull/43) Run rubocop on Github Actions
-- [#44](https://github.com/veeqo/activejob-uniqueness/pull/44) Add ActiveJob::Uniqueness.test_mode! method to reset lock manager by [@akostadinov](https://github.com/akostadinov)
+- [#44](https://github.com/veeqo/activejob-uniqueness/pull/44) Add ActiveJob::Uniqueness.reset_manager! method to reset lock manager by [@akostadinov](https://github.com/akostadinov)
 
 ### Changed
 - [#42](https://github.com/veeqo/activejob-uniqueness/pull/42) Actualize rubies and gems for tests

data/README.md

@@ -43,6 +43,19 @@ To override the defaults, create an initializer `config/initializers/active_job_
 rails generate active_job:uniqueness:install
 ```
 
+This gem relies on `redlock` for it's Redis connection, that means **it will not inherit global configuration of `Sidekiq`**. To configure the connection, you can use `config.redlock_servers`, for example to disable SSL verification for Redis/Key-Value cloud providers:
+
+```ruby
+ActiveJob::Uniqueness.configure do |config|
+  config.redlock_servers = [
+    RedisClient.new(
+      url: ENV['REDIS_URL'],
+      ssl_params: { verify_mode: OpenSSL::SSL::VERIFY_NONE }
+    )
+  ]
+end
+```
+
 ## Usage
 
 
@@ -87,6 +100,19 @@ class MyJob < ActiveJob::Base
 end
 ```
 
+### Control redis connection errors
+
+```ruby
+class MyJob < ActiveJob::Base
+  # Proc gets the job instance including its arguments, and as keyword arguments the resource(lock key) `resource` and the original error `error`
+  unique :until_executing, on_redis_connection_error: ->(job, resource: _, error: _) { job.logger.info "Oops: #{job.arguments}" }
+
+  def perform(args)
+    # work
+  end
+end
+```
+
 ### Control lock key arguments
 
 ```ruby

data/lib/active_job/uniqueness/active_job_patch.rb

@@ -27,6 +27,7 @@ module ActiveJob
         def unique(strategy, options = {})
           validate_on_conflict_action!(options[:on_conflict])
           validate_on_conflict_action!(options[:on_runtime_conflict])
+          validate_on_redis_connection_error!(options[:on_redis_connection_error])
 
           self.lock_strategy_class = ActiveJob::Uniqueness::Strategies.lookup(strategy)
           self.lock_options = options
@@ -40,7 +41,9 @@ module ActiveJob
 
         private
 
-        delegate :validate_on_conflict_action!, to: :'ActiveJob::Uniqueness.config'
+        delegate :validate_on_conflict_action!,
+                 :validate_on_redis_connection_error!,
+                 to: :'ActiveJob::Uniqueness.config'
       end
 
       included do

data/lib/active_job/uniqueness/configuration.rb

@@ -14,6 +14,7 @@ module ActiveJob
       config_accessor(:lock_ttl) { 86_400 } # 1.day
       config_accessor(:lock_prefix) { 'activejob_uniqueness' }
       config_accessor(:on_conflict) { :raise }
+      config_accessor(:on_redis_connection_error) { :raise }
       config_accessor(:redlock_servers) { [ENV.fetch('REDIS_URL', 'redis://localhost:6379')] }
       config_accessor(:redlock_options) { { retry_count: 0 } }
       config_accessor(:lock_strategies) { {} }
@@ -34,6 +35,18 @@ module ActiveJob
 
         raise ActiveJob::Uniqueness::InvalidOnConflictAction, "Unexpected '#{action}' action on conflict"
       end
+
+      def on_redis_connection_error=(action)
+        validate_on_redis_connection_error!(action)
+
+        config.on_redis_connection_error = action
+      end
+
+      def validate_on_redis_connection_error!(action)
+        return if action.nil? || action == :raise || action.respond_to?(:call)
+
+        raise ActiveJob::Uniqueness::InvalidOnConflictAction, "Unexpected '#{action}' action on_redis_connection_error"
+      end
     end
   end
 end

data/lib/active_job/uniqueness/lock_manager.rb

@@ -9,24 +9,40 @@ module ActiveJob
       # Unlocks a resource by resource only.
       def delete_lock(resource)
         @servers.each do |server|
-          server.instance_variable_get(:@redis).with do |conn|
-            conn.del resource
+          synced_redis_connection(server) do |conn|
+            conn.call('DEL', resource)
           end
         end
 
         true
       end
 
+      DELETE_LOCKS_SCAN_COUNT = 1000
+
       # Unlocks multiple resources by key wildcard.
       def delete_locks(wildcard)
         @servers.each do |server|
-          server.instance_variable_get(:@redis).with do |conn|
-            conn.scan_each(match: wildcard).each { |key| conn.del key }
+          synced_redis_connection(server) do |conn|
+            cursor = 0
+            while cursor != '0'
+              cursor, keys = conn.call('SCAN', cursor, 'MATCH', wildcard, 'COUNT', DELETE_LOCKS_SCAN_COUNT)
+              conn.call('UNLINK', *keys) unless keys.empty?
+            end
           end
         end
 
         true
       end
+
+      private
+
+      def synced_redis_connection(server, &block)
+        if server.respond_to?(:synchronize)
+          server.synchronize(&block)
+        else
+          server.instance_variable_get(:@redis).with(&block)
+        end
+      end
     end
   end
 end

data/lib/active_job/uniqueness/log_subscriber.rb

@@ -3,98 +3,100 @@
 require 'active_support/log_subscriber'
 
 module ActiveJob
-  class LogSubscriber < ActiveSupport::LogSubscriber # :nodoc:
-    def lock(event)
-      job = event.payload[:job]
-      resource = event.payload[:resource]
-
-      debug do
-        "Locked #{lock_info(job, resource)}" + args_info(job)
+  module Uniqueness
+    class LogSubscriber < ActiveSupport::LogSubscriber # :nodoc:
+      def lock(event)
+        job = event.payload[:job]
+        resource = event.payload[:resource]
+
+        debug do
+          "Locked #{lock_info(job, resource)}" + args_info(job)
+        end
       end
-    end
 
-    def runtime_lock(event)
-      job = event.payload[:job]
-      resource = event.payload[:resource]
+      def runtime_lock(event)
+        job = event.payload[:job]
+        resource = event.payload[:resource]
 
-      debug do
-        "Locked runtime #{lock_info(job, resource)}" + args_info(job)
+        debug do
+          "Locked runtime #{lock_info(job, resource)}" + args_info(job)
+        end
       end
-    end
 
-    def unlock(event)
-      job = event.payload[:job]
-      resource = event.payload[:resource]
+      def unlock(event)
+        job = event.payload[:job]
+        resource = event.payload[:resource]
 
-      debug do
-        "Unlocked #{lock_info(job, resource)}"
+        debug do
+          "Unlocked #{lock_info(job, resource)}"
+        end
       end
-    end
 
-    def runtime_unlock(event)
-      job = event.payload[:job]
-      resource = event.payload[:resource]
+      def runtime_unlock(event)
+        job = event.payload[:job]
+        resource = event.payload[:resource]
 
-      debug do
-        "Unlocked runtime #{lock_info(job, resource)}"
+        debug do
+          "Unlocked runtime #{lock_info(job, resource)}"
+        end
       end
-    end
 
-    def conflict(event)
-      job = event.payload[:job]
-      resource = event.payload[:resource]
+      def conflict(event)
+        job = event.payload[:job]
+        resource = event.payload[:resource]
 
-      info do
-        "Not unique #{lock_info(job, resource)}" + args_info(job)
+        info do
+          "Not unique #{lock_info(job, resource)}" + args_info(job)
+        end
       end
-    end
 
-    def runtime_conflict(event)
-      job = event.payload[:job]
-      resource = event.payload[:resource]
+      def runtime_conflict(event)
+        job = event.payload[:job]
+        resource = event.payload[:resource]
 
-      info do
-        "Not unique runtime #{lock_info(job, resource)}" + args_info(job)
+        info do
+          "Not unique runtime #{lock_info(job, resource)}" + args_info(job)
+        end
       end
-    end
 
-    private
+      private
 
-    def lock_info(job, resource)
-      "#{job.class.name} (Job ID: #{job.job_id}) (Lock key: #{resource})"
-    end
+      def lock_info(job, resource)
+        "#{job.class.name} (Job ID: #{job.job_id}) (Lock key: #{resource})"
+      end
 
-    def args_info(job)
-      if job.arguments.any? && log_arguments?(job)
-        " with arguments: #{job.arguments.map { |arg| format(arg).inspect }.join(', ')}"
-      else
-        ''
+      def args_info(job)
+        if job.arguments.any? && log_arguments?(job)
+          " with arguments: #{job.arguments.map { |arg| format(arg).inspect }.join(', ')}"
+        else
+          ''
+        end
       end
-    end
 
-    def log_arguments?(job)
-      return true unless job.class.respond_to?(:log_arguments?)
+      def log_arguments?(job)
+        return true unless job.class.respond_to?(:log_arguments?)
 
-      job.class.log_arguments?
-    end
+        job.class.log_arguments?
+      end
 
-    def format(arg)
-      case arg
-      when Hash
-        arg.transform_values { |value| format(value) }
-      when Array
-        arg.map { |value| format(value) }
-      when GlobalID::Identification
-        arg.to_global_id rescue arg
-      else
-        arg
+      def format(arg)
+        case arg
+        when Hash
+          arg.transform_values { |value| format(value) }
+        when Array
+          arg.map { |value| format(value) }
+        when GlobalID::Identification
+          arg.to_global_id rescue arg
+        else
+          arg
+        end
       end
-    end
 
-    def logger
-      ActiveJob::Base.logger
+      def logger
+        ActiveJob::Base.logger
+      end
     end
   end
 end
 
-ActiveJob::LogSubscriber.attach_to :active_job_uniqueness
+ActiveJob::Uniqueness::LogSubscriber.attach_to :active_job_uniqueness

data/lib/active_job/uniqueness/sidekiq_patch.rb

@@ -41,7 +41,7 @@ module ActiveJob
       module ScheduledSet
         def delete(score, job_id)
           entry = find_job(job_id)
-          ActiveJob::Uniqueness.unlock_sidekiq_job!(entry.item) if super(score, job_id)
+          ActiveJob::Uniqueness.unlock_sidekiq_job!(entry.item) if super
           entry
         end
       end
@@ -67,7 +67,7 @@ module ActiveJob
         end
 
         def delete_by_value(name, value)
-          ActiveJob::Uniqueness.unlock_sidekiq_job!(Sidekiq.load_json(value)) if super(name, value)
+          ActiveJob::Uniqueness.unlock_sidekiq_job!(Sidekiq.load_json(value)) if super
         end
       end
     end
@@ -91,6 +91,8 @@ end
 
 # Global death handlers are introduced in Sidekiq 5.1
 # https://github.com/mperham/sidekiq/blob/e7acb124fbeb0bece0a7c3d657c39a9cc18d72c6/Changes.md#510
-if sidekiq_version >= Gem::Version.new('5.1')
+if sidekiq_version >= Gem::Version.new('7.0')
+  Sidekiq.default_configuration.death_handlers << ->(job, _ex) { ActiveJob::Uniqueness.unlock_sidekiq_job!(job) }
+elsif sidekiq_version >= Gem::Version.new('5.1')
   Sidekiq.death_handlers << ->(job, _ex) { ActiveJob::Uniqueness.unlock_sidekiq_job!(job) }
 end

data/lib/active_job/uniqueness/strategies/base.rb

@@ -11,12 +11,13 @@ module ActiveJob
 
         delegate :lock_manager, :config, to: :'ActiveJob::Uniqueness'
 
-        attr_reader :lock_key, :lock_ttl, :on_conflict, :job
+        attr_reader :lock_key, :lock_ttl, :on_conflict, :on_redis_connection_error, :job
 
         def initialize(job:)
           @lock_key = job.lock_key
           @lock_ttl = (job.lock_options[:lock_ttl] || config.lock_ttl).to_i * 1000 # ms
           @on_conflict = job.lock_options[:on_conflict] || config.on_conflict
+          @on_redis_connection_error = job.lock_options[:on_redis_connection_error] || config.on_redis_connection_error
           @job = job
         end
 
@@ -60,6 +61,12 @@ module ActiveJob
 
             handle_conflict(resource: lock_key, on_conflict: on_conflict)
             abort_job
+          rescue RedisClient::ConnectionError => e
+            handle_redis_connection_error(
+              resource: lock_key, on_redis_connection_error:
+              on_redis_connection_error, error: e
+            )
+            abort_job
           end
 
           def around_enqueue(block)
@@ -86,6 +93,14 @@ module ActiveJob
           end
         end
 
+        def handle_redis_connection_error(resource:, on_redis_connection_error:, error:)
+          case on_redis_connection_error
+          when :raise, nil then raise error
+          else
+            on_redis_connection_error.call(job, resource: resource, error: error)
+          end
+        end
+
         def abort_job
           @job_aborted = true # ActiveJob 4.2 workaround
 

data/lib/active_job/uniqueness/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveJob
   module Uniqueness
-    VERSION = '0.2.4'
+    VERSION = '0.4.0'
   end
 end

data/lib/generators/active_job/uniqueness/templates/config/initializers/active_job_uniqueness.rb

@@ -2,7 +2,7 @@
 
 ActiveJob::Uniqueness.configure do |config|
   # Global default expiration for lock keys. Each job can define its own ttl via :lock_ttl option.
-  # Stategy :until_and_while_executing also accept :on_runtime_ttl option.
+  # Strategy :until_and_while_executing also accepts :on_runtime_ttl option.
   #
   # config.lock_ttl = 1.day
 
@@ -11,7 +11,7 @@ ActiveJob::Uniqueness.configure do |config|
   # config.lock_prefix = 'activejob_uniqueness'
 
   # Default action on lock conflict. Can be set per job.
-  # Stategy :until_and_while_executing also accept :on_runtime_conflict option.
+  # Strategy :until_and_while_executing also accepts :on_runtime_conflict option.
   # Allowed values are
   #   :raise - raises ActiveJob::Uniqueness::JobNotUnique
   #   :log - instruments ActiveSupport::Notifications and logs event to the ActiveJob::Logger
@@ -19,6 +19,13 @@ ActiveJob::Uniqueness.configure do |config|
   #
   # config.on_conflict = :raise
 
+  # Default action on redis connection error. Can be set per job.
+  # Allowed values are
+  #   :raise - raises ActiveJob::Uniqueness::JobNotUnique
+  #   proc - custom Proc. For example, ->(job, resource: _, error: _) { job.logger.info("Job already in queue: #{job.class.name} #{job.arguments.inspect} (#{job.job_id})") }
+  #
+  # config.on_redis_connection_error = :raise
+
   # Digest method for lock keys generating. Expected to have `hexdigest` class method.
   #
   # config.digest_method = OpenSSL::Digest::MD5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-uniqueness
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Rustam Sharshenov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-22 00:00:00.000000000 Z
+date: 2024-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -19,7 +19,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,27 +29,27 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: redlock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -82,16 +82,16 @@ dependencies:
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Ensure uniqueness of your ActiveJob jobs