grape_rails_logger 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94417c5b83b15c0da840d88d8bdfeb896912ff28a57a876cd61adb64ad6a939b
-  data.tar.gz: 9d4b7e286d214e6cdd0237483a217a73b928dd3c19c6fc7ec9a568f9f734d559
+  metadata.gz: 1779ba966e376295939d488c527346f2ee0380d77b5f48471e6d5ba8e60683e3
+  data.tar.gz: bceef6b5f6f3be3a7db4c2a256e52ccbd0170ab6bee98314480778e5d1a5bb77
 SHA512:
-  metadata.gz: d11dc4b4774436c0d63b06a13232356b23e6334fc35e2c5a1a86ba4812678f841b4334d3d3bf8610deddeec30cbfbcc8bbabc774c73cda08f441d17520747d9b
-  data.tar.gz: 13e60517292321d0e3f70c9c1eff49db53934446c6495d55d6b556125eb5473cfe163ee338e6d636b03a9ab186637ef7105c0ca14aedd270d03d3bc1729f0a5c
+  metadata.gz: 01aed9f8207e56efd5ae7dcc35d61e29a037bc8792503cd6624f891d7a20c5a6139d620e24579d508d45d5b3961940646ca99b47149592ee5fc7af4a0feafdb2
+  data.tar.gz: 8b89335e9415219f6cfdecd6d07c579064fd890cc483beaa537fd0529e4c1cfe839036fe6bef6c2ffbd21e4059650c42188c80634e95c7316415e225bf63cbcb

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # CHANGELOG
 
+## 1.2.3 (2026-11-03)
+
+- Keep tracing and request instrumentation from dispatching a failed request more than once
+- Return false from `safe_log` / `log_data` when the logger write fails or no logger exists
+- Filter manual params by key only; expand key patterns toward Rails `filter_parameters` defaults
+- Prefer `#status` over `#to_a` when reading a non-Array Rack response status
+- Skip `ActiveSupport::Notifications::Event` allocation for SQL outside an active Grape request
+- Fail closed when release confirmation input reaches EOF
+- Require a CHANGELOG version heading before release; run tests on pull requests to `main`
+
+## 1.2.2 (2026-09-15)
+
+- Allow grape 4.x by expanding the runtime dependency to `< 5.0`
+- Keep request log action names when grape stores path and method on endpoint config instead of `options`
+
 ## 1.2.1 (2026-07-18)
 
 - Fix HTTP status in Grape request logs for exception subclasses of mapped error types

data/README.md

@@ -1,6 +1,6 @@
 # grape_rails_logger
 
-[![Gem Version](https://badge.fury.io/rb/grape_rails_logger.svg?v=1.1.0)](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.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)
 
 Rails-compatible structured logging for Grape APIs with ActiveRecord timing, parameter filtering, and exception tracking.
 
@@ -22,7 +22,7 @@ Run `bundle install` or `gem install grape_rails_logger`.
 
 ## Usage
 
-The gem works automatically in Rails applications. No configuration needed. It automatically patches `Grape::Endpoint#build_stack` to instrument requests and subscribes to `grape.request` notifications, logging structured data via `Rails.logger`. Works with any Rails logger or integrates with `activesupport-json_logging` for JSON output.
+In a Rails app, adding the gem is enough. The Railtie patches `Grape::Endpoint#build_stack`, subscribes to `grape.request`, and writes structured data through `Rails.logger`. Any Rails logger works; pair with `activesupport-json_logging` for JSON lines.
 
 ## What gets logged
 
@@ -30,7 +30,7 @@ Each request logs structured data with:
 - Request metadata: `method`, `path`, `status`, `duration`, `host`, `remote_addr`, `request_id`
 - Route information: `controller`, `action`, `source_location` (file:line)
 - Performance metrics: `duration` (ms), `db` (ActiveRecord query time in ms), `db_calls` (SQL query count)
-- Parameters: `params` (automatically filtered using Rails `filter_parameters`)
+- Parameters: `params` (filtered with Rails `filter_parameters`)
 - Exceptions: `exception` object with `class`, `message`, and `backtrace` (non-production only)
 
 ## Configuration
@@ -43,11 +43,11 @@ Rails.application.config.filter_parameters += [
 ]
 ```
 
-When Rails `ParameterFilter` is not available, the gem falls back to manual filtering that detects sensitive patterns (password, secret, token, key) in parameter keys.
+When Rails `ParameterFilter` is not available, the gem falls back to manual key filtering with patterns aligned to those defaults (`passw`, `secret`, `token`, `_key`, `crypt`, `salt`, `certificate`, `otp`, `ssn`, `authorization`).
 
 ## Debug tracing
 
-Optional `DebugTracer` middleware provides detailed request tracing when the `debug` gem is installed and `TRACE` environment variable is set:
+Optional `DebugTracer` middleware traces requests when the `debug` gem is present and `TRACE` is set:
 
 ```ruby
 class API < Grape::API
@@ -55,22 +55,22 @@ class API < Grape::API
 end
 ```
 
-Enable tracing: `TRACE=1 rails server`. The middleware gracefully degrades if the `debug` gem is not installed.
+Enable tracing: `TRACE=1 rails server`. Without the `debug` gem, the middleware does not start a tracer.
 
 ## Compatibility
 
-- Rails 6.0, 6.1, 7.0, 7.1, 7.2, 8.0+
-- Grape >= 1.6
-- Ruby >= 2.7
+- Rails 7.0, 7.1, 7.2, 8.0+
+- Grape >= 1.6, < 5.0
+- Ruby >= 3.4
 
-In Rails 7.1+, the gem uses `ActiveSupport::IsolatedExecutionState` for improved thread/Fiber safety. In Rails 6-7.0, it falls back to `Thread.current`.
+In Rails 7.1+, request state uses `ActiveSupport::IsolatedExecutionState`. On Rails 7.0, it uses `Thread.current`.
 
 ## Development
 
 ```bash
 bundle install
 bundle exec appraisal generate
-bundle exec rspec
+bundle exec polyrun parallel-rspec --workers 5 --merge-failures
 bin/appraisals
 bundle exec standardrb --fix
 ```

data/lib/grape_rails_logger/debug_tracer.rb

@@ -20,11 +20,6 @@ module GrapeRailsLogger
       trace_request(env) do
         @app.call(env)
       end
-    rescue => e
-      # If tracing fails for any reason, log and pass through
-      # Never break the request flow
-      log_trace_error(e)
-      @app.call(env)
     end
 
     private
@@ -41,19 +36,31 @@ module GrapeRailsLogger
       file_prefix = sanitize_file_prefix(request_method, request_path)
       context = [request_method, request_path].compact.join(" ")
 
-      Debug.new(
-        with_sql: true,
-        with_stack: false,
-        store_file: true,
-        file_prefix: file_prefix,
-        context: context
-      ).trace do
+      downstream_started = false
+      downstream_completed = false
+      downstream_response = nil
+
+      begin
+        Debug.new(
+          with_sql: true,
+          with_stack: false,
+          store_file: true,
+          file_prefix: file_prefix,
+          context: context
+        ).trace do
+          downstream_started = true
+          downstream_response = yield
+          downstream_completed = true
+          downstream_response
+        end
+        downstream_response
+      rescue => e
+        log_trace_error(e)
+        raise if downstream_started && !downstream_completed
+        return downstream_response if downstream_completed
+
         yield
       end
-    rescue => e
-      # If Debug.new or trace fails, log and continue without tracing
-      log_trace_error(e)
-      yield
     end
 
     def sanitize_file_prefix(method, path)

data/lib/grape_rails_logger/endpoint_wrapper.rb

@@ -20,6 +20,8 @@ module GrapeRailsLogger
 
       logger = resolve_logger
       downstream_response = nil
+      downstream_started = false
+      downstream_completed = false
 
       Timings.track_grape_request do
         # Wrap the entire request in ActiveSupport::Notifications
@@ -28,7 +30,9 @@ module GrapeRailsLogger
           # Call the wrapped app - Error middleware will process exceptions and return final response
           # NOTE: We do NOT read the body here - Grape will process it and parse params
           # We'll extract params later from already-parsed sources (endpoint.request.params)
+          downstream_started = true
           downstream_response = @app.call(env)
+          downstream_completed = true
 
           # NOW collect all data AFTER Error middleware has processed exceptions
           # At this point, response contains the final Rack response with correct status
@@ -41,7 +45,8 @@ module GrapeRailsLogger
       end
     rescue => e
       handle_instrumentation_error(e)
-      return downstream_response if downstream_response
+      return downstream_response if downstream_completed
+      raise if downstream_started
 
       @app.call(env)
     end
@@ -86,11 +91,11 @@ module GrapeRailsLogger
 
       if response.is_a?(Array) && response[0].is_a?(Integer)
         response[0]
+      elsif response.respond_to?(:status) && response.status.is_a?(Integer)
+        response.status
       elsif response.respond_to?(:to_a)
         array = response.to_a
         array[0] if array.is_a?(Array) && array[0].is_a?(Integer)
-      elsif response.respond_to?(:status) && response.status.is_a?(Integer)
-        response.status
       end
     end
 

data/lib/grape_rails_logger/railtie.rb

@@ -20,7 +20,7 @@ if defined?(Rails) && defined?(Rails::Railtie)
         # Only subscribe if ActiveRecord is loaded (optional dependency)
         if defined?(ActiveRecord)
           ActiveSupport::Notifications.subscribe("sql.active_record") do |*args|
-            GrapeRailsLogger::Timings.append_db_runtime(ActiveSupport::Notifications::Event.new(*args))
+            GrapeRailsLogger::Timings.record_sql_notification(*args)
           rescue => e
             # Never let DB timing errors break anything
             # Only warn in development to avoid noise in production

data/lib/grape_rails_logger/subscriber.rb

@@ -17,7 +17,8 @@ module GrapeRailsLogger
       end
     end
 
-    FILTERED_PARAMS = %w[password secret token key].freeze
+    # 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
     PARAM_EXCEPTIONS = %w[controller action format].freeze
 
     def grape_request(event)
@@ -134,12 +135,6 @@ module GrapeRailsLogger
       else
         safe_log(:info, data, logger)
       end
-      # Mark that we successfully logged to prevent fallback from duplicating
-      true
-    rescue => e
-      # If logging itself fails, don't log again in fallback
-      # Mark that we tried to log so fallback knows not to duplicate
-      raise LoggingError.new(e)
     end
 
     def build_exception_data(exception)
@@ -157,11 +152,9 @@ module GrapeRailsLogger
     end
 
     def safe_log(level, data, logger = nil)
-      # Get logger from parameter, config, or default to Rails.logger
       effective_logger = logger || resolve_effective_logger
-      return unless effective_logger
+      return false unless effective_logger
 
-      # Get tag from config
       tag = resolve_tag
 
       if effective_logger.respond_to?(:tagged) && tag
@@ -171,12 +164,12 @@ module GrapeRailsLogger
       else
         effective_logger.public_send(level, data)
       end
+      true
     rescue => e
-      # Fallback to stderr if logging fails - never raise
-      # Only warn in development to avoid noise in production
       if defined?(Rails) && Rails.respond_to?(:env) && Rails.env.development?
         Rails.logger&.warn("GrapeRailsLogger log error: #{e.message}")
       end
+      false
     end
 
     def resolve_tag
@@ -481,21 +474,52 @@ module GrapeRailsLogger
     def extract_action(event)
       endpoint = event.payload.dig(:env, "api.endpoint")
       return "unknown" unless endpoint
-      return "unknown" unless endpoint.respond_to?(:options)
-      return "unknown" unless endpoint.options
 
-      method = endpoint.options[:method]&.first
-      path = endpoint.options[:path]&.first
+      method = first_list_item(endpoint_http_methods(endpoint))
+      path = first_list_item(endpoint_paths(endpoint))
       return "unknown" unless method && path
 
-      return method.downcase.to_s if path == "/" || path.empty?
+      method_name = method.to_s.downcase
+      return method_name if path == "/" || path.empty?
 
       clean_path = path.to_s.delete_prefix("/").gsub(/[:\/]/, "_").squeeze("_").gsub(/^_+|_+$/, "")
-      "#{method.downcase}_#{clean_path}"
+      "#{method_name}_#{clean_path}"
     rescue
       "unknown"
     end
 
+    def endpoint_http_methods(endpoint)
+      config = endpoint_config(endpoint)
+      methods = config.http_methods if config.respond_to?(:http_methods)
+      return methods if methods
+      return nil unless endpoint.respond_to?(:options) && endpoint.options
+
+      endpoint.options[:method]
+    end
+
+    def endpoint_paths(endpoint)
+      config = endpoint_config(endpoint)
+      paths = config.path if config.respond_to?(:path)
+      return paths if paths
+      return nil unless endpoint.respond_to?(:options) && endpoint.options
+
+      endpoint.options[:path]
+    end
+
+    # grape 4 stores definition-time verbs and path on protected Endpoint#config
+    def endpoint_config(endpoint)
+      return unless endpoint.respond_to?(:config, true)
+
+      endpoint.send(:config)
+    end
+
+    def first_list_item(value)
+      return value if value.nil? || value.is_a?(String) || value.is_a?(Symbol)
+      return value.first if value.respond_to?(:first)
+
+      value
+    end
+
     def extract_controller(event)
       endpoint = event.payload.dig(:env, "api.endpoint")
       return nil unless endpoint&.source&.source_location
@@ -678,7 +702,8 @@ module GrapeRailsLogger
       endpoint = env["api.endpoint"]
       return nil unless endpoint
 
-      api_class = endpoint.respond_to?(:options) ? endpoint.options[:for] : nil
+      api_class = endpoint.respond_to?(:api) ? endpoint.api : nil
+      api_class ||= endpoint.respond_to?(:options) ? endpoint.options[:for] : nil
       api_class ||= endpoint.respond_to?(:namespace) ? endpoint.namespace&.options&.dig(:for) : nil
       api_class ||= endpoint.respond_to?(:route) ? endpoint.route&.options&.dig(:for) : nil
       return nil unless api_class&.respond_to?(:content_types, true)
@@ -761,9 +786,9 @@ module GrapeRailsLogger
           when Hash
             filter_parameters_manually(value, depth + 1)
           when Array
-            value.first(100).map { |v| v.is_a?(Hash) ? filter_parameters_manually(v, depth + 1) : filter_value(v) }
+            value.first(100).map { |v| v.is_a?(Hash) ? filter_parameters_manually(v, depth + 1) : v }
           else
-            filter_value(value)
+            value
           end
         end
       end
@@ -773,14 +798,6 @@ module GrapeRailsLogger
       {}
     end
 
-    def filter_value(value)
-      return value unless value.is_a?(String)
-      value_lower = value.downcase
-      return "[FILTERED]" if FILTERED_PARAMS.any? { |param| value_lower.include?(param.downcase) }
-
-      value
-    end
-
     def should_filter_key?(key)
       key_lower = key.to_s.downcase
       FILTERED_PARAMS.any? { |param| key_lower.include?(param.downcase) }

data/lib/grape_rails_logger/timings.rb

@@ -48,5 +48,12 @@ module GrapeRailsLogger
       state[:grape_db_runtime] = (state[:grape_db_runtime] || 0) + event.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?
+
+      append_db_runtime(ActiveSupport::Notifications::Event.new(*args))
+    end
   end
 end

data/lib/grape_rails_logger/version.rb

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

data/sig/grape_rails_logger.rbs

@@ -23,6 +23,7 @@ module GrapeRailsLogger
     def self.db_runtime: () -> Float
     def self.db_calls: () -> Integer
     def self.append_db_runtime: (ActiveSupport::Notifications::Event event) -> void
+    def self.record_sql_notification: (*untyped args) -> void
   end
 
   module StatusExtractor

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape_rails_logger
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Andrei Makarov
@@ -58,7 +58,7 @@ dependencies:
         version: '1.6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -68,7 +68,7 @@ dependencies:
         version: '1.6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -125,20 +125,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -307,8 +293,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
-description: Rails-compatible, ActiveSupport-integrated logging for Grape APIs, including
-  request context and ActiveRecord timings.
+description: Rails and ActiveSupport request logging for Grape APIs, with request
+  context and ActiveRecord timings.
 email:
 - contact@kiskolabs.com
 executables: []
@@ -351,5 +337,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
-summary: Unified JSON request logging for Grape on Rails with DB timing.
+summary: Structured request logging for Grape on Rails with ActiveRecord timing.
 test_files: []