grape_rails_logger 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1779ba966e376295939d488c527346f2ee0380d77b5f48471e6d5ba8e60683e3
-  data.tar.gz: bceef6b5f6f3be3a7db4c2a256e52ccbd0170ab6bee98314480778e5d1a5bb77
+  metadata.gz: 1309874132392d9a8663be8cdbcb56a4ce095d1e99773ba1ec520e8efa1f85e3
+  data.tar.gz: c831b29fd58a6a7128c351ea6cc99031a3ef24129c57d1ec03620fcd92628ba9
 SHA512:
-  metadata.gz: 01aed9f8207e56efd5ae7dcc35d61e29a037bc8792503cd6624f891d7a20c5a6139d620e24579d508d45d5b3961940646ca99b47149592ee5fc7af4a0feafdb2
-  data.tar.gz: 8b89335e9415219f6cfdecd6d07c579064fd890cc483beaa537fd0529e4c1cfe839036fe6bef6c2ffbd21e4059650c42188c80634e95c7316415e225bf63cbcb
+  metadata.gz: 739fb2ea500a4dcd09361b109a6c40812c4b986ab4025892d9413460f63eb92f62c28b57537337a4eacbb0b783a79a224ea47f281623d5452c0f2fcbd30ed839
+  data.tar.gz: 20a22a11f028bf57eaeb8463906ecc5628baa59e8a059a58099b94a5ef5a4bc0a72b23187d115b06f572c86a17952ce8d9e45d979b4dd28d422c3af2b947031a

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 1.2.4 (2026-11-07)
+
+- Cache `ActiveSupport::ParameterFilter` (and legacy `ParameterFilter`) per `filter_parameters` configuration
+- Use shallow param copy for flat hashes before in-place filtering; keep `deep_dup` when nested structures are present
+- Speed request log build: `nested_param_structure?` fast path, frozen downcased filter tokens, `PARAM_EXCEPTIONS` hash lookup, local `payload` in `build_log_data`
+- In `Timings.record_sql_notification`, derive duration from notification args without allocating `Event` when the payload matches the usual five-argument AS::Notifications shape
+
 ## 1.2.3 (2026-11-03)
 
 - Keep tracing and request instrumentation from dispatching a failed request more than once

data/README.md

@@ -1,15 +1,9 @@
 # grape_rails_logger
 
-[![Gem Version](https://badge.fury.io/rb/grape_rails_logger.svg?v=1.2.3)](https://badge.fury.io/rb/grape_rails_logger) [![Test Status](https://github.com/amkisko/grape_rails_logger.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/grape_rails_logger.rb/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/amkisko/grape_rails_logger.rb/graph/badge.svg?token=RC5T0Y2Z5A)](https://app.codecov.io/github/amkisko/grape_rails_logger.rb)
+[![Gem Version](https://badge.fury.io/rb/grape_rails_logger.svg?v=1.2.4)](https://badge.fury.io/rb/grape_rails_logger) [![Test Status](https://github.com/amkisko/grape_rails_logger.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/grape_rails_logger.rb/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/amkisko/grape_rails_logger.rb/graph/badge.svg?token=RC5T0Y2Z5A)](https://app.codecov.io/github/amkisko/grape_rails_logger.rb)
 
 Rails-compatible structured logging for Grape APIs with ActiveRecord timing, parameter filtering, and exception tracking.
 
-Sponsored by [Kisko Labs](https://www.kiskolabs.com).
-
-<a href="https://www.kiskolabs.com">
-  <img src="kisko.svg" width="200" alt="Sponsored by Kisko Labs" />
-</a>
-
 ## Installation
 
 Add to your Gemfile:
@@ -120,3 +114,11 @@ usr/bin/release.rb
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Sponsors
+
+Sponsored by [Kisko Labs](https://www.kiskolabs.com).
+
+<a href="https://www.kiskolabs.com">
+  <img src="kisko.svg" width="200" alt="Sponsored by Kisko Labs" />
+</a>

data/lib/grape_rails_logger/subscriber.rb

@@ -7,6 +7,9 @@ module GrapeRailsLogger
   # This class is designed to be exception-safe: any error in logging
   # is caught and logged separately, never breaking the request flow.
   class GrapeRequestLogSubscriber
+    API_ENDPOINT_ENV_KEY = Grape::Env::API_ENDPOINT
+    EMPTY_HASH = {}.freeze
+
     # Custom error class to distinguish logging errors from other errors
     class LoggingError < StandardError
       attr_reader :original_error
@@ -19,25 +22,33 @@ module GrapeRailsLogger
 
     # Key substrings aligned with Rails filter_parameters defaults (key-only; values pass through).
     FILTERED_PARAMS = %w[passw secret token _key crypt salt certificate otp ssn authorization].freeze
+    FILTERED_PARAMS_LOWER = FILTERED_PARAMS.map(&:downcase).freeze
     PARAM_EXCEPTIONS = %w[controller action format].freeze
+    PARAM_EXCEPTIONS_EXCLUDE = PARAM_EXCEPTIONS.each_with_object({}) { |k, h| h[k] = true }.freeze
+
+    def initialize
+      super
+      @parameter_filter_config = nil
+      @parameter_filter = nil
+    end
 
     def grape_request(event)
       return unless event.is_a?(ActiveSupport::Notifications::Event)
 
-      env = event.payload[:env]
+      payload = event.payload
+      env = payload[:env]
       return unless env.is_a?(Hash)
 
-      # Get logger from event payload (passed from middleware)
-      logger = event.payload[:logger]
+      logger = payload[:logger]
 
       logged_successfully = false
       begin
-        endpoint = env[Grape::Env::API_ENDPOINT] if env.is_a?(Hash)
+        endpoint = env[API_ENDPOINT_ENV_KEY]
         request = (endpoint&.respond_to?(:request) && endpoint.request) ? endpoint.request : nil
 
         data = build_log_data(event, request, env)
-        logged_successfully = log_data(data, event.payload[:exception_object], logger)
-        event.payload[:logged_successfully] = true if logged_successfully
+        logged_successfully = log_data(data, payload[:exception_object], logger)
+        payload[:logged_successfully] = true if logged_successfully
       rescue LoggingError
         # If logging itself failed, don't try to log again (would cause infinite loop or duplicates)
         # The error was already logged in safe_log's rescue block
@@ -60,18 +71,22 @@ module GrapeRailsLogger
     end
 
     def build_log_data(event, request, env)
-      db_runtime = event.payload[:db_runtime] || 0
-      db_calls = event.payload[:db_calls] || 0
+      payload = event.payload
+      db_runtime = payload[:db_runtime] || 0
+      db_calls = payload[:db_calls] || 0
       total_runtime = begin
         event.duration || 0
       rescue
         0
       end
 
-      status = extract_status(event) || (event.payload[:exception_object] ? 500 : 200)
+      exception_object = payload[:exception_object]
+      status = extract_status(event) || (exception_object ? 500 : 200)
       rails_request = rails_request_for(env)
       method = request ? safe_string(request.request_method) : safe_string(env["REQUEST_METHOD"])
       path = request ? safe_string(request.path) : safe_string(env["PATH_INFO"] || env["REQUEST_URI"])
+      duration_q = total_runtime.round(2)
+      db_q = db_runtime.round(2)
 
       {
         method: method,
@@ -84,9 +99,9 @@ module GrapeRailsLogger
         host: extract_host(rails_request, request),
         remote_addr: extract_remote_addr(rails_request, request),
         request_id: extract_request_id(rails_request, env),
-        duration: total_runtime.round(2),
-        db: db_runtime.round(2),
-        db_calls: db_calls,
+        duration: duration_q,
+        db: db_q,
+        db_calls: Integer(db_calls),
         params: filter_params(extract_params(request, env))
       }
     end
@@ -578,13 +593,13 @@ module GrapeRailsLogger
     end
 
     def extract_params(request, env = nil)
-      return {} unless env.is_a?(Hash)
+      return EMPTY_HASH unless env.is_a?(Hash)
 
-      endpoint = env[Grape::Env::API_ENDPOINT]
+      endpoint = env[API_ENDPOINT_ENV_KEY]
       return {} unless endpoint&.respond_to?(:request) && endpoint.request
 
       endpoint_params = endpoint.request.params
-      return {} if endpoint_params.blank?
+      return EMPTY_HASH if endpoint_params.blank?
 
       params_hash = if endpoint_params.respond_to?(:to_unsafe_h)
         endpoint_params.to_unsafe_h
@@ -728,22 +743,27 @@ module GrapeRailsLogger
     end
 
     def filter_params(params)
-      return {} unless params
+      return EMPTY_HASH unless params
       return {} unless params.is_a?(Hash)
 
       cleaned = if (filter = rails_parameter_filter)
         # Create a deep copy since filter modifies in place (Rails 6+)
-        params_copy = params.respond_to?(:deep_dup) ? params.deep_dup : params.dup
+        params_copy =
+          if nested_param_structure?(params)
+            params.respond_to?(:deep_dup) ? params.deep_dup : params.dup
+          else
+            params.dup
+          end
         filter.filter(params_copy)
       else
         filter_parameters_manually(params)
       end
 
-      cleaned.is_a?(Hash) ? cleaned.reject { |key, _| PARAM_EXCEPTIONS.include?(key.to_s) } : {}
+      cleaned.is_a?(Hash) ? cleaned.reject { |key, _| PARAM_EXCEPTIONS_EXCLUDE[key.to_s] } : {}
     rescue
       # Don't log - just fallback to manual filtering
       # Logging happens only in subscriber
-      filter_parameters_manually(params).reject { |key, _| PARAM_EXCEPTIONS.include?(key.to_s) }
+      filter_parameters_manually(params).reject { |key, _| PARAM_EXCEPTIONS_EXCLUDE[key.to_s] }
     end
 
     def rails_parameter_filter
@@ -754,14 +774,23 @@ module GrapeRailsLogger
       filter_parameters = Rails.application.config.filter_parameters
       return nil if filter_parameters.blank?
 
+      if filter_parameters.equal?(@parameter_filter_config) && @parameter_filter
+        return @parameter_filter
+      end
+
       # Prefer ActiveSupport::ParameterFilter (Rails 6.1+)
       # This is the Rails-native parameter filtering system
-      if defined?(ActiveSupport::ParameterFilter)
-        ActiveSupport::ParameterFilter.new(filter_parameters)
-      # Fall back to ActionDispatch::Http::ParameterFilter (Rails 6.0 and earlier)
-      elsif defined?(ActionDispatch::Http::ParameterFilter)
-        ActionDispatch::Http::ParameterFilter.new(filter_parameters)
-      end
+      built =
+        if defined?(ActiveSupport::ParameterFilter)
+          ActiveSupport::ParameterFilter.new(filter_parameters)
+        # Fall back to ActionDispatch::Http::ParameterFilter (Rails 6.0 and earlier)
+        elsif defined?(ActionDispatch::Http::ParameterFilter)
+          ActionDispatch::Http::ParameterFilter.new(filter_parameters)
+        end
+      return nil if built.nil?
+
+      @parameter_filter_config = filter_parameters
+      @parameter_filter = built
     rescue
       # Log but don't fail - fall back to manual filtering
       # Don't log - just return nil
@@ -769,6 +798,33 @@ module GrapeRailsLogger
       nil
     end
 
+    def nested_param_structure?(params)
+      return false unless params.is_a?(Hash)
+      return false if params.empty?
+
+      return true if params.any? { |_, v| v.is_a?(Hash) }
+
+      params.each_value do |value|
+        next unless value.is_a?(Array)
+
+        return true if value.any? { |el| el.is_a?(Hash) }
+      end
+
+      stack = [params]
+      until stack.empty?
+        h = stack.pop
+        h.each_value do |value|
+          case value
+          when Hash
+            return true
+          when Array
+            value.each { |el| stack.push(el) if el.is_a?(Hash) }
+          end
+        end
+      end
+      false
+    end
+
     def filter_parameters_manually(params, depth = 0)
       return {} unless params
       return {"[FILTERED]" => "[max_depth_exceeded]"} if depth > 10
@@ -799,8 +855,13 @@ module GrapeRailsLogger
     end
 
     def should_filter_key?(key)
-      key_lower = key.to_s.downcase
-      FILTERED_PARAMS.any? { |param| key_lower.include?(param.downcase) }
+      key_lower =
+        if key.is_a?(String)
+          key.downcase
+        else
+          key.to_s.downcase
+        end
+      FILTERED_PARAMS_LOWER.any? { |param| key_lower.include?(param) }
     end
   end
 end

data/lib/grape_rails_logger/timings.rb

@@ -15,7 +15,7 @@ module GrapeRailsLogger
 
     def self.reset_db_runtime
       state = execution_state
-      state[:grape_db_runtime] = 0
+      state[:grape_db_runtime] = 0.0
       state[:grape_db_calls] = 0
     end
 
@@ -41,19 +41,41 @@ module GrapeRailsLogger
       execution_state[:grape_db_calls] ||= 0
     end
 
-    def self.append_db_runtime(event)
+    def self.append_db_runtime(event_or_duration)
       state = execution_state
       return unless state[:grape_db_tracking]
 
-      state[:grape_db_runtime] = (state[:grape_db_runtime] || 0) + event.duration
+      duration =
+        if event_or_duration.is_a?(Numeric)
+          event_or_duration
+        else
+          event_or_duration.duration
+        end
+      duration = duration.to_f if duration.is_a?(Numeric)
+      state[:grape_db_runtime] = (state[:grape_db_runtime] || 0) + duration
       state[:grape_db_calls] = (state[:grape_db_calls] || 0) + 1
     end
 
     # Railtie SQL subscribe entry: skip Event allocation when no Grape request is tracked.
     def self.record_sql_notification(*args)
-      return unless grape_request_active?
+      state = execution_state
+      return unless state[:grape_db_tracking]
 
-      append_db_runtime(ActiveSupport::Notifications::Event.new(*args))
+      duration = sql_notification_duration(args)
+      append_db_runtime(duration.nil? ? ActiveSupport::Notifications::Event.new(*args) : duration)
+    end
+
+    def self.sql_notification_duration(args)
+      case args.length
+      when 5
+        d = args[2] - args[1]
+        d.is_a?(Numeric) ? d.to_f : d
+      when 1
+        arg = args.first
+        d = arg.duration if arg.respond_to?(:duration)
+        d.is_a?(Numeric) ? d.to_f : d
+      end
     end
+    private_class_method :sql_notification_duration
   end
 end

data/lib/grape_rails_logger/version.rb

@@ -1,3 +1,3 @@
 module GrapeRailsLogger
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

data/sig/grape_rails_logger.rbs

@@ -22,7 +22,7 @@ module GrapeRailsLogger
     def self.grape_request_active?: () -> bool
     def self.db_runtime: () -> Float
     def self.db_calls: () -> Integer
-    def self.append_db_runtime: (ActiveSupport::Notifications::Event event) -> void
+    def self.append_db_runtime: (ActiveSupport::Notifications::Event | Float | Integer event_or_duration) -> void
     def self.record_sql_notification: (*untyped args) -> void
   end
 
@@ -35,6 +35,8 @@ module GrapeRailsLogger
   end
 
   class GrapeRequestLogSubscriber
+    EMPTY_HASH: Hash[untyped, untyped]
+
     def initialize: () -> void
     def grape_request: (ActiveSupport::Notifications::Event event) -> void
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape_rails_logger
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Andrei Makarov
@@ -89,14 +89,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.2.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.2.9
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement