loga 2.8.1 → 2.9.0

data/gemfiles/unit.gemfile

@@ -4,24 +4,26 @@ source "https://rubygems.org"
 
 group :development do
   gem "appraisal"
+  gem "benchmark"
+  gem "bigdecimal"
   gem "bundler", ">= 1.6"
   gem "byebug"
-  gem "guard"
+  gem "fakeredis"
   gem "guard-rspec"
   gem "guard-rubocop"
+  gem "guard"
+  gem "net-imap"
+  gem "net-pop"
+  gem "net-smtp"
+  gem "ostruct"
   gem "pry"
+  gem "psych"
   gem "rack-test"
   gem "rake"
-  gem "fakeredis"
   gem "rspec", "~> 3.7"
-  gem "rubocop"
   gem "rubocop-rspec"
+  gem "rubocop"
   gem "timecop"
-  gem "psych"
-  gem "net-smtp"
-  gem "net-pop"
-  gem "net-imap"
-  gem "bigdecimal"
 end
 
 group :test do

data/lib/loga/parameter_filter.rb

@@ -20,8 +20,6 @@ module Loga
 
     class CompiledFilter
       def self.compile(filters)
-        ->(params) { params.dup } if filters.empty?
-
         regexps = []
         strings = []
 

data/lib/loga/rack/request.rb

@@ -34,12 +34,12 @@ module Loga
         env['loga.request.original_path']
       end
 
-      # rubocop:disable Metrics/LineLength
+      # rubocop:disable Layout/LineLength
       def filtered_full_path
         @filtered_full_path ||=
           query_string.empty? ? original_path : "#{original_path}?#{filtered_query_string}"
       end
-      # rubocop:enable Metrics/LineLength
+      # rubocop:enable Layout/LineLength
 
       def filtered_parameters
         @filtered_parameters ||= filtered_query_hash.merge(filtered_form_hash)

data/lib/loga/rack/request_id.rb

@@ -3,7 +3,7 @@ require 'securerandom'
 require 'active_support/core_ext/string/access'
 require 'active_support/core_ext/object/blank'
 
-# rubocop:disable Lint/AssignmentInCondition, Metrics/LineLength, Style/GuardClause
+# rubocop:disable Lint/AssignmentInCondition, Layout/LineLength, Style/GuardClause
 module Loga
   module Rack
     # Makes a unique request id available to the action_dispatch.request_id env variable (which is then accessible through
@@ -41,4 +41,4 @@ module Loga
     end
   end
 end
-# rubocop:enable Lint/AssignmentInCondition, Metrics/LineLength, Style/GuardClause
+# rubocop:enable Lint/AssignmentInCondition, Layout/LineLength, Style/GuardClause

data/lib/loga/railtie.rb

@@ -125,7 +125,7 @@ module Loga
       def silence_rails_rack_logger
         case Rails::VERSION::MAJOR
         when 3    then require 'loga/ext/rails/rack/logger3.rb'
-        when 4..7 then require 'loga/ext/rails/rack/logger.rb'
+        when 4..8 then require 'loga/ext/rails/rack/logger.rb'
         else
           raise Loga::ConfigurationError,
                 "Rails #{Rails::VERSION::MAJOR} is unsupported"

data/lib/loga/sidekiq.rb

@@ -12,6 +12,8 @@ module Loga
         configure_for_sidekiq6
       elsif Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('8.0')
         configure_for_sidekiq7
+      elsif Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('9.0')
+        configure_for_sidekiq8
       end
     end
 
@@ -43,5 +45,14 @@ module Loga
         config.logger = Loga.configuration.logger
       end
     end
+
+    def self.configure_for_sidekiq8
+      require 'loga/sidekiq8/job_logger'
+
+      ::Sidekiq.configure_server do |config|
+        config[:job_logger] = Loga::Sidekiq8::JobLogger
+        config.logger = Loga.configuration.logger
+      end
+    end
   end
 end

data/lib/loga/sidekiq8/job_logger.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# If a future Sidekiq 8.x release introduces breaking changes that require a
+# divergent implementation, replace this constant assignment with a dedicated
+# class (you can copy the Sidekiq7 implementation as a starting point).
+
+require 'loga/sidekiq7/job_logger'
+
+module Loga
+  module Sidekiq8
+    JobLogger = Class.new(Loga::Sidekiq7::JobLogger)
+  end
+end

data/lib/loga/tagged_logging.rb

@@ -8,7 +8,7 @@ require 'active_support/core_ext/object/blank'
 require 'logger'
 
 module Loga
-  # rubocop:disable Metrics/LineLength
+  # rubocop:disable Layout/LineLength
   # Wraps any standard Logger object to provide tagging capabilities.
   #
   #   logger = ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
@@ -19,7 +19,7 @@ module Loga
   # This is used by the default Rails.logger as configured by Railties to make
   # it easy to stamp log lines with subdomains, request ids, and anything else
   # to aid debugging of multi-user production applications.
-  # rubocop:enable Metrics/LineLength
+  # rubocop:enable Layout/LineLength
   module TaggedLogging
     module Formatter # :nodoc:
       def tagged(*tags)

data/lib/loga/version.rb

@@ -1,3 +1,3 @@
 module Loga
-  VERSION = '2.8.1'.freeze
+  VERSION = '2.9.0'.freeze
 end

data/spec/fixtures/rails71.rb

@@ -9,7 +9,7 @@ class Dummy < Rails::Application
   config.eager_load = true
   config.filter_parameters += [:password]
   config.secret_key_base = '2624599ca9ab3cf3823626240138a128118a87683bf03ab8f155844c33b3cd8cbbfa3ef5e29db6f5bd182f8bd4776209d9577cfb46ac51bfd232b00ab0136b24'
-  config.session_store :cookie_store, key: '_rails70_session'
+  config.session_store :cookie_store, key: '_rails71_session'
 
   config.log_tags = [:uuid, 'TEST_TAG']
   config.loga = {

data/spec/fixtures/rails72.rb

@@ -0,0 +1,80 @@
+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: '_rails72_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 with: :null_session
+
+  def ok
+    render plain: '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_now
+  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/rails80.rb

@@ -0,0 +1,80 @@
+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: '_rails80_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 with: :null_session
+
+  def ok
+    render plain: '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_now
+  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/integration/sidekiq8_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::Sidekiq8::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/integration/sinatra_spec.rb

@@ -61,7 +61,7 @@ RSpec.describe 'Structured logging with Sinatra', :timecop, :with_hostname do
     end
   end
 
-  # rubocop:disable Metrics/LineLength
+  # rubocop:disable Layout/LineLength
   context 'when RACK_ENV is development', if: ENV['RACK_ENV'].eql?('development') do
     let(:format) { :simple }
     let(:last_log_entry) do
@@ -122,9 +122,16 @@ RSpec.describe 'Structured logging with Sinatra', :timecop, :with_hostname do
       it 'logs the request with the exception' do
         get '/error', {}, 'HTTP_X_REQUEST_ID' => '700a6a01'
 
-        expect(last_log_entry).to start_with("E, #{time_pid_tags} GET /error 500 in 0ms type=request #{data_as_text} exception=undefined method `name' for nil")
+        exception_line =
+          if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('3.4.0dev')
+            "E, #{time_pid_tags} GET /error 500 in 0ms type=request #{data_as_text} exception=undefined method 'name' for nil"
+          else
+            "E, #{time_pid_tags} GET /error 500 in 0ms type=request #{data_as_text} exception=undefined method `name' for nil"
+          end
+
+        expect(last_log_entry).to start_with(exception_line)
       end
     end
   end
-  # rubocop:enable Metrics/LineLength
+  # rubocop:enable Layout/LineLength
 end

data/spec/loga/sidekiq_latest/job_logger_spec.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'loga/sidekiq7/job_logger'
+require 'loga/sidekiq8/job_logger'
+
+logger_klass =
+  if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('8.0.0')
+    Loga::Sidekiq8::JobLogger
+  elsif Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('7.0.0')
+    Loga::Sidekiq7::JobLogger
+  else
+    raise 'No suitable Sidekiq JobLogger implementation found'
+  end
+
+RSpec.describe logger_klass, 'unified (latest) Sidekiq JobLogger spec' do
+  # Sidekiq < 7.3: initializer expects a raw logger
+  # Sidekiq >= 7.3: initializer expects a config object responding to #logger and #[] (Sidekiq 8 keeps this)
+  subject(:job_logger) do
+    if Gem::Version.new(Sidekiq::VERSION) >= Gem::Version.new('7.3.0')
+      described_class.new(sidekiq_config)
+    else
+      described_class.new(logger)
+    end
+  end
+
+  let(:target) { StringIO.new }
+
+  let(:json_line) do
+    target.rewind
+    raw = target.read
+    line = raw.split("\n").last
+    JSON.parse(line) if line
+  end
+
+  let(:logger) { Loga.logger }
+  let(:sidekiq_config) { instance_double(Sidekiq::Config, logger: logger, :[] => nil) }
+
+  before do
+    Loga.reset
+    Loga.configure(
+      service_name: 'hello_world_app',
+      service_version: '1.0',
+      device: target,
+      format: :gelf,
+    )
+  end
+
+  it 'inherits from ::Sidekiq::JobLogger' do
+    expect(job_logger).to be_a(Sidekiq::JobLogger)
+  end
+
+  describe '#call' 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
+
+    context 'when the job passes successfully' do
+      it 'logs the expected structured event' do
+        job_logger.call(item_data, 'default') do
+          # simulate job body
+        end
+
+        expected = {
+          'version' => '1.1',
+          'level' => 6, # INFO -> 6 (syslog mapping)
+          '_type' => 'sidekiq',
+          '_created_at' => item_data['created_at'],
+          '_enqueued_at' => item_data['enqueued_at'],
+          '_jid' => item_data['jid'],
+          '_retry' => true,
+          '_queue' => 'default',
+          '_service.name' => 'hello_world_app',
+          '_service.version' => '1.0',
+          '_class' => 'HardWorker',
+          '_params' => ['asd'],
+          '_tags' => '',
+        }
+
+        aggregate_failures do
+          expect(json_line).to include(expected)
+          expect(json_line['_duration']).to be_a(Float).or be_a(Integer)
+          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: '591f6f66ee0d218fb451dfb6' (done|executed)/)
+        end
+      end
+    end
+
+    context 'when the job fails' do
+      it 'logs the expected structured event with exception info' do
+        failing = lambda do
+          job_logger.call(item_data, 'default') do
+            raise StandardError, 'Boom'
+          end
+        end
+
+        expect(&failing).to raise_error(StandardError, 'Boom')
+
+        expected = {
+          'version' => '1.1',
+          # WARN -> syslog 4 (sidekiq job failure logged at warn)
+          'level' => 4,
+          '_type' => 'sidekiq',
+          '_created_at' => item_data['created_at'],
+          '_enqueued_at' => item_data['enqueued_at'],
+          '_jid' => item_data['jid'],
+          '_retry' => true,
+          '_queue' => 'default',
+          '_service.name' => 'hello_world_app',
+          '_service.version' => '1.0',
+          '_class' => 'HardWorker',
+          '_params' => ['asd'],
+          '_tags' => '',
+          '_exception' => 'Boom',
+        }
+
+        aggregate_failures do
+          expect(json_line).to include(expected)
+          expect(json_line['_duration']).to be_a(Float).or be_a(Integer)
+          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: '591f6f66ee0d218fb451dfb6' fail/)
+        end
+      end
+    end
+  end
+end