activejob-uniqueness 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff1cfb19bc51b7eb8f4040f700650c51a47376e1ec96c84ae72b764227911f0c
-  data.tar.gz: 3813cf68d80e7d56d828e15f179c677e49fe2f171780e25c0a6990b7b93eed76
+  metadata.gz: 881d2ffd39454784d884cc4049639e2e4455d854deec87217c55a95c4f4a5869
+  data.tar.gz: 469900d8be29af691e4efa9d883ba3d037dbbd06ac9ca7a6cf38b8cd0b2fb17d
 SHA512:
-  metadata.gz: b616c4460d8bffe1be31226c3d18d9d3a7197fd714d680ddd636b154934ff648fb5dface28b0099b59ac865a91a5a0cec85a8230ba8d442bda6f831535405b94
-  data.tar.gz: 938eb49268486827b8b946934838af755f7f449fc75e84f2cde8538e49af7e786edc13583a715ad86b2203a58867e324e8e580cc611d522e512ae7ed235ddae1
+  metadata.gz: c9907d17c12ff54e319d75253c7190a97b8114f7492e728d98b19ea94a14219722365f35e98422a3b2cd474d6aa14cb8c45bd5b7facfc68febdb541e14110c3a
+  data.tar.gz: a4f99ea028e1290f7742d67025b04069c0bec2912bdf4b455f0e422b91c411e8adb6e0ad2193c3b7a0067f2921cdb3b7fe7bf2ff3f251258e87b931956f96112

data/CHANGELOG.md

@@ -1,14 +1,31 @@
-## Changes Between 0.1.1 and 0.1.2
+# Changelog
+All notable changes to this project will be documented in this file.
 
-Release lock for Sidekiq adapter when all Sidekiq attempts were unsuccessful or job is deleted manually from Sidekiq::Web
-[PR](https://github.com/veeqo/activejob-uniqueness/pull/5) by @vbyno
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## Changes Between 0.1.0 and 0.1.1
+## [Unreleased](https://github.com/veeqo/activejob-uniqueness/compare/v0.1.3...HEAD)
 
-Fixed NoMethodError on `Rails.application.eager_load!` in Rails initializer
-```
-NoMethodError: undefined method `unique' for MyJob:Class
-```
-[PR](https://github.com/veeqo/activejob-uniqueness/pull/4)
+## [0.1.3](https://github.com/veeqo/activejob-uniqueness/compare/v0.1.2...v0.1.3) - 2020-08-17
 
-## Original Release: 0.1.0
+### Fixed
+- [#7](https://github.com/veeqo/activejob-uniqueness/pull/7) Fix deprecation warnings for ruby 2.7 by [@tonobo](https://github.com/tonobo)
+
+### Changed
+- [#8](https://github.com/veeqo/activejob-uniqueness/pull/8) Use appraisal gem to control gem versions of tests matrix
+- [#9](https://github.com/veeqo/activejob-uniqueness/pull/9) Refactor of Sidekiq API patch. Fixes [#6](https://github.com/veeqo/activejob-uniqueness/issues/6) Rails boot error for version 0.1.2
+- [#10](https://github.com/veeqo/activejob-uniqueness/pull/10) Refactor changelog to comply with Keep a Changelog
+
+## [0.1.2](https://github.com/veeqo/activejob-uniqueness/compare/v0.1.1...v0.1.2) - 2020-07-30
+
+### Added
+-  [#5](https://github.com/veeqo/activejob-uniqueness/pull/5) Release lock for Sidekiq adapter by [@vbyno](https://github.com/vbyno)
+
+## [0.1.1](https://github.com/veeqo/activejob-uniqueness/compare/v0.1.0...v0.1.1) - 2020-07-23
+
+### Fixed
+- [#4](https://github.com/veeqo/activejob-uniqueness/pull/4) Fix `NoMethodError` on `Rails.application.eager_load!` in Rails initializer
+
+## [0.1.0](https://github.com/veeqo/activejob-uniqueness/releases/tag/v0.1.0) - 2020-07-05
+
+### Added
+- Job uniqueness for ActiveJob

data/README.md

@@ -93,6 +93,30 @@ And then writes to `ActiveJob::Base.logger`.
 
 ### ActiveJob prior to version `6.1` will always log `Enqueued MyJob (Job ID) ...` even if the callback chain was halted. [Details](https://github.com/rails/rails/pull/37830)
 
+## Testing
+
+Run redis server (in separate console):
+```
+docker run --rm -p 6379:6379 redis
+```
+
+Run tests with:
+
+```sh
+bundle
+rake
+```
+
+Use [wwtd](https://github.com/grosser/wwtd) to run test matrix:
+```sh
+gem install wwtd
+wwtd
+```
+
+## Sidekiq adapter support
+
+ActiveJob::Uniqueness patches Sidekiq API to unset locks on jobs cleanup. Starting Sidekiq 5.1 job death also triggers locks cleanup.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/veeqo/activejob-uniqueness.

data/lib/active_job/uniqueness.rb

@@ -7,7 +7,15 @@ require 'openssl'
 require 'active_job/uniqueness/version'
 require 'active_job/uniqueness/errors'
 require 'active_job/uniqueness/log_subscriber'
-require 'active_job/uniqueness/patch'
+require 'active_job/uniqueness/active_job_patch'
+
+begin
+  require 'sidekiq/api'
+rescue LoadError
+  # ¯\_(ツ)_/¯
+else
+  require 'active_job/uniqueness/sidekiq_patch'
+end
 
 module ActiveJob
   module Uniqueness

data/lib/active_job/uniqueness/{patch.rb → active_job_patch.rb}

@@ -16,7 +16,7 @@ module ActiveJob
     #   end
     # end
     #
-    module Patch
+    module ActiveJobPatch
       extend ActiveSupport::Concern
 
       class_methods do
@@ -55,7 +55,7 @@ module ActiveJob
       end
 
       def lock_strategy
-        @lock_strategy ||= lock_strategy_class.new(lock_options.merge(lock_key: lock_key, job: self))
+        @lock_strategy ||= lock_strategy_class.new(**lock_options.merge(lock_key: lock_key, job: self))
       end
 
       # Override in your job class if you want to customize arguments set for a digest.
@@ -73,12 +73,7 @@ module ActiveJob
     end
 
     ActiveSupport.on_load(:active_job) do
-      ActiveJob::Base.include ActiveJob::Uniqueness::Patch
-
-      if ::ActiveJob.const_defined?(:Railtie) &&
-         ActiveJob::Railtie.config.active_job.queue_adapter.to_sym == :sidekiq
-        require_relative 'patch/sidekiq'
-      end
+      ActiveJob::Base.include ActiveJob::Uniqueness::ActiveJobPatch
     end
   end
 end

data/lib/active_job/uniqueness/sidekiq_patch.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  module Uniqueness
+    def self.unlock_sidekiq_job!(job_data)
+      return unless job_data['class'] == 'ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper' # non ActiveJob jobs
+
+      job = ActiveJob::Base.deserialize(job_data.fetch('args').first)
+
+      return unless job.class.lock_strategy_class
+
+      begin
+        job.send(:deserialize_arguments_if_needed)
+      rescue ActiveJob::DeserializationError
+        # Most probably, GlobalID fails to locate AR record (record is deleted)
+      else
+        ActiveJob::Uniqueness.unlock!(job_class_name: job.class.name, arguments: job.arguments)
+      end
+    end
+
+    module SidekiqPatch
+      module SortedEntry
+        def delete
+          ActiveJob::Uniqueness.unlock_sidekiq_job!(item) if super
+          item
+        end
+
+        private
+
+        def remove_job
+          super do |message|
+            ActiveJob::Uniqueness.unlock_sidekiq_job!(Sidekiq.load_json(message))
+            yield message
+          end
+        end
+      end
+
+      module ScheduledSet
+        def delete(score, job_id)
+          entry = find_job(job_id)
+          ActiveJob::Uniqueness.unlock_sidekiq_job!(entry.item) if super(score, job_id)
+          entry
+        end
+      end
+
+      module Job
+        def delete
+          ActiveJob::Uniqueness.unlock_sidekiq_job!(item)
+          super
+        end
+      end
+
+      module Queue
+        def clear
+          each(&:delete)
+          super
+        end
+      end
+
+      module JobSet
+        def clear
+          each(&:delete)
+          super
+        end
+
+        def delete_by_value(name, value)
+          ActiveJob::Uniqueness.unlock_sidekiq_job!(Sidekiq.load_json(value)) if super(name, value)
+        end
+      end
+    end
+  end
+end
+
+Sidekiq::SortedEntry.prepend ActiveJob::Uniqueness::SidekiqPatch::SortedEntry
+Sidekiq::ScheduledSet.prepend ActiveJob::Uniqueness::SidekiqPatch::ScheduledSet
+Sidekiq::Job.prepend ActiveJob::Uniqueness::SidekiqPatch::Job
+Sidekiq::Queue.prepend ActiveJob::Uniqueness::SidekiqPatch::Queue
+Sidekiq::JobSet.prepend ActiveJob::Uniqueness::SidekiqPatch::JobSet
+
+# Global death handlers are introduced in Sidekiq 5.1
+# https://github.com/mperham/sidekiq/blob/e7acb124fbeb0bece0a7c3d657c39a9cc18d72c6/Changes.md#510
+if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('5.1')
+  Sidekiq.death_handlers << ->(job, _ex) { ActiveJob::Uniqueness.unlock_sidekiq_job!(job) }
+end

data/lib/active_job/uniqueness/version.rb

@@ -2,6 +2,6 @@
 
 module ActiveJob
   module Uniqueness
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-uniqueness
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Rustam Sharshenov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: redlock
   requirement: !ruby/object:Gem::Requirement
@@ -45,35 +51,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -107,24 +113,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- activejob-uniqueness.gemspec
 - lib/active_job/uniqueness.rb
+- lib/active_job/uniqueness/active_job_patch.rb
 - lib/active_job/uniqueness/configuration.rb
 - lib/active_job/uniqueness/errors.rb
 - lib/active_job/uniqueness/lock_key.rb
 - lib/active_job/uniqueness/lock_manager.rb
 - lib/active_job/uniqueness/log_subscriber.rb
-- lib/active_job/uniqueness/patch.rb
-- lib/active_job/uniqueness/patch/sidekiq.rb
+- lib/active_job/uniqueness/sidekiq_patch.rb
 - lib/active_job/uniqueness/strategies.rb
 - lib/active_job/uniqueness/strategies/base.rb
 - lib/active_job/uniqueness/strategies/until_and_while_executing.rb

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/Gemfile.lock
-/.ruby-gemset
-/.ruby-version
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,38 +0,0 @@
-AllCops:
-  NewCops: enable
-
-Layout/LineLength:
-  Max: 120
-  Exclude:
-    - spec/**/*
-
-Layout/MultilineMethodCallIndentation:
-  Exclude:
-    - spec/**/*
-
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - spec/**/*
-
-Metrics/AbcSize:
-  Exclude:
-    - spec/**/*
-
-Metrics/BlockLength:
-  Exclude:
-    - activejob-uniqueness.gemspec
-    - spec/**/*
-
-Metrics/MethodLength:
-  Exclude:
-    - spec/**/*
-
-Style/ClassAndModuleChildren:
-  Exclude:
-    - spec/**/*
-
-Style/Documentation:
-  Enabled: false
-
-Style/RescueModifier:
-  Enabled: false

data/.travis.yml

@@ -1,22 +0,0 @@
----
-dist: xenial
-language: ruby
-services:
-  - redis-server
-cache: bundler
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-env:
-  - ACTIVEJOB_VERSION="~> 4.2.11"
-  - ACTIVEJOB_VERSION="~> 5.2.4"
-  - ACTIVEJOB_VERSION="~> 6.0.3"
-  - ACTIVEJOB_VERSION="~> 6.0.3" SIDEKIQ_VERSION="~> 6.0.0"
-jobs:
-  exclude:
-    - rvm: 2.7.1
-      env: ACTIVEJOB_VERSION="~> 4.2.11"
-
-before_install: gem install bundler -v 1.17.3
-bundler_args: --jobs 3 --retry 3

data/Gemfile

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in activejob-uniqueness.gemspec
-gemspec
-
-gem 'activejob', ENV.fetch('ACTIVEJOB_VERSION', '~> 4.2.11')
-
-if ENV['SIDEKIQ_VERSION']
-  gem 'sidekiq', ENV.fetch('SIDEKIQ_VERSION')
-  gem 'railties', ENV.fetch('ACTIVEJOB_VERSION')
-end

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/activejob-uniqueness.gemspec

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'active_job/uniqueness/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'activejob-uniqueness'
-  spec.version       = ActiveJob::Uniqueness::VERSION
-  spec.authors       = ['Rustam Sharshenov']
-  spec.email         = ['rustam@sharshenov.com']
-
-  spec.summary       = 'Ensure uniqueness of your ActiveJob jobs'
-  spec.description   = 'Ensure uniqueness of your ActiveJob jobs'
-  spec.homepage      = 'https://github.com/veeqo/activejob-uniqueness'
-  spec.license       = 'MIT'
-
-  if spec.respond_to?(:metadata)
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = spec.homepage
-    spec.metadata['changelog_uri'] = 'https://github.com/veeqo/activejob-uniqueness/blob/master/CHANGELOG.md'
-  end
-
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|\.rubocop.yml)/}) }
-  end
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'activejob', '>= 4.2'
-  spec.add_dependency 'redlock', '>= 1.2', '< 2'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-end

data/lib/active_job/uniqueness/patch/sidekiq.rb

@@ -1,93 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveJob
-  module Uniqueness
-    module Patch
-      def self.delete_sidekiq_job!(job)
-        ActiveJob::Uniqueness.unlock!(
-          job_class_name: job.fetch('wrapped'),
-          arguments: job.fetch('args').first.fetch('arguments')
-        )
-      end
-    end
-  end
-end
-
-require 'sidekiq/api'
-
-Sidekiq.configure_server do |config|
-  config.death_handlers << ->(job, _ex) do
-    ActiveJob::Uniqueness::Patch.delete_sidekiq_job!(job)
-  end
-end
-
-module Sidekiq
-  class SortedEntry
-    module UniqueExtension
-      def delete
-        ActiveJob::Uniqueness::Patch.delete_sidekiq_job!(item) if super
-        item
-      end
-
-      private
-
-      def remove_job
-        super do |message|
-          ActiveJob::Uniqueness::Patch.delete_sidekiq_job!(Sidekiq.load_json(message))
-          yield message
-        end
-      end
-    end
-
-    prepend UniqueExtension
-  end
-
-  class ScheduledSet
-    module UniqueExtension
-      def delete(score, job_id)
-        entry = find_job(job_id)
-        ActiveJob::Uniqueness::Patch.delete_sidekiq_job!(entry.item) if super(score, job_id)
-        entry
-      end
-    end
-
-    prepend UniqueExtension
-  end
-
-  class Job
-    module UniqueExtension
-      def delete
-        ActiveJob::Uniqueness::Patch.delete_sidekiq_job!(item)
-        super
-      end
-    end
-
-    prepend UniqueExtension
-  end
-
-  class Queue
-    module UniqueExtension
-      def clear
-        each(&:delete)
-        super
-      end
-    end
-
-    prepend UniqueExtension
-  end
-
-  class JobSet
-    module UniqueExtension
-      def clear
-        each(&:delete)
-        super
-      end
-
-      def delete_by_value(name, value)
-        ActiveJob::Uniqueness::Patch.delete_sidekiq_job!(Sidekiq.load_json(value)) if super(name, value)
-      end
-    end
-
-    prepend UniqueExtension
-  end
-end