pier_logging 0.2.4 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a68a14c994124359699bf1e907d76b47f06efe6f46d20bc2d68a13180b76ada8
-  data.tar.gz: 671bc7adb48ffb3d33e694c17b7dcd68f6a1743220bcd22ba74f7c9f933efa18
+  metadata.gz: a55ccf237c0b0f40cdc5a97c3b1409112de8343a8b1070f1b70d814ef4ed4dad
+  data.tar.gz: acd0969b17612d4f42d1c8229699c5176e2aa8ebfdf13a5fd8c07b64b94602d3
 SHA512:
-  metadata.gz: 72a2b35a68c812a341bf59dd24360ec0ed7b381f0873cc1d492e5507e4d7a7e527fe42f1d0b190afd8fcba3ca53a0e77bbc665bee224facb5c7abe2aa870962a
-  data.tar.gz: 4fdb6ae38a9aa3d68d7437e34f2264f44e2721d3dab531a04236a169e6ff471987fd40fecb8cadc4e1b2c156158ee275e19a0a05ff4b33f0729e397c464cd532
+  metadata.gz: 56f1b5ca14007773f0604a3bf8720f81f5950892120e260a9a7c6a9231680edf4ece11c5702714e29a07ccae6c9490d8b406a992c78af8e6c1e85a887fa05deb
+  data.tar.gz: 79c17490ba3109bdbce3a06dd8fa45f92b6537a350e274273d5856208b99f878e9d085d4d194f7c8b62490af5b051b568d1a9eb74552993bb55c0962815a92d0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pier_logging (0.1.7)
+    pier_logging (0.3.1)
       awesome_print
       facets
       ougai
@@ -10,135 +10,138 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.2)
-      actionpack (= 6.0.3.2)
+    actioncable (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activejob (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
-      activestorage (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionmailbox (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      actionview (= 6.0.3.2)
-      activejob (= 6.0.3.2)
+    actionmailer (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.2)
-      actionview (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
-      activestorage (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actiontext (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    activejob (6.1.3.1)
+      activesupport (= 6.1.3.1)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activestorage (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activejob (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
-      marcel (~> 0.3.1)
-    activesupport (6.0.3.2)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activestorage (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    awesome_print (1.8.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    awesome_print (1.9.2)
     builder (3.2.4)
     byebug (11.1.3)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.8)
     crass (1.0.6)
-    erubi (1.9.0)
+    erubi (1.10.0)
     facets (3.1.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.3)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.9.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.1)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
-    nio4r (2.5.2)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    oj (3.10.6)
-    ougai (1.8.5)
+    mini_mime (1.0.3)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    oj (3.11.3)
+    ougai (2.0.0)
       oj (~> 3.10)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3.2)
-      actioncable (= 6.0.3.2)
-      actionmailbox (= 6.0.3.2)
-      actionmailer (= 6.0.3.2)
-      actionpack (= 6.0.3.2)
-      actiontext (= 6.0.3.2)
-      actionview (= 6.0.3.2)
-      activejob (= 6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
-      activestorage (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-      bundler (>= 1.3.0)
-      railties (= 6.0.3.2)
+    rails (6.1.3.1)
+      actioncable (= 6.1.3.1)
+      actionmailbox (= 6.1.3.1)
+      actionmailer (= 6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actiontext (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    railties (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rake (13.0.1)
+      thor (~> 1.0)
+    rake (13.0.3)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    websocket-driver (0.7.2)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.3.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/lib/pier_logging.rb

@@ -54,13 +54,15 @@ module PierLogging
   end
 
   class RequestLoggerConfiguration
-    attr_reader :enabled, :user_info_getter, :hide_response_body_for_paths, 
-                :log_response, :hide_request_headers, :correlation_id_getter
+    attr_reader :enabled, :user_info_getter, :hide_request_body_for_paths, :hide_response_body_for_paths, 
+                :log_request_body, :log_response, :hide_request_headers, :correlation_id_getter
 
     def initialize
       @user_info_getter = ->(_ = nil) { nil }
       @enabled = false
+      @hide_request_body_for_paths = nil
       @hide_response_body_for_paths = nil
+      @log_request_body = true
       @log_response = true
       @hide_request_headers = nil
       @correlation_id_getter = ->(_ = nil, _ = nil) { nil }
@@ -71,11 +73,24 @@ module PierLogging
       @user_info_getter = proc
     end
 
+    def log_request_body=(log_request_body)
+      raise ArgumentError, "Config 'log_request_body' must be a 'boolean'" unless !!log_request_body == log_request_body
+      @log_request_body = log_request_body
+    end
+
     def log_response=(log_response)
       raise ArgumentError, "Config 'log_response' must be a 'boolean'" unless !!log_response == log_response
       @log_response = log_response
     end
 
+    def hide_request_body_for_paths=(hide_request_body_for_paths)
+      unless (hide_request_body_for_paths.is_a? Array) && (hide_request_body_for_paths.all?{|item| item.is_a? Regexp})
+        raise ArgumentError, "Config 'hide_request_body_for_paths' must be an 'Array of Regexps'" 
+      end
+      
+      @hide_request_body_for_paths = hide_request_body_for_paths
+    end
+
     def hide_response_body_for_paths=(hide_response_body_for_paths)
       unless (hide_response_body_for_paths.is_a? Array) && (hide_response_body_for_paths.all?{|item| item.is_a? Regexp})
         raise ArgumentError, "Config 'hide_response_body_for_paths' must be an 'Array of Regexps'" 

data/lib/pier_logging/logger.rb

@@ -2,7 +2,7 @@
 module PierLogging
   class Logger < Ougai::Logger
     include ActiveSupport::LoggerThreadSafeLevel
-    include LoggerSilence
+    include ActiveSupport::LoggerSilence if defined?(ActiveSupport::LoggerSilence)
 
     def initialize(*args)
       super

data/lib/pier_logging/request_logger.rb

@@ -44,7 +44,7 @@ module PierLogging
       env, status, type, body, starts_at, ends_at, _ = args
       request = Rack::Request.new(env)
       request_headers = get_request_headers_from_env(env)
-      logger.info redact_hash({
+      logger.info redact_object({
         message: build_message_from_request(request),
         type: 'http',
         duration: ((ends_at - starts_at)*1000).to_i,
@@ -56,7 +56,8 @@ module PierLogging
         request: {
           headers: request_headers,
           href: request.url,
-          body: parse_body(request.body)
+          query_string: request.query_string,
+          body: request_body(request.path, request.body)
         },
         response: {
           status: status,
@@ -77,16 +78,25 @@ module PierLogging
       headers = env.select { |k,v| k[0..4] == 'HTTP_'}.
         transform_keys { |k| k[5..-1].split('_').join('-').upcase }
       
-      return redact_hash(headers, hide_request_headers, nil) if hide_request_headers.present?
+      return redact_object(headers, hide_request_headers, nil) if hide_request_headers.present?
 
       headers
     end
 
+    def request_body(request_path, body)
+      return nil unless PierLogging.request_logger_configuration.log_request_body
+
+      hide_request_body_for_paths = PierLogging.request_logger_configuration.hide_request_body_for_paths
+      return nil if hide_request_body_for_paths&.any?{ |path|request_path =~ path }
+
+      parse_body(body)
+    end
+    
     def response_body(request_path, body)
       return nil unless PierLogging.request_logger_configuration.log_response
       
       hide_response_body_for_paths = PierLogging.request_logger_configuration.hide_response_body_for_paths
-      return nil if hide_response_body_for_paths && hide_response_body_for_paths.any?{ |path|request_path =~ path }
+      return nil if hide_response_body_for_paths&.any?{ |path|request_path =~ path }
       
       parse_body(body)
     end
@@ -119,13 +129,35 @@ module PierLogging
       body
     end
 
+    def redact_object(obj, replace_keys = REDACT_REPLACE_KEYS, replace_by = REDACT_REPLACE_BY)
+      if obj === Array
+        redact_array(obj, replace_keys, replace_by)
+      elsif obj === Hash
+        redact_hash(obj, replace_keys, replace_by)
+      elsif obj.respond_to?(:to_hash)
+        redact_hash(obj.to_hash, replace_keys, replace_by)
+      else
+        obj
+      end
+    end
+    
+    def redact_array(arr, replace_keys = REDACT_REPLACE_KEYS, replace_by = REDACT_REPLACE_BY)
+      raise StandardError, 'Could not redact_array for non-array objects' unless arr.is_a? Array
+      arr.map { |el| redact_object(el, replace_keys, replace_by) }
+    end
+    
     def redact_hash(hash, replace_keys = REDACT_REPLACE_KEYS, replace_by = REDACT_REPLACE_BY)
-      hash.traverse do |k,v| 
+      raise StandardError, 'Could not redact_hash for non-hash objects' unless hash.is_a? Hash
+      hash.traverse do |k,v|
         should_redact = replace_keys.any?{ |regex| k =~regex }
         if (should_redact)
           [k, replace_by]
         else
-          [k, v]
+          case v
+          when Array then [k, redact_array(v, replace_keys, replace_by)]
+          else 
+            [k, v]
+          end
         end
       end
     end

data/lib/pier_logging/version.rb

@@ -1,3 +1,3 @@
 module PierLogging
-  VERSION = "0.2.4"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pier_logging
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.3
 platform: ruby
 authors:
 - Mauricio Banduk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ougai