loga 2.3.0 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99d4525427d3cfa44d95be9d47f82188246743e71aab9f8d40489214e02e4c02
-  data.tar.gz: 33fc287f4ecabf93cdc6d789f81a040c64eb411d7a018459fa39c91ae03c46c8
+  metadata.gz: 346f092fca3d84834d02408f3307462e0ec017f9634bf08396355e46a1681ec2
+  data.tar.gz: 93949c198f5a4a697ca261bc6d13eabdbd3349c2ab2d57e845abbd5289279095
 SHA512:
-  metadata.gz: 6ce2b115d84a4b3c1c93bf8070b0f3d7ed148df4eb1169ab57d8de2357ad03ea23c21fab2f30f6c0b24236919cbaee21565eee7fed007949a7fa6601118ef510
-  data.tar.gz: df05bfcd3ba233ef8a64e743fcb40c9948caeb1a82039340ae6cb24a839b2cab08044da8009f91196bf444b0b960cbcc29bd2fe9b08f8f3ac003f2757ad5d320
+  metadata.gz: c64276706dd59404d3dc19370dc5b85a8390b60d80f6c781826d6417db086c445051b28ce9b85511da071da4d1c5172f7c4703e2782298f09a2e271399ee7a3f
+  data.tar.gz: 19c9919c468fd33bcabf84877b429e631ffdffa1fe3e8b2cbf3319d8b894ffdf3e3db830549f5fa39a57b8745aa9d37d6f691fd9feeb0f4cc2a0a2538f6b5d24

data/.circleci/config.yml

@@ -58,21 +58,21 @@ jobs:
           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.2:
-    docker:
-      - image: circleci/ruby:2.2.10
-    <<: *test_build
   ruby-2.3:
     docker:
-      - image: circleci/ruby:2.3.7
+      - image: circleci/ruby:2.3
     <<: *test_build
   ruby-2.4:
     docker:
-      - image: circleci/ruby:2.4.4
+      - image: circleci/ruby:2.4
     <<: *test_build
   ruby-2.5:
     docker:
-      - image: circleci/ruby:2.5.1
+      - image: circleci/ruby:2.5
+    <<: *test_build
+  ruby-2.6:
+    docker:
+      - image: circleci/ruby:2.6
     <<: *test_build
   rubocop:
     <<: *basic_build
@@ -111,25 +111,25 @@ workflows:
           filters:
             tags:
               only: /.*/
-      - ruby-2.2:
+      - ruby-2.3:
           filters:
             tags:
               only: /.*/
           requires:
             - build
-      - ruby-2.3:
+      - ruby-2.4:
           filters:
             tags:
               only: /.*/
           requires:
             - build
-      - ruby-2.4:
+      - ruby-2.5:
           filters:
             tags:
               only: /.*/
           requires:
             - build
-      - ruby-2.5:
+      - ruby-2.6:
           filters:
             tags:
               only: /.*/
@@ -140,10 +140,10 @@ workflows:
             tags:
               only: /.*/
           requires:
-            - ruby-2.2
             - ruby-2.3
             - ruby-2.4
             - ruby-2.5
+            - ruby-2.6
       - push-to-rubygems:
           filters:
             tags:
@@ -152,7 +152,7 @@ workflows:
               ignore: /.*/
           requires:
             - rubocop
-            - ruby-2.2
             - ruby-2.3
             - ruby-2.4
             - ruby-2.5
+            - ruby-2.6

data/.codeclimate.yml

@@ -2,5 +2,3 @@ engines:
   rubocop:
     enabled: true
     channel: rubocop-0-57
-    config:
-      file: rubocop.yml

data/Appraisals

@@ -24,6 +24,16 @@ appraise 'rails52' do
   gem 'rails', '~> 5.2.0'
 end
 
+if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.5.0')
+  appraise 'rails60' do
+    gem 'rails', '~> 6.0.0'
+  end
+
+  appraise 'sidekiq6' do
+    gem 'sidekiq', '~> 6.0'
+  end
+end
+
 appraise 'sidekiq51' do
   gem 'sidekiq', '~> 5.1.0'
 end

data/CHANGELOG.md

@@ -4,6 +4,30 @@ 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.2] - 2020-10-21
+### Fixed
+- Support for sidekiq 6
+
+## [2.5.1] - 2020-01-02
+### Fixed
+- Fixed a long standing bug that would mask exceptions raised by the host application when serving requests. The original exception would be replaced with a `TypeError` one due to a HTTP status code not being available within `Loga::Rack::Logger`.
+
+## [2.5.0] - 2019-11-12
+### Added
+- Add support for rails 6
+
+## [2.4.0] - 2019-09-03
+### Fixed
+- `duration` in the `sidekiq` integration is now calculated correctly
+### Added
+- Add build for ruby 2.6
+### Removed
+- Remove build for ruby 2.2
+
+## [2.3.1] - 2019-05-14
+### Added
+New configuration option `hide_pii` which defaults to `true` to hide email addresses in logs that get generate when an email is sent through action_mailer
+
 ## [2.3.0] - 2018-06-29
 ### Added
 Support for Sidekiq `~> 5.0`.

data/Gemfile

@@ -4,5 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'simplecov'
+  gem 'simplecov', '~> 0.17.0'
 end

data/gemfiles/rails60.gemfile

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

data/gemfiles/sidekiq6.gemfile

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

data/lib/loga/configuration.rb

@@ -15,9 +15,10 @@ module Loga
     ].freeze
 
     attr_accessor :device, :filter_exceptions, :filter_parameters,
-                  :host, :level, :service_version, :sync, :tags
+                  :host, :level, :service_version, :sync, :tags, :hide_pii
     attr_reader :logger, :format, :service_name
 
+    # rubocop:disable Metrics/MethodLength
     def initialize(user_options = {}, framework_options = {})
       options = default_options.merge(framework_options)
                                .merge(environment_options)
@@ -33,11 +34,13 @@ module Loga
       self.service_version   = options[:service_version] || ServiceVersionStrategies.call
       self.sync              = options[:sync]
       self.tags              = options[:tags]
+      self.hide_pii          = options[:hide_pii]
 
       validate
 
       @logger = initialize_logger
     end
+    # rubocop:enable Metrics/MethodLength
 
     def format=(name)
       @format = name.to_s.to_sym
@@ -68,6 +71,7 @@ module Loga
         level:             :info,
         sync:              true,
         tags:              [],
+        hide_pii:          true,
       }
     end
 

data/lib/loga/log_subscribers/action_mailer.rb

@@ -9,7 +9,11 @@ module Loga
         recipients = event.payload[:to].join(',')
         unique_id  = event.payload[:unique_id]
         duration   = event.duration.round(1)
-        message = "#{mailer}: Sent mail to #{recipients} in (#{duration}ms)"
+        message    = ''.tap do |string|
+          string << "#{mailer}: Sent mail"
+          string << " to #{recipients}" unless hide_pii?
+          string << " in (#{duration}ms)"
+        end
 
         loga_event = Event.new(
           data: { mailer: mailer, unique_id: unique_id },
@@ -41,10 +45,15 @@ module Loga
         from      = event.payload[:from]
         mailer    = event.payload[:mailer]
         unique_id = event.payload[:unique_id]
+        message   = ''.tap do |string|
+          string << 'Received mail'
+          string << " from #{from}" unless hide_pii?
+          string << " in (#{event.duration.round(1)}ms)"
+        end
 
         loga_event = Event.new(
           data: { mailer: mailer, unique_id: unique_id },
-          message: "Received mail #{from} in (#{event.duration.round(1)}ms)",
+          message: message,
           type: 'action_mailer',
         )
 
@@ -54,6 +63,10 @@ module Loga
       def logger
         Loga.logger
       end
+
+      def hide_pii?
+        Loga.configuration.hide_pii
+      end
     end
   end
 end

data/lib/loga/rack/logger.rb

@@ -44,6 +44,9 @@ module Loga
         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
 

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

data/lib/loga/sidekiq.rb

@@ -10,7 +10,7 @@ module Loga
         config.options[:job_logger] = Loga::Sidekiq::JobLogger
       end
 
-      ::Sidekiq::Logging.logger = Loga.configuration.logger
+      ::Sidekiq.logger = Loga.configuration.logger
     end
   end
 end

data/lib/loga/sidekiq/job_logger.rb

@@ -9,14 +9,16 @@ module Loga
 
       EVENT_TYPE = 'sidekiq'.freeze
 
-      attr_reader :started_at, :data
+      def started_at
+        @started_at ||= Time.now
+      end
 
-      def initialize
-        @started_at = Time.now
-        @data = {}
+      def data
+        @data ||= {}
       end
 
       def call(item, _queue)
+        reset_data
         yield
       rescue Exception => ex # rubocop:disable Lint/RescueException
         data['exception'] = ex
@@ -29,6 +31,11 @@ module Loga
 
       private
 
+      def reset_data
+        @data = {}
+        @started_at = Time.now
+      end
+
       def assign_data(item)
         data['created_at']  = item['created_at']
         data['enqueued_at'] = item['enqueued_at']

data/lib/loga/version.rb

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

data/spec/fixtures/rails60.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: '_rails60_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

@@ -44,7 +44,7 @@ RSpec.describe Loga::LogSubscribers::ActionMailer, if: Rails.env.production? do
     it 'has the proper payload for message delivery' do
       FakeMailer.send_email
 
-      message_pattern = /^FakeMailer: Sent mail to user@example.com in \(*/
+      message_pattern = /^FakeMailer: Sent mail \(*/
       expect(last_log_entry['short_message']).to match(message_pattern)
     end
 

data/spec/integration/sidekiq_spec.rb

@@ -21,9 +21,9 @@ end
 describe 'Sidekiq client logger' do
   let(:target) { StringIO.new }
 
-  let(:json_line) do
+  def read_json_log(line:)
     target.rewind
-    JSON.parse(target.read)
+    JSON.parse(target.each_line.drop(line - 1).first)
   end
 
   before do
@@ -45,10 +45,6 @@ describe 'Sidekiq client logger' do
     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
@@ -67,6 +63,10 @@ describe 'Sidekiq client logger' do
   end
 
   if ENV['BUNDLE_GEMFILE'] =~ /sidekiq51/
+    it 'has the proper logger Sidekiq::Logging.logger' do
+      expect(Sidekiq::Logging.logger).to eq Loga.logger
+    end
+
     # https://github.com/mperham/sidekiq/blob/97363210b47a4f8a1d8c1233aaa059d6643f5040/test/test_actors.rb#L57-L79
     let(:mgr) do
       Class.new do
@@ -117,6 +117,8 @@ describe 'Sidekiq client logger' do
         'version'=> '1.1',
       }
 
+      json_line = read_json_log(line: 1)
+
       aggregate_failures do
         expect(json_line).to include(expected_attributes)
 
@@ -126,6 +128,20 @@ describe 'Sidekiq client logger' do
 
         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

data/spec/unit/loga/log_subscribers/action_mailer_spec.rb

@@ -24,11 +24,34 @@ RSpec.describe Loga::LogSubscribers::ActionMailer do
           to:     ['user@example.com'],
         }
       end
+      let(:config) { instance_double Loga::Configuration, hide_pii: hide_pii }
 
-      it 'logs an info message' do
+      before do
         allow(Loga.logger).to receive(:info)
-        mailer.deliver(event)
-        expect(Loga.logger).to have_received(:info).with(kind_of(Loga::Event))
+        allow(Loga).to receive(:configuration).and_return(config)
+      end
+
+      context 'when configuration hide_pii is true' do
+        let(:hide_pii) { true }
+
+        it 'logs an info message' do
+          mailer.deliver(event)
+          expect(Loga.logger).to have_received(:info).with(Loga::Event) do |event|
+            expect(event.message).to include('FakeMailer: Sent mail')
+            expect(event.message).not_to include('user@example.com')
+          end
+        end
+      end
+
+      context 'when configuration option hide_pii is false' do
+        let(:hide_pii) { false }
+
+        it 'logs an info message' do
+          mailer.deliver(event)
+          expect(Loga.logger).to have_received(:info).with(Loga::Event) do |event|
+            expect(event.message).to include('FakeMailer: Sent mail to user@example.com')
+          end
+        end
       end
     end
   end
@@ -45,7 +68,12 @@ RSpec.describe Loga::LogSubscribers::ActionMailer do
       it 'logs an info message' do
         allow(Loga.logger).to receive(:debug)
         mailer.process(event)
-        expect(Loga.logger).to have_received(:debug).with(kind_of(Loga::Event))
+        expect(Loga.logger).to have_received(:debug)
+          .with(kind_of(Loga::Event)) do |event|
+            expect(event.message).to include(
+              'FakeMailer#hello_world: Processed outbound mail',
+            )
+          end
       end
     end
   end
@@ -59,11 +87,38 @@ RSpec.describe Loga::LogSubscribers::ActionMailer do
           subject: 'Lorem ipsum',
         }
       end
+      let(:config) { instance_double Loga::Configuration, hide_pii: hide_pii }
 
-      it 'logs an info message' do
+      before do
         allow(Loga.logger).to receive(:info)
-        mailer.receive(event)
-        expect(Loga.logger).to have_received(:info).with(kind_of(Loga::Event))
+        allow(Loga).to receive(:configuration).and_return(config)
+      end
+
+      context 'when configuration hide_pii is true' do
+        let(:hide_pii) { true }
+
+        it 'logs an info message without email' do
+          mailer.receive(event)
+          expect(Loga.logger).to have_received(:info)
+            .with(kind_of(Loga::Event)) do |event|
+              expect(event.message).to include('Received mail')
+              expect(event.message).not_to include('loremipsum@example.com')
+            end
+        end
+      end
+
+      context 'when configuration option hide_pii is false' do
+        let(:hide_pii) { false }
+
+        it 'logs an info message with email' do
+          mailer.receive(event)
+          expect(Loga.logger).to have_received(:info)
+            .with(kind_of(Loga::Event)) do |event|
+              expect(event.message).to include(
+                'Received mail from loremipsum@example.com',
+              )
+            end
+        end
       end
     end
   end

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

@@ -65,12 +65,13 @@ 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 } }
+      let(:app) {  ->(_env) { raise exception_class } }
 
       it 'does not rescue the exception' do
-        expect { subject.call(env) }.to raise_error(StandardError)
+        expect { subject.call(env) }.to raise_error(exception_class)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loga
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.2
 platform: ruby
 authors:
 - Funding Circle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-02 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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
@@ -290,6 +292,7 @@ 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
@@ -345,6 +348,7 @@ 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