loga 2.5.2 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 346f092fca3d84834d02408f3307462e0ec017f9634bf08396355e46a1681ec2
-  data.tar.gz: 93949c198f5a4a697ca261bc6d13eabdbd3349c2ab2d57e845abbd5289279095
+  metadata.gz: 1c431f4c2be4360f29975cc8434c86647c77cf8a375bcd8fa6e6a0b47bb8a2e8
+  data.tar.gz: 2ec1e76ed48281e99acca8bdc3dd55b3fb6068dee599dd5c4bf92008e1af6eb0
 SHA512:
-  metadata.gz: c64276706dd59404d3dc19370dc5b85a8390b60d80f6c781826d6417db086c445051b28ce9b85511da071da4d1c5172f7c4703e2782298f09a2e271399ee7a3f
-  data.tar.gz: 19c9919c468fd33bcabf84877b429e631ffdffa1fe3e8b2cbf3319d8b894ffdf3e3db830549f5fa39a57b8745aa9d37d6f691fd9feeb0f4cc2a0a2538f6b5d24
+  metadata.gz: 5c09402cb2b8f7e90bb53ccba07df43c759a9d4cea9cd5a19f8fbfcf332b0ce7914dca1d3c085cd43d9d081e40cc2c4d18452bd5c6b44d10e1df2771c7a88146
+  data.tar.gz: f9f937d8e0a600c05ca50e60c05b084d6756b76158f2b4dcfc7a070ee30ad535ef2df6f0c10d6f61a99152ec2fa2cdb1815b450ce600e4be72e51e797d1165b6

data/.circleci/config.yml

@@ -1,7 +1,7 @@
 basic_build: &basic_build
   working_directory: ~/loga
   docker:
-    - image: circleci/ruby:2.5.1
+    - image: cimg/ruby:2.7.5
 
 test_build: &test_build
   working_directory: ~/loga
@@ -25,43 +25,11 @@ test_build: &test_build
         at: ./tmp
     - run: RACK_ENV=development bundle exec appraisal rspec
     - run: RACK_ENV=production bundle exec appraisal rspec
-    - run: ./tmp/cc-test-reporter format-coverage -t simplecov -o $(ruby -e 'puts "tmp/codeclimate.#{RUBY_VERSION}.json"') coverage/.resultset.json
-    - persist_to_workspace:
-        root: tmp
-        paths:
-          - codeclimate.*.json
     - store_artifacts:
         path: coverage
 
 version: 2
 jobs:
-  build:
-    <<: *basic_build
-    steps:
-      - run:
-          name: Download cc-test-reporter
-          command: |
-            mkdir -p tmp/
-            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./tmp/cc-test-reporter
-            chmod +x ./tmp/cc-test-reporter
-      - persist_to_workspace:
-          root: ./tmp
-          paths:
-            - cc-test-reporter
-  upload-coverage:
-    <<: *basic_build
-    steps:
-      - attach_workspace:
-          at: ./tmp
-      - run:
-          name: Upload coverage results to Code Climate
-          command: |
-            ./tmp/cc-test-reporter sum-coverage tmp/codeclimate.*.json -o tmp/codeclimate.total.json
-            ./tmp/cc-test-reporter upload-coverage -i tmp/codeclimate.total.json -r $CODECLIMATE_REPO_TOKEN
-  ruby-2.3:
-    docker:
-      - image: circleci/ruby:2.3
-    <<: *test_build
   ruby-2.4:
     docker:
       - image: circleci/ruby:2.4
@@ -74,6 +42,14 @@ jobs:
     docker:
       - image: circleci/ruby:2.6
     <<: *test_build
+  ruby-2.7:
+    docker:
+      - image: cimg/ruby:2.7
+    <<: *test_build
+  ruby-3.0:
+    docker:
+      - image: cimg/ruby:3.0
+    <<: *test_build
   rubocop:
     <<: *basic_build
     steps:
@@ -103,48 +79,32 @@ workflows:
   version: 2
   test-then-push-gem:
     jobs:
-      - build:
-          filters:
-            tags:
-              only: /.*/
       - rubocop:
           filters:
             tags:
               only: /.*/
-      - ruby-2.3:
-          filters:
-            tags:
-              only: /.*/
-          requires:
-            - build
       - ruby-2.4:
           filters:
             tags:
               only: /.*/
-          requires:
-            - build
       - ruby-2.5:
           filters:
             tags:
               only: /.*/
-          requires:
-            - build
       - ruby-2.6:
           filters:
             tags:
               only: /.*/
-          requires:
-            - build
-      - upload-coverage:
+      - ruby-2.7:
+          filters:
+            tags:
+              only: /.*/
+      - ruby-3.0:
           filters:
             tags:
               only: /.*/
-          requires:
-            - ruby-2.3
-            - ruby-2.4
-            - ruby-2.5
-            - ruby-2.6
       - push-to-rubygems:
+          context: org-rubygems
           filters:
             tags:
               only: /^v\d.+/
@@ -152,7 +112,8 @@ workflows:
               ignore: /.*/
           requires:
             - rubocop
-            - ruby-2.3
             - ruby-2.4
             - ruby-2.5
             - ruby-2.6
+            - ruby-2.7
+            - ruby-3.0

data/Appraisals

@@ -8,20 +8,22 @@ if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.4.0')
   end
 end
 
-appraise 'rails42' do
-  gem 'rails', '~> 4.2.0'
-end
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.7.0')
+  appraise 'rails42' do
+    gem 'rails', '~> 4.2.0'
+  end
 
-appraise 'sinatra14' do
-  gem 'sinatra', '~> 1.4.0'
-end
+  appraise 'rails50' do
+    gem 'rails', '~> 5.0.0'
+  end
 
-appraise 'rails50' do
-  gem 'rails', '~> 5.0.0'
+  appraise 'rails52' do
+    gem 'rails', '~> 5.2.0'
+  end
 end
 
-appraise 'rails52' do
-  gem 'rails', '~> 5.2.0'
+appraise 'sinatra14' do
+  gem 'sinatra', '~> 1.4.0'
 end
 
 if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.5.0')
@@ -32,6 +34,20 @@ if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.5.0')
   appraise 'sidekiq6' do
     gem 'sidekiq', '~> 6.0'
   end
+
+  appraise 'sidekiq61' do
+    gem 'sidekiq', '~> 6.1.0'
+  end
+end
+
+if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.7.0')
+  appraise 'rails61' do
+    gem 'rails', '~> 6.1.4.4'
+  end
+
+  appraise 'rails70' do
+    gem 'rails', '~> 7.0.0'
+  end
 end
 
 appraise 'sidekiq51' do

data/CHANGELOG.md

@@ -4,6 +4,26 @@ 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.6.1] - 2022-02-22
+### Fixed
+- Fix compatibility with sidekiq 6.4.1
+
+## [2.6.0] - 2021-12-22
+### Added
+- Allow using the gem with rails 7
+- Add a build for ruby 3.0
+
+### Removed
+- Remove build for ruby 2.3
+
+## [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!`
+
 ## [2.5.2] - 2020-10-21
 ### Fixed
 - Support for sidekiq 6

data/Guardfile

@@ -15,7 +15,7 @@ end
 
 group :rails do
   %w[production development].each do |env|
-    %w[rails32 rails40 rails50 rails52].each do |appraisal|
+    %w[rails52 rails61 rails70].each do |appraisal|
       cmd = "RACK_ENV=#{env} bundle exec appraisal #{appraisal} rspec"
 
       guard :rspec, all_on_start: true, cmd: cmd do

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://circleci.com/gh/FundingCircle/loga/tree/master.svg?style=shield&circle-token=9b81c3cf8468a8c3dc760f4c0398cf8914cb27d4)](https://circleci.com/gh/FundingCircle/loga/tree/master)
 [![Code Quality](https://codeclimate.com/repos/5563694f6956805723005d2f/badges/8eecb9144730614fb39e/gpa.svg)](https://codeclimate.com/repos/5563694f6956805723005d2f/feed)
 [![Test Coverage](https://codeclimate.com/repos/5563694f6956805723005d2f/badges/8eecb9144730614fb39e/coverage.svg)](https://codeclimate.com/repos/5563694f6956805723005d2f/coverage)
-[![Dependency Status](https://gemnasium.com/badges/github.com/FundingCircle/loga.svg)](https://gemnasium.com/github.com/FundingCircle/loga)
+[![Dependency Status](https://img.shields.io/librariesio/release/rubygems/loga)](https://libraries.io/rubygems/loga)
 
 ## Description
 

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/rails61.gemfile

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

data/gemfiles/rails70.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.0"
+
+group :test do
+  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/sidekiq61.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 6.1.0"
+
+group :test do
+  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/configuration.rb

@@ -79,6 +79,7 @@ module Loga
       { format: ENV['LOGA_FORMAT'].presence }.reject { |_, v| v.nil? }
     end
 
+    # Note: sidekiq 6 will extend the logger -> https://github.com/mperham/sidekiq/blob/v6.1.2/lib/sidekiq.rb#L210
     def initialize_logger
       device.sync      = sync
       logger           = Logger.new(device)

data/lib/loga/formatters/gelf_formatter.rb

@@ -47,7 +47,8 @@ module Loga
                 end
 
         event.timestamp ||= time
-        event.data ||= {}
+        # Overwrite sidekiq_context data anything manually specified
+        event.data = sidekiq_context.merge!(event.data || {})
         event.data.tap do |hash|
           hash.merge! compute_exception(event.exception)
           hash.merge! compute_type(event.type)
@@ -101,6 +102,20 @@ module Loga
           tags: current_tags.join(' '),
         }
       end
+
+      def sidekiq_context
+        return {} unless defined?(::Sidekiq::Context)
+
+        c = ::Sidekiq::Context.current
+
+        # The context usually holds :class and :jid. :elapsed is added when the job ends
+        data = c.dup
+        if data.key?(:elapsed)
+          data[:duration] = data[:elapsed].to_f
+          data.delete(:elapsed)
+        end
+        data
+      end
     end
   end
 end

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/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..6 then require 'loga/ext/rails/rack/logger.rb'
+        when 4..7 then require 'loga/ext/rails/rack/logger.rb'
         else
           raise Loga::ConfigurationError,
                 "Rails #{Rails::VERSION::MAJOR} is unsupported"

data/lib/loga/sidekiq.rb

@@ -1,13 +1,21 @@
-require 'loga/sidekiq/job_logger'
-
 module Loga
   module Sidekiq
     def self.configure_logging
       return unless defined?(::Sidekiq)
       return if Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('5.0')
 
-      ::Sidekiq.configure_server do |config|
-        config.options[:job_logger] = Loga::Sidekiq::JobLogger
+      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
+      elsif Gem::Version.new(::Sidekiq::VERSION) < Gem::Version.new('7.0')
+        require 'loga/sidekiq6/job_logger'
+
+        ::Sidekiq.configure_server do |config|
+          config.options[:job_logger] = Loga::Sidekiq6::JobLogger
+        end
       end
 
       ::Sidekiq.logger = Loga.configuration.logger

data/lib/loga/{sidekiq → sidekiq5}/job_logger.rb

@@ -1,9 +1,7 @@
 module Loga
-  module Sidekiq
+  module Sidekiq5
     # The approach of using a custom job logger in sidekiq was introduced
     # in v5.0: https://github.com/mperham/sidekiq/pull/3235
-    # This job logger does not support logging for Sidekiq versions
-    # that are before 5.0
     class JobLogger
       include Loga::Utilities
 

data/lib/loga/sidekiq6/job_logger.rb

@@ -0,0 +1,55 @@
+require 'sidekiq/job_logger'
+
+module Loga
+  module Sidekiq6
+    class JobLogger < ::Sidekiq::JobLogger
+      EVENT_TYPE = 'sidekiq'.freeze
+
+      def call(item, _queue)
+        start = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+
+        yield
+
+        ::Sidekiq::Context.current[:elapsed] = elapsed(start)
+
+        loga_log(message: "#{item['class']} with jid: '#{item['jid']}' done", item: item)
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        ::Sidekiq::Context.current[:elapsed] = elapsed(start)
+
+        loga_log(
+          message: "#{item['class']} with jid: '#{item['jid']}' fail", item: item,
+          exception: e
+        )
+
+        raise
+      end
+
+      def prepare(job_hash, &block)
+        super
+      ensure
+        # For sidekiq version < 6.4
+        Thread.current[:sidekiq_context] = nil
+      end
+
+      private
+
+      def loga_log(message:, item:, exception: nil)
+        data = {
+          'created_at'  => item['created_at'],
+          'enqueued_at' => item['enqueued_at'],
+          'jid'         => item['jid'],
+          'queue'       => item['queue'],
+          'retry'       => item['retry'],
+          'params'      => item['args'],
+          'class'       => item['class'],
+        }
+        if exception
+          data['exception'] = exception
+          @logger.warn(Event.new(type: EVENT_TYPE, message: message, data: data))
+        else
+          @logger.info(Event.new(type: EVENT_TYPE, message: message, data: data))
+        end
+      end
+    end
+  end
+end

data/lib/loga/version.rb

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

data/loga.gemspec

@@ -21,17 +21,17 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '>= 2.3.8'
   spec.add_dependency 'rack'
 
-  spec.add_development_dependency 'appraisal', '~> 2.2.0'
-  spec.add_development_dependency 'bundler',   '~> 1.6'
+  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.3'
+  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.0'
+  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'