sidekiq-unique-jobs 5.0.0 → 5.0.1

data/lib/sidekiq_unique_jobs/version.rb

@@ -1,3 +1,3 @@
 module SidekiqUniqueJobs
-  VERSION = '5.0.0'.freeze
+  VERSION = '5.0.1'.freeze
 end

data/rails_example/.env

@@ -3,7 +3,7 @@ APP_DOMAIN=localhost
 APP_WEB_URL=http://localhost:3000
 APP_CABLE_URL=ws://localhost:28080
 WEB_CONSOLE_WHITELISTED_IPS=127.0.0.1 ::1 127.0.0.0/8 ::1
-DB_HOST=postgres
+DB_HOST=localhost
 DB_PORT=5432
 DB_USERNAME=mhenrixon
 DB_PASSWORD=

data/rails_example/Gemfile

@@ -25,6 +25,7 @@ gem 'sidekiq-unique-jobs', path: '../'
 gem 'sinatra', github: 'sinatra/sinatra'
 
 group :development do
+  gem 'foreman'
   gem 'web-console'
 end
 

data/rails_example/Procfile

@@ -1,2 +1,2 @@
 web:    bundle exec rails server -p $PORT
-worker: bundle exec sidekiq
+worker: bundle exec sidekiq -C config/sidekiq.yml

data/rails_example/app/workers/simple_worker.rb

@@ -8,7 +8,7 @@ class SimpleWorker
 
   def perform(some_args)
     Sidekiq::Logging.with_context(self.class.name) do
-      Sidekiq.logger.debug { "#{__method__}(#{some_args})" }
+      SidekiqUniqueJobs.logger.debug { "#{__method__}(#{some_args})" }
     end
     sleep 1
   end

data/rails_example/app/workers/slow_until_executing_worker.rb

@@ -8,7 +8,7 @@ class SlowUntilExecutingWorker
 
   def perform(some_args)
     Sidekiq::Logging.with_context(self.class.name) do
-      Sidekiq.logger.debug { "#{__method__}(#{some_args})" }
+      SidekiqUniqueJobs.logger.debug { "#{__method__}(#{some_args})" }
     end
     sleep 15
   end

data/rails_example/app/workers/spawn_simple_worker.rb

@@ -3,7 +3,7 @@ class SpawnSimpleWorker
 
   def perform(spawn_arg)
     Sidekiq::Logging.with_context(self.class.name) do
-      Sidekiq.logger.debug { "#{__method__}(#{spawn_arg})" }
+      logger.debug { "#{__method__}(#{spawn_arg})" }
     end
     SimpleWorker.perform_async spawn_arg
   end

data/rails_example/app/workers/while_executing_worker.rb

@@ -0,0 +1,12 @@
+class WhileExecutingWorker
+  include Sidekiq::Worker
+
+  sidekiq_options unique: :while_executing
+
+  def perform(_one, _two)
+    Sidekiq::Logging.with_context(self.class.name) do
+      logger.debug { "#{__method__}(#{some_args})" }
+    end
+    sleep 10
+  end
+end

data/rails_example/app/workers/without_argument_worker.rb

@@ -5,7 +5,7 @@ class WithoutArgumentWorker
 
   def perform
     Sidekiq::Logging.with_context(self.class.name) do
-      Sidekiq.logger.debug { __method__.to_s }
+      logger.debug { __method__.to_s }
     end
     sleep 20
   end

data/sidekiq-unique-jobs.gemspec

@@ -23,5 +23,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'timecop'
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'gem-release'
+  gem.add_development_dependency 'aruba'
   gem.add_development_dependency 'codeclimate-test-reporter', '~> 1.0.0'
 end

data/spec/jobs/another_unique_job.rb

@@ -4,7 +4,7 @@ class AnotherUniqueJob
                   unique: :until_executed
 
   sidekiq_retries_exhausted do |msg|
-    Sidekiq.logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
+    logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
   end
 
   def perform(*)

data/spec/jobs/my_job.rb

@@ -3,7 +3,7 @@ class MyJob
   sidekiq_options queue: :working, retry: 1, backtrace: 10, unique: false
 
   sidekiq_retries_exhausted do |msg|
-    Sidekiq.logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
+    logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
   end
 
   def perform(*)

data/spec/jobs/unique_job_with_filter_method.rb

@@ -4,7 +4,7 @@ class UniqueJobWithFilterMethod
                   unique: :while_executing, unique_args: :filtered_args
 
   sidekiq_retries_exhausted do |msg|
-    Sidekiq.logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
+    logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
   end
 
   def perform(*)

data/spec/jobs/unique_on_all_queues_job.rb

@@ -4,7 +4,7 @@ class UniqueOnAllQueuesJob
                   unique: :until_executed, unique_on_all_queues: true
 
   sidekiq_retries_exhausted do |msg|
-    Sidekiq.logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
+    logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
   end
 
   def perform(*)

data/spec/jobs/until_executed_job.rb

@@ -4,7 +4,7 @@ class UntilExecutedJob
   sidekiq_options unique: :until_executed
 
   sidekiq_retries_exhausted do |msg|
-    Sidekiq.logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
+    logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
   end
 
   def perform(*)

data/spec/jobs/while_executing_job.rb

@@ -3,7 +3,7 @@ class WhileExecutingJob
   sidekiq_options queue: :working, retry: 1, backtrace: 10, unique: :while_executing
 
   sidekiq_retries_exhausted do |msg|
-    Sidekiq.logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
+    logger.warn "Failed #{msg['class']} with #{msg['args']}: #{msg['error_message']}"
   end
 
   def perform(_)

data/spec/lib/sidekiq_unique_jobs/cli_spec.rb

@@ -0,0 +1,183 @@
+require 'spec_helper'
+require 'thor/runner'
+
+RSpec.describe SidekiqUniqueJobs::Cli, ruby_ver: '>= 2.4' do
+  describe '#help' do
+    let(:output) { capture(:stdout) { described_class.start(%w[help]) } }
+    let(:banner) do
+      <<~EOS.freeze
+        Commands:
+          jobs  console         # drop into a console with easy access to helper methods
+          jobs  del PATTERN     # deletes unique keys from redis by pattern
+          jobs  expire          # removes all expired unique keys from the hash in redis
+          jobs  help [COMMAND]  # Describe available commands or one specific command
+          jobs  keys PATTERN    # list all unique keys and their expiry time
+      EOS
+    end
+
+    it 'displays help' do
+      expect(output).to include(banner)
+    end
+
+    describe '#help del' do
+      let(:output) { capture(:stdout) { described_class.start(%w[help del]) } }
+      let(:banner) do
+        <<~EOS.freeze
+          Usage:
+            jobs  del PATTERN
+
+          Options:
+            d, [--dry-run], [--no-dry-run]  # set to false to perform deletion
+            c, [--count=N]                  # The max number of keys to return
+                                            # Default: 1000
+
+          deletes unique keys from redis by pattern
+        EOS
+      end
+
+      it 'displays help about the `del` command' do
+        expect(output).to eq(banner)
+      end
+    end
+
+    describe '#help expire' do
+      let(:output) { capture(:stdout) { described_class.start(%w[help expire]) } }
+
+      let(:banner) do
+        <<~EOS.freeze
+          Usage:
+            jobs  expire
+
+          removes all expired unique keys from the hash in redis
+        EOS
+      end
+
+      it 'displays help about the `expire` command' do
+        expect(output).to eq(banner)
+      end
+    end
+
+    describe '#help keys' do
+      let(:output) { capture(:stdout) { described_class.start(%w[help keys]) } }
+      let(:banner) do
+        <<~EOS.freeze
+          Usage:
+            jobs  keys PATTERN
+
+          Options:
+            c, [--count=N]  # The max number of keys to return
+                            # Default: 1000
+
+          list all unique keys and their expiry time
+        EOS
+      end
+
+      it 'displays help about the `key` command' do
+        expect(output).to eq(banner)
+      end
+    end
+  end
+
+  let(:pattern) { '*' }
+  let(:max_lock_time) { 1 }
+  let(:unique_key) { 'uniquejobs:abcdefab' }
+  let(:jid) { 'abcdefab' }
+
+  describe '.keys' do
+    let(:output) { capture(:stdout) { described_class.start(%w[keys * --count 1000]) } }
+
+    context 'when no keys exist' do
+      let(:expected) { "Found 0 keys matching '#{pattern}':\n" }
+      specify { expect(output).to eq(expected) }
+    end
+
+    context 'when a key exists' do
+      let(:keys) { ['defghayl', jid, 'poilkij'].sort }
+      before do
+        keys.each do |jid|
+          unique_key = "uniquejobs:#{jid}"
+          SidekiqUniqueJobs::Scripts::AcquireLock.execute(nil, unique_key, jid, 20)
+          expect(SidekiqUniqueJobs)
+            .to have_key(unique_key)
+            .for_seconds(20)
+            .with_value(jid)
+        end
+      end
+
+      after { SidekiqUniqueJobs::Util.del('*', 1000, false) }
+
+      let(:expected) do
+        <<~EOS
+        Found 3 keys matching '#{pattern}':
+        uniquejobs:abcdefab  uniquejobs:defghayl  uniquejobs:poilkij
+        EOS
+      end
+      specify do
+        expect(output).to eq(expected)
+      end
+    end
+  end
+
+  describe '.del' do
+    let(:expected) do
+      <<~EOS
+        Deleted 1 keys matching '*'
+      EOS
+    end
+
+    before do
+      SidekiqUniqueJobs::Scripts::AcquireLock.execute(nil, unique_key, jid, max_lock_time)
+      expect(SidekiqUniqueJobs)
+        .to have_key(unique_key)
+        .for_seconds(1)
+        .with_value(jid)
+    end
+
+    specify do
+      output = capture(:stdout) { described_class.start(%w[del * --no-dry-run --count 1000]) }
+      expect(output).to eq(expected)
+      expect(SidekiqUniqueJobs).not_to have_key(unique_key)
+    end
+  end
+
+  describe '.expire' do
+    before do
+      SidekiqUniqueJobs::Scripts::AcquireLock.execute(nil, unique_key, jid, max_lock_time)
+      expect(SidekiqUniqueJobs)
+        .to have_key(unique_key)
+        .for_seconds(1)
+        .with_value(jid)
+    end
+    let(:expected) do
+      <<~EOS
+        Removed 1 left overs from redis.
+        uniquejobs:abcdefab
+      EOS
+    end
+
+    specify do
+      sleep 1
+      output = capture(:stdout) { described_class.start(%w[expire]) }
+      expect(output).to eq(expected)
+    end
+  end
+
+  describe '.console' do
+    let(:expected) do
+      <<~EOS
+        Use `keys '*', 1000 to display the first 1000 unique keys matching '*'
+        Use `del '*', 1000, true (default) to see how many keys would be deleted for the pattern '*'
+        Use `del '*', 1000, false to delete the first 1000 keys matching '*'
+      EOS
+    end
+    let(:output) { capture(:stdout) { described_class.start(%w[console]) } }
+
+    specify do
+      expect(Object).to receive(:include).with(SidekiqUniqueJobs::Util).and_return(true)
+      console = double(:console)
+      allow_any_instance_of(SidekiqUniqueJobs::Cli).to receive(:console_class).and_return(console)
+      allow(console).to receive(:start)
+      expect(output).to eq(expected)
+    end
+  end
+end

data/spec/lib/sidekiq_unique_jobs/client/middleware_spec.rb

@@ -9,14 +9,6 @@ RSpec.describe SidekiqUniqueJobs::Client::Middleware do
   end
 
   describe 'with real redis' do
-    before do
-      if defined?(Sidekiq::Extensions) && Sidekiq::Extensions.respond_to?(:enable_delay!)
-        Sidekiq::Extensions.enable_delay!
-      end
-      Sidekiq.redis = REDIS
-      Sidekiq.redis(&:flushdb)
-    end
-
     describe 'when a job is already scheduled' do
       it 'processes jobs properly' do
         Sidekiq::Testing.disable! do
@@ -288,7 +280,7 @@ RSpec.describe SidekiqUniqueJobs::Client::Middleware do
     end
 
     it 'does not log duplicate payload when config turned off' do
-      expect(Sidekiq.logger).to_not receive(:warn).with(/^payload is not unique/)
+      expect(SidekiqUniqueJobs.logger).to_not receive(:warn).with(/^payload is not unique/)
 
       UntilExecutedJob.sidekiq_options log_duplicate_payload: false
 

data/spec/lib/sidekiq_unique_jobs/lock/until_and_while_executing_spec.rb

@@ -15,8 +15,6 @@ RSpec.describe SidekiqUniqueJobs::Lock::UntilAndWhileExecuting do
 
   describe '#execute' do
     before do
-      Sidekiq.redis(&:flushdb)
-      Sidekiq::Worker.clear_all
       subject.lock(:client)
     end
     let(:runtime_lock) { SidekiqUniqueJobs::Lock::WhileExecuting.new(item, nil) }

data/spec/lib/sidekiq_unique_jobs/script_mock_spec.rb

@@ -14,7 +14,6 @@ RSpec.describe SidekiqUniqueJobs::ScriptMock, ruby_ver: '>= 2.4.1' do
   ANOTHER_JID ||= 'anotherjid'.freeze
 
   before do
-    Sidekiq.redis(&:flushdb)
     SidekiqUniqueJobs.configure do |config|
       config.redis_test_mode = :mock
     end
@@ -36,7 +35,6 @@ RSpec.describe SidekiqUniqueJobs::ScriptMock, ruby_ver: '>= 2.4.1' do
     SidekiqUniqueJobs.configure do |config|
       config.redis_test_mode = :redis
     end
-    Sidekiq.redis(&:flushdb)
   end
 
   subject { SidekiqUniqueJobs::Scripts }
@@ -54,7 +52,7 @@ RSpec.describe SidekiqUniqueJobs::ScriptMock, ruby_ver: '>= 2.4.1' do
       specify { expect(lock_for).to eq(1) }
       specify do
         expect(lock_for(1)).to eq(1)
-        expect(Redis)
+        expect(SidekiqUniqueJobs)
           .to have_key(UNIQUE_KEY)
           .for_seconds(1)
           .with_value('fuckit')

data/spec/lib/sidekiq_unique_jobs/scripts/acquire_lock_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe SidekiqUniqueJobs::Scripts::AcquireLock do
+  let(:redis_pool) { nil }
+  let(:jid) { 'abcdefab' }
+  let(:unique_key) { 'uniquejobs:123asdasd2134' }
+  let(:max_lock_time) { 1 }
+
+  describe '.execute' do
+    subject { instance_double(described_class) }
+
+    it 'delegates to instance' do
+      expect(described_class).to receive(:new)
+        .with(redis_pool, unique_key, jid, max_lock_time)
+        .and_return(subject)
+      expect(subject).to receive(:execute).and_return(true)
+
+      described_class.execute(redis_pool, unique_key, jid, max_lock_time)
+    end
+  end
+
+  describe '#execute' do
+    context 'when job is unique' do
+      def execute(myjid = jid, key = unique_key, max_lock = max_lock_time)
+        described_class.execute(
+          redis_pool,
+          key,
+          myjid,
+          max_lock
+        )
+      end
+
+      specify { expect(execute(jid, unique_key, max_lock_time)).to eq(true) }
+      specify do
+        expect(execute(jid, unique_key, max_lock_time)).to eq(true)
+        expect(SidekiqUniqueJobs)
+          .to have_key(unique_key)
+          .for_seconds(max_lock_time)
+          .with_value('abcdefab')
+        sleep 0.5
+        expect(execute).to eq(true)
+      end
+
+      context 'when a unique_key exists for another jid' do
+        before  { expect(execute(jid, unique_key, 10)).to eq(true) }
+        specify { expect(execute('anotherjid', unique_key, 5)).to eq(false) }
+      end
+    end
+  end
+end

data/spec/lib/sidekiq_unique_jobs/scripts/release_lock_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+RSpec.describe SidekiqUniqueJobs::Scripts::ReleaseLock do
+  let(:redis_pool) { nil }
+  let(:jid) { 'abcdefab' }
+  let(:unique_key) { 'uniquejobs:123asdasd2134' }
+  let(:max_lock_time) { 1 }
+
+  describe '.execute' do
+    subject { instance_double(described_class) }
+
+    it 'delegates to instance' do
+      expect(described_class).to receive(:new)
+        .with(redis_pool, unique_key, jid)
+        .and_return(subject)
+      expect(subject).to receive(:execute).and_return(true)
+
+      described_class.execute(redis_pool, unique_key, jid)
+    end
+  end
+
+  describe '#execute' do
+    context 'when exists' do
+      subject { described_class.execute(redis_pool, unique_key, jid) }
+
+      before do
+        SidekiqUniqueJobs::Scripts::AcquireLock.execute(redis_pool, unique_key, jid, max_lock_time)
+      end
+
+      specify do
+        expect(SidekiqUniqueJobs)
+          .to have_key(unique_key)
+          .for_seconds(max_lock_time)
+          .with_value(jid)
+
+        expect(subject).to eq(true)
+        expect(SidekiqUniqueJobs).not_to have_key(unique_key)
+      end
+    end
+  end
+end