logcraft-sidekiq 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2322ef0bc6be2a50e4b4dcf0a66876b53d116a5f14de3dcdf550bbb7bd4da4ad
-  data.tar.gz: b4369d176d52c6b1fda974f5c2251d8d96facb458a1407c3153b2e0f78b89409
+  metadata.gz: 0e418eca7f621e2b923267d18660dd53d1bd66a744789e52c42be26b08ef88a0
+  data.tar.gz: 7e4bcf27f2f0b329e1540294ac6636f229ec676c0167c06d996cf5e4cc356767
 SHA512:
-  metadata.gz: 9e5c2dd739aab79f00820fb51cc734b358c1308bf4cb8b67716d8d13a1ef1770fb1c44a55afff8de64ed278245fd2c016327927aa3f31a8985bb979c6d399e22
-  data.tar.gz: 920ba562c1de6d51258e0cf9345da786eaa9cbe77dd5fb7ef431d4242371da897f5f6c6fa14d4dbdc2cfce6812149e4a5d0306c1c121944c5bfe4e8a77f7807a
+  metadata.gz: ec5a733a392e86a7c7a903e7a1fb2ada15db050dccc1e78a8d21d46af3fc8095eae2360108444db87f4908bfd1d11c019832d3cf1876eadc61113e3856bf9921
+  data.tar.gz: 6acb7edb71a36a93d6d5fcd6fae09b560715839d096080f989d220af0ac6bc2ee70ef5e54bfd4e93e9aa380bbe2fedb6cb66d5074955470c0c769cf99bcfaf3c

data/CHANGELOG.md

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.0] - 2024-07-24
+### Added
+- Added support for Sidekiq 7. Thanks to [@wfarr](https://github.com/wfarr) for contributing! ([#4](https://github.com/zormandi/logcraft-sidekiq/pull/4))
+
+### Fixed
+- Eliminated deprecation warning in preparation for Sidekiq 8. Thanks to [@wfarr](https://github.com/wfarr) for contributing! ([#3](https://github.com/zormandi/logcraft-sidekiq/pull/3))
+
+## [1.1.0] - 2023-08-19
+### Added
+- Added support for Sidekiq 7.
+- Added support for request-specific context (`CurrentAttributes`). 
+  See this [blog post](https://www.mikeperham.com/2022/07/29/sidekiq-and-request-specific-context/) for details.
+
 ## [1.0.0] - 2022-08-01
 
 No changes, just publishing the release candidate as a final release.

data/Gemfile

@@ -6,5 +6,5 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem 'sidekiq', '~> 6.0'
+  gem 'sidekiq', '~> 7.0'
 end

data/README.md

@@ -4,7 +4,7 @@
 [![Gem Version](https://badge.fury.io/rb/logcraft-sidekiq.svg)](https://badge.fury.io/rb/logcraft-sidekiq)
 
 Logcraft::Sidekiq is a structured logging solution for [Sidekiq](https://github.com/mperham/sidekiq), using
-the [Logcraft](https://github.com/zormandi/logcraft) gem.
+the [Logcraft](https://github.com/zormandi/logcraft) gem. It supports (and is tested with) Sidekiq 6 and 7.
 
 ## Installation
 

data/gemfiles/sidekiq_6.0.gemfile

@@ -7,4 +7,5 @@ gemspec path: '..'
 
 group :test do
   gem 'sidekiq', '~> 6.0.0'
+  gem 'redis', '~> 4.5.0'
 end

data/gemfiles/sidekiq_6.4.gemfile

@@ -7,4 +7,5 @@ gemspec path: '..'
 
 group :test do
   gem 'sidekiq', '~> 6.4.0'
+  gem 'redis', '~> 4.5.0'
 end

data/gemfiles/sidekiq_7.0.gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in logcraft-sidekiq.gemspec
+gemspec path: '..'
+
+group :test do
+  gem 'sidekiq', '~> 7.0.0'
+end

data/gemfiles/sidekiq_7.3.gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in logcraft-sidekiq.gemspec
+gemspec path: '..'
+
+group :test do
+  gem 'sidekiq', '~> 7.3.0'
+end

data/gemfiles/sidekiq_7.latest.gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in logcraft-sidekiq.gemspec
+gemspec path: '..'
+
+group :test do
+  gem 'sidekiq', '~> 7.0'
+end

data/lib/logcraft/sidekiq/error_logger.rb

@@ -5,7 +5,7 @@ module Logcraft
     class ErrorLogger
       include Logcraft::LogContextHelper
 
-      def call(error, context)
+      def call(error, context, _config = nil)
         within_log_context(JobContext.from_job_hash(context[:job])) do
           ::Sidekiq.logger.warn error
         end

data/lib/logcraft/sidekiq/job_context.rb

@@ -23,6 +23,7 @@ module Logcraft
           }
           info_hash[:bid] = job['bid'] if job['bid']
           info_hash[:tags] = job['tags'] if job['tags']
+          info_hash[:cattr] = job['cattr'] if job['cattr']
           info_hash
         end
 

data/lib/logcraft/sidekiq/job_logger.rb

@@ -5,14 +5,22 @@ module Logcraft
     class JobLogger
       include Logcraft::LogContextHelper
 
+      def initialize(config_or_logger = ::Sidekiq.logger)
+        @logger = if config_or_logger.respond_to? :logger
+                    config_or_logger.logger
+                  else
+                    config_or_logger
+                  end
+      end
+
       def call(job_hash, _queue)
         within_log_context(JobContext.from_job_hash(job_hash)) do
           begin
-            logger.info "#{job_hash['class']} started"
+            @logger.info "#{job_hash['class']} started"
             benchmark { yield }
-            logger.info message: "#{job_hash['class']} finished"
+            @logger.info message: "#{job_hash['class']} finished"
           rescue Exception
-            logger.info message: "#{job_hash['class']} failed"
+            @logger.info message: "#{job_hash['class']} failed"
             raise
           end
         end
@@ -32,10 +40,6 @@ module Logcraft
         add_to_log_context duration: end_time - start_time,
                            duration_sec: (end_time - start_time) / 1000.0
       end
-
-      def logger
-        ::Sidekiq.logger
-      end
     end
   end
 end

data/lib/logcraft/sidekiq/version.rb

@@ -2,6 +2,6 @@
 
 module Logcraft
   module Sidekiq
-    VERSION = '1.0.0'
+    VERSION = '1.2.0'
   end
 end

data/lib/logcraft/sidekiq.rb

@@ -14,7 +14,7 @@ module Logcraft
     autoload :JobLogger, 'logcraft/sidekiq/job_logger'
 
     def self.initialize
-      ::Sidekiq.logger = Logcraft.logger 'Sidekiq'
+      initialize_logger
       ::Sidekiq.configure_server do |config|
         if config.respond_to? :[]=
           config[:job_logger] = JobLogger
@@ -23,11 +23,22 @@ module Logcraft
         end
         config.error_handlers.delete_if do |handler|
           (defined?(::Sidekiq::ExceptionHandler) && defined?(::Sidekiq::ExceptionHandler::Logger) && handler.is_a?(::Sidekiq::ExceptionHandler::Logger)) ||
-            (handler.is_a?(Method) && handler.receiver.name == 'Sidekiq' && handler.name == :default_error_handler)
+            (handler.is_a?(Method) && handler.receiver.name == 'Sidekiq' && handler.name == :default_error_handler) ||
+            (defined?(::Sidekiq::Config) && defined?(::Sidekiq::Config::ERROR_HANDLER) && (handler == ::Sidekiq::Config::ERROR_HANDLER))
         end
         config.error_handlers << ErrorLogger.new
         config.death_handlers << DeathLogger.new
       end
     end
+
+    def self.initialize_logger
+      case ::Sidekiq::VERSION.chr
+      when '7'
+        ::Sidekiq.configure_client { |config| config.logger = Logcraft.logger 'Sidekiq' }
+        ::Sidekiq.configure_server { |config| config.logger = Logcraft.logger 'Sidekiq' }
+      when '6'
+        ::Sidekiq.logger = Logcraft.logger 'Sidekiq'
+      end
+    end
   end
 end

data/logcraft-sidekiq.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "logcraft"
-  spec.add_dependency "sidekiq", "~> 6.0"
+  spec.add_dependency "sidekiq", ">= 6.0", "< 8.0"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", ">= 12.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logcraft-sidekiq
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Zoltan Ormandi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2024-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logcraft
@@ -28,16 +28,22 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +86,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - zoltan.ormandi@gmail.com
 executables: []
@@ -97,6 +103,9 @@ files:
 - gemfiles/sidekiq_6.0.gemfile
 - gemfiles/sidekiq_6.4.gemfile
 - gemfiles/sidekiq_6.5.gemfile
+- gemfiles/sidekiq_7.0.gemfile
+- gemfiles/sidekiq_7.3.gemfile
+- gemfiles/sidekiq_7.latest.gemfile
 - lib/logcraft/sidekiq.rb
 - lib/logcraft/sidekiq/death_logger.rb
 - lib/logcraft/sidekiq/error_logger.rb
@@ -113,7 +122,7 @@ metadata:
   homepage_uri: https://github.com/zormandi/logcraft-sidekiq
   source_code_uri: https://github.com/zormandi/logcraft-sidekiq
   changelog_uri: https://github.com/zormandi/logcraft-sidekiq/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,8 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A structured logging solution for Sidekiq, using Logcraft.
 test_files: []