loga 2.4.0 → 2.5.4

data/spec/loga/sidekiq_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 RSpec.describe Loga::Sidekiq do
   describe '.configure_logging' do
-    context 'when sidekiq version is 5.1' do
+    context 'when sidekiq is defined' do
       it 'gets invoked on Loga.configure' do
         allow(described_class).to receive(:configure_logging)
 
@@ -18,7 +18,7 @@ RSpec.describe Loga::Sidekiq do
         expect(described_class).to have_received(:configure_logging)
       end
 
-      it 'assigns our custom sidekiq job logger' do
+      it 'assigns our custom sidekiq job logger depending on the sidekiq version' do
         Loga.reset
 
         Loga.configure(
@@ -28,7 +28,14 @@ RSpec.describe Loga::Sidekiq do
           format: :gelf,
         )
 
-        expect(::Sidekiq.options[:job_logger]).to eq(Loga::Sidekiq::JobLogger)
+        m = ENV['BUNDLE_GEMFILE'].match(/sidekiq(?<version>\d+)/)
+
+        case m['version']
+        when '51'
+          expect(::Sidekiq.options[:job_logger]).to eq(Loga::Sidekiq5::JobLogger)
+        when '6'
+          expect(::Sidekiq.options[:job_logger]).to eq(Loga::Sidekiq6::JobLogger)
+        end
       end
     end
 

data/spec/spec_helper.rb

@@ -29,14 +29,23 @@ when /sinatra/
 when /unit/
   rspec_pattern = 'unit/**/*_spec.rb'
   require 'loga'
-when /sidekiq/
-  sidekiq_specs = [
-    'integration/sidekiq_spec.rb',
-    'spec/loga/sidekiq/**/*_spec.rb',
-    'spec/loga/sidekiq_spec.rb',
-  ]
-
-  rspec_pattern = sidekiq_specs.join(',')
+when /sidekiq(?<version>\d+)/
+  case $LAST_MATCH_INFO['version']
+  when '51'
+    rspec_pattern = [
+      'spec/integration/sidekiq5_spec.rb',
+      'spec/loga/sidekiq5/**/*_spec.rb',
+      'spec/loga/sidekiq_spec.rb',
+    ].join(',')
+  when '6'
+    rspec_pattern = [
+      'spec/integration/sidekiq6_spec.rb',
+      'spec/loga/sidekiq6/**/*_spec.rb',
+      'spec/loga/sidekiq_spec.rb',
+    ].join(',')
+  else
+    raise 'FIXME: Unknown sidekiq - update this file.'
+  end
 
   require 'sidekiq'
   require 'sidekiq/cli'

data/spec/unit/loga/formatters/gelf_formatter_spec.rb

@@ -166,6 +166,49 @@ describe Loga::Formatters::GELFFormatter do
       end
     end
 
+    context 'when working with sidekiq context' do
+      let(:options) { { message: 'Wooden house' } }
+      let(:message) { Loga::Event.new(options) }
+      let(:sidekiq_context) { { class: 'MyWorker', jid: '123' } }
+
+      before do
+        klass = Class.new do
+          class << self
+            attr_accessor :current
+          end
+        end
+        klass.current = sidekiq_context
+        stub_const('::Sidekiq::Context', klass)
+      end
+
+      it 'includes the ::Sidekiq::Context.current data' do
+        expect(json['_class']).to eq('MyWorker')
+        expect(json['_jid']).to eq('123')
+      end
+
+      include_examples 'valid GELF message'
+
+      describe 'overwriting sidekiq context data with manual one' do
+        let(:options) { { message: 'Test', data: { class: 'CoolTest' } } }
+
+        it 'uses the manual data instead of the sidekiq context' do
+          expect(json['_class']).to eq('CoolTest')
+        end
+
+        include_examples 'valid GELF message'
+      end
+
+      describe ':elapsed in the sidekiq context' do
+        let(:sidekiq_context) { { class: 'MyWorker', jid: '123', elapsed: '22.2' } }
+
+        it 'transforms it to _duration' do
+          expect(json['_duration']).to eq(22.2)
+        end
+
+        include_examples 'valid GELF message'
+      end
+    end
+
     {
       'DEBUG'   => 7,
       'INFO'    => 6,

data/spec/unit/loga/rack/logger_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 require 'rack/test'
 
-# rubocop:disable RSpec/SubjectStub, RSpec/MessageSpies, RSpec/VerifiedDoubles
+# rubocop:disable RSpec/VerifiedDoubles RSpec/MessageSpies
 describe Loga::Rack::Logger do
-  subject { described_class.new(app) }
+  subject(:middleware) { described_class.new(app) }
 
   let(:env)     { Rack::MockRequest.env_for('/about_us?limit=1', options) }
   let(:options) { {} }
@@ -21,18 +21,25 @@ describe Loga::Rack::Logger do
     )
   end
 
-  before { Loga.instance_variable_set(:@configuration, configuration) }
+  let(:started_at) { Time.new(2021, 1, 2, 9, 30, 4.500, '+00:00') }
+
+  around do |example|
+    Timecop.freeze(Time.new(2021, 1, 2, 9, 30, 5.000, '+00:00'), &example)
+  end
+
+  before do
+    allow(Loga).to receive(:configuration).and_return(configuration)
+  end
 
   shared_examples 'logs the event' do |details|
     let(:level) { details[:level] }
 
-    before do
-      allow(subject).to receive(:started_at).and_return(:timestamp)
-      allow(subject).to receive(:duration_in_ms).with(any_args).and_return(5)
-    end
-
     it 'instantiates a Loga::Event' do
-      expect(Loga::Event).to receive(:new).with(
+      allow(Loga::Event).to receive(:new).and_call_original
+
+      middleware.call(env, started_at)
+
+      expect(Loga::Event).to have_received(:new).with(
         data:      {
           request: {
             'status'     => response_status,
@@ -42,21 +49,19 @@ describe Loga::Rack::Logger do
             'request_id' => nil,
             'request_ip' => nil,
             'user_agent' => nil,
-            'duration'   => 5,
+            'duration'   => 500,
           },
         },
         exception: logged_exception,
         message:   %r{^GET \/about_us\?limit=1 #{response_status} in \d+ms$},
-        timestamp: :timestamp,
+        timestamp: started_at,
         type:      'request',
       )
-
-      subject.call(env)
     end
 
     it "logs the Loga::Event with severity #{details[:level]}" do
       allow(logger).to receive(level)
-      subject.call(env)
+      middleware.call(env, started_at)
       expect(logger).to have_received(level).with(an_instance_of(Loga::Event))
     end
   end
@@ -65,12 +70,35 @@ describe Loga::Rack::Logger do
     let(:exception)        { StandardError.new }
     let(:logged_exception) { nil }
     let(:response_status)  { 200 }
+    let(:exception_class)  { Class.new(StandardError) }
 
     context 'when an exception is raised' do
-      let(:app) {  ->(_env) { raise exception } }
-
-      it 'does not rescue the exception' do
-        expect { subject.call(env) }.to raise_error(StandardError)
+      let(:app) {  ->(_env) { raise exception_class } }
+      let(:response_status) { 500 }
+
+      it 'raises error, but still logs an event' do
+        allow(Loga::Event).to receive(:new).and_call_original
+
+        expect { middleware.call(env, started_at) }.to raise_error(exception_class)
+
+        expect(Loga::Event).to have_received(:new).with(
+          data:      {
+            request: {
+              'status'     => response_status,
+              'method'     => 'GET',
+              'path'       => '/about_us',
+              'params'     => { 'limit' => '1' },
+              'request_id' => nil,
+              'request_ip' => nil,
+              'user_agent' => nil,
+              'duration'   => 500,
+            },
+          },
+          exception: logged_exception,
+          message:   %r{^GET \/about_us\?limit=1 #{response_status} in \d+ms$},
+          timestamp: started_at,
+          type:      'request',
+        )
       end
     end
 
@@ -112,28 +140,21 @@ describe Loga::Rack::Logger do
     end
 
     context 'when the logger is tagged' do
-      let(:logger) { double(:logger, tagged: true) }
-
-      before do
-        allow(subject).to receive(:call_app).with(any_args).and_return(:response)
-        allow(subject).to receive(:compute_tags).with(any_args).and_return(:tag)
-        allow(logger).to receive(:tagged).with('hello') do |&block|
-          block.call
-        end
-      end
+      let(:logger) { Loga::TaggedLogging.new(Logger.new('/dev/null')) }
+      let(:fake_tag_proc) { double(:proc, call: true) }
+
+      let(:tags) { [->(request) { fake_tag_proc.call(request) }] }
+
+      include_examples 'logs the event', level: :info
 
-      context 'when tags are present' do
-        let(:tags) { [:foo] }
+      it 'calls the tags and computes them' do
+        middleware.call(env)
 
-        it 'yields the app with tags' do
-          allow(logger).to receive(:tagged)
-          subject.call(env)
-          expect(logger).to have_received(:tagged).with(:tag) do |&block|
-            expect(block.call).to eq(:response)
-          end
-        end
+        expect(fake_tag_proc)
+          .to have_received(:call)
+          .with(instance_of(Loga::Rack::Request))
       end
     end
   end
 end
-# rubocop:enable RSpec/SubjectStub, RSpec/MessageSpies, RSpec/VerifiedDoubles
+# rubocop:enable RSpec/VerifiedDoubles RSpec/MessageSpies

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loga
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.4
 platform: ruby
 authors:
 - Funding Circle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,14 +56,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
@@ -259,7 +259,9 @@ files:
 - gemfiles/rails42.gemfile
 - gemfiles/rails50.gemfile
 - gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
 - gemfiles/sidekiq51.gemfile
+- gemfiles/sidekiq6.gemfile
 - gemfiles/sinatra14.gemfile
 - gemfiles/unit.gemfile
 - lib/loga.rb
@@ -279,7 +281,8 @@ files:
 - lib/loga/railtie.rb
 - lib/loga/service_version_strategies.rb
 - lib/loga/sidekiq.rb
-- lib/loga/sidekiq/job_logger.rb
+- lib/loga/sidekiq5/job_logger.rb
+- lib/loga/sidekiq6/job_logger.rb
 - lib/loga/tagged_logging.rb
 - lib/loga/utilities.rb
 - lib/loga/version.rb
@@ -290,13 +293,16 @@ files:
 - spec/fixtures/rails42.rb
 - spec/fixtures/rails50.rb
 - spec/fixtures/rails52.rb
+- spec/fixtures/rails60.rb
 - spec/fixtures/random_bin
 - spec/integration/rails/action_mailer_spec.rb
 - spec/integration/rails/railtie_spec.rb
 - spec/integration/rails/request_spec.rb
-- spec/integration/sidekiq_spec.rb
+- spec/integration/sidekiq5_spec.rb
+- spec/integration/sidekiq6_spec.rb
 - spec/integration/sinatra_spec.rb
-- spec/loga/sidekiq/job_logger_spec.rb
+- spec/loga/sidekiq5/job_logger_spec.rb
+- spec/loga/sidekiq6/job_logger_spec.rb
 - spec/loga/sidekiq_spec.rb
 - spec/spec_helper.rb
 - spec/support/gethostname_shared.rb
@@ -345,13 +351,16 @@ test_files:
 - spec/fixtures/rails42.rb
 - spec/fixtures/rails50.rb
 - spec/fixtures/rails52.rb
+- spec/fixtures/rails60.rb
 - spec/fixtures/random_bin
 - spec/integration/rails/action_mailer_spec.rb
 - spec/integration/rails/railtie_spec.rb
 - spec/integration/rails/request_spec.rb
-- spec/integration/sidekiq_spec.rb
+- spec/integration/sidekiq5_spec.rb
+- spec/integration/sidekiq6_spec.rb
 - spec/integration/sinatra_spec.rb
-- spec/loga/sidekiq/job_logger_spec.rb
+- spec/loga/sidekiq5/job_logger_spec.rb
+- spec/loga/sidekiq6/job_logger_spec.rb
 - spec/loga/sidekiq_spec.rb
 - spec/spec_helper.rb
 - spec/support/gethostname_shared.rb

data/spec/integration/sidekiq_spec.rb

@@ -1,147 +0,0 @@
-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); end
-end
-
-describe 'Sidekiq client logger' do
-  let(:target) { StringIO.new }
-
-  def read_json_log(line:)
-    target.rewind
-    JSON.parse(target.each_line.drop(line - 1).first)
-  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
-    job_logger = Loga::Sidekiq::JobLogger
-
-    expect(Sidekiq.options[:job_logger]).to eq job_logger
-  end
-
-  it 'has the proper logger Sidekiq::Logging.logger' do
-    expect(Sidekiq::Logging.logger).to eq Loga.logger
-  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
-
-  if ENV['BUNDLE_GEMFILE'] =~ /sidekiq51/
-    # https://github.com/mperham/sidekiq/blob/97363210b47a4f8a1d8c1233aaa059d6643f5040/test/test_actors.rb#L57-L79
-    let(:mgr) do
-      Class.new do
-        attr_reader :latest_error, :mutex, :cond
-
-        def initialize
-          @mutex = ::Mutex.new
-          @cond = ::ConditionVariable.new
-        end
-
-        def processor_died(_inst, err)
-          @latest_error = err
-
-          @mutex.synchronize { @cond.signal }
-        end
-
-        def processor_stopped(_inst)
-          @mutex.synchronize { @cond.signal }
-        end
-
-        def options
-          {
-            concurrency: 3,
-            queues: ['default'],
-            job_logger: Loga::Sidekiq::JobLogger,
-          }
-        end
-      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
-
-      expected_attributes = {
-        '_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',
-      }
-
-      json_line = read_json_log(line: 1)
-
-      aggregate_failures do
-        expect(json_line).to include(expected_attributes)
-
-        %w[_created_at _enqueued_at _jid _duration timestamp host].each do |key|
-          expect(json_line).to have_key(key)
-        end
-
-        expect(json_line['short_message']).to match(/MySidekiqWorker with jid:*/)
-      end
-
-      # 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
-
-      json_line = read_json_log(line: 2)
-
-      expect(json_line['_duration']).to be < 500
-    end
-  end
-end