loga 2.8.0 → 2.9.0

data/gemfiles/sinatra2.gemfile

@@ -0,0 +1,36 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "concurrent-ruby", "1.3.4"
+gem "sinatra", "~> 2.2.4"
+
+group :development do
+  gem "appraisal"
+  gem "benchmark"
+  gem "bigdecimal"
+  gem "bundler", ">= 1.6"
+  gem "byebug"
+  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 "rspec", "~> 3.7"
+  gem "rubocop-rspec"
+  gem "rubocop"
+  gem "timecop"
+end
+
+group :test do
+  gem "simplecov", "~> 0.17.0"
+end
+
+gemspec path: "../"

data/gemfiles/sinatra3.gemfile

@@ -0,0 +1,36 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "concurrent-ruby", "1.3.4"
+gem "sinatra", "~> 3.2.0"
+
+group :development do
+  gem "appraisal"
+  gem "benchmark"
+  gem "bigdecimal"
+  gem "bundler", ">= 1.6"
+  gem "byebug"
+  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 "rspec", "~> 3.7"
+  gem "rubocop-rspec"
+  gem "rubocop"
+  gem "timecop"
+end
+
+group :test do
+  gem "simplecov", "~> 0.17.0"
+end
+
+gemspec path: "../"

data/gemfiles/sinatra4.gemfile

@@ -0,0 +1,36 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "concurrent-ruby", "1.3.4"
+gem "sinatra", "~> 4.0.0"
+
+group :development do
+  gem "appraisal"
+  gem "benchmark"
+  gem "bigdecimal"
+  gem "bundler", ">= 1.6"
+  gem "byebug"
+  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 "rspec", "~> 3.7"
+  gem "rubocop-rspec"
+  gem "rubocop"
+  gem "timecop"
+end
+
+group :test do
+  gem "simplecov", "~> 0.17.0"
+end
+
+gemspec path: "../"

data/gemfiles/unit.gemfile

@@ -2,6 +2,30 @@
 
 source "https://rubygems.org"
 
+group :development do
+  gem "appraisal"
+  gem "benchmark"
+  gem "bigdecimal"
+  gem "bundler", ">= 1.6"
+  gem "byebug"
+  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 "rspec", "~> 3.7"
+  gem "rubocop-rspec"
+  gem "rubocop"
+  gem "timecop"
+end
+
 group :test do
   gem "simplecov", "~> 0.17.0"
 end

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

@@ -86,10 +86,10 @@ module Loga
 
         private
 
-        def render_exception_with_loga(arg, exception)
+        def render_exception_with_loga(arg, exception, *args)
           env = arg.is_a?(ActionDispatch::Request) ? arg.env : arg
           env['loga.exception'] = exception
-          render_exception_without_loga(arg, exception)
+          render_exception_without_loga(arg, exception, *args)
         end
       end
 
@@ -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.0'.freeze
+  VERSION = '2.9.0'.freeze
 end

data/loga.gemspec

@@ -20,19 +20,4 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 2.3.8'
   spec.add_dependency 'rack'
-
-  spec.add_development_dependency 'appraisal', '~> 2.4'
-  spec.add_development_dependency 'bundler',   '>= 1.6'
-  spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'guard',         '~> 2.13'
-  spec.add_development_dependency 'guard-rspec',   '~> 4.7'
-  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rack-test'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'fakeredis'
-  spec.add_development_dependency 'rspec',    '~> 3.7'
-  spec.add_development_dependency 'rubocop',  '~> 0.57.0'
-  spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'timecop'
 end

data/spec/fixtures/{rails50.rb → 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: '_rails50_session'
+  config.session_store :cookie_store, key: '_rails71_session'
 
   config.log_tags = [:uuid, 'TEST_TAG']
   config.loga = {

data/spec/fixtures/{rails42.rb → rails72.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: '_rails42_session'
+  config.session_store :cookie_store, key: '_rails72_session'
 
   config.log_tags = [:uuid, 'TEST_TAG']
   config.loga = {
@@ -23,10 +23,10 @@ end
 
 class ApplicationController < ActionController::Base
   include Rails.application.routes.url_helpers
-  protect_from_forgery
+  protect_from_forgery with: :null_session
 
   def ok
-    render text: 'Hello Rails'
+    render plain: 'Hello Rails'
   end
 
   def error

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/rails/action_mailer_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 RSpec.describe Loga::LogSubscribers::ActionMailer, if: Rails.env.production? do

data/spec/integration/rails/railtie_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 
 RSpec.describe Loga::Railtie do
@@ -17,7 +19,11 @@ RSpec.describe Loga::Railtie do
       let(:formatter) { Loga::Formatters::SimpleFormatter }
 
       it 'assign Loga logger to Rails logger' do
-        expect(Loga.logger).to equal(Rails.logger)
+        if defined?(ActiveSupport::BroadcastLogger)
+          expect(Loga.logger).to be_a(Logger)
+        else
+          expect(Loga.logger).to equal(Rails.logger)
+        end
       end
 
       it 'configures Loga with a simple formatter' do
@@ -29,7 +35,11 @@ RSpec.describe Loga::Railtie do
   context 'when production', if: Rails.env.production? do
     describe 'loga_initialize_logger' do
       it 'assign Loga logger to Rails logger' do
-        expect(Loga.logger).to equal(Rails.logger)
+        if defined?(ActiveSupport::BroadcastLogger)
+          expect(Loga.logger).to be_a(Logger)
+        else
+          expect(Loga.logger).to equal(Rails.logger)
+        end
       end
 
       it 'configures Loga with a structured formatter' do
@@ -38,7 +48,7 @@ RSpec.describe Loga::Railtie do
       end
 
       it 'disables colorized logging' do
-        expect(app.config.colorize_logging).to eq(false)
+        expect(app.config.colorize_logging).to be(false)
       end
     end
 

data/spec/integration/rails/request_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-RSpec.describe 'Structured logging with Rails', timecop: true,
-                                                if: Rails.env.production? do
+RSpec.describe 'Structured logging with Rails', :timecop,
+               if: Rails.env.production? do
   let(:app) { Rails.application }
 
   let(:log_entries) do

data/spec/integration/sidekiq5_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'timecop'
 require 'fakeredis'
@@ -24,8 +26,8 @@ describe 'Sidekiq client logger' do
       attr_reader :latest_error, :mutex, :cond
 
       def initialize
-        @mutex = ::Mutex.new
-        @cond = ::ConditionVariable.new
+        @mutex = Mutex.new
+        @cond = ConditionVariable.new
       end
 
       def processor_died(_inst, err)
@@ -84,7 +86,7 @@ describe 'Sidekiq client logger' do
     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['retry']).to be true
       expect(last_element['queue']).to eq 'default'
     end
   end
@@ -107,16 +109,16 @@ describe 'Sidekiq client logger' do
 
     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',
+        '_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|

data/spec/integration/sidekiq60_spec.rb

@@ -31,8 +31,8 @@ describe 'Sidekiq client logger' do
       attr_reader :cond
 
       def initialize
-        @mutex = ::Mutex.new
-        @cond = ::ConditionVariable.new
+        @mutex = Mutex.new
+        @cond = ConditionVariable.new
       end
 
       def processor_died(_inst, err)
@@ -103,7 +103,7 @@ describe 'Sidekiq client logger' do
     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['retry']).to be true
       expect(last_element['queue']).to eq 'default'
     end
   end

data/spec/integration/sidekiq61_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'timecop'
 require 'fakeredis'
@@ -27,8 +29,8 @@ describe 'Sidekiq client logger' do
       attr_reader :latest_error, :mutex, :cond
 
       def initialize
-        @mutex = ::Mutex.new
-        @cond = ::ConditionVariable.new
+        @mutex = Mutex.new
+        @cond = ConditionVariable.new
       end
 
       def processor_died(_inst, err)
@@ -46,7 +48,7 @@ describe 'Sidekiq client logger' do
           concurrency: 3,
           queues: ['default'],
           job_logger: Loga::Sidekiq6::JobLogger,
-        }.tap { |opts| opts[:fetch] = ::Sidekiq::BasicFetch.new(opts) }
+        }.tap { |opts| opts[:fetch] = Sidekiq::BasicFetch.new(opts) }
       end
     end
   end
@@ -87,7 +89,7 @@ describe 'Sidekiq client logger' do
     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['retry']).to be true
       expect(last_element['queue']).to eq 'default'
     end
   end

data/spec/integration/sidekiq65_spec.rb

@@ -75,7 +75,7 @@ describe 'Sidekiq client logger' do
     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['retry']).to be true
       expect(last_element['queue']).to eq 'default'
     end
   end