logcraft-sidekiq 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2322ef0bc6be2a50e4b4dcf0a66876b53d116a5f14de3dcdf550bbb7bd4da4ad
-  data.tar.gz: b4369d176d52c6b1fda974f5c2251d8d96facb458a1407c3153b2e0f78b89409
+  metadata.gz: 28452045ea7393df36c7954b72551cce39009acd50519f57e8a2987f6f492d8e
+  data.tar.gz: 5a9a2e6fd7f3b260bfa2407a546ae10d6bb37924982b7631da5e66be0faea7a7
 SHA512:
-  metadata.gz: 9e5c2dd739aab79f00820fb51cc734b358c1308bf4cb8b67716d8d13a1ef1770fb1c44a55afff8de64ed278245fd2c016327927aa3f31a8985bb979c6d399e22
-  data.tar.gz: 920ba562c1de6d51258e0cf9345da786eaa9cbe77dd5fb7ef431d4242371da897f5f6c6fa14d4dbdc2cfce6812149e4a5d0306c1c121944c5bfe4e8a77f7807a
+  metadata.gz: f1c1352ba7f9e634c440cfa31b5950da0842d2b3cf3f5e0e2a906fca85ffb5c92c280bbdfc70d9e59b6aa28fe337c2bbace7e30a5a37e34e1ffeea3a443a3046
+  data.tar.gz: 072b697fa207b85bb91e0c2af585a4e6a1f85310147e314842143ef225688f665d16d60f115b22d3fcaddcb86c17e52323ccac6d39d629cc584abca3a40056bd

data/CHANGELOG.md

@@ -4,6 +4,12 @@ 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.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.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/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,18 @@ module Logcraft
     class JobLogger
       include Logcraft::LogContextHelper
 
+      def initialize(logger = ::Sidekiq.logger)
+        @logger = logger
+      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 +36,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.1.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logcraft-sidekiq
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Zoltan Ormandi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2023-08-19 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
@@ -97,6 +103,8 @@ files:
 - gemfiles/sidekiq_6.0.gemfile
 - gemfiles/sidekiq_6.4.gemfile
 - gemfiles/sidekiq_6.5.gemfile
+- gemfiles/sidekiq_7.0.gemfile
+- gemfiles/sidekiq_7.latest.gemfile
 - lib/logcraft/sidekiq.rb
 - lib/logcraft/sidekiq/death_logger.rb
 - lib/logcraft/sidekiq/error_logger.rb
@@ -104,7 +112,6 @@ files:
 - lib/logcraft/sidekiq/job_logger.rb
 - lib/logcraft/sidekiq/railtie.rb
 - lib/logcraft/sidekiq/version.rb
-- logcraft-sidekiq.gemspec
 - sig/logcraft/sidekiq.rbs
 homepage: https://github.com/zormandi/logcraft-sidekiq
 licenses:
@@ -128,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A structured logging solution for Sidekiq, using Logcraft.

data/logcraft-sidekiq.gemspec

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/logcraft/sidekiq/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "logcraft-sidekiq"
-  spec.version = Logcraft::Sidekiq::VERSION
-  spec.authors = ["Zoltan Ormandi"]
-  spec.email = ["zoltan.ormandi@gmail.com"]
-
-  spec.summary = "A structured logging solution for Sidekiq, using Logcraft."
-  spec.homepage = "https://github.com/zormandi/logcraft-sidekiq"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/zormandi/logcraft-sidekiq"
-  spec.metadata["changelog_uri"] = "https://github.com/zormandi/logcraft-sidekiq/blob/main/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor|Rakefile)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "logcraft"
-  spec.add_dependency "sidekiq", "~> 6.0"
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", ">= 12.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end