loga 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99d4525427d3cfa44d95be9d47f82188246743e71aab9f8d40489214e02e4c02
-  data.tar.gz: 33fc287f4ecabf93cdc6d789f81a040c64eb411d7a018459fa39c91ae03c46c8
+  metadata.gz: 9144c2b13cb8e6ed178d6ee24e99c9d00d4ce23bf3198d487e1803d221038874
+  data.tar.gz: 2528a6ce89a60dccc50e22f98abd1e4e74ae3f49319adeed42a89a98ad4412f8
 SHA512:
-  metadata.gz: 6ce2b115d84a4b3c1c93bf8070b0f3d7ed148df4eb1169ab57d8de2357ad03ea23c21fab2f30f6c0b24236919cbaee21565eee7fed007949a7fa6601118ef510
-  data.tar.gz: df05bfcd3ba233ef8a64e743fcb40c9948caeb1a82039340ae6cb24a839b2cab08044da8009f91196bf444b0b960cbcc29bd2fe9b08f8f3ac003f2757ad5d320
+  metadata.gz: 1d9b346f49a5661ab32f3cabe4a16edba7757aa5a5d10b830758d1ca12ff70ece723014701a5ba82da7d358736c320af4a91e7dee609ba657d200905b5afdb3f
+  data.tar.gz: e53c366b5efcb67136322cae79fa6f21fcfdbefd654cb982681067b02de0c86d02f678afe02b7e5c3db298024818ba06dd5ac4ad51f0c234ea799a906295782d

data/.codeclimate.yml

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

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.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/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/version.rb

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

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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loga
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Funding Circle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-02 00:00:00.000000000 Z
+date: 2019-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport