rails-profiler 0.34.4 → 0.34.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4912dd474a748e657c35111e3224d83500e75960ef2592e5cd652155dc62617
-  data.tar.gz: d0d4cb0f34f25d98f5be08875bdc59ec4cc84894f7cbe0b512fd1ecd153dda4b
+  metadata.gz: 0b498ec1274af5787fe96b70e64613b009298b578a7b084d65d450ec86a431bc
+  data.tar.gz: b575d9afef090eee5539cfca2ffd536887d90b4c08a3b5099504a8e31ca69eab
 SHA512:
-  metadata.gz: 3ca18ad3dd582e68c2bb935a5ace8628dc466a4999fa655e54117879548d543c5a291ec98765eb25456b0ff8fa774ee0f98f939544a346aa9b3368d37c421f72
-  data.tar.gz: e144011d2fd93d37aa3166748bf2d3671d8d246325a475cf13d756b188dd99999ef6f95b232fd36eca444c91e24e2715c1902695697ea1930407bc932b2e952d
+  metadata.gz: f7da413fad8fd79420dddc04242b1ce30c05aac1106073219b7c0dcda26dada8c59a1b8e0d6a6c3c403d92ee6cd519271285d5f99fe6670b0e970179f79be119
+  data.tar.gz: d36516568229d7fa228dad51b70a30e8ca2753cc07fa114279f322200d32bd9a4f5e02891ff0ea96b0c904dc1594d528f677129b840fe0acadd2f106f29ea9cc

data/CHANGELOG.md

@@ -19,6 +19,22 @@ every commit of every tag interval is accounted for one way or the other.
 
 ## [Unreleased]
 
+## [0.34.5] - 2026-10-16
+
+<!-- stamped -->
+
+### Fixed
+
+- **Request capture:** the parameters of a request are now read once the application has returned, so
+  route parameters are present and `param_encoding` is applied, and they are converted to UTF-8. They
+  used to be read in the outermost middleware, before the router ran.
+- **Request capture:** a text body keeps its accents. It is now read in the `charset` of its
+  `Content-Type`, UTF-8 when it declares none, and invalid bytes are replaced, instead of every
+  accent being turned into a replacement character.
+- **Request capture:** a request whose `Content-Type` declares a charset Ruby cannot convert from
+  (`charset=utf-7`, `charset=internal`) no longer loses its profile; the body is read as UTF-8 with
+  invalid bytes replaced.
+
 ## [0.34.4] - 2026-10-16
 
 <!-- stamped -->

data/lib/profiler/middleware/profiler_middleware.rb

@@ -28,7 +28,7 @@ module Profiler
         kept = nil
         begin
           begin
-            profile = Models::Profile.new(build_request(env))
+            profile = Models::Profile.new(build_request(env), params: false)
             profile.gem_version = Profiler::VERSION
             Profiler::CurrentContext.token = profile.token
 
@@ -57,10 +57,12 @@ module Profiler
           begin
             response = @app.call(env)
           rescue Exception => e # rubocop:disable Lint/RescueException
+            capture_params(env, profile) if failed_request?(e)
             record_failed_request(env, profile, collectors, request_body, allocations_before, e) if failed_request?(e)
             raise
           end
 
+          capture_params(env, profile)
           response, kept = complete_profile(env, profile, collectors, request_body, allocations_before, response)
           response
         ensure
@@ -74,6 +76,14 @@ module Profiler
 
       private
 
+      # Read after the application has run, so after the routing: the route parameters are there,
+      # and the params carry the encoding the route declared, as the controller saw them.
+      def capture_params(env, profile)
+        profile.capture_params(build_request(env))
+      rescue => e
+        Profiler.log_error("ProfilerMiddleware: could not read the request params", e)
+      end
+
       def complete_profile(env, profile, collectors, request_body, allocations_before, response)
         status, headers, body = response
 

data/lib/profiler/models/profile.rb

@@ -22,7 +22,9 @@ module Profiler
                     :collectors_released_after_seconds, :params_truncated,
                     :gem_version
 
-      def initialize(request = nil)
+      # +params+: false leaves the params to capture_params, for a caller that builds the profile
+      # before the router has run.
+      def initialize(request = nil, params: true)
         @token = SecureRandom.hex(16)
         @started_at = Time.now
         @collectors_data = {}
@@ -34,12 +36,19 @@ module Profiler
         if request
           @path = request.path
           @method = request.request_method
-          @params, @params_truncated = cap_params(sanitize_params(request.params),
-                                                  Profiler.configuration.max_captured_body_bytes)
+          capture_params(request) if params
           @headers = extract_headers(request.env)
         end
       end
 
+      # The request's params as the controller sees them. Read once the router has run: Rails
+      # adds the route parameters (:id...) and applies the routes' param_encoding only then, so
+      # a read before it keeps neither.
+      def capture_params(request)
+        @params, @params_truncated = cap_params(sanitize_params(utf8_params(request.params)),
+                                                Profiler.configuration.max_captured_body_bytes)
+      end
+
       # The sizes are those of the whole bodies, when a body was cut at max_captured_body_bytes;
       # *_size_is_minimum when the whole size is not known (no Content-Length, a stream that
       # stopped), only that it is at least that.
@@ -252,7 +261,7 @@ module Profiler
           # compressed format (zip, png, gzip...) does not hold the secret as it is.
           { body: Base64.strict_encode64(Redaction.hide_credentials(raw.b)), encoding: "base64" }
         else
-          text = Redaction.filter_body(raw, content_type).encode("UTF-8", invalid: :replace, undef: :replace)
+          text = utf8_text(Redaction.filter_body(raw, content_type), content_type)
           if compress_body?(text)
             # The fastest level: paid on the request, a quarter larger than the default level.
             { body: Base64.strict_encode64(Zlib::Deflate.deflate(text, Zlib::BEST_SPEED)), encoding: "gzip+base64" }
@@ -262,6 +271,39 @@ module Profiler
         end
       end
 
+      # The text as UTF-8: a body read from the wire is binary, and is taken for the charset its
+      # Content-Type declares (UTF-8 when it declares none, or one Ruby does not know). Bytes
+      # that do not belong to it are replaced, never raised on.
+      def utf8_text(text, content_type)
+        return text.encode("UTF-8", invalid: :replace, undef: :replace) unless text.encoding == Encoding::BINARY
+
+        charset = content_type.to_s[/charset\s*=\s*"?([^\s";]+)/i, 1]
+        source = begin
+          charset ? Encoding.find(charset) : Encoding::UTF_8
+        rescue ArgumentError
+          Encoding::UTF_8
+        end
+        # "internal" is a name Ruby knows but resolves to nil, "utf-7" is a dummy encoding with no converter.
+        source ||= Encoding::UTF_8
+        begin
+          text.dup.force_encoding(source).encode("UTF-8", invalid: :replace, undef: :replace)
+        rescue EncodingError
+          text.dup.force_encoding(Encoding::UTF_8).encode("UTF-8", invalid: :replace, undef: :replace)
+        end
+      end
+
+      # The params with their strings in UTF-8: a route's param_encoding gives some another
+      # encoding, which the profile must not carry into its JSON.
+      def utf8_params(value)
+        case value
+        when Hash then value.to_h { |k, v| [utf8_params(k), utf8_params(v)] }
+        when Array then value.map { |v| utf8_params(v) }
+        when String
+          value.encoding == Encoding::UTF_8 ? value : value.encode("UTF-8", invalid: :replace, undef: :replace)
+        else value
+        end
+      end
+
       def body_size(captured, total)
         captured_size = captured.to_s.bytesize
         total ||= captured_size

data/lib/profiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Profiler
-  VERSION = "0.34.4"
+  VERSION = "0.34.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-profiler
 version: !ruby/object:Gem::Version
-  version: 0.34.4
+  version: 0.34.5
 platform: ruby
 authors:
 - Sébastien Duplessy