rails_api_logger 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eec005ade27407b2e826f07e25dfb756d8582a831b0f42e17fbb901886a846f0
-  data.tar.gz: 03571be34906628a5c0a4becfe39d699d8535b7dc3fe7d7b2b1bef27e6337d0c
+  metadata.gz: 4f1fb1fae010aa6cf4bdda941fd6ad2ce3ac5583faa690d23680194d2f3eb991
+  data.tar.gz: 0dd85cd48972098af775d7a5feec4d17b8aaaa51641e9a4405244d8ccdd12644
 SHA512:
-  metadata.gz: a61c04ed687aa6c48ac6c1e51de301ebcff658c574eea9db836a1ee343dac994b4fb87a8ef15dd666a415176ea181a6f150057c5ce5fb276d1ccc373844ba9cf
-  data.tar.gz: 7e7c35c31fe36d335a8b79a29fafb6f61934cc2c91dc9d05a3c891cb0c4909d49cb0a8bf4fea8301dddd744cea1d10523a143d6163267c3d8c2a9fe3071c0d75
+  metadata.gz: 4d310658b9bbae0d5406a8df1d7a85e11d161db8405ad970cb422fbd9ad38d2a95c251a8ba3f6acbe30089290b61d94ed8c8cd1b0e601fbbea6f8d2a111b7ae0
+  data.tar.gz: c3c29eaf30dbbb4548b3527ac7220193135a4ca0eb69b5f17b12e0ef88516b8aa91c1b8367dacd4a4ee5988c4722ba493c5e98a28ba7b5c61645db971c36bcdb

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.9.0
+* Add option skip_request_body to skip the request body. Use this option when you don't want to persist the request body. `[Skipped]` will be persisted instead.
+* Add option skip_request_body_regexp to skip logging the body of requests matching a regexp.
+* Renamed the option skip_body into skip_response_body. This is a breaking change!
+* Renamed the option skip_body_regexp into skip_response_body_regexp. This is a breaking change!
+
 # 0.8.1
 * Fix Rails 7.1 warnings.
 

data/README.md

@@ -128,10 +128,12 @@ If you want to log only requests on a certain path, you can pass a regular expre
 config.middleware.insert_before Rails::Rack::Logger, InboundRequestsLoggerMiddleware, path_regexp: /api/
 ```
 
-If you want to skip logging the body of certain requests, you can pass a regular expression:
+If you want to skip logging the response or request body of certain requests, you can pass a regular expression:
 
 ```ruby
-config.middleware.insert_before Rails::Rack::Logger, InboundRequestsLoggerMiddleware, skip_body_regexp: /api/letters/
+config.middleware.insert_before Rails::Rack::Logger, InboundRequestsLoggerMiddleware,
+                                skip_request_body_regexp: /api/books/,
+                                skip_response_body_regexp: /api/letters/
 ```
 
 

data/lib/rails_api_logger/inbound_requests_logger_middleware.rb

@@ -1,24 +1,32 @@
 class InboundRequestsLoggerMiddleware
-  attr_accessor :only_state_change, :path_regexp, :skip_body_regexp
+  attr_accessor :only_state_change, :path_regexp, :skip_request_body_regexp, :skip_response_body_regexp
 
-  def initialize(app, only_state_change: true, path_regexp: /.*/, skip_body_regexp: nil)
+  def initialize(app, only_state_change: true,
+    path_regexp: /.*/,
+    skip_request_body_regexp: nil,
+    skip_response_body_regexp: nil)
     @app = app
     self.only_state_change = only_state_change
     self.path_regexp = path_regexp
-    self.skip_body_regexp = skip_body_regexp
+    self.skip_request_body_regexp = skip_request_body_regexp
+    self.skip_response_body_regexp = skip_response_body_regexp
   end
 
   def call(env)
     request = ActionDispatch::Request.new(env)
     logging = log?(env, request)
     if logging
-      env["INBOUND_REQUEST_LOG"] = InboundRequestLog.from_request(request)
+      env["INBOUND_REQUEST_LOG"] = InboundRequestLog.from_request(request, skip_request_body: skip_request_body?(env))
       request.body.rewind
     end
     status, headers, body = @app.call(env)
     if logging
       updates = {response_code: status, ended_at: Time.current}
-      updates[:response_body] = parsed_body(body) if log_response_body?(env)
+      updates[:response_body] = if skip_response_body?(env)
+        "[Skipped]"
+      else
+        parsed_body(body)
+      end
       # this usually works. let's be optimistic.
       begin
         env["INBOUND_REQUEST_LOG"].update_columns(updates)
@@ -31,8 +39,12 @@ class InboundRequestsLoggerMiddleware
 
   private
 
-  def log_response_body?(env)
-    skip_body_regexp.nil? || env["PATH_INFO"] !~ skip_body_regexp
+  def skip_request_body?(env)
+    skip_request_body_regexp && env["PATH_INFO"] =~ skip_request_body_regexp
+  end
+
+  def skip_response_body?(env)
+    skip_response_body_regexp && env["PATH_INFO"] =~ skip_response_body_regexp
   end
 
   def log?(env, request)

data/lib/rails_api_logger/request_log.rb

@@ -11,20 +11,24 @@ class RequestLog < ActiveRecord::Base
   validates :method, presence: true
   validates :path, presence: true
 
-  def self.from_request(request, loggable: nil)
-    request_body = (request.body.respond_to?(:read) ? request.body.read : request.body)
-    body = request_body&.dup&.force_encoding("UTF-8")
-    begin
-      body = JSON.parse(body) if body.present?
-    rescue JSON::ParserError
-      body
+  def self.from_request(request, loggable: nil, skip_request_body: false)
+    if skip_request_body
+      body = "[Skipped]"
+    else
+      request_body = (request.body.respond_to?(:read) ? request.body.read : request.body)
+      body = request_body&.dup&.force_encoding("UTF-8")
+      begin
+        body = JSON.parse(body) if body.present?
+      rescue JSON::ParserError
+        body
+      end
     end
     create(path: request.path, request_body: body, method: request.method, started_at: Time.current, loggable: loggable)
   end
 
-  def from_response(response, skip_body: false)
+  def from_response(response, skip_response_body: false)
     self.response_code = response.code
-    self.response_body = skip_body ? "[Skipped]" : manipulate_body(response.body)
+    self.response_body = skip_response_body ? "[Skipped]" : manipulate_body(response.body)
     self
   end
 
@@ -37,7 +41,9 @@ class RequestLog < ActiveRecord::Base
   end
 
   def formatted_body(body)
-    if body.is_a?(Hash)
+    if body.is_a?(String) && body.blank?
+      ""
+    elsif body.is_a?(Hash)
       JSON.pretty_generate(body)
     else
       xml = Nokogiri::XML(body)

data/lib/rails_api_logger.rb

@@ -10,15 +10,16 @@ loader.setup
 class RailsApiLogger
   class Error < StandardError; end
 
-  def initialize(loggable = nil, skip_body: false)
+  def initialize(loggable = nil, skip_request_body: false, skip_response_body: false)
     @loggable = loggable
-    @skip_body = skip_body
+    @skip_request_body = skip_request_body
+    @skip_response_body = skip_response_body
   end
 
   def call(url, request)
-    log = OutboundRequestLog.from_request(request, loggable: @loggable)
+    log = OutboundRequestLog.from_request(request, loggable: @loggable, skip_request_body: @skip_request_body)
     yield.tap do |response|
-      log.from_response(response, skip_body: @skip_body)
+      log.from_response(response, skip_response_body: @skip_response_body)
     end
   rescue => e
     log.response_body = {error: e.message}

data/rails_api_logger.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "rails_api_logger"
-  spec.version = "0.8.2"
+  spec.version = "0.9.0"
   spec.authors = ["Alessandro Rodi"]
   spec.email = ["alessandro.rodi@renuo.ch"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_logger
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Alessandro Rodi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-27 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties