rails-profiler 0.31.5 → 0.31.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87fc21dec17ab7627d4430f49b042e53061efb33034d7309ea07aac6eb83ac5d
-  data.tar.gz: 3e64027bb71fa5ce3d2a23a23cf1525f0e5a55c508c019f1398c35c705f20434
+  metadata.gz: f8c9d9f31f3f32dc5ada20eb78eb6bc205c0985e084942edf18b283cfafe81be
+  data.tar.gz: 49fb9afa0dd2fa52033f151b077ec971db08fe45818fe64448559ba95f4face3
 SHA512:
-  metadata.gz: 596fda2dad5ffa7e2a7c98a2b749c03901df7748d26776203a30d88a86b842e5956d92453b3847a3cf856a7afee5c4511f02ce83070a6dd26d0ef4d1e6784b5b
-  data.tar.gz: b70a833918e15474ac410c182763f13e03e0352e39cd7a0ed066c68a47f2f86762e7ef01fcd5246bfe47d391d86c03556929f66dbb84f0098f0bc43c43e9b415
+  metadata.gz: 79bd6095dd2deb184ee662c398183d5e63b9b9af30f5bda76b1806353adce5137627c2e33afc5c95aadc451dd540a9d243c1cc1df3eb72eccc2001331362581f
+  data.tar.gz: bd488d9da999d2f54be42b4002030f88bb51b069c956b78c85f0aadc4e87faa3f6ec3a2bb26c9921b73bea0fbaa84e16fd8e3f5967cfc8276ada75fa44a9b331

data/CHANGELOG.md

@@ -19,6 +19,36 @@ every commit of every tag interval is accounted for one way or the other.
 
 ## [Unreleased]
 
+## [0.31.6] - 2026-10-05
+
+<!-- stamped -->
+
+### Fixed
+
+- **Storage:** With `config.compress_bodies` (on by default), a text body larger than
+  `config.compress_body_threshold` (10 KB) is now stored gzip+base64, as the README said: the
+  profile was decompressed again before every save, so the file, Redis and memory stores kept the
+  body as text, next to the compressed copy the request collector keeps, and the compression only
+  cost time. A 132 KB HTML page now takes 86 KB in those stores instead of 171 KB (273 KB without
+  compression); SQLite, which only keeps that copy, 44 KB instead of 36 KB at the faster level.
+  Compressing it costs 1.6 ms on the request instead of 4.1 ms (the fastest zlib level), saving
+  the profile 0.2 ms instead of 1.2 ms; the bodies are decompressed only when a profile is shown,
+  about 0.7 ms. The profile page, its API, the job, console and test APIs, the lists the cluster
+  proxy reads and the MCP tools still give the bodies as text; the toolbar, which shows no body,
+  gets them as stored (86 KB instead of 171 KB for that page).
+- **Storage:** The profile list summaries kept by the file, SQLite and Redis stores no longer
+  carry the first 500 characters of the request and response bodies. Summaries written by 0.31.4
+  and 0.31.5 keep them until their profiles are evicted; no list shows them.
+- **MCP:** The `curl` command of `get_profile_detail` carries the request body as it was sent: a
+  body larger than `compress_body_threshold` came out as its compressed base64 form, and a binary
+  body as base64 text. A binary body is now left out of the command.
+- **Upgrading:** the profiles already stored, all as text, are read as before, with no migration.
+  An earlier version reading a store written by this one shows the compressed bodies as text too,
+  and a cluster master and its slaves may run either version: the profile API they read still
+  gives the bodies as text. A body that cannot be decompressed is shown as it is stored, never as
+  an error. To keep the bodies readable as text in the stored files or Redis keys, set
+  `config.compress_bodies = false`.
+
 ## [0.31.5] - 2026-10-05
 
 <!-- stamped -->

data/app/controllers/profiler/api/console_controller.rb

@@ -14,7 +14,7 @@ module Profiler
           return render json: { error: "Console profile not found" }, status: :not_found
         end
 
-        render json: profile.to_h
+        render json: profile.to_h(decode_bodies: true)
       end
 
       def destroy

data/app/controllers/profiler/api/jobs_controller.rb

@@ -14,7 +14,7 @@ module Profiler
           return render json: { error: "Job profile not found" }, status: :not_found
         end
 
-        render json: profile.to_h.merge(
+        render json: profile.to_h(decode_bodies: true).merge(
           child_jobs: build_child_jobs(profile),
           parent_profile: build_parent_summary(profile)
         )

data/app/controllers/profiler/api/profiles_controller.rb

@@ -28,7 +28,7 @@ module Profiler
         # The route table and ENV are the process's, not stored in the profile
         Profiler::ProcessSnapshot.hydrate(profile)
 
-        render json: profile.to_h.merge(
+        render json: profile.to_h(decode_bodies: true).merge(
           child_jobs: build_child_jobs(profile),
           parent_profile: build_parent_summary(profile)
         )

data/app/controllers/profiler/api/tests_controller.rb

@@ -14,7 +14,7 @@ module Profiler
           return render json: { error: "Test profile not found" }, status: :not_found
         end
 
-        render json: profile.to_h
+        render json: profile.to_h(decode_bodies: true)
       end
 
       def destroy

data/app/controllers/profiler/api/toolbar_controller.rb

@@ -19,6 +19,7 @@ module Profiler
         # The route table and ENV are the process's, not stored in the profile
         Profiler::ProcessSnapshot.hydrate(profile)
 
+        # The bodies as stored (gzip+base64 past compress_body_threshold): the toolbar shows none.
         render json: {
           profile: profile.to_h.merge(child_jobs: build_child_jobs(profile)),
           events_cursor: events_cursor

data/app/controllers/profiler/application_controller.rb

@@ -74,9 +74,10 @@ module Profiler
       render_page(Profiler.storage.list(limit: limit + 1, offset: offset, type: type, summary: summary), limit, offset)
     end
 
+    # The bodies as text: the cluster proxy lists whole profiles (all_types), a summary has none.
     def render_page(profiles, limit, offset)
       render json: {
-        profiles: profiles.first(limit).map(&:to_h),
+        profiles: profiles.first(limit).map { |profile| profile.to_h(decode_bodies: true) },
         limit:    limit,
         offset:   offset,
         has_more: profiles.size > limit

data/app/controllers/profiler/profiles_controller.rb

@@ -25,7 +25,7 @@ module Profiler
       # The route table and ENV are the process's, not stored in the profile
       Profiler::ProcessSnapshot.hydrate(@profile)
 
-      @profile_data = @profile.to_h.merge(
+      @profile_data = @profile.to_h(decode_bodies: true).merge(
         child_jobs: build_child_jobs(@profile),
         parent_profile: build_parent_summary(@profile)
       )

data/lib/profiler/mcp/body_formatter.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require "base64"
-require "zlib"
+require_relative "../models/profile"
 
 module Profiler
   module MCP
@@ -19,13 +18,7 @@ module Profiler
         return "  *(binary, base64 encoded)*" if encoding == "base64"
         return nil if body.nil? || body.empty?
 
-        if encoding == "gzip+base64"
-          begin
-            body = Zlib::Inflate.inflate(Base64.strict_decode64(body))
-          rescue Zlib::Error, ArgumentError
-            # fall through with original body
-          end
-        end
+        body, = Models::Profile.decode_body(body, encoding)
 
         if params["save_bodies"]
           path = FileCache.save(token, name, body)

data/lib/profiler/mcp/tools/get_profile_detail.rb

@@ -2,6 +2,7 @@
 
 require_relative "../slave_support"
 require_relative "../../process_snapshot"
+require_relative "../../models/profile"
 
 require "shellwords"
 require "cgi"
@@ -666,7 +667,10 @@ module Profiler
         def self.generate_curl(profile, req_data)
           headers  = req_data&.dig("headers")  || {}
           params   = req_data&.dig("params")   || {}
-          req_body = req_data&.dig("request_body")
+          # As captured: a binary body cannot be typed on a command line.
+          req_body, req_encoding = Models::Profile.decode_body(req_data&.dig("request_body"),
+                                                               req_data&.dig("request_body_encoding"))
+          req_body = nil unless req_encoding.nil? || req_encoding == "text"
 
           parts = ["curl -X #{profile.method}"]
 

data/lib/profiler/models/profile.rb

@@ -117,9 +117,15 @@ module Profiler
       end
       private :collector_metadata
 
-      def to_h
-        req_body,  req_enc  = decode_body(@request_body,  @request_body_encoding)
-        resp_body, resp_enc = decode_body(@response_body, @response_body_encoding)
+      # The profile as the stores keep it: a body compressed by compress_bodies stays gzip+base64.
+      # decode_bodies: true gives the bodies as text, for the responses that show them.
+      def to_h(decode_bodies: false)
+        req_body,  req_enc  = @request_body,  @request_body_encoding
+        resp_body, resp_enc = @response_body, @response_body_encoding
+        if decode_bodies
+          req_body,  req_enc  = self.class.decode_body(req_body, req_enc)
+          resp_body, resp_enc = self.class.decode_body(resp_body, resp_enc)
+        end
 
         {
           profile_type: @profile_type,
@@ -155,6 +161,7 @@ module Profiler
         }
       end
 
+      # The stored form, as #to_h.
       def to_json(*args)
         to_h.to_json(*args)
       end
@@ -212,6 +219,18 @@ module Profiler
         profile
       end
 
+      # A body kept gzip+base64 as text, with its encoding then "text"; any other body as it is.
+      # One that cannot be decompressed (cut, damaged) is returned as it is: unreadable at worst.
+      def self.decode_body(body, encoding)
+        return [body, encoding] unless encoding == "gzip+base64"
+        return [body, encoding] if body.nil? || body.empty?
+
+        decoded = Zlib::Inflate.inflate(Base64.strict_decode64(body))
+        [decoded.force_encoding(Encoding::UTF_8).scrub, "text"]
+      rescue Zlib::Error, ArgumentError
+        [body, encoding]
+      end
+
       def self.deep_stringify_keys(obj)
         case obj
         when Hash
@@ -235,7 +254,8 @@ module Profiler
         else
           text = Redaction.filter_body(raw, content_type).encode("UTF-8", invalid: :replace, undef: :replace)
           if compress_body?(text)
-            { body: Base64.strict_encode64(Zlib::Deflate.deflate(text)), encoding: "gzip+base64" }
+            # 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" }
           else
             { body: text, encoding: "text" }
           end
@@ -253,16 +273,6 @@ module Profiler
           text.bytesize > Profiler.configuration.compress_body_threshold
       end
 
-      def decode_body(body, encoding)
-        return [body, encoding] unless encoding == "gzip+base64"
-        return [body, encoding] if body.nil? || body.empty?
-
-        decoded = Zlib::Inflate.inflate(Base64.strict_decode64(body))
-        [decoded, "text"]
-      rescue Zlib::Error, ArgumentError
-        [body, encoding]
-      end
-
       def binary_content_type?(ct)
         ct.to_s.match?(%r{image/(?!svg)|application/(?:pdf|octet-stream|zip)|audio/|video/})
       end

data/lib/profiler/storage/summary.rb

@@ -7,16 +7,19 @@ module Profiler
     # What the profile lists show of a profile, for the stores to keep apart from the profile
     # itself: the top-level fields without the bodies, params, headers and tabs, and for each
     # collector its scalar values only (database.total_queries, job.queue, test.test_name...),
-    # nested lists and hashes left out, strings cut at MAX_SCALAR_LENGTH (a console return value,
-    # an exception message). Built from Profile#to_h, after the collectors and the
-    # redaction have run: a summary is a subset of the stored profile (a long string cut to its
-    # start) and holds no value the profile does not.
+    # nested lists and hashes and the request collector's copy of the bodies left out, strings
+    # cut at MAX_SCALAR_LENGTH (a console return value, an exception message). Built from
+    # Profile#to_h, after the collectors and the redaction have run: a summary is a subset of the
+    # stored profile (a long string cut to its start) and holds no value the profile does not.
     module Summary
       MAX_SCALAR_LENGTH = 500
 
       DROPPED = %i[params headers response_headers request_body request_body_encoding
                    response_body response_body_encoding tabs].freeze
 
+      # The request collector keeps a copy of the bodies: no more listed than the profile's own.
+      DROPPED_SCALARS = %w[request_body request_body_encoding response_body response_body_encoding].freeze
+
       module_function
 
       # From a Profile, or the Hash its #to_h returns.
@@ -37,6 +40,7 @@ module Profiler
       def scalars(values)
         values.each_with_object({}) do |(key, value), kept|
           next unless scalar?(value)
+          next if DROPPED_SCALARS.include?(key.to_s)
 
           kept[key.to_s] = value.is_a?(String) && value.length > MAX_SCALAR_LENGTH ? value[0, MAX_SCALAR_LENGTH] : value
         end

data/lib/profiler/version.rb

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

metadata

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