rails_api_logger 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a81b65d48bd11340944d7d656808134a8f6ba51d6a8b9a16997e22d68cea2781
-  data.tar.gz: b4fe1ffa4236a408177b46346e0491f425e085d22c7e89791ebeb7068ea04f7f
+  metadata.gz: b99069d517d5cd82e5e073121ebb94306335c052644115cc56765a0a3c166447
+  data.tar.gz: bfac0a6e391ff5c1e29e481e313c47419a6b6f4835871e9f12624638b38d497e
 SHA512:
-  metadata.gz: cb5a895c1c041f879a7602cfc03d1282146dbd140a2fc6bb48a14c34d682f3e1b99ea887a1aabc75dc764a889e02a9bb6c27d770ae5e048987f114fe9deafe2d
-  data.tar.gz: cb631dc32ff4f8595d7953440f27e1600d35f2bc84bff7f5bf3c58171fc6aff2831a1a30cad39ceba14dcd4da40a070d89b459a714ba39955e7c11af07eb31cf
+  metadata.gz: 3b97315feb5e4792465a85819c829d33733a854fe77a9af907935058eb468c44829f524a29fb6c969cef6efe342903bcd6384989720bd54180f274fbde2bb0c7
+  data.tar.gz: 7139532155a71e2f9d068438164425acebb9f5bb6825f6fbdac0a5f0d0b0f58204dd824b7dcfd474776133b2c4e616a6b7834bd40a94f6500d845c885d45f326

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+3.2.1

data/.semaphore/semaphore.yml

@@ -21,6 +21,7 @@ blocks:
           - cache restore
           - bundle config set path 'vendor/bundle'
           - bundle install -j 4
+          - sem-service start postgres 14 --username=semaphore
           - cache store
       jobs:
         - name: tests

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.7.0
+* Fix an issue in the middleware where the request body was not read correctly if there were encoding issues.
+* Improved documentation about outboud request logging.
+* Add option skip_body_regexp to skip logging the body of requests matching a regexp.
+
 # 0.6.3
 * Fix the CHANGELOG path in gemspec.
 

data/README.md

@@ -71,34 +71,67 @@ log.save!
 You can also use the provided logger class to do that in a simpler and safer manner:
 
 ```ruby
-uri = URI('http://example.com/some_path?query=string')
-http = Net::HTTP.new(uri.host, uri.port)
-request = Net::HTTP::Get.new(uri)
-response = RailsApiLogger.new.call(uri, request) { http.start { |http| http.request(request) } }
+uri = URI('https://example.com/some_path')
+request = Net::HTTP::Post.new(uri)
+request.body = { answer: 42 }.to_json
+request.content_type = 'application/json'
+
+response = RailsApiLogger.new.call(nil, request) do
+  Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }
+end
 ``` 
 
 This will guarantee that the log is always persisted, even in case of errors.
 
+### Database Transactions Caveats
+
+If you log your outbound requests inside of parent app transactions, your logs will not be persisted if
+the transaction is rolled-back. You can circumvent that by opening another database connection
+to the same (or another database if you're into that stuff) when logging.
+
+```
+# config/initializers/outbound_request_log_patch.rb
+
+module OutboundRequestLogTransactionPatch
+  extend ActiveSupport::Concern
+
+  included do
+    connects_to database: { writing: :primary, reading: :primary }
+  end
+end
+
+OutboundRequestLog.include(OutboundRequestLogTransactionPatch)
+```
+
+another way to do the same is to start a new thread to log the request. 
+See the [linked test for an example](https://github.com/renuo/rails_api_logger/blob/main/spec/outbound_request_log_spec.rb:15)
+
 ## Log Inbound Requests
 
 If you are exposing some API you might be interested in logging the requests you receive.
 You can do so by adding this middleware in `config/application.rb`
 
 ```ruby
-config.middleware.insert_before Rails::Rack::Logger, InboundRequestLoggerMiddleware
+config.middleware.insert_before Rails::Rack::Logger, InboundRequestsLoggerMiddleware
 ``` 
 
 this will by default only log requests that have an impact in your system (POST, PUT, and PATCH calls).
 If you want to log all requests (also GET ones) use
 
 ```ruby
-config.middleware.insert_before Rails::Rack::Logger, InboundRequestLoggerMiddleware, only_state_change: false
+config.middleware.insert_before Rails::Rack::Logger, InboundRequestsLoggerMiddleware, only_state_change: false
 ```
 
 If you want to log only requests on a certain path, you can pass a regular expression:
 
 ```ruby
-config.middleware.insert_before Rails::Rack::Logger, InboundRequestLoggerMiddleware, path_regexp: /api/
+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:
+
+```ruby
+config.middleware.insert_before Rails::Rack::Logger, InboundRequestsLoggerMiddleware, skip_body_regexp: /api/letters/
 ```
 
 
@@ -106,7 +139,6 @@ In the implementation of your API, you can call any time `attach_inbound_request
 to attach an already persisted model to the log record.
 
 
-
 For example:
 ```ruby
 
@@ -170,6 +202,7 @@ This configuration will give you some nice views, and searches to work with the
 end
 ```
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rails_api_logger/inbound_requests_logger.rb

@@ -4,6 +4,7 @@ module InboundRequestsLogger
   private
 
   def attach_inbound_request_loggable(loggable)
+    return unless request.env["INBOUND_REQUEST_LOG"].present?
     request.env["INBOUND_REQUEST_LOG"].update(loggable: loggable) if loggable&.persisted?
   end
 end

data/lib/rails_api_logger/inbound_requests_logger_middleware.rb

@@ -1,10 +1,11 @@
 class InboundRequestsLoggerMiddleware
-  attr_accessor :only_state_change, :path_regexp
+  attr_accessor :only_state_change, :path_regexp, :skip_body_regexp
 
-  def initialize(app, only_state_change: true, path_regexp: /.*/)
+  def initialize(app, only_state_change: true, path_regexp: /.*/, skip_body_regexp: nil)
     @app = app
     self.only_state_change = only_state_change
     self.path_regexp = path_regexp
+    self.skip_body_regexp = skip_body_regexp
   end
 
   def call(env)
@@ -16,15 +17,24 @@ class InboundRequestsLoggerMiddleware
     end
     status, headers, body = @app.call(env)
     if logging
-      env["INBOUND_REQUEST_LOG"].update_columns(response_body: parsed_body(body),
-                                                response_code: status,
-                                                ended_at: Time.current)
+      updates = {response_code: status, ended_at: Time.current}
+      updates[:response_body] = parsed_body(body) if log_response_body?(env)
+      # this usually works. let's be optimistic.
+      begin
+        env["INBOUND_REQUEST_LOG"].update_columns(updates)
+      rescue JSON::GeneratorError => _e # this can be raised by activerecord if the string is not UTF-8.
+        env["INBOUND_REQUEST_LOG"].update_columns(updates.except(:response_body))
+      end
     end
     [status, headers, body]
   end
 
   private
 
+  def log_response_body?(env)
+    skip_body_regexp.nil? || env["PATH_INFO"] !~ skip_body_regexp
+  end
+
   def log?(env, request)
     env["PATH_INFO"] =~ path_regexp && (!only_state_change || request_with_state_change?(request))
   end
@@ -39,7 +49,7 @@ class InboundRequestsLoggerMiddleware
     else
       body
     end
-  rescue JSON::ParserError
+  rescue JSON::ParserError, ArgumentError
     body
   end
 

data/lib/rails_api_logger/request_log.rb

@@ -6,14 +6,14 @@ class RequestLog < ActiveRecord::Base
 
   belongs_to :loggable, optional: true, polymorphic: true
 
-  scope :failed, -> { where.not(response_code: 200..299) }
+  scope :failed, -> { where(response_code: 400..599).or(where.not(ended_at: nil).where(response_code: nil)) }
 
   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 ? request_body.dup.force_encoding("UTF-8") : nil
+    body = request_body&.dup&.force_encoding("UTF-8")
     begin
       body = JSON.parse(body) if body.present?
     rescue JSON::ParserError
@@ -24,13 +24,14 @@ class RequestLog < ActiveRecord::Base
 
   def from_response(response)
     self.response_code = response.code
-    body = response.body ? response.body.dup.force_encoding("UTF-8") : nil
+    body = response.body&.dup&.force_encoding("UTF-8")
     begin
       body = JSON.parse(body) if body.present?
     rescue JSON::ParserError
       body
     end
     self.response_body = body
+    self
   end
 
   def formatted_request_body

data/rails_api_logger.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "rails_api_logger"
-  spec.version = "0.6.3"
+  spec.version = "0.7.0"
   spec.authors = ["Alessandro Rodi"]
   spec.email = ["alessandro.rodi@renuo.ch"]
 
@@ -30,7 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "zeitwerk", ">= 2.0.0"
 
   spec.add_development_dependency "sqlite3", "~> 1.4.0"
-  spec.add_development_dependency "standard", "~> 0.13.0"
+  spec.add_development_dependency "pg", "~> 1.5.4"
+  spec.add_development_dependency "standard", "~> 1.31"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rack"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_logger
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Alessandro Rodi
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2023-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -94,20 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.4
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.31'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.31'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -186,7 +200,7 @@ metadata:
   homepage_uri: https://github.com/renuo/rails_api_logger
   source_code_uri: https://github.com/renuo/rails_api_logger
   changelog_uri: https://github.com/renuo/rails_api_logger/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -201,8 +215,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.4.21
+signing_key:
 specification_version: 4
 summary: "Log API requests like a king \U0001F451"
 test_files: []