loga 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c431f4c2be4360f29975cc8434c86647c77cf8a375bcd8fa6e6a0b47bb8a2e8
-  data.tar.gz: 2ec1e76ed48281e99acca8bdc3dd55b3fb6068dee599dd5c4bf92008e1af6eb0
+  metadata.gz: 8a97eae050b9e31ef0ddb1e6f327563c4e0f54eb1a42ea7bb53b03e22c8fb9c9
+  data.tar.gz: 771373253651884fead19e93038d5c7e31827d3c562d2cd748e0acd66f31124e
 SHA512:
-  metadata.gz: 5c09402cb2b8f7e90bb53ccba07df43c759a9d4cea9cd5a19f8fbfcf332b0ce7914dca1d3c085cd43d9d081e40cc2c4d18452bd5c6b44d10e1df2771c7a88146
-  data.tar.gz: f9f937d8e0a600c05ca50e60c05b084d6756b76158f2b4dcfc7a070ee30ad535ef2df6f0c10d6f61a99152ec2fa2cdb1815b450ce600e4be72e51e797d1165b6
+  metadata.gz: 28d17a44bf2c8c0a919916438c8935a4033e14176185ca87ff69987ee03507dee5ae854c2887ff89d174c78fd0fa846b8d8237392b6705eb552365202f2f7680
+  data.tar.gz: 45bf838fa85c9a3a01ba1134034b2ab2e577cd9f9c28ecceaf175935ff69627f156856dc8e383b5212829636934657ee4fb0c40f5e5e992a54eb1027ee47d74f

data/.circleci/config.yml

@@ -30,10 +30,6 @@ test_build: &test_build
 
 version: 2
 jobs:
-  ruby-2.4:
-    docker:
-      - image: circleci/ruby:2.4
-    <<: *test_build
   ruby-2.5:
     docker:
       - image: circleci/ruby:2.5
@@ -45,10 +41,12 @@ jobs:
   ruby-2.7:
     docker:
       - image: cimg/ruby:2.7
+      - image: redis:7
     <<: *test_build
   ruby-3.0:
     docker:
       - image: cimg/ruby:3.0
+      - image: redis:7
     <<: *test_build
   rubocop:
     <<: *basic_build
@@ -83,10 +81,6 @@ workflows:
           filters:
             tags:
               only: /.*/
-      - ruby-2.4:
-          filters:
-            tags:
-              only: /.*/
       - ruby-2.5:
           filters:
             tags:
@@ -112,7 +106,6 @@ workflows:
               ignore: /.*/
           requires:
             - rubocop
-            - ruby-2.4
             - ruby-2.5
             - ruby-2.6
             - ruby-2.7

data/Appraisals

@@ -1,13 +1,3 @@
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.4.0')
-  appraise 'rails32' do
-    gem 'rails', '~> 3.2.0'
-  end
-
-  appraise 'rails40' do
-    gem 'rails', '~> 4.0.0'
-  end
-end
-
 if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7.0')
   appraise 'rails42' do
     gem 'rails', '~> 4.2.0'
@@ -31,13 +21,29 @@ if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.5.0')
     gem 'rails', '~> 6.0.0'
   end
 
-  appraise 'sidekiq6' do
-    gem 'sidekiq', '~> 6.0'
+  appraise 'sidekiq60' do
+    gem 'sidekiq', '~> 6.0.0'
   end
 
   appraise 'sidekiq61' do
     gem 'sidekiq', '~> 6.1.0'
   end
+
+  appraise 'sidekiq62' do
+    gem 'sidekiq', '~> 6.2.0'
+  end
+
+  appraise 'sidekiq63' do
+    gem 'sidekiq', '~> 6.3.0'
+  end
+
+  appraise 'sidekiq64' do
+    gem 'sidekiq', '~> 6.4.0'
+  end
+
+  appraise 'sidekiq65' do
+    gem 'sidekiq', '~> 6.5.0'
+  end
 end
 
 if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.7.0')
@@ -48,6 +54,18 @@ if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.7.0')
   appraise 'rails70' do
     gem 'rails', '~> 7.0.0'
   end
+
+  appraise 'sidekiq7' do
+    gem 'sidekiq', '~> 7.0'
+  end
+
+  appraise 'sidekiq70' do
+    gem 'sidekiq', '~> 7.0.0'
+  end
+
+  appraise 'sidekiq71' do
+    gem 'sidekiq', '~> 7.1.0'
+  end
 end
 
 appraise 'sidekiq51' do

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.7.0] - 2023-03-28
+### Added
+- Support for sidekiq 7
+
 ## [2.6.1] - 2022-02-22
 ### Fixed
 - Fix compatibility with sidekiq 6.4.1

data/README.md

@@ -150,7 +150,7 @@ LOGA_FORMAT=simple rackup
 
 ### Sidekiq
 
-Loga `2.3` provides an out-of-the-box support for `Sidekiq ~> 5.0`.
+Loga `2.7` provides an out-of-the-box support for `Sidekiq ~> 7.0`.
 
 ## Output Example
 

data/gemfiles/{rails32.gemfile → sidekiq60.gemfile}

@@ -2,10 +2,10 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 3.2.0"
+gem "sidekiq", "~> 6.0.0"
 
 group :test do
-  gem "simplecov"
+  gem "simplecov", "~> 0.17.0"
 end
 
 gemspec path: "../"

data/gemfiles/{rails40.gemfile → sidekiq62.gemfile}

@@ -2,10 +2,10 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.0.0"
+gem "sidekiq", "~> 6.2.0"
 
 group :test do
-  gem "simplecov"
+  gem "simplecov", "~> 0.17.0"
 end
 
 gemspec path: "../"

data/gemfiles/sidekiq63.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 6.3.0"
+
+group :test do
+  gem "simplecov", "~> 0.17.0"
+end
+
+gemspec path: "../"

data/gemfiles/sidekiq64.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 6.4.0"
+
+group :test do
+  gem "simplecov", "~> 0.17.0"
+end
+
+gemspec path: "../"

data/gemfiles/sidekiq65.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 6.5.0"
+
+group :test do
+  gem "simplecov", "~> 0.17.0"
+end
+
+gemspec path: "../"

data/gemfiles/{sidekiq6.gemfile → sidekiq7.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "sidekiq", "~> 6.0"
+gem "sidekiq", "~> 7.0"
 
 group :test do
   gem "simplecov", "~> 0.17.0"

data/gemfiles/sidekiq70.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 7.0.0"
+
+group :test do
+  gem "simplecov", "~> 0.17.0"
+end
+
+gemspec path: "../"

data/gemfiles/sidekiq71.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 7.1.0"
+
+group :test do
+  gem "simplecov", "~> 0.17.0"
+end
+
+gemspec path: "../"

data/lib/loga/sidekiq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Loga
   module Sidekiq
     def self.configure_logging
@@ -5,20 +7,41 @@ module Loga
       return if Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('5.0')
 
       if Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('6.0')
-        require 'loga/sidekiq5/job_logger'
-
-        ::Sidekiq.configure_server do |config|
-          config.options[:job_logger] = Loga::Sidekiq5::JobLogger
-        end
+        configure_for_sidekiq5
       elsif Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('7.0')
-        require 'loga/sidekiq6/job_logger'
+        configure_for_sidekiq6
+      elsif Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('8.0')
+        configure_for_sidekiq7
+      end
+    end
 
-        ::Sidekiq.configure_server do |config|
-          config.options[:job_logger] = Loga::Sidekiq6::JobLogger
-        end
+    def self.configure_for_sidekiq5
+      require 'loga/sidekiq5/job_logger'
+
+      ::Sidekiq.configure_server do |config|
+        config.options[:job_logger] = Loga::Sidekiq5::JobLogger
       end
 
       ::Sidekiq.logger = Loga.configuration.logger
     end
+
+    def self.configure_for_sidekiq6
+      require 'loga/sidekiq6/job_logger'
+
+      ::Sidekiq.configure_server do |config|
+        config.options[:job_logger] = Loga::Sidekiq6::JobLogger
+      end
+
+      ::Sidekiq.logger = Loga.configuration.logger
+    end
+
+    def self.configure_for_sidekiq7
+      require 'loga/sidekiq7/job_logger'
+
+      ::Sidekiq.configure_server do |config|
+        config[:job_logger] = Loga::Sidekiq7::JobLogger
+        config.logger = Loga.configuration.logger
+      end
+    end
   end
 end

data/lib/loga/sidekiq7/job_logger.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'sidekiq/job_logger'
+
+module Loga
+  module Sidekiq7
+    class JobLogger < ::Sidekiq::JobLogger
+      EVENT_TYPE = 'sidekiq'.freeze
+
+      def call(item, _queue)
+        start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+
+        yield
+
+        ::Sidekiq::Context.add(:elapsed, elapsed(start))
+
+        loga_log(message: "#{item['class']} with jid: '#{item['jid']}' done", item: item)
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        ::Sidekiq::Context.add(:elapsed, elapsed(start))
+
+        loga_log(
+          message: "#{item['class']} with jid: '#{item['jid']}' fail", item: item,
+          exception: e
+        )
+
+        raise
+      end
+
+      private
+
+      def loga_log(message:, item:, exception: nil)
+        data = item.select do |k, _v|
+          %w[created_at enqueued_at jid queue retry
+             class].include? k
+        end
+
+        data['params'] = item['args']
+
+        data['exception'] = exception if exception
+
+        event = Event.new(type: EVENT_TYPE, message: message, data: data)
+
+        if exception
+          @logger.warn(event)
+        else
+          @logger.info(event)
+        end
+      end
+    end
+  end
+end

data/lib/loga/version.rb

@@ -1,3 +1,3 @@
 module Loga
-  VERSION = '2.6.1'.freeze
+  VERSION = '2.7.0'.freeze
 end

data/spec/integration/sidekiq60_spec.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'timecop'
+require 'fakeredis'
+
+dummy_redis_config = ConnectionPool.new(size: 5) { Redis.new }
+
+Sidekiq.configure_client do |config|
+  config.redis = dummy_redis_config
+end
+
+Sidekiq.configure_server do |config|
+  config.redis = dummy_redis_config
+end
+
+class MySidekiqWorker
+  include Sidekiq::Worker
+
+  def perform(_name)
+    logger.info('Hello from MySidekiqWorker')
+  end
+end
+
+describe 'Sidekiq client logger' do
+  let(:mgr) do
+    # https://github.com/mperham/sidekiq/blob/v6.0.0/test/test_actors.rb#L57:79
+    Class.new do
+      attr_reader :latest_error
+      attr_reader :mutex
+      attr_reader :cond
+
+      def initialize
+        @mutex = ::Mutex.new
+        @cond = ::ConditionVariable.new
+      end
+
+      def processor_died(_inst, err)
+        @latest_error = err
+        @mutex.synchronize do
+          @cond.signal
+        end
+      end
+
+      def processor_stopped(_inst)
+        @mutex.synchronize do
+          @cond.signal
+        end
+      end
+
+      def options
+        {
+          concurrency: 3,
+          job_logger: Loga::Sidekiq6::JobLogger,
+          queues: ['default'],
+        }
+      end
+    end
+  end
+
+  let(:target) { StringIO.new }
+
+  def read_json_log(line:)
+    target.rewind
+    JSON.parse(target.each_line.drop(line - 1).first)
+  end
+
+  def dump_log
+    offset = target.pos
+
+    target.rewind
+    target.each_line { puts _1 }
+
+    target.pos = offset
+  end
+
+  before do
+    Redis.current.flushall
+
+    Loga.reset
+
+    Loga.configure(
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+      device: target,
+      format: :gelf,
+    )
+  end
+
+  it 'has the proper job logger' do
+    expect(Sidekiq.options[:job_logger]).to eq Loga::Sidekiq6::JobLogger
+  end
+
+  it 'has the proper logger for Sidekiq.logger' do
+    expect(Sidekiq.logger).to eq Loga.logger
+  end
+
+  it 'pushes a new element in the default queue' do
+    MySidekiqWorker.perform_async('Bob')
+
+    last_element = JSON.parse(Redis.current.lpop('queue:default'))
+
+    aggregate_failures do
+      expect(last_element['class']).to eq 'MySidekiqWorker'
+      expect(last_element['args']).to eq ['Bob']
+      expect(last_element['retry']).to eq true
+      expect(last_element['queue']).to eq 'default'
+    end
+  end
+
+  def test_log_from_worker(json_line)
+    aggregate_failures do
+      expect(json_line).to include(
+        '_class' => 'MySidekiqWorker',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_tags' => '',
+        'level' => 6,
+        'version' => '1.1',
+        'short_message' => 'Hello from MySidekiqWorker',
+      )
+
+      %w[_jid timestamp host].each do |key|
+        expect(json_line).to have_key(key)
+      end
+
+      expect(json_line).not_to include('_duration')
+    end
+  end
+
+  def test_job_end_log(json_line) # rubocop:disable Metrics/MethodLength
+    aggregate_failures do
+      expect(json_line).to include(
+        '_queue' => 'default',
+        '_retry' => true,
+        '_params' => ['Bob'],
+        '_class' => 'MySidekiqWorker',
+        '_type' => 'sidekiq',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_tags' => '',
+        'level' => 6,
+        'version' => '1.1',
+      )
+
+      %w[_created_at _enqueued_at _jid _duration timestamp host].each do |key|
+        expect(json_line).to have_key(key)
+      end
+
+      expect(json_line['_duration']).to be < 500
+      expect(json_line['short_message']).to match(/MySidekiqWorker with jid:*/)
+    end
+  end
+
+  it 'logs the job processing event' do
+    MySidekiqWorker.perform_async('Bob')
+
+    require 'sidekiq/processor'
+
+    Sidekiq::Processor.new(mgr.new).start
+
+    sleep 0.5
+
+    test_log_from_worker(read_json_log(line: 1))
+    test_job_end_log(read_json_log(line: 2))
+
+    # This was a bug - the duration was constantly incresing based on when
+    # the logger was created. https://github.com/FundingCircle/loga/pull/117
+    #
+    # Test that after sleeping for few seconds the duration is still under 500ms
+    sleep 1
+
+    MySidekiqWorker.perform_async('Bob')
+
+    sleep 1
+
+    test_log_from_worker(read_json_log(line: 3))
+    test_job_end_log(read_json_log(line: 4))
+  end
+end

data/spec/integration/sidekiq65_spec.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'timecop'
+require 'fakeredis'
+
+dummy_redis_config = ConnectionPool.new(size: 5) { Redis.new }
+
+Sidekiq.configure_client do |config|
+  config.redis = dummy_redis_config
+end
+
+Sidekiq.configure_server do |config|
+  config.redis = dummy_redis_config
+end
+
+class MySidekiqWorker
+  include Sidekiq::Job
+
+  def perform(_name)
+    logger.info('Hello from MySidekiqWorker')
+  end
+end
+
+module Sidekiq
+  def self.reset!
+    @config = DEFAULTS.dup
+  end
+end
+
+describe 'Sidekiq client logger' do
+  let(:target) { StringIO.new }
+  let(:config) do
+    c = Sidekiq
+
+    c[:queues] = %w[default]
+    c[:fetch] = Sidekiq::BasicFetch.new(c)
+    c[:error_handlers] << Sidekiq.method(:default_error_handler)
+
+    c
+  end
+
+  def read_json_log(line:)
+    target.rewind
+    JSON.parse(target.each_line.drop(line - 1).first)
+  end
+
+  before do
+    Sidekiq.reset!
+    Sidekiq.redis(&:flushdb)
+
+    Loga.reset
+
+    Loga.configure(
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+      device: target,
+      format: :gelf,
+    )
+  end
+
+  it 'has the proper job logger' do
+    expect(Sidekiq.options[:job_logger]).to eq Loga::Sidekiq6::JobLogger
+  end
+
+  it 'has the proper logger for Sidekiq.logger' do
+    expect(Sidekiq.logger).to eq Loga.logger
+  end
+
+  it 'pushes a new element in the default queue' do
+    MySidekiqWorker.perform_async('Bob')
+
+    last_element = JSON.parse(Redis.current.lpop('queue:default'))
+
+    aggregate_failures do
+      expect(last_element['class']).to eq 'MySidekiqWorker'
+      expect(last_element['args']).to eq ['Bob']
+      expect(last_element['retry']).to eq true
+      expect(last_element['queue']).to eq 'default'
+    end
+  end
+
+  def test_log_from_worker(json_line)
+    aggregate_failures do
+      expect(json_line).to include(
+        '_class' => 'MySidekiqWorker',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_tags' => '',
+        'level' => 6,
+        'version' => '1.1',
+        'short_message' => 'Hello from MySidekiqWorker',
+      )
+
+      %w[_jid timestamp host].each do |key|
+        expect(json_line).to have_key(key)
+      end
+
+      expect(json_line).not_to include('_duration')
+    end
+  end
+
+  def test_job_end_log(json_line) # rubocop:disable Metrics/MethodLength
+    aggregate_failures do
+      expect(json_line).to include(
+        '_queue' => 'default',
+        '_retry' => true,
+        '_params' => ['Bob'],
+        '_class' => 'MySidekiqWorker',
+        '_type' => 'sidekiq',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_tags' => '',
+        'level' => 6,
+        'version' => '1.1',
+      )
+
+      %w[_created_at _enqueued_at _jid _duration timestamp host].each do |key|
+        expect(json_line).to have_key(key)
+      end
+
+      expect(json_line['_duration']).to be < 500
+      expect(json_line['short_message']).to match(/MySidekiqWorker with jid:*/)
+    end
+  end
+
+  context 'with processor' do
+    let(:mutex) { Mutex.new }
+    let(:cond) { ConditionVariable.new }
+
+    def result(_processor, _exception)
+      mutex.synchronize { cond.signal }
+    end
+
+    def await(timeout: 0.5)
+      mutex.synchronize do
+        yield
+        cond.wait(mutex, timeout)
+      end
+    end
+
+    it 'logs the job processing event' do
+      MySidekiqWorker.perform_async('Bob')
+
+      require 'sidekiq/processor'
+
+      p = Sidekiq::Processor.new(config) { |pr, ex| result(pr, ex) }
+
+      await { p.start }
+
+      test_log_from_worker(read_json_log(line: 1))
+      test_job_end_log(read_json_log(line: 2))
+
+      # This was a bug - the duration was constantly incresing based on when
+      # the logger was created. https://github.com/FundingCircle/loga/pull/117
+      #
+      # Test that after sleeping for few seconds the duration is still under 500ms
+      sleep 1
+
+      await { MySidekiqWorker.perform_async('Bob') }
+
+      test_log_from_worker(read_json_log(line: 3))
+      test_job_end_log(read_json_log(line: 4))
+    end
+  end
+end

data/spec/integration/sidekiq7_spec.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Sidekiq client logger' do
+  let(:target) { StringIO.new }
+  let(:config) { Sidekiq.instance_variable_get :@config }
+
+  before do
+    Sidekiq.configure_server do |config|
+      config.redis = { pool_name: :default }
+    end
+
+    Loga.reset
+
+    Loga.configure(
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+      device: target,
+      format: :gelf,
+    )
+  end
+
+  it 'has the proper job logger' do
+    expect(config[:job_logger]).to eq Loga::Sidekiq7::JobLogger
+  end
+
+  it 'has the proper logger for Sidekiq.logger' do
+    expect(Sidekiq.logger).to eq Loga.logger
+  end
+
+  context 'with processor' do
+    require 'sidekiq/processor'
+
+    let(:mutex) { Mutex.new }
+    let(:cond) { ConditionVariable.new }
+    let(:processor) do
+      Sidekiq::Processor.new(config.default_capsule) { |pr, ex| result(pr, ex) }
+    end
+
+    before do
+      @exception = nil
+    end
+
+    context 'with a successful job' do
+      before do
+        MySidekiqWorker.perform_async('Bob')
+
+        await { processor.start }
+
+        processor.terminate(true)
+      end
+
+      it 'logs the job processing event' do
+        test_log_from_worker(read_json_log(line: -2))
+      end
+
+      it 'logs the "done" event' do
+        test_job_end_log(read_json_log(line: -1))
+      end
+    end
+
+    context 'with an error' do
+      before do
+        MySidekiqWorker.perform_async('Boom')
+
+        await { processor.start }
+
+        processor.terminate(true)
+      end
+
+      it 'logs the "error" event' do
+        test_job_fail_log(read_json_log(line: 0))
+      end
+
+      it 're-throws the error' do
+        # rubocop:disable RSpec/InstanceVariable
+        expect(@exception.message).to eq('Boom')
+        # rubocop:enable RSpec/InstanceVariable
+      end
+    end
+
+    def result(_processor, exception)
+      @exception = exception
+      mutex.synchronize { cond.signal }
+    end
+
+    def await(timeout: 0.1)
+      mutex.synchronize do
+        yield
+        cond.wait(mutex, timeout)
+      end
+    end
+
+    def common_log_fields
+      {
+        '_class' => 'MySidekiqWorker',
+        '_service.name' => 'hello_world_app',
+        '_service.version' => '1.0',
+        '_tags' => '',
+        'version' => '1.1',
+      }.freeze
+    end
+
+    def job_logger_common_fields
+      common_log_fields.merge(
+        '_queue' => 'default',
+        '_retry' => true,
+        '_type' => 'sidekiq',
+      )
+    end
+
+    def test_log_from_worker(json_line)
+      aggregate_failures do
+        expect(json_line).to include(
+          common_log_fields.merge(
+            'level' => 6,
+            'short_message' => 'Hello from MySidekiqWorker',
+          ),
+        )
+
+        %w[_jid timestamp host].each do |key|
+          expect(json_line).to have_key(key)
+        end
+
+        expect(json_line).not_to include('_duration')
+      end
+    end
+
+    def test_job_end_log(json_line)
+      aggregate_failures do
+        expect(json_line).to include(
+          job_logger_common_fields.merge(
+            '_params' => ['Bob'],
+            'level' => 6,
+          ),
+        )
+
+        %w[_created_at _enqueued_at _jid _duration timestamp host].each do |key|
+          expect(json_line).to have_key(key)
+        end
+
+        expect(json_line['_duration']).to be < 500
+        expect(json_line['short_message'])
+          .to match(/MySidekiqWorker with jid: '\w+' done/)
+      end
+    end
+
+    def test_job_fail_log(json_line)
+      aggregate_failures do
+        expect(json_line).to include(
+          job_logger_common_fields.merge(
+            '_params' => ['Boom'],
+            'level' => 4,
+          ),
+        )
+
+        %w[_created_at _enqueued_at _jid _duration timestamp host].each do |key|
+          expect(json_line).to have_key(key)
+        end
+
+        expect(json_line['_duration']).to be < 500
+        expect(json_line['short_message'])
+          .to match(/MySidekiqWorker with jid: '\w+' fail/)
+      end
+    end
+  end
+
+  def dump_log
+    offset = target.pos
+
+    target.rewind
+    target.each_line { puts _1 }
+
+    target.pos = offset
+  end
+
+  def read_json_log(line:)
+    target.rewind
+
+    JSON.parse(target.readlines[line])
+  end
+end
+
+class MySidekiqWorker
+  include Sidekiq::Job
+
+  def perform(name)
+    raise name if name == 'Boom'
+
+    logger.info('Hello from MySidekiqWorker')
+  end
+end

data/spec/loga/sidekiq7/job_logger_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+require 'loga/sidekiq7/job_logger'
+
+RSpec.describe Loga::Sidekiq7::JobLogger do
+  subject(:job_logger) { described_class.new(logger) }
+
+  let(:target) { StringIO.new }
+
+  let(:json_line) do
+    target.rewind
+    JSON.parse(target.read.split("\n").last)
+  end
+
+  let(:logger) { Loga.logger }
+
+  before do
+    Loga.reset
+
+    Loga.configure(
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+      device: target,
+      format: :gelf,
+    )
+  end
+
+  # https://github.com/mperham/sidekiq/blob/v6.1.2/lib/sidekiq/job_logger.rb
+  it 'inherits from ::Sidekiq::JobLogger' do
+    expect(subject).to be_a(::Sidekiq::JobLogger)
+  end
+
+  describe '#call' do
+    context 'when the job passess successfully' do
+      let(:item_data) do
+        {
+          'class' => 'HardWorker',
+          'args' => ['asd'],
+          'retry' => true,
+          'queue' => 'default',
+          'jid' => '591f6f66ee0d218fb451dfb6',
+          'created_at' => 1_528_799_582.904939,
+          'enqueued_at' => 1_528_799_582.9049861,
+        }
+      end
+
+      it 'has the the required attributes on call' do
+        job_logger.call(item_data, 'queue') do
+          # something
+        end
+
+        expected_body = {
+          'version' => '1.1',
+          'level' => 6,
+          '_type' => 'sidekiq',
+          '_created_at' => 1_528_799_582.904939,
+          '_enqueued_at' => 1_528_799_582.9049861,
+          '_jid' => '591f6f66ee0d218fb451dfb6',
+          '_retry' => true,
+          '_queue' => 'default',
+          '_service.name' => 'hello_world_app',
+          '_class' => 'HardWorker',
+          '_service.version' => '1.0',
+          '_tags' => '',
+          '_params' => ['asd'],
+        }
+
+        aggregate_failures do
+          expect(json_line).to include(expected_body)
+          expect(json_line['_duration']).to be_a(Float)
+          expect(json_line['timestamp']).to be_a(Float)
+          expect(json_line['host']).to be_a(String)
+          expect(json_line['short_message']).to match(/HardWorker with jid:*/)
+        end
+      end
+    end
+
+    context 'when the job fails' do
+      let(:item_data) do
+        {
+          'class' => 'HardWorker',
+          'args' => ['asd'],
+          'retry' => true,
+          'queue' => 'default',
+          'jid' => '591f6f66ee0d218fb451dfb6',
+          'created_at' => 1_528_799_582.904939,
+          'enqueued_at' => 1_528_799_582.9049861,
+        }
+      end
+
+      it 'has the the required attributes on call' do
+        failed_job = lambda do
+          job_logger.call(item_data, 'queue') do
+            raise StandardError
+          end
+        end
+
+        expected_body = {
+          'version' => '1.1',
+          'level' => 4,
+          '_type' => 'sidekiq',
+          '_created_at' => 1_528_799_582.904939,
+          '_enqueued_at' => 1_528_799_582.9049861,
+          '_jid' => '591f6f66ee0d218fb451dfb6',
+          '_retry' => true,
+          '_queue' => 'default',
+          '_service.name' => 'hello_world_app',
+          '_class' => 'HardWorker',
+          '_service.version' => '1.0',
+          '_tags' => '',
+          '_params' => ['asd'],
+          '_exception' => 'StandardError',
+        }
+
+        aggregate_failures do
+          expect(&failed_job).to raise_error(StandardError)
+          expect(json_line['_duration']).to be_a(Float)
+          expect(json_line).to include(expected_body)
+          expect(json_line['timestamp']).to be_a(Float)
+          expect(json_line['host']).to be_a(String)
+          expect(json_line['short_message']).to match(/HardWorker with jid:*/)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -30,21 +30,40 @@ when /unit/
   rspec_pattern = 'unit/**/*_spec.rb'
   require 'loga'
 when /sidekiq(?<version>\d+)/
-  case $LAST_MATCH_INFO['version']
+  sidekiq_version = $LAST_MATCH_INFO['version']
+  case sidekiq_version
   when '51'
     rspec_pattern = [
       'spec/integration/sidekiq5_spec.rb',
       'spec/loga/sidekiq5/**/*_spec.rb',
       'spec/loga/sidekiq_spec.rb',
     ].join(',')
-  when '6', '61'
+  when '60'
     rspec_pattern = [
-      'spec/integration/sidekiq6_spec.rb',
+      'spec/integration/sidekiq60_spec.rb',
+      'spec/loga/sidekiq5/**/*_spec.rb',
+      'spec/loga/sidekiq_spec.rb',
+    ].join(',')
+  when '61', '62', '63', '64'
+    rspec_pattern = [
+      'spec/integration/sidekiq61_spec.rb',
       'spec/loga/sidekiq6/**/*_spec.rb',
       'spec/loga/sidekiq_spec.rb',
     ].join(',')
+  when '65'
+    rspec_pattern = [
+      'spec/integration/sidekiq65_spec.rb',
+      'spec/loga/sidekiq6/**/*_spec.rb',
+      'spec/loga/sidekiq_spec.rb',
+    ].join(',')
+  when '7', '70', '71'
+    rspec_pattern = [
+      'spec/integration/sidekiq7_spec.rb',
+      'spec/loga/sidekiq7/**/*_spec.rb',
+      'spec/loga/sidekiq_spec.rb',
+    ].join(',')
   else
-    raise 'FIXME: Unknown sidekiq - update this file.'
+    raise "FIXME: Unknown sidekiq #{sidekiq_version} - update this file."
   end
 
   require 'sidekiq'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loga
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Funding Circle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2023-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -254,8 +254,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/rails32.gemfile
-- gemfiles/rails40.gemfile
 - gemfiles/rails42.gemfile
 - gemfiles/rails50.gemfile
 - gemfiles/rails52.gemfile
@@ -263,8 +261,15 @@ files:
 - gemfiles/rails61.gemfile
 - gemfiles/rails70.gemfile
 - gemfiles/sidekiq51.gemfile
-- gemfiles/sidekiq6.gemfile
+- gemfiles/sidekiq60.gemfile
 - gemfiles/sidekiq61.gemfile
+- gemfiles/sidekiq62.gemfile
+- gemfiles/sidekiq63.gemfile
+- gemfiles/sidekiq64.gemfile
+- gemfiles/sidekiq65.gemfile
+- gemfiles/sidekiq7.gemfile
+- gemfiles/sidekiq70.gemfile
+- gemfiles/sidekiq71.gemfile
 - gemfiles/sinatra14.gemfile
 - gemfiles/unit.gemfile
 - lib/loga.rb
@@ -286,13 +291,12 @@ files:
 - lib/loga/sidekiq.rb
 - lib/loga/sidekiq5/job_logger.rb
 - lib/loga/sidekiq6/job_logger.rb
+- lib/loga/sidekiq7/job_logger.rb
 - lib/loga/tagged_logging.rb
 - lib/loga/utilities.rb
 - lib/loga/version.rb
 - loga.gemspec
 - spec/fixtures/README.md
-- spec/fixtures/rails32.rb
-- spec/fixtures/rails40.rb
 - spec/fixtures/rails42.rb
 - spec/fixtures/rails50.rb
 - spec/fixtures/rails52.rb
@@ -304,10 +308,14 @@ files:
 - spec/integration/rails/railtie_spec.rb
 - spec/integration/rails/request_spec.rb
 - spec/integration/sidekiq5_spec.rb
-- spec/integration/sidekiq6_spec.rb
+- spec/integration/sidekiq60_spec.rb
+- spec/integration/sidekiq61_spec.rb
+- spec/integration/sidekiq65_spec.rb
+- spec/integration/sidekiq7_spec.rb
 - spec/integration/sinatra_spec.rb
 - spec/loga/sidekiq5/job_logger_spec.rb
 - spec/loga/sidekiq6/job_logger_spec.rb
+- spec/loga/sidekiq7/job_logger_spec.rb
 - spec/loga/sidekiq_spec.rb
 - spec/spec_helper.rb
 - spec/support/gethostname_shared.rb
@@ -350,8 +358,6 @@ specification_version: 4
 summary: Facilitate log aggregation via unified logging
 test_files:
 - spec/fixtures/README.md
-- spec/fixtures/rails32.rb
-- spec/fixtures/rails40.rb
 - spec/fixtures/rails42.rb
 - spec/fixtures/rails50.rb
 - spec/fixtures/rails52.rb
@@ -363,10 +369,14 @@ test_files:
 - spec/integration/rails/railtie_spec.rb
 - spec/integration/rails/request_spec.rb
 - spec/integration/sidekiq5_spec.rb
-- spec/integration/sidekiq6_spec.rb
+- spec/integration/sidekiq60_spec.rb
+- spec/integration/sidekiq61_spec.rb
+- spec/integration/sidekiq65_spec.rb
+- spec/integration/sidekiq7_spec.rb
 - spec/integration/sinatra_spec.rb
 - spec/loga/sidekiq5/job_logger_spec.rb
 - spec/loga/sidekiq6/job_logger_spec.rb
+- spec/loga/sidekiq7/job_logger_spec.rb
 - spec/loga/sidekiq_spec.rb
 - spec/spec_helper.rb
 - spec/support/gethostname_shared.rb

data/spec/fixtures/rails32.rb

@@ -1,80 +0,0 @@
-require 'action_controller/railtie'
-require 'action_mailer/railtie'
-
-Bundler.require(*Rails.groups(assets: %w[development test]))
-
-STREAM = StringIO.new unless defined?(STREAM)
-
-class Dummy < Rails::Application
-  config.filter_parameters += [:password]
-  config.secret_token = '32431967aed1c4357d311f27708a1837a938f07e0abfdefa6b8b398d7024c08c6b883ce9254cdd8573ce8e78f9dd192efff39395127811040fc695ab23677452'
-  config.session_store :cookie_store, key: '_rails32_session'
-
-  config.log_tags = [:uuid, 'TEST_TAG']
-  config.loga = {
-    device: STREAM,
-    host: 'bird.example.com',
-    service_name: 'hello_world_app',
-    service_version: '1.0',
-  }
-  config.action_mailer.delivery_method = :test
-  config.active_support.deprecation = :notify
-end
-
-class ApplicationController < ActionController::Base
-  include Rails.application.routes.url_helpers
-  protect_from_forgery
-
-  def ok
-    render text: 'Hello Rails'
-  end
-
-  def error
-    nil.name
-  end
-
-  def show
-    render json: params
-  end
-
-  def create
-    render json: params
-  end
-
-  def new
-    redirect_to :ok
-  end
-
-  def update
-    @id = params[:id]
-    render '/user'
-  end
-end
-
-class FakeMailer < ActionMailer::Base
-  default from: 'notifications@example.com'
-
-  def self.send_email
-    basic_mail.deliver
-  end
-
-  def basic_mail
-    mail(
-      to: 'user@example.com',
-      subject: 'Welcome to My Awesome Site',
-      body: 'Banana muffin',
-      content_type: 'text/html',
-    )
-  end
-end
-
-Dummy.routes.append do
-  get 'ok'        => 'application#ok'
-  get 'error'     => 'application#error'
-  get 'show'      => 'application#show'
-  post 'users'    => 'application#create'
-  get 'new'       => 'application#new'
-  put 'users/:id' => 'application#update'
-end
-
-Dummy.initialize!

data/spec/fixtures/rails40.rb

@@ -1,80 +0,0 @@
-require 'action_controller/railtie'
-require 'action_mailer/railtie'
-
-Bundler.require(*Rails.groups)
-
-STREAM = StringIO.new unless defined?(STREAM)
-
-class Dummy < Rails::Application
-  config.eager_load = true
-  config.filter_parameters += [:password]
-  config.secret_key_base = '2624599ca9ab3cf3823626240138a128118a87683bf03ab8f155844c33b3cd8cbbfa3ef5e29db6f5bd182f8bd4776209d9577cfb46ac51bfd232b00ab0136b24'
-  config.session_store :cookie_store, key: '_rails40_session'
-
-  config.log_tags = [:uuid, 'TEST_TAG']
-  config.loga = {
-    device: STREAM,
-    host: 'bird.example.com',
-    service_name: 'hello_world_app',
-    service_version: '1.0',
-  }
-  config.action_mailer.delivery_method = :test
-end
-
-class ApplicationController < ActionController::Base
-  include Rails.application.routes.url_helpers
-  protect_from_forgery
-
-  def ok
-    render text: 'Hello Rails'
-  end
-
-  def error
-    nil.name
-  end
-
-  def show
-    render json: params
-  end
-
-  def create
-    render json: params
-  end
-
-  def new
-    redirect_to :ok
-  end
-
-  def update
-    @id = params[:id]
-    render '/user'
-  end
-end
-
-class FakeMailer < ActionMailer::Base
-  default from: 'notifications@example.com'
-
-  def self.send_email
-    basic_mail.deliver
-  end
-
-  def basic_mail
-    mail(
-      to: 'user@example.com',
-      subject: 'Welcome to My Awesome Site',
-      body: 'Banana muffin',
-      content_type: 'text/html',
-    )
-  end
-end
-
-Dummy.routes.append do
-  get 'ok'        => 'application#ok'
-  get 'error'     => 'application#error'
-  get 'show'      => 'application#show'
-  post 'users'    => 'application#create'
-  get 'new'       => 'application#new'
-  put 'users/:id' => 'application#update'
-end
-
-Dummy.initialize!