ree_lib 1.3.7 → 1.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22c9b3f24637ea89df5a633bb65b00165bdcf89193dc870cacd6521ead772c5a
-  data.tar.gz: fa3c84478540381ba0dba7046bf41dc472e3de75fed7bc99b53e78cddc14de4c
+  metadata.gz: 91fc8dfb82375a041a8174ecb6845cc67b808ff127789f7a0cfc7acf77dd070d
+  data.tar.gz: 9559a1c0ab2a12444b80321ffeee129104eb50e3ab18b1245190747eec34e168
 SHA512:
-  metadata.gz: 7f7c74ea3f1d7a72b9c61dc8ddf2291dc4493a863c89cbda641f42ffbb8a505b5fe7537cb2d39bb03c65fc805350a3d5788c68b77e5a86a05dbbc70061f077c3
-  data.tar.gz: 8ad1a702714b65592c6c37f932d22d86727263240faa64e3b23c48a2b330d7f2cfab37c162bdb8d9ad0edb0b9e004871f0ae266dbfc0d1097f4899239c31a5e7
+  metadata.gz: 043c917b9aedca9ead3eda2ebf43e1ad5404abf818b6a8aa63fc2827b677ad850785c4ebdb46b135e1f9967bb1cc66b04524b0124d6ea5218cabee98b348e90e
+  data.tar.gz: ca3d90247859cb1dde09162aa2e3479f6e9cacc038ea8b083bda2fa9704015314cce9b39154d639b0c60f9caf1f0268dd3c89bfc383e999f556b66193225ed64

data/Gemfile.lock

@@ -9,7 +9,7 @@ PATH
 PATH
   remote: .
   specs:
-    ree_lib (1.3.6)
+    ree_lib (1.3.8)
       bigdecimal
       binding_of_caller
       i18n

data/lib/ree_lib/packages/ree_roda/package/ree_roda/plugins/ree_logger.rb

@@ -11,14 +11,18 @@ class Roda
     module ReeLogger
       REE_LOGGER_DEFAULTS = {
         method: :info,
-        log_params: true
+        log_params: true,
+        filter_params: [],
+        filter_params_placeholder: '[FILTERED]'
       }
 
       def self.configure(app, **opts)
         opts = REE_LOGGER_DEFAULTS.merge(opts)
-        app.opts[:ree_logger] = ::ReeLogger::Logger.new
+        app.opts[:ree_logger] = opts[:ree_logger] || ::ReeLogger::Logger.new
         app.opts[:ree_logger_filter] = opts[:filter] if opts[:filter]
         app.opts[:ree_logger_log_params] = !!opts[:log_params]
+        app.opts[:ree_logger_filter_params] = opts[:filter_params].map(&:to_s)
+        app.opts[:ree_logger_filter_params_placeholder] = opts[:filter_params_placeholder]
       end
 
       def self.start_timer
@@ -46,7 +50,7 @@ class Roda
 
           message = <<~DOC
             Request/Response details:
-              Request: #{env["REQUEST_METHOD"]} #{env["QUERY_STRING"] && !env["QUERY_STRING"].empty? ? env["SCRIPT_NAME"].to_s + env["PATH_INFO"] + "?#{env["QUERY_STRING"]}": env["SCRIPT_NAME"].to_s + env["PATH_INFO"]} #{opts[:ree_logger_log_params] ? "\n  Params: " + request.params.inspect : ""}
+              Request: #{env["REQUEST_METHOD"]} #{env["QUERY_STRING"] && !env["QUERY_STRING"].empty? ? env["SCRIPT_NAME"].to_s + env["PATH_INFO"] + "?#{env["QUERY_STRING"]}": env["SCRIPT_NAME"].to_s + env["PATH_INFO"]} #{opts[:ree_logger_log_params] ? "\n  Params: " + _ree_logger_filtered_params.inspect : ""}
               Response status: #{response.status || "-"}#{(400..499).include?(response.status) ? "\n  Response body: " + response.body[0].to_s : ""}
               Time Taken: #{elapsed_time}
           DOC
@@ -54,6 +58,19 @@ class Roda
           opts[:ree_logger].info(message)
         end
 
+        def _ree_logger_filtered_params
+          params = request.params
+          filter_keys = opts[:ree_logger_filter_params]
+
+          return params if filter_keys.empty?
+
+          placeholder = opts[:ree_logger_filter_params_placeholder]
+
+          params.each_with_object({}) do |(k, v), h|
+            h[k] = filter_keys.include?(k.to_s) ? placeholder : v
+          end
+        end
+
         # Create timer instance used for timing
         def _roda_before_05__ree_logger
           @_request_timer = ReeLogger.start_timer

data/lib/ree_lib/packages/ree_roda/spec/ree_roda/plugins/ree_logger_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal = true
+
+package_require("ree_roda/plugins/ree_logger")
+
+RSpec.describe :ree_logger do
+  it "filters request params" do
+    class TestFilterApp < ReeRoda::App
+      route do |r|
+        r.get "health" do
+          "success"
+        end
+
+        r.ree_routes
+      end
+    end
+
+    env = { "REQUEST_METHOD" => "GET", "PATH_INFO" => "/health", "QUERY_STRING" => "email=test@example.com&password=password" }
+
+    class TestFilterLogger
+      def info(msg)
+        @logs ||= []
+        @logs << msg
+      end
+
+      def logs
+        @logs
+      end
+    end
+    logger = TestFilterLogger.new
+
+    TestFilterApp.plugin(:ree_logger, ree_logger: logger, filter_params: ['password'])
+    TestFilterApp.app.call(env)
+
+    expect(logger.logs.first).to match('"password" => "\[FILTERED\]"')
+  end
+end

data/lib/ree_lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReeLib
-  VERSION = "1.3.7"
+  VERSION = "1.3.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ree_lib
 version: !ruby/object:Gem::Version
-  version: 1.3.7
+  version: 1.3.8
 platform: ruby
 authors:
 - Ruslan Gatiyatov
@@ -891,6 +891,7 @@ files:
 - lib/ree_lib/packages/ree_roda/package/ree_roda/services/build_swagger_from_routes.rb
 - lib/ree_lib/packages/ree_roda/package/ree_roda/services/status_from_error.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/app_spec.rb
+- lib/ree_lib/packages/ree_roda/spec/ree_roda/plugins/ree_logger_spec.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/services/build_routing_tree_spec.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/services/build_swagger_from_routes_spec.rb
 - lib/ree_lib/packages/ree_roda/spec/ree_roda/services/locales/en.yml