Prepare for sidekiq 6

.travis.yml

@@ -38,6 +38,10 @@ matrix:
     - rvm: 2.5.3
       gemfile: gemfiles/sidekiq_develop.gemfile
       env: COV=true
+    - rvm: 2.6.0
+      gemfile: gemfiles/sidekiq_6.0.gemfile
+    - rvm: 2.5.3
+      gemfile: gemfiles/sidekiq_6.0.gemfile
 
 gemfile:
   - gemfiles/sidekiq_develop.gemfile

Appraisals

@@ -27,3 +27,7 @@ end
 appraise 'sidekiq-5.2' do
   gem 'sidekiq', '~> 5.2.0'
 end
+
+appraise 'sidekiq-6.0' do
+  gem 'sidekiq', git: 'https://github.com/mperham/sidekiq.git', branch: '6-0'
+end

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## [v6.0.10](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.10) (2019-02-23)
+[Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.9...v6.0.10)
+
+**Closed issues:**
+
+- Unsure of sane defaults [\#372](https://github.com/mhenrixon/sidekiq-unique-jobs/issues/372)
+
+**Merged pull requests:**
+
+- Log job silently complete [\#371](https://github.com/mhenrixon/sidekiq-unique-jobs/pull/371) ([tadejm](https://github.com/tadejm))
+
 ## [v6.0.9](https://github.com/mhenrixon/sidekiq-unique-jobs/tree/v6.0.9) (2019-02-11)
 [Full Changelog](https://github.com/mhenrixon/sidekiq-unique-jobs/compare/v6.0.8...v6.0.9)
 

Gemfile

@@ -7,6 +7,7 @@ gem "appraisal", "~> 2.2.0"
 gem "rspec-eventually", require: false
 gem "rspec-its",        require: false
 gem "rspec-retry",      require: false
+gem "sidekiq", git: "https://github.com/mperham/sidekiq.git", branch: "6-0"
 
 platforms :mri_25 do
   gem "benchmark-ips"

README.md

@@ -363,7 +363,7 @@ end
 
 ### Cleanup Dead Locks
 
-For sidekiq versions before 5.1 a `sidekiq_retries_exhausted` block is required per worker class.
+For sidekiq versions before 5.1 a `sidekiq_retries_exhausted` block is required per worker class. This is deprecated in Sidekiq 6.0
 
 ```ruby
 class MyWorker

gemfiles/sidekiq_6.0.gemfile

@@ -0,0 +1,28 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.2.0"
+gem "rspec-eventually", require: false
+gem "rspec-its", require: false
+gem "rspec-retry", require: false
+gem "sidekiq", git: "https://github.com/mperham/sidekiq.git", branch: "6-0"
+
+platforms :mri_25 do
+  gem "benchmark-ips"
+  gem "fasterer"
+  gem "fuubar"
+  gem "guard"
+  gem "guard-reek"
+  gem "guard-rspec"
+  gem "guard-rubocop"
+  gem "memory_profiler"
+  gem "pry"
+  gem "reek", ">= 5.3"
+  gem "rubocop"
+  gem "rubocop-rspec"
+  gem "simplecov-json"
+  gem "travis"
+end
+
+gemspec path: "../"

lib/sidekiq_unique_jobs/client/middleware.rb

@@ -39,7 +39,7 @@ def success?
 
       def locked?
         SidekiqUniqueJobs::Job.add_uniqueness(item)
-        Sidekiq::Logging.with_context(logging_context(self.class, item)) do
+        SidekiqUniqueJobs.with_context(logging_context(self.class, item)) do
           locked = lock.lock
           warn_about_duplicate unless locked
           locked

lib/sidekiq_unique_jobs/logging.rb

@@ -51,8 +51,12 @@ def log_fatal(message_or_exception = nil, &block)
     end
 
     def logging_context(middleware_class, job_hash)
-      digest = job_hash["unique_digest"]
-      "#{middleware_class} #{"DIG-#{digest}" if digest}"
+      if defined?(Sidekiq::Logging)
+        digest = job_hash["unique_digest"]
+        "#{middleware_class} #{"DIG-#{digest}" if digest}"
+      else
+        { middleware: middleware_class, unique_digest: job_hash["unique_digest"] }
+      end
     end
   end
 end

lib/sidekiq_unique_jobs/server/middleware.rb

@@ -23,7 +23,7 @@ def call(worker_class, item, queue)
         return yield if unique_disabled?
 
         SidekiqUniqueJobs::Job.add_uniqueness(item)
-        Sidekiq::Logging.with_context(logging_context(self.class, item)) do
+        SidekiqUniqueJobs.with_context(logging_context(self.class, item)) do
           lock.execute do
             yield
           end

lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb

@@ -33,6 +33,14 @@ def logger
     config.logger
   end
 
+  def with_context(context, &block)
+    if logger.respond_to?(:with_context)
+      logger.with_context(context, &block)
+    elsif defined?(Sidekiq::Logging)
+      Sidekiq::Logging.with_context(context, &block)
+    end
+  end
+
   # Set a new logger
   # @param [Logger] other a new logger
   def logger=(other)

lib/sidekiq_unique_jobs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqUniqueJobs
-  VERSION = "6.0.10"
+  VERSION = "6.0.11"
 end

rails_example/app/workers/simple_worker.rb

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

rails_example/app/workers/slow_until_executing_worker.rb

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

rails_example/app/workers/spawn_simple_worker.rb

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

rails_example/app/workers/while_executing_with_timeout_worker.rb

@@ -6,7 +6,7 @@ class WhileExecutingWithTimeoutWorker
   sidekiq_options unique: :while_executing, lock_timeout: 5, unique_args: ->(args) { args.second }
 
   def perform(one, two)
-    Sidekiq::Logging.with_context(self.class.name) do
+    SidekiqUniqueJobs.with_context(self.class.name) do
       logger.info { "#{__method__}(#{one}, #{two})" }
     end
     sleep 10

rails_example/app/workers/without_argument_worker.rb

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

rails_example/config/environments/test.rb

@@ -37,7 +37,6 @@
   config.action_mailer.delivery_method = :test
 
   config.log_level = :debug
-  Sidekiq.logger = Logger.new(STDOUT)
 
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr

sidekiq-unique-jobs.gemspec

@@ -42,7 +42,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
   spec.add_dependency "concurrent-ruby", "~> 1.0", ">= 1.0.5"
-  spec.add_dependency "sidekiq", ">= 4.0", "< 6.0"
+  spec.add_dependency "sidekiq", ">= 4.0", "< 7.0"
   spec.add_dependency "thor", "~> 0"
 
   spec.add_development_dependency "bundler", ">= 2.0"

spec/integration/sidekiq_unique_jobs/locksmith_spec.rb

@@ -6,9 +6,9 @@
   let(:locksmith_two)   { described_class.new(item_two) }
 
   let(:jid_one)         { "maaaahjid" }
-  let(:jid_two)           { "jidmayhem" }
-  let(:lock_expiration)   { nil }
-  let(:unique_digest)     { "uniquejobs:randomvalue" }
+  let(:jid_two)         { "jidmayhem" }
+  let(:lock_expiration) { nil }
+  let(:unique_digest)   { "uniquejobs:randomvalue" }
   let(:item_one) do
     {
       "jid" => jid_one,

spec/spec_helper.rb

@@ -22,7 +22,7 @@
 require "timecop"
 require "sidekiq_unique_jobs/testing"
 
-Sidekiq.logger = Logger.new("/dev/null")
+Sidekiq.log_format = :json if Sidekiq.respond_to?(:log_format)
 SidekiqUniqueJobs.logger.level = Object.const_get("Logger::#{ENV.fetch('LOGLEVEL') { 'error' }.upcase}")
 
 require "sidekiq/redis_connection"