loga 2.5.3 → 2.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 252a23996e615f29819c4465c083adb286278026baaf2c2d693883bf76560e24
-  data.tar.gz: c410a1c3442a4f66fd299c456cf62ae7cc21d8beb89ce16ba98460a0b1142b3f
+  metadata.gz: b0e5af261daf89f7f7e4b80be296a8f19307a33f187a501e23eb5295fbedd8f2
+  data.tar.gz: ed0d0281f4d40078051363434600bdd9a8f843ba70a85fde3b110d56a58e2ca3
 SHA512:
-  metadata.gz: bbeb468b6ddd72798c497a8f1f2f0d34acf189e9ada83d4dc6d878461e9d65b19365582deb9a9ce48886379f10e97185c551c228b4a0adc827a3d1d2d686c987
-  data.tar.gz: f063246243858c1645bfd9b02b50396268c0c3c72ae966d2e070f22cf2dd332635601c66ab4c550680c49eb9faaaafaae0c60e98c71fa249f14de5fd45881eb4
+  metadata.gz: 64128d6a8442ce7006629f3056c94487e9316f7c07cd284b3f96f3bb01fd5daccd3a7e4372dfb746376e8e91e2ccb52e015e381bd1c2fdc1774b86e5a5a78f43
+  data.tar.gz: bf0393ec37a4f9f8a023d031b5823ad94151fc98b9f1d2ce1ee2bea8b580c88db3013b35b73c68636dfb482dbabd1019771b0b0542ec11c8b2ab0baad290a022

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.5.4] - 2021-03-24
+### Fixed
+- Remove state from Rack middleware, to prevent race conditions where one request would overwrite the state of another
+
 ## [2.5.3] - 2020-10-27
 ### Fixed
 - Support for sidekiq 6 - previous versions were causing sidekiq to crash with `Internal exception!`

data/gemfiles/rails60.gemfile

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

data/gemfiles/sidekiq51.gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 gem "sidekiq", "~> 5.1.0"
 
 group :test do
-  gem "simplecov"
+  gem "simplecov", "~> 0.17.0"
 end
 
 gemspec path: "../"

data/gemfiles/sidekiq6.gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 gem "sidekiq", "~> 6.0"
 
 group :test do
-  gem "simplecov"
+  gem "simplecov", "~> 0.17.0"
 end
 
 gemspec path: "../"

data/gemfiles/sinatra14.gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 gem "sinatra", "~> 1.4.0"
 
 group :test do
-  gem "simplecov"
+  gem "simplecov", "~> 0.17.0"
 end
 
 gemspec path: "../"

data/gemfiles/unit.gemfile

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 group :test do
-  gem "simplecov"
+  gem "simplecov", "~> 0.17.0"
 end
 
 gemspec path: "../"

data/lib/loga/rack/logger.rb

@@ -7,65 +7,57 @@ module Loga
         @app = app
       end
 
-      def call(env)
+      def call(env, started_at = Time.now)
         request = Loga::Rack::Request.new(env)
         env['loga.request.original_path'] = request.path
 
         if logger.respond_to?(:tagged)
-          logger.tagged(compute_tags(request)) { call_app(request, env) }
+          logger.tagged(compute_tags(request)) { call_app(request, env, started_at) }
         else
-          call_app(request, env)
+          call_app(request, env, started_at)
         end
       end
 
       private
 
-      attr_reader :data, :env, :request, :started_at
-
-      def call_app(request, env)
-        @data       = {}
-        @env        = env
-        @request    = request
-        @started_at = Time.now
-
-        @app.call(env).tap { |status, _headers, _body| data['status'] = status.to_i }
+      def call_app(request, env, started_at)
+        status, _headers, _body = @app.call(env)
       ensure
-        set_data
-        send_message
-      end
+        data = generate_data(request, status, started_at)
 
-      # rubocop:disable Metrics/LineLength
-      def set_data
-        data['method']     = request.request_method
-        data['path']       = request.original_path
-        data['params']     = request.filtered_parameters
-        data['request_id'] = request.uuid
-        data['request_ip'] = request.ip
-        data['user_agent'] = request.user_agent
-        data['controller'] = request.controller_action_name if request.controller_action_name
-        data['duration']   = duration_in_ms(started_at, Time.now)
-
-        # If data['status'] is nil we assume an exception was raised when calling the application
-        data['status']     ||= 500
-      end
-      # rubocop:enable Metrics/LineLength
+        exception = compute_exception(env)
 
-      def send_message
         event = Loga::Event.new(
           data:       { request: data },
-          exception:  compute_exception,
-          message:    compute_message,
+          exception:  exception,
+          message:    compute_message(request, data),
           timestamp:  started_at,
           type:       'request',
         )
-        logger.public_send(compute_level, event)
+
+        exception ? logger.error(event) : logger.info(event)
+      end
+
+      def generate_data(request, status, started_at)
+        controller = request.controller_action_name
+        status ||= 500
+        {
+          'method' => request.request_method,
+          'path' => request.original_path,
+          'params' => request.filtered_parameters,
+          'request_id' => request.uuid,
+          'request_ip' => request.ip,
+          'user_agent' => request.user_agent,
+          'duration' => duration_in_ms(started_at, Time.now),
+          'status' => status.to_i,
+        }.tap { |d| d['controller'] = controller if controller }
       end
 
       def logger
         Loga.logger
       end
 
-      def compute_message
+      def compute_message(request, data)
         '%<method>s %<filtered_full_path>s %<status>d in %<duration>dms' % {
           method:             request.request_method,
           filtered_full_path: request.filtered_full_path,
@@ -74,19 +66,14 @@ module Loga
         }
       end
 
-      def compute_level
-        compute_exception ? :error : :info
-      end
+      def compute_exception(env)
+        exception =
+          env['loga.exception'] || env['action_dispatch.exception'] ||
+          env['sinatra.error'] || env['rack.exception']
 
-      def compute_exception
         filter_exceptions.include?(exception.class.to_s) ? nil : exception
       end
 
-      def exception
-        env['loga.exception'] || env['action_dispatch.exception'] ||
-          env['sinatra.error'] || env['rack.exception']
-      end
-
       def filter_exceptions
         Loga.configuration.filter_exceptions
       end

data/lib/loga/version.rb

@@ -1,3 +1,3 @@
 module Loga
-  VERSION = '2.5.3'.freeze
+  VERSION = '2.5.4'.freeze
 end

data/spec/integration/sinatra_spec.rb

@@ -68,7 +68,6 @@ RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
     end
     let(:data) do
       {
-        'status' => 200,
         'method' => 'GET',
         'path'   => '/ok',
         'params' => { 'username'=>'yoshi' },
@@ -76,6 +75,7 @@ RSpec.describe 'Structured logging with Sinatra', :with_hostname, :timecop do
         'request_ip' => '127.0.0.1',
         'user_agent' => nil,
         'duration'   => 0,
+        'status' => 200,
       }
     end
     let(:data_as_text)  { "data=#{{ request: data }.inspect}" }

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
@@ -69,9 +74,31 @@ describe Loga::Rack::Logger do
 
     context 'when an exception is raised' do
       let(:app) {  ->(_env) { raise exception_class } }
-
-      it 'does not rescue the exception' do
-        expect { subject.call(env) }.to raise_error(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
 
@@ -113,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.5.3
+  version: 2.5.4
 platform: ruby
 authors:
 - Funding Circle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-27 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport