sidekiq-unique-jobs 3.0.2 → 3.0.5

data/spec/lib/sidekiq_testing_enabled_spec.rb

@@ -1,14 +1,15 @@
 require 'spec_helper'
 require 'sidekiq/worker'
-require "sidekiq-unique-jobs"
+require 'sidekiq_unique_jobs'
 require 'sidekiq/scheduled'
-require 'sidekiq-unique-jobs/middleware/server/unique_jobs'
+require 'sidekiq_unique_jobs/middleware/server/unique_jobs'
+require 'active_support/testing/time_helpers'
 require 'rspec-sidekiq'
 
-describe "When Sidekiq::Testing is enabled" do
+describe 'When Sidekiq::Testing is enabled' do
   describe 'when set to :fake!', sidekiq: :fake do
-    context "with unique worker" do
-      it "does not push duplicate messages" do
+    context 'with unique worker' do
+      it 'does not push duplicate messages' do
         param = 'work'
         expect(UniqueWorker.jobs.size).to eq(0)
         UniqueWorker.perform_async(param)
@@ -18,7 +19,7 @@ describe "When Sidekiq::Testing is enabled" do
         expect(UniqueWorker.jobs.size).to eq(1)
       end
 
-      it "adds the unique_hash to the message" do
+      it 'adds the unique_hash to the message' do
         param = 'hash'
         hash = SidekiqUniqueJobs::PayloadHelper.get_payload(UniqueWorker, :working, [param])
         UniqueWorker.perform_async(param)
@@ -27,9 +28,9 @@ describe "When Sidekiq::Testing is enabled" do
       end
     end
 
-    context "with non-unique worker" do
+    context 'with non-unique worker' do
 
-      it "pushes duplicates messages" do
+      it 'pushes duplicates messages' do
         param = 'work'
         expect(MyWorker.jobs.size).to eq(0)
         MyWorker.perform_async(param)
@@ -40,4 +41,85 @@ describe "When Sidekiq::Testing is enabled" do
       end
     end
   end
+
+  describe 'when set to :inline!', sidekiq: :inline do
+    class InlineWorker
+      include Sidekiq::Worker
+      sidekiq_options unique: true
+
+      def perform(x)
+        TestClass.run(x)
+      end
+    end
+
+    class InlineUnlockOrderWorker
+      include Sidekiq::Worker
+      sidekiq_options unique: true, unique_unlock_order: :never
+
+      def perform(x)
+        TestClass.run(x)
+      end
+    end
+
+    class InlineUnlockOrderWorker
+      include Sidekiq::Worker
+      sidekiq_options unique: true, unique_unlock_order: :never
+
+      def perform(x)
+        TestClass.run(x)
+      end
+    end
+
+    class InlineExpirationWorker
+      include Sidekiq::Worker
+      sidekiq_options unique: true, unique_unlock_order: :never,
+                      unique_job_expiration: 10 * 60
+      def perform(x)
+        TestClass.run(x)
+      end
+    end
+
+    class TestClass
+      def self.run(_x)
+      end
+    end
+
+    it 'once the job is completed allows to run another one' do
+      expect(TestClass).to receive(:run).exactly(2).times
+
+      InlineWorker.perform_async('test')
+      InlineWorker.perform_async('test')
+    end
+
+    it 'if the unique is kept forever it does not allows to run the job again' do
+      expect(TestClass).to receive(:run).once
+
+      InlineUnlockOrderWorker.perform_async('test')
+      InlineUnlockOrderWorker.perform_async('test')
+    end
+
+    describe 'when a job is set to run once in 10 minutes' do
+      include ActiveSupport::Testing::TimeHelpers
+      it 'only allows 1 call per 10 minutes' do
+        allow(TestClass).to receive(:run).with(1).and_return(true)
+        allow(TestClass).to receive(:run).with(2).and_return(true)
+
+        InlineExpirationWorker.perform_async(1)
+        expect(TestClass).to have_received(:run).with(1).once
+        100.times do
+          InlineExpirationWorker.perform_async(1)
+        end
+        expect(TestClass).to have_received(:run).with(1).once
+        InlineExpirationWorker.perform_async(2)
+        expect(TestClass).to have_received(:run).with(1).once
+        expect(TestClass).to have_received(:run).with(2).once
+        travel_to(11.minutes.from_now) do
+          InlineExpirationWorker.perform_async(1)
+        end
+
+        expect(TestClass).to have_received(:run).with(1).twice
+      end
+    end
+
+  end
 end

data/spec/lib/unlock_order_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 require 'sidekiq/api'
 require 'sidekiq/worker'
-require 'sidekiq-unique-jobs/middleware/server/unique_jobs'
+require 'sidekiq_unique_jobs/middleware/server/unique_jobs'
 
-describe "Unlock order" do
+describe 'Unlock order' do
   QUEUE = 'unlock_ordering'
 
   class BeforeYieldOrderingWorker
@@ -27,7 +27,7 @@ describe "Unlock order" do
   describe 'with real redis' do
     before do
       Sidekiq.redis = REDIS
-      Sidekiq.redis { |c| c.flushdb }
+      Sidekiq.redis(&:flushdb)
       @middleware = SidekiqUniqueJobs::Middleware::Server::UniqueJobs.new
     end
 

data/spec/spec_helper.rb

@@ -1,8 +1,7 @@
-$TESTING = true
-
 begin
   require 'pry'
 rescue LoadError
+  puts 'Pry unavailable'
 end
 
 require 'rspec'
@@ -10,7 +9,7 @@ require 'rspec'
 require 'celluloid/test'
 require 'sidekiq'
 require 'sidekiq/util'
-require 'sidekiq-unique-jobs'
+require 'sidekiq_unique_jobs'
 Sidekiq.logger.level = Logger::ERROR
 
 require 'rspec-sidekiq'
@@ -19,10 +18,10 @@ Sidekiq::Testing.disable!
 
 require 'sidekiq/redis_connection'
 redis_url = ENV['REDIS_URL'] || 'redis://localhost/15'
-REDIS = Sidekiq::RedisConnection.create(:url => redis_url, :namespace => 'testy')
+REDIS = Sidekiq::RedisConnection.create(url: redis_url, namespace: 'testy')
 
 Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each { |f| require f }
-RSpec.configure do |config|
+RSpec.configure do |_config|
   # config.treat_symbols_as_metadata_keys_with_true_values = true
 end
 
@@ -35,4 +34,4 @@ RSpec::Sidekiq.configure do |config|
 
   # Warn when jobs are not enqueued to Redis but to a job array
   config.warn_when_jobs_not_processed_by_sidekiq = true # default => true
-end
+end

data/spec/support/my_worker.rb

@@ -1,7 +1,7 @@
 class MyWorker
   include Sidekiq::Worker
-  sidekiq_options :queue => :working, :retry => 1, :backtrace => 10
-  sidekiq_options :unique => false
+  sidekiq_options queue: :working, retry: 1, backtrace: 10
+  sidekiq_options unique: false
 
   sidekiq_retries_exhausted do |msg|
     Sidekiq.logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
@@ -10,4 +10,4 @@ class MyWorker
   def perform(param)
     puts param
   end
-end
+end

data/spec/support/sidekiq_meta.rb

@@ -1,15 +1,12 @@
 RSpec.configure do |config|
   config.before(:each) do |example|
-    sidekiq = example.metadata[:sidekiq]
-    if sidekiq
+    if (sidekiq = example.metadata[:sidekiq])
       sidekiq = :fake if sidekiq == true
       Sidekiq::Testing.send("#{sidekiq}!")
     end
   end
 
   config.after(:each) do |example|
-    if sidekiq = example.metadata[:sidekiq]
-      Sidekiq::Testing.disable!
-    end
+    Sidekiq::Testing.disable! unless example.metadata[:sidekiq].nil?
   end
-end
+end

data/spec/support/unique_worker.rb

@@ -1,7 +1,7 @@
 class UniqueWorker
   include Sidekiq::Worker
-  sidekiq_options :queue => :working, :retry => 1, :backtrace => 10
-  sidekiq_options :unique => true
+  sidekiq_options queue: :working, retry: 1, backtrace: 10
+  sidekiq_options unique: true
 
   sidekiq_retries_exhausted do |msg|
     Sidekiq.logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
@@ -10,4 +10,4 @@ class UniqueWorker
   def perform(param)
     puts param
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-unique-jobs
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.5
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-08 00:00:00.000000000 Z
+date: 2014-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -31,7 +31,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +131,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.md
@@ -129,15 +144,22 @@ files:
 - gemfiles/sidekiq_2.17.gemfile
 - gemfiles/sidekiq_3.0.gemfile
 - gemfiles/sidekiq_develop.gemfile
-- lib/sidekiq-unique-jobs.rb
-- lib/sidekiq-unique-jobs/config.rb
-- lib/sidekiq-unique-jobs/middleware.rb
-- lib/sidekiq-unique-jobs/middleware/client/unique_jobs.rb
-- lib/sidekiq-unique-jobs/middleware/server/unique_jobs.rb
-- lib/sidekiq-unique-jobs/payload_helper.rb
-- lib/sidekiq-unique-jobs/testing.rb
-- lib/sidekiq-unique-jobs/version.rb
+- lib/sidekiq_unique_jobs.rb
+- lib/sidekiq_unique_jobs/config.rb
+- lib/sidekiq_unique_jobs/connectors.rb
+- lib/sidekiq_unique_jobs/connectors/redis_pool.rb
+- lib/sidekiq_unique_jobs/connectors/sidekiq_redis.rb
+- lib/sidekiq_unique_jobs/connectors/testing.rb
+- lib/sidekiq_unique_jobs/middleware.rb
+- lib/sidekiq_unique_jobs/middleware/client/strategies/testing_inline.rb
+- lib/sidekiq_unique_jobs/middleware/client/strategies/unique.rb
+- lib/sidekiq_unique_jobs/middleware/client/unique_jobs.rb
+- lib/sidekiq_unique_jobs/middleware/server/unique_jobs.rb
+- lib/sidekiq_unique_jobs/payload_helper.rb
+- lib/sidekiq_unique_jobs/testing.rb
+- lib/sidekiq_unique_jobs/version.rb
 - sidekiq-unique-jobs.gemspec
+- spec/lib/.sidekiq_testing_enabled_spec.rb.swp
 - spec/lib/client_spec.rb
 - spec/lib/middleware/server/unique_jobs_spec.rb
 - spec/lib/sidekiq_testing_enabled_spec.rb

data/lib/sidekiq-unique-jobs.rb

@@ -1,11 +0,0 @@
-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"
-
-module SidekiqUniqueJobs
-  def self.config
-    SidekiqUniqueJobs::Config
-  end
-end

data/lib/sidekiq-unique-jobs/config.rb

@@ -1,35 +0,0 @@
-module SidekiqUniqueJobs
-  class Config
-    def self.unique_prefix=(prefix)
-      @unique_prefix = prefix
-    end
-
-    def self.unique_prefix
-      @unique_prefix || "sidekiq_unique"
-    end
-
-    def self.unique_args_enabled=(enabled)
-      @unique_args_enabled = enabled
-    end
-
-    def self.unique_args_enabled?
-      @unique_args_enabled || false
-    end
-
-    def self.default_expiration=(expiration)
-      @expiration = expiration
-    end
-
-    def self.default_expiration
-      @expiration || 30 * 60
-    end
-
-    def self.default_unlock_order=(order)
-      @default_unlock_order = order
-    end
-
-    def self.default_unlock_order
-      @default_unlock_order || :after_yield
-    end
-  end
-end

data/lib/sidekiq-unique-jobs/middleware/client/unique_jobs.rb

@@ -1,101 +0,0 @@
-require 'digest'
-
-module SidekiqUniqueJobs
-  module Middleware
-    module Client
-      class UniqueJobs
-        attr_reader :item, :worker_class, :redis_pool
-
-        def call(worker_class, item, queue, redis_pool = nil)
-          @redis_pool = redis_pool
-          @worker_class = worker_class_constantize(worker_class)
-          @item = item
-
-          if unique_enabled?
-            @item['unique_hash'] = payload_hash
-            yield if unique?
-          else
-            yield
-          end
-        end
-
-        def unique?
-          if testing_enabled?
-            unique_for_connection?(SidekiqUniqueJobs.redis_mock)
-          else
-            if redis_pool
-              redis_pool.with do |conn|
-                unique_for_connection?(conn)
-              end
-            else
-              Sidekiq.redis do |conn|
-                unique_for_connection?(conn)
-              end
-            end
-          end
-        end
-
-        def unique_for_connection?(conn)
-          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
-
-        protected
-
-        # Attempt to constantize a string worker_class argument, always
-        # failing back to the original argument.
-        def worker_class_constantize(worker_class)
-          if worker_class.is_a?(String)
-            worker_class.constantize rescue worker_class
-          else
-            worker_class
-          end
-        end
-
-        private
-
-        def payload_hash
-          SidekiqUniqueJobs::PayloadHelper.get_payload(item['class'], item['queue'], item['args'])
-        end
-
-        # When sidekiq/testing is loaded, the Sidekiq::Testing constant is
-        # present and testing is enabled.
-        def testing_enabled?
-          if Sidekiq.const_defined?('Testing') && Sidekiq::Testing.enabled?
-            require 'sidekiq-unique-jobs/testing'
-            return true
-          end
-
-          false
-        end
-
-        def unique_enabled?
-          worker_class.get_sidekiq_options['unique'] || item['unique']
-        end
-
-        def unique_job_expiration
-          worker_class.get_sidekiq_options['unique_job_expiration']
-        end
-
-      end
-    end
-  end
-end