rails-profiler 0.30.4 → 0.30.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2940fc44efea04a648f7bba562f2fc19be1639d996525e9d08483ef7093baa16
-  data.tar.gz: 1b9f6534d20625950aef62f906319942d7327ea609649aef00b70ba88c9b17ce
+  metadata.gz: 04defc47e71c610492ff23fbce13ebf669f459a1cac74c5933200bdf4d52365c
+  data.tar.gz: d99cf7c5531fd369aa8c9367d95b0a5314f71f38de6ed64a7c81a9693f69566a
 SHA512:
-  metadata.gz: 6ce1584ab5b3d70a6262d205cfbd0e4876d29e89b3766efde13fe345966734c20f6a73df1fe1e14b71f7b8af5c588b04e02c7e9a8b16a0f00c902ff8f5a55aa6
-  data.tar.gz: 6e02c794a279605d81ac11c5f31f099378af2d82c967e757bf571ce2ff27ec7ca3f7c342f7e90cca628c5a406c253b0f0252971a723d0c4970db86ec35bd5c4e
+  metadata.gz: '09ba67258286ddc275d2d1cc36234dd8f0e7d24783034dd3959c666b41d96bb334d5c38d720ceca2254d205449094aa57cac9de6afb1842e3437fbd2d238eac3'
+  data.tar.gz: '0936d7ca150be6a80809739a2d9b94f77c51c80fad8796bb01d93fb2ca0047a5da3eb4ae832f9567c381bd3dcaacad3000b0273664362570306060c8b3b3eeec'

data/CHANGELOG.md

@@ -0,0 +1,402 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Write your entry under `[Unreleased]`, for a user of the gem. When your branch is
+ready, run `bin/changelog stamp`: it works out the version the merge will publish
+and turns `[Unreleased]` into `[X.Y.Z] - <date>`, reopening an empty one above.
+Run it again after a rebase or a new commit, it corrects the number and folds the
+new entries in. Never edit a section that already carries a tag.
+
+A section written by `stamp` carries `<!-- stamped -->`. In the older sections,
+each bullet carries the short sha of the commit it describes, and commits left out
+on purpose are listed in that version's `excluded:` comment with the reason; all of
+it in HTML comments, invisible once rendered. `bin/changelog coverage` checks that
+every commit of every tag interval is accounted for one way or the other.
+
+## [Unreleased]
+
+## [0.30.5] - 2026-10-03
+
+<!-- stamped -->
+
+### Fixed
+
+- **Instrumentation:** Pass the arguments of `Thread.new` on to its block, and keep keyword
+  arguments as keywords. While a profile was being collected the block got none at all, which on
+  Ruby 3.4 broke the Happy Eyeballs hostname resolution of `Socket.tcp`: connections by hostname
+  timed out, for example as `Redis::CannotConnectError`. Keyword arguments were flattened at all
+  times, on every Ruby. Affects v0.22.1 through v0.30.4.
+- **Instrumentation:** Raise `ThreadError` on a `Thread.new` with no block during a profiled
+  request, as Ruby does.
+
+## [0.30.4] - 2026-07-01
+
+### Fixed
+
+- **Cluster:** Resolve profiles across slaves from the master `ProfilesController` <!-- 9236c4c -->
+
+## [0.30.3] - 2026-06-29
+
+### Fixed
+
+- Wrap the profile dashboards and `TestRunnerPage` with `QueryClientProvider` <!-- 420ae2f -->
+
+## [0.30.2] - 2026-06-29
+
+### Fixed
+
+- **Middleware:** Duplicate downstream headers before mutating them <!-- 3efb20c -->
+
+## [0.30.1] - 2026-06-29
+
+### Fixed
+
+- **Cluster:** Fix sentinel mismatch, profile list pagination, nil safety in MCP tools and HTTPS slave URLs <!-- 4b5fb1c -->
+
+## [0.30.0] - 2026-06-28
+
+### Added
+
+- **Cluster:** Add master/slave profiler clustering <!-- 1435f22 -->
+
+## [0.29.0] - 2026-06-28
+
+### Added
+
+- **SSE:** Push live profile updates over server-sent events <!-- fa0ae2e -->
+
+## [0.28.0] - 2026-06-06
+
+### Added
+
+- **HTTP:** Add the `http_backtrace_depth` configuration option <!-- 25b4f99 -->
+
+## [0.27.1] - 2026-06-06
+
+### Changed
+
+- **API:** Replace manual `fetch()` calls with `orval` generated TanStack Query hooks <!-- e33341e -->
+
+### Fixed
+
+- **File store:** Prevent `ENOENT` errors on concurrent profile file deletion <!-- 8898f0e -->
+
+## [0.27.0] - 2026-06-02
+
+### Added
+
+- **MCP:** Add console profiling, mailer detail, logs/env/i18n sections and full documentation <!-- ca362a1 -->
+
+## [0.26.0] - 2026-06-02
+
+### Added
+
+- **Test profiler:** Add the `run_tests` MCP tool, the `track_tests` option, specs and docs <!-- 265ce03 -->
+- **Test profiler:** Enrich reporter, add SSE streaming, MCP tools and env safety <!-- a410c4b -->
+- **Test profiler:** Add test profiling, test runner UI and MCP tool <!-- a116fcb -->
+
+## [0.25.0] - 2026-06-01
+
+### Added
+
+- **Console:** Add a console profiling tab with IRB instrumentation <!-- f29937a -->
+
+### Changed
+
+- **Docs:** Document the console profiling tab and the env override behaviour <!-- 031cac6 -->
+
+<!-- excluded:
+  bd55e9b specs only, no visible change
+-->
+
+## [0.24.0] - 2026-06-01
+
+### Added
+
+- **MCP:** Add tools to manage `ENV` variables <!-- 9126194 -->
+
+## [0.23.0] - 2026-05-27
+
+### Added
+
+- **Profile list:** Add a global clear-all button and auto-refresh on tab switch <!-- 460a110 -->
+
+## [0.22.1] - 2026-05-26
+
+### Fixed
+
+- **HTTP:** Propagate collector to child threads, add fire-and-forget support, fix deep backtrace capture <!-- 9d0bd61 -->
+
+## [0.22.0] - 2026-05-04
+
+### Added
+
+- **Mailer:** Add a body preview, a variables display, a queued badge and design alignment <!-- b7d608f -->
+- **Collector:** Implement `MailerCollector`, tracking ActionMailer deliveries <!-- e59dd72 -->
+
+### Changed
+
+- **Toolbar:** Remove the emoji from the mailer toolbar item and the dashboard tab <!-- 55df9bb -->
+
+### Fixed
+
+- **Mailer:** Add the Mailers tab to `JobProfileDashboard` <!-- 4ce145d -->
+- **Mailer:** Fix thread isolation and `deliver_later` mode detection <!-- 6e76a99 -->
+- **Mailer:** Add `MailerCollector` to the job profiler and align the toolbar item design <!-- 915be28 -->
+- **Mailer:** Handle the Rails 7 encoded mail string in the `deliver.action_mailer` payload <!-- 5479dcf -->
+- **Mailer:** Replace `Thread.current.delete` with a read and nil write for fiber local variables <!-- 8787201 -->
+- **Version:** Remove the pre-release suffix, which broke Bundler resolution <!-- 98caecd -->
+- **Mailer:** Address code review findings from MR !32 <!-- b46d3d2 -->
+
+## [0.21.0] - 2026-05-02
+
+### Added
+
+- **Toolbar:** Add a collapse/expand toggle <!-- 8f0669a -->
+
+## [0.20.0] - 2026-05-01
+
+### Added
+
+- **UI:** Display the gem version and warn on a mismatch <!-- 64ff6eb -->
+
+## [0.19.2] - 2026-04-24
+
+### Fixed
+
+- **HTTP:** Capture `RestClient` `body_stream`, remove body size limits, show bodies in MCP tool results <!-- 89fb0e5 -->
+
+<!-- excluded:
+  4527e12 release plumbing, version placeholder reset
+-->
+
+## [0.19.1] - 2026-04-17
+
+### Fixed
+
+- **Env vars:** Fix revert restoring wrong value, SQLite busy errors, middleware rescue handling and UI refresh <!-- 55c8661 -->
+
+<!-- excluded:
+  4637391 pipeline only
+  b53b4d7 pipeline only
+  7b33bf6 pipeline only
+-->
+
+## [0.19.0] - 2026-04-15
+
+### Added
+
+- **Env:** Propagate env var overrides to Sidekiq workers <!-- e75a883 -->
+
+## [0.18.0] - 2026-04-14
+
+### Changed
+
+- **UI:** Extract shared tab utilities and redesign the Request tab <!-- 7aa8adb -->
+
+### Fixed
+
+- **HTTP:** Capture outbound request body passed as second argument to `http.request()` <!-- 5a59665 -->
+
+## [0.17.0] - 2026-04-13
+
+### Added
+
+- **Dashboard:** Add env tab on the home page and env/job toolbar items <!-- d0277ab -->
+
+## [0.16.0] - 2026-04-13
+
+### Added
+
+- **Function profiler:** Add `stackprof` sampling mode with multi-clock support and GC visibility <!-- 5f73512 -->
+
+### Fixed
+
+- **Function profiler:** Fix `stackprof` bugs, remove minimal mode, improve performance <!-- 76c6197 -->
+
+## [0.15.0] - 2026-04-11
+
+### Added
+
+- **Env:** Add environment variables tab <!-- 0e85f18 -->
+
+## [0.14.0] - 2026-04-09
+
+### Added
+
+- **Profiler:** Link jobs to their triggering request or parent job <!-- 74ba5e3 -->
+
+## [0.13.0] - 2026-04-09
+
+### Added
+
+- **UI:** Add copy/download buttons on HTTP bodies, waterfall view, date sort, and other UX improvements <!-- 5afd003 -->
+- **UI:** Always show waterfall above the HTTP request list <!-- 32c6b6d -->
+- **UI:** Use `SmartBodyPreview` in RequestTab for copy/download on request and response bodies <!-- aef4c0c -->
+
+### Fixed
+
+- **UI:** Derive download file extension from actual MIME type instead of body category <!-- 1dc0bc8 -->
+- **UI:** Move `sortedJobs` after `filteredJobs` to fix TDZ error <!-- d4de7bc -->
+
+## [0.12.0] - 2026-04-09
+
+### Added
+
+- **Profiler:** Add function-level profiling with flamegraph and stats table <!-- fcb04a6 -->
+
+## [0.11.1] - 2026-04-09
+
+### Added
+
+- **Config:** Add `tmp_path` option to centralize the storage directory <!-- 5e77944 -->
+
+### Fixed
+
+- **MCP:** Decompress gzip+base64 bodies before returning to UI and MCP tool results <!-- 8f5ac47 -->
+
+## [0.11.0] - 2026-04-06
+
+### Added
+
+- **UI:** Add load-more pagination to the profile list <!-- 9f8458b -->
+
+## [0.10.1] - 2026-04-06
+
+### Changed
+
+- **Docs:** Add full user documentation, with a UI guide, an MCP guide and screenshots <!-- 80a9198 -->
+
+## [0.10.0] - 2026-04-06
+
+### Added
+
+- **Middleware:** Add configurable CORS origins, CSP nonce support and body compression <!-- 3a42188 -->
+
+## [0.9.1] - 2026-04-06
+
+### Removed
+
+- **Collectors:** Remove `PerformanceCollector`, replaced by `FlameGraphCollector` <!-- 212e155 -->
+
+## [0.9.0] - 2026-04-06
+
+### Added
+
+- **Profiler:** Add the `Profiler.measure` custom instrumentation API <!-- 0a3044e -->
+
+## [0.8.0] - 2026-04-05
+
+### Added
+
+- **UI:** Add sortable columns, quick filter presets and flamegraph search <!-- ffd2e6f -->
+
+## [0.7.0] - 2026-04-05
+
+### Added
+
+- **Database:** Add N+1 visual detection and `EXPLAIN ANALYZE` integration <!-- a22902d -->
+
+## [0.6.0] - 2026-04-05
+
+### Added
+
+- **MCP:** Reduce token usage with filtering, body file saving and pagination <!-- 834251d -->
+
+## [0.5.0] - 2026-04-04
+
+### Added
+
+- **MCP:** Add outbound IDs, a domain filter, datetimes, a latest token, exceptions and copy helpers <!-- 9330545 -->
+
+## [0.4.0] - 2026-04-03
+
+### Added
+
+- **Collector:** Add an I18n panel tracking translation lookups per request <!-- 3032a15 -->
+
+<!-- excluded:
+  b50d1eb pipeline only
+-->
+
+## [0.3.0] - 2026-04-02
+
+### Added
+
+- **Collector:** Add a routes panel and enrich the request collector <!-- bdf0e3c -->
+
+## [0.2.0] - 2026-03-29
+
+### Added
+
+- **Collector:** Add a Logs panel, capturing `Rails.logger` messages per request <!-- 0e0e7ce -->
+- Publish the gem to RubyGems.org <!-- f292a21 -->
+
+<!-- excluded:
+  10c1314 pipeline only, despite the fix: type
+  3f97b1d pipeline only
+  a8c2044 pipeline only
+  27cc550 pipeline only
+-->
+
+## [0.1.4] - 2026-03-29
+
+### Added
+
+- **Profiler:** Capture the full request and response, and add an MCP history clear <!-- 9922c8a -->
+
+## [0.1.3] - 2026-03-29
+
+### Changed
+
+- **Assets:** Migrate Sass `@import` to `@use`, which removes the build deprecation warnings <!-- 1a67e48 -->
+
+## [0.1.2] - 2026-03-25
+
+This tag holds nothing but the release commit the pipeline wrote. The interval
+carries no change to the gem, so there is nothing to report for this version.
+
+## [0.1.1] - 2026-03-25
+
+### Added
+
+- **HTTP:** Decompress gzip and deflate response bodies before storing them <!-- f71a5c7 -->
+- **Flamegraph:** Add an interactive flame graph tab <!-- 63c4b67 -->
+- **Config:** Add `.well-known` and `favicon.ico` to the default `skip_paths` <!-- 1286447 -->
+- **Storage:** Add an SQLite backend, a blob store and delete/clear APIs <!-- 544015b -->
+- **UI:** Add filters to the profile list action bar and fix the badge colours <!-- 40d4081 -->
+- **HTTP:** Add binary download, inline preview and smart text formatting <!-- b09eab8 -->
+- Rename the HTTP tab, add the outbound HTTP list and extend MCP coverage <!-- 71bc537 -->
+- **Jobs:** Add background job profiling for Sidekiq and ActiveJob <!-- 27b87db -->
+- Add an outbound HTTP request collector <!-- e5f2ac9 -->
+- **MCP:** Migrate to the official Ruby SDK, over HTTP transport <!-- 3fc2d45 -->
+- Implement the dashboard UI, with a tab system and a design system <!-- beb83f7 -->
+- Add the AJAX and dump collectors, and the CORS middleware <!-- 08bad9f -->
+- First implementation of the gem <!-- 360c6fa -->
+
+### Changed
+
+- **Docs:** Document installation from the GitLab Package Registry <!-- 527c32b -->
+- **Assets:** Serve every gem asset exclusively under `/_profiler/` <!-- e8ae1ae -->
+- **Config:** Add `manifest.json` to the default `skip_paths` <!-- 350f16c -->
+- **Docs:** Correct the installation instructions in the README and remove the dashboard README <!-- e44c8a2 -->
+
+### Fixed
+
+- **Packaging:** Fix the gemspec metadata and file glob, and exclude source assets <!-- 195b609 -->
+- **Packaging:** Switch to the yarn build scripts and update dependencies <!-- b62f2d8 -->
+- **Packaging:** Fix the `http_collector` require, the collectors option override and asset serving in API only applications <!-- 729f20f -->
+- **Packaging:** Exclude `.gem` build artifacts from the file list <!-- 9b97f60 -->
+- **Profiler:** Improve memory tracking and profile deserialisation <!-- a0af47e -->
+
+<!-- excluded:
+  e27cdae pipeline only
+  02d63c9 pipeline only
+  9f598d9 subject is not conventional, tooling only
+  7d1d823 tests only
+  c0d46e6 licence file, not a change to the gem
+-->

data/lib/profiler/instrumentation/thread_context_propagation.rb

@@ -9,24 +9,39 @@ module Profiler
       ].freeze
 
       def initialize(*args, &block)
+        # Ruby refuses a Thread with no block, and the wrapper below is a block, so
+        # without this the error would never come while a profile is being collected.
+        return super if block.nil?
+
         parent_context = PROPAGATED_KEYS.filter_map do |key|
           val = Thread.current[key]
           [key, val] unless val.nil?
         end.to_h
 
-        if parent_context.empty?
-          super
-        else
-          super(*args) do
-            parent_context.each { |k, v| Thread.current[k] = v }
-            begin
-              block&.call
-            ensure
-              PROPAGATED_KEYS.each { |k| Thread.current[k] = nil }
-            end
+        return super if parent_context.empty?
+
+        # Thread.new hands its arguments to the block, so the wrapper has to take
+        # them and pass them on. Ruby 3.4 depends on it in the stdlib: the Happy
+        # Eyeballs hostname resolution of Socket.tcp runs
+        #   Thread.new(*thread_args) { |*thread_args| resolve_hostname(*thread_args) }
+        # and a wrapper that swallows the arguments leaves the name unresolved.
+        # The wrapper is a named proc rather than a literal block because only a
+        # proc can be given the ruby2_keywords flag, which, together with the one
+        # on this method, keeps a trailing keyword hash a keyword hash rather than
+        # flattening it into a positional argument.
+        wrapper = proc do |*block_args|
+          parent_context.each { |k, v| Thread.current[k] = v }
+          begin
+            block&.call(*block_args)
+          ensure
+            PROPAGATED_KEYS.each { |k| Thread.current[k] = nil }
           end
         end
+        wrapper.ruby2_keywords
+
+        super(*args, &wrapper)
       end
+      ruby2_keywords :initialize
     end
   end
 end

data/lib/profiler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-profiler
 version: !ruby/object:Gem::Version
-  version: 0.30.4
+  version: 0.30.5
 platform: ruby
 authors:
 - Sébastien Duplessy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-07-01 00:00:00.000000000 Z
+date: 2026-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -103,6 +103,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - app/assets/builds/profiler-toolbar.js
 - app/assets/builds/profiler.css
 - app/assets/builds/profiler.js
@@ -231,6 +232,7 @@ licenses:
 metadata:
   homepage_uri: https://git.duplessy.eu/sebastien/rails-profiler-gem
   source_code_uri: https://git.duplessy.eu/sebastien/rails-profiler-gem
+  changelog_uri: https://git.duplessy.eu/sebastien/rails-profiler-gem/-/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: