sidekiq-unique-jobs 3.0.2 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8c45fa6d6faaedc2eb3df2cb7adf815542acfad
-  data.tar.gz: adba5484ba2d2162db6cbf04bb3c73527c44cfa7
+  metadata.gz: ccc0e1c15fcc36a44e3e7717744929a8f23b2bac
+  data.tar.gz: 5151f5ddab6597438efed5cadbccde7ed7bce67c
 SHA512:
-  metadata.gz: 24640f6eaa634d5b6aa0bcc0e532e72a9d255e4b71035527ec5edc0bc76d890c7ce1b50962ce74b6e114d02106d9913c0d88844a8172f32e0c47b579c5faa627
-  data.tar.gz: 5db2d29daa350d4b7427bf90a5728b0ce57753bb907e176b9a65546fc2c39c2bbb37b9d0dde299b02bcc6be0f63183eaa19503a0a96586318a009d1acc836c13
+  metadata.gz: 409b65e0c55d399a5339491b5a216c670f2b398a4d5e36df9d82d8168f388a9981b0738cb0b33caa60a63296aeee4bc567756655735711293bde97e71827e37b
+  data.tar.gz: d6d4528fca55ed0cda6a21215f6fdc2de33c74a7ebcd4ad4b3e2d1c74c551c9c2648ab83a983c614429faea925b9c7e9bb563a808a4ed505c961876774894745

data/.rubocop.yml

@@ -0,0 +1,36 @@
+
+Lint/HandleExceptions:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 38
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/LineLength:
+  Max: 108
+
+Metrics/MethodLength:
+  Max: 13
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+Style/AccessorMethodName:
+  Enabled: true
+
+Style/ConstantName:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/FileName:
+  Enabled: true
+
+Style/GlobalVars:
+  Enabled: true

data/.travis.yml

@@ -22,6 +22,4 @@ notifications:
       - mikael@zoolutions.se
 matrix:
   allow_failures:
-    - rvm: jruby-19mode
     - rvm: rbx-19mode
-    - rvm: 2.0.0

data/Appraisals

@@ -1,5 +1,6 @@
 appraise "sidekiq-develop" do
   gem 'sidekiq', github: 'mperham/sidekiq'
+  gem 'sidekiq', '3.0', :platform => :mri_19
 end
 
 appraise "sidekiq-2.17" do
@@ -16,4 +17,4 @@ end
 
 appraise "sidekiq-3.0" do
   gem "sidekiq", '3.0'
-end
+end

data/CHANGELOG.md

@@ -5,10 +5,10 @@
 - Update travis with redis-server
 
 ## v2.6.5
-- via @sax - possibility to set which arguments should be counted as unique - https://github.com/form26/sidekiq-unique-jobs/pull/12
-- via @eduardosasso - possibility to set which arguments should be counted as unique - https://github.com/form26/sidekiq-unique-jobs/pull/11
-- via @KensoDev - configuration of default expiration - https://github.com/form26/sidekiq-unique-jobs/pull/9
+- via @sax - possibility to set which arguments should be counted as unique - https://github.com/form26/sidekiq_unique_jobs/pull/12
+- via @eduardosasso - possibility to set which arguments should be counted as unique - https://github.com/form26/sidekiq_unique_jobs/pull/11
+- via @KensoDev - configuration of default expiration - https://github.com/form26/sidekiq_unique_jobs/pull/9
 
 ## v2.1.0
 
-Extracted the unique jobs portion from sidekiq main repo since @mperham dropped support for it.
+Extracted the unique jobs portion from sidekiq main repo since @mperham dropped support for it.

data/Gemfile

@@ -2,6 +2,4 @@ source 'http://rubygems.org'
 gemspec
 
 gem 'appraisal', '~> 1.0.0'
-gem 'pry'
-gem 'pry-stack_explorer'
-gem 'pry-debugger'
+gem 'pry', platform: :mri

data/README.md

@@ -41,12 +41,12 @@ Requiring the gem in your gemfile should be sufficient to enable unique jobs.
 
 ### Finer Control over Uniqueness
 
-Sometimes it is desired to have a finer control over which arguments are used in determining uniqueness of the job, and others may be _transient_. For this use-case, you need to set `SidekiqUniqueJobs::Config.unique_args_enabled` to true in an initializer, and then defined either `unique_args` method, or a ruby proc.
+Sometimes it is desired to have a finer control over which arguments are used in determining uniqueness of the job, and others may be _transient_. For this use-case, you need to set `SidekiqUniqueJobs.config.unique_args_enabled` to true in an initializer, and then defined either `unique_args` method, or a ruby proc.
 
 The unique_args method need to return an array of values to use for uniqueness check.
 
 ```ruby
-SidekiqUniqueJobs::Config.unique_args_enabled = true
+SidekiqUniqueJobs.config.unique_args_enabled = true
 ```
 
 The method or the proc can return a modified version of args without the transient arguments included, as shown below:

data/Rakefile

@@ -1,9 +1,11 @@
 #!/usr/bin/env rake
-require "rubygems"
-require "bundler/setup"
-require "bundler/gem_tasks"
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
+RuboCop::RakeTask.new(:style)
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: [:spec, :style]

data/gemfiles/sidekiq_2.15.gemfile

@@ -3,9 +3,7 @@
 source "http://rubygems.org"
 
 gem "appraisal", "~> 1.0.0"
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-debugger"
+gem "pry", :platform => :mri
 gem "sidekiq", "2.15"
 
 gemspec :path => "../"

data/gemfiles/sidekiq_2.16.gemfile

@@ -3,9 +3,7 @@
 source "http://rubygems.org"
 
 gem "appraisal", "~> 1.0.0"
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-debugger"
+gem "pry", :platform => :mri
 gem "sidekiq", "2.16"
 
 gemspec :path => "../"

data/gemfiles/sidekiq_2.17.gemfile

@@ -3,9 +3,7 @@
 source "http://rubygems.org"
 
 gem "appraisal", "~> 1.0.0"
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-debugger"
+gem "pry", :platform => :mri
 gem "sidekiq", "2.17"
 
 gemspec :path => "../"

data/gemfiles/sidekiq_3.0.gemfile

@@ -3,9 +3,7 @@
 source "http://rubygems.org"
 
 gem "appraisal", "~> 1.0.0"
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-debugger"
+gem "pry", :platform => :mri
 gem "sidekiq", "3.0"
 
 gemspec :path => "../"

data/gemfiles/sidekiq_develop.gemfile

@@ -3,9 +3,7 @@
 source "http://rubygems.org"
 
 gem "appraisal", "~> 1.0.0"
-gem "pry"
-gem "pry-stack_explorer"
-gem "pry-debugger"
-gem "sidekiq", :github => "mperham/sidekiq"
+gem "pry", :platform => :mri
+gem "sidekiq", "3.0", :platform => :mri_19
 
 gemspec :path => "../"

data/lib/sidekiq_unique_jobs.rb

@@ -0,0 +1,27 @@
+require 'yaml' if RUBY_VERSION.include?('2.0.0')
+require 'sidekiq_unique_jobs/middleware'
+require 'sidekiq_unique_jobs/version'
+require 'sidekiq_unique_jobs/config'
+require 'sidekiq_unique_jobs/payload_helper'
+require 'ostruct'
+
+module SidekiqUniqueJobs
+  module_function
+
+  def config
+    @config ||= Config.new(
+      unique_prefix: 'sidekiq_unique',
+      unique_args_enabled: false,
+      default_expiration: 30 * 60,
+      default_unlock_order: :after_yield
+    )
+  end
+
+  def unique_args_enabled?
+    config.unique_args_enabled
+  end
+
+  def configure
+    yield configuration
+  end
+end

data/lib/sidekiq_unique_jobs/config.rb

@@ -0,0 +1,47 @@
+module SidekiqUniqueJobs
+  class Config < OpenStruct
+    CONFIG_ACCESSORS = [
+      :unique_prefix,
+      :unique_args_enabled,
+      :default_expiration,
+      :default_unlock_order
+    ]
+
+    class << self
+      warn('This method has been deprecated. See readme for information')
+      CONFIG_ACCESSORS.each do |method|
+        define_method(method) do
+          warn('This method has been deprecated. See readme for information')
+          config.send(method)
+        end
+
+        define_method("#{method}=") do |obj|
+          warn('This method has been deprecated. See readme for information')
+          config.send("#{method}=", obj)
+        end
+      end
+
+      def unique_args_enabled?
+        warn('This method has been deprecated. See readme for information')
+        config.unique_args_enabled
+      end
+
+      def config
+        SidekiqUniqueJobs.config
+      end
+    end
+
+    def testing_enabled?
+      if Sidekiq.const_defined?('Testing') && Sidekiq::Testing.enabled?
+        require 'sidekiq_unique_jobs/testing'
+        return true
+      end
+
+      false
+    end
+
+    def unique_args_enabled?
+      config.unique_args_enabled
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/connectors.rb

@@ -0,0 +1,16 @@
+require 'sidekiq_unique_jobs/connectors/testing'
+require 'sidekiq_unique_jobs/connectors/redis_pool'
+require 'sidekiq_unique_jobs/connectors/sidekiq_redis'
+
+module SidekiqUniqueJobs
+  module Connectors
+    CONNECTOR_TYPES = [Testing, RedisPool, SidekiqRedis]
+
+    def self.conn(redis_pool = nil)
+      CONNECTOR_TYPES.each do |connector|
+        conn = connector.conn(redis_pool)
+        return conn if conn
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/connectors/redis_pool.rb

@@ -0,0 +1,10 @@
+module SidekiqUniqueJobs
+  module Connectors
+    class RedisPool
+      def self.conn(redis_pool = nil)
+        return if redis_pool.nil?
+        redis_pool.with { |conn| conn }
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/connectors/sidekiq_redis.rb

@@ -0,0 +1,9 @@
+module SidekiqUniqueJobs
+  module Connectors
+    class SidekiqRedis
+      def self.conn(_redis_pool = nil)
+        Sidekiq.redis { |conn| conn }
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/connectors/testing.rb

@@ -0,0 +1,10 @@
+module SidekiqUniqueJobs
+  module Connectors
+    class Testing
+      def self.conn(_redis_pool = nil)
+        return unless SidekiqUniqueJobs.config.testing_enabled?
+        SidekiqUniqueJobs.redis_mock { |conn| conn }
+      end
+    end
+  end
+end

data/lib/{sidekiq-unique-jobs → sidekiq_unique_jobs}/middleware.rb

@@ -2,11 +2,11 @@ require 'sidekiq'
 
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
-    require 'sidekiq-unique-jobs/middleware/server/unique_jobs'
+    require 'sidekiq_unique_jobs/middleware/server/unique_jobs'
     chain.add SidekiqUniqueJobs::Middleware::Server::UniqueJobs
   end
   config.client_middleware do |chain|
-    require 'sidekiq-unique-jobs/middleware/client/unique_jobs'
+    require 'sidekiq_unique_jobs/middleware/client/unique_jobs'
     chain.add SidekiqUniqueJobs::Middleware::Client::UniqueJobs
   end
 
@@ -14,7 +14,7 @@ end
 
 Sidekiq.configure_client do |config|
   config.client_middleware do |chain|
-    require 'sidekiq-unique-jobs/middleware/client/unique_jobs'
+    require 'sidekiq_unique_jobs/middleware/client/unique_jobs'
     chain.add SidekiqUniqueJobs::Middleware::Client::UniqueJobs
   end
 end

data/lib/sidekiq_unique_jobs/middleware/client/strategies/testing_inline.rb

@@ -0,0 +1,25 @@
+require 'sidekiq_unique_jobs/middleware/server/unique_jobs'
+
+module SidekiqUniqueJobs
+  module Middleware
+    module Client
+      module Strategies
+        class TestingInline < Unique
+          def self.elegible?
+            SidekiqUniqueJobs.config.testing_enabled? && Sidekiq::Testing.inline?
+          end
+
+          def review
+            _middleware.call(worker_class.new, item, queue, redis_pool) do
+              super
+            end
+          end
+
+          def _middleware
+            SidekiqUniqueJobs::Middleware::Server::UniqueJobs.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/middleware/client/strategies/unique.rb

@@ -0,0 +1,72 @@
+require 'digest'
+require 'sidekiq_unique_jobs/connectors'
+
+module SidekiqUniqueJobs
+  module Middleware
+    module Client
+      module Strategies
+        class Unique
+          def self.elegible?
+            true
+          end
+
+          def self.review(worker_class, item, queue, redis_pool = nil)
+            new(worker_class, item, queue, redis_pool).review { yield }
+          end
+
+          def initialize(worker_class, item, queue, redis_pool = nil)
+            @worker_class = worker_class
+            @item = item
+            @queue = queue
+            @redis_pool = redis_pool
+          end
+
+          def review
+            item['unique_hash'] = payload_hash
+            return unless unique_for_connection?
+            yield
+          end
+
+          private
+
+          attr_reader :item, :worker_class, :redis_pool, :queue
+
+          def unique_for_connection?
+            unique = false
+            conn.watch(payload_hash)
+
+            if conn.get(payload_hash).to_i == 1 ||
+               (conn.get(payload_hash).to_i == 2 && item['at'])
+              # if the job is already queued, or is already scheduled and
+              # we're trying to schedule again, abort
+              conn.unwatch
+            else
+              # if the job was previously scheduled and is now being queued,
+              # or we've never seen it before
+              expires_at = unique_job_expiration || SidekiqUniqueJobs.config.default_expiration
+              expires_at = ((Time.at(item['at']) - Time.now.utc) + expires_at).to_i if item['at']
+
+              unique = conn.multi do
+                # set value of 2 for scheduled jobs, 1 for queued jobs.
+                conn.setex(payload_hash, expires_at, item['at'] ? 2 : 1)
+              end
+            end
+            unique
+          end
+
+          def conn
+            SidekiqUniqueJobs::Connectors.conn(redis_pool)
+          end
+
+          def payload_hash
+            SidekiqUniqueJobs::PayloadHelper.get_payload(item['class'], item['queue'], item['args'])
+          end
+
+          def unique_job_expiration
+            worker_class.get_sidekiq_options['unique_job_expiration']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_unique_jobs/middleware/client/unique_jobs.rb

@@ -0,0 +1,48 @@
+require 'sidekiq_unique_jobs/middleware/client/strategies/unique'
+require 'sidekiq_unique_jobs/middleware/client/strategies/testing_inline'
+
+module SidekiqUniqueJobs
+  module Middleware
+    module Client
+      class UniqueJobs
+        STRATEGIES = [
+          Strategies::TestingInline,
+          Strategies::Unique
+        ]
+
+        attr_reader :item, :worker_class, :redis_pool
+
+        def call(worker_class, item, queue, redis_pool = nil)
+          @worker_class = worker_class_constantize(worker_class)
+          @item = item
+          @redis_pool = redis_pool
+
+          if unique_enabled?
+            strategy.review(worker_class, item, queue, redis_pool) { yield }
+          else
+            yield
+          end
+        end
+
+        private
+
+        def unique_enabled?
+          worker_class.get_sidekiq_options['unique'] || item['unique']
+        end
+
+        def strategy
+          STRATEGIES.detect(&:elegible?)
+        end
+
+        # Attempt to constantize a string worker_class argument, always
+        # failing back to the original argument.
+        def worker_class_constantize(worker_class)
+          return worker_class unless worker_class.is_a?(String)
+          worker_class.constantize
+        rescue NameError
+          worker_class
+        end
+      end
+    end
+  end
+end